openstack/keystone
Code Issues Proposed changes

api-ref: Splitting status lines in API v3.

Browse Source 
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.

Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
This commit is contained in:
Anh Tran 2016-08-25 13:14:34 +07:00
parent 5685990287
commit 43df6125f9
12 changed files with 101 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api-ref/source/v3/authenticate-v3.inc
View File

@ -99,6 +99,7 @@ authentication method, which is ``password``, and the user, by ID
or name, and password credentials.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -154,6 +155,7 @@ The request body must include a payload that specifies the
``project`` or ``domain`` authorization scope.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -218,6 +220,7 @@ The request body must include a payload that specifies the
``unscoped`` authorization scope.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -272,6 +275,7 @@ Authenticates an identity and generates a token. Uses the token authentication m
In the request body, provide the token ID.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -314,6 +318,7 @@ In the request body, provide the token ID and the ``project`` or
``domain`` authorization scope.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -360,6 +365,7 @@ Pass the token that you want to validate in the ``X-Subject-Token``
request header.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -419,6 +425,7 @@ indicates that the ``X-Subject-Token`` is valid.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -445,6 +452,7 @@ of the ``expires_at`` attribute value. An additional
``X-Auth-Token`` is not required.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -472,6 +480,7 @@ if it was generated using ?nocatalog).
The structure of the catalog object is identical to that contained in a token.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -515,6 +524,7 @@ The structure of the response is exactly the same as listing projects
for a user.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -558,6 +568,7 @@ to based on the X-Auth-Token provided in the request.
The structure is the same as listing domains.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request

5
api-ref/source/v3/credentials.inc
View File

@ -30,6 +30,7 @@ credentials, such as ``access_key``, change the type and contents
of the data blob.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -76,6 +77,7 @@ Optionally, you can include the ``user_id`` query parameter in the
URI to filter the response by a user.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -115,6 +117,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credentia
Shows details for a credential.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -154,6 +157,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credentia
Updates a credential.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -204,6 +208,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/credentia
Deletes a credential.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request

12
api-ref/source/v3/domains-config-v3.inc
View File

@ -76,6 +76,7 @@ Relationship:
The API supports only the ``identity`` and ``ldap`` groups.
Normal response codes: 200
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -118,6 +119,7 @@ The API supports only the ``identity`` and ``ldap`` groups. For the
the ``identity`` group, a valid value is ``driver``.
Normal response codes: 200
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -158,6 +160,7 @@ The API supports only the ``identity`` and ``ldap`` groups. For the
the ``identity`` group, a valid value is ``driver``.
Normal response codes: 200
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -202,6 +205,7 @@ The API supports only the ``identity`` and ``ldap`` groups. For the
the ``identity`` group, a valid value is ``driver``.
Normal response codes: 200
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Request
@ -258,6 +262,7 @@ The API supports only the ``identity`` and ``ldap`` groups. For the
the ``identity`` group, a valid value is ``driver``.
Normal response codes: 204
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Request
@ -282,6 +287,7 @@ Shows details for a domain group configuration.
The API supports only the ``identity`` and ``ldap`` groups.
Normal response codes: 200
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -325,6 +331,7 @@ try to set configuration options for other groups, this call fails
with the ``Forbidden (403)`` response code.
Normal response codes: 200
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Request
@ -378,6 +385,7 @@ Deletes a domain group configuration.
The API supports only the ``identity`` and ``ldap`` groups.
Normal response codes: 204
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Request
@ -399,6 +407,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_co
Creates a domain configuration.
Normal response codes: 200, 201
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -449,6 +458,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_co
Shows details for a domain configuration.
Normal response codes: 200
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -487,6 +497,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_co
Updates a domain configuration.
Normal response codes: 200
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Request
@ -537,6 +548,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_co
Deletes a domain configuration.
Normal response codes: 204
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
Request

5
api-ref/source/v3/domains.inc
View File

@ -33,6 +33,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domains``
Lists all domains.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -72,6 +73,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domains``
Creates a domain.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -113,6 +115,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domains``
Shows details for a domain.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -151,6 +154,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain``
Updates a domain.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -209,6 +213,7 @@ If you try to delete an enabled domain, this call returns the
``Forbidden (403)`` response code.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request

7
api-ref/source/v3/groups.inc
View File

@ -30,6 +30,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group``
Shows details for a group.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request
@ -71,6 +72,7 @@ If the back-end driver does not support this functionality, the
call returns the ``Not Implemented (501)`` response code.
Normal response codes: 200
Error response codes:413,415,405,404,403,401,400,503,409,
Request
@ -158,6 +160,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Removes a user from a group.
Normal response codes: 204
Error response codes:413,415,405,404,403,401,400,503,409,
Request
@ -179,6 +182,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Validates that a user belongs to a group.
Normal response codes: 204
Error response codes:413,405,404,403,401,400,503,
Request
@ -200,6 +204,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/group_use
Lists the users that belong to a group.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request
@ -226,6 +231,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/groups``
Creates a group.
Normal response codes: 201
Error response codes:413,415,405,404,403,401,400,503,409,
Request
@ -272,6 +278,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/groups``
Lists groups.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request

1
api-ref/source/v3/inherit.inc
View File

@ -504,4 +504,5 @@ would return:
:language: javascript
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 405, 413, 503

5
api-ref/source/v3/policies.inc
View File

@ -32,6 +32,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policies`
Creates a policy.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -75,6 +76,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policies`
Lists policies.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -114,6 +116,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policy``
Shows details for a policy.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -153,6 +156,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policy``
Updates a policy.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -203,6 +207,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/policy``
Deletes a policy.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request

