From bceeecc296c56b29de079cd4f65b6165ecc22a55 Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Thu, 21 Jul 2016 16:42:57 +0900 Subject: [PATCH] Separate api-ref for list security groups by server All proxy APIs are now deprecated which includes sec grp APIs also. But list sec grps by server API- (/servers/{server_id}/os-security-groups) is not deprecated so this should be separated from deprecated sec grp APIs in api-ref. Partially implements blueprint deprecate-api-proxies Change-Id: I9f9e2cf5f8e390cecd9e1794a0af1a3fcc24f149 --- api-ref/source/index.rst | 1 + api-ref/source/os-security-groups.inc | 36 ------------------- api-ref/source/server-security-groups.inc | 43 +++++++++++++++++++++++ 3 files changed, 44 insertions(+), 36 deletions(-) create mode 100644 api-ref/source/server-security-groups.inc diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 2a80409bcd6f..d505650938ff 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -18,6 +18,7 @@ .. include:: servers-action-shelve.inc .. include:: servers-action-crash-dump.inc .. include:: servers-admin-action.inc +.. include:: server-security-groups.inc .. include:: diagnostics.inc .. include:: ips.inc .. include:: metadata.inc diff --git a/api-ref/source/os-security-groups.inc b/api-ref/source/os-security-groups.inc index bac81c51dbd2..d5fe30229707 100644 --- a/api-ref/source/os-security-groups.inc +++ b/api-ref/source/os-security-groups.inc @@ -190,39 +190,3 @@ Response -------- There is no body content for the response of a successful DELETE query. - -List Security Groups By Server -============================== - -.. rest_method:: GET /servers/{server_id}/os-security-groups - -Lists security groups for a server. - -Normal response codes: 200 - -Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) - -Request -------- - -.. rest_parameters:: parameters.yaml - - - server_id: server_id - -Response --------- - -.. rest_parameters:: parameters.yaml - - - security_groups: security_groups - - description: description - - id: id - - name: name - - rules: rules - - tenant_id: tenant_id_body - - -**Example List security groups by server: JSON response** - -.. literalinclude:: ../../doc/api_samples/os-security-groups/server-security-groups-list-resp.json - :language: javascript diff --git a/api-ref/source/server-security-groups.inc b/api-ref/source/server-security-groups.inc new file mode 100644 index 000000000000..b3c7d615f34f --- /dev/null +++ b/api-ref/source/server-security-groups.inc @@ -0,0 +1,43 @@ +.. -*- rst -*- + +====================================================== + Servers Security Groups (servers, os-security-groups) +====================================================== + +Lists Security Groups for a server instance. + +List Security Groups By Server +============================== + +.. rest_method:: GET /servers/{server_id}/os-security-groups + +Lists security groups for a server. + +Normal response codes: 200 + +Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - server_id: server_id + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - security_groups: security_groups + - description: description + - id: id + - name: name + - rules: rules + - tenant_id: tenant_id_body + + +**Example List security groups by server: JSON response** + +.. literalinclude:: ../../doc/api_samples/os-security-groups/server-security-groups-list-resp.json + :language: javascript