Add api-ref for container commit

This patch adds api-ref for container commit.

Change-Id: Ibcb7846cd9d0c00c385196635d9b9b03c65dba82
Partially-Implements: bp zun-api-doc
This commit is contained in:
miaohb 2017-08-26 00:34:28 -07:00
parent 8f985147e8
commit f39ad3fbd2
2 changed files with 50 additions and 1 deletions

View File

@ -5,7 +5,7 @@
===================
Lists, creates, shows details for, stats, updates, deletes, starts,
stops, pauses, unpauses, restarts, renames containers, and adds
stops, pauses, unpauses, restarts, renames, commits containers, and adds
security group for specified container.
Create new container
@ -654,3 +654,41 @@ This request does not return anything in the response body.
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
Commit a container
==================
.. rest_method:: POST /v1/containers/{container_ident}/commit?tag={tag}&repository={repository}
Create a new image from a container's changes
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
- 409
Request
-------
.. rest_parameters:: parameters.yaml
- container_ident: container_ident
- repository: repository
- tag: tag
Response
--------
.. rest_parameters:: parameters.yaml
- image: image

View File

@ -217,6 +217,11 @@ report_count:
in: body
required: true
type: integer
repository:
description: |
The reposiroty of the container image.
in: body
type: string
restart_policy:
description: |
Restart policy to apply when a container exits. Allowed values are
@ -277,6 +282,12 @@ status_reason:
in: body
required: true
type: string
tag:
description: |
The tag of the container image.
in: body
required: true
type: string
task_state:
description: |
The current task of the container.