35 Commits

Author SHA1 Message Date
Lance Bragstad
139aa015d2 Remove v2.0 token APIs
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
2017-09-30 15:26:03 +00:00
Lance Bragstad
75f24c628b Remove v2.0 identity APIs
bp removed-as-of-queens

Change-Id: Icfd519f527de0e3945a858ce7f87ddadef766faa
2017-09-29 20:42:12 +00:00
Lance Bragstad
f2d2bcbf2b Remove v2.0 resource APIs
bp removed-as-of-queens

Change-Id: I2ac92c1f541b6348006d315f7ada6f6022944db4
2017-08-31 22:21:01 +00:00
Lance Bragstad
70ad022f70 Remove v2.0 service and endpoint APIs
These were deprecated in Mitaka and slated for removal in Queens.

bp removed-as-of-queens

Change-Id: I9fc718b48b64d5d607eb6ed53a0974d18ac41d3c
2017-08-31 20:17:54 +00:00
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
Samuel Pilla
4f4f8a7394 Remove unused api parameters
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
2017-02-07 09:45:02 -06:00
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
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
Ha Van Tu
364462e2db Refactor Keystone admin-tokens and admin-users v2
This patch modifies parameters name to make it be maintainable and
reusable

Change-Id: I0dc5fb29f3eef5e1269a36df4cd952ed54267f88
2016-11-28 18:18:39 +07:00
Samuel Pilla
2e70ecd8ce Document OS-SIMPLE-CERT Routes
Document certificates and OS-SIMPLE-CERT routes.

Change-Id: I528c3eb27a5226a4da17a3c3aa2ca3ccc65a5a39
Closes-Bug: #1626779
2016-11-01 08:26:00 -04:00
Lance Bragstad
7f3f596351 Fix the belongsTo query parameter
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
2016-09-23 21:05:16 +00:00
Ha Van Tu
f1da1c0ae0 Refactor Keystone admin-tenant API v2
This patch modifies parameters names in admin-tenant.inc

Change-Id: Ic5e4a00321d7999a060a7c6bc992f005e7aaaaeb
2016-09-20 10:30:22 +07:00
Ha Van Tu
32352f4c7e Refactor Keystone admin-endpoint API
This patch moves content of admin-endpoints_parameters.yaml to
parameters.yaml and modifies some parameters names.

Change-Id: I02e331c1673d7df87b27758d1329d6f9cc9caea9
2016-09-20 10:29:31 +07:00
Nguyen Phuong An
5c9fa41834 [api-ref] Correcting parameter's type
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
2016-09-06 04:17:38 +00:00
Chris Spencer
ba98048401 Add documentation on how to set a user's tenant.
Change-Id: I61b98891336ca1ed096f013ff1ed1a89d7854886
Closes-Bug: #1609161
2016-08-31 13:18:50 -07:00
Gage Hugo
6db31c8590 api-ref: Add missing parameter tables to tenant
This adds response tables to multiple tenant API calls within
the identity admin API.

Change-Id: I78ff3d981ed0a1d4dc42d0a81b0369e7275d4d85
Closes-Bug: #1572168
2016-08-09 10:37:31 -05: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
gage hugo
0e6752b7f5 Removed duplicate parameter in v2-admin api-ref
user_id was listed twice under the update user request parameters.
This fix removes the duplicated parameter.

Change-Id: I9c70aff00f151c4907101335174adf3624d4f686
2016-07-20 19:05:49 -05:00
Steve Martinelli
e00c89e965 v2 api: add tenant APIs
The /v2.0/tenant routes are incorrectly in the OS-KSADM APIs. They
should be in the v2-admin APIs.

Move the sample files accordingly and remove any unused sample files.

Route link: https://github.com/openstack/keystone/blob/master/keystone/v2_crud/admin_crud.py#L60-L79

Change-Id: I6e6dd4bbfdb8b46fb146db089eaeaaa1f6d2d86a
2016-07-16 15:33:20 +00:00
Steve Martinelli
1963093f5e v2 api: change update user
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
2016-07-16 06:42:40 -07:00
Steve Martinelli
cab514de1f v2 api: correct user list
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
2016-07-16 06:35:00 -07:00
Jenkins
94b8907fff Merge "Add v2.0 /endpoints/ api-ref" 2016-07-15 07:23:36 +00:00
Boris Bobrov
5d42b3e577 Add v2.0 /endpoints/ api-ref
Change-Id: I5f1b93251f9256f40394fda56b3c3f16227fafe5
Closes-Bug: 1569384
2016-07-15 04:58:13 +00:00
Jenkins
7b835e4f53 Merge "Variables in URL path should be required" 2016-07-14 17:39:19 +00:00
Dave Chen
f8231b8daf Variables in URL path should be required
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
2016-07-14 19:25:41 +08:00
Jenkins
df056ec9e9 Merge "Correct normal response codes in v2.0 versions doc" 2016-07-14 06:47:56 +00:00
Jenkins
c55dc06040 Merge "Correct normal response codes in v2.0 admin user docs" 2016-07-14 05:56:10 +00:00
Jenkins
45538f8ac1 Merge "Correct normal response codes in v2.0 tenant docs" 2016-07-14 05:55:52 +00:00
Lance Bragstad
edc2cc1755 Correct normal response codes in v2.0 versions doc
20X http status codes don't represent errors.

Change-Id: I295a7cedc810619debd921b3c8611ff816b30150
2016-07-13 19:56:24 +00:00
Lance Bragstad
b87b8f755d Correct normal response codes in v2.0 tenant docs
20X http status codes don't represent errors.

Change-Id: I8c63e725d80f6807c13d42926079d09480ebc4f6
2016-07-13 19:55:11 +00:00
Lance Bragstad
c36fa2c5c1 Correct normal response codes in v2.0 token docs
20X http status codes don't represent errors.

Change-Id: I6ffc7dd0fb0ee27948d0ebc6e2df043e7c35de0b
2016-07-13 19:50:53 +00:00
Lance Bragstad
7acd8d0a1a Correct normal response codes in v2.0 admin user docs
20X http status codes don't represent errors.

Change-Id: I6483d8eba7cce0a788eca0a8d12ad408062f14a9
2016-07-13 19:44:37 +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