From 18741fe632769a02ee26da73657aadc03e1a9dec Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi <gouthampravi@gmail.com> Date: Tue, 30 Mar 2021 07:33:32 -0700 Subject: [PATCH] Fix api-ref for access rules The key for access rule metadata in the API request or response is just "metadata". The "access_key" in /share-access-rules endpoint responses doesn't need to specify a min-version since its present in all API versions that the endpoint itself is supported with. TrivialFix Change-Id: I66ac3804f22d70ad673eb7185e5e7eb08843c811 Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com> --- api-ref/source/parameters.yaml | 14 ++++++++++++++ api-ref/source/share-access-rules.inc | 6 +++--- api-ref/source/share-actions.inc | 4 ++-- 3 files changed, 19 insertions(+), 5 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index ed8fd19342..5e9e2b2732 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -534,6 +534,12 @@ access_key: required: true type: string min_version: 2.21 +access_key_share_access_rules: + description: | + The access credential of the entity granted share access. + in: body + required: true + type: string access_level: description: | The access level to the share. To grant or deny @@ -559,6 +565,14 @@ access_metadata: in: body required: true type: object +access_metadata_grant_access: + description: | + One or more access rule metadata key and value pairs as a + dictionary of strings. + in: body + required: true + type: object + min_version: 2.45 access_rule_id: description: | The access rule ID. diff --git a/api-ref/source/share-access-rules.inc b/api-ref/source/share-access-rules.inc index 185cd63e8a..e5f64c02ca 100644 --- a/api-ref/source/share-access-rules.inc +++ b/api-ref/source/share-access-rules.inc @@ -49,11 +49,11 @@ Response parameters - updated_at: updated_at - access_type: access_type - access_to: access_to - - access_key: access_key + - access_key: access_key_share_access_rules - state: state - access_level: access_level - id: access_rule_id - - access_metadata: access_metadata + - metadata: access_metadata Response example ---------------- @@ -106,7 +106,7 @@ Response parameters - metadata: access_metadata - access_type: access_type - - access_key: access_key + - access_key: access_key_share_access_rules - access_to: access_to - access_level: access_level - state: state diff --git a/api-ref/source/share-actions.inc b/api-ref/source/share-actions.inc index 6a105d14b0..c6def37dca 100644 --- a/api-ref/source/share-actions.inc +++ b/api-ref/source/share-actions.inc @@ -99,7 +99,7 @@ Request - access_level: access_level - access_type: access_type - access_to: access_to - - access_metadata: metadata + - metadata: access_metadata_grant_access Request example --------------- @@ -121,7 +121,7 @@ Response parameters - access: access - access_level: access_level - id: access_rule_id - - access_metadata: access_metadata + - metadata: access_metadata Response example ----------------