openstack/keystone
Code Issues Proposed changes

Reorganize api-ref: v3-ext ep-filter.inc

Browse Source 
Reorganize as per the documentation session at PTG:
https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup

Change-Id: Iaa732e613178243c76f0570c4832d91f0538a6da
This commit is contained in:
Suramya Shah
2018-01-11 18:55:13 +05:30
parent abb0d552a1
commit 7d4c366c91
1 changed files with 308 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

381
api-ref/source/v3-ext/ep-filter.inc
View File

@@ -52,25 +52,41 @@ service endpoints having the same characteristics
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_groups``
Normal response codes: 201
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- name: eg_name
- filters: eg_filters
- description: eg_description
Example
~~~~~~~
.. literalinclude:: samples/OS-EP-FILTER/create-endpoint-group-request.json
:language: javascript
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 201
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 201 Created
.. literalinclude:: samples/OS-EP-FILTER/endpoint-group-response.json
@@ -85,13 +101,12 @@ Show details of an endpoint group.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -99,6 +114,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/endpoint-group-response.json
@@ -113,13 +142,12 @@ Determine if an endpoint group exists.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -127,6 +155,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
Update Endpoint Group
@@ -138,13 +180,12 @@ Modify attributes of an endpoint group.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -152,12 +193,29 @@ Request
- filters: eg_filters
- description: eg_description
Example
~~~~~~~
.. literalinclude:: samples/OS-EP-FILTER/update-endpoint-group-request.json
:language: javascript
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/update-endpoint-group-response.json
@@ -172,13 +230,12 @@ Delete an endpoint group.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group``
Normal response codes: 204
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -186,6 +243,18 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
.. rest_status_code:: error ../v3/status.yaml
- 401
Status: 204 No Content
List Endpoint Groups
@@ -197,13 +266,23 @@ List all available endpoint groups.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_groups``
Normal response codes: 200
Error response codes: 401
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/endpoint-groups-response.json
@@ -225,13 +304,12 @@ Creates a direct association between ``project_id`` and ``endpoint_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint``
Normal response codes: 204
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
@@ -240,6 +318,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 204 No Content
Check Association
@@ -251,13 +343,12 @@ Verifies the existence of an association between ``project_id`` and ``endpoint_i
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint``
Normal response codes: 204
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
@@ -266,6 +357,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 204 No Content
Delete Association
@@ -277,13 +382,12 @@ Removes a direct association between ``project_id`` and ``endpoint_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint``
Normal response codes: 204
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
@@ -292,6 +396,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 204 No Content
List Associations by Project
@@ -303,13 +421,12 @@ Returns all endpoints that are currently associated with ``project_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoints``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
@@ -317,6 +434,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/list-associations-by-project-response.json
@@ -331,13 +462,12 @@ Returns all projects that are currently associated with ``endpoint_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_projects``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_id: endpoint_id_path
@@ -345,6 +475,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/list-associations-by-endpoint-response.json
@@ -367,13 +511,12 @@ Creates an association between ``endpoint_group_id`` and ``project_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project``
Normal response codes: 204
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -382,6 +525,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 204 No Content
Get Endpoint Group to Project Association
@@ -393,13 +550,12 @@ Verifies the existence of an association between ``project_id`` and ``endpoint_g
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -408,6 +564,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/endpoint-project-response.json
@@ -422,13 +592,12 @@ Verifies the existence of an association between ``project_id`` and ``endpoint_g
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -437,6 +606,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
Delete Endpoint Group to Project Association
@@ -448,13 +631,12 @@ Removes the association between ``project_id`` and ``endpoint_group_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_project``
Normal response codes: 204
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -463,6 +645,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 204 No Content
List Projects Associated with Endpoint Group
@@ -474,13 +670,12 @@ Returns all projects that are currently associated with ``endpoint_group_id``.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_projects``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -488,6 +683,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/list-associations-by-endpoint-response.json
@@ -502,13 +711,12 @@ Returns all the endpoints that are currently associated with ``endpoint_group_id
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/endpoint_group_endpoints``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id_path
@@ -516,6 +724,20 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/list-service-endpoints.json
@@ -530,13 +752,12 @@ Returns all the endpoint groups that are currently associated with ``project_id`
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-EP-FILTER/1.0/rel/project_endpoint_groups``
Normal response codes: 200
Error response codes: 401
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
@@ -544,7 +765,21 @@ Request
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
.. rest_status_code:: error ../v3/status.yaml
- 401
Example
~~~~~~~
Status: 200 OK
.. literalinclude:: samples/OS-EP-FILTER/endpoint-groups-response.json
:language: javascript
:language: javascript