From 7705b74a755641e29e2aa464fac3a554deb099bb Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Thu, 10 Aug 2023 15:00:33 -0700 Subject: [PATCH] [api-ref] add provider_location to snapshots This optional field was missing in the docs Change-Id: I86a3161b098652788f8a982053a8efd06a73dbba --- api-ref/source/parameters.yaml | 10 ++++++++++ api-ref/source/snapshots.inc | 4 +++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index b61a870a9a..2704f27319 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -3406,6 +3406,16 @@ snapshot_provider_location: in: body required: true type: string +snapshot_provider_location_optional: + description: | + Provider location of the snapshot on the backend. This parameter is only + available to users with an "administrator" role by virtue of default + RBAC. This behavior can be modified by overriding the + ``context_is_admin`` policy via a custom ``policy.yaml``. + in: body + required: false + type: string + min_version: 2.12 snapshot_provider_location_request: description: | Provider location of the snapshot on the backend. diff --git a/api-ref/source/snapshots.inc b/api-ref/source/snapshots.inc index 7a6a182481..8a4eef1531 100644 --- a/api-ref/source/snapshots.inc +++ b/api-ref/source/snapshots.inc @@ -133,6 +133,7 @@ Response parameters - size: snapshot_size - project_id: snapshot_project_id - user_id: snapshot_user_id + - provider_location: snapshot_provider_location_optional Response example ---------------- @@ -185,6 +186,7 @@ Response parameters - size: snapshot_size - project_id: snapshot_project_id - user_id: snapshot_user_id + - provider_location: snapshot_provider_location_optional Response example ---------------- @@ -248,7 +250,7 @@ Response parameters - created_at: created_at - share_proto: snapshot_share_protocol - share_size: snapshot_share_size - - provider_location: snapshot_provider_location + - provider_location: snapshot_provider_location_optional - size: snapshot_size - project_id: snapshot_project_id - user_id: snapshot_user_id