Commit Graph

45 Commits

Author SHA1 Message Date
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
Samuel Pilla
c90db0375e Renaming of api parameters
Some parameters of similar name would follow the convention
such as `region_id` and `region_id_1` which gave no good
information as to the differences.

This patch changes these names to help give such information.

Change-Id: I2dec61ed06042990ff54e86c02dc3fca9d566366
2017-02-03 15:23:40 -06:00
“Richard
19c6530b1a Add queries for federated attributes in list_users
This patch adds filters to list_user that enable the user to query for
unique_id, idp_id, protocol_id, or a mix of these to get back the
corresponding users of the federated attributes.

Partially-Implements: bp support-federated-attr
Change-Id: Iea5681791e521e9b8d96137fe30c388c10a02b30
2017-01-23 22:25:52 +00: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
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 c2a3ec27e3.

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
jolie
48841fdeaa Fix typo in api-ref doc
Change-Id: I67c390d20bbdc016c44b4c9cd187f5ddde649768
2016-12-09 16:18:55 +08:00
Jamie Lennox
fcebc2fa8d Allow fetching an expired token
A service user from auth_token middleware should be able to fetch a
token that has expired within a certain window so that long running
operations can finish.

Implements bp: allow-expired
Change-Id: I784f719be88481048f5aa7a79d34a54907438cf3
2016-11-28 04:07:26 +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
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
026b94ea9a Merge "api-ref: Document domain specific roles" 2016-08-18 03:34:47 +00:00
Anh Tran
b6744a6412 api-ref: Fix parameters attributes
Changing 'required' of parameters 'in path' to 'true'.

Change-Id: Ib1e46914045ea9dc7b65b7a209f0fe55cac03b5f
2016-08-17 10:46:23 +07:00
Tin Lam
251cf107f2 api-ref: Document domain specific roles
Add domain_id parameter to the /roles API documentation,
and example request and response json's.

Change-Id: I213883b8402b518e041542ae1c3c169612a096c5
Closes-Bug: #1609171
2016-08-16 14:49:19 -05:00
Tin Lam
3b86db443c api-ref: Document implied roles API
Add documentation for implied roles.

Change-Id: I9fe9123acc8a83379c8dbe02a8fe517add0d8c67
Closes-Bug: #1609164
2016-08-15 15:26:05 -05:00
Anh Tran
729c989c3e api-ref: Correcting V3 OS-INHERIT APIs
Correcting all parameters of OS-INHERIT APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html#os-inherit-api
Finish on V3 APIs.

Change-Id: I670130a2f874e1921ecdc8c06d756ece79505d50
Partial-Bug: #1610777
2016-08-15 08:47:33 +07:00
liyingjun
b9c671718d Document get auth/catalog,projects,domains
This patch adds GET /auth/catalog, GET /auth/projects and GET /auth/domains
to the API site.

Change-Id: Ifda4676680bb9759348bbf7f3353741c45308b8c
Closes-bug: #1609178
2016-08-11 15:36:27 +08:00
Anh Tran
9241aeb485 api-ref: Correcting V3 Credentials APIs
Correcting all parameters of Credentials APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html#credentials
Rename parameters for more easy to maintain.

Change-Id: I811558a646d41d2594777b4601fa223d13e193e7
Partial-Bug: #1610777
2016-08-11 08:38:19 +07:00
Anh Tran
ceaa09dcd7 api-ref: Correcting V3 Policies APIs
Fixed in Create/List/Show/Update APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html#policies

Change-Id: Ia3e4caf80c783ac2213444e9d6fecf39018187d8
Partial-Bug: #1610777
2016-08-11 08:35:26 +07:00
Anh Tran
b3c838153f api-ref: Correcting V3 Authentication APIs
http://developer.openstack.org/api-ref/identity/v3/index.html#authentication-and-token-management

Change-Id: I17a3a974c36c0992c681100833f0443963edbf69
Partial-Bug: #1610777
2016-08-11 08:29:42 +07:00
Anh Tran
8d5926a962 api-ref: Correcting V3 Domain config APIs
Correcting parameters of APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html#domain-configuration

Change-Id: Ia36dd13f813d3cf718a1d3bf9a7f4be482a1ce0a
Partial-Bug: #1610777
2016-08-11 08:23:35 +07:00
Jenkins
93248d23a1 Merge "api-ref: Correcting V3 Endpoints APIs" 2016-08-10 22:14:22 +00:00
Tin Lam
5740a320f8 api-ref: Add query options to GET /projects API documentation
Add the following query options to the api-ref:

* parents_as_list (key-only, no value expected)
* subtree_as_list (key-only, no value expected)
* parents_as_ids (key-only, no value expected)
* subtree_as_ids (key-only, no value expected)

Change-Id: Ie9362885d57112c81c7141c4238e9e3d5d3e0431
Closes-Bug: #1609175
2016-08-10 12:32:31 +00:00
Anh Tran
6919253c8f api-ref: Correcting V3 Endpoints APIs
Correcting all parameters of Show/Create/List/Update/Delete APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html?#show-endpoint-details

Change-Id: Iea796c4cd475bd0bb2879f4810abf9a645ff58ea
Partial-Bug: #1610777
2016-08-09 14:17:00 +07:00
Anh Tran
9a520bcfa8 api-ref: Correcting V3 Services APIs
Correcting all parameters of services APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html?expanded=#list-services
Rename parameters for more easy to maintain.

Change-Id: I9819c19032c93bab9a613bf94b4b95dda722ced9
Partial-Bug: #1610777
2016-08-09 14:17:00 +07:00
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
Jenkins
a1ba4a22f6 Merge "PCI-DSS Adds password_expires_at to API docs" 2016-07-22 23:17:17 +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
f854241d0f Merge "password is not required for updating a user" 2016-07-21 17:48:25 +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
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
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
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
0223d9a398 Fix up numerous errors in params in api-ref for roles
Change-Id: I1bd6fea18f92a914270b7d6f1a3f2462fc235b04
2016-07-16 03:35:09 +00:00
Henry Nash
4979fbc0bf Fix up the api-ref for role query paramaters
Closes-Bug: 1597024
Partial-bug: 1602854
Change-Id: I6d763e7f5af86a103da2da3644f3c1303f443e1f
2016-07-16 03:31:54 +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
Steve Martinelli
e55dfe490c move OAUTH1 API to extensions
as part of the move, also make the extension names consistent

Change-Id: I779b948a3ba63c95bb1c4650bc76c7259f0828fe
2016-07-04 14:04:51 -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