openstack/manila
Code Issues Proposed changes
3abfbef591
manila/api-ref/source/share-metadata.inc

186 lines
2.8 KiB
PHP
Raw Normal View History

Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
.. -*- rst -*-
==============
Share metadata
==============
Shows, sets, updates, and unsets share metadata.
Show share metadata
===================
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/metadata
Shows the metadata for a share.
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-22 18:38:36 +08:00
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Request
-------
.. rest_parameters:: parameters.yaml
- share_id: share_id
[Api-ref] Delete the duplicate tenant arguments in parameters.yaml In the parameters.yaml file, the description of tenant_id_path is the same as tenant_id_1, so delete the parameter tenant_id_1. Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
2017-09-04 14:27:23 +08:00
- tenant_id: tenant_id_path
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- metadata: metadata_3
Response example
----------------
.. literalinclude:: samples/share-show-metadata-response.json
:language: javascript
Set share metadata
==================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/metadata
Sets the metadata on a share.
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-22 18:38:36 +08:00
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Request
-------
.. rest_parameters:: parameters.yaml
- metadata: metadata_2
- share_id: share_id
[Api-ref] Delete the duplicate tenant arguments in parameters.yaml In the parameters.yaml file, the description of tenant_id_path is the same as tenant_id_1, so delete the parameter tenant_id_1. Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
2017-09-04 14:27:23 +08:00
- tenant_id: tenant_id_path
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Request example
---------------
.. literalinclude:: samples/share-set-metadata-request.json
:language: javascript
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- metadata: metadata
Response example
----------------
.. literalinclude:: samples/share-set-metadata-response.json
:language: javascript
Update share metadata
=====================
.. rest_method:: PUT /v2/{tenant_id}/shares/{share_id}/metadata
Updates the metadata for a share.
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-22 18:38:36 +08:00
Response codes
--------------
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-22 18:38:36 +08:00
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Request
-------
.. rest_parameters:: parameters.yaml
- metadata: metadata_2
- share_id: share_id
[Api-ref] Delete the duplicate tenant arguments in parameters.yaml In the parameters.yaml file, the description of tenant_id_path is the same as tenant_id_1, so delete the parameter tenant_id_1. Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
2017-09-04 14:27:23 +08:00
- tenant_id: tenant_id_path
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Request example
---------------
.. literalinclude:: samples/share-update-metadata-request.json
:language: javascript
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- metadata: metadata_3
Response example
----------------
.. literalinclude:: samples/share-update-metadata-response.json
:language: javascript
Unset share metadata
====================
.. rest_method:: DELETE /v2/{tenant_id}/shares/{share_id}/metadata/{key}
Un-sets the metadata on a share.
To unset a metadata key value, specify only the key name in the
URI.
Use rest_status_code for api-ref response codes Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-22 18:38:36 +08:00
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
Request
-------
.. rest_parameters:: parameters.yaml
- share_id: share_id
[Api-ref] Delete the duplicate tenant arguments in parameters.yaml In the parameters.yaml file, the description of tenant_id_path is the same as tenant_id_1, so delete the parameter tenant_id_1. Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
2017-09-04 14:27:23 +08:00
- tenant_id: tenant_id_path
[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
2017-01-22 12:44:25 -05:00
- key: metadata_key_request
Copy Permalink