Skip to content

Commit 22e65a2

Browse files
authored
docs(openapi): Add undocumented last task run endpoints (#2446)
### Description - Add undocumented, but public API endpoints related to the last task run - last Actor run dataset - last Actor run rq - last Actor run kvs - Abstract reusable parts of nearly duplicate endpoints and use references. - Replace prose description of previously not properly documented redispatch endpoints by links to their documentation. (prose description is no longer needed, all redispatch endpoints have their own pages) ### Issues Partially implements: #2286
1 parent 3887815 commit 22e65a2

36 files changed

Lines changed: 660 additions & 136 deletions

File tree

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ sharedTagLastRun: &sharedTagLastRun
2222
tags:
2323
- Last Actor run's default dataset
2424

25+
sharedTagTaskLastRun: &sharedTagTaskLastRun
26+
tags:
27+
- Last Actor task run's default dataset
28+
2529
parametersGetHeadById: &parametersGetHeadById
2630
parameters:
2731
- $ref: "../../parameters/datasetParameters.yaml#/datasetId"
@@ -320,6 +324,40 @@ getLastRun:
320324
- $ref: "../../parameters/datasetParameters.yaml#/skipFailedPages"
321325
- $ref: "../../parameters/storageParameters.yaml#/signature"
322326

327+
getTaskLastRun:
328+
<<: [*sharedGet, *sharedTagTaskLastRun]
329+
summary: Get last task run's dataset items
330+
description: |
331+
Returns data stored in the default dataset of the last Actor task run in the desired format.
332+
333+
This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
334+
[Get dataset items](/api/v2/dataset-items-get) endpoint.
335+
operationId: actorTask_runs_last_dataset_items_get
336+
parameters:
337+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
338+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
339+
- $ref: "../../parameters/datasetParameters.yaml#/format"
340+
- $ref: "../../parameters/datasetParameters.yaml#/clean"
341+
- $ref: "../../parameters/paginationParameters.yaml#/offset"
342+
- $ref: "../../parameters/datasetParameters.yaml#/limit"
343+
- $ref: "../../parameters/datasetParameters.yaml#/fields"
344+
- $ref: "../../parameters/datasetParameters.yaml#/omit"
345+
- $ref: "../../parameters/datasetParameters.yaml#/unwind"
346+
- $ref: "../../parameters/datasetParameters.yaml#/flatten"
347+
- $ref: "../../parameters/datasetParameters.yaml#/descDataset"
348+
- $ref: "../../parameters/datasetParameters.yaml#/attachment"
349+
- $ref: "../../parameters/datasetParameters.yaml#/delimiter"
350+
- $ref: "../../parameters/datasetParameters.yaml#/bom"
351+
- $ref: "../../parameters/datasetParameters.yaml#/xmlRoot"
352+
- $ref: "../../parameters/datasetParameters.yaml#/xmlRow"
353+
- $ref: "../../parameters/datasetParameters.yaml#/skipHeaderRow"
354+
- $ref: "../../parameters/datasetParameters.yaml#/skipHidden"
355+
- $ref: "../../parameters/datasetParameters.yaml#/skipEmpty"
356+
- $ref: "../../parameters/datasetParameters.yaml#/simplified"
357+
- $ref: "../../parameters/datasetParameters.yaml#/view"
358+
- $ref: "../../parameters/datasetParameters.yaml#/skipFailedPages"
359+
- $ref: "../../parameters/storageParameters.yaml#/signature"
360+
323361
headById:
324362
<<: [*parametersGetHeadById, *sharedTagById]
325363
responses:
@@ -429,3 +467,17 @@ postLastRun:
429467
parameters:
430468
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
431469
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
470+
471+
postTaskLastRun:
472+
<<: [*sharedPost, *sharedTagTaskLastRun]
473+
summary: Store items in last task run's dataset
474+
description: |
475+
Appends an item or an array of items to the end of the last Actor task run's default dataset.
476+
477+
This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
478+
[Store items](/api/v2/dataset-items-post) endpoint.
479+
480+
operationId: actorTask_runs_last_dataset_items_post
481+
parameters:
482+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
483+
- $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
@@ -61,3 +61,18 @@ getLastRun:
6161
parameters:
6262
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
6363
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
64+
65+
getTaskLastRun:
66+
<<: *sharedGet
67+
tags:
68+
- Last Actor task run's default dataset
69+
summary: Get last task run's dataset statistics
70+
description: |
71+
Returns statistics for the last Actor task run's default dataset.
72+
73+
This endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the
74+
[Get dataset statistics](/api/v2/dataset-statistics-get) endpoint.
75+
operationId: actorTask_runs_last_dataset_statistics_get
76+
parameters:
77+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
78+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ sharedLastRun: &sharedLastRun
4040
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
4141
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
4242

43+
sharedTaskLastRun: &sharedTaskLastRun
44+
tags:
45+
- Last Actor task run's default dataset
46+
parameters:
47+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
48+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
49+
4350
sharedGet: &sharedGet
4451
responses:
4552
<<: [*common200, *commonErrors]
@@ -94,6 +101,16 @@ getLastRun:
94101
[Get dataset](/api/v2/dataset-get) endpoint.
95102
operationId: act_runs_last_dataset_get
96103

104+
getTaskLastRun:
105+
<<: [*sharedGet, *sharedTaskLastRun]
106+
summary: Get last task run's default dataset
107+
description: |
108+
Returns the default dataset associated with the last Actor task run.
109+
110+
This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
111+
[Get dataset](/api/v2/dataset-get) endpoint.
112+
operationId: actorTask_runs_last_dataset_get
113+
97114
sharedPut: &sharedPut
98115
requestBody:
99116
description: ""
@@ -150,6 +167,16 @@ putLastRun:
150167
[Update dataset](/api/v2/dataset-put) endpoint.
151168
operationId: act_runs_last_dataset_put
152169

170+
putTaskLastRun:
171+
<<: [*sharedPut, *sharedTaskLastRun]
172+
summary: Update last task run's default dataset
173+
description: |
174+
Updates the default dataset associated with the last Actor task run.
175+
176+
This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
177+
[Update dataset](/api/v2/dataset-put) endpoint.
178+
operationId: actorTask_runs_last_dataset_put
179+
153180
sharedDelete: &sharedDelete
154181
responses:
155182
<<: *commonErrors
@@ -189,3 +216,13 @@ deleteLastRun:
189216
This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
190217
[Delete dataset](/api/v2/dataset-delete) endpoint.
191218
operationId: act_runs_last_dataset_delete
219+
220+
deleteTaskLastRun:
221+
<<: [*sharedDelete, *sharedTaskLastRun]
222+
summary: Delete last task run's default dataset
223+
description: |
224+
Deletes the default dataset associated with the last Actor task run.
225+
226+
This endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the
227+
[Delete dataset](/api/v2/dataset-delete) endpoint.
228+
operationId: actorTask_runs_last_dataset_delete

apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ sharedTagLastRun: &sharedTagLastRun
2424
tags:
2525
- Last Actor run's default key-value store
2626

27+
sharedTagTaskLastRun: &sharedTagTaskLastRun
28+
tags:
29+
- Last Actor task run's default key-value store
30+
2731
sharedGet: &sharedGet
2832
responses:
2933
<<: *commonErrors
@@ -98,3 +102,21 @@ getLastRun:
98102
- $ref: "../../parameters/keyValueStoreParameters.yaml#/collectionKeys"
99103
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixKeys"
100104
- $ref: "../../parameters/storageParameters.yaml#/signature"
105+
106+
getTaskLastRun:
107+
<<: [*sharedGet, *sharedTagTaskLastRun]
108+
summary: Get last task run's default store's list of keys
109+
description: |
110+
Returns a list of keys for the default key-value store of the last Actor task run.
111+
112+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
113+
[Get list of keys](/api/v2/key-value-store-keys-get) endpoint.
114+
operationId: actorTask_runs_last_keyValueStore_keys_get
115+
parameters:
116+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
117+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
118+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/exclusiveStartKey"
119+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/limit"
120+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/collectionKeys"
121+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixKeys"
122+
- $ref: "../../parameters/storageParameters.yaml#/signature"

apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ sharedTagLastRun: &sharedTagLastRun
2424
tags:
2525
- Last Actor run's default key-value store
2626

27+
sharedTagTaskLastRun: &sharedTagTaskLastRun
28+
tags:
29+
- Last Actor task run's default key-value store
30+
2731
sharedGet: &sharedGet
2832
responses:
2933
<<: *commonErrors
@@ -156,6 +160,22 @@ getLastRun:
156160
- $ref: "../../parameters/storageParameters.yaml#/signature"
157161
- $ref: "../../parameters/keyValueStoreParameters.yaml#/attachment"
158162

163+
getTaskLastRun:
164+
<<: [*sharedGet, *sharedTagTaskLastRun]
165+
summary: Get last task run's default store's record
166+
description: |
167+
Gets a value stored under a specific key in the default key-value store of the last Actor task run.
168+
169+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
170+
[Get record](/api/v2/key-value-store-record-get) endpoint.
171+
operationId: actorTask_runs_last_keyValueStore_record_get
172+
parameters:
173+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
174+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
175+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
176+
- $ref: "../../parameters/storageParameters.yaml#/signature"
177+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/attachment"
178+
159179
headById:
160180
<<: *sharedTagById
161181
summary: Check if a record exists
@@ -244,11 +264,27 @@ putLastRun:
244264
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
245265
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"
246266

267+
putTaskLastRun:
268+
<<: [*sharedPutPost, *sharedTagTaskLastRun]
269+
summary: Store record in last task run's default store
270+
description: |
271+
Stores a value under a specific key in the default key-value store of the last Actor task run.
272+
273+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
274+
[Store record](/api/v2/key-value-store-record-put) endpoint.
275+
operationId: actorTask_runs_last_keyValueStore_record_put
276+
parameters:
277+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
278+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
279+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
280+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"
281+
247282
postById:
248283
<<: [*sharedPutPost, *sharedTagById]
249284
summary: Store record (POST)
250285
description: |
251286
Stores a value under a specific key to the key-value store.
287+
252288
This endpoint is an alias for the [`PUT` record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put) method and behaves identically.
253289
operationId: keyValueStore_record_post
254290
parameters:
@@ -265,7 +301,6 @@ postDefault:
265301
summary: Store record in default store (POST)
266302
description: |
267303
Stores a value under a specific key in the default key-value store of the Actor run.
268-
This endpoint is an alias for the [`PUT` record](/api/v2/key-value-store-record-put) method and behaves identically.
269304
270305
This endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the
271306
[Store record](/api/v2/key-value-store-record-post) endpoint.
@@ -280,7 +315,6 @@ postLastRun:
280315
summary: Store record in last run's default store (POST)
281316
description: |
282317
Stores a value under a specific key in the default key-value store of the last Actor run.
283-
This endpoint is an alias for the [`PUT` record](/api/v2/act-runs-last-key-value-store-record-put) method and behaves identically.
284318
285319
This endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the
286320
[Store record](/api/v2/key-value-store-record-post) endpoint.
@@ -291,6 +325,21 @@ postLastRun:
291325
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
292326
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"
293327

328+
postTaskLastRun:
329+
<<: [*sharedPutPost, *sharedTagTaskLastRun]
330+
summary: Store record in last task run's default store (POST)
331+
description: |
332+
Stores a value under a specific key in the default key-value store of the last Actor task run.
333+
334+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
335+
[Store record](/api/v2/key-value-store-record-post) endpoint.
336+
operationId: actorTask_runs_last_keyValueStore_record_post
337+
parameters:
338+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
339+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
340+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
341+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"
342+
294343
deleteById:
295344
<<: [*sharedDelete, *sharedTagById]
296345
summary: Delete record
@@ -336,3 +385,17 @@ deleteLastRun:
336385
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
337386
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
338387
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
388+
389+
deleteTaskLastRun:
390+
<<: [*sharedDelete, *sharedTagTaskLastRun]
391+
summary: Delete last task run's default store's record
392+
description: |
393+
Removes a record specified by a key from the default key-value store of the last Actor task run.
394+
395+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
396+
[Delete record](/api/v2/key-value-store-record-delete) endpoint.
397+
operationId: actorTask_runs_last_keyValueStore_record_delete
398+
parameters:
399+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
400+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
401+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"

apify-api/openapi/components/objects/key-value-stores/key-value-store-records.yaml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ sharedTagLastRun: &sharedTagLastRun
2424
tags:
2525
- Last Actor run's default key-value store
2626

27+
sharedTagTaskLastRun: &sharedTagTaskLastRun
28+
tags:
29+
- Last Actor task run's default key-value store
30+
2731
common200: &common200
2832
"200":
2933
description: A ZIP archive containing the requested records.
@@ -85,6 +89,22 @@ getLastRun:
8589
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixRecords"
8690
- $ref: "../../parameters/storageParameters.yaml#/signature"
8791

92+
getTaskLastRun:
93+
<<: [*sharedGet, *sharedTagTaskLastRun]
94+
summary: Download last task run's default store's records
95+
description: |
96+
Downloads all records from the default key-value store of the last Actor task run as a ZIP archive.
97+
98+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
99+
[Download records](/api/v2/key-value-store-records-get) endpoint.
100+
operationId: actorTask_runs_last_keyValueStore_records_get
101+
parameters:
102+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
103+
- $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
104+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/collectionRecords"
105+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/prefixRecords"
106+
- $ref: "../../parameters/storageParameters.yaml#/signature"
107+
88108
sharedPutPost: &sharedPutPost
89109
requestBody:
90110
description: ""
@@ -241,3 +261,31 @@ postLastRun:
241261
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
242262
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
243263
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"
264+
265+
putTaskLastRun:
266+
<<: [*sharedPutPost, *sharedTagTaskLastRun]
267+
summary: Store record in last task run's default store
268+
description: |
269+
Stores a value under a specific key to the default key-value store of the last Actor task run.
270+
271+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
272+
[PUT record](/api/v2/key-value-store-record-put) endpoint.
273+
operationId: actorTask_runs_last_keyValueStore_records_put
274+
parameters:
275+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
276+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
277+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"
278+
279+
postTaskLastRun:
280+
<<: [*sharedPutPost, *sharedTagTaskLastRun]
281+
summary: Store record in last task run's default store (POST)
282+
description: |
283+
Stores a value under a specific key to the default key-value store of the last Actor task run.
284+
285+
This endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the
286+
[POST record](/api/v2/key-value-store-record-post) endpoint.
287+
operationId: actorTask_runs_last_keyValueStore_records_post
288+
parameters:
289+
- $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
290+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/recordKey"
291+
- $ref: "../../parameters/keyValueStoreParameters.yaml#/Content-Encoding"

0 commit comments

Comments
 (0)