From 6274c20b785686d6340cf88f076db9f47d8e9d3a Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Sun, 22 Jan 2017 12:44:25 -0500 Subject: [PATCH] [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 --- api-ref/source/parameters.yaml | 8 ++++++++ api-ref/source/scheduler-stats.inc | 12 ++++++------ api-ref/source/share-metadata.inc | 1 + api-ref/source/share-types.inc | 2 +- 4 files changed, 16 insertions(+), 7 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index f088117e..4a5282ed 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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. diff --git a/api-ref/source/scheduler-stats.inc b/api-ref/source/scheduler-stats.inc index 61274a9e..03ccbf62 100644 --- a/api-ref/source/scheduler-stats.inc +++ b/api-ref/source/scheduler-stats.inc @@ -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 diff --git a/api-ref/source/share-metadata.inc b/api-ref/source/share-metadata.inc index 0d36732f..626087a4 100644 --- a/api-ref/source/share-metadata.inc +++ b/api-ref/source/share-metadata.inc @@ -142,3 +142,4 @@ Request - share_id: share_id - tenant_id: tenant_id_1 + - key: metadata_key_request diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index 24ed9fde..c5eab7cf 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -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.