Revise some API docs

Change-Id: I8a7f0a241614f2a31ebdcc304ff4143d33af5517
This commit is contained in:
Zhenguo Niu 2017-09-14 13:20:01 +08:00
parent d88fd1008a
commit 52e8f17990
7 changed files with 11 additions and 9 deletions

View File

@ -21,10 +21,6 @@ Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Request
-------
Response
--------

View File

@ -16,3 +16,4 @@ Baremetal Compute API V1 (CURRENT)
.. include:: availability_zones.inc
.. include:: aggregates.inc
.. include:: server_groups.inc
.. include:: manageable_servers.inc

View File

@ -32,8 +32,6 @@ Response
- portgroups: manageable_servers_portgroups
- image_source: manageable_servers_image_source
|
**Example List manageable servers information**
.. literalinclude:: samples/manageable_servers/manageable-servers-list-resp.json
@ -65,7 +63,7 @@ Request
**Example Manage Server: JSON request**
.. literalinclude:: samples/servers/manageable-server-create-req.json
.. literalinclude:: samples/manageable_servers/server-manage-req.json
:language: javascript
Response
@ -96,5 +94,5 @@ Response
**Example Manage Server: JSON response**
.. literalinclude:: samples/servers/manageable-server-manage-resp.json
.. literalinclude:: samples/manageable_servers/server-manage-resp.json
:language: javascript

View File

@ -109,6 +109,13 @@ flavor_query:
in: query
required: false
type: string
group_all_tenants:
description: |
Specify the ``all_tenants=1`` query parameter to list server groups
for all projects. By default this is only allowed by admin users.
in: query
required: false
type: integer
image_query:
description: |
Filters the server list by image's UUID.

View File

@ -22,7 +22,7 @@ Request
.. rest_parameters:: parameters.yaml
- all_tenants: all_tenants
- all_tenants: group_all_tenants
Response
--------