openstack/keystone
Code Issues Proposed changes

[api] add relationship links to v3-ext

Browse Source 
Nearly all the "relationship" links are missing in v3 APIs

Added relationship links to v3-ext API pages.

Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e
Closes-Bug: #1609159
This commit is contained in:
gage hugo 2016-08-11 15:16:08 -05:00
parent 35ee1a9564
commit cb51cb4037
8 changed files with 70 additions and 12 deletions
api-ref/source/v3-ext
federation
assertion
assertion.inc
auth
auth.inc
identity-provider
idp.inc
mapping
mapping.inc
projects-domains
projects-domains.inc
service-provider
sp.inc
revoke.inctrust.inc

6
api-ref/source/v3-ext/federation/assertion/assertion.inc

@ -7,6 +7,8 @@ Generate a SAML assertion
.. rest_method:: POST /v3/auth/OS-FEDERATION/saml2
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/saml2``
A user may generate a SAML assertion document based on the scoped token that is
used in the request.
@ -56,6 +58,8 @@ Generate an ECP wrapped SAML assertion
.. rest_method:: POST /v3/auth/OS-FEDERATION/saml2/ecp
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/saml2/ecp``
A user may generate a SAML assertion document to work with the
*Enhanced Client or Proxy* (ECP) profile based on the scoped token that is
used in the request.
@ -104,6 +108,8 @@ Retrieve Metadata properties
.. rest_method:: GET /v3/OS-FEDERATION/saml2/metadata
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/metadata``
A user may retrieve Metadata about an Identity Service acting as an Identity
Provider.

4
api-ref/source/v3-ext/federation/auth/auth.inc

@ -5,6 +5,8 @@ Request an unscoped OS-FEDERATION token
.. rest_method:: GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/auth
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol_auth``
A federated ephemeral user may request an unscoped token, which can be used to
get a scoped token.
@ -52,6 +54,8 @@ Request a scoped OS-FEDERATION token
.. rest_method:: POST /v3/auth/tokens
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/auth_tokens``
A federated user may request a scoped token, by using the unscoped token. A
project or domain may be specified by either id or name. An id is sufficient to
uniquely identify a project or domain.

20
api-ref/source/v3-ext/federation/identity-provider/idp.inc

@ -5,6 +5,8 @@ Register an Identity Provider
.. rest_method:: PUT /v3/OS-FEDERATION/identity_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
Normal response codes: 201
Error response codes: 409
@ -47,6 +49,8 @@ List identity providers
.. rest_method:: GET /v3/OS-FEDERATION/identity_providers
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``
Normal response codes: 200
Request
@ -76,6 +80,8 @@ Get Identity provider
.. rest_method:: GET /v3/OS-FEDERATION/identity_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
Normal response codes: 200
Request
@ -108,6 +114,8 @@ Delete identity provider
.. rest_method:: DELETE /v3/OS-FEDERATION/identity_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
When an identity provider is deleted, any tokens generated by that identity
provider will be revoked.
@ -125,6 +133,8 @@ Update identity provider
.. rest_method:: PATCH /v3/OS-FEDERATION/identity_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
When an identity provider is disabled, any tokens generated by that identity
provider will be revoked.
@ -169,6 +179,8 @@ Add a protocol and attribute mapping to an identity provider
.. rest_method:: PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
Normal response codes: 201
Request
@ -205,6 +217,8 @@ List all protocol and attribute mappings of an identity provider
.. rest_method:: GET /v3/OS-FEDERATION/identity_providers/{id}/protocols
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``
Normal response codes: 200
@ -235,6 +249,8 @@ Get a protocol and attribute mapping for an identity provider
.. rest_method:: GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
Normal response codes: 200
Request
@ -264,6 +280,8 @@ Update the attribute mapping for an identity provider and protocol
.. rest_method:: PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
Normal response codes: 200
Request
@ -300,6 +318,8 @@ Delete a protocol and attribute mapping from an identity provider
.. rest_method:: DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
Normal response codes: 204
Request

10
api-ref/source/v3-ext/federation/mapping/mapping.inc

