kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

add missing status code in api docs

Browse source 
Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit 9a1f7b6b0b)
Signed-off-by: Victor Vieux <victorvieux@gmail.com>
This commit is contained in:
allencloud 2016-11-13 11:09:38 +08:00 • committed by Victor Vieux
parent 1b195847f4
commit 69f3cb179e
1 changed files with 43 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/api/v1.24.md
View file

@ -3963,6 +3963,7 @@ List nodes
**Status codes**: **Status codes**:
- **200** – no error - **200** – no error
- **406** - node is not part of a swarm
- **500** – server error - **500** – server error
#### Inspect a node #### Inspect a node
@ -4045,6 +4046,7 @@ Return low-level information on the node `id`
- **200** – no error - **200** – no error
- **404** – no such node - **404** – no such node
- **406** – node is not part of a swarm
- **500** – server error - **500** – server error
#### Remove a node #### Remove a node
@ -4073,6 +4075,7 @@ Remove a node from the swarm.
- **200** – no error - **200** – no error
- **404** – no such node - **404** – no such node
- **406** – node is not part of a swarm
- **500** – server error - **500** – server error
#### Update a node #### Update a node
@ -4128,6 +4131,7 @@ JSON Parameters:
- **200** – no error - **200** – no error
- **404** – no such node - **404** – no such node
- **406** – node is not part of a swarm
- **500** – server error - **500** – server error
### 3.8 Swarm ### 3.8 Swarm
@ -4179,6 +4183,8 @@ Inspect swarm
**Status codes**: **Status codes**:
- **200** - no error - **200** - no error
- **406** – node is not part of a swarm
- **500** - sever error
#### Initialize a new swarm #### Initialize a new swarm
@ -4219,6 +4225,7 @@ Initialize a new swarm. The body of the HTTP response includes the node ID.
- **200** – no error - **200** – no error
- **400** – bad parameter - **400** – bad parameter
- **406** – node is already part of a swarm - **406** – node is already part of a swarm
- **500** - server error
JSON Parameters: JSON Parameters:
@ -4285,6 +4292,7 @@ Join an existing swarm
- **200** – no error - **200** – no error
- **400** – bad parameter - **400** – bad parameter
- **406** – node is already part of a swarm - **406** – node is already part of a swarm
- **500** - server error
JSON Parameters: JSON Parameters:
@ -4323,6 +4331,7 @@ Leave a swarm
- **200** – no error - **200** – no error
- **406** – node is not part of a swarm - **406** – node is not part of a swarm
- **500** - server error
#### Update a swarm #### Update a swarm
@ -4377,6 +4386,7 @@ Update a swarm
- **200** – no error - **200** – no error
- **400** – bad parameter - **400** – bad parameter
- **406** – node is not part of a swarm - **406** – node is not part of a swarm
- **500** - server error
JSON Parameters: JSON Parameters:
@ -4512,6 +4522,7 @@ List services
**Status codes**: **Status codes**:
- **200** – no error - **200** – no error
- **406** – node is not part of a swarm
- **500** – server error - **500** – server error
#### Create a service #### Create a service
@ -4607,8 +4618,9 @@ image](#create-an-image) section for more details.
**Status codes**: **Status codes**:
- **201** – no error - **201** – no error
- **406** – server error or node is not part of a swarm - **406** – node is not part of a swarm
- **409** – name conflicts with an existing object - **409** – name conflicts with an existing object
- **500** - server error
**JSON Parameters**: **JSON Parameters**:
@ -4708,6 +4720,7 @@ Stop and remove the service `id`
- **200** – no error - **200** – no error
- **404** – no such service - **404** – no such service
- **406** - node is not part of a swarm
- **500** – server error - **500** – server error
#### Inspect one or more services #### Inspect one or more services
@ -4797,6 +4810,7 @@ Return information on the service `id`.
- **200** – no error - **200** – no error
- **404** – no such service - **404** – no such service
- **406** - node is not part of a swarm
- **500** – server error - **500** – server error
#### Update a service #### Update a service
@ -4930,6 +4944,7 @@ image](#create-an-image) section for more details.
- **200** – no error - **200** – no error
- **404** – no such service - **404** – no such service
- **406** - node is not part of a swarm
- **500** – server error - **500** – server error
### 3.10 Tasks ### 3.10 Tasks
@ -5132,14 +5147,15 @@ List tasks
**Status codes**: **Status codes**:
- **200** – no error - **200** – no error
- **406** - node is not part of a swarm
- **500** – server error - **500** – server error
#### Inspect a task #### Inspect a task
`GET /tasks/(task id)` `GET /tasks/(id)`
Get details on a task Get details on the task `id`
**Example request**: **Example request**:
@ -5235,6 +5251,7 @@ Get details on a task
- **200** – no error - **200** – no error
- **404** – unknown task - **404** – unknown task
- **406** - node is not part of a swarm
- **500** – server error - **500** – server error
## 4. Going further ## 4. Going further