7
api-ref/source/v3/projects.inc
View File

@ -37,6 +37,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/projects`
Lists projects.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -83,6 +84,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/projects`
Creates a project, including a project acting as a domain.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -133,6 +135,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
Shows details for a project.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -190,6 +193,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
Updates a project.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -243,6 +247,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project``
Deletes a project.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -274,6 +279,7 @@ If you perform this action against a project that acts as a domain
``Forbidden (403)`` response code.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -327,6 +333,7 @@ in the hierarchy. You must disable all the projects in the subtree
before you perform this operation.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request

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

@ -25,6 +25,7 @@ Relationship: ``http://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
Request
@ -69,6 +70,7 @@ 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
Request
@ -120,6 +122,7 @@ The following error might occur:
child regions.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -140,6 +143,7 @@ Relationship: ``http://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
Request
@ -192,6 +196,7 @@ The following errors might occur:
the OpenStack deployment.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request

28
api-ref/source/v3/roles.inc
View File

@ -88,6 +88,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_g
Assigns a role to a group on a project.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -110,6 +111,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_g
Validates that a group has a role assignment on a project.
Normal response codes: 204
Error response codes: 413,405,404,403,401,400,503
Request
@ -132,6 +134,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_g
Unassigns a role from a group on a project.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -154,6 +157,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_u
Assigns a role to a user on a project.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -176,6 +180,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_u
Validates that a user has a role on a project.
Normal response codes: 204
Error response codes: 413,405,404,403,401,400,503
Request
@ -198,6 +203,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_u
Unassigns a role from a user on a project.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -220,6 +226,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_u
Lists role assignments for a user on a project.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -247,6 +254,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/project_u
Lists role assignments for a group on a project.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -279,6 +287,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_gr
Assigns a role to a group on a domain.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -300,6 +309,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_gr
Validates that a group has a role assignment on a domain.
Normal response codes: 204
Error response codes: 413,405,404,403,401,400,503
Request
@ -322,6 +332,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_gr
Unassigns a role from a group on a domain.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -344,6 +355,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_us
Lists role assignments for a user on a domain.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -386,6 +398,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/roles``
Lists roles.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -425,6 +438,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/roles``
Creates a role.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -470,6 +484,7 @@ Relationship: ``http://developer.openstack.org/api-ref-identity-v3.html#assignRo
Assigns a role to a user on a domain.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -492,6 +507,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_us
Validates that a user has a role assignment on a domain.
Normal response codes: 204
Error response codes: 413,405,404,403,401,400,503
Request
@ -514,6 +530,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_us
Unassigns a role from a user on a domain.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -535,6 +552,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/domain_gr
Lists role assignments for a group on a domain.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -566,6 +584,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role_assi
Lists role assignments.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -606,6 +625,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role``
Shows details for a role.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -643,6 +663,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role``
Updates a role.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -688,6 +709,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/role``
Deletes a role.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -708,6 +730,7 @@ Relationship:
``http://developer.openstack.org/api-ref-identity-v3.html#getRoleInference``
Normal response codes: 200
Error response codes: 401, 404
Request
@ -746,6 +769,7 @@ Relationship:
``http://developer.openstack.org/api-ref-identity-v3.html#createRoleInference``
Normal response codes: 201
Error response codes: 401, 404
Request
@ -785,6 +809,7 @@ Relationship:
``http://developer.openstack.org/api-ref-identity-v3.html#getRoleInference``
Normal response codes: 200
Error response codes: 401, 404
Request
@ -824,6 +849,7 @@ Relationship:
``http://developer.openstack.org/api-ref-identity-v3.html#getRoleInference``
Normal response codes: 204
Error response codes: 401, 404
Request
@ -850,6 +876,7 @@ Relationship:
``http://developer.openstack.org/api-ref-identity-v3.html#deleteRoleInference``
Normal response codes: 204
Error response codes: 401, 404
.. rest_parameters:: parameters.yaml
@ -870,6 +897,7 @@ List all role inference rules
Lists all role inference rules.
Normal response codes: 200
Error response codes: 401, 404
Relationship:

10
api-ref/source/v3/service-catalog.inc
View File

@ -29,6 +29,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/services`
Lists all services.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -68,6 +69,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/services`
Creates a service.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -111,6 +113,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoints
Shows details for an endpoint.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -150,6 +153,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoint`
Updates an endpoint.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -200,6 +204,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoint`
Deletes an endpoint.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -220,6 +225,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoints
Lists all available endpoints.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -262,6 +268,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/endpoints
Creates an endpoint.
Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -308,6 +315,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/service``
Shows details for a service.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
@ -350,6 +358,7 @@ except that you include only those attributes that you want to
update.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
@ -403,6 +412,7 @@ this call either deletes all associated endpoints or fails until
all endpoints are deleted.
Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409
Request

5
api-ref/source/v3/users.inc
View File

@ -27,6 +27,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user``
Shows details for a user.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request
@ -71,6 +72,7 @@ If the back-end driver does not support this functionality, this
call might return the HTTP ``Not Implemented (501)`` response code.
Normal response codes: 200
Error response codes:413,415,405,404,403,401,400,503,409,
Request
@ -142,6 +144,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_grou
Lists groups to which a user belongs.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request
@ -240,6 +243,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Lists users.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request
@ -283,6 +287,7 @@ Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_proj
List projects for a user.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Request