From c8ffdf0bf60ab2d2095f5d4cd301586271f274f1 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Sun, 23 Apr 2017 16:41:46 +0100 Subject: [PATCH] Correct oauth create_request_token documentation Currently, the oauth documentation for the `create_request_token` endpoint is incorrect. The parameter "requested_project_id" [0] is actually spelled "Request-Project-Id" and is located in the header, not the body, of the request object [1]. [0] https://developer.openstack.org/api-ref/identity/v3-ext/?expanded=create-request-token-detail [1] https://github.com/openstack/keystone/blob/master/keystone/oauth1/controllers.py#L220 Change-Id: Ib249efffc1e7a14635ab5d767cb70caa8b8baf0f Closes-Bug: #1685634 --- api-ref/source/v3-ext/oauth.inc | 2 +- api-ref/source/v3-ext/parameters.yaml | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/api-ref/source/v3-ext/oauth.inc b/api-ref/source/v3-ext/oauth.inc index b70417963d..fd6861b7c6 100644 --- a/api-ref/source/v3-ext/oauth.inc +++ b/api-ref/source/v3-ext/oauth.inc @@ -226,7 +226,7 @@ Request .. rest_parameters:: parameters.yaml - - requested_project_id: requested_project_id + - Requested-Project-Id: requested_project_id Response Example ---------------- diff --git a/api-ref/source/v3-ext/parameters.yaml b/api-ref/source/v3-ext/parameters.yaml index fc8ce08c1e..9418b53be2 100644 --- a/api-ref/source/v3-ext/parameters.yaml +++ b/api-ref/source/v3-ext/parameters.yaml @@ -1,4 +1,10 @@ # variables in header +requested_project_id: + description: | + The ID of the requested project. + in: header + required: true + type: string # variables in path access_token_id_path: @@ -321,12 +327,6 @@ remaining_uses: in: body required: false type: boolean -requested_project_id: - description: | - The ID of the requested project. - in: body - required: true - type: string revoke_audit_chain_id: description: | Specifies a group of tokens based upon the ``audit_id`` of the