From 52e8f17990ef205fb2e2685c40eea80476ca55ad Mon Sep 17 00:00:00 2001 From: Zhenguo Niu Date: Thu, 14 Sep 2017 13:20:01 +0800 Subject: [PATCH] Revise some API docs Change-Id: I8a7f0a241614f2a31ebdcc304ff4143d33af5517 --- api-ref/source/v1/flavors.inc | 4 ---- api-ref/source/v1/index.rst | 1 + api-ref/source/v1/manageable_servers.inc | 6 ++---- api-ref/source/v1/parameters.yaml | 7 +++++++ ...able-servers-create-req.json => server-manage-req.json} | 0 ...le-servers-create-resp.json => server-manage-resp.json} | 0 api-ref/source/v1/server_groups.inc | 2 +- 7 files changed, 11 insertions(+), 9 deletions(-) rename api-ref/source/v1/samples/manageable_servers/{manageable-servers-create-req.json => server-manage-req.json} (100%) rename api-ref/source/v1/samples/manageable_servers/{manageable-servers-create-resp.json => server-manage-resp.json} (100%) diff --git a/api-ref/source/v1/flavors.inc b/api-ref/source/v1/flavors.inc index 49b2d079..7c9a6d95 100644 --- a/api-ref/source/v1/flavors.inc +++ b/api-ref/source/v1/flavors.inc @@ -21,10 +21,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - - Response -------- diff --git a/api-ref/source/v1/index.rst b/api-ref/source/v1/index.rst index ea8471b9..d381fe21 100644 --- a/api-ref/source/v1/index.rst +++ b/api-ref/source/v1/index.rst @@ -16,3 +16,4 @@ Baremetal Compute API V1 (CURRENT) .. include:: availability_zones.inc .. include:: aggregates.inc .. include:: server_groups.inc +.. include:: manageable_servers.inc diff --git a/api-ref/source/v1/manageable_servers.inc b/api-ref/source/v1/manageable_servers.inc index 46449e78..3f7d60ae 100644 --- a/api-ref/source/v1/manageable_servers.inc +++ b/api-ref/source/v1/manageable_servers.inc @@ -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 diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index fb11d9ed..44794880 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -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. diff --git a/api-ref/source/v1/samples/manageable_servers/manageable-servers-create-req.json b/api-ref/source/v1/samples/manageable_servers/server-manage-req.json similarity index 100% rename from api-ref/source/v1/samples/manageable_servers/manageable-servers-create-req.json rename to api-ref/source/v1/samples/manageable_servers/server-manage-req.json diff --git a/api-ref/source/v1/samples/manageable_servers/manageable-servers-create-resp.json b/api-ref/source/v1/samples/manageable_servers/server-manage-resp.json similarity index 100% rename from api-ref/source/v1/samples/manageable_servers/manageable-servers-create-resp.json rename to api-ref/source/v1/samples/manageable_servers/server-manage-resp.json diff --git a/api-ref/source/v1/server_groups.inc b/api-ref/source/v1/server_groups.inc index 10a5343d..3371cce0 100644 --- a/api-ref/source/v1/server_groups.inc +++ b/api-ref/source/v1/server_groups.inc @@ -22,7 +22,7 @@ Request .. rest_parameters:: parameters.yaml - - all_tenants: all_tenants + - all_tenants: group_all_tenants Response --------