Skip to content

Commit a5320fd

Browse files
committed
Add Last run related dataset endpoints
1 parent 0b361f5 commit a5320fd

11 files changed

+131
-92
lines changed

apify-api/openapi/components/objects/datasets/dataset-items.yaml

Lines changed: 43 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -276,28 +276,20 @@ getDefault:
276276
- $ref: "../../parameters/datasetItemsParameters.yaml#/skipFailedPages"
277277
- $ref: "../../parameters/storageParameters.yaml#/signature"
278278

279-
sharedHead: &sharedHead
280-
responses:
281-
"200":
282-
description: ""
283-
headers:
284-
$ref: ../../headers/ApifyPaginationHeaders.yaml
285-
content: {}
286-
"400":
287-
$ref: ../../responses/BadRequest.yaml
288-
deprecated: false
289-
290-
headById:
291-
<<: *sharedHead
279+
getLastRun:
280+
<<: *sharedGet
292281
tags:
293-
- Storage/Datasets
294-
summary: Get dataset items headers
282+
- Last Actor run
283+
summary: Get last run's dataset items
295284
description: |
296-
Returns only the HTTP headers for the dataset items endpoint, without the response body.
297-
This is useful to check pagination metadata or verify access without downloading the full dataset.
298-
operationId: dataset_items_head
285+
Returns data stored in the default dataset of the last Actor run in the desired format.
286+
287+
This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
288+
[Get dataset items](/api/v2/dataset-items-get) endpoint.
289+
operationId: act_runs_last_dataset_items_get
299290
parameters:
300-
- $ref: "../../parameters/storageParameters.yaml#/datasetId"
291+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
292+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
301293
- $ref: "../../parameters/datasetItemsParameters.yaml#/format"
302294
- $ref: "../../parameters/datasetItemsParameters.yaml#/clean"
303295
- $ref: "../../parameters/paginationParameters.yaml#/offset"
@@ -320,20 +312,25 @@ headById:
320312
- $ref: "../../parameters/datasetItemsParameters.yaml#/skipFailedPages"
321313
- $ref: "../../parameters/storageParameters.yaml#/signature"
322314

323-
headDefault:
324-
<<: *sharedHead
315+
headById:
316+
responses:
317+
"200":
318+
description: ""
319+
headers:
320+
$ref: ../../headers/ApifyPaginationHeaders.yaml
321+
content: {}
322+
"400":
323+
$ref: ../../responses/BadRequest.yaml
324+
deprecated: false
325325
tags:
326-
- Default storages
327-
summary: Get default dataset items headers
326+
- Storage/Datasets
327+
summary: Get dataset items headers
328328
description: |
329-
Returns only the HTTP headers for the dataset items endpoint of the Actor run's default dataset,
330-
without the response body.
331-
332-
This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
333-
[Head dataset items](/api/v2/dataset-items-head) endpoint.
334-
operationId: actorRun_dataset_items_head
329+
Returns only the HTTP headers for the dataset items endpoint, without the response body.
330+
This is useful to check pagination metadata or verify access without downloading the full dataset.
331+
operationId: dataset_items_head
335332
parameters:
336-
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
333+
- $ref: "../../parameters/storageParameters.yaml#/datasetId"
337334
- $ref: "../../parameters/datasetItemsParameters.yaml#/format"
338335
- $ref: "../../parameters/datasetItemsParameters.yaml#/clean"
339336
- $ref: "../../parameters/paginationParameters.yaml#/offset"
@@ -438,3 +435,19 @@ postDefault:
438435
operationId: actorRun_dataset_items_post
439436
parameters:
440437
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
438+
439+
postLastRun:
440+
<<: *sharedPost
441+
tags:
442+
- Last Actor run
443+
summary: Store items in last run's dataset
444+
description: |
445+
Appends an item or an array of items to the end of the last Actor run's default dataset.
446+
447+
This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
448+
[Store items](/api/v2/dataset-items-post) endpoint.
449+
450+
operationId: act_runs_last_dataset_items_post
451+
parameters:
452+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
453+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"

apify-api/openapi/components/objects/datasets/dataset-statistics.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,18 @@ getDefault:
4646
operationId: actorRun_dataset_statistics_get
4747
parameters:
4848
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
49+
50+
getLastRun:
51+
<<: *sharedGet
52+
tags:
53+
- Last Actor run
54+
summary: Get last run's dataset statistics
55+
description: |
56+
Returns statistics for the last Actor run's default dataset.
57+
58+
This endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the
59+
[Get dataset statistics](/api/v2/dataset-statistics-get) endpoint.
60+
operationId: act_runs_last_dataset_statistics_get
61+
parameters:
62+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
63+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"

