30 Commits

Author SHA1 Message Date
Lance Bragstad
0286c3a92a Remove v2.0 identity API documentation
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
2017-10-06 15:29:36 +00:00
Lance Bragstad
9eef17930a Remove v2.0 assignment APIs
bp removed-as-of-queens

Change-Id: I29df48b0df39dc0a97e28a6436278734082d5ec7
2017-08-31 22:20:58 +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
Sean Dague
73939d90cd Fix warnings generated by os-api-ref 1.2.0
This addresses the warnings that os-api-ref 1.2.0 generates about
undocumented parameters.

Change-Id: I921ab1e2a05cd15885f789a4175c70056872f10a
2017-01-20 12:39:07 -05:00
Ha Van Tu
5fc08a7fce Fix prameters names in Keystone API v2-ext
Change-Id: Ie1d7b9eea14f331f6a51ae54e8792422660b9b1c
2016-09-20 17:34:50 +07:00
Nguyen Phuong An
77a002bd3f [api-ref] Correct response code status
This patch corrects response code status in keystone api.

Change-Id: I5e4a65990a50c37ab6cce55cba90fc5ca1b54ba1
2016-09-08 11:59:12 +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
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
Colleen Murphy
62fb97f71c Fix v2-ext API enabled documentation
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
2016-07-25 11:05:01 -07:00
Dave Chen
002de1b183 Clarify V2 API for enabling or disabling user
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
2016-07-21 10:50:04 +08:00
Steve Martinelli
7f7cfe7b7e v2 api: add APIs for setting a user's password
Add support for an admin setting a user's password, the route
is defined here:

https://github.com/openstack/keystone/blob/master/keystone/v2_crud/admin_crud.py#L110-L114

Also, this patch updates the sample response and sample request
for enabling a user, since the two APIs are very similar.

Change-Id: I3ad0d4ab8ebec7481954997cd0b127627a18f13d
2016-07-18 21:17:13 +00:00
Steve Martinelli
96852a0849 v2 api: remove APIs for global roles
These APIs will return a NotImplemented error.

Change-Id: I052864549eb3ef6d60e886caf5de6c71b324cce6
link: https://github.com/openstack/keystone/blob/master/keystone/assignment/controllers.py#L161-L163
2016-07-16 15:33:55 +00:00
Steve Martinelli
e6da0ba0f9 v2 api: group and order the v2-ext APIs
Group the services together, then the roles, then more advanced
role operations. No content was actually changed, just moved
things around.

Change-Id: If3f664c11958218bbcc38aa5c3ec75c714be32f1
2016-07-16 15:33:50 +00:00
Steve Martinelli
05fb9cc5e4 v2 api: remove duplicated delete user API
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
2016-07-16 15:33:44 +00:00
Steve Martinelli
eb27807b03 v2 api: add missing /roles in role CRUD APIs
Some of the APIs specified are missing the /roles portion of the
path, add it.

Also, group the role based APIs together.

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

Change-Id: I73b6a6b950b06a1b943abf7eba8e939bdc985820
2016-07-16 15:33:39 +00:00
Steve Martinelli
139dc8ddcc v2 api: list user roles is defined twice
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
2016-07-16 15:33:34 +00:00
Steve Martinelli
b135c27694 v2 api: add OS-KSADM to service API routes
The service CRUD APIs are missing the OS-KSADM path.

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

Change-Id: I87cd7c75f0397c78a3ad76abf0b516c4b5ef7f83
2016-07-16 15:33:30 +00: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
50c64f9c66 v2 api: delete user is defined twice
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
2016-07-16 15:33:08 +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
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
7d96826021 Merge "Add OS-KSCRUD api-ref" 2016-07-14 07:49:12 +00:00
Boris Bobrov
8a56b19734 Add OS-KSCRUD api-ref
Change-Id: Ibf837eb880ee1811bfc85464b213451ddaf94a0b
Closes-Bug: 1524153
2016-07-14 04:41:45 +00:00
Lance Bragstad
0b15eea06a Correct normal status codes for v2.0 admin docs
20X http status codes don't represent errors.

Change-Id: I425b898033d7c3007405f57981961708854c8cee
2016-07-13 20:20:18 +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
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