This commit removes all the v2.0 token APIs with the exception of the
v2.0 authenticate for token API. POST /v2.0/tokens affects so much
stuff that we can do it in a separate patch and hopefully make it
easier for reviewers.
bp removed-as-of-queens
Change-Id: I508e7350c2a2d25c8fb413ea3523633f8939d80f
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 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 belongsTo query parameter is only supported by the v2.0
token validation API. It would check the ID of the project passed
to the belongsTo parameter against the project a token was scoped to.
This commit corrects the implementation, tests, and adds
documentation. It also moves the check to keystone.token.controller
since belongsTo is a v2-ism and doesn't belong in the
keystone.token.provider.
Closes-Bug: 1627085
Closes-Bug: 1626794
Change-Id: I4a06a498112b81093d7e5ef3142bb1e2d0f78138
This patch moves content of admin-endpoints_parameters.yaml to
parameters.yaml and modifies some parameters names.
Change-Id: I02e331c1673d7df87b27758d1329d6f9cc9caea9
This patch corrects some parameter's type such as 'type: list'
to 'type: array' or 'type: array of...' to 'type: array' because we
don't have 'type: list' in 'JSON Schema primitive types' [1]
[1] http://json-schema.org/latest/json-schema-core.html#anchor8
Change-Id: Ic638ef48fcf0f60c55cec975ee20a71d1830b319
This adds response tables to multiple tenant API calls within
the identity admin API.
Change-Id: I78ff3d981ed0a1d4dc42d0a81b0369e7275d4d85
Closes-Bug: #1572168
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
user_id was listed twice under the update user request parameters.
This fix removes the duplicated parameter.
Change-Id: I9c70aff00f151c4907101335174adf3624d4f686
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
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