Fix up the api-ref for role query paramaters

Closes-Bug: 1597024
Partial-bug: 1602854
Change-Id: I6d763e7f5af86a103da2da3644f3c1303f443e1f
This commit is contained in:
Henry Nash 2016-07-14 22:40:38 +01:00 committed by Steve Martinelli
parent 22ab8a8046
commit 4979fbc0bf
2 changed files with 72 additions and 8 deletions

View File

@ -112,6 +112,13 @@ domain_id_7:
in: query
required: false
type: string
effective_query:
description: |
Returns the effective assignments, including any assignments gained by
virtue of group membership.
in: query
required: false
type: key-only (no value required)
enabled_11:
description: |
Filters the response by either enabled (``true``)
@ -141,6 +148,31 @@ enabled_9:
in: query
required: false
type: string
group_id_query:
description: |
Filters the response by a group ID.
in: query
required: false
type: string
include_names_query:
description: |
If set to true, then the names of any entities returned will be include as
well as their IDs. Any value other than ``0`` (including no value) will be
interpreted as true.
in: query
required: false
type: boolean
min_version: 3.6
include_subtree_query:
description: |
If set to true, then relevant assignments in the project hierarchy below
the project specified in the ``scope.project_id`` query parameter are also
included in the response. Any value other than ``0`` (including no value)
for ``include_subtree`` will be interpreted as true.
in: query
required: false
type: boolean
min_version: 3.6
interface_2:
description: |
Filters the response by an interface.
@ -159,12 +191,6 @@ name_13:
in: query
required: false
type: string
name_14:
description: |
Filters the response by a role name.
in: query
required: false
type: string
name_16:
description: |
Filters the response by a user name.
@ -191,6 +217,30 @@ parent_region_id_1:
in: query
required: false
type: string
role_id_query:
description: |
Filters the response by a role ID.
in: query
required: false
type: string
role_name_query:
description: |
Filters the response by a role name.
in: query
required: false
type: string
scope_domain_id_query:
description: |
Filters the response by a domain ID.
in: query
required: false
type: string
scope_project_id_query:
description: |
Filters the response by a project ID.
in: query
required: false
type: string
service_id_3:
description: |
Filters the response by a service ID.
@ -212,7 +262,7 @@ type_5:
in: query
required: false
type: string
user_id_3:
user_id_query:
description: |
Filters the response by a user ID.
in: query

View File

@ -368,7 +368,7 @@ Request
.. rest_parameters:: parameters.yaml
- name: name
- name: role_name_query
Response Parameters
-------------------
@ -492,6 +492,20 @@ Lists role assignments.
Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503
Request
-------
.. rest_parameters:: parameters.yaml
- effective: effective_query
- include_names: include_names_query
- include_subtree: include_subtree_query
- group.id: group_id_query
- role.id: role_id_query
- scope.domain.id: scope_domain_id_query
- scope.project.id: scope_project_id_query
- user.id: user_id_query
Response Parameters
-------------------