openstack/keystone
Code Issues Proposed changes

Merge "Fix prameters names in Keystone API v2-ext"

Browse Source
This commit is contained in:
Jenkins 2016-09-20 17:40:13 +00:00 committed by Gerrit Code Review
commit 0ec3b88a31
4 changed files with 183 additions and 183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
api-ref/source/v2-ext/ksadm-admin.inc
View File

@ -11,7 +11,7 @@ roles, and services. Requires administrator privileges.
Enable (Disable) user
=====================
.. rest_method:: PUT /v2.0/users/{userId}/OS-KSADM/enabled
.. rest_method:: PUT /v2.0/users/{user_id}/OS-KSADM/enabled
Enables or disables a user.
@ -23,8 +23,8 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- enabled: enabled_user
- user_id: user_id_path
- enabled: user_enabled
Request Example
---------------
@ -37,11 +37,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- email: email
- enabled: enabled
- id: id
- name: name
- username: username
- user: user
- email: user_email
- enabled: user_enabled
- id: user_id_response
- name: user_name
- username: user_name
- tenantId: tenant_id_response
Response Example
----------------
@ -53,7 +55,7 @@ Response Example
Set user password
=================
.. rest_method:: PUT /v2.0/users/{userId}/OS-KSADM/password
.. rest_method:: PUT /v2.0/users/{user_id}/OS-KSADM/password
Sets a user's password
@ -65,8 +67,8 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- password: new_password
- user_id: user_id_path
- password: user_new_password
Request Example
---------------
@ -79,11 +81,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- enabled: enabled
- email: email
- name: name
- id: id
- username: username
- user: user
- enabled: user_enabled
- email: user_email
- name: user_name
- username: user_name
- id: user_id_response
- tenantId: tenant_id_response
Response Example
----------------
@ -95,7 +99,7 @@ Response Example
Update user tenant
==================
.. rest_method:: PUT /v2.0/users/{userId}/OS-KSADM/tenant
.. rest_method:: PUT /v2.0/users/{user_id}/OS-KSADM/tenant
Sets a user's tenant
@ -108,8 +112,8 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- tenantId: tenantId
- user_id: user_id_path
- tenantId: tenant_id_request
Request Example
---------------
@ -122,12 +126,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- email: email
- enabled: enabled
- tenantId: tenantId
- id: id
- name: name
- username: username
- user: user
- email: user_email
- enabled: user_enabled
- tenant: tenant_id_response
- id: user_id_response
- name: user_name
- username: user_name
- tenantId: tenant_id_response
Response Example
----------------
@ -158,10 +164,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- Location: Location
- type: type
- description: description
- name: name
- id: id
- type: service_type
- description: service_description
- name: service_name
- id: service_id
List services (admin extension)
@ -179,10 +185,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- type: type
- description: description
- name: name
- id: id
- type: service_type
- description: service_description
- name: service_name
- id: service_id
Response Example
----------------
@ -194,7 +200,7 @@ Response Example
Shows service information by ID
===============================
.. rest_method:: GET /v2.0/OS-KSADM/services/{serviceId}
.. rest_method:: GET /v2.0/OS-KSADM/services/{service_id}
Shows information for a service, by ID.
@ -206,17 +212,17 @@ Request
.. rest_parameters:: parameters.yaml
- serviceId: serviceId
- service_id: service_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- type: type
- description: description
- name: name
- id: id
- type: service_type
- description: service_description
- name: service_name
- id: service_id
Response Example
----------------
@ -240,10 +246,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- type: type
- description: description
- name: name
- id: id
- type: service_type
- description: service_description
- name: service_name
- id: service_id
Response Example
----------------
@ -255,7 +261,7 @@ Response Example
Delete service (admin extension)
================================
.. rest_method:: DELETE /v2.0/OS-KSADM/services/{serviceId}
.. rest_method:: DELETE /v2.0/OS-KSADM/services/{service_id}
Deletes a service.
@ -267,7 +273,7 @@ Request
.. rest_parameters:: parameters.yaml
- serviceId: serviceId
- service_id: service_id_path
Create a role
@ -309,11 +315,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- roles_links: roles_links
- role_links: role_links
- roles: roles
- description: description
- name: name
- id: id
- description: role_description
- name: role_name
- id: role_id
Response Example
----------------
@ -325,7 +331,7 @@ Response Example
Show a role
===========
.. rest_method:: GET /v2.0/OS-KSADM/roles/{roleId}
.. rest_method:: GET /v2.0/OS-KSADM/roles/{role_id}
Shows details for a role.
@ -337,7 +343,7 @@ Request
.. rest_parameters:: parameters.yaml
- roleId: roleId
- role_id: role_id_path
Response Parameters
-------------------
@ -345,9 +351,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- Location: Location
- description: description
- name: name
- id: id
- description: role_description
- name: role_name
- id: role_id
Response Example
----------------
@ -372,9 +378,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- Location: Location
- description: description
- name: name
- id: id
- description: role_description
- name: role_name
- id: role_id
Response Example
----------------
@ -386,7 +392,7 @@ Response Example
Delete a role
=============
.. rest_method:: DELETE /v2.0/OS-KSADM/roles/{roleId}
.. rest_method:: DELETE /v2.0/OS-KSADM/roles/{role_id}
Deletes a role.
@ -398,13 +404,13 @@ Request
.. rest_parameters:: parameters.yaml
- roleId: roleId
- role_id: role_id_path
Grant roles to user on tenant
=============================
.. rest_method:: PUT /v2.0/tenants/{tenantId}/users/{userId}/roles/OS-KSADM/{roleId}
.. rest_method:: PUT /v2.0/tenants/{tenant_id}/users/{user_id}/roles/OS-KSADM/{role_id}
Grants a role to a user for a tenant.
@ -416,15 +422,15 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- roleId: roleId
- tenantId: tenantId
- user_id: user_id_path
- role_id: role_id_path
- tenant_id: tenant_id_path
Revoke role from user on tenant
===============================
.. rest_method:: DELETE /v2.0/tenants/{tenantId}/users/{userId}/roles/OS-KSADM/{roleId}
.. rest_method:: DELETE /v2.0/tenants/{tenant_id}/users/{user_id}/roles/OS-KSADM/{role_id}
Revokes a role from a user for a tenant.
@ -436,6 +442,6 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- roleId: roleId
- tenantId: tenantId
- user_id: user_id_path
- role_id: role_id_path
- tenant_id: tenant_id_path

