Fix up numerous errors in params in api-ref for roles

Change-Id: I1bd6fea18f92a914270b7d6f1a3f2462fc235b04
This commit is contained in:
Henry Nash 2016-07-15 00:26:33 +01:00 committed by Steve Martinelli
parent 4979fbc0bf
commit 0223d9a398
2 changed files with 134 additions and 68 deletions

View File

@ -41,6 +41,12 @@ domain_id:
in: path
required: true
type: string
domain_id_path:
description: |
The domain ID.
in: path
required: true
type: string
endpoint_id:
description: |
The endpoint ID.
@ -60,6 +66,12 @@ group_id:
in: path
required: true
type: string
group_id_path:
description: |
The group ID.
in: path
required: true
type: string
option:
description: |
The option name. For the ``ldap`` group, a valid
@ -80,6 +92,12 @@ project_id:
in: path
required: true
type: string
project_id_path:
description: |
The project ID.
in: path
required: true
type: string
region_id_2:
description: |
The region ID.
@ -92,6 +110,12 @@ role_id:
in: path
required: true
type: string
role_id_path:
description: |
The role ID.
in: path
required: true
type: string
service_id_2:
description: |
The service ID.
@ -104,6 +128,12 @@ user_id:
in: path
required: true
type: string
user_id_path:
description: |
The user ID.
in: path
required: true
type: string
# variables in query
domain_id_7:
@ -867,6 +897,18 @@ ldap:
in: body
required: true
type: object
link_collection:
description: |
The link to the collection of resources.
in: body
required: true
type: string
link_response_body:
description: |
The link to the resources in question.
in: body
required: true
type: string
links:
description: |
The links for the ``credential`` resource.
@ -1221,19 +1263,43 @@ regions:
type: array
role:
description: |
A ``role`` object.
A ``role`` object, containing:
in: body
required: true
type: object
role_assignments:
description: |
A ``role_assignments`` object.
A list of ``role_assignment`` objects.
in: body
required: true
type: array
role_id_response_body:
description: |
The role ID.
in: body
required: true
type: string
role_name_create_body:
description: |
The role name.
in: body
required: true
type: string
role_name_response_body:
description: |
The role name.
in: body
required: true
type: string
role_name_update_body:
description: |
The new role name.
in: body
required: false
type: string
roles:
description: |
A ``roles`` object.
A list of ``role`` objects, each containing:
in: body
required: true
type: array

View File

@ -93,9 +93,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- project_id: project_id
- group_id: group_id
- project_id: project_id_path
- group_id: group_id_path
- role_id: role_id_path
Check whether group has role assignment on project
@ -113,9 +113,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- project_id: project_id
- group_id: group_id
- project_id: project_id_path
- group_id: group_id_path
- role_id: role_id_path
Unassign role from group on project
@ -133,9 +133,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- project_id: project_id
- group_id: group_id
- project_id: project_id_path
- group_id: group_id_path
- role_id: role_id_path
Assign role to user on project
@ -153,9 +153,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- project_id: project_id
- user_id: user_id
- project_id: project_id_path
- user_id: user_id_path
- role_id: role_id_path
Check whether user has role assignment on project
@ -173,9 +173,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- project_id: project_id
- user_id: user_id
- project_id: project_id_path
- user_id: user_id_path
- role_id: role_id_path
Unassign role from user on project
@ -193,9 +193,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- project_id: project_id
- user_id: user_id
- project_id: project_id_path
- user_id: user_id_path
- role_id: role_id_path
List role assignments for user on project
@ -213,8 +213,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- user_id: user_id
- project_id: project_id_path
- user_id: user_id_path
Response Example
----------------
@ -238,8 +238,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- group_id: group_id
- project_id: project_id_path
- group_id: group_id_path
Response Example
----------------
@ -268,10 +268,9 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- role_id: role_id
- group_id: group_id
- domain_id: domain_id_path
- group_id: group_id_path
- role_id: role_id_path
Check whether group has role assignment on domain
=================================================
@ -288,9 +287,9 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- role_id: role_id
- group_id: group_id
- domain_id: domain_id_path
- group_id: group_id_path
- role_id: role_id_path
Unassign role from group on domain
@ -308,9 +307,9 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- role_id: role_id
- group_id: group_id
- domain_id: domain_id_path
- group_id: group_id_path
- role_id: role_id_path
List role assignments for user on domain
@ -328,8 +327,8 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- user_id: user_id
- domain_id: domain_id_path
- user_id: user_id_path
Response Parameters
-------------------
@ -337,9 +336,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- roles: roles
- id: id
- links: links
- name: name
- id: role_id_response_body
- links: link_response_body
- name: role_name_response_body
Response Example
----------------
@ -375,10 +374,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- links: link_collection
- roles: roles
- id: id
- links: links
- name: name
- id: role_id_response_body
- links: link_response_body
- name: role_name_response_body
Response Example
----------------
@ -403,7 +403,7 @@ Request
.. rest_parameters:: parameters.yaml
- role: role
- name: name
- name: role_name_create_body
Request Example
---------------
@ -417,9 +417,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- role: role
- id: id
- links: links
- name: name
- id: role_id_response_body
- links: link_response_body
- name: role_name_response_body
Assign role to user on domain
@ -437,9 +437,9 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- role_id: role_id
- user_id: user_id
- domain_id: domain_id_path
- user_id: user_id_path
- role_id: role_id_path
Check whether user has role assignment on domain
@ -457,9 +457,9 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- role_id: role_id
- user_id: user_id
- domain_id: domain_id_path
- user_id: user_id_path
- role_id: role_id_path
Unassigns role from user on domain
@ -477,9 +477,9 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- role_id: role_id
- user_id: user_id
- domain_id: domain_id_path
- user_id: user_id_path
- role_id: role_id_path
List role assignments
@ -535,7 +535,7 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- role_id: role_id_path
Response Parameters
-------------------
@ -543,9 +543,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- role: role
- id: id
- links: links
- name: name
- id: role_id_response_body
- links: link_response_body
- name: role_name_response_body
Response Example
----------------
@ -569,9 +569,9 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id_path
- role: role
- name: name
- role_id: role_id
- name: role_name_update_body
Request Example
---------------
@ -585,9 +585,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- role: role
- id: id
- links: links
- name: name
- id: role_id_response_body
- links: link_response_body
- name: role_name_response_body
Response Example
----------------
@ -611,7 +611,7 @@ Request
.. rest_parameters:: parameters.yaml
- role_id: role_id
- role_id: role_id_path
List role assignments for group on domain
@ -629,8 +629,8 @@ Request
.. rest_parameters:: parameters.yaml
- domain_id: domain_id
- group_id: group_id
- domain_id: domain_id_path
- group_id: group_id_path
Response Example
----------------