From 17f96bb8753c4dbac1b1b82704eb057b544e9af5 Mon Sep 17 00:00:00 2001 From: Anh Tran Date: Thu, 25 Aug 2016 13:21:06 +0700 Subject: [PATCH] api-ref: Splitting status lines in API v3-ext. Currently, 'Normal response codes' and 'Error response codes' are in the same line. We should split them. Change-Id: I1684ebb668a6fe8339dc428dfd70d11ae1dca97c --- api-ref/source/v3-ext/ep-filter.inc | 18 ++++++++++++++++++ api-ref/source/v3-ext/oauth.inc | 14 ++++++++++++++ api-ref/source/v3-ext/trust.inc | 7 +++++++ 3 files changed, 39 insertions(+) diff --git a/api-ref/source/v3-ext/ep-filter.inc b/api-ref/source/v3-ext/ep-filter.inc index 1a101021ea..39489a29c8 100644 --- a/api-ref/source/v3-ext/ep-filter.inc +++ b/api-ref/source/v3-ext/ep-filter.inc @@ -40,6 +40,7 @@ Creates an association between ``project_id`` and ``endpoint_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint`` Normal response codes: 204 + Error response codes: 401 Request @@ -65,6 +66,7 @@ Verifies the existence of an association between ``project_id`` and ``endpoint_i Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint`` Normal response codes: 204 + Error response codes: 401 Request @@ -90,6 +92,7 @@ Removes the association between ``project_id`` and ``endpoint_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint`` Normal response codes: 204 + Error response codes: 401 Request @@ -115,6 +118,7 @@ Returns all the endpoints that are currently associated with ``project_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoints`` Normal response codes: 200 + Error response codes: 401 Request @@ -143,6 +147,7 @@ Returns all projects that are currently associated with ``endpoint_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_projects`` Normal response codes: 200 + Error response codes: 401 Request @@ -171,6 +176,7 @@ service endpoints having the same characteristics Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_groups`` Normal response codes: 201 + Error response codes: 401 Request @@ -203,6 +209,7 @@ Show details of an endpoint group. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group`` Normal response codes: 200 + Error response codes: 401 Request @@ -230,6 +237,7 @@ Determine if an endpoint group exists. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group`` Normal response codes: 200 + Error response codes: 401 Request @@ -254,6 +262,7 @@ Modify attributes of an endpoint group. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group`` Normal response codes: 200 + Error response codes: 401 Request @@ -287,6 +296,7 @@ Delete an endpoint group. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group`` Normal response codes: 204 + Error response codes: 401 Request @@ -311,6 +321,7 @@ List all available endpoint groups. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_groups`` Normal response codes: 200 + Error response codes: 401 Response @@ -331,6 +342,7 @@ Creates an associate between ``endpoint_group_id`` and ``project_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project`` Normal response codes: 204 + Error response codes: 401 Request @@ -356,6 +368,7 @@ Verifies the existence of an association between ``project_id`` and ``endpoint_g Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project`` Normal response codes: 200 + Error response codes: 401 Request @@ -384,6 +397,7 @@ Verifies the existence of an association between ``project_id`` and ``endpoint_g Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project`` Normal response codes: 200 + Error response codes: 401 Request @@ -409,6 +423,7 @@ Removes the association between ``project_id`` and ``endpoint_group_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project`` Normal response codes: 204 + Error response codes: 401 Request @@ -434,6 +449,7 @@ Returns all projects that are currently associated with ``endpoint_group_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_projects`` Normal response codes: 200 + Error response codes: 401 Request @@ -461,6 +477,7 @@ Returns all the endpoints that are currently associated with ``endpoint_group_id Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_endpoints`` Normal response codes: 200 + Error response codes: 401 Request @@ -488,6 +505,7 @@ Returns all the endpoints that are currently associated with ``project_id``. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint_groups`` Normal response codes: 200 + Error response codes: 401 Request diff --git a/api-ref/source/v3-ext/oauth.inc b/api-ref/source/v3-ext/oauth.inc index 1a191f11b0..d310cbe2b5 100644 --- a/api-ref/source/v3-ext/oauth.inc +++ b/api-ref/source/v3-ext/oauth.inc @@ -66,6 +66,7 @@ Enables a user to create a consumer. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/consumers`` Normal response codes: 201 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -108,6 +109,7 @@ tokens, and Identity API tokens are also revoked. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/consumer`` Normal response codes: 204 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -128,6 +130,7 @@ Lists consumers. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/consumers`` Normal response codes: 200 + Error response codes: 413, 405, 404, 403, 401, 400, 503 Response Example @@ -147,6 +150,7 @@ Shows details for a consumer. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/consumer`` Normal response codes: 200 + Error response codes: 413, 405, 404, 403, 401, 400, 503 Request @@ -176,6 +180,7 @@ If you try to update any attribute other than ``description``, an HTTP Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/consumer`` Normal response codes: 200 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -213,6 +218,7 @@ request. See `Consumer Obtains a Request Token Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/request_tokens`` Normal response codes: 200 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -250,6 +256,7 @@ returned. The Consumer receives the OAuth Verifier from the User out-of-band. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/authorize_request_token`` Normal response codes: 200 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -283,6 +290,7 @@ request. See `Consumer Requests an Access Token Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/access_tokens`` Normal response codes: 200 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Response Example @@ -311,6 +319,7 @@ Gets an access token. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token`` Normal response codes: 200 + Error response codes: 413, 405, 404, 403, 401, 400, 503 Request @@ -340,6 +349,7 @@ API tokens that were issued to the consumer through that access token. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token`` Normal response codes: 204 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -361,6 +371,7 @@ Lists authorized access tokens. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_tokens`` Normal response codes: 200 + Error response codes: 413, 405, 404, 403, 401, 400, 503 Request @@ -387,6 +398,7 @@ Lists associated roles for an access token. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token_roles`` Normal response codes: 200 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503 Request @@ -408,6 +420,7 @@ Shows details for a role for an access token. Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/user_access_token_role`` Normal response codes: 200 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503 Request @@ -451,4 +464,5 @@ Example OAuth-specific object in a token: Relationship: ``http://docs.openstack.org/identity/rel/v3/auth_tokens`` Normal response codes: 200 + Error response codes: 413, 405, 404, 403, 401, 400, 503 diff --git a/api-ref/source/v3-ext/trust.inc b/api-ref/source/v3-ext/trust.inc index 962caf5191..a051ffebf9 100644 --- a/api-ref/source/v3-ext/trust.inc +++ b/api-ref/source/v3-ext/trust.inc @@ -100,6 +100,7 @@ Creates a trust. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trusts Normal response codes: 201 + Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 Request @@ -165,6 +166,7 @@ Lists all trusts. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trusts Normal response codes: 200 + Error response codes: 400, 401, 403, 404, 405, 413, 503 The following optional query strings are supported: @@ -227,6 +229,7 @@ Gets the trust information for ``{trust_id}``. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust Normal response codes: 200 + Error response codes: 400, 401, 403, 404, 405, 413, 503 Request @@ -275,6 +278,7 @@ Deletes a trust with ``{trust_id}``. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust Normal response codes: 204 + Error response codes: 400, 401, 403, 404, 405, 409, 413, 415, 503 Request @@ -300,6 +304,7 @@ Lists roles delegated by a trust with ``{trust_id}``. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_roles Normal response codes: 200 + Error response codes: 400, 401, 403, 404, 405, 413, 503 Request @@ -328,6 +333,7 @@ Checks if a role is delegated by a trust. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_role Normal response codes: 200 + Error response codes: 400, 401, 403, 404, 405, 413, 503 Request @@ -354,6 +360,7 @@ Gets a role with delegated by a trust. Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_role Normal response codes: 200 + Error response codes: 400, 401, 403, 404, 405, 413, 503 Request