From e183c14be7051f33f251117f85ec9e94789c123f Mon Sep 17 00:00:00 2001 From: Dave Chen Date: Sun, 17 Jul 2016 11:03:30 +0800 Subject: [PATCH] Fix the errors in params in api-ref for V3 region Change-Id: If412bb5424e61f45793f498112950ca02682a650 --- api-ref/source/v3/parameters.yaml | 85 +++++++++++++++++++------------ api-ref/source/v3/regions-v3.inc | 64 +++++++++++------------ 2 files changed, 84 insertions(+), 65 deletions(-) diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 5cece0c302..e980591e28 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -98,11 +98,11 @@ project_id_path: in: path required: true type: string -region_id_2: +region_id_path: description: | The region ID. in: path - required: false + required: true type: string role_id: description: | @@ -261,7 +261,7 @@ parent_id_2: in: query required: false type: string -parent_region_id_1: +parent_region_id_query: description: | Filters the response by a parent region, by ID. in: query @@ -452,12 +452,6 @@ description_2: in: body required: false type: string -description_3: - description: | - The region description. - in: body - required: false - type: string description_4: description: | The service description. @@ -488,6 +482,18 @@ description_9: in: body required: true type: string +description_region_request_body: + description: | + The region description. + in: body + required: false + type: string +description_region_response_body: + description: | + The region description. + in: body + required: true + type: string domain: description: | A ``domain`` object, containing: @@ -912,12 +918,6 @@ id_12: in: body required: true type: string -id_13: - description: | - The ID for the region. - in: body - required: true - type: string id_2: description: | A token ID. @@ -969,6 +969,18 @@ id_9: in: body required: false type: string +id_region_response_body: + description: | + The ID for the region. + in: body + required: true + type: string +id_region_resquest_body: + description: | + The ID for the region. + in: body + required: false + type: string id_user_body: description: | The user ID. @@ -1124,12 +1136,6 @@ links_5: in: body required: true type: object -links_6: - description: | - The links for the ``region`` resource. - in: body - required: true - type: object links_7: description: | The links for the ``role`` resource. @@ -1142,6 +1148,12 @@ links_8: in: body required: true type: object +links_region: + description: | + The links for the ``region`` resource. + in: body + required: true + type: object links_user: description: | The links for the ``user`` resource. @@ -1289,17 +1301,24 @@ parent_id_1: in: body required: true type: string -parent_region_id: +parent_region_id_2: + description: | + If the region is a child of another region, the + ID for the parent region. Otherwise, this value is ``null``. + in: body + required: true + type: string +parent_region_id_request_body: description: | To make this region a child of another region, set this parameter to the ID of the parent region. in: body required: false type: string -parent_region_id_2: +parent_region_id_response_body: description: | - If the region is a child of another region, the - ID for the parent region. Otherwise, this value is ``null``. + To make this region a child of another region, + set this parameter to the ID of the parent region. in: body required: true type: string @@ -1358,12 +1377,6 @@ region: in: body required: true type: string -region_1: - description: | - A ``region`` object. - in: body - required: true - type: object region_2: description: | (Deprecated in v3.2) The geographic location of @@ -1385,9 +1398,15 @@ region_id_1: in: body required: false type: string -regions: +region_object: description: | - A ``regions`` object. + A ``region`` object, containing the following: + in: body + required: true + type: object +regions_object: + description: | + A list of ``region`` object, each containing the following: in: body required: true type: array diff --git a/api-ref/source/v3/regions-v3.inc b/api-ref/source/v3/regions-v3.inc index dfa6bbe378..9bb0e24827 100644 --- a/api-ref/source/v3/regions-v3.inc +++ b/api-ref/source/v3/regions-v3.inc @@ -9,7 +9,7 @@ associate zero or more sub-regions with a region to create a tree- like structured hierarchy. Although a region does not have a geographical connotation, a -deployment can use a geographical name for a region, such as ``us- +deployment can use a geographical name for a region ID, such as ``us- east``. You can list, create, update, show details for, and delete regions. @@ -30,18 +30,18 @@ Request .. rest_parameters:: parameters.yaml - - region_id: region_id + - region_id: region_id_path Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - parent_region_id: parent_region_id - - region: region - - description: description - - links: links - - id: id + - region: region_object + - description: description_region_response_body + - id: id_region_response_body + - links: links_region + - parent_region_id: parent_region_id_response_body Response Example ---------------- @@ -72,10 +72,10 @@ Request .. rest_parameters:: parameters.yaml - - parent_region_id: parent_region_id - - region: region - - description: description - - region_id: region_id + - region_id: region_id_path + - region: region_object + - description: description_region_request_body + - parent_region_id: parent_region_id_request_body Request Example --------------- @@ -88,11 +88,11 @@ Response Parameters .. rest_parameters:: parameters.yaml - - parent_region_id: parent_region_id - - region: region - - description: description - - links: links - - id: id + - region: region_object + - description: description_region_response_body + - id: id_region_response_body + - links: links_region + - parent_region_id: parent_region_id_response_body Response Example ---------------- @@ -121,7 +121,7 @@ Request .. rest_parameters:: parameters.yaml - - region_id: region_id + - region_id: region_id_path List regions @@ -139,18 +139,18 @@ Request .. rest_parameters:: parameters.yaml - - parent_region_id: parent_region_id + - parent_region_id: parent_region_id_query Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - regions: regions - - parent_region_id: parent_region_id - - description: description - - links: links - - id: id + - regions: regions_object + - description: description_region_response_body + - id: id_region_response_body + - links: links_region + - parent_region_id: parent_region_id_response_body Response Example ---------------- @@ -189,10 +189,10 @@ Request .. rest_parameters:: parameters.yaml - - parent_region_id: parent_region_id - - region: region - - description: description - - id: id + - region: region_object + - description: description_region_request_body + - id: id_region_resquest_body + - parent_region_id: parent_region_id_request_body Request Example --------------- @@ -205,8 +205,8 @@ Response Parameters .. rest_parameters:: parameters.yaml - - parent_region_id: parent_region_id - - region: region - - description: description - - links: links - - id: id + - region: region_object + - description: description_region_response_body + - id: id_region_response_body + - links: links_region + - parent_region_id: parent_region_id_response_body