openstack/keystone
Code Issues Proposed changes
68f1043ce2
keystone/api-ref/source/v3-ext/federation/mapping/mapping.inc

152 lines
2.8 KiB
PHP
Raw Normal View History

Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
.. -*- rst -*-
Create a mapping
================
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
.. rest_method:: PUT /v3/OS-FEDERATION/mappings/{id}
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
[api] add relationship links to v3-ext Nearly all the "relationship" links are missing in v3 APIs Added relationship links to v3-ext API pages. Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e Closes-Bug: #1609159
2016-08-11 15:16:08 -05:00
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Normal response codes: 201
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Request
-------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_path
- rules: rules
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Request Example
---------------
.. literalinclude:: federation/mapping/samples/create-request.json
:language: javascript
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Response
--------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_body
- links: links
- rules: rules
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Response Example
----------------
.. literalinclude:: federation/mapping/samples/create-response.json
:language: javascript
Get a mapping
=============
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
.. rest_method:: GET /v3/OS-FEDERATION/mappings/{id}
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
[api] add relationship links to v3-ext Nearly all the "relationship" links are missing in v3 APIs Added relationship links to v3-ext API pages. Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e Closes-Bug: #1609159
2016-08-11 15:16:08 -05:00
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Normal response codes: 200
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Request
-------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_path
Response
--------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_body
- links: links
- rules: rules
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Response Example
----------------
.. literalinclude:: federation/mapping/samples/get-response.json
:language: javascript
Update a mapping
================
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
.. rest_method:: PATCH /v3/OS-FEDERATION/mappings/{id}
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
[api] add relationship links to v3-ext Nearly all the "relationship" links are missing in v3 APIs Added relationship links to v3-ext API pages. Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e Closes-Bug: #1609159
2016-08-11 15:16:08 -05:00
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Normal response codes: 200
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Request
-------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_path
- rules: rules
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Request Example
---------------
.. literalinclude:: federation/mapping/samples/update-request.json
:language: javascript
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Response
--------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_body
- links: links
- rules: rules
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Response Example
----------------
.. literalinclude:: federation/mapping/samples/update-response.json
:language: javascript
List all mappings
=================
.. rest_method:: GET /v3/OS-FEDERATION/mappings
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mappings``
[api] add relationship links to v3-ext Nearly all the "relationship" links are missing in v3 APIs Added relationship links to v3-ext API pages. Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e Closes-Bug: #1609159
2016-08-11 15:16:08 -05:00
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Normal response codes: 200
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Response
--------
.. rest_parameters:: federation/mapping/parameters.yaml
- links: links_collection
- mappings: mappings
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Response Example
----------------
.. literalinclude:: federation/mapping/samples/list-response.json
:language: javascript
Delete a mapping
================
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
.. rest_method:: DELETE /v3/OS-FEDERATION/mappings/{id}
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
[api] add relationship links to v3-ext Nearly all the "relationship" links are missing in v3 APIs Added relationship links to v3-ext API pages. Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e Closes-Bug: #1609159
2016-08-11 15:16:08 -05:00
Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:33:33 -03:00
Normal response codes: 204
Detail Federation Mapping APIs in api-ref docs Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Request
-------
.. rest_parameters:: federation/mapping/parameters.yaml
- id: id_path
Copy Permalink