Revise some API docs
Change-Id: I8a7f0a241614f2a31ebdcc304ff4143d33af5517
This commit is contained in:
@@ -21,10 +21,6 @@ Normal response codes: 200
|
|||||||
|
|
||||||
Error response codes: unauthorized(401), forbidden(403)
|
Error response codes: unauthorized(401), forbidden(403)
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
@@ -16,3 +16,4 @@ Baremetal Compute API V1 (CURRENT)
|
|||||||
.. include:: availability_zones.inc
|
.. include:: availability_zones.inc
|
||||||
.. include:: aggregates.inc
|
.. include:: aggregates.inc
|
||||||
.. include:: server_groups.inc
|
.. include:: server_groups.inc
|
||||||
|
.. include:: manageable_servers.inc
|
||||||
|
@@ -32,8 +32,6 @@ Response
|
|||||||
- portgroups: manageable_servers_portgroups
|
- portgroups: manageable_servers_portgroups
|
||||||
- image_source: manageable_servers_image_source
|
- image_source: manageable_servers_image_source
|
||||||
|
|
||||||
|
|
|
||||||
|
|
||||||
**Example List manageable servers information**
|
**Example List manageable servers information**
|
||||||
|
|
||||||
.. literalinclude:: samples/manageable_servers/manageable-servers-list-resp.json
|
.. literalinclude:: samples/manageable_servers/manageable-servers-list-resp.json
|
||||||
@@ -65,7 +63,7 @@ Request
|
|||||||
|
|
||||||
**Example Manage Server: JSON request**
|
**Example Manage Server: JSON request**
|
||||||
|
|
||||||
.. literalinclude:: samples/servers/manageable-server-create-req.json
|
.. literalinclude:: samples/manageable_servers/server-manage-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
Response
|
Response
|
||||||
@@ -96,5 +94,5 @@ Response
|
|||||||
|
|
||||||
**Example Manage Server: JSON response**
|
**Example Manage Server: JSON response**
|
||||||
|
|
||||||
.. literalinclude:: samples/servers/manageable-server-manage-resp.json
|
.. literalinclude:: samples/manageable_servers/server-manage-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@@ -109,6 +109,13 @@ flavor_query:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
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:
|
image_query:
|
||||||
description: |
|
description: |
|
||||||
Filters the server list by image's UUID.
|
Filters the server list by image's UUID.
|
||||||
|
@@ -22,7 +22,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- all_tenants: all_tenants
|
- all_tenants: group_all_tenants
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
Reference in New Issue
Block a user