api-ref: Add missing parameter tables to tenant

This adds response tables to multiple tenant API calls within
the identity admin API.

Change-Id: I78ff3d981ed0a1d4dc42d0a81b0369e7275d4d85
Closes-Bug: #1572168
This commit is contained in:
Gage Hugo 2016-08-09 10:37:31 -05:00
parent d082fb29ce
commit 6db31c8590
2 changed files with 64 additions and 1 deletions

View File

@ -22,6 +22,17 @@ Request
- tenantId: tenantId - tenantId: tenantId
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- tenant: tenant
- enabled: enabled
- description: description
- name: name
- id: id
Response Example Response Example
---------------- ----------------
@ -46,6 +57,18 @@ Request
- tenantId: tenantId - tenantId: tenantId
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- users_link: users_link
- users: users
- enabled: enabled
- username: username
- email: email
- id: id
Response Example Response Example
---------------- ----------------
@ -99,6 +122,18 @@ Lists all tenants.
Normal response codes: 200,203 Normal response codes: 200,203
Error response codes: 413,405,404,403,401,400,503 Error response codes: 413,405,404,403,401,400,503
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- tenant_links: tenant_links
- tenants: tenants
- enabled: enabled
- description: description
- name: name
- id: id
Response Example Response Example
---------------- ----------------
@ -123,6 +158,17 @@ Request
- name: name - name: name
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- tenant: tenant
- enabled: enabled
- description: description
- name: name
- id: id
Response Example Response Example
---------------- ----------------

View File

@ -206,12 +206,24 @@ tenant:
in: body in: body
required: true required: true
type: string type: string
tenant_links:
description: |
The link to the represented tenant collection.
in: body
required: true
type: array
tenantId: tenantId:
description: | description: |
The tenant ID. The tenant ID.
in: body in: body
required: false required: false
type: string type: string
tenants:
description: |
The collection of tenants.
in: body
required: true
type: array
token: token:
description: | description: |
A ``token`` object. A ``token`` object.
@ -267,4 +279,9 @@ users:
in: body in: body
required: true required: true
type: array type: array
users_link:
description: |
The link to the reporesented user collection.
in: body
required: true
type: array