Skip to content

Commit 3e85fb2

Browse files
authored
feat: Add the new storage ids field where needed (#2310)
This adds docs for multiple datasets in the API. We're not including the storage IDs in the list response. At this point it's not needed, but we might want to add it later. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > OpenAPI schema/example-only change that adds a new optional response field and should not affect runtime behavior; main risk is client expectations around the new field’s shape. > > **Overview** > Documents a new `storageIds` object on the `Run` schema to expose **aliased storage IDs** grouped by `datasets`, `keyValueStores`, and `requestQueues` (including the `default` alias). > > Updates example responses for run abort endpoints (both `actor-runs` and deprecated `actors`) and task run creation to include the new `storageIds` field; list/run-short responses remain unchanged. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit fa1c269. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 1befd13 commit 3e85fb2

File tree

4 files changed

+55
-0
lines changed

4 files changed

+55
-0
lines changed

apify-api/openapi/components/schemas/actor-runs/Run.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,40 @@ properties:
9797
type: string
9898
examples: [FL35cSF7jrxr3BY39]
9999
description: ID of the default request queue for this run.
100+
storageIds:
101+
type: object
102+
description: A map of aliased storage IDs associated with this run, grouped by storage type.
103+
properties:
104+
datasets:
105+
type: object
106+
description: Aliased dataset IDs for this run.
107+
properties:
108+
default:
109+
type: string
110+
description: ID of the default dataset for this run.
111+
example: wmKPijuyDnPZAPRMk
112+
additionalProperties:
113+
type: string
114+
keyValueStores:
115+
type: object
116+
description: Aliased key-value store IDs for this run.
117+
properties:
118+
default:
119+
type: string
120+
description: ID of the default key-value store for this run.
121+
example: eJNzqsbPiopwJcgGQ
122+
additionalProperties:
123+
type: string
124+
requestQueues:
125+
type: object
126+
description: Aliased request queue IDs for this run.
127+
properties:
128+
default:
129+
type: string
130+
description: ID of the default request queue for this run.
131+
example: FL35cSF7jrxr3BY39
132+
additionalProperties:
133+
type: string
100134
buildNumber:
101135
type: string
102136
examples: [0.0.36]

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ post:
8080
defaultKeyValueStoreId: eJNzqsbPiopwJcgGQ
8181
defaultDatasetId: wmKPijuyDnPZAPRMk
8282
defaultRequestQueueId: FL35cSF7jrxr3BY39
83+
storageIds:
84+
datasets:
85+
default: wmKPijuyDnPZAPRMk
86+
keyValueStores:
87+
default: eJNzqsbPiopwJcgGQ
88+
requestQueues:
89+
default: FL35cSF7jrxr3BY39
8390
isContainerServerReady: false
8491
gitBranchName: master
8592
usage:

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,13 @@ post:
280280
defaultKeyValueStoreId: eJNzqsbPiopwJcgGQ
281281
defaultDatasetId: wmKPijuyDnPZAPRMk
282282
defaultRequestQueueId: FL35cSF7jrxr3BY39
283+
storageIds:
284+
datasets:
285+
default: wmKPijuyDnPZAPRMk
286+
keyValueStores:
287+
default: eJNzqsbPiopwJcgGQ
288+
requestQueues:
289+
default: FL35cSF7jrxr3BY39
283290
buildNumber: 0.2.2
284291
containerUrl: "https://nwfcc4btrgqt.runs.apify.com"
285292
isContainerServerReady: false

apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ post:
8989
defaultKeyValueStoreId: eJNzqsbPiopwJcgGQ
9090
defaultDatasetId: wmKPijuyDnPZAPRMk
9191
defaultRequestQueueId: FL35cSF7jrxr3BY39
92+
storageIds:
93+
datasets:
94+
default: wmKPijuyDnPZAPRMk
95+
keyValueStores:
96+
default: eJNzqsbPiopwJcgGQ
97+
requestQueues:
98+
default: FL35cSF7jrxr3BY39
9299
isContainerServerReady: false
93100
gitBranchName: master
94101
usage:

0 commit comments

Comments
 (0)