Since we removed the v2.0 identity API:
Icfd519f527de0e3945a858ce7f87ddadef766faa
We can remove these documents since the no longer apply.
bp removed-as-of-queens
Change-Id: I645367ecdcd62d6b55b182c0550ef351fedf06d8
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
This patch removes any unused parameters in the v2 and v3 api's.
In order to find which parameters were unused, I wrote a script
that found all the parameters used in the `parameters.yaml` files,
then is searched the same api directory (ex: v3/, v3-ext/, etc.)
for any reference to these parameters. Anything unreferenced was
flagged and then removed.
Script: http://cdn.pasteraw.com/8cdh0e76aqhtliuh874veautr7as8k7
Change-Id: I1558ac94e1041f9fbb1d6713b394c4f97f997ada
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
The 'enabled' key in the parameters list refers to a tenant, not a
user. The `/v2.0/users/{userId}/OS-KSADM/enabled` method is operating
on a user, so we should use the 'enabled_1' key. 'enabled_1' is not a
very descriptive name so let's call it 'enabled_user' instead.
Moreover, this parameter is required, so it does not make sense for it
to have a default when the user must supply a value, so this patch
modifies the 'enabled_1' (now called 'enabled_user') description to
reflect that.
Change-Id: I81a7c68d5000ca6acab74679b49eeb619a5b914e
This small change make it clear that the API can also disable a
user and the request body with `enabled` attribute is always needed.
Change-Id: I4e242d36e9830fd162634c5a864f6a787a4de9d7
Related-Bug: #1603905
Group the services together, then the roles, then more advanced
role operations. No content was actually changed, just moved
things around.
Change-Id: If3f664c11958218bbcc38aa5c3ec75c714be32f1
This is already defined in the v2-admin docs, it's not needed in
the v2-ext docs, it's not part of OS-KSADM.
Remove the sample response file, it's not needed.
Change-Id: If6a08b67c8cef9540d3d10b8bcb4f626954bd92d
it's already property defined in the v2-admin docs, remove
the sample (user-roles-list) since it's not used.
Slightly unrelated, but a quick correction anyway. The API that enabled
the user was also corrected, and resulted in removing an unused sample.
Change-Id: Id69aa1e58e41888093083f41261bf1f39a74b62a
The DELETE /v2.0/users/{userId} route is unnecessarily in the OS-KSADM
APIs, it's not part of that extension. It is already defined correctly
in the v2-admin APIs.
Change-Id: I39ecee3918dc2fd6afb8448fe972def2876a51c9
The PUT /v2.0/users/{userId} route is unnecessarily in the OS-KSADM APIs,
it's not part of that extension. It is already defined correctly in the
v2-admin APIs.
Further, the update example is the v2-ext docs was a bit nicer, so use
that one, update the request and response for that route. Delete the
example in v2-ext since nothing else uses it.
Route link: https://github.com/openstack/keystone/blob/master/keystone/v2_crud/admin_crud.py#L93-L97
Change-Id: I14bdf9a3b4c09a7b48cc52b0ff32f72dcb115178
The GET /v2.0/users route is unnecessarily in the OS-KSADM APIs, it's
not part of that extension. It is already defined correctly in the
v2-admin APIs.
Further, the sample response shows a single user, not a list, so fix
that while we're at it.
Route link: https://github.com/openstack/keystone/blob/master/keystone/v2_crud/admin_crud.py#L81-L86
Change-Id: I4131b955a6986a1311c1e100a54ab18f8622b2ff
These inline parameters are not optional, they are required to call the
API, this patch change all of them from optional to required.
Change-Id: I6b1c8893b12e5e88f887c884b9812eb1005dcbdd
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
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