openstack/keystone
Code Issues Proposed changes

Fix warnings generated by os-api-ref 1.2.0

Browse Source 
This addresses the warnings that os-api-ref 1.2.0 generates about
undocumented parameters.

Change-Id: I921ab1e2a05cd15885f789a4175c70056872f10a
This commit is contained in:
Sean Dague 2017-01-20 12:35:18 -05:00
parent bc8a145de1
commit 73939d90cd
3 changed files with 54 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -246,6 +246,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- serviceName: service_name_path
- type: service_type - type: service_type
- description: service_description - description: service_description
- name: service_name - name: service_name
@ -378,6 +379,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- Location: Location - Location: Location
- role_name: role_name_path
- description: role_description - description: role_description
- name: role_name - name: role_name
- id: role_id - id: role_id

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

@ -18,6 +18,14 @@ Normal response codes: 201
Error response codes: 413,415,405,404,403,401,400,503,409, Error response codes: 413,415,405,404,403,401,400,503,409,
Request
-------
.. rest_parameters:: parameters.yaml
- userId: user_id_path
Request Example Request Example
--------------- ---------------
@ -36,6 +44,14 @@ Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503, Error response codes: 413,405,404,403,401,400,503,
Request
-------
.. rest_parameters:: parameters.yaml
- userId: user_id_path
Response Example Response Example
---------------- ----------------
@ -54,6 +70,14 @@ Normal response codes: 200
Error response codes: 415,405,404,403,401,400,503,409, Error response codes: 415,405,404,403,401,400,503,409,
Request
-------
.. rest_parameters:: parameters.yaml
- userId: user_id_path
Request Example Request Example
--------------- ---------------
@ -79,6 +103,14 @@ Normal response codes: 204
Error response codes: 413,415,405,404,403,401,400,503,409, Error response codes: 413,415,405,404,403,401,400,503,409,
Request
-------
.. rest_parameters:: parameters.yaml
- userId: user_id_path
Get user credentials Get user credentials
==================== ====================
@ -90,6 +122,13 @@ Normal response codes: 200
Error response codes: 413,405,404,403,401,400,503, Error response codes: 413,405,404,403,401,400,503,
Request
-------
.. rest_parameters:: parameters.yaml
- userId: user_id_path
Response Example Response Example
---------------- ----------------
@ -113,6 +152,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- userId: user_id_path
- type: credential_type - type: credential_type
Response Example Response Example

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

@ -18,12 +18,24 @@ role_id_path:
in: path in: path
required: true required: true
type: string type: string
role_name_path:
description: |
The role name.
in: path
required: true
type: string
service_id_path: service_id_path:
description: | description: |
The service ID. The service ID.
in: path in: path
required: true required: true
type: string type: string
service_name_path:
description: |
The service name.
in: path
required: true
type: string
tenant_id_path: tenant_id_path:
description: | description: |
The tenant ID. The tenant ID.
@ -186,4 +198,3 @@ users:
in: body in: body
required: true required: true
type: array type: array