Skip to content

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.

Sign up for GitHub

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

Open
nmanerikar wants to merge 3 commits into
base: master
Choose a base branch
from
+38 −0
Open

chore(api): add the new 'ownership' parameter for listing storages #2208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50d9ae7
Add ownership parameter docs
nmanerikar Jan 27, 2026
ee02f2e
Adjust wording
nmanerikar Jan 28, 2026
462f9f8
Make reusable component of the schema. Clarify default
nmanerikar Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions apify-api/openapi/components/schemas/common/StorageOwnership.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: string
enum:
- ownedByMe
- sharedWithMe
examples: [ownedByMe]
11 changes: 11 additions & 0 deletions apify-api/openapi/paths/datasets/datasets.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ get:
schema:
type: boolean
example: true
- name: ownership
in: query
description: |
Filter by ownership. If this parameter is omitted, all accessible datasets are returned.
- `ownedByMe`: Return only datasets owned by the user.
- `sharedWithMe`: Return only datasets shared with the user by other users.
style: form
explode: true
schema:
$ref: ../../components/schemas/common/StorageOwnership.yaml
responses:
"200":
description: ""
Expand Down
11 changes: 11 additions & 0 deletions apify-api/openapi/paths/key-value-stores/key-value-stores.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,17 @@ get:
schema:
type: boolean
example: true
- name: ownership
in: query
description: |
Filter by ownership. If this parameter is omitted, all accessible key-value stores are returned.
- `ownedByMe`: Return only key-value stores owned by the user.
- `sharedWithMe`: Return only key-value stores shared with the user by other users.
style: form
explode: true
schema:
$ref: ../../components/schemas/common/StorageOwnership.yaml
responses:
"200":
description: ""
Expand Down
11 changes: 11 additions & 0 deletions apify-api/openapi/paths/request-queues/request-queues.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ get:
schema:
type: boolean
example: true
- name: ownership
in: query
description: |
Filter by ownership. If this parameter is omitted, all accessible request queues are returned.
- `ownedByMe`: Return only request queues owned by the user.
- `sharedWithMe`: Return only request queues shared with the user by other users.
style: form
explode: true
schema:
$ref: ../../components/schemas/common/StorageOwnership.yaml
responses:
"200":
description: ""
Expand Down
Loading