From 572fac9d91b6da07ec5362b83c115261e4e8f16c Mon Sep 17 00:00:00 2001 From: Suramya Shah Date: Mon, 8 Jan 2018 16:38:20 +0530 Subject: [PATCH] Reorganize api-ref: v3-ext oauth.inc Reorganize api-ref as per the documentation session at PTG: https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup Change-Id: I01d5f8948712061223a5e1102ab47da0a8846aa1 --- api-ref/source/v3-ext/oauth.inc | 441 ++++++++++++++++++++++++++------ 1 file changed, 356 insertions(+), 85 deletions(-) diff --git a/api-ref/source/v3-ext/oauth.inc b/api-ref/source/v3-ext/oauth.inc index 9a87d78f73..5a037fa8ce 100644 --- a/api-ref/source/v3-ext/oauth.inc +++ b/api-ref/source/v3-ext/oauth.inc @@ -65,19 +65,18 @@ Enables a user to create a consumer. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - description: consumer_description -Request Example ---------------- +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/consumer-create-request.json :language: javascript @@ -85,12 +84,31 @@ Request Example Response -------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 201 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 + Status: 201 Created The ``secret`` is only returned once, during consumer creation. -Response Example ----------------- +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/consumer-create-response.json :language: javascript @@ -108,17 +126,37 @@ tokens, and Identity API tokens are also revoked. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - consumer_id: consumer_id_path +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 204 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 List consumers ============== @@ -129,12 +167,28 @@ Lists consumers. Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/consumers`` -Normal response codes: 200 +Response +-------- -Error response codes: 413, 405, 404, 403, 401, 400, 503 +Status Codes +~~~~~~~~~~~~ -Response Example ----------------- +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/consumers-list-response.json :language: javascript @@ -149,19 +203,38 @@ Shows details for a consumer. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - consumer_id: consumer_id_path -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/consumer-show-response.json :language: javascript @@ -179,25 +252,47 @@ If you try to update any attribute other than ``description``, an HTTP Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - consumer_id: consumer_id_path -Request Example ---------------- +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/consumer-update-request.json :language: javascript -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/consumer-update-response.json :language: javascript @@ -217,32 +312,52 @@ request. See `Consumer Obtains a Request Token Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/request_tokens`` -Normal response codes: 201 - -Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 - Request ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - Requested-Project-Id: requested_project_id -Response Example ----------------- - -.. literalinclude:: ./samples/OS-OAUTH1/request-token-create-response.txt - :language: javascript - Response -------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - oauth_token: oauth_token - oauth_token_secret: oauth_token_secret - oauth_expires_at: oauth_expires_at +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 201 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 + +Example +~~~~~~~ + +.. literalinclude:: ./samples/OS-OAUTH1/request-token-create-response.txt + :language: javascript Authorize request token ======================= @@ -255,18 +370,39 @@ returned. The Consumer receives the OAuth Verifier from the User out-of-band. Relationship: ``https://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 ------- +Example +~~~~~~~ + .. literalinclude:: ./samples/OS-OAUTH1/authorize-request-token-request.json :language: javascript -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/authorize-request-token-response.json :language: javascript @@ -289,25 +425,43 @@ request. See `Consumer Requests an Access Token Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-OAUTH1/1.0/rel/access_tokens`` -Normal response codes: 201 - -Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409 - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-OAUTH1/access-token-create-response.txt - :language: javascript - Response -------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - oauth_token: oauth_token - oauth_token_secret: oauth_token_secret - oauth_expires_at: oauth_expires_at +Status Codes +~~~~~~~~~~~~ + + +.. rest_status_code:: success ../v3/status.yaml + + - 201 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 + +Example +~~~~~~~ + +.. literalinclude:: ./samples/OS-OAUTH1/access-token-create-response.txt + :language: javascript Get access token ================ @@ -318,20 +472,40 @@ Gets an access token. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - user_id: user_id_path - access_token_id: access_token_id_path -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/access-token-show-response.json :language: javascript @@ -348,18 +522,38 @@ API tokens that were issued to the consumer through that access token. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - user_id: user_id_path - access_token_id: access_token_id_path +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 204 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 List access tokens ================== @@ -370,19 +564,38 @@ Lists authorized access tokens. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - user_id: user_id_path -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/access-tokens-list-response.json :language: javascript @@ -397,20 +610,41 @@ Lists associated roles for an access token. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - user_id: user_id_path - access_token_id: access_token_id_path -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 415 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + - 409 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/access-token-roles-list-response.json :language: javascript @@ -425,21 +659,41 @@ Shows details for a role for an access token. Relationship: ``https://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 ------- +Parameters +~~~~~~~~~~ + .. rest_parameters:: parameters.yaml - user_id: user_id_path - role_id: role_id_path - access_token_id: access_token_id_path -Response Example ----------------- +Response +-------- + +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 + +Example +~~~~~~~ .. literalinclude:: ./samples/OS-OAUTH1/access-token-role-show-response.json :language: javascript @@ -475,6 +729,23 @@ Example OAuth-specific object in a token: Relationship: ``https://docs.openstack.org/identity/rel/v3/auth_tokens`` -Normal response codes: 200 +Response +-------- -Error response codes: 413, 405, 404, 403, 401, 400, 503 +Status Codes +~~~~~~~~~~~~ + + +.. rest_status_code:: success ../v3/status.yaml + + - 200 + +.. rest_status_code:: error ../v3/status.yaml + + - 413 + - 405 + - 404 + - 403 + - 401 + - 400 + - 503 \ No newline at end of file