[api-ref] Fix missing parameters in api-ref

The new version of api-ref raises warnings to indicate
missing parameters. Nothing like an amber alert around
feature freeze.

[1] http://lists.openstack.org/pipermail/openstack-dev/2017-January/110606.html

Change-Id: Ieeb018ef4f42ddb8e4271048b385ae679392c59c
Closes-Bug: #1658494
This commit is contained in:
Goutham Pacha Ravi 2017-01-22 12:44:25 -05:00
parent 2fe4fd35ca
commit 6274c20b78
4 changed files with 16 additions and 7 deletions

View File

@ -1821,6 +1821,14 @@ metadata_3:
in: body
required: true
type: object
metadata_key_request:
description: |
The key of a metadata item. For example, if share metadata is
as follows: ``"project": "my_test", "aim": "testing"``, the keys are
"project" and "aim".
in: body
required: false
type: object
migrate-start:
description: |
The ``migrate-start`` object.

View File

@ -25,9 +25,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- pool: backend_pool_query
- host: backend_host_query
- backend: backend_query
- pool_name: backend_pool_query
- host_name: backend_host_query
- backend_name: backend_query
- capabilities: backend_capabilities_query
- share_type: share_type_query
@ -65,9 +65,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- pool: backend_pool_query
- host: backend_host_query
- backend: backend_query
- pool_name: backend_pool_query
- host_name: backend_host_query
- backend_name: backend_query
- capabilities: backend_capabilities_query
- share_type: share_type_query

View File

@ -142,3 +142,4 @@ Request
- share_id: share_id
- tenant_id: tenant_id_1
- key: metadata_key_request

View File

@ -327,7 +327,7 @@ Response example
Unset an extra spec
===================
.. rest_method:: DELETE /v2/{tenant_id}/types/{share_type_id}/extra_specs/{key}
.. rest_method:: DELETE /v2/{tenant_id}/types/{share_type_id}/extra_specs/{extra-spec-key}
Unsets an extra specification for the share type.