keystone/api-ref/source/v3-ext/index.rst
Gage Hugo 6c8ea57210 Add description for relationship links in api-ref
This adds a section within the index file that describes what a
relationship link is and what it is used for in terms of each
operation within keystone. There will be a relationships section
in both v3 and v3-ext.

This should help clarify any confusion that may arise when a user is
viewing the api-ref about what the relationship links are.

Change-Id: I9c6b7959ed6ea682c565c515af0cf509b6a64e5d
Closes-Bug: #1674676
2017-08-09 20:59:55 +00:00

988 B

tocdepth

3

Identity API v3 extensions (CURRENT)

Relationships

The entries within the operations below contain a relationship link, which appears as a valid URI, however these are actually URN (Uniform Resource Name), which are similar to GUID except it uses a URI syntax so that it is easier to be read. These links do not resolve to anything valid, but exist to show a relationship.

Identity API Extensions

This page describes these Identity API v3 extensions:

  • OS-ENDPOINT-POLICY API
  • OS-OAUTH1 API
  • OS-TRUST API
  • OS-REVOKE API
  • OS-EP-FILTER API
  • OS-FEDERATION API
  • OS-SIMPLE-CERT API