-
Notifications
You must be signed in to change notification settings - Fork 163
chore(api): add the new 'ownership' parameter for listing storages #2208
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
base: master
Are you sure you want to change the base?
Conversation
|
Preview for this PR was built for commit |
| - name: ownership | ||
| in: query | ||
| description: | | ||
| Filter by ownership. By default, all accessible datasets are returned. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this correspond to either of the possible values? Or is the default a third value, semantically?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Default is the absence of this parameter - all accessible datasets are returned when the ownership parameter is not included in the request. This behaviour will be changed shortly after communication with users - the absence of the ownership parameter will then start behaving the same as ownedByMe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good, thanks for the explanation!
| schema: | ||
| type: string | ||
| enum: | ||
| - ownedByMe | ||
| - sharedWithMe | ||
| example: ownedByMe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be great to turn this into a reusable component
|
Preview for this PR was built for commit |
Document the new 'ownership' parameter in the listing requests for storages.
Note
Documents a new optional
ownershipquery parameter for storage listing endpoints to filter by resource ownership.ownershiptoGETlistings for datasets, key-value stores, and request queues (datasets.yaml,key-value-stores.yaml,request-queues.yaml)ownedByMeorsharedWithMe; default remains all accessible resourcesWritten by Cursor Bugbot for commit ee02f2e. Configure here.