openstack/manila
Code Issues Proposed changes

[api-ref] fix resource lock api reference

Browse Source 
"delete" was the only lock action supported when
we introduced the API; but we now support "show"
as well for the access rules resource.

Also fix an incorrect parameter in the PUT /resource-locks
method.

Change-Id: Ie276d9c984586ad5b90581e46796d390f748ce1f
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
This commit is contained in:
Goutham Pacha Ravi 2024-05-10 12:24:13 -07:00
parent 84ab5df84a
commit 2c90e59924
2 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/parameters.yaml
View File

@ -2779,8 +2779,7 @@ resource_lock_resource_action:
The action pertaining to a resource that the resource lock prevents. For The action pertaining to a resource that the resource lock prevents. For
example, if a resource lock prevents deletion of a share, the value of example, if a resource lock prevents deletion of a share, the value of
``resource_action`` is ``delete``. Resource locks are not supported for ``resource_action`` is ``delete``. Resource locks are not supported for
all API actions. Currently support only exists for ``delete``, and for all API actions.
specific resources.
in: body in: body
required: true required: true
type: string type: string
@ -2800,8 +2799,7 @@ resource_lock_resource_action_optional:
The action pertaining to a resource that the resource lock prevents. For The action pertaining to a resource that the resource lock prevents. For
example, if a resource lock prevents deletion of a share, the value of example, if a resource lock prevents deletion of a share, the value of
``resource_action`` is ``delete``. Resource locks are not supported for ``resource_action`` is ``delete``. Resource locks are not supported for
all API actions. Currently support only exists for ``delete``, and for all API actions.
specific resources.
in: body in: body
required: false required: false
type: string type: string

6
api-ref/source/resource-locks.inc
View File

@ -187,7 +187,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- service_token: service_token_locks - service_token: service_token_locks
- resource_id: resource_lock_id_path - resource_lock_id: resource_lock_id_path
Response Parameters Response Parameters
@ -250,7 +250,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- service_token: service_token_locks - service_token: service_token_locks
- resource_id: resource_lock_id_path - resource_lock_id: resource_lock_id_path
- resource_lock: resource_lock_object - resource_lock: resource_lock_object
- resource_action: resource_lock_resource_action_optional - resource_action: resource_lock_resource_action_optional
- lock_reason: resource_lock_lock_reason_optional - lock_reason: resource_lock_lock_reason_optional
@ -322,4 +322,4 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- service_token: service_token_locks - service_token: service_token_locks
- resource_id: resource_lock_id_path - resource_lock_id: resource_lock_id_path