[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
This commit is contained in:
Dave Chen 2016-10-17 10:56:12 +08:00
parent ab02ec038c
commit 382279f701
3 changed files with 15 additions and 117 deletions

View File

@ -18,7 +18,7 @@ Assign role to user on projects owned by domain
.. rest_method:: PUT /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/{role_id}/inherited_to_projects .. rest_method:: PUT /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/index.html#assign-role-to-user-owned-by-domain-projects`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_user_role_inherited_to_projects``
Assigns a role to a user in projects owned by a domain. Assigns a role to a user in projects owned by a domain.
@ -43,7 +43,7 @@ Assign role to group on projects owned by a domain
.. rest_method:: PUT /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects .. rest_method:: PUT /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#assign-role-to-group-in-domain-projects`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_group_role_inherited_to_projects``
The inherited role is only applied to the owned projects (both existing and The inherited role is only applied to the owned projects (both existing and
future projects), and will not appear as a role in a domain scoped token. future projects), and will not appear as a role in a domain scoped token.
@ -66,7 +66,7 @@ List user's inherited project roles on a domain
.. rest_method:: GET /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/inherited_to_projects .. rest_method:: GET /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#list-project-roles-for-user-in-domain`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_user_roles_inherited_to_projects``
The list only contains those role assignments to the domain that were specified The list only contains those role assignments to the domain that were specified
as being inherited to projects within that domain. as being inherited to projects within that domain.
@ -94,7 +94,7 @@ List group's inherited project roles on domain
.. rest_method:: GET /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/inherited_to_projects .. rest_method:: GET /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#list-project-roles-for-group-in-domain`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_group_roles_inherited_to_projects``
The list only contains those role assignments to the domain that were specified The list only contains those role assignments to the domain that were specified
as being inherited to projects within that domain. as being inherited to projects within that domain.
@ -122,7 +122,7 @@ Check if user has an inherited project role on domain
.. rest_method:: HEAD /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/{role_id}/inherited_to_projects .. rest_method:: HEAD /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#check-project-role-for-user-in-domain`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_user_role_inherited_to_projects``
Checks whether a user has an inherited project role in a domain. Checks whether a user has an inherited project role in a domain.
@ -144,7 +144,7 @@ Check if group has an inherited project role on domain
.. rest_method:: HEAD /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects .. rest_method:: HEAD /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#check-project-role-for-group-in-domain`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_group_role_inherited_to_projects``
Checks whether a group has an inherited project role in a domain. Checks whether a group has an inherited project role in a domain.
@ -166,7 +166,7 @@ Revoke an inherited project role from user on domain
.. rest_method:: DELETE /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/{role_id}/inherited_to_projects .. rest_method:: DELETE /v3/OS-INHERIT/domains/{domain_id}/users/{user_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#revoke-role-from-user`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_user_role_inherited_to_projects``
Revokes an inherited project role from a user in a domain. Revokes an inherited project role from a user in a domain.
@ -188,7 +188,7 @@ Revoke an inherited project role from group on domain
.. rest_method:: DELETE /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects .. rest_method:: DELETE /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#revoke-project-role-from-group-in-domain`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/domain_group_role_inherited_to_projects``
Revokes an inherited project role from a group in a domain. Revokes an inherited project role from a group in a domain.
@ -210,7 +210,7 @@ Assign role to user on projects in a subtree
.. rest_method:: PUT /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/{role_id}/inherited_to_projects .. rest_method:: PUT /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#assign-role-to-user`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/project_user_role_inherited_to_projects``
The inherited role assignment is anchored to a project and applied to its The inherited role assignment is anchored to a project and applied to its
subtree in the projects hierarchy (both existing and future projects). subtree in the projects hierarchy (both existing and future projects).
@ -237,7 +237,7 @@ Assign role to group on projects in a subtree
.. rest_method:: PUT /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects .. rest_method:: PUT /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#assign-role-to-group`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/project_group_role_inherited_to_projects``
The inherited role assignment is anchored to a project and applied to its The inherited role assignment is anchored to a project and applied to its
subtree in the projects hierarchy (both existing and future projects). subtree in the projects hierarchy (both existing and future projects).
@ -258,69 +258,13 @@ Request
- role_id: role_id_path - role_id: role_id_path
List user's inherited project roles on project
==============================================
.. rest_method:: GET /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/inherited_to_projects
Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#list-inherited-roles-for-user``
The list only contains those roles assigned to this project that were specified
as being inherited to its subtree.
Normal response codes: 200
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- user_id: user_id_path
Response Example
----------------
.. literalinclude:: samples/admin/user-roles-list-response.json
:language: javascript
List group's inherited project roles on project
===============================================
.. rest_method:: GET /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/inherited_to_projects
Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#list-roles-for-group``
The list only contains those roles assigned to this project that were specified
as being inherited to its subtree.
Normal response codes: 200
Request
-------
.. rest_parameters:: parameters.yaml
- group_id: group_id_path
- project_id: project_id_path
Response Example
----------------
.. literalinclude:: samples/admin/group-roles-list-response.json
:language: javascript
Check if user has an inherited project role on project Check if user has an inherited project role on project
====================================================== ======================================================
.. rest_method:: HEAD /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/{role_id}/inherited_to_projects .. rest_method:: HEAD /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#check-role-for-user`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/project_user_role_inherited_to_projects``
Checks whether a user has a role assignment with the ``inherited_to_projects`` flag in a project. Checks whether a user has a role assignment with the ``inherited_to_projects`` flag in a project.
@ -342,7 +286,7 @@ Check if group has an inherited project role on project
.. rest_method:: HEAD /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects .. rest_method:: HEAD /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#check-role-for-group`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/project_group_role_inherited_to_projects``
Checks whether a group has a role assignment with the ``inherited_to_projects`` flag in a project. Checks whether a group has a role assignment with the ``inherited_to_projects`` flag in a project.
@ -364,7 +308,7 @@ Revoke an inherited project role from user on project
.. rest_method:: DELETE /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/{role_id}/inherited_to_projects .. rest_method:: DELETE /v3/OS-INHERIT/projects/{project_id}/users/{user_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#revoke-role-from-user`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/project_user_role_inherited_to_projects``
Normal response codes: 204 Normal response codes: 204
@ -384,7 +328,7 @@ Revoke an inherited project role from group on project
.. rest_method:: DELETE /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects .. rest_method:: DELETE /v3/OS-INHERIT/projects/{project_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#revoke-role-from-group`` ``http://docs.openstack.org/api/openstack-identity/3/ext/OS-INHERIT/1.0/rel/project_group_role_inherited_to_projects``
Normal response codes: 204 Normal response codes: 204
@ -404,7 +348,7 @@ List effective role assignments
.. rest_method:: GET /v3/role_assignments .. rest_method:: GET /v3/role_assignments
Relationship: Relationship:
``http://developer.openstack.org/api-ref/identity/v3/?expanded=#list-effective-role-assignments`` ``http://docs.openstack.org/api/openstack-identity/3/rel/role_assignments``
Optional query parameters: Optional query parameters:

View File

@ -1,23 +0,0 @@
{
"roles": [
{
"id": "91011",
"links": {
"self": "http://example.com/identity/v3/roles/91011"
},
"name": "admin"
},
{
"id": "91011",
"links": {
"self": "http://example.com/identity/v3/roles/91011"
},
"name": "admin"
}
],
"links": {
"self": "http://example.com/identity/v3/OS-INHERIT/projects/1234/groups/5678/roles/inherited_to_projects",
"previous": null,
"next": null
}
}

View File

@ -1,23 +0,0 @@
{
"roles": [
{
"id": "91011",
"links": {
"self": "http://example.com/identity/v3/roles/91011"
},
"name": "admin"
},
{
"id": "91011",
"links": {
"self": "http://example.com/identity/v3/roles/91011"
},
"name": "admin"
}
],
"links": {
"self": "http://example.com/identity/v3/OS-INHERIT/projects/1234/users/5678/roles/inherited_to_projects",
"previous": null,
"next": null
}
}