From 9241aeb485783e74d9bcf3d5d1501e8ceeeaf697 Mon Sep 17 00:00:00 2001 From: Anh Tran Date: Tue, 9 Aug 2016 09:56:14 +0700 Subject: [PATCH] api-ref: Correcting V3 Credentials APIs Correcting all parameters of Credentials APIs. http://developer.openstack.org/api-ref/identity/v3/index.html#credentials Rename parameters for more easy to maintain. Change-Id: I811558a646d41d2594777b4601fa223d13e193e7 Partial-Bug: #1610777 --- api-ref/source/v3/credentials.inc | 60 ++++++++-------- api-ref/source/v3/parameters.yaml | 116 +++++++++++++++--------------- 2 files changed, 88 insertions(+), 88 deletions(-) diff --git a/api-ref/source/v3/credentials.inc b/api-ref/source/v3/credentials.inc index 22f432a0ea..ee5619e445 100644 --- a/api-ref/source/v3/credentials.inc +++ b/api-ref/source/v3/credentials.inc @@ -37,9 +37,9 @@ Request - credential: credential - project_id: project_id - - type: type - - blob: blob - - user_id: user_id + - type: credential_type + - blob: credential_blob + - user_id: credential_user_id Request Example --------------- @@ -53,12 +53,12 @@ Response Parameters .. rest_parameters:: parameters.yaml - credential: credential - - user_id: user_id - - links: links - - blob: blob + - user_id: credential_user_id + - links: credential_links + - blob: credential_blob - project_id: project_id - - type: type - - id: id + - type: credential_type + - id: credential_id List credentials @@ -79,20 +79,20 @@ Request .. rest_parameters:: parameters.yaml - - user_id: user_id + - user_id: user_id_query Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - user_id: user_id - - links: links - - blob: blob + - user_id: credential_user_id + - links: credentials_links + - blob: credential_blob - credentials: credentials - project_id: project_id - - type: type - - id: id + - type: credential_type + - id: credential_id Response Example ---------------- @@ -116,7 +116,7 @@ Request .. rest_parameters:: parameters.yaml - - credential_id: credential_id + - credential_id: credential_id_path Response Parameters ------------------- @@ -124,12 +124,12 @@ Response Parameters .. rest_parameters:: parameters.yaml - credential: credential - - user_id: user_id - - links: links - - blob: blob + - user_id: credential_user_id + - links: credential_links + - blob: credential_blob - project_id: project_id - - type: type - - id: id + - type: credential_type + - id: credential_id Response Example ---------------- @@ -153,12 +153,12 @@ Request .. rest_parameters:: parameters.yaml + - credential_id: credential_id_path - credential: credential - project_id: project_id - - type: type - - blob: blob - - user_id: user_id - - credential_id: credential_id + - type: credential_type_notRequired + - blob: credential_blob_notRequired + - user_id: credential_user_id_notRequired Request Example --------------- @@ -172,12 +172,12 @@ Response Parameters .. rest_parameters:: parameters.yaml - credential: credential - - user_id: user_id - - links: links - - blob: blob + - user_id: credential_user_id + - links: credential_links + - blob: credential_blob - project_id: project_id - - type: type - - id: id + - type: credential_type + - id: credential_id Response Example ---------------- @@ -201,4 +201,4 @@ Request .. rest_parameters:: parameters.yaml - - credential_id: credential_id + - credential_id: credential_id_path diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index f3e9fc63d8..f7e0b48203 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -29,7 +29,7 @@ access_token_id: in: path required: true type: string -credential_id: +credential_id_path: description: | The UUID for the credential. in: path @@ -442,18 +442,6 @@ auth_token_id: in: body required: true type: string -blob: - description: | - The credential itself, as a serialized blob. - in: body - required: true - type: string -blob_3: - description: | - The credential itself, as a serialized blob. - in: body - required: false - type: string catalog: description: | A ``catalog`` object. @@ -466,12 +454,68 @@ credential: in: body required: true type: object +credential_blob: + description: | + The credential itself, as a serialized blob. + in: body + required: true + type: string +credential_blob_notRequired: + description: | + The credential itself, as a serialized blob. + in: body + required: false + type: string +credential_id: + description: | + The UUID for the credential. + in: body + required: true + type: string +credential_links: + description: | + The links for the ``credential`` resource. + in: body + required: true + type: object +credential_type: + description: | + The credential type, such as ``ec2`` or ``cert``. + The implementation determines the list of supported types. + in: body + required: true + type: string +credential_type_notRequired: + description: | + The credential type, such as ``ec2`` or ``cert``. + The implementation determines the list of supported types. + in: body + required: false + type: string +credential_user_id: + description: | + The ID of the user who owns the credential. + in: body + required: true + type: string +credential_user_id_notRequired: + description: | + The ID of the user who owns the credential. + in: body + required: false + type: string credentials: description: | - A ``credentials`` object. + A list of ``credential`` objects. in: body required: true type: array +credentials_links: + description: | + The links for the ``credentials`` resource. + in: body + required: true + type: object default_project_id_request_body: description: | The ID of the default project for the user. @@ -1047,12 +1091,6 @@ id_2: in: body required: false type: string -id_3: - description: | - The UUID for the credential. - in: body - required: true - type: string id_4: description: | The domain ID. @@ -1169,18 +1207,6 @@ link_response_body: in: body required: true type: string -links: - description: | - The links for the ``credential`` resource. - in: body - required: true - type: object -links_10: - description: | - The links for the ``credentials`` resource. - in: body - required: true - type: object links_11: description: | The links for the ``domains`` resource. @@ -1706,13 +1732,6 @@ type: in: body required: true type: string -type_1: - description: | - The credential type, such as ``ec2`` or ``cert``. - The implementation determines the list of supported types. - in: body - required: true - type: string type_3: description: | The service type, which describes the API @@ -1721,13 +1740,6 @@ type_3: in: body required: true type: string -type_7: - description: | - The credential type, such as ``ec2`` or ``cert``. - The implementation determines the list of supported types. - in: body - required: false - type: string user: description: | A ``user`` object. @@ -1755,24 +1767,12 @@ user_id: in: body required: false type: string -user_id_1: - description: | - The ID of the user who owns the credential. - in: body - required: true - type: string user_id_2: description: | The ID of the user who owns the policy. in: body required: false type: string -user_id_5: - description: | - The ID of the user who owns the credential. - in: body - required: false - type: string user_name: description: | The user name. Required if you do not specify