Detail Federation Mapping APIs in api-ref docs
Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
This commit is contained in:
parent
0c78293216
commit
30ded5078b
|
@ -3,16 +3,33 @@
|
|||
Create a mapping
|
||||
================
|
||||
|
||||
.. rest_method:: PUT /v3/OS-FEDERATION/mappings/{mapping_id}
|
||||
.. rest_method:: PUT /v3/OS-FEDERATION/mappings/{id}
|
||||
|
||||
Normal response codes: 201
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_path
|
||||
- rules: rules
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: federation/mapping/samples/create-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_body
|
||||
- links: links
|
||||
- rules: rules
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
|
@ -23,10 +40,26 @@ Response Example
|
|||
Get a mapping
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v3/OS-FEDERATION/mappings/{mapping_id}
|
||||
.. rest_method:: GET /v3/OS-FEDERATION/mappings/{id}
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_path
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_body
|
||||
- links: links
|
||||
- rules: rules
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
|
@ -37,16 +70,33 @@ Response Example
|
|||
Update a mapping
|
||||
================
|
||||
|
||||
.. rest_method:: PATCH /v3/OS-FEDERATION/mappings/{mapping_id}
|
||||
.. rest_method:: PATCH /v3/OS-FEDERATION/mappings/{id}
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_path
|
||||
- rules: rules
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: federation/mapping/samples/update-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_body
|
||||
- links: links
|
||||
- rules: rules
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
|
@ -61,6 +111,14 @@ List all mappings
|
|||
|
||||
Normal response codes: 200
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- links: links_collection
|
||||
- mappings: mappings
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
|
@ -71,6 +129,13 @@ Response Example
|
|||
Delete a mapping
|
||||
================
|
||||
|
||||
.. rest_method:: DELETE /v3/OS-FEDERATION/mappings/{mapping_id}
|
||||
.. rest_method:: DELETE /v3/OS-FEDERATION/mappings/{id}
|
||||
|
||||
Normal response codes: 204
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: federation/mapping/parameters.yaml
|
||||
|
||||
- id: id_path
|
||||
|
|
|
@ -2,6 +2,48 @@
|
|||
|
||||
# variables in path
|
||||
|
||||
id_path:
|
||||
description: |
|
||||
The Federation Mapping unique ID
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# variables in query
|
||||
|
||||
# variables in body
|
||||
|
||||
id_body:
|
||||
description: |
|
||||
The Federation Mapping unique ID
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
links:
|
||||
description: |
|
||||
Link to the URI where the mapping is located
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
|
||||
links_collection:
|
||||
description: |
|
||||
Link to the URI where the mapping collection is located
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
|
||||
mappings:
|
||||
description: |
|
||||
The collection of Federation Mappings
|
||||
in: body
|
||||
required: true
|
||||
type: list of objects
|
||||
|
||||
rules:
|
||||
description: |
|
||||
The list of rules used to map remote users into local users
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
|
|
Loading…
Reference in New Issue