api-ref cleanup: required flag for tenants

Current url scheme doesn't allow to skip admin_tenant_id
or tenant_id params. This change marks them as required
in api-ref. Get default quotas for a project signature
was changed on correct also.

Partial-Bug: #1415214

Change-Id: I0c528d1c49346477b608a12f8f35ee6d47404bd3
This commit is contained in:
Andrey Volkov
2016-12-02 12:17:08 +03:00
parent 07857fb572
commit 8235e6e1e2
4 changed files with 24 additions and 10 deletions

View File

@@ -11,7 +11,7 @@ admin_tenant_id:
description: | description: |
The UUID of the administrative tenant. The UUID of the administrative tenant.
in: path in: path
required: false required: true
type: string type: string
backup_id: backup_id:
description: | description: |
@@ -83,6 +83,12 @@ qos_id:
in: path in: path
required: false required: false
type: string type: string
quotas_tenant_id:
description: |
The UUID of the tenant in a multi-tenancy cloud.
in: path
required: true
type: string
snapshot_id_1: snapshot_id_1:
description: | description: |
The UUID of the snapshot. The UUID of the snapshot.

View File

@@ -24,7 +24,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id - tenant_id: quotas_tenant_id
- admin_tenant_id: admin_tenant_id - admin_tenant_id: admin_tenant_id
- usage: usage - usage: usage
@@ -91,7 +91,7 @@ Request
- fixed_ips: fixed_ips - fixed_ips: fixed_ips
- id: id - id: id
- security_groups: security_groups - security_groups: security_groups
- tenant_id: tenant_id - tenant_id: quotas_tenant_id
- admin_tenant_id: admin_tenant_id - admin_tenant_id: admin_tenant_id
Request Example Request Example
@@ -146,7 +146,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id - tenant_id: quotas_tenant_id
- admin_tenant_id: admin_tenant_id - admin_tenant_id: admin_tenant_id
Response Example Response Example
@@ -158,7 +158,7 @@ Response Example
Get default quotas Get default quotas
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/{tenant_id}/os-quota-sets/defaults .. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/defaults
Gets default quotas for a tenant. Gets default quotas for a tenant.
@@ -173,6 +173,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id - tenant_id: tenant_id
- admin_tenant_id: admin_tenant_id
Response Parameters Response Parameters

View File

@@ -11,7 +11,7 @@ admin_project_id:
description: | description: |
The UUID of the administrative project. The UUID of the administrative project.
in: path in: path
required: false required: true
type: string type: string
all_tenants: all_tenants:
description: | description: |
@@ -113,6 +113,12 @@ qos_id:
in: path in: path
required: false required: false
type: string type: string
quotas_project_id:
description: |
The UUID of the tenant in a multi-tenancy cloud.
in: path
required: true
type: string
resource: resource:
description: | description: |
Filter filters by resource name. Filter filters by resource name.

View File

@@ -25,7 +25,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: quotas_project_id
- admin_project_id: admin_project_id - admin_project_id: admin_project_id
- usage: usage - usage: usage
@@ -92,7 +92,7 @@ Request
- fixed_ips: fixed_ips - fixed_ips: fixed_ips
- id: id - id: id
- security_groups: security_groups - security_groups: security_groups
- project_id: project_id_path - project_id: quotas_project_id
- admin_project_id: admin_project_id - admin_project_id: admin_project_id
Request Example Request Example
@@ -147,7 +147,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: quotas_project_id
- admin_project_id: admin_project_id - admin_project_id: admin_project_id
Response Example Response Example
@@ -160,7 +160,7 @@ Response Example
Get default quotas for a project Get default quotas for a project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/os-quota-sets/defaults .. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/defaults
Gets default quotas for a project. Gets default quotas for a project.
@@ -175,6 +175,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- admin_project_id: admin_project_id
Response Parameters Response Parameters