From 2c90e59924fb2d38af5b23b318c0b0a9ca4e1ef5 Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Fri, 10 May 2024 12:24:13 -0700 Subject: [PATCH] [api-ref] fix resource lock api reference "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 --- api-ref/source/parameters.yaml | 6 ++---- api-ref/source/resource-locks.inc | 6 +++--- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index ced6cc5494..5ab40386f0 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2779,8 +2779,7 @@ resource_lock_resource_action: 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 ``resource_action`` is ``delete``. Resource locks are not supported for - all API actions. Currently support only exists for ``delete``, and for - specific resources. + all API actions. in: body required: true type: string @@ -2800,8 +2799,7 @@ resource_lock_resource_action_optional: 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 ``resource_action`` is ``delete``. Resource locks are not supported for - all API actions. Currently support only exists for ``delete``, and for - specific resources. + all API actions. in: body required: false type: string diff --git a/api-ref/source/resource-locks.inc b/api-ref/source/resource-locks.inc index e5eab57598..d082901b3b 100644 --- a/api-ref/source/resource-locks.inc +++ b/api-ref/source/resource-locks.inc @@ -187,7 +187,7 @@ Request .. rest_parameters:: parameters.yaml - service_token: service_token_locks - - resource_id: resource_lock_id_path + - resource_lock_id: resource_lock_id_path Response Parameters @@ -250,7 +250,7 @@ Request .. rest_parameters:: parameters.yaml - service_token: service_token_locks - - resource_id: resource_lock_id_path + - resource_lock_id: resource_lock_id_path - resource_lock: resource_lock_object - resource_action: resource_lock_resource_action_optional - lock_reason: resource_lock_lock_reason_optional @@ -322,4 +322,4 @@ Request .. rest_parameters:: parameters.yaml - service_token: service_token_locks - - resource_id: resource_lock_id_path + - resource_lock_id: resource_lock_id_path