156 Commits

Author SHA1 Message Date
liyingjun
8026a952de Document query option (is_domain) for projects
The "is_domain" query parameter is missing from GET/UPDATE /v3/projects
documentation in the API site.

Change-Id: I059f7e2ac689ec799dbdcc30c071de26d1603c47
Closes-bug: #1609174
2016-08-07 22:47:10 +08: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
Jenkins
2b1cce8773 Merge "Move Assertion API to its own file" 2016-08-03 10:42:23 +00:00
Jenkins
919838ac98 Merge "Improve domain configuration API docs" 2016-08-03 10:41:25 +00:00
Eric Brown
ebe1e835cb Improve domain configuration API docs
* Beautified the response codes (removed trailing commas and added
  spaces)
* Creating a domain configuration was missing from the docs

Change-Id: Ifaabc38c27669588b1abcb1d121a9e4410d62ebb
Closes-Bug: #1607567
2016-08-03 04:29:23 +00:00
Samuel de Medeiros Queiroz
8eb67a9e01 Move Assertion API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Assertion API to its own file is one of the TODO comments left
there, which is being addressed in this change.

Change-Id: I0ad565619744eb7f7b3c2fb33971d8d8ab4e22ea
2016-08-03 01:58:02 +00:00
Samuel de Medeiros Queiroz
62d0175ada Move Federation Auth API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Auth API to its own file is one of the TODO comments left there,
which is being addressed in this change.

Change-Id: Icd0c293c1a326c9bf3fe1ca01c96e3908ac33db3
2016-08-02 13:18:19 -03:00
Samuel de Medeiros Queiroz
edd5827199 Move List Projects and Domains API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving List Projects and Domains API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: I78572d6605c7eddd9c7b41bb2e982dc10728f46e
2016-08-02 13:07:07 -03:00
Samuel de Medeiros Queiroz
34dd18c2c2 Move Service Provider API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Service Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: Iabe3d443f01b173024620aae629558d228c2cd10
2016-08-02 13:04:45 -03:00
Samuel de Medeiros Queiroz
fc9cfb76c5 Move Mapping API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Mapping API to its own file is one of the TODO comments left
there, which is being addressed in this change.

Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:52:33 -03:00
Steve Martinelli
85570dc678 refactor idp to its own file
for comparison

Change-Id: Ia1becc2fa36f095e30f306c6436bd180fb8760a2
2016-07-30 20:35:19 -07:00
Samuel de Medeiros Queiroz
0f6fa0e3d3 Move Identity Provider API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Identity Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: I5c5b26c2d4c9920d6b9642eaf0fc47ed5bffb3cb
2016-07-29 15:28:04 -03:00
Jenkins
4a8298d5b8 Merge "Improve os-federation docs" 2016-07-26 12:37:13 +00:00
Clenimar Filemon
ab7a7458e1 Improve os-federation docs
- add /v3/ to all routes;
- switch from 'localhost:port' and 'identity:port' endpoints to
  'example.com/identity';
- fix typo.

Change-Id: If0d90ebab78e93fc9395b0e02436853a4ecbfa73
2016-07-25 22:39:23 -03: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
Jenkins
a1ba4a22f6 Merge "PCI-DSS Adds password_expires_at to API docs" 2016-07-22 23:17:17 +00:00
Jenkins
c05d287ee2 Merge "Migrate OS-FEDERATION from specs repo" 2016-07-22 18:21:32 +00:00
Ronald De Rose
dfd5d25910 PCI-DSS Adds password_expires_at to API docs
This patch adds a new user response attribute, password_expires_at,
to the Identity API v3 documentation.

Passord expires validation implementation:
https://review.openstack.org/333360

Depends-On: I07c10de627898d6ac79578dc24292ded4a2190f1
Partially-implements: blueprint pci-dss
Change-Id: I37136f79488d7469f0b8b24e3f5628899e40cac0
2016-07-22 17:47:27 +00:00
Jenkins
b6fc525c8f Merge "Fix up the api-ref request/response parameters for projects" 2016-07-21 17:49:40 +00:00
Jenkins
0cecda6ff0 Merge "Clarify V2 API for enabling or disabling user" 2016-07-21 17:49:28 +00:00
Jenkins
f854241d0f Merge "password is not required for updating a user" 2016-07-21 17:48:25 +00:00
Jenkins
25c11ef293 Merge "Removed duplicate parameter in v2-admin api-ref" 2016-07-21 06:00:47 +00:00
Henry Nash
0b49d43e5b Fix up the api-ref request/response parameters for projects
A number of the examples are also updated, since not all of
them were valid combinations of domain_id, parent_id and
is_domain.

