openstack
/
keystone
Code Issues Proposed changes

Merge "Reorganize api-ref: v3-ext federation service-provider"

This commit is contained in:
Zuul 2018-02-08 17:32:32 +00:00 committed by Gerrit Code Review
parent 93f4454a4f 5a174a518c
commit 6bd057e4f6
1 changed files with 85 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
api-ref/source/v3-ext/federation/service-provider/sp.inc
View File

@ -5,13 +5,15 @@ Register a service provider
.. rest_method:: PUT /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Create a service provider entity.
Normal response codes: 201
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- auth_url: auth_url
@ -20,8 +22,8 @@ Request
- id: id_path
- sp_url: sp_url
Request Example
---------------
Example
~~~~~~~
.. literalinclude:: federation/service-provider/samples/register-request.json
:language: javascript
@ -29,6 +31,9 @@ Request Example
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- auth_url: auth_url
@ -39,8 +44,15 @@ Response
- relay_state_prefix: relay_state_prefix
- sp_url: sp_url
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 201
Example
~~~~~~~
.. literalinclude:: federation/service-provider/samples/register-response.json
:language: javascript
@ -51,37 +63,50 @@ List service providers
.. rest_method:: GET /v3/OS-FEDERATION/service_providers
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_providers``
List all service providers.
Normal response codes: 200
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_providers``
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- links: links_collection
- service_providers: service_providers
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
Example
~~~~~~~
.. literalinclude:: federation/service-provider/samples/list-response.json
:language: javascript
Get Service Provider
Get service provider
====================
.. rest_method:: GET /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Get a specific service provider reference.
Normal response codes: 200
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- id: id_path
@ -89,6 +114,9 @@ Request
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- auth_url: auth_url
@ -99,42 +127,64 @@ Response
- relay_state_prefix: relay_state_prefix
- sp_url: sp_url
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
Example
~~~~~~~
.. literalinclude:: federation/service-provider/samples/get-response.json
:language: javascript
Delete Service Provider
Delete service provider
=======================
.. rest_method:: DELETE /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Delete a service provider.
Normal response codes: 204
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Request
-------
Parameters
~~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- id: id_path
Response
--------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 204
Update service provider
=======================
.. rest_method:: PATCH /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Update a service provider's attributes.
Normal response codes: 200
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Request
-------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- id: id_path
@ -143,8 +193,8 @@ Request
- enabled: enabled
- sp_url: sp_url
Request Example
---------------
Example
~~~~~~~
.. literalinclude:: federation/service-provider/samples/update-request.json
:language: javascript
@ -152,6 +202,9 @@ Request Example
Response
--------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/service-provider/parameters.yaml
- auth_url: auth_url
@ -162,8 +215,15 @@ Response
- relay_state_prefix: relay_state_prefix
- sp_url: sp_url
Response Example
----------------
Status Codes
~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
Example
~~~~~~~~
.. literalinclude:: federation/service-provider/samples/update-response.json
:language: javascript
:language: javascript