From ba6c5afbfd6a61ae8048f17e97e71174c0b1f3c6 Mon Sep 17 00:00:00 2001 From: Suramya Shah Date: Thu, 28 Dec 2017 13:19:40 +0530 Subject: [PATCH] Reorganize api-ref: v3 service-catalog Reorganize as per the documentation session at PTG: https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup Change-Id: I1a0e8d2606096f26258e4d15efb550ce63df317a --- api-ref/source/v3/service-catalog.inc | 521 ++++++++++++++------------ 1 file changed, 290 insertions(+), 231 deletions(-) diff --git a/api-ref/source/v3/service-catalog.inc b/api-ref/source/v3/service-catalog.inc index a752a74dc3..d8dbaa06c8 100644 --- a/api-ref/source/v3/service-catalog.inc +++ b/api-ref/source/v3/service-catalog.inc @@ -23,32 +23,25 @@ List services .. rest_method:: GET /v3/services -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services`` - Lists all services. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services`` -.. rest_status_code:: success status.yaml +Request +------- - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml - type: service_type_query -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -60,8 +53,21 @@ Response Parameters - id: service_id - description: service_description -Response Example ----------------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Example +~~~~~~~ .. literalinclude:: ./samples/admin/services-list-response.json :language: javascript @@ -72,12 +78,47 @@ Create service .. rest_method:: POST /v3/services -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services`` - Creates a service. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services`` + +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - description: service_description + - service: service + - enabled: service_enabled + - type: service_type + - name: service_name + +Example +~~~~~~~ + +.. literalinclude:: ./samples/admin/service-create-request.json + :language: javascript + +Response +-------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - name: service_name + - service: service + - links: service_links + - type: service_type + - id: service_id + - description: service_description + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -90,25 +131,30 @@ Response Codes - 403 - 409 -Request Parameters ------------------- +Show service details +==================== + +.. rest_method:: GET /v3/services/{service_id} + +Shows details for a service. + +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/service`` + +Request +------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml - - description: service_description - - service: service - - enabled: service_enabled - - type: service_type - - name: service_name + - service_id: service_id_path -Request Example ---------------- +Response +-------- -.. literalinclude:: ./samples/admin/service-create-request.json - :language: javascript - -Response Parameters -------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -119,18 +165,8 @@ Response Parameters - id: service_id - description: service_description - -Show service details -==================== - -.. rest_method:: GET /v3/services/{service_id} - -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/service`` - -Shows details for a service. - -Response Codes --------------- +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -143,27 +179,8 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - service_id: service_id_path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - name: service_name - - service: service - - links: service_links - - type: service_type - - id: service_id - - description: service_description - -Response Example ----------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/service-show-response.json :language: javascript @@ -174,16 +191,52 @@ Update service .. rest_method:: PATCH /v3/services/{service_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services`` - Updates a service. The request body is the same as the create service request body, except that you include only those attributes that you want to update. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services`` + +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - type: service_type + - enabled: service_enabled_not_required + - description: service_description_not_required + - service: service + - name: service_name + - service_id: service_id_path + +Example +~~~~~~~ + +.. literalinclude:: ./samples/admin/service-update-request.json + :language: javascript + +Response +-------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - name: service_name + - service: service + - links: service_links + - type: service_type + - id: service_id + - description: service_description + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -197,38 +250,8 @@ Response Codes - 404 - 409 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - type: service_type - - enabled: service_enabled_not_required - - description: service_description_not_required - - service: service - - name: service_name - - service_id: service_id_path - -Request Example ---------------- - -.. literalinclude:: ./samples/admin/service-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - name: service_name - - service: service - - links: service_links - - type: service_type - - id: service_id - - description: service_description - -Response Example ----------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/service-update-response.json :language: javascript @@ -239,16 +262,29 @@ Delete service .. rest_method:: DELETE /v3/services/{service_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/service`` - Deletes a service. If you try to delete a service that still has associated endpoints, this call either deletes all associated endpoints or fails until all endpoints are deleted. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/service`` + +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - service_id: service_id_path + +Response +-------- + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -261,46 +297,32 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - service_id: service_id_path - List endpoints ============== .. rest_method:: GET /v3/endpoints -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints`` - Lists all available endpoints. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints`` -.. rest_status_code:: success status.yaml +Request +------- - - 200 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml - interface: interface_query - service_id: service_id_query -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -314,8 +336,21 @@ Response Parameters - endpoints: endpoints - id: endpoint_id -Response Example ----------------- +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + +Example +~~~~~~~ .. literalinclude:: ./samples/admin/endpoints-list-response.json :language: javascript @@ -326,26 +361,15 @@ Create endpoint .. rest_method:: POST /v3/endpoints -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints`` - Creates an endpoint. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints`` -.. rest_status_code:: success status.yaml +Request +------- - - 201 - -.. rest_status_code:: error status.yaml - - - 400 - - 401 - - 403 - - 409 - -Request Parameters ------------------- +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -356,14 +380,17 @@ Request Parameters - service_id: service_id - region_id: region_id_not_required -Request Example ---------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/endpoint-create-request.json :language: javascript -Response Parameters -------------------- +Response +-------- + +Parameters +~~~~~~~~~~ .. rest_parameters:: parameters.yaml @@ -377,18 +404,58 @@ Response Parameters - id: endpoint_id - region_id: region_id_required +Status Codes +~~~~~~~~~~~~ + +.. rest_status_code:: success status.yaml + + - 201 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 403 + - 409 + Show endpoint details ===================== .. rest_method:: GET /v3/endpoints/{endpoint_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints`` - Shows details for an endpoint. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints`` + +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - endpoint_id: endpoint_id_path + +Response +-------- + +Parameters +~~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - endpoint: endpoint + - name: endpoint_name + - links: endpoint_links + - url: endpoint_url + - region: endpoint_region + - interface: endpoint_interface + - service_id: service_id + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -401,28 +468,8 @@ Response Codes - 403 - 404 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - endpoint_id: endpoint_id_path - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - endpoint: endpoint - - name: endpoint_name - - links: endpoint_links - - url: endpoint_url - - region: endpoint_region - - interface: endpoint_interface - - service_id: service_id - -Response Example ----------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/endpoint-show-response.json :language: javascript @@ -433,12 +480,49 @@ Update endpoint .. rest_method:: PATCH /v3/endpoints/{endpoint_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoint`` - Updates an endpoint. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoint`` + +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - endpoint: endpoint + - url: endpoint_url + - region: endpoint_region + - interface: endpoint_interface + - service_id: service_id + - endpoint_id: endpoint_id_path + +Example +~~~~~~~ + +.. literalinclude:: ./samples/admin/endpoint-update-request.json + :language: javascript + +Response +-------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - endpoint: endpoint + - id: endpoint_id + - links: endpoint_links + - url: endpoint_url + - region: endpoint_region + - interface: endpoint_interface + - service_id: service_id + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -452,39 +536,8 @@ Response Codes - 404 - 409 -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - endpoint: endpoint - - url: endpoint_url - - region: endpoint_region - - interface: endpoint_interface - - service_id: service_id - - endpoint_id: endpoint_id_path - -Request Example ---------------- - -.. literalinclude:: ./samples/admin/endpoint-update-request.json - :language: javascript - -Response Parameters -------------------- - -.. rest_parameters:: parameters.yaml - - - endpoint: endpoint - - id: endpoint_id - - links: endpoint_links - - url: endpoint_url - - region: endpoint_region - - interface: endpoint_interface - - service_id: service_id - -Response Example ----------------- +Example +~~~~~~~ .. literalinclude:: ./samples/admin/endpoint-update-response.json :language: javascript @@ -495,12 +548,25 @@ Delete endpoint .. rest_method:: DELETE /v3/endpoints/{endpoint_id} -Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoint`` - Deletes an endpoint. -Response Codes --------------- +Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoint`` + +Request +------- + +Parameters +~~~~~~~~~~ + +.. rest_parameters:: parameters.yaml + + - endpoint_id: endpoint_id_path + +Response +-------- + +Status Codes +~~~~~~~~~~~~ .. rest_status_code:: success status.yaml @@ -511,11 +577,4 @@ Response Codes - 400 - 401 - 403 - - 404 - -Request Parameters ------------------- - -.. rest_parameters:: parameters.yaml - - - endpoint_id: endpoint_id_path + - 404 \ No newline at end of file