14 Commits

Author SHA1 Message Date
Suramya Shah
3c7a0f32e1 Re-organize api-ref: v3 inherit.inc
Re-organize as per the documentation session at PTG:
https://etherpad.openstack.org/p/queens-ptg-keystone-docs-cleanup

Change-Id: Ic689e78b88d91f00835361a7061bf3198c567cef
2017-12-30 16:04:16 +05:30
Samuel de Medeiros Queiroz
cc63cb9935 Fix role assignment api-ref docs
The current docs list the available query params wrongly.

[1] https://github.com/openstack/keystone/blob/c025cb3/keystone/assignment/controllers.py#L961-L964

Change-Id: Ia7ec0e9dfaa8a67226a01531ac82b6391a7f3d81
2017-09-11 15:17:56 -03:00
Jenkins
311c779029 Merge "Add notes in inherit.inc" 2017-04-28 18:07:22 +00:00
zlyqqq
2c3a727710 use '&' instead of '?' to connect parameters in url
Change-Id: Ie19026bd0c2df504f5809f315596de42edf2301a
2017-04-28 13:09:23 +08:00
zlyqqq
4d2b936be2 Add notes in inherit.inc
If we assign role to user on projects in a subtree, such as
'PUT /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles
/{role_id}/inherited_to_projects'.
The role assignment is not applied to the project in the request,
and only applied to its subtree projects.

Change-Id: I170227d40a631a1827baa3b334d4c128c9fc2041
2017-04-26 11:33:42 +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
Samuel Pilla
28fd030667 api-ref update for roles assignments with names
Updates the api-ref to reflect that list_role_assignment now also
return the donain id and name for roles.

Related-Bug: #1607114
Change-Id: Ie887907b9410e84b5f3ff958b05b2fd98efbe5aa
2016-12-06 08:00:37 -06:00
Rodrigo Duarte Sousa
24dd02277c Minor fix in role_assignments api-ref
GET /role_assignments do not list the effective role_assignments,
this is done via the "effective" query param as described in the
doc.

For listing role assignments, we also have a similar explanation in
the "roles.inc" doc. After giving some thought, I guess the best option
is to leave both entries. This can sound redundant, but both entries give
pertinent explanation to the doc they are part of. For example, in the
"inherit.inc" doc, we have a introduction to the GET /role_assignments
API and explanations about the "effective", "include_subtree" and
"inherit_to" query parameters, which are essentially part of the
inherited roles feature.

Closes-Bug: 1645554

Change-Id: I38fa771295a1e1f482b10013f922a0bd0e432f8d
2016-12-01 10:02:14 -03: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
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
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
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
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
Clenimar Filemon
ab252d58dc Move OS-INHERIT api-ref from extensions to core
Move inheritance API-ref to main Identity API-ref [1]. The docs need to
be updated, though. I think it's better to move them first, then update to
match keystone-specs docs.

[1] Ia838dff1863b1b77472079b32783ae31557b1ef5

Change-Id: I6a6a59bba9c15ac7678e0b20d248dfb4c03881c7
2016-07-14 14:27:49 -03:00