Skip to content

Commit b4c35ab

Browse files
authored
chore(api): add the new 'ownership' parameter for listing storages (#2208)
Document the new 'ownership' parameter in the listing requests for storages. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Documents a new optional `ownership` query parameter for storage listing endpoints to filter by resource ownership. > > - Adds `ownership` to `GET` listings for datasets, key-value stores, and request queues (`datasets.yaml`, `key-value-stores.yaml`, `request-queues.yaml`) > - Accepts `ownedByMe` or `sharedWithMe`; default remains all accessible resources > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit ee02f2e. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 1c867e7 commit b4c35ab

4 files changed

Lines changed: 38 additions & 0 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: string
2+
enum:
3+
- ownedByMe
4+
- sharedWithMe
5+
examples: [ownedByMe]

apify-api/openapi/paths/datasets/datasets.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,17 @@ get:
5454
schema:
5555
type: boolean
5656
example: true
57+
- name: ownership
58+
in: query
59+
description: |
60+
Filter by ownership. If this parameter is omitted, all accessible datasets are returned.
61+
62+
- `ownedByMe`: Return only datasets owned by the user.
63+
- `sharedWithMe`: Return only datasets shared with the user by other users.
64+
style: form
65+
explode: true
66+
schema:
67+
$ref: ../../components/schemas/common/StorageOwnership.yaml
5768
responses:
5869
"200":
5970
description: ""

apify-api/openapi/paths/key-value-stores/key-value-stores.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ get:
5959
schema:
6060
type: boolean
6161
example: true
62+
- name: ownership
63+
in: query
64+
description: |
65+
Filter by ownership. If this parameter is omitted, all accessible key-value stores are returned.
66+
67+
- `ownedByMe`: Return only key-value stores owned by the user.
68+
- `sharedWithMe`: Return only key-value stores shared with the user by other users.
69+
style: form
70+
explode: true
71+
schema:
72+
$ref: ../../components/schemas/common/StorageOwnership.yaml
6273
responses:
6374
"200":
6475
description: ""

apify-api/openapi/paths/request-queues/request-queues.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,17 @@ get:
5757
schema:
5858
type: boolean
5959
example: true
60+
- name: ownership
61+
in: query
62+
description: |
63+
Filter by ownership. If this parameter is omitted, all accessible request queues are returned.
64+
65+
- `ownedByMe`: Return only request queues owned by the user.
66+
- `sharedWithMe`: Return only request queues shared with the user by other users.
67+
style: form
68+
explode: true
69+
schema:
70+
$ref: ../../components/schemas/common/StorageOwnership.yaml
6071
responses:
6172
"200":
6273
description: ""

0 commit comments

Comments
 (0)