From 50d9ae7eedaa50a023ca909f80564481164e61d3 Mon Sep 17 00:00:00 2001 From: Nishad Manerikar Date: Tue, 27 Jan 2026 16:13:29 +0100 Subject: [PATCH 1/3] Add ownership parameter docs --- apify-api/openapi/paths/datasets/datasets.yaml | 15 +++++++++++++++ .../paths/key-value-stores/key-value-stores.yaml | 15 +++++++++++++++ .../paths/request-queues/request-queues.yaml | 15 +++++++++++++++ 3 files changed, 45 insertions(+) diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index 3b8f67d75..7d8353d0e 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -54,6 +54,21 @@ get: schema: type: boolean example: true + - name: ownership + in: query + description: | + Filter by ownership. By default, all accessible datasets are returned. + + - `ownedByMe`: Return only datasets owned by the currently authenticated user. + - `sharedWithMe`: Return only datasets shared with the currently authenticated user by other users. + style: form + explode: true + schema: + type: string + enum: + - ownedByMe + - sharedWithMe + example: ownedByMe responses: "200": description: "" diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml index d2242a1e3..d4c8240b5 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml @@ -59,6 +59,21 @@ get: schema: type: boolean example: true + - name: ownership + in: query + description: | + Filter by ownership. By default, all accessible key-value stores are returned. + + - `ownedByMe`: Return only key-value stores owned by the currently authenticated user. + - `sharedWithMe`: Return only key-value stores shared with the currently authenticated user by other users. + style: form + explode: true + schema: + type: string + enum: + - ownedByMe + - sharedWithMe + example: ownedByMe responses: "200": description: "" diff --git a/apify-api/openapi/paths/request-queues/request-queues.yaml b/apify-api/openapi/paths/request-queues/request-queues.yaml index 0598ecfca..866c2fd66 100644 --- a/apify-api/openapi/paths/request-queues/request-queues.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues.yaml @@ -57,6 +57,21 @@ get: schema: type: boolean example: true + - name: ownership + in: query + description: | + Filter by ownership. By default, all accessible request queues are returned. + + - `ownedByMe`: Return only request queues owned by the currently authenticated user. + - `sharedWithMe`: Return only request queues shared with the currently authenticated user by other users. + style: form + explode: true + schema: + type: string + enum: + - ownedByMe + - sharedWithMe + example: ownedByMe responses: "200": description: "" From ee02f2e732419b607a8d00567d7c9eb0b4172bd5 Mon Sep 17 00:00:00 2001 From: Nishad Manerikar Date: Wed, 28 Jan 2026 17:32:24 +0100 Subject: [PATCH 2/3] Adjust wording --- apify-api/openapi/paths/datasets/datasets.yaml | 4 ++-- .../openapi/paths/key-value-stores/key-value-stores.yaml | 4 ++-- apify-api/openapi/paths/request-queues/request-queues.yaml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index 7d8353d0e..6b1c018a3 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -59,8 +59,8 @@ get: description: | Filter by ownership. By default, all accessible datasets are returned. - - `ownedByMe`: Return only datasets owned by the currently authenticated user. - - `sharedWithMe`: Return only datasets shared with the currently authenticated user by other users. + - `ownedByMe`: Return only datasets owned by the user. + - `sharedWithMe`: Return only datasets shared with the user by other users. style: form explode: true schema: diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml index d4c8240b5..0dadc581e 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml @@ -64,8 +64,8 @@ get: description: | Filter by ownership. By default, all accessible key-value stores are returned. - - `ownedByMe`: Return only key-value stores owned by the currently authenticated user. - - `sharedWithMe`: Return only key-value stores shared with the currently authenticated user by other users. + - `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: diff --git a/apify-api/openapi/paths/request-queues/request-queues.yaml b/apify-api/openapi/paths/request-queues/request-queues.yaml index 866c2fd66..0a8018f1c 100644 --- a/apify-api/openapi/paths/request-queues/request-queues.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues.yaml @@ -62,8 +62,8 @@ get: description: | Filter by ownership. By default, all accessible request queues are returned. - - `ownedByMe`: Return only request queues owned by the currently authenticated user. - - `sharedWithMe`: Return only request queues shared with the currently authenticated user by other users. + - `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: From 462f9f8748c4de4642d82389614e56c25ed7f35b Mon Sep 17 00:00:00 2001 From: Nishad Manerikar Date: Wed, 28 Jan 2026 18:22:27 +0100 Subject: [PATCH 3/3] Make reusable component of the schema. Clarify default --- .../components/schemas/common/StorageOwnership.yaml | 5 +++++ apify-api/openapi/paths/datasets/datasets.yaml | 8 ++------ .../openapi/paths/key-value-stores/key-value-stores.yaml | 8 ++------ .../openapi/paths/request-queues/request-queues.yaml | 8 ++------ 4 files changed, 11 insertions(+), 18 deletions(-) create mode 100644 apify-api/openapi/components/schemas/common/StorageOwnership.yaml diff --git a/apify-api/openapi/components/schemas/common/StorageOwnership.yaml b/apify-api/openapi/components/schemas/common/StorageOwnership.yaml new file mode 100644 index 000000000..d6b56f39e --- /dev/null +++ b/apify-api/openapi/components/schemas/common/StorageOwnership.yaml @@ -0,0 +1,5 @@ +type: string +enum: + - ownedByMe + - sharedWithMe +examples: [ownedByMe] diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index 6b1c018a3..6a047c340 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -57,18 +57,14 @@ get: - name: ownership in: query description: | - Filter by ownership. By default, all accessible datasets are returned. + 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: - type: string - enum: - - ownedByMe - - sharedWithMe - example: ownedByMe + $ref: ../../components/schemas/common/StorageOwnership.yaml responses: "200": description: "" diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml index 0dadc581e..38813ba9d 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml @@ -62,18 +62,14 @@ get: - name: ownership in: query description: | - Filter by ownership. By default, all accessible key-value stores are returned. + 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: - type: string - enum: - - ownedByMe - - sharedWithMe - example: ownedByMe + $ref: ../../components/schemas/common/StorageOwnership.yaml responses: "200": description: "" diff --git a/apify-api/openapi/paths/request-queues/request-queues.yaml b/apify-api/openapi/paths/request-queues/request-queues.yaml index 0a8018f1c..d2b308f21 100644 --- a/apify-api/openapi/paths/request-queues/request-queues.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues.yaml @@ -60,18 +60,14 @@ get: - name: ownership in: query description: | - Filter by ownership. By default, all accessible request queues are returned. + 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: - type: string - enum: - - ownedByMe - - sharedWithMe - example: ownedByMe + $ref: ../../components/schemas/common/StorageOwnership.yaml responses: "200": description: ""