@ -5,6 +5,8 @@ Create a mapping
.. rest_method:: PUT /v3/OS-FEDERATION/mappings/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
Normal response codes: 201
Request
@ -42,6 +44,8 @@ Get a mapping
.. rest_method:: GET /v3/OS-FEDERATION/mappings/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
Normal response codes: 200
Request
@ -72,6 +76,8 @@ Update a mapping
.. rest_method:: PATCH /v3/OS-FEDERATION/mappings/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
Normal response codes: 200
Request
@ -109,6 +115,8 @@ List all mappings
.. rest_method:: GET /v3/OS-FEDERATION/mappings
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mappings``
Normal response codes: 200
Response
@ -131,6 +139,8 @@ Delete a mapping
.. rest_method:: DELETE /v3/OS-FEDERATION/mappings/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/mapping``
Normal response codes: 204
Request

4
api-ref/source/v3-ext/federation/projects-domains/projects-domains.inc

@ -8,6 +8,8 @@ List projects a federated user can access
.. rest_method:: GET /v3/OS-FEDERATION/projects
Relationship: ``http://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
@ -38,6 +40,8 @@ List domains a federated user can access
.. rest_method:: GET /v3/OS-FEDERATION/domains
Relationship: ``http://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

10
api-ref/source/v3-ext/federation/service-provider/sp.inc

@ -5,6 +5,8 @@ Register a Service Provider
.. rest_method:: PUT /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Normal response codes: 201
Error response codes: 400 Bad Request when registering a service provider with
invalid URLs for either `auth_url` or `sp_url`.
@ -51,6 +53,8 @@ Listing Service Providers
.. rest_method:: GET /v3/OS-FEDERATION/service_providers
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_providers``
Normal response codes: 200
Response
@ -73,6 +77,8 @@ Get Service Provider
.. rest_method:: GET /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Normal response codes: 200
Request
@ -107,6 +113,8 @@ Delete Service Provider
.. rest_method:: DELETE /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Normal response codes: 204
Request
@ -122,6 +130,8 @@ Update Service Provider
.. rest_method:: PATCH /v3/OS-FEDERATION/service_providers/{id}
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/service_provider``
Normal response codes: 200
Error response codes: 400 Bad Request when updating a service provider with
invalid URLs for either `auth_url` or `sp_url`.

2
api-ref/source/v3-ext/revoke.inc

@ -34,6 +34,8 @@ List revocation events
.. rest_method:: GET /v3/OS-REVOKE/events
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-REVOKE/1.0/rel/events``
List revocation events.
The HTTP Date header returned in the response reflects the timestamp of the

26
api-ref/source/v3-ext/trust.inc

@ -95,6 +95,8 @@ Create trust
.. rest_method:: POST /v3/OS-TRUST/trusts
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trusts``
Creates a trust.
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trusts
@ -160,9 +162,9 @@ List trusts
.. rest_method:: GET /v3/OS-TRUST/trusts
Lists all trusts.
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trusts``
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trusts
Lists all trusts.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 405, 413, 503
@ -222,9 +224,9 @@ Get trust
.. rest_method:: GET /v3/OS-TRUST/trusts/{trust_id}
Gets the trust information for ``{trust_id}``.
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust``
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust
Gets the trust information for ``{trust_id}``.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 405, 413, 503
@ -270,9 +272,9 @@ Delete trust
.. rest_method:: DELETE /v3/OS-TRUST/trusts/{trust_id}
Deletes a trust with ``{trust_id}``.
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust``
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust
Deletes a trust with ``{trust_id}``.
Normal response codes: 204
Error response codes: 400, 401, 403, 404, 405, 409, 413, 415, 503
@ -295,9 +297,9 @@ List roles delegated by a trust
.. rest_method:: GET /v3/OS-TRUST/trusts/{trust_id}/roles
Lists roles delegated by a trust with ``{trust_id}``.
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_roles``
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_roles
Lists roles delegated by a trust with ``{trust_id}``.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 405, 413, 503
@ -323,9 +325,9 @@ Check if a role is delegated by a trust
.. rest_method:: HEAD /v3/OS-TRUST/trusts/{trust_id}/roles/{role_id}
Checks if a role is delegated by a trust.
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_role``
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_role
Checks if a role is delegated by a trust.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 405, 413, 503
@ -349,9 +351,9 @@ Get role delegated by a trust
.. rest_method:: GET /v3/OS-TRUST/trusts/{trust_id}/roles/{role_id}
Gets a role with delegated by a trust.
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_role``
Relationship: http://docs.openstack.org/api/openstack-identity/3/ext/OS-TRUST/1.0/rel/trust_role
Gets a role with delegated by a trust.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 405, 413, 503