Skip to content

[Update] Limited access keys with Object Storage #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Sep 8, 2020

Conversation

sagesyr
Copy link
Contributor

@sagesyr sagesyr commented Sep 2, 2020

No description provided.

@sagesyr sagesyr requested a review from nmelehan September 2, 2020 00:46
openapi.yaml Outdated
@@ -10692,6 +10692,22 @@ paths:
type: string
description: The label for this keypair, for display purposes only.
example: my-key
bucket_access:
type: object
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be type: array with items being of type: object and having the properties you added below. Same for the response value below.

openapi.yaml Outdated
example: ap-south-1
bucket_name:
type: string
description: The unique label of the bucket with limited access.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The unique label of the bucket to which the key should have access.

openapi.yaml Outdated
example: example-bucket
permissions:
type: string
description: The permissions for the selected key. Can be `read_write` or `read_only`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The permissions of the key for the selected bucket.

openapi.yaml Outdated
properties:
cluster:
type: string
description: The datacenter where a bucket with limited access is hosted.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be more accurate to say The Object Storage cluster where a bucket to which the key should have access is hosted.

The OBJ cluster label is different than the datacenter/region label (typically just a -1 appended to the datacenter name.)

type: boolean
description: Whether or not this key is a limited access key. Will return `false` if this key grants full access to all buckets on the user's account.
example: true
bucket_access:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My other comments about type and property descriptions also apply to this section.

@leslitagordita leslitagordita requested review from leslitagordita and removed request for nmelehan September 3, 2020 17:50
Copy link
Collaborator

@victoriaroan victoriaroan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy changes look good 👍

@leslitagordita leslitagordita merged commit 0f58157 into linode:development Sep 8, 2020
LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants