Browse code

[Documentation - API] Add missing 'signal' parameter for /containers/:id/kill endpoint

Docker-DCO-1.1-Signed-off-by: Leo Unbekandt <leo.unbekandt@appsdeck.eu> (github: Soulou)

Soulou authored on 2014/03/11 18:30:51
Showing 8 changed files
... ...
@@ -454,6 +454,7 @@ Kill a container
454 454
 
455 455
 	   HTTP/1.1 204 OK
456 456
 	   	
457
+	: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.
457 458
 	:statuscode 204: no error
458 459
 	:statuscode 404: no such container
459 460
 	:statuscode 500: server error
... ...
@@ -482,6 +482,7 @@ Kill a container
482 482
 
483 483
            HTTP/1.1 204 OK
484 484
 
485
+        :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.
485 486
         :statuscode 204: no error
486 487
         :statuscode 404: no such container
487 488
         :statuscode 500: server error
... ...
@@ -459,6 +459,11 @@ Kill the container `id`
459 459
 
460 460
         HTTP/1.1 204 OK
461 461
 
462
+    Query Parameters
463
+
464
+    -   **signal** - Signal to send to the container: integer or string like "SIGINT".
465
+        When not set, SIGKILL is assumed and the call will waits for the container to exit.
466
+
462 467
     Status Codes:
463 468
 
464 469
     -   **204** – no error
... ...
@@ -466,6 +466,7 @@ Kill a container
466 466
 
467 467
            HTTP/1.1 204 OK
468 468
 
469
+        :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.
469 470
         :statuscode 204: no error
470 471
         :statuscode 404: no such container
471 472
         :statuscode 500: server error
... ...
@@ -461,6 +461,11 @@ Kill the container `id`
461 461
 
462 462
         HTTP/1.1 204 OK
463 463
 
464
+    Query Parameters
465
+
466
+    -   **signal** - Signal to send to the container: integer or string like "SIGINT".
467
+        When not set, SIGKILL is assumed and the call will waits for the container to exit.
468
+
464 469
     Status Codes:
465 470
 
466 471
     -   **204** – no error
... ...
@@ -468,6 +468,7 @@ Kill a container
468 468
 
469 469
            HTTP/1.1 204 OK
470 470
 
471
+        :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.
471 472
         :statuscode 204: no error
472 473
         :statuscode 404: no such container
473 474
         :statuscode 500: server error
... ...
@@ -482,6 +482,11 @@ Kill the container `id`
482 482
 
483 483
         HTTP/1.1 204 OK
484 484
 
485
+    Query Parameters
486
+
487
+    -   **signal** - Signal to send to the container: integer or string like "SIGINT".
488
+        When not set, SIGKILL is assumed and the call will waits for the container to exit.
489
+
485 490
     Status Codes:
486 491
 
487 492
     -   **204** – no error
... ...
@@ -480,6 +480,7 @@ Kill a container
480 480
 
481 481
            HTTP/1.1 204 OK
482 482
 
483
+        :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.
483 484
         :statuscode 204: no error
484 485
         :statuscode 404: no such container
485 486
         :statuscode 500: server error