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
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
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
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
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
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
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
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
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
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
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