The /v3/auth/token API's response body doesn't contain
extra at all.
It has been removed here: https://review.openstack.org/#/c/249480/
This patch remove the "extra" from api-ref to avoid misleading.
Change-Id: I3d41c022835bc43e5bf46d1d522dfcdcc0a8922e
This commit adds HEAD counterparts to all GET APIs within the
authentication API.
There was also some inconsistencies in the existing documention
saying a few GET APIs return 204 No Content when the response
was actually 200 OK. This corrects that as well.
Change-Id: Ic1f74b73e27a14428b129bed610d3d1d3d18f24e
Partial-Bug: 1696574
The description of scope parameter in the API docs is inconsistent for
scoped and explicit unscoped authorization. It doesn't explain clearly
when the parameter should be set to keyword 'unscoped' (explicit
unscoped authorization) and when to include ID/name of the project/
domain (scoped authorization). This patch covers the required update
for the scope parameter by introducing separate descriptions for the
above mentioned cases.
For explicit unscoped authorization, the keystone server specifies
scope value as 'unscoped' whereas in some old versions of keystoneauth
the value is {'unscoped': {}}. Added a comment to keystone/auth/schema.py
to make sure the type of scope parameter is object and not string, so
that it is consistent with older versions too.
In v3 API docs the case for token authentication with explicit unscoped
authorization is missing. Added documentation and request example for
that case.
Partial-Bug #1637682
Change-Id: I10d38e4cc59934c421443322b14f4f971acf3a29
Only x-auth-token is required for these api calls, but the
api-ref mentions x-subject-token as required also.
This fixes that by removing x-subject-token from the call docs.
Change-Id: I26342250c74918c21fce951bf0706d50141aa58c
Closes-Bug: 1673301
Currently the api ref states the return code for
GET /v3/auth/catalog returns 204 no content. However
after testing the return code is 200 ok. This commit
updates api-ref to correct return code.
Change-Id: I5f1049b565b1e11fb6e748b43ae9dfe1e16250a6
Closes-Bug: 1670380
Only x-auth-token is required for these api calls, but the
api-ref mentions x-subject-token as required also.
This fixes that by removing x-subject-token from the call docs.
Change-Id: Ib30a71b81939b11363aced4aecd545049c210380
Closes-Bug: 1667194
Some parameters of similar name would follow the convention
such as `region_id` and `region_id_1` which gave no good
information as to the differences.
This patch changes these names to help give such information.
Change-Id: I2dec61ed06042990ff54e86c02dc3fca9d566366
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.
Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
A service user from auth_token middleware should be able to fetch a
token that has expired within a certain window so that long running
operations can finish.
Implements bp: allow-expired
Change-Id: I784f719be88481048f5aa7a79d34a54907438cf3
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.
Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
Nearly all the "relationship" links are missing in v3 APIs.
Added relationship links to v3 API pages.
Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8
Partial-Bug: #1609159
This patch adds GET /auth/catalog, GET /auth/projects and GET /auth/domains
to the API site.
Change-Id: Ifda4676680bb9759348bbf7f3353741c45308b8c
Closes-bug: #1609178
The authentication docs for v3 were listing 20X http status codes as Error
responses. This commit corrects the documentation to list 20X codes as Normal
response codes.
Change-Id: I317d7e3571e5a80b5efa74141be1c12226a13699
Following two words should not have space.
X-Subject-Token
X-Auth-Token
But currently these two words have CR within these words,
This causes redundunt spaces.
http://developer.openstack.org/api-ref/identity/v3/authenticate-v3.html
Change-Id: I3ae39cdaf19b73b5f7750eeb9b01d1447e2ca73a
Docs at [1] have already been converted from WADL (SGML / XML) to RST
using fairy-slipper [2].
This commit polish the results from the conversion and migrate the docs
to our repository under 'api-ref/source' directory. In addition, it
added missing descriptions for access_token_id and consumer_id to
'parameters.yaml'.
Polishing the generated RST files include:
- Removing unnecessary blank lines;
- Removing empty references.
Polishing the generated RST files do not include:
- Modifying their content;
- Modifying file names;
- Wrapping lines at the maximum of 79 chars.
Updating the documentation will be done after this migration step.
This change also adds a tox environment to build the docs using sphinx
under 'api-ref/build', which in turn is added to '.gitignore'.
Lastly, 'os-api-ref' is added as a test requirement. It provides the
sphinx stanzas rest_method and rest_parameter, used to define OpenStack
APIs in RST docs.
[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper
Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
