Refactor Keystone admin-endpoint API

This patch moves content of admin-endpoints_parameters.yaml to
parameters.yaml and modifies some parameters names.

Change-Id: I02e331c1673d7df87b27758d1329d6f9cc9caea9

api-ref/source/v2-admin/admin-endpoints.inc

@@ -15,9 +15,9 @@ Normal response codes: 200
 Response Parameters
 -------------------
 
-.. rest_parameters:: admin-endpoints_parameters.yaml
+.. rest_parameters:: parameters.yaml
 
-   - endpoints: endpoints_list
+   - endpoints: endpoints
 
 Response Example
 ----------------
@@ -36,14 +36,14 @@ Normal response codes: 201
 Request
 -------
 
-.. rest_parameters:: admin-endpoints_parameters.yaml
+.. rest_parameters:: parameters.yaml
 
-   - endpoint: endpoint_create
-   - region: region
-   - service_id: service_id
-   - publicurl: publicurl
-   - adminurl: adminurl
-   - internalurl: internalurl
+   - endpoint: endpoint
+   - region: endpoint_region_request
+   - service_id: service_id_request
+   - publicurl: endpoint_publicurl_request
+   - adminurl: endpoint_adminurl_request
+   - internalurl: endpoint_internalurl_request
 
 Request Example
 ---------------
@@ -54,13 +54,13 @@ Request Example
 Response Parameters
 -------------------
 
-.. rest_parameters:: admin-endpoints_parameters.yaml
+.. rest_parameters:: parameters.yaml
 
-   - adminurl: adminurl
-   - id: id
-   - internalurl: internalurl
-   - publicurl: publicurl
-   - region: region
+   - endpoint: endpoint
+   - id: endpoint_id
+   - internalurl: endpoint_internalurl_response
+   - publicurl: endpoint_publicurl_response
+   - region: endpoint_region_response
 
 
 Delete endpoint template
@@ -73,6 +73,6 @@ Normal response codes: 204
 Request
 -------
 
-.. rest_parameters:: admin-endpoints_parameters.yaml
+.. rest_parameters:: parameters.yaml
 
-   - endpointId: id_path
+   - endpointId: endpoint_id_path

api-ref/source/v2-admin/admin-endpoints_parameters.yaml

@@ -1,71 +0,0 @@
-# variables in header
-
-# variables in path
-id_path:
-  description: |
-    Endpoint ID
-  in: path
-  required: true
-  type: string
-
-# variables in query
-
-# variables in body
-adminurl:
-  description: |
-    Admin URL
-  in: body
-  required: true
-  type: string
-endpoint:
-  description: |
-    Endpoint object. Contains ``publicURL``, ``adminURL``,
-    ``internalURL``, ``id`` and ``region`` for the endpoint.
-  in: body
-  required: true
-  type: object
-endpoint_create:
-  description: |
-    Endpoint object, containing ``region``, ``service_id``,
-    ``publicurl``, ``adminurl``, ``internalurl``.
-  in: body
-  required: true
-  type: object
-endpoints_list:
-  description: |
-    One or more ``endpoint`` objects. Each object
-    shows the ``adminURL``, ``region``, ``internalURL``, ``id``, and
-    ``publicURL`` for the endpoint.
-  in: body
-  required: true
-  type: array
-id:
-  description: |
-    Endpoint ID
-  in: body
-  required: true
-  type: string
-internalurl:
-  description: |
-    Internal URL
-  in: body
-  required: true
-  type: string
-publicurl:
-  description: |
-    Public URL
-  in: body
-  required: true
-  type: string
-region:
-  description: |
-    Region of the endpoint
-  in: body
-  required: true
-  type: string
-service_id:
-  description: |
-    Service ID
-  in: body
-  required: true
-  type: string

api-ref/source/v2-admin/parameters.yaml

@@ -8,6 +8,12 @@ X-Auth-Token:
   type: string
 
 # variables in path
+endpoint_id_path:
+  description: |
+    Endpoint ID
+  in: path
+  required: true
+  type: string
 tenantId_1:
   description: |
     The tenant ID.
@@ -83,14 +89,75 @@ enabled_2:
   in: body
   required: true
   type: boolean
+endpoint:
+  description: |
+    Endpoint object. Contains ``publicURL``, ``adminURL``,
+    ``internalURL``, ``id`` and ``region`` for the endpoint.
+  in: body
+  required: true
+  type: object
+endpoint_adminurl_request:
+  description: |
+    Admin URL
+  in: body
+  required: false
+  type: string
+endpoint_adminurl_response:
+  description: |
+    Admin URL
+  in: body
+  required: true
+  type: string
+endpoint_id:
+  description: |
+    Endpoint ID
+  in: body
+  required: true
+  type: string
+endpoint_internalurl_request:
+  description: |
+    Internal URL
+  in: body
+  required: false
+  type: string
+endpoint_internalurl_response:
+  description: |
+    Internal URL
+  in: body
+  required: true
+  type: string
+endpoint_publicurl_request:
+  description: |
+    Public URL
+  in: body
+  required: true
+  type: string
+endpoint_publicurl_response:
+  description: |
+    Public URL
+  in: body
+  required: true
+  type: string
+endpoint_region_request:
+  description: |
+    Region of the endpoint
+  in: body
+  required: false
+  type: string
+endpoint_region_response:
+  description: |
+    Region of the endpoint
+  in: body
+  required: true
+  type: string
 endpoints:
   description: |
-    One or more ``endpoints`` objects. Each object
+    One or more ``endpoint`` objects. Each object
     shows the ``adminURL``, ``region``, ``internalURL``, ``id``, and
     ``publicURL`` for the endpoint.
   in: body
   required: true
-  type: string
+  type: array
 endpoints_links:
   description: |
     Links for the endpoint.
@@ -194,6 +261,12 @@ roles_links:
   in: body
   required: true
   type: array
+service_id_request:
+  description: |
+    Service ID
+  in: body
+  required: true
+  type: string
 serviceCatalog:
   description: |
     A ``serviceCatalog`` object.