19 Commits

Author SHA1 Message Date
Samriddhi Jain
dac0e0572e Reorganised api-ref index page
Currently in the keystone API documentation page located at,
https://developer.openstack.org/api-ref/identity/index.html
all the sections and sub-sections appear at the same depth.
This makes the ordering very untidy and confusing.

This patch reorganises the appearance of sections and
sub-sections at the index page.

Change-Id: I55ae0102236805591e653c153618dec2af510c63
2017-07-13 19:40:07 +05:30
Eric Brown
30d9095d28 Use https for docs.openstack.org references
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
2017-01-30 16:05:08 -08:00
Brant Knudson
42d19a072d Correct invalid rst in api docs
This rst was invalid so the docs didn't render correctly.

Change-Id: I9eb802cd6231ccfe907b931abe2a8c5f72f40443
2017-01-05 22:00:22 +00:00
Brant Knudson
ec4d0551c0 Correct timestamp format in token responses
The token issue response has timestamps like this:

  "issued_at": "2017-01-03T22:42:55.000000Z"
  "expires_at": "2017-01-03T23:42:55.000000Z"

Which didn't match the format documented in the API spec (the
response has subsecond precision and Z rather than ±HHMM).

Change-Id: I1deeac1776a7716ee66d187d1c1c7c1f5b02235f
Closes-Bug: 1634568
2017-01-04 13:05:23 -06:00
jolie
76139d1507 [api] Inconsistency between v3 API and keystone token timestamps
The v3 API spec for tokens documents the format of timestamps.
It says the format is like "CCYY-MM-DDThh:mm:ss±hh:mm".
By this, the timestamps returned by keystone like this:
2016-12-13T15:33:12+0000

Change-Id: I616865c1b12457487c4aeb5b8e907ca01cb79ef9
Closes-Bug:#1634568
2016-12-28 15:17:23 +08:00
Samuel Pilla
c70baa0a7a Document v2 Revoked Token Route
Adds documentation for /v2.0/tokens/revoked in /api-ref.

Patch for v3: https://review.openstack.org/#/c/390904

Change-Id: I2a09eba3484299a63b30d936e5677a9e1d922c04
Partial-Bug: #1626778
2016-10-31 21:45:35 +00:00
Nguyen Phuong An
36d7be0e79 Fix prameters name and response codes in Keystone API v2
This patch fixes parameters name and response codes in Keystone
API v2.

Change-Id: I0b81389ee43e588c5a37d7470763d7ecf853fbd3
2016-09-13 08:54:20 +07:00
Matt Riedemann
50ff85813f Update the api-ref to mark the v2 API as deprecated
The v2 API was deprecated in mitaka with change:

e63a8311fa2e5d7cccdb76b4cd3fc17719cc86c6

The api-ref needs to be updated to show that as
well since that's the main thing someone sees when
they are in the API docs.

The status value comes from:

https://wiki.openstack.org/wiki/VersionDiscovery#status

Change-Id: I6dc5d8fd26d0981e5d83e829fe2dd09b7b9b4c17
2016-08-04 16:01:05 -04:00
Jenkins
d88cf20765 Merge "Update Identity endpoint in v2 samples" 2016-07-18 05:25:53 +00:00
Clenimar Filemon
9c4ac4e613 Update Identity endpoint in v2 samples
Change the endpoints in order to match the current API responses.
Switch sample domain from localhost to example.com.

localhost:5000/v2.0 -> example.com/identity/v2.0
localhost:35357/v2.0 -> example.com/identity_v2_admin/v2.0

The service catalog returned in authenticate-response, though, doesn't
keep the /v2.0. So, in this case, switch from localhost:5000/v2.0 to
example.com/identity. This matches the current API responses.

Change-Id: If26baeca17b19fa9fac3ace285d10dd28e824d4a
2016-07-16 03:43:10 +00:00
Jenkins
0907156538 Merge "Correct normal response codes for v2.0 extensions" 2016-07-14 23:01:15 +00:00
Jenkins
c59b5ac72d Merge "Add "v2 overview" docs to APIs" 2016-07-14 22:00:24 +00:00
Lance Bragstad
6ac478c529 Correct normal response codes for v2.0 extensions
20X http status codes don't represent errors.

Change-Id: I86e44c535c35a843191b89f7b368171b69a53202
2016-07-14 20:46:28 +00:00
Steve Martinelli
8517caa07b Add "v2 overview" docs to APIs
Migrate the content from [1] over to the in-tree API.

Do not include extensions or versions since those are already
documented.

[1] http://specs.openstack.org/openstack/keystone-specs/#v2-0-api

Change-Id: If31f86d93b0b3c44295d969d8f5bd408a18705fb
2016-07-14 19:39:14 +00:00
Lance Bragstad
f51b06a54e Correct normal response codes for v2.0 versions doc
20X and 30X http status codes don't represent errors.

Change-Id: I8a6809f89391e0cf4b59ffc5aa14607fee01c8a6
2016-07-13 20:01:00 +00:00
Steve Martinelli
4f183727f1 generate separate index files for each api-ref
currntly, no index.html file is generated for any of the APIs,
which should be required to migrate over to the api-site.

check the generated build.

Change-Id: Ib290c7412ff426b3061c5ad7535c8cb8310500fa
2016-07-04 13:03:55 -07:00
Samuel de Medeiros Queiroz
11d6b32fd4 Migrate identity /v2-admin 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 v2
admin docs to our repository under 'api-ref/source' directory. Missing
parameters definitions were added. It also removes admin-extensions.inc
as it did not contain any information.

The operation of listing roles for user had it title renamed so there
is not a duplicate label warning when running the api-ref job.

The API examples were moved into '/v2-admin/samples'.

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.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: I39d6c6197a939d77fc462c091051760d6b626d80
2016-07-04 15:36:43 -03:00
Samuel de Medeiros Queiroz
1ee8252e6a Migrate identity /v2-ext 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 v2
extension docs to our repository under 'api-ref/source' directory. It
also removes the OS-KSCATALOG, OS-KSS3 and OS-KSVALIDATE docs, given
they do not exist anymore. Missing parameters definitions were added.

The API examples for the extensions were moved into '/v2-ext/samples'.

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.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: If7adf10d0bb5fb07db70d4f42364fa0b50568a01
2016-06-28 18:53:08 +00:00
Samuel de Medeiros Queiroz
3bfb08e4b1 Migrate identity /v2 docs from api-ref repo
Docs at [1] have already been converted from WADL (SGML / XML) to RST
using fairy-slipper [2].

This commit polishes the results from the conversion and migrates the v2
docs to our repository under 'api-ref/source' directory. Missing
parameters definitions were added.

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.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: Id21d94a73f601561cb5f3e00ae25f4a5e4087716
2016-06-28 18:52:47 +00:00