openstack/keystone
Code Issues Proposed changes

Reorganize api-ref: v3-ext federation projects-domains.inc

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

Change-Id: Id12aa4cda271b38dfe0233817c7dad3eea42ec2e
This commit is contained in:
Suramya Shah 2018-01-11 21:32:42 +05:30
parent 1ad32c2ad7
commit 51d725c896
1 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc
View File

@ -8,10 +8,6 @@ List projects a federated user can access
.. rest_method:: GET /v3/OS-FEDERATION/projects .. rest_method:: GET /v3/OS-FEDERATION/projects
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/projects``
Normal response codes: 200
**Deprecated in v1.1**. Use core ``GET /auth/projects``. This call has the same **Deprecated in v1.1**. Use core ``GET /auth/projects``. This call has the same
response format. response format.
@ -20,16 +16,28 @@ to access. To access this resource, an unscoped token is used, the user can
then select a project and request a scoped token. Note that only enabled then select a project and request a scoped token. Note that only enabled
projects will be returned. projects will be returned.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/projects``
Response Response
-------- --------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/projects-domains/parameters.yaml .. rest_parameters:: federation/projects-domains/parameters.yaml
- links: links_projects - links: links_projects
- projects: projects - projects: projects
Response Example Status Codes
---------------- ~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
Example
~~~~~~~
.. literalinclude:: federation/projects-domains/samples/project-list-response.json .. literalinclude:: federation/projects-domains/samples/project-list-response.json
:language: javascript :language: javascript
@ -40,10 +48,6 @@ List domains a federated user can access
.. rest_method:: GET /v3/OS-FEDERATION/domains .. rest_method:: GET /v3/OS-FEDERATION/domains
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/domains``
Normal response codes: 200
**Deprecated in v1.1**. Use core ``GET /auth/domains``. This call has the same **Deprecated in v1.1**. Use core ``GET /auth/domains``. This call has the same
response format. response format.
@ -52,16 +56,28 @@ to access. To access this resource, an unscoped token is used, the user can
then select a domain and request a scoped token. Note that only enabled domains then select a domain and request a scoped token. Note that only enabled domains
will be returned. will be returned.
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/domains``
Response Response
-------- --------
Parameters
~~~~~~~~~~
.. rest_parameters:: federation/projects-domains/parameters.yaml .. rest_parameters:: federation/projects-domains/parameters.yaml
- domains: domains - domains: domains
- links: links_domains - links: links_domains
Response Example Status Codes
---------------- ~~~~~~~~~~~~
.. rest_status_code:: success ../v3/status.yaml
- 200
Example
~~~~~~~
.. literalinclude:: federation/projects-domains/samples/domain-list-response.json .. literalinclude:: federation/projects-domains/samples/domain-list-response.json
:language: javascript :language: javascript