16 Commits

Author SHA1 Message Date
biwei
68dfd78c35 Api-ref: Correct response code
The response code for PUT /groups/{group_id}/users/{user_id} should be 204, not 200.

Closes-bug: #1784375
Change-Id: I73705131f15dc7df764de21ad116f28e77230b6e
2018-07-30 22:20:31 -04:00
zlyqqq
82a53de9b1 Reorganize api-ref:v3 groups
Change-Id: Ia15643abe0195a0976177937e8a38fa805e317de
2017-12-06 16:43:30 +08: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
Steve Martinelli
b0f9237570 API Documentation for user password expires
New proposal on how we document the password_expires_at query.

bp pci-dss-query-password-expired-users

Co-Authored-By: Samuel Pilla <sp516w@att.com>

Change-Id: I81facd0a84f5c05f72294eb1a143c7632b2406e1
2016-12-12 22:07:03 +00:00
Steve Martinelli
320479647c Revert "API Documentation for user password expires"
This reverts commit c2a3ec27e3882e79c3fdbbed86473c46edabfefc.

Change-Id: Ib55a9595003fa44e45a6b89b7e2b84f08cd67295
2016-12-12 21:04:10 +00:00
Samuel Pilla
1eb38e46e7 API Documentation for user password expires
The api documentation for the following queries:

/v3/users?password_expires_at={operator}:{timestamp}
/v3/groups/{group_id}/users?password_expires_at={operator}:{timestamp}

The acceptable operators are lt, lte, gt, gte, eq, and neq.
They allow for querying for a range of timestamps rather than
an exact time for password expiration.

Examples:
- GET /v3/users?password_expires_at=lt:2016-11-06T15:32:17Z
- GET /v3/groups/079c578fd99b428ab61fcd4c9bd88ecd/users?password_expires_at=gt:2016-12-08T22:02:00Z

Partially-Implements: bp pci-dss-query-password-expired-users
Parent-Id: If0b9cc3c8af92b2ea5d41a0e8afeb78e12b7689c
Change-Id: I737dd6b703cc5af16b3d748ebaeebe0fbada039e
2016-12-10 05:18:18 +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
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
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
Anh Tran
43df6125f9 api-ref: Splitting status lines in API v3.
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.

Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
gage hugo
d36e555788 [api] add relationship links to v3
Nearly all the "relationship" links are missing in v3 APIs.

Added relationship links to v3 API pages.

Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8
Partial-Bug: #1609159
2016-08-11 15:17:59 -05: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
Lance Bragstad
f2911cb6d0 Improve the API documentation for groups
This improves some of the wording used in the groups documentation. It also
moves 20X status codes from the Error response list to the Normal response
list.

Change-Id: I76dce8c532caa9a99757ea850e0305534c9072fe
2016-07-13 17:30:18 +00:00
Steve Martinelli
ebccd23b78 Add missing preamble for v3 and v3-ext
The api-ref site had a short blurb about the resources listed
in the document, add that back.

Change-Id: I2bac40a250a5b73fb70320d598a12c34c359e3c2
2016-07-04 14:35:49 -07:00
Samuel de Medeiros Queiroz
9a5395f1b2 Migrate identity /v3 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 docs
to our repository under 'api-ref/source' directory. In addition, it
added missing descriptions for access_token_id and consumer_id to
'parameters.yaml'.

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.

This change also adds a tox environment to build the docs using sphinx
under 'api-ref/build', which in turn is added to '.gitignore'.

Lastly, 'os-api-ref' is added as a test requirement. It provides the
sphinx stanzas rest_method and rest_parameter, used to define OpenStack
APIs in RST docs.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-24 09:58:23 -03:00