41d243c394
- Call out the maximum API version in Stein (2.49) - Add parameter 'cast_rules_to_readonly' to share instance API ref - Remove parameters 'export_location' and 'export_locations' from share instance API ref. - Add "min_version" and "max_version" annotations on parameters where missing. - Add "versionadded" annotation to APIs - Add "DEPRECATED" annotation to deprecated APIs along with a warning message. Identical changes to the manage/unmanage APIs are handled in https://review.openstack.org/#/c/647973/ Partial-Bug: #1760644 Change-Id: I5342cc26d1cbeea8ca3d55868e0f69d525333421
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/{tenant_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
|
|
|
|
- metadata: access_metadata
|
|
- access_id: access_id_path
|
|
- tenant_id: tenant_id_path
|
|
|
|
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/{tenant_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
|
|
|
|
- access_id: access_id_path
|
|
- tenant_id: tenant_id_path
|
|
- key: metadata_key_path
|