Selaa lähdekoodia

Merge pull request #4576 from Soulou/4549-doc-kill-signal-param

Add missing 'signal' parameter for kill endpoint
James Turnbull 11 vuotta sitten
vanhempi
commit
4155874443

+ 1 - 0
docs/sources/reference/api/archive/docker_remote_api_v1.7.rst

@@ -454,6 +454,7 @@ Kill a container
 
 	   HTTP/1.1 204 OK
 	   	
+	:query signal: Signal to send to the container (integer). When not set, SIGKILL is assumed and the call will waits for the container to exit.
 	:statuscode 204: no error
 	:statuscode 404: no such container
 	:statuscode 500: server error

+ 1 - 0
docs/sources/reference/api/archive/docker_remote_api_v1.8.rst

@@ -482,6 +482,7 @@ Kill a container
 
            HTTP/1.1 204 OK
 
+        :query signal: Signal to send to the container (integer). When not set, SIGKILL is assumed and the call will waits for the container to exit.
         :statuscode 204: no error
         :statuscode 404: no such container
         :statuscode 500: server error

+ 5 - 0
docs/sources/reference/api/docker_remote_api_v1.10.md

@@ -459,6 +459,11 @@ Kill the container `id`
 
         HTTP/1.1 204 OK
 
+    Query Parameters
+
+    -   **signal** - Signal to send to the container: integer or string like "SIGINT".
+        When not set, SIGKILL is assumed and the call will waits for the container to exit.
+
     Status Codes:
 
     -   **204** – no error

+ 1 - 0
docs/sources/reference/api/docker_remote_api_v1.10.rst

@@ -466,6 +466,7 @@ Kill a container
 
            HTTP/1.1 204 OK
 
+        :query signal: Signal to send to the container, must be integer or string (i.e. SIGINT). When not set, SIGKILL is assumed and the call will waits for the container to exit.
         :statuscode 204: no error
         :statuscode 404: no such container
         :statuscode 500: server error

+ 5 - 0
docs/sources/reference/api/docker_remote_api_v1.11.md

@@ -461,6 +461,11 @@ Kill the container `id`
 
         HTTP/1.1 204 OK
 
+    Query Parameters
+
+    -   **signal** - Signal to send to the container: integer or string like "SIGINT".
+        When not set, SIGKILL is assumed and the call will waits for the container to exit.
+
     Status Codes:
 
     -   **204** – no error

+ 1 - 0
docs/sources/reference/api/docker_remote_api_v1.11.rst

@@ -468,6 +468,7 @@ Kill a container
 
            HTTP/1.1 204 OK
 
+        :query signal: Signal to send to the container, must be integer or string (i.e. SIGINT). When not set, SIGKILL is assumed and the call will waits for the container to exit.
         :statuscode 204: no error
         :statuscode 404: no such container
         :statuscode 500: server error

+ 5 - 0
docs/sources/reference/api/docker_remote_api_v1.9.md

@@ -482,6 +482,11 @@ Kill the container `id`
 
         HTTP/1.1 204 OK
 
+    Query Parameters
+
+    -   **signal** - Signal to send to the container: integer or string like "SIGINT".
+        When not set, SIGKILL is assumed and the call will waits for the container to exit.
+
     Status Codes:
 
     -   **204** – no error

+ 1 - 0
docs/sources/reference/api/docker_remote_api_v1.9.rst

@@ -480,6 +480,7 @@ Kill a container
 
            HTTP/1.1 204 OK
 
+        :query signal: Signal to send to the container, must be integer or string (i.e. SIGINT). When not set, SIGKILL is assumed and the call will waits for the container to exit.
         :statuscode 204: no error
         :statuscode 404: no such container
         :statuscode 500: server error