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>
This commit is contained in:
Goutham Pacha Ravi 2021-03-30 07:33:32 -07:00
parent b50a0bb9de
commit 18741fe632
3 changed files with 19 additions and 5 deletions

View File

@ -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.

View File

@ -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

View File

@ -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
----------------