255 Commits

Author SHA1 Message Date
Steve Martinelli
f4a30aac66 [api] add changelog from 3.0 -> 3.7
This section was missed from the migration (from specs to api-ref).

Change-Id: Id7243ea0f2dbfbb4b579489fdb4f75c7a4b7b940
Closes-Bug: 1637214
2016-11-18 09:09:08 +00:00
Gage Hugo
d3e955f993 Change "Change User Password" request example
Changed the new password value in the JSON request for
V3 "Change User Password" example to be more clear about which field
the "new" password should be in and that the user's password will be
that "new" password.

Change-Id: I6790422956ed99f90fd41b6774bd266fd57d7130
2016-11-16 09:39:52 -06:00
Jenkins
1b5bbf3340 Merge "[api-ref] Fix couple of issues on OS-INHERIT API" 2016-11-09 20:50:31 +00: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
Jenkins
9c2a48829d Merge "Document v2 Revoked Token Route" 2016-11-01 12:12:20 +00:00
Samuel Pilla
c70baa0a7a Document v2 Revoked Token Route
Adds documentation for /v2.0/tokens/revoked in /api-ref.

Patch for v3: https://review.openstack.org/#/c/390904

Change-Id: I2a09eba3484299a63b30d936e5677a9e1d922c04
Partial-Bug: #1626778
2016-10-31 21:45:35 +00:00
Tin Lam
095ed9187b Add api-ref /auth/tokens/OS-PKI/revoked (v3)
The v3 endpoint documentation /v3/auth/tokens/OS-PKI/revoked is missing
in /api-ref.  This patch set adds the documentation for v3.
A separate patch set will be submitted for v2.

Change-Id: I3db3356d24cc8885012756016a90a0996fcf14f5
Partial-Bug: #1626778
2016-10-31 20:05:00 +00:00
Jenkins
827de44a22 Merge "Validate mapping exists when creating/updating a protocol" 2016-10-21 03:55:42 +00:00
Ronald De Rose
de8fbcf9a0 Validate mapping exists when creating/updating a protocol
This patch validates that a mapping exists when adding or updating
a federation protocol.

Change-Id: I996f94d26eb0f2c679542ba13a03bbaa4442486a
Closes-Bug: #1571878
2016-10-20 19:12:04 +00:00
tengqm
d45d82f6ed Tweak api-ref doc for v3 roles
The current API doc for v3 roles is very difficult to navigate. This
patch reorders the APIs in the following order:

- roles
- group roles on domain
- user roles on domain
- group roles on project
- user roles on project
- implied (infererence) roles
- others

Inside each group, APIs are reordered as following:

- list
- create (assign)
- get/retrieve
- verify/confirm (if applicable)
- update (if applicable)
- delete

Change-Id: I465cd493958a3e8384a7ae750b528d5fc08326de
2016-10-19 12:29:16 +00:00
tengqm
bc756d5152 Tweak api-ref doc for v3 roles status codes
This patch reformats the presentation of status codes for the v3 roles
in api-ref documentation.

Change-Id: I706f7dfa16b11aaa9b6233d8b41a11822012e746
2016-10-19 12:29:10 +00:00
tengqm
43b55f1e39 Reorder APIs in api-ref for v3 groups
This patch reorders the APIs documented for v3 groups. After the
revision the order becomes:

 - list group
 - create group
 - show group
 - update group
 - delete group

 - list users in group
 - add user to group
 - check whether user belongs to a group
 - remove user from group

This reordering is for consistency among all APIs and for ease of
browsing (List followed by CRUD in that order).

Change-Id: I7d829e993ae9bffac95c04d1f40613bcf65eed49
2016-10-19 02:33:40 -04:00
Jenkins
20b3be55af Merge "Tweak api-ref for v3 groups status codes" 2016-10-19 03:11:25 +00:00
Dave Chen
c7c0b99185 [api-ref] Remove the duplicated sample
The sample is not used anywhere and it is duplicated with
'auth-password-unscoped-request-with-domain.json'.

Change-Id: Ia47b05dfbd588b0d4886027d9e770864fff964ba
2016-10-18 08:40:38 +00:00
npraveen35
193915938c changed domain id to name in JSON request
When authenticating, it is more common for a user to supply a name
for a resource rather than an ID.

