From 5d2fd076c38f5a61c9b16e0815bd3f51679e8cc1 Mon Sep 17 00:00:00 2001 From: Samuel de Medeiros Queiroz Date: Fri, 12 Aug 2016 18:28:21 -0300 Subject: [PATCH] Detail Fed Projects and Domains APIs in api-ref Change-Id: Ifab067287e67ed9a5cb5dd806221d29d240f0241 --- .../projects-domains/parameters.yaml | 35 +++++++++++++++++++ .../projects-domains/projects-domains.inc | 16 +++++++++ 2 files changed, 51 insertions(+) create mode 100644 api-ref/source/v3-ext/federation/projects-domains/parameters.yaml diff --git a/api-ref/source/v3-ext/federation/projects-domains/parameters.yaml b/api-ref/source/v3-ext/federation/projects-domains/parameters.yaml new file mode 100644 index 0000000000..1633caf040 --- /dev/null +++ b/api-ref/source/v3-ext/federation/projects-domains/parameters.yaml @@ -0,0 +1,35 @@ +# variables in header + +# variables in path + +# variables in query + +# variables in body + +domains: + description: | + The list of domains the authenticated user may scope to + in: body + required: true + type: object + +links_domains: + description: | + Link to the URI where the domain collection is located + in: body + required: true + type: object + +links_projects: + description: | + Link to the URI where the project collection is located + in: body + required: true + type: object + +projects: + description: | + The list of projects the authenticated user may scope to + in: body + required: true + type: object 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 index 823a8796d8..957d72108e 100644 --- a/api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc +++ b/api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc @@ -18,6 +18,14 @@ 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 +-------- + +.. rest_parameters:: federation/projects-domains/parameters.yaml + + - links: links_projects + - projects: projects + Response Example ---------------- @@ -40,6 +48,14 @@ 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 +-------- + +.. rest_parameters:: federation/projects-domains/parameters.yaml + + - domains: domains + - links: links_domains + Response Example ----------------