From edd58271995bfeba77151985b7e8697191b88d8a Mon Sep 17 00:00:00 2001 From: Samuel de Medeiros Queiroz Date: Tue, 2 Aug 2016 13:01:30 -0300 Subject: [PATCH] Move List Projects and Domains API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving List Projects and Domains API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I78572d6605c7eddd9c7b41bb2e982dc10728f46e --- api-ref/source/v3-ext/federation.inc | 48 +------------------ .../projects-domains/projects-domains.inc | 47 ++++++++++++++++++ .../samples}/domain-list-response.json | 0 .../samples}/project-list-response.json | 0 4 files changed, 48 insertions(+), 47 deletions(-) create mode 100644 api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc rename api-ref/source/v3-ext/{samples/OS-FEDERATION => federation/projects-domains/samples}/domain-list-response.json (100%) rename api-ref/source/v3-ext/{samples/OS-FEDERATION => federation/projects-domains/samples}/project-list-response.json (100%) diff --git a/api-ref/source/v3-ext/federation.inc b/api-ref/source/v3-ext/federation.inc index 5d526b894e..7ffc63ed25 100644 --- a/api-ref/source/v3-ext/federation.inc +++ b/api-ref/source/v3-ext/federation.inc @@ -300,54 +300,8 @@ to ``ss:mem:``. .. include:: federation/service-provider/sp.inc +.. include:: federation/projects-domains/projects-domains.inc -.. TODO(samueldmq): This is the Listing Projects and Domains API, move it to its - own file. -.. **Deprecated in v1.1**. This section is deprecated as the functionality is - available in the core Identity API. - -List projects a federated user can access -========================================= - -.. rest_method:: GET /v3/OS-FEDERATION/projects - -Normal response codes: 200 - -**Deprecated in v1.1**. Use core ``GET /auth/projects``. This call has the same -response format. - -Returns a collection of projects to which the federated user has authorization -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 -projects will be returned. - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-FEDERATION/project-list-response.json - :language: javascript - - -List domains a federated user can access -======================================== - -.. rest_method:: GET /v3/OS-FEDERATION/domains - -Normal response codes: 200 - -**Deprecated in v1.1**. Use core ``GET /auth/domains``. This call has the same -response format. - -Returns a collection of domains to which the federated user has authorization -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 -will be returned. - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-FEDERATION/domain-list-response.json - :language: javascript .. TODO(samueldmq): This is the Federation Authentication API, move it to its own file. diff --git a/api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc b/api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc new file mode 100644 index 0000000000..823a8796d8 --- /dev/null +++ b/api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc @@ -0,0 +1,47 @@ +.. -*- rst -*- + +.. **Deprecated in v1.1**. This section is deprecated as the functionality is + available in the core Identity API. + +List projects a federated user can access +========================================= + +.. rest_method:: GET /v3/OS-FEDERATION/projects + +Normal response codes: 200 + +**Deprecated in v1.1**. Use core ``GET /auth/projects``. This call has the same +response format. + +Returns a collection of projects to which the federated user has authorization +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 +projects will be returned. + +Response Example +---------------- + +.. literalinclude:: federation/projects-domains/samples/project-list-response.json + :language: javascript + + +List domains a federated user can access +======================================== + +.. rest_method:: GET /v3/OS-FEDERATION/domains + +Normal response codes: 200 + +**Deprecated in v1.1**. Use core ``GET /auth/domains``. This call has the same +response format. + +Returns a collection of domains to which the federated user has authorization +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 +will be returned. + +Response Example +---------------- + +.. literalinclude:: federation/projects-domains/samples/domain-list-response.json + :language: javascript diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/domain-list-response.json b/api-ref/source/v3-ext/federation/projects-domains/samples/domain-list-response.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/domain-list-response.json rename to api-ref/source/v3-ext/federation/projects-domains/samples/domain-list-response.json diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/project-list-response.json b/api-ref/source/v3-ext/federation/projects-domains/samples/project-list-response.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/project-list-response.json rename to api-ref/source/v3-ext/federation/projects-domains/samples/project-list-response.json