Change-Id: Id642762cd6acfdf6142b24caf3de1d16db599065
2016-07-21 06:07:43 +01:00
Dave Chen
0f13aed2d8 password is not required for updating a user
This patch fixes the nits from the below commit:

https://review.openstack.org/#/c/342089/

Change-Id: I062979ccce393e74e72c3d812657123151e476fd
2016-07-21 11:13:15 +08: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
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
Dave Chen
e183c14be7 Fix the errors in params in api-ref for V3 region
Change-Id: If412bb5424e61f45793f498112950ca02682a650
2016-07-20 22:12:58 +08:00
Dave Chen
14018e95f3 Fix the errors in params in api-ref for V3 user
This patch also take the chance to fix some examples.

Change-Id: I512d3dcc8a73d50b2bbee5f3d3b9f44c359e7416
2016-07-20 22:05:23 +08:00
Henry Nash
e8eeb433e1 Clean up api-ref for domains
Change-Id: Ia829c95945ae13e481a773815065bd2372b5895b
2016-07-19 17:33:54 +01:00
Jenkins
9f77e26b18 Merge "Clean up the api-ref for groups" 2016-07-19 10:26:04 +00:00
Jenkins
9adda34914 Merge "v2 api: add APIs for setting a user's password" 2016-07-19 01:50:27 +00: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
Clenimar Filemon
74a8e5be18 Update os-inherit API reference
In order to match the keystone-specs version [1].

[1] Ia838dff1863b1b77472079b32783ae31557b1ef5
Change-Id: I648a66107477daff491a55f7004ec4b4306832e6
2016-07-18 17:51:57 -03:00
Jenkins
816a2bdd55 Merge "Improve introdcution to api-ref projects" 2016-07-18 06:00:44 +00:00
Jenkins
d88cf20765 Merge "Update Identity endpoint in v2 samples" 2016-07-18 05:25:53 +00:00
Henry Nash
e4c30cb517 Clean up the api-ref for groups
The response paramaters for listing users who are members of a
group will be added in a later patch, once the users api-ref
has been cleaned up.

Change-Id: Ib08ac374f9e16aa443cc33253a84a67ab98958d0
2016-07-18 03:56:17 +01:00
Henry Nash
20259d1971 Improve introdcution to api-ref projects
This patch fixes up the intro to projects as well as where
we have text for a given API. A follow on patch will fix up
the paramaters, many of which are wrong.

Change-Id: Ia34a9a1c2460f95886d9d9ea0c560fdf94435012
2016-07-17 16:45:06 +01:00
Samuel de Medeiros Queiroz
53b5b99785 Migrate OS-FEDERATION from specs repo
This commit migrates OS-FEDERATION docs from the spec repo to keystone server
repo under api-ref/source/v3-ext/ directory.

Change-Id: I2423030bd0849c051d22f63bf60b6a5f41f72574
2016-07-17 03:27:18 +00:00
Jenkins
852bda4eae Merge "v2 api: remove APIs for global roles" 2016-07-16 18:42:13 +00:00
Jenkins
5e244d4706 Merge "v2 api: group and order the v2-ext APIs" 2016-07-16 18:42:04 +00:00
Jenkins
1af5e78db2 Merge "v2 api: remove duplicated delete user API" 2016-07-16 18:41:55 +00:00
Jenkins
49c0ac58e1 Merge "v2 api: add missing /roles in role CRUD APIs" 2016-07-16 18:40:12 +00:00
Jenkins
a0a05168cd Merge "v2 api: list user roles is defined twice" 2016-07-16 18:40:03 +00:00
Jenkins
e4954034d9 Merge "v2 api: add OS-KSADM to service API routes" 2016-07-16 18:39:54 +00:00
Jenkins
49c204cdc1 Merge "v2 api: add tenant APIs" 2016-07-16 18:39:45 +00:00
Jenkins
9d38dceecf Merge "v2 api: delete user is defined twice" 2016-07-16 18:39:37 +00:00
Jenkins
165411584f Merge "v2 api: change update user" 2016-07-16 18:39:28 +00:00
Jenkins
dcc96eecb6 Merge "v2 api: correct user list" 2016-07-16 18:17:47 +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