[api-ref] Update volume metadata key api

The patch did:
1. Add the missing PUT api-ref for volume metadata key.
2. fix the metadata key api's request and response example.
Correct the "metadata" with "meta".

Change-Id: I315682ef86f660eb468991a336d9edae520a4189
This commit is contained in:
wangxiyuan 2017-04-12 15:47:01 +08:00
parent 1fa43b8f79
commit 2b6bc7d8b8
5 changed files with 69 additions and 2 deletions

View File

@ -101,6 +101,13 @@ key_2:
in: path
required: true
type: string
key_3:
description: |
The metadata key name for the metadata that you
want to update.
in: path
required: true
type: string
project_id_path:
description: |
The UUID of the project in a multi-tenancy cloud.
@ -1122,6 +1129,12 @@ message_level:
in: body
required: true
type: string
meta:
description: |
The metadata key and value pair for the volume.
in: body
required: true
type: object
metadata:
description: |
One or more metadata key and value pairs for the

View File

@ -0,0 +1,5 @@
{
"meta": {
"name": "test"
}
}

View File

@ -0,0 +1,5 @@
{
"meta": {
"name": "new_name"
}
}

View File

@ -0,0 +1,5 @@
{
"meta": {
"name": "new_name"
}
}

View File

@ -623,14 +623,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- metadata: metadata_3
- meta: meta
Response Example
----------------
.. literalinclude:: ./samples/volume-metadata-show-response.json
.. literalinclude:: ./samples/volume-metadata-show-key-response.json
:language: javascript
@ -655,6 +655,45 @@ Request
- key: key_1
Update a volume's metadata for a specific key
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v3/{project_id}/volumes/{volume_id}/metadata/{key}
Update metadata for a volume for a specific key.
Normal response codes: 200
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume_id: volume_id_path
- key: key_3
- meta: meta
Request Example
---------------
.. literalinclude:: ./samples/volume-metadata-update-key-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- meta: meta
Response Example
----------------
.. literalinclude:: ./samples/volume-metadata-update-key-response.json
:language: javascript
Get volumes summary
~~~~~~~~~~~~~~~~~~~