Browse Source

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
changes/80/352980/1
Gage Hugo 6 years ago
parent
commit
6db31c8590
  1. 46
      api-ref/source/v2-admin/admin-tenants.inc
  2. 19
      api-ref/source/v2-admin/parameters.yaml

46
api-ref/source/v2-admin/admin-tenants.inc

@ -22,6 +22,17 @@ Request
- tenantId: tenantId
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- tenant: tenant
- enabled: enabled
- description: description
- name: name
- id: id
Response Example
----------------
@ -46,6 +57,18 @@ Request
- tenantId: tenantId
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- users_link: users_link
- users: users
- enabled: enabled
- username: username
- email: email
- id: id
Response Example
----------------
@ -99,6 +122,18 @@ Lists all tenants.
Normal response codes: 200,203
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
----------------
@ -123,6 +158,17 @@ Request
- name: name
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- tenant: tenant
- enabled: enabled
- description: description
- name: name
- id: id
Response Example
----------------

19
api-ref/source/v2-admin/parameters.yaml

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

Loading…
Cancel
Save