Further, since the bootstrapping command was introduced the "id" of the
default domain is no longer "default" but rather a UUID.

Change-Id: Ib75fac089924ab9c513861027f1875058232408e
Closes-Bug: #1633285
2016-10-18 03:45:27 +00:00
Dave Chen
382279f701 [api-ref] Fix couple of issues on OS-INHERIT API
- The doc was incorrectly defined the relationship by a link to
the doc.
- Remove couple of APIs that have not implemented yet, this patch
reference with the BP, so that they can be added back if those APIs
is implemented one day.

Change-Id: I32155733b848fafa809114182a164db777e33e93
Implements: blueprint hierarchical-multitenancy
2016-10-17 11:01:11 +08:00
Jenkins
c1fd67deb5 Merge "Return password_expires_at during auth" 2016-10-14 06:42:24 +00:00
Ronald De Rose
02452d02c4 Return password_expires_at during auth
The new user attribute, password_expires_at, is not being returned
during auth; this patch adds it.

bp password-expires-validation
Change-Id: I1f17a849d9da4067d6be7d612c5a561bcb247ebb
2016-10-14 00:25:57 -04:00
Steve Martinelli
1974f2d5dc [api] add a note about project name restrictions
Mention that project names are limited to domain, 64 characters,
and utf8 support depends on the given backend.

Change-Id: Idc266d693c9e81d2bc9b51f20ad5f1282bda5721
Closes-Bug: 1631517
2016-10-12 15:30:04 +00:00
Steve Martinelli
abe6157e5a [api] remove user_id and project_id from policy
There is no user ID and project ID support for the /v3/policy
APIs. The schema [1] validates this.

[1] https://github.com/openstack/keystone/blob/master/keystone/policy/schema.py

Change-Id: I53197412c60513756bce42089f5e959d6c9a7c34
Closes-Bug: #1448602
2016-10-11 15:50:02 -04:00
tengqm
a20d66c1b0 Tweak api-ref for v3 groups status codes
This patch changes the representation of response codes using tables.
Some error codes that are never returned from keystone are removed.
For example, 503 service unavailable is never returned from keystone.

Change-Id: I5e1e0ea1dab7dcb229bce44199f57a9a3bd45ae8
2016-09-29 10:06:21 -04:00
Jenkins
fb6ff30009 Merge "Reorder APIs in api-ref doc for v3 users" 2016-09-28 11:32:27 +00:00
tengqm
abab343921 Reorder APIs in api-ref doc for v3 users
This patch reorders the APIs listed in the api-ref doc for v3 users so
that we have APIs documented in the following order:

- list users
- create user
- show user
- update user
- delete user
- list user groups
- list user projects
- change passwd

The rationale behind the change is that we want the order of API docs
for all resources to be consistent and easy to navigate. This patch
reorders the users APIs so that:

- Plural form of resources comes always come before singlar form because
  it has a unique URI;
- APIs about a specific resource (usually with an ID) are documented
  in the order of CRUD (create, retrieve, update and delete);
- All other helper APIs are documented at the end and they are grouped
  based on resource URIs when appropriate.

Change-Id: Ie594a45a51064a5f9089e2663bd970f10707ffaa
2016-09-27 21:35:38 -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
Jenkins
0da99e272c Merge "Tweak status code in api-ref doc for v3 users" 2016-09-22 06:49:10 +00:00
tengqm
3d00a20893 Tweak status code in api-ref doc for v3 users
This patch reformats the status code section to use tables.

Change-Id: I4e27f20dbb0d673f9ce12cf59a259c9fa14d1f05
2016-09-21 01:30:55 -04:00
Ha Van Tu
5fc08a7fce Fix prameters names in Keystone API v2-ext
Change-Id: Ie1d7b9eea14f331f6a51ae54e8792422660b9b1c
2016-09-20 17:34:50 +07: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
Jenkins
ab09cc3f3f Merge "Tweak api-ref doc for services/endpoints" 2016-09-15 12:44:09 +00:00
Jenkins
ed34b53f18 Merge "Fix prameters name and response codes in Keystone API v2" 2016-09-13 03:25:14 +00:00
Nguyen Phuong An
36d7be0e79 Fix prameters name and response codes in Keystone API v2
This patch fixes parameters name and response codes in Keystone
API v2.

Change-Id: I0b81389ee43e588c5a37d7470763d7ecf853fbd3
2016-09-13 08:54:20 +07:00
tengqm
4d4faabf14 Tweak api-ref doc for services/endpoints
This patch reorders the sections about services and endpoints which were
previously interleaved randomly. After the reordering, all services APIs
appear before all endpoint APIs so browsing through the APIs would be
much easier. This patch aslo changes the representations of status codes
using the new stanza in os-api-ref.

Change-Id: I89aabd3d9a336f5f6f65aaca51353f2d23b4cb2a
2016-09-12 21:14:11 -04:00
Dave Chen
d907ad3b6f Remove the APIs from doc that is not supported yet
The support of updating project or deleting project cascadely has
not yet implemented in the controller [1] and no routed is defined
yet for this feature.

So, remove they from the public doc and can be added back when this
feature is fully implemented in order not to mislead readers.

[1] https://review.openstack.org/#/c/243585/

bp project-tree-deletion

Change-Id: I22b2cb41d44975bca6bc96ba2e3daa61d5029cce
2016-09-12 16:10:28 +00:00
tengqm
830b01fb3c Tweak api-ref doc for projects
This patch adds the status code table into the api-ref doc for projects.
It brings in a 'status.yaml' file that could be shared by other *.inc
files.

Change-Id: Ic536a4dd686cf9bde70b91f5575e8f3053fd1295
2016-09-10 20:59:47 -04: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
Jenkins
59f379896e Merge "[api-ref] Correcting parameter's type" 2016-09-07 17:04:04 +00:00
Jenkins
cc912af562 Merge "[api-ref] Stop supporting os-api-ref 1.0.0" 2016-09-07 06:20:24 +00:00
Ha Van Tu
fb7be8ccd0 [api-ref] Stop supporting os-api-ref 1.0.0
The os-api-ref 1.0.0 is out. We can remove the support to older version
now.
Reference:
https://github.com/openstack/senlin/commit/
6d41feb58dd836d426c9b6f025846dbbf7295097
https://review.openstack.org/#/c/362170/

Change-Id: Ibdd4547d5cf90b31ddff0b548e649d46286cf70e
2016-09-07 11:55:14 +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
Ha Van Tu
602cc57c07 Correct link type
In some tables [1], link parameter's type is wrong. This patch
change these parameters from 'string' to 'object'.

[1]
http://developer.openstack.org/api-ref/identity/v3/#list-users
http://developer.openstack.org/api-ref/identity/v3/#list-groups
http://developer.openstack.org/api-ref/identity/v3/#list-projects

Change-Id: I32916b4f3703b1411ddb1e643dd5f2b27fa6af99
2016-09-06 10:08:18 +07:00
tengqm
fbe462f031 Fix problems in service api doc
This patch fixes the following problems found in the api doc:

- The 'service_id' field should not appear in a service create request;
- The 'enabled', 'description' fields should be optional when doing a
  service update.

Change-Id: Iac91a9f2d29a458f1e3eb93e64fea6a508b9980c
2016-09-05 09:14:25 -04:00
Jenkins
49761bdef2 Merge "Add documentation on how to set a user's tenant." 2016-09-01 03:21:02 +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
Ha Van Tu
2b6d04b77f Config logABug feature for Keystone api-ref
Currently, Keystone api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to
"bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/keystone/"

Change-Id: I8d6fc4d2a6ab9d7f444a02cbc2f756fdaa3de264
2016-08-31 14:15:46 +07:00
Jenkins
f30d529e53 Merge "Fix wrong response codes in 'groups' APIs." 2016-08-29 21:03:36 +00:00
Anh Tran
c81b3374df Fix wrong response codes in 'groups' APIs.
Change-Id: I2cd3970d9eac00d9d832f97d44f0750671ecb131
2016-08-29 18:19:08 +00:00
Jenkins
618a2f5fb4 Merge "api-ref: Splitting status lines in API v3-ext." 2016-08-29 15:40:56 +00:00
Jenkins
af4b4ba116 Merge "api-ref: Splitting status lines in API v3." 2016-08-29 15:29:34 +00:00
Jenkins
3139d31126 Merge "Add Response Example for 'Passwd auth with unscoped authorization'" 2016-08-29 15:29:26 +00:00