11 Commits

Author SHA1 Message Date
gage hugo
d36e555788 [api] add relationship links to v3
Nearly all the "relationship" links are missing in v3 APIs.

Added relationship links to v3 API pages.

Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8
Partial-Bug: #1609159
2016-08-11 15:17:59 -05:00
liyingjun
b9c671718d Document get auth/catalog,projects,domains
This patch adds GET /auth/catalog, GET /auth/projects and GET /auth/domains
to the API site.

Change-Id: Ifda4676680bb9759348bbf7f3353741c45308b8c
Closes-bug: #1609178
2016-08-11 15:36:27 +08:00
Anh Tran
b3c838153f api-ref: Correcting V3 Authentication APIs
http://developer.openstack.org/api-ref/identity/v3/index.html#authentication-and-token-management

Change-Id: I17a3a974c36c0992c681100833f0443963edbf69
Partial-Bug: #1610777
2016-08-11 08:29:42 +07:00
Jenkins
93248d23a1 Merge "api-ref: Correcting V3 Endpoints APIs" 2016-08-10 22:14:22 +00:00
Anh Tran
6919253c8f api-ref: Correcting V3 Endpoints APIs
Correcting all parameters of Show/Create/List/Update/Delete APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html?#show-endpoint-details

Change-Id: Iea796c4cd475bd0bb2879f4810abf9a645ff58ea
Partial-Bug: #1610777
2016-08-09 14:17:00 +07:00
Tin Lam
82bf342f20 api-ref: Add "nocatalog" option to GET /v3/auth/tokens
Added missing "nocatalog" query parameter for GET /v3/auth/tokens API
to api-ref.  See [1].

[1] http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#validate-token

Change-Id: Ie2310b7dfaf8d6a05b6a61ac6f9639d181798930
Closes-Bug: #1609177
2016-08-09 00:51:58 -05:00
Lance Bragstad
179f0fdaca Correct normal response codes for auth docs
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
2016-07-13 20:09:17 +00:00
Jenkins
3eed447128 Merge "[doc/api]Remove space within word" 2016-07-05 14:36:05 +00:00
Atsushi SAKAI
e37db54212 [doc/api]Remove space within word
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
2016-07-05 16:39:10 +09:00
Steve Martinelli
ebccd23b78 Add missing preamble for v3 and v3-ext
The api-ref site had a short blurb about the resources listed
in the document, add that back.

Change-Id: I2bac40a250a5b73fb70320d598a12c34c359e3c2
2016-07-04 14:35:49 -07:00
Samuel de Medeiros Queiroz
9a5395f1b2 Migrate identity /v3 docs from api-ref repo
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
2016-05-24 09:58:23 -03:00