openstack/keystone
Code Issues Proposed changes

Reorganize api-ref: v3 regions-v3

Browse Source 
Reorganize as per the documentation session at PTG:
https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup

Change-Id: Ia536a36a6cab51c4b6911da1726281c196b54d22
This commit is contained in:
Suramya Shah
2017-12-29 19:17:35 +05:30
parent 3d80ded1da
commit f80b8dd2ec
1 changed files with 143 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

186
api-ref/source/v3/regions-v3.inc
View File

@@ -20,23 +20,25 @@ Show region details
.. rest_method:: GET /v3/regions/{region_id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
Shows details for a region, by ID.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- region_id: region_id_path
Response Parameters
-------------------
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
@@ -46,8 +48,25 @@ Response Parameters
- links: links_region
- parent_region_id: parent_region_id_response_body
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 413
- 405
- 404
- 403
- 401
- 400
- 503
Example
~~~~~~~
.. literalinclude:: ./samples/admin/region-show-response.json
:language: javascript
@@ -58,8 +77,6 @@ Update region
.. rest_method:: PATCH /v3/regions/{region_id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/region``
Updates a region.
You can update the description or parent region ID for a region.
@@ -69,13 +86,14 @@ The following error might occur:
- ``Not Found (404)``. The parent region ID does not exist.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/region``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- region_id: region_id_path
@@ -83,14 +101,17 @@ Request
- description: description_region_request_body
- parent_region_id: parent_region_id_request_body
Request Example
---------------
Example
~~~~~~~
.. literalinclude:: ./samples/admin/region-update-request.json
:language: javascript
Response Parameters
-------------------
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
@@ -100,8 +121,27 @@ Response Parameters
- links: links_region
- parent_region_id: parent_region_id_response_body
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 413
- 415
- 405
- 404
- 403
- 401
- 400
- 503
- 409
Example
~~~~~~~
.. literalinclude:: ./samples/admin/region-update-response.json
:language: javascript
@@ -112,8 +152,6 @@ Delete region
.. rest_method:: DELETE /v3/regions/{region_id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/region``
Deletes a region.
The following error might occur:
@@ -121,40 +159,64 @@ The following error might occur:
- ``Conflict (409)``. The region cannot be deleted because it has
child regions.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/region``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- region_id: region_id_path
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 413
- 415
- 405
- 404
- 403
- 401
- 400
- 503
- 409
List regions
============
.. rest_method:: GET /v3/regions
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
Lists regions.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- parent_region_id: parent_region_id_query_not_required
Response Parameters
-------------------
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
@@ -164,8 +226,25 @@ Response Parameters
- links: links_region
- parent_region_id: parent_region_id_response_body
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 413
- 405
- 404
- 403
- 401
- 400
- 503
Example
~~~~~~~
.. literalinclude:: ./samples/admin/regions-list-response.json
:language: javascript
@@ -176,8 +255,6 @@ Create region
.. rest_method:: POST /v3/regions
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
Creates a region.
When you create the region, you can optionally specify a region ID.
@@ -195,13 +272,14 @@ The following errors might occur:
- ``Conflict (409)``. The user-defined region ID is not unique to
the OpenStack deployment.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- region: region_object
@@ -209,14 +287,17 @@ Request
- id: id_region_resquest_body
- parent_region_id: parent_region_id_request_body
Request Example
---------------
Example
~~~~~~~
.. literalinclude:: ./samples/admin/region-create-request.json
:language: javascript
Response Parameters
-------------------
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
@@ -225,3 +306,22 @@ Response Parameters
- id: id_region_response_body
- links: links_region
- parent_region_id: parent_region_id_response_body
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 413
- 415
- 405
- 404
- 403
- 401
- 400
- 503
- 409