Tweak api-ref for v3 groups status codes

This patch changes the representation of response codes using tables.
Some error codes that are never returned from keystone are removed.
For example, 503 service unavailable is never returned from keystone.

Change-Id: I5e1e0ea1dab7dcb229bce44199f57a9a3bd45ae8
This commit is contained in:
tengqm 2016-09-09 03:07:22 -04:00
parent fb6ff30009
commit a20d66c1b0

@ -29,12 +29,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group``
Shows details for a group.
Normal response codes: 200
Response Codes
--------------
Error response codes:413,405,404,403,401,400,503,
.. rest_status_code:: success status.yaml
Request
-------
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -71,12 +81,24 @@ Updates a group.
If the back-end driver does not support this functionality, the
call returns the ``Not Implemented (501)`` response code.
Normal response codes: 200
Response Codes
--------------
Error response codes:413,415,405,404,403,401,400,503,409,
.. rest_status_code:: success status.yaml
Request
-------
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
- 501
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -120,12 +142,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group``
Deletes a group.
Normal response codes: 204
Response Codes
--------------
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
.. rest_status_code:: success status.yaml
Request
-------
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -141,12 +173,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Adds a user to a group.
Normal response codes: 200
Response Codes
--------------
Error response codes: 413,415,405,404,403,401,400,503,409
.. rest_status_code:: success status.yaml
Request
-------
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -163,12 +205,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Removes a user from a group.
Normal response codes: 204
Response Codes
--------------
Error response codes:413,415,405,404,403,401,400,503,409,
.. rest_status_code:: success status.yaml
Request
-------
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -185,12 +237,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Validates that a user belongs to a group.
Normal response codes: 204
Response Codes
--------------
Error response codes:413,405,404,403,401,400,503,
.. rest_status_code:: success status.yaml
Request
-------
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -207,12 +269,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Lists the users that belong to a group.
Normal response codes: 200
Response Codes
--------------
Error response codes:413,405,404,403,401,400,503,
.. rest_status_code:: success status.yaml
Request
-------
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -234,12 +306,22 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/groups``
Creates a group.
Normal response codes: 201
Response Codes
--------------
Error response codes:413,415,405,404,403,401,400,503,409,
.. rest_status_code:: success status.yaml
Request
-------
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
@ -272,6 +354,7 @@ Response Example
.. literalinclude:: ./samples/admin/group-show-response.json
:language: javascript
List groups
===========
@ -281,12 +364,21 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/groups``
Lists groups.
Normal response codes: 200
Response Codes
--------------
Error response codes:413,405,404,403,401,400,503,
.. rest_status_code:: success status.yaml
Request
-------
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request Parameters
------------------
.. rest_parameters:: parameters.yaml