d7140ffe09
Nowadays "project" and "project_id" are used instead of "tenant" in the OpenStack world. See [1] and [2]. - Replace "tenant_id" in the API paths to "project_id" - For most manila resources, the "project_id" in an API response body refers to the project that owns the resource. So, create a unified parameter and share that across the APIs. - Fix path variable names, and their order - Fix usage of "UUID" to refer to project and user IDs - Fix query parameters [1] https://docs.openstack.org/operations-guide/ops-projects-users.html [2] https://developer.openstack.org/api-ref/identity/v3/index.html#projects Partial-Bug: #1760644 Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com> Change-Id: I64e4ef8ad258d07c7d80d11a4d015c4b82156722
95 lines
1.7 KiB
ReStructuredText
95 lines
1.7 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
============================================
|
|
Share access rule metadata (since API v2.45)
|
|
============================================
|
|
|
|
Updates, and unsets share access rule metadata.
|
|
|
|
Update share access rule metadata
|
|
==================================
|
|
|
|
.. rest_method:: PUT /v2/{project_id}/share-access-rules/{access_id}/metadata
|
|
|
|
.. versionadded:: 2.45
|
|
|
|
Updates the metadata for a share access rule.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- access_id: access_id_path
|
|
- metadata: access_metadata
|
|
|
|
Request example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/share-access-rules-update-metadata-request.json
|
|
:language: javascript
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- metadata: access_metadata
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/share-access-rules-update-metadata-response.json
|
|
:language: javascript
|
|
|
|
|
|
Unset share access rule metadata
|
|
================================
|
|
|
|
.. rest_method:: DELETE /v2/{project_id}/share-access-rules/{access_id}/metadata/{key}
|
|
|
|
.. versionadded:: 2.45
|
|
|
|
Un-sets the metadata on a share access rule.
|
|
|
|
To unset a metadata key value, specify only the key name in the
|
|
URI.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- access_id: access_id_path
|
|
- key: metadata_key_path
|