From d3c9954506c2789545d162e730cf188f5bdc9d32 Mon Sep 17 00:00:00 2001
From: miaohb <miao.hongbao@zte.com.cn>
Date: Mon, 23 Oct 2017 00:54:51 -0700
Subject: [PATCH] Add api-ref for container kill

This patch adds api-ref for container kill.

Change-Id: Icd13077d10b44f9d6b3b56599de8c84922055f48
Closes-Bug: #1720927
---
 api-ref/source/containers.inc  | 42 +++++++++++++++++++++++++++++++++-
 api-ref/source/parameters.yaml |  6 +++++
 2 files changed, 47 insertions(+), 1 deletion(-)

diff --git a/api-ref/source/containers.inc b/api-ref/source/containers.inc
index 671e7fbc0..d48480746 100644
--- a/api-ref/source/containers.inc
+++ b/api-ref/source/containers.inc
@@ -5,7 +5,7 @@
 ===================
 
 Lists, creates, shows details for, stats, updates, deletes, starts, resizes,
-stops, pauses, unpauses, restarts, renames, commits, attaches to containers,
+stops, pauses, unpauses, restarts, renames, commits, kills, attaches to containers,
 gets archive from container, puts archive to container, and adds security group
 for specified container, gets logs of a container, displays the running
 processes in a container.
@@ -254,6 +254,46 @@ This request does not return anything in the response body.
   - X-Openstack-Request-Id: request_id
 
 
+Kill a container
+================
+
+.. rest_method:: POST /v1/containers/{container_ident}/kill?signal={signal}
+
+Kill a running container.
+
+Response Codes
+--------------
+
+.. rest_status_code:: success status.yaml
+
+   - 202
+
+.. rest_status_code:: error status.yaml
+
+   - 400
+   - 401
+   - 403
+   - 404
+   - 409
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - container_ident: container_ident
+  - signal: signal
+
+Response
+--------
+
+This request does not return anything in the response body.
+
+.. rest_parameters:: parameters.yaml
+
+  - X-Openstack-Request-Id: request_id
+
+
 Display stats of a container
 ============================
 
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index e8b305463..1630e4b48 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -65,6 +65,12 @@ security_group_query:
   in: query
   required: true
   type: string
+signal:
+  description: |
+    The signal to kill a container.
+  in: query
+  required: false
+  type: string
 since:
   description: |
     Show logs since a given datetime or integer epoch (in seconds).