6
api-ref/source/v2-ext/kscrud.inc
View File

@ -20,7 +20,7 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- userId: user_id_path
- user: user
- original_password: original_password
- password: new_password
- original_password: user_original_password
- password: user_new_password

2
api-ref/source/v2-ext/ksec2-admin.inc
View File

@ -113,7 +113,7 @@ Request
.. rest_parameters:: parameters.yaml
- type: type
- type: credential_type
Response Example
----------------

218
api-ref/source/v2-ext/parameters.yaml
View File

@ -4,40 +4,33 @@ Location:
in: header
required: false
type: string
Location_1:
description: |
The location.
format: uri
in: header
required: false
type: string
# variables in path
roleId:
credential_type:
description: |
The credential type.
in: path
required: true
type: string
role_id_path:
description: |
The role ID.
in: path
required: true
type: string
serviceId:
service_id_path:
description: |
The service ID.
in: path
required: true
type: string
tenantId:
tenant_id_path:
description: |
The tenant ID.
in: path
required: true
type: string
type_1:
description: |
The credential type.
in: path
required: false
type: string
userId:
user_id_path:
description: |
The user ID.
in: path
@ -47,125 +40,94 @@ userId:
# variables in query
# variables in body
description:
description: |
Description about the service.
in: body
required: true
type: string
description_1:
description: |
Description about the tenant.
in: body
required: true
type: string
description_2:
role_description:
description: |
The role description.
in: body
required: true
type: string
email:
description: |
The user email.
in: body
required: true
type: string
enabled:
description: |
Indicates whether the tenant is enabled or
disabled. Default is ``true``.
in: body
required: true
type: boolean
enabled_user:
description: |
Indicates whether the user should be enabled (``true``)
or disabled(``false``).
in: body
required: true
type: boolean
id:
description: |
The UUID of the service.
in: body
required: true
type: string
id_1:
description: |
The tenant ID.
in: body
required: true
type: string
id_2:
description: |
The user ID.
in: body
required: true
type: string
id_3:
role_id:
description: |
The role ID.
in: body
required: true
type: integer
name:
role_links:
description: |
The service name.
Role links.
in: body
required: true
type: string
name_1:
description: |
The tenant name.
in: body
required: true
type: string
name_2:
description: |
The user name.
in: body
required: true
type: string
name_3:
type: object
role_name:
description: |
The role name.
in: body
required: true
type: string
new_password:
description: |
User's new password
in: body
required: true
type: string
original_password:
description: |
User's old password
in: body
required: true
type: string
roles:
description: |
A ``roles`` object.
in: body
required: true
type: string
roles_links:
service_description:
description: |
Role links.
Description about the service.
in: body
required: true
type: object
type: string
service_id:
description: |
The ID of the service.
in: body
required: true
type: string
service_name:
description: |
The service name.
in: body
required: true
type: string
service_type:
description: |
The type of the service.
in: body
required: true
type: string
tenant:
description: |
The tenant object.
in: body
required: true
type: string
type:
type: object
tenant_description:
description: |
The type of the service.
Description about the tenant.
in: body
required: true
type: string
tenant_enabled:
description: |
Indicates whether the tenant is enabled or
disabled. Default is ``true``.
in: body
required: true
type: boolean
tenant_id_request:
description: |
The tenant ID.
in: body
required: true
type: string
tenant_id_response:
description: |
The tenant ID.
in: body
required: true
type: string
tenant_name:
description: |
The tenant name.
in: body
required: true
type: string
@ -175,11 +137,48 @@ user:
in: body
required: true
type: string
username:
user_email:
description: |
The user name.
The user email.
in: body
required: false
required: true
type: string
user_enabled:
description: |
Indicates whether the user should be enabled (``true``)
or disabled(``false``).
in: body
required: true
type: boolean
user_id_response:
description: |
The user ID.
in: body
required: true
type: string
user_links:
description: |
The links of ``users`` object.
in: body
required: true
type: array
user_name:
description: |
The user in-real-life name.
in: body
required: true
type: string
user_new_password:
description: |
User's new password
in: body
required: true
type: string
user_original_password:
description: |
User's old password
in: body
required: true
type: string
users:
description: |
@ -187,9 +186,4 @@ users:
in: body
required: true
type: array
users_links:
description: |
The links of ``users`` object.
in: body
required: true
type: array