apify-api/openapi/components/objects/datasets/dataset.yaml

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,21 @@ getDefault:
8080
parameters:
8181
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
8282

83+
getLastRun:
84+
<<: *sharedGet
85+
tags:
86+
- Last Actor run
87+
summary: Get last run's default dataset
88+
description: |
89+
Returns the default dataset associated with the last Actor run.
90+
91+
This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
92+
[Get dataset](/api/v2/dataset-get) endpoint.
93+
operationId: act_runs_last_dataset_get
94+
parameters:
95+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
96+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
97+
8398
sharedPut: &sharedPut
8499
requestBody:
85100
description: ""
@@ -141,6 +156,21 @@ putDefault:
141156
parameters:
142157
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
143158

159+
putLastRun:
160+
<<: *sharedPut
161+
tags:
162+
- Last Actor run
163+
summary: Update last run's default dataset
164+
description: |
165+
Updates the default dataset associated with the last Actor run.
166+
167+
This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
168+
[Update dataset](/api/v2/dataset-put) endpoint.
169+
operationId: act_runs_last_dataset_put
170+
parameters:
171+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
172+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
173+
144174
sharedDelete: &sharedDelete
145175
responses:
146176
<<: *commonErrors
@@ -170,7 +200,26 @@ deleteDefault:
170200
tags:
171201
- Default storages
172202
summary: Delete default dataset
173-
description: Deletes default dataset associated with an Actor run.
203+
description: |
204+
Deletes default dataset associated with an Actor run.
205+
206+
This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
207+
[ Delete dataset ](/api/v2/dataset-delete) endpoint.
174208
operationId: actorRun_dataset_delete
175209
parameters:
176210
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
211+
212+
deleteLastRun:
213+
<<: *sharedDelete
214+
tags:
215+
- Last Actor run
216+
summary: Delete last run's default dataset
217+
description: |
218+
Deletes the default dataset associated with the last Actor run.
219+
220+
This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
221+
[Delete dataset](/api/v2/dataset-delete) endpoint.
222+
operationId: act_runs_last_dataset_delete
223+
parameters:
224+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
225+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"

apify-api/openapi/components/tags.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,3 +431,7 @@
431431
x-displayName: Default storages - Introduction
432432
description: |
433433
The API endpoints described in this section are convenience endpoints that provide access to Actor run's default storages (dataset, key-value store, and request queue) without the need to resolve the storage ID first.
434+
- name: Last Actor run
435+
x-displayName: Last Actor run - Introduction
436+
description: |
437+
The API endpoints described in this section are convenience endpoints that provide access to Actor's last run and all it's sub resources without the need to resolve the run ID first.

apify-api/openapi/components/x-tag-groups.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@
4444
- name: Convenience endpoints
4545
tags:
4646
- Default storages
47+
- Last Actor run

apify-api/openapi/openapi.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,12 @@ paths:
514514
$ref: "paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml"
515515
"/v2/acts/{actorId}/runs/last":
516516
$ref: "paths/actors/acts@{actorId}@runs@last.yaml"
517+
"/v2/acts/{actorId}/runs/last/dataset":
518+
$ref: "paths/actors/acts@{actorId}@runs@last@dataset.yaml"
519+
"/v2/acts/{actorId}/runs/last/dataset/items":
520+
$ref: "paths/actors/acts@{actorId}@runs@last@dataset@items.yaml"
521+
"/v2/acts/{actorId}/runs/last/dataset/statistics":
522+
$ref: "paths/actors/acts@{actorId}@runs@last@dataset@statistics.yaml"
517523
"/v2/acts/{actorId}/runs/{runId}":
518524
$ref: "paths/actors/acts@{actorId}@runs@{runId}.yaml"
519525
"/v2/acts/{actorId}/runs/{runId}/abort":
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
get:
22
$ref: "../../components/objects/datasets/dataset-items.yaml#/getDefault"
3-
head:
4-
$ref: "../../components/objects/datasets/dataset-items.yaml#/headDefault"
53
post:
64
$ref: "../../components/objects/datasets/dataset-items.yaml#/postDefault"
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
get:
2+
$ref: "../../components/objects/datasets/dataset.yaml#/getLastRun"
3+
put:
4+
$ref: "../../components/objects/datasets/dataset.yaml#/putLastRun"
5+
delete:
6+
$ref: "../../components/objects/datasets/dataset.yaml#/deleteLastRun"
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
get:
2+
$ref: "../../components/objects/datasets/dataset-items.yaml#/getLastRun"
3+
post:
4+
$ref: "../../components/objects/datasets/dataset-items.yaml#/postLastRun"
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
get:
2+
$ref: "../../components/objects/datasets/dataset-statistics.yaml#/getLastRun"

0 commit comments

Comments
 (0)