From d1fc846b96b982fb55f88ccf8c2a2d2baf432401 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 9 Jan 2026 15:52:50 +0100 Subject: [PATCH 01/20] Fix OpenApi specs --- .../schemas/actor-builds/BuildStats.yaml | 2 - .../schemas/actor-builds/BuildsMeta.yaml | 1 - .../components/schemas/actor-runs/Run.yaml | 5 +- .../schemas/actor-runs/RunShort.yaml | 1 - .../schemas/actor-runs/RunStats.yaml | 3 + .../components/schemas/actors/Actor.yaml | 1 - .../schemas/actors/ActorDefinition.yaml | 4 - .../components/schemas/actors/ActorStats.yaml | 2 - .../schemas/actors/DefaultRunOptions.yaml | 1 - .../components/schemas/actors/Version.yaml | 2 - .../components/schemas/datasets/Dataset.yaml | 1 - .../key-value-stores/KeyValueStore.yaml | 3 +- .../key-value-stores/KeyValueStoreStats.yaml | 1 - .../key-value-stores/ListOfKeysResponse.yaml | 85 ++++++++++--------- .../GetHeadAndLockResponse.yaml | 2 - .../request-queues/GetHeadResponse.yaml | 2 - .../request-queues/ListRequestsResponse.yaml | 1 - .../request-queues/ProcessedRequest.yaml | 3 - .../schemas/request-queues/RequestQueue.yaml | 20 ++++- .../request-queues/RequestQueueItems.yaml | 2 - .../schemas/request-queues/UserData.yaml | 1 + .../schemas/users/UpdateLimitsRequest.yaml | 7 +- 22 files changed, 72 insertions(+), 78 deletions(-) diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml index 46679b6f17..3e97ffeeeb 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml @@ -1,7 +1,5 @@ title: BuildStats required: - - durationMillis - - runTimeSecs - computeUnits type: object properties: diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml index 43f6244fe3..1e0ea6a554 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml @@ -1,7 +1,6 @@ title: BuildsMeta required: - origin - - clientIp - userAgent type: object properties: diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index c9b5c78c71..e722f3db50 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -4,7 +4,6 @@ required: - actId - userId - startedAt - - finishedAt - status - meta - stats @@ -13,8 +12,6 @@ required: - defaultKeyValueStoreId - defaultDatasetId - defaultRequestQueueId - - buildNumber - - containerUrl - generalAccess type: object properties: @@ -57,7 +54,7 @@ properties: chargedEventCounts: type: object additionalProperties: - $ref: ../actor-pricing-info/ActorChargeEvent.yaml + type: integer options: $ref: ./RunOptions.yaml buildId: diff --git a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml index f9355a3359..2a64cca784 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml @@ -6,7 +6,6 @@ required: - startedAt - finishedAt - buildId - - buildNumber - meta - usageTotalUsd - defaultKeyValueStoreId diff --git a/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml b/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml index 0d93eaa7fd..14beb19b69 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml @@ -11,6 +11,9 @@ properties: migrationCount: type: number example: 0 + rebootCount: + type: number + example: 0 restartCount: type: number example: 0 diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml index 9fab58ec5b..228f33253d 100644 --- a/apify-api/openapi/components/schemas/actors/Actor.yaml +++ b/apify-api/openapi/components/schemas/actors/Actor.yaml @@ -10,7 +10,6 @@ required: - stats - versions - defaultRunOptions - - deploymentKey type: object properties: id: diff --git a/apify-api/openapi/components/schemas/actors/ActorDefinition.yaml b/apify-api/openapi/components/schemas/actors/ActorDefinition.yaml index 1978ecbc15..f9c6f56342 100644 --- a/apify-api/openapi/components/schemas/actors/ActorDefinition.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorDefinition.yaml @@ -60,7 +60,3 @@ properties: usesStandbyMode: type: boolean description: Specifies whether the Actor will have Standby mode enabled. -required: - - actorSpecification - - name - - version diff --git a/apify-api/openapi/components/schemas/actors/ActorStats.yaml b/apify-api/openapi/components/schemas/actors/ActorStats.yaml index 2f2b72d582..868316aee5 100644 --- a/apify-api/openapi/components/schemas/actors/ActorStats.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorStats.yaml @@ -6,8 +6,6 @@ required: - totalUsers7Days - totalUsers30Days - totalUsers90Days - - totalMetamorphs - - lastRunStartedAt type: object properties: totalBuilds: diff --git a/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml b/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml index 7c8efa84dc..d5a4475d20 100644 --- a/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml +++ b/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml @@ -1,7 +1,6 @@ title: defaultRunOptions required: - build - - timeoutSecs - memoryMbytes type: object properties: diff --git a/apify-api/openapi/components/schemas/actors/Version.yaml b/apify-api/openapi/components/schemas/actors/Version.yaml index 355a8114b1..61d112d8a2 100644 --- a/apify-api/openapi/components/schemas/actors/Version.yaml +++ b/apify-api/openapi/components/schemas/actors/Version.yaml @@ -3,7 +3,6 @@ type: object required: - versionNumber - sourceType - - buildTag properties: versionNumber: type: string @@ -27,4 +26,3 @@ properties: example: latest sourceFiles: $ref: ./VersionSourceFiles.yaml - diff --git a/apify-api/openapi/components/schemas/datasets/Dataset.yaml b/apify-api/openapi/components/schemas/datasets/Dataset.yaml index 4a707d71c4..b8a584d928 100644 --- a/apify-api/openapi/components/schemas/datasets/Dataset.yaml +++ b/apify-api/openapi/components/schemas/datasets/Dataset.yaml @@ -1,7 +1,6 @@ title: Dataset required: - id - - name - userId - createdAt - modifiedAt diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml index a9b1bcf0e1..cf41194edb 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml @@ -1,7 +1,6 @@ title: KeyValueStore required: - id - - name - createdAt - modifiedAt - accessedAt @@ -42,7 +41,7 @@ properties: example: null consoleUrl: type: string - example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC' + example: 'https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC' keysPublicUrl: type: string description: "A public link to access keys of the key-value store directly." diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml index e0e2c81cf7..981226e35b 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml @@ -4,7 +4,6 @@ required: - writeCount - deleteCount - listCount - - s3StorageBytes type: object properties: readCount: diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml index 499c927a53..8aa7f97e41 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml @@ -1,44 +1,49 @@ title: ListOfKeysResponse required: - - items - - count - - limit - - isTruncated + - data type: object properties: - items: - type: array - items: - type: object - title: items - required: - - key - - size - - recordPublicUrl - properties: - key: - type: string - example: second-key - size: - type: number - example: 36 - recordPublicUrl: - type: string - description: "A public link to access this record directly." - example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123' - description: '' - count: - type: number - example: 2 - limit: - type: number - example: 2 - exclusiveStartKey: - type: string - example: some-key - isTruncated: - type: boolean - example: true - nextExclusiveStartKey: - type: string - example: third-key + data: + type: object + required: + - items + - count + - limit + - isTruncated + properties: + items: + type: array + items: + type: object + title: items + required: + - key + - size + - recordPublicUrl + properties: + key: + type: string + example: second-key + size: + type: number + example: 36 + recordPublicUrl: + type: string + description: "A public link to access this record directly." + example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123' + description: '' + count: + type: number + example: 2 + limit: + type: number + example: 2 + exclusiveStartKey: + type: string + example: some-key + isTruncated: + type: boolean + example: true + nextExclusiveStartKey: + type: string + example: third-key diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml index 8c458e33d8..2c96a83f30 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml @@ -51,10 +51,8 @@ properties: example: '2022-06-14T23:00:00.000Z' required: - id - - retryCount - uniqueKey - url - - method - lockExpiresAt description: '' required: diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml index 8dac4e1b6e..70fa137890 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml @@ -37,10 +37,8 @@ properties: example: GET required: - id - - retryCount - uniqueKey - url - - method description: '' required: - limit diff --git a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml b/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml index d4f487db87..035c2c683c 100644 --- a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml @@ -22,5 +22,4 @@ properties: example: Ihnsp8YrvJ8102Kj required: - items - - count - limit diff --git a/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml b/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml index 9b3055dd0e..cd14d8f908 100644 --- a/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml @@ -1,9 +1,6 @@ title: ProcessedRequest required: - - requestId - uniqueKey - - wasAlreadyHandled - - wasAlreadyPresent type: object properties: requestId: diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index 402db7a81c..54c8debfc9 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -45,6 +45,24 @@ properties: example: true consoleUrl: type: string - example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC' + example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC' + stats: + type: object + properties: + deleteCount: + type: number + example: 0 + headItemReadCount: + type: number + example: 5 + readCount: + type: number + example: 100 + storageBytes: + type: number + example: 1024 + writeCount: + type: number + example: 10 generalAccess: $ref: ../common/GeneralAccessEnum.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml index c83cfeacea..be0e02839d 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml @@ -1,10 +1,8 @@ title: RequestQueueItems required: - id - - retryCount - uniqueKey - url - - method type: object properties: id: diff --git a/apify-api/openapi/components/schemas/request-queues/UserData.yaml b/apify-api/openapi/components/schemas/request-queues/UserData.yaml index 92c313677a..2d9afbfeb5 100644 --- a/apify-api/openapi/components/schemas/request-queues/UserData.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UserData.yaml @@ -1,5 +1,6 @@ title: UserData type: object +additionalProperties: true properties: label: type: string diff --git a/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml b/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml index 84432d4bbf..d1b7e83b4a 100644 --- a/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml +++ b/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml @@ -5,12 +5,9 @@ properties: type: number example: 300 description: | - If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. - Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges + If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges. dataRetentionDays: type: number example: 90 description: | - Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. - Unnamed storages and other Actor runs are automatically deleted after the retention period. - If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention) + Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention). From 5d55d3662f7844f3f23c53a445b7190a4610af99 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 13 Jan 2026 20:48:02 +0100 Subject: [PATCH 02/20] Update create task --- .../schemas/actor-tasks/CreateTaskResponse.yaml | 10 ++++++++++ apify-api/openapi/paths/actor-tasks/actor-tasks.yaml | 7 +------ 2 files changed, 11 insertions(+), 6 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml diff --git a/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml b/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml new file mode 100644 index 0000000000..d014371389 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml @@ -0,0 +1,10 @@ +title: CreateTaskResponse +type: object +required: + - data +properties: + data: + $ref: ./Task.yaml + standbyUrl: + type: string + nullable: true diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml index c150f2e3e2..5cb55be571 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml @@ -164,12 +164,7 @@ post: content: application/json: schema: - type: object - required: - - data - properties: - data: - $ref: "../../components/schemas/actor-tasks/Task.yaml" + $ref: "../../components/schemas/actor-tasks/CreateTaskResponse.yaml" example: data: id: zdc3Pyhyz3m8vjDeM From 3a3f8b014f30d96fc47939f331c19c86d3ad103b Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 10:13:33 +0100 Subject: [PATCH 03/20] Fix double nesting in get list of keys --- .../GetListOfKeysResponse.yaml | 2 +- .../schemas/key-value-stores/ListOfKeys.yaml | 44 +++++++++++++++++ .../key-value-stores/ListOfKeysResponse.yaml | 49 ------------------- 3 files changed, 45 insertions(+), 50 deletions(-) create mode 100644 apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml delete mode 100644 apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml diff --git a/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeysResponse.yaml b/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeysResponse.yaml index 9617f87f2f..d7e308051c 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeysResponse.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeysResponse.yaml @@ -4,4 +4,4 @@ required: type: object properties: data: - $ref: ./ListOfKeysResponse.yaml + $ref: ./ListOfKeys.yaml diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml new file mode 100644 index 0000000000..a1c4198f21 --- /dev/null +++ b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml @@ -0,0 +1,44 @@ +title: ListOfKeys +type: object +required: + - items + - count + - limit + - isTruncated +properties: + items: + type: array + items: + type: object + title: Item + required: + - key + - size + - recordPublicUrl + properties: + key: + type: string + example: second-key + size: + type: number + example: 36 + recordPublicUrl: + type: string + description: "A public link to access this record directly." + example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123' + description: '' + count: + type: number + example: 2 + limit: + type: number + example: 2 + exclusiveStartKey: + type: string + example: some-key + isTruncated: + type: boolean + example: true + nextExclusiveStartKey: + type: string + example: third-key diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml deleted file mode 100644 index 8aa7f97e41..0000000000 --- a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeysResponse.yaml +++ /dev/null @@ -1,49 +0,0 @@ -title: ListOfKeysResponse -required: - - data -type: object -properties: - data: - type: object - required: - - items - - count - - limit - - isTruncated - properties: - items: - type: array - items: - type: object - title: items - required: - - key - - size - - recordPublicUrl - properties: - key: - type: string - example: second-key - size: - type: number - example: 36 - recordPublicUrl: - type: string - description: "A public link to access this record directly." - example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123' - description: '' - count: - type: number - example: 2 - limit: - type: number - example: 2 - exclusiveStartKey: - type: string - example: some-key - isTruncated: - type: boolean - example: true - nextExclusiveStartKey: - type: string - example: third-key From 96ae163f878a881246c0cc948ada001bd3267a5d Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 11:01:06 +0100 Subject: [PATCH 04/20] Update structure to eliminate Data and Item models --- .../schemas/actor-builds/BuildList.yaml | 11 +++ .../actor-builds/GetBuildListResponse.yaml | 30 +------ .../actor-builds/GetOpenApiResponse.yaml | 84 +------------------ .../RunsResponseSchemaDataProperties.yaml | 84 +++++++++++++++++++ .../actor-runs/GetUserRunsListResponse.yaml | 11 +-- .../schemas/actor-runs/RunList.yaml | 11 +++ .../components/schemas/actors/EnvVarList.yaml | 14 ++++ .../schemas/actors/GetEnvVarListResponse.yaml | 14 +--- .../actors/GetListOfActorsResponse.yaml | 11 +-- .../actors/GetVersionListResponse.yaml | 14 +--- .../schemas/actors/ListOfActors.yaml | 11 +++ .../schemas/actors/VersionList.yaml | 14 ++++ .../DatasetSchemaValidationError.yaml | 52 +----------- .../DatasetSchemaValidationErrorDetails.yaml | 17 ++++ .../schemas/datasets/DatasetStatistics.yaml | 11 +++ .../GetDatasetStatisticsResponse.yaml | 11 +-- .../datasets/GetListOfDatasetsResponse.yaml | 12 +-- .../schemas/datasets/InvalidItem.yaml | 12 +++ .../schemas/datasets/ListOfDatasets.yaml | 11 +++ .../datasets/SchemaValidationErrorData.yaml | 10 +++ .../schemas/datasets/ValidationError.yaml | 18 ++++ .../GetListOfKeyValueStoresResponse.yaml | 13 +-- .../key-value-stores/KeyValueStoreKey.yaml | 17 ++++ .../ListOfKeyValueStores.yaml | 11 +++ .../schemas/key-value-stores/ListOfKeys.yaml | 18 +--- .../BatchOperationResponse.yaml | 14 +--- .../request-queues/BatchOperationResult.yaml | 14 ++++ .../GetHeadAndLockResponse.yaml | 58 +------------ .../request-queues/GetHeadResponse.yaml | 42 +--------- .../GetListOfRequestQueuesResponse.yaml | 30 +------ .../request-queues/ListOfRequestQueues.yaml | 11 +++ .../request-queues/ListOfRequests.yaml | 20 +++++ .../request-queues/ListRequestsResponse.yaml | 20 +---- .../request-queues/LockedQueueHead.yaml | 34 ++++++++ .../request-queues/LockedQueueHeadItem.yaml | 26 ++++++ .../ProlongRequestLockResponse.yaml | 9 +- .../schemas/request-queues/QueueHead.yaml | 22 +++++ .../schemas/request-queues/QueueHeadItem.yaml | 22 +++++ .../request-queues/RequestLockInfo.yaml | 9 ++ .../ListOfWebhookDispatches.yaml | 11 +++ .../WebhookDispatchList.yaml | 18 +--- .../webhooks/GetListOfWebhooksResponse.yaml | 8 +- .../schemas/webhooks/ListOfWebhooks.yaml | 11 +++ 43 files changed, 453 insertions(+), 448 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actor-builds/BuildList.yaml create mode 100644 apify-api/openapi/components/schemas/actor-builds/RunsResponseSchemaDataProperties.yaml create mode 100644 apify-api/openapi/components/schemas/actor-runs/RunList.yaml create mode 100644 apify-api/openapi/components/schemas/actors/EnvVarList.yaml create mode 100644 apify-api/openapi/components/schemas/actors/ListOfActors.yaml create mode 100644 apify-api/openapi/components/schemas/actors/VersionList.yaml create mode 100644 apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationErrorDetails.yaml create mode 100644 apify-api/openapi/components/schemas/datasets/DatasetStatistics.yaml create mode 100644 apify-api/openapi/components/schemas/datasets/InvalidItem.yaml create mode 100644 apify-api/openapi/components/schemas/datasets/ListOfDatasets.yaml create mode 100644 apify-api/openapi/components/schemas/datasets/SchemaValidationErrorData.yaml create mode 100644 apify-api/openapi/components/schemas/datasets/ValidationError.yaml create mode 100644 apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml create mode 100644 apify-api/openapi/components/schemas/key-value-stores/ListOfKeyValueStores.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/QueueHead.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml create mode 100644 apify-api/openapi/components/schemas/webhook-dispatches/ListOfWebhookDispatches.yaml create mode 100644 apify-api/openapi/components/schemas/webhooks/ListOfWebhooks.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildList.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildList.yaml new file mode 100644 index 0000000000..9c4df87be6 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-builds/BuildList.yaml @@ -0,0 +1,11 @@ +title: BuildList +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./BuildShort.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/GetBuildListResponse.yaml b/apify-api/openapi/components/schemas/actor-builds/GetBuildListResponse.yaml index e14e6aed23..4c17b136c7 100644 --- a/apify-api/openapi/components/schemas/actor-builds/GetBuildListResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/GetBuildListResponse.yaml @@ -4,32 +4,4 @@ required: - data properties: data: - type: object - required: - - total - - offset - - limit - - desc - - count - - items - properties: - total: - type: number - example: 2 - offset: - type: number - example: 0 - limit: - type: number - example: 1000 - desc: - type: boolean - example: false - count: - type: number - example: 2 - items: - type: array - items: - $ref: ./BuildShort.yaml - description: '' + $ref: ./BuildList.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml b/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml index a5a159db69..6792dc95a8 100644 --- a/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml @@ -263,86 +263,4 @@ properties: type: object properties: data: - type: object - properties: - type: - type: string - example: object - properties: - type: object - properties: - id: - type: object - properties: - type: - type: string - example: string - actId: - type: object - properties: - type: - type: string - example: string - userId: - type: object - properties: - type: - type: string - example: string - startedAt: - type: object - properties: - type: - type: string - example: string - format: - type: string - example: date-time - example: - type: string - example: '2025-01-08T00:00:00.000Z' - finishedAt: - type: object - properties: - type: - type: string - example: string - format: - type: string - example: date-time - example: - type: string - example: '2025-01-08T00:00:00.000Z' - status: - type: object - properties: - type: - type: string - example: string - example: - type: string - example: 'READY' - meta: - type: object - properties: - type: - type: string - example: object - properties: - type: object - properties: - origin: - type: object - properties: - type: - type: string - example: string - example: - type: string - example: 'API' - userAgent: - type: object - properties: - type: - type: string - example: string + $ref: ./RunsResponseSchemaDataProperties.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/RunsResponseSchemaDataProperties.yaml b/apify-api/openapi/components/schemas/actor-builds/RunsResponseSchemaDataProperties.yaml new file mode 100644 index 0000000000..f1f49dcaea --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-builds/RunsResponseSchemaDataProperties.yaml @@ -0,0 +1,84 @@ +title: RunsResponseSchemaDataProperties +type: object +properties: + type: + type: string + example: object + properties: + type: object + properties: + id: + type: object + properties: + type: + type: string + example: string + actId: + type: object + properties: + type: + type: string + example: string + userId: + type: object + properties: + type: + type: string + example: string + startedAt: + type: object + properties: + type: + type: string + example: string + format: + type: string + example: date-time + example: + type: string + example: '2025-01-08T00:00:00.000Z' + finishedAt: + type: object + properties: + type: + type: string + example: string + format: + type: string + example: date-time + example: + type: string + example: '2025-01-08T00:00:00.000Z' + status: + type: object + properties: + type: + type: string + example: string + example: + type: string + example: 'READY' + meta: + type: object + properties: + type: + type: string + example: object + properties: + type: object + properties: + origin: + type: object + properties: + type: + type: string + example: string + example: + type: string + example: 'API' + userAgent: + type: object + properties: + type: + type: string + example: string diff --git a/apify-api/openapi/components/schemas/actor-runs/GetUserRunsListResponse.yaml b/apify-api/openapi/components/schemas/actor-runs/GetUserRunsListResponse.yaml index ff3721a9b9..f6a7176bcf 100644 --- a/apify-api/openapi/components/schemas/actor-runs/GetUserRunsListResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/GetUserRunsListResponse.yaml @@ -4,13 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: "../common/PaginationResponse.yaml" - - type: object - required: - - items - properties: - items: - type: array - items: - $ref: "../actor-runs/RunShort.yaml" + $ref: ./RunList.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/RunList.yaml b/apify-api/openapi/components/schemas/actor-runs/RunList.yaml new file mode 100644 index 0000000000..28f9f9eb72 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-runs/RunList.yaml @@ -0,0 +1,11 @@ +title: RunList +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./RunShort.yaml diff --git a/apify-api/openapi/components/schemas/actors/EnvVarList.yaml b/apify-api/openapi/components/schemas/actors/EnvVarList.yaml new file mode 100644 index 0000000000..4895a3fb46 --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/EnvVarList.yaml @@ -0,0 +1,14 @@ +title: EnvVarList +type: object +required: + - total + - items +properties: + total: + type: number + example: 5 + items: + type: array + items: + $ref: "./EnvVar.yaml" + description: '' diff --git a/apify-api/openapi/components/schemas/actors/GetEnvVarListResponse.yaml b/apify-api/openapi/components/schemas/actors/GetEnvVarListResponse.yaml index 3553e182e2..2bb16b0ddc 100644 --- a/apify-api/openapi/components/schemas/actors/GetEnvVarListResponse.yaml +++ b/apify-api/openapi/components/schemas/actors/GetEnvVarListResponse.yaml @@ -4,16 +4,4 @@ required: type: object properties: data: - type: object - required: - - total - - items - properties: - total: - type: number - example: 5 - items: - type: array - items: - $ref: "./EnvVar.yaml" - description: '' + $ref: ./EnvVarList.yaml diff --git a/apify-api/openapi/components/schemas/actors/GetListOfActorsResponse.yaml b/apify-api/openapi/components/schemas/actors/GetListOfActorsResponse.yaml index ad1212f9db..1f6e0bac81 100644 --- a/apify-api/openapi/components/schemas/actors/GetListOfActorsResponse.yaml +++ b/apify-api/openapi/components/schemas/actors/GetListOfActorsResponse.yaml @@ -4,13 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: "../common/PaginationResponse.yaml" - - type: object - required: - - items - properties: - items: - type: array - items: - $ref: "./ActorShort.yaml" + $ref: ./ListOfActors.yaml diff --git a/apify-api/openapi/components/schemas/actors/GetVersionListResponse.yaml b/apify-api/openapi/components/schemas/actors/GetVersionListResponse.yaml index 6a639457ac..a11b17aabf 100644 --- a/apify-api/openapi/components/schemas/actors/GetVersionListResponse.yaml +++ b/apify-api/openapi/components/schemas/actors/GetVersionListResponse.yaml @@ -4,16 +4,4 @@ required: type: object properties: data: - type: object - required: - - total - - items - properties: - total: - type: number - example: 5 - items: - type: array - items: - $ref: "./Version.yaml" - description: '' + $ref: ./VersionList.yaml diff --git a/apify-api/openapi/components/schemas/actors/ListOfActors.yaml b/apify-api/openapi/components/schemas/actors/ListOfActors.yaml new file mode 100644 index 0000000000..6956679012 --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/ListOfActors.yaml @@ -0,0 +1,11 @@ +title: ListOfActors +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./ActorShort.yaml diff --git a/apify-api/openapi/components/schemas/actors/VersionList.yaml b/apify-api/openapi/components/schemas/actors/VersionList.yaml new file mode 100644 index 0000000000..030435fe05 --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/VersionList.yaml @@ -0,0 +1,14 @@ +title: VersionList +type: object +required: + - total + - items +properties: + total: + type: number + example: 5 + items: + type: array + items: + $ref: "./Version.yaml" + description: '' diff --git a/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationError.yaml b/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationError.yaml index 0121b99935..ab2bba21b1 100644 --- a/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationError.yaml +++ b/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationError.yaml @@ -1,53 +1,5 @@ +title: DatasetSchemaValidationError type: object properties: error: - type: object - properties: - type: - type: string - description: The type of the error. - example: "schema-validation-error" - message: - type: string - description: A human-readable message describing the error. - example: "Schema validation failed" - data: - type: object - properties: - invalidItems: - type: array - description: A list of invalid items in the received array of items. - items: - type: object - properties: - itemPosition: - type: number - description: The position of the invalid item in the array. - example: 2 - validationErrors: - type: array - description: A complete list of AJV validation error objects for the invalid item. - items: - type: object - properties: - instancePath: - type: string - description: The path to the instance being validated. - schemaPath: - type: string - description: The path to the schema that failed the validation. - keyword: - type: string - description: The validation keyword that caused the error. - message: - type: string - description: A message describing the validation error. - params: - type: object - description: Additional parameters specific to the validation error. - required: - - invalidItems - required: - - type - - message - - data + $ref: ./DatasetSchemaValidationErrorDetails.yaml diff --git a/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationErrorDetails.yaml b/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationErrorDetails.yaml new file mode 100644 index 0000000000..f25fb67e13 --- /dev/null +++ b/apify-api/openapi/components/schemas/datasets/DatasetSchemaValidationErrorDetails.yaml @@ -0,0 +1,17 @@ +title: DatasetSchemaValidationErrorDetails +required: + - type + - message + - data +type: object +properties: + type: + type: string + description: The type of the error. + example: "schema-validation-error" + message: + type: string + description: A human-readable message describing the error. + example: "Schema validation failed" + data: + $ref: ./SchemaValidationErrorData.yaml diff --git a/apify-api/openapi/components/schemas/datasets/DatasetStatistics.yaml b/apify-api/openapi/components/schemas/datasets/DatasetStatistics.yaml new file mode 100644 index 0000000000..49138a812c --- /dev/null +++ b/apify-api/openapi/components/schemas/datasets/DatasetStatistics.yaml @@ -0,0 +1,11 @@ +title: DatasetStatistics +type: object +properties: + fieldStatistics: + type: object + nullable: true + additionalProperties: + $ref: ./DatasetFieldStatistics.yaml + description: 'When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. + This property provides statistics for each field from dataset fields schema. +

See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information.' diff --git a/apify-api/openapi/components/schemas/datasets/GetDatasetStatisticsResponse.yaml b/apify-api/openapi/components/schemas/datasets/GetDatasetStatisticsResponse.yaml index 9a5b675ff6..a9fe88728f 100644 --- a/apify-api/openapi/components/schemas/datasets/GetDatasetStatisticsResponse.yaml +++ b/apify-api/openapi/components/schemas/datasets/GetDatasetStatisticsResponse.yaml @@ -4,13 +4,4 @@ required: type: object properties: data: - type: object - properties: - fieldStatistics: - type: object - nullable: true - additionalProperties: - $ref: ./DatasetFieldStatistics.yaml - description: 'When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. - This property provides statistics for each field from dataset fields schema. -

See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information.' + $ref: ./DatasetStatistics.yaml diff --git a/apify-api/openapi/components/schemas/datasets/GetListOfDatasetsResponse.yaml b/apify-api/openapi/components/schemas/datasets/GetListOfDatasetsResponse.yaml index 64ef8d8666..ca829a1ff0 100644 --- a/apify-api/openapi/components/schemas/datasets/GetListOfDatasetsResponse.yaml +++ b/apify-api/openapi/components/schemas/datasets/GetListOfDatasetsResponse.yaml @@ -4,15 +4,5 @@ required: type: object properties: data: - allOf: - - $ref: ../common/PaginationResponse.yaml - - type: object - required: - - items - properties: - items: - type: array - items: - $ref: ./DatasetListItem.yaml - description: '' + $ref: ./ListOfDatasets.yaml diff --git a/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml b/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml new file mode 100644 index 0000000000..8f75c291b7 --- /dev/null +++ b/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml @@ -0,0 +1,12 @@ +title: InvalidItem +type: object +properties: + itemPosition: + type: number + description: The position of the invalid item in the array. + example: 2 + validationErrors: + type: array + description: A complete list of AJV validation error objects for the invalid item. + items: + $ref: ./ValidationError.yaml diff --git a/apify-api/openapi/components/schemas/datasets/ListOfDatasets.yaml b/apify-api/openapi/components/schemas/datasets/ListOfDatasets.yaml new file mode 100644 index 0000000000..9158b6f120 --- /dev/null +++ b/apify-api/openapi/components/schemas/datasets/ListOfDatasets.yaml @@ -0,0 +1,11 @@ +title: ListOfDatasets +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./DatasetListItem.yaml diff --git a/apify-api/openapi/components/schemas/datasets/SchemaValidationErrorData.yaml b/apify-api/openapi/components/schemas/datasets/SchemaValidationErrorData.yaml new file mode 100644 index 0000000000..3eca2c0a14 --- /dev/null +++ b/apify-api/openapi/components/schemas/datasets/SchemaValidationErrorData.yaml @@ -0,0 +1,10 @@ +title: SchemaValidationErrorData +required: + - invalidItems +type: object +properties: + invalidItems: + type: array + description: A list of invalid items in the received array of items. + items: + $ref: ./InvalidItem.yaml diff --git a/apify-api/openapi/components/schemas/datasets/ValidationError.yaml b/apify-api/openapi/components/schemas/datasets/ValidationError.yaml new file mode 100644 index 0000000000..865d52dcf5 --- /dev/null +++ b/apify-api/openapi/components/schemas/datasets/ValidationError.yaml @@ -0,0 +1,18 @@ +title: ValidationError +type: object +properties: + instancePath: + type: string + description: The path to the instance being validated. + schemaPath: + type: string + description: The path to the schema that failed the validation. + keyword: + type: string + description: The validation keyword that caused the error. + message: + type: string + description: A message describing the validation error. + params: + type: object + description: Additional parameters specific to the validation error. diff --git a/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeyValueStoresResponse.yaml b/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeyValueStoresResponse.yaml index 420066df58..b250cb50bb 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeyValueStoresResponse.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/GetListOfKeyValueStoresResponse.yaml @@ -5,17 +5,8 @@ required: properties: data: allOf: - - $ref: ../common/PaginationResponse.yaml - - type: object - required: - - items - properties: - items: - type: array - items: - $ref: ./KeyValueStore.yaml - description: '' - example: + - $ref: ./ListOfKeyValueStores.yaml + - example: items: - id: WkzbQMuFYuamGv3YF name: d7b9MDYsbtX5L7XAj diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml new file mode 100644 index 0000000000..864360998b --- /dev/null +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml @@ -0,0 +1,17 @@ +title: KeyValueStoreKey +type: object +required: + - key + - size + - recordPublicUrl +properties: + key: + type: string + example: second-key + size: + type: number + example: 36 + recordPublicUrl: + type: string + description: "A public link to access this record directly." + example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123' diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeyValueStores.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeyValueStores.yaml new file mode 100644 index 0000000000..89cd49dfc7 --- /dev/null +++ b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeyValueStores.yaml @@ -0,0 +1,11 @@ +title: ListOfKeyValueStores +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./KeyValueStore.yaml diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml index a1c4198f21..6e23cf19bf 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml @@ -9,23 +9,7 @@ properties: items: type: array items: - type: object - title: Item - required: - - key - - size - - recordPublicUrl - properties: - key: - type: string - example: second-key - size: - type: number - example: 36 - recordPublicUrl: - type: string - description: "A public link to access this record directly." - example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123' + $ref: ./KeyValueStoreKey.yaml description: '' count: type: number diff --git a/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml b/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml index bfb4c17010..8e24dac8b3 100644 --- a/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml @@ -4,16 +4,4 @@ required: type: object properties: data: - type: object - required: - - processedRequests - - unprocessedRequests - properties: - processedRequests: - type: array - items: - $ref: './ProcessedRequest.yaml' - unprocessedRequests: - type: array - items: - $ref: './UnprocessedRequest.yaml' + $ref: './BatchOperationResult.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml b/apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml new file mode 100644 index 0000000000..0b28da4595 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml @@ -0,0 +1,14 @@ +title: BatchOperationResult +type: object +required: + - processedRequests + - unprocessedRequests +properties: + processedRequests: + type: array + items: + $ref: './ProcessedRequest.yaml' + unprocessedRequests: + type: array + items: + $ref: './UnprocessedRequest.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml index 2c96a83f30..ce3fce1f82 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml @@ -4,60 +4,4 @@ required: type: object properties: data: - type: object - properties: - limit: - type: number - example: 1000 - queueModifiedAt: - type: string - description: The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue. - example: '2018-03-14T23:00:00.000Z' - queueHasLockedRequests: - type: boolean - description: Whether the queue contains requests locked by any client (either the one calling the endpoint or a different one). - example: true - clientKey: - type: string - example: client-one - hadMultipleClients: - type: boolean - example: true - lockSecs: - type: number - example: 60 - items: - type: array - items: - type: object - properties: - id: - type: string - example: 8OamqXBCpPHxyj9 - retryCount: - type: number - example: 0 - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET - lockExpiresAt: - type: string - example: '2022-06-14T23:00:00.000Z' - required: - - id - - uniqueKey - - url - - lockExpiresAt - description: '' - required: - - limit - - queueModifiedAt - - hadMultipleClients - - lockSecs - - items + $ref: './LockedQueueHead.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml index 70fa137890..7a1e8162b3 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml @@ -4,44 +4,4 @@ required: type: object properties: data: - type: object - properties: - limit: - type: number - example: 1000 - queueModifiedAt: - type: string - example: '2018-03-14T23:00:00.000Z' - hadMultipleClients: - type: boolean - example: false - items: - type: array - items: - type: object - properties: - id: - type: string - example: 8OamqXBCpPHxyH9 - retryCount: - type: number - example: 0 - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET - required: - - id - - uniqueKey - - url - description: '' - required: - - limit - - queueModifiedAt - - hadMultipleClients - - items + $ref: './QueueHead.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml index 04cfbfd63b..e5d39c073d 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml @@ -4,32 +4,4 @@ required: type: object properties: data: - required: - - total - - offset - - limit - - desc - - count - - items - type: object - properties: - total: - type: number - example: 2 - offset: - type: number - example: 0 - limit: - type: number - example: 1000 - desc: - type: boolean - example: false - count: - type: number - example: 2 - items: - type: array - items: - $ref: ./RequestQueueShort.yaml - description: '' + $ref: ./ListOfRequestQueues.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml b/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml new file mode 100644 index 0000000000..9eeb9b857e --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml @@ -0,0 +1,11 @@ +title: ListOfRequestQueues +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./RequestQueueShort.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml b/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml new file mode 100644 index 0000000000..aee6ee621f --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml @@ -0,0 +1,20 @@ +title: ListOfRequests +type: object +properties: + items: + type: array + items: + $ref: ./RequestQueueItems.yaml + description: '' + count: + type: number + example: 2 + limit: + type: number + example: 2 + exclusiveStartId: + type: string + example: Ihnsp8YrvJ8102Kj +required: + - items + - limit diff --git a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml b/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml index 035c2c683c..e642647d14 100644 --- a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml @@ -4,22 +4,4 @@ required: type: object properties: data: - type: object - properties: - items: - type: array - items: - $ref: ./RequestQueueItems.yaml - description: '' - count: - type: number - example: 2 - limit: - type: number - example: 2 - exclusiveStartId: - type: string - example: Ihnsp8YrvJ8102Kj - required: - - items - - limit + $ref: './ListOfRequests.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml new file mode 100644 index 0000000000..f42fc14fc7 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml @@ -0,0 +1,34 @@ +title: LockedQueueHead +type: object +properties: + limit: + type: number + example: 1000 + queueModifiedAt: + type: string + description: The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue. + example: '2018-03-14T23:00:00.000Z' + queueHasLockedRequests: + type: boolean + description: Whether the queue contains requests locked by any client (either the one calling the endpoint or a different one). + example: true + clientKey: + type: string + example: client-one + hadMultipleClients: + type: boolean + example: true + lockSecs: + type: number + example: 60 + items: + type: array + items: + $ref: './LockedQueueHeadItem.yaml' + description: '' +required: + - limit + - queueModifiedAt + - hadMultipleClients + - lockSecs + - items diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml new file mode 100644 index 0000000000..5a50ff1ab0 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml @@ -0,0 +1,26 @@ +title: LockedQueueHeadItem +type: object +properties: + id: + type: string + example: 8OamqXBCpPHxyj9 + retryCount: + type: number + example: 0 + uniqueKey: + type: string + example: 'http://example.com' + url: + type: string + example: 'http://example.com' + method: + type: string + example: GET + lockExpiresAt: + type: string + example: '2022-06-14T23:00:00.000Z' +required: + - id + - uniqueKey + - url + - lockExpiresAt diff --git a/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml index af45c93d7b..82ce7e9129 100644 --- a/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml @@ -2,11 +2,4 @@ title: ProlongRequestLockResponse type: object properties: data: - type: object - properties: - lockExpiresAt: - type: string - description: Date when lock expires. - example: '2022-01-01T00:00:00.000Z' - required: - - lockExpiresAt + $ref: './RequestLockInfo.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml new file mode 100644 index 0000000000..14aede5ebc --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml @@ -0,0 +1,22 @@ +title: QueueHead +type: object +properties: + limit: + type: number + example: 1000 + queueModifiedAt: + type: string + example: '2018-03-14T23:00:00.000Z' + hadMultipleClients: + type: boolean + example: false + items: + type: array + items: + $ref: './QueueHeadItem.yaml' + description: '' +required: + - limit + - queueModifiedAt + - hadMultipleClients + - items diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml new file mode 100644 index 0000000000..f1b5d9fcbc --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml @@ -0,0 +1,22 @@ +title: QueueHeadItem +type: object +properties: + id: + type: string + example: 8OamqXBCpPHxyH9 + retryCount: + type: number + example: 0 + uniqueKey: + type: string + example: 'http://example.com' + url: + type: string + example: 'http://example.com' + method: + type: string + example: GET +required: + - id + - uniqueKey + - url diff --git a/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml b/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml new file mode 100644 index 0000000000..3b585db361 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml @@ -0,0 +1,9 @@ +title: RequestLockInfo +type: object +properties: + lockExpiresAt: + type: string + description: Date when lock expires. + example: '2022-01-01T00:00:00.000Z' +required: + - lockExpiresAt diff --git a/apify-api/openapi/components/schemas/webhook-dispatches/ListOfWebhookDispatches.yaml b/apify-api/openapi/components/schemas/webhook-dispatches/ListOfWebhookDispatches.yaml new file mode 100644 index 0000000000..8f82d71e43 --- /dev/null +++ b/apify-api/openapi/components/schemas/webhook-dispatches/ListOfWebhookDispatches.yaml @@ -0,0 +1,11 @@ +title: ListOfWebhookDispatches +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./WebhookDispatch.yaml diff --git a/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatchList.yaml b/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatchList.yaml index 3f307c2644..6e368f1f45 100644 --- a/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatchList.yaml +++ b/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatchList.yaml @@ -1,21 +1,5 @@ title: WebhookDispatchList -required: - - total - - offset - - limit - - desc - - count - - items type: object properties: data: - allOf: - - $ref: ../common/PaginationResponse.yaml - - type: object - required: - - items - properties: - items: - type: array - items: - $ref: ./WebhookDispatch.yaml + $ref: ./ListOfWebhookDispatches.yaml diff --git a/apify-api/openapi/components/schemas/webhooks/GetListOfWebhooksResponse.yaml b/apify-api/openapi/components/schemas/webhooks/GetListOfWebhooksResponse.yaml index 0f89d23da7..1ddb054829 100644 --- a/apify-api/openapi/components/schemas/webhooks/GetListOfWebhooksResponse.yaml +++ b/apify-api/openapi/components/schemas/webhooks/GetListOfWebhooksResponse.yaml @@ -4,10 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ../common/PaginationResponse.yaml - - properties: - items: - type: array - items: - $ref: ./WebhookShort.yaml + $ref: ./ListOfWebhooks.yaml diff --git a/apify-api/openapi/components/schemas/webhooks/ListOfWebhooks.yaml b/apify-api/openapi/components/schemas/webhooks/ListOfWebhooks.yaml new file mode 100644 index 0000000000..42b037c415 --- /dev/null +++ b/apify-api/openapi/components/schemas/webhooks/ListOfWebhooks.yaml @@ -0,0 +1,11 @@ +title: ListOfWebhooks +allOf: + - $ref: ../common/PaginationResponse.yaml + - type: object + required: + - items + properties: + items: + type: array + items: + $ref: ./WebhookShort.yaml From 0e8cdf8a6440638f881fc999c19d2c82d8591608 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 12:55:51 +0100 Subject: [PATCH 05/20] Fix get list of Actors --- apify-api/openapi/components/schemas/actors/ActorShort.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/apify-api/openapi/components/schemas/actors/ActorShort.yaml b/apify-api/openapi/components/schemas/actors/ActorShort.yaml index 23f457932c..fffa5e567f 100644 --- a/apify-api/openapi/components/schemas/actors/ActorShort.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorShort.yaml @@ -22,3 +22,8 @@ properties: username: type: string example: janedoe + title: + type: string + example: 'Hello World Example' + stats: + $ref: ./ActorStats.yaml From c37a9f822d4f0b82b49503b82faa402b120e6415 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:03:55 +0100 Subject: [PATCH 06/20] Improve actor-builds schemas --- .../schemas/actor-builds/Build.yaml | 25 ++++++------------- .../schemas/actor-builds/BuildShort.yaml | 4 +-- .../actor-builds/GetBuildResponse.yaml | 4 +-- .../actor-builds/PostAbortBuildResponse.yaml | 4 +-- 4 files changed, 11 insertions(+), 26 deletions(-) diff --git a/apify-api/openapi/components/schemas/actor-builds/Build.yaml b/apify-api/openapi/components/schemas/actor-builds/Build.yaml index 7239247f9b..93be297efd 100644 --- a/apify-api/openapi/components/schemas/actor-builds/Build.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/Build.yaml @@ -31,33 +31,25 @@ properties: meta: $ref: ./BuildsMeta.yaml stats: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./BuildStats.yaml - - {} + - $ref: ./BuildStats.yaml options: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./BuildOptions.yaml - - {} + - $ref: ./BuildOptions.yaml usage: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./BuildUsage.yaml - - {} + - $ref: ./BuildUsage.yaml usageTotalUsd: type: number nullable: true example: 0.02 usageUsd: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./BuildUsage.yaml - - {} + - $ref: ./BuildUsage.yaml inputSchema: type: string nullable: true @@ -138,4 +130,3 @@ example: minMemoryMbytes: 512 maxMemoryMbytes: 2048 usesStandbyMode: false - diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml index e5d4903f9d..f95537a0b3 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml @@ -26,6 +26,4 @@ properties: type: number example: 0.02 meta: - allOf: - - $ref: ./BuildsMeta.yaml - - {} + $ref: ./BuildsMeta.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/GetBuildResponse.yaml b/apify-api/openapi/components/schemas/actor-builds/GetBuildResponse.yaml index e94a5ccea7..bd24e4f6cc 100644 --- a/apify-api/openapi/components/schemas/actor-builds/GetBuildResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/GetBuildResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ./Build.yaml - - {} + $ref: ./Build.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/PostAbortBuildResponse.yaml b/apify-api/openapi/components/schemas/actor-builds/PostAbortBuildResponse.yaml index 496858ec36..74474633ca 100644 --- a/apify-api/openapi/components/schemas/actor-builds/PostAbortBuildResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/PostAbortBuildResponse.yaml @@ -4,9 +4,7 @@ required: type: object properties: data: - allOf: - - $ref: ./Build.yaml - - {} + $ref: ./Build.yaml example: data: id: HG7ML7M8z78YcAPEB From 6466288bc1b31f11fb68c9480104a4cd618bb47c Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:07:56 +0100 Subject: [PATCH 07/20] Improve actor-pricing-info schemas --- .../FlatPricePerMonthActorPricingInfo.yaml | 3 +-- .../schemas/actor-pricing-info/FreeActorPricingInfo.yaml | 3 +-- .../actor-pricing-info/PayPerEventActorPricingInfo.yaml | 3 +-- .../PricePerDatasetItemActorPricingInfo.yaml | 3 +-- .../schemas/actor-pricing-info/PricingModel.yaml | 7 +++++++ 5 files changed, 11 insertions(+), 8 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actor-pricing-info/PricingModel.yaml diff --git a/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml b/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml index f8148cac80..db76e4854a 100644 --- a/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml +++ b/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml @@ -8,8 +8,7 @@ allOf: - trialMinutes properties: pricingModel: - type: string - enum: [FLAT_PRICE_PER_MONTH] + $ref: ./PricingModel.yaml trialMinutes: type: number description: "For how long this Actor can be used for free in trial period" diff --git a/apify-api/openapi/components/schemas/actor-pricing-info/FreeActorPricingInfo.yaml b/apify-api/openapi/components/schemas/actor-pricing-info/FreeActorPricingInfo.yaml index 743bd28a5a..197d6dc098 100644 --- a/apify-api/openapi/components/schemas/actor-pricing-info/FreeActorPricingInfo.yaml +++ b/apify-api/openapi/components/schemas/actor-pricing-info/FreeActorPricingInfo.yaml @@ -6,5 +6,4 @@ allOf: - pricingModel properties: pricingModel: - type: string - enum: [FREE] + $ref: ./PricingModel.yaml diff --git a/apify-api/openapi/components/schemas/actor-pricing-info/PayPerEventActorPricingInfo.yaml b/apify-api/openapi/components/schemas/actor-pricing-info/PayPerEventActorPricingInfo.yaml index 2a733e3b28..dd123424fa 100644 --- a/apify-api/openapi/components/schemas/actor-pricing-info/PayPerEventActorPricingInfo.yaml +++ b/apify-api/openapi/components/schemas/actor-pricing-info/PayPerEventActorPricingInfo.yaml @@ -7,8 +7,7 @@ allOf: - pricingPerEvent properties: pricingModel: - type: string - enum: [PAY_PER_EVENT] + $ref: ./PricingModel.yaml pricingPerEvent: type: object properties: diff --git a/apify-api/openapi/components/schemas/actor-pricing-info/PricePerDatasetItemActorPricingInfo.yaml b/apify-api/openapi/components/schemas/actor-pricing-info/PricePerDatasetItemActorPricingInfo.yaml index 6d5e77fbfc..cf50219ce0 100644 --- a/apify-api/openapi/components/schemas/actor-pricing-info/PricePerDatasetItemActorPricingInfo.yaml +++ b/apify-api/openapi/components/schemas/actor-pricing-info/PricePerDatasetItemActorPricingInfo.yaml @@ -8,8 +8,7 @@ allOf: - unitName properties: pricingModel: - type: string - enum: [PRICE_PER_DATASET_ITEM] + $ref: ./PricingModel.yaml unitName: type: string description: "Name of the unit that is being charged" diff --git a/apify-api/openapi/components/schemas/actor-pricing-info/PricingModel.yaml b/apify-api/openapi/components/schemas/actor-pricing-info/PricingModel.yaml new file mode 100644 index 0000000000..d8092098ae --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-pricing-info/PricingModel.yaml @@ -0,0 +1,7 @@ +title: PricingModel +type: string +enum: + - PAY_PER_EVENT + - PRICE_PER_DATASET_ITEM + - FLAT_PRICE_PER_MONTH + - FREE From 84659ac7e43609c9d6effed78b9ccd0830b2088c Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:11:52 +0100 Subject: [PATCH 08/20] Improve actor-runs schemas --- .../openapi/components/schemas/actor-runs/Run.yaml | 12 ++++-------- .../components/schemas/actor-runs/RunMeta.yaml | 3 +-- .../components/schemas/actor-runs/RunOrigin.yaml | 12 ++++++++++++ .../components/schemas/actor-runs/RunResponse.yaml | 4 +--- .../components/schemas/actor-runs/RunShort.yaml | 4 +--- 5 files changed, 19 insertions(+), 16 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actor-runs/RunOrigin.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index e722f3db50..d5b870697f 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -90,18 +90,14 @@ properties: nullable: true example: master usage: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./RunUsage.yaml - - {} + - $ref: ./RunUsage.yaml usageTotalUsd: type: number nullable: true example: 0.2654 usageUsd: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./RunUsage.yaml - - {} + - $ref: ./RunUsage.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/RunMeta.yaml b/apify-api/openapi/components/schemas/actor-runs/RunMeta.yaml index 916ab0dfb1..5114049965 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunMeta.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunMeta.yaml @@ -4,5 +4,4 @@ required: type: object properties: origin: - type: string - enum: [DEVELOPMENT, WEB, API, SCHEDULER, TEST, WEBHOOK, ACTOR, CLI, STANDBY] + $ref: ./RunOrigin.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/RunOrigin.yaml b/apify-api/openapi/components/schemas/actor-runs/RunOrigin.yaml new file mode 100644 index 0000000000..d74519fa35 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-runs/RunOrigin.yaml @@ -0,0 +1,12 @@ +title: RunOrigin +type: string +enum: + - DEVELOPMENT + - WEB + - API + - SCHEDULER + - TEST + - WEBHOOK + - ACTOR + - CLI + - STANDBY diff --git a/apify-api/openapi/components/schemas/actor-runs/RunResponse.yaml b/apify-api/openapi/components/schemas/actor-runs/RunResponse.yaml index 3887baaf1b..9c255ee6da 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: "./Run.yaml" - - {} + $ref: "./Run.yaml" diff --git a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml index 2a64cca784..1b40cfe2ef 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml @@ -39,9 +39,7 @@ properties: type: string example: 0.0.2 meta: - allOf: - - $ref: ./RunMeta.yaml - - {} + $ref: ./RunMeta.yaml usageTotalUsd: type: number example: 0.2 From c65293320914acfb04d0c05cb563f357202d8ad0 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:13:08 +0100 Subject: [PATCH 09/20] Improve actor-tasks schemas --- .../schemas/actor-tasks/CreateTaskRequest.yaml | 12 ++++-------- .../components/schemas/actor-tasks/Task.yaml | 18 ++++++------------ .../schemas/actor-tasks/TaskShort.yaml | 6 ++---- .../schemas/actor-tasks/UpdateTaskRequest.yaml | 18 ++++++------------ 4 files changed, 18 insertions(+), 36 deletions(-) diff --git a/apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml b/apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml index a79b9e0d6d..80e06b551b 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml @@ -11,14 +11,10 @@ properties: type: string example: my-task options: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskOptions.yaml - - {} + - $ref: ./TaskOptions.yaml input: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskInput.yaml - - {} + - $ref: ./TaskInput.yaml diff --git a/apify-api/openapi/components/schemas/actor-tasks/Task.yaml b/apify-api/openapi/components/schemas/actor-tasks/Task.yaml index 563a11b0dd..a96278008b 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/Task.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/Task.yaml @@ -34,20 +34,14 @@ properties: type: string nullable: true stats: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskStats.yaml - - {} + - $ref: ./TaskStats.yaml options: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskOptions.yaml - - {} + - $ref: ./TaskOptions.yaml input: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskInput.yaml - - {} + - $ref: ./TaskInput.yaml diff --git a/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml b/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml index 7ac6fa6cb5..ac003d9445 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml @@ -39,8 +39,6 @@ properties: type: string example: '2018-10-26T13:30:49.578Z' stats: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskStats.yaml - - {} + - $ref: ./TaskStats.yaml diff --git a/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml b/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml index 772f9b36f6..5934a8236e 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml @@ -34,20 +34,14 @@ properties: type: string nullable: true stats: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskStats.yaml - - {} + - $ref: ./TaskStats.yaml options: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./TaskOptions.yaml - - {} + - $ref: ./TaskOptions.yaml input: + nullable: true allOf: - - oneOf: - - nullable: true - - $ref: ./Task.yaml - - {} + - $ref: ./TaskInput.yaml From 031339ab36fd38c5535ff676300670ddba09a122 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:38:09 +0100 Subject: [PATCH 10/20] Improve actors schemas --- .../components/schemas/actors/Actor.yaml | 8 ++--- .../components/schemas/actors/BuildTag.yaml | 8 +++++ .../schemas/actors/SourceCodeFile.yaml | 19 ++++++++++ .../schemas/actors/SourceCodeFolder.yaml | 14 ++++++++ .../schemas/actors/TaggedBuilds.yaml | 33 +++++++++-------- .../schemas/actors/UpdateActorRequest.yaml | 15 ++++---- .../schemas/actors/VersionSourceFiles.yaml | 36 ++----------------- 7 files changed, 69 insertions(+), 64 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actors/BuildTag.yaml create mode 100644 apify-api/openapi/components/schemas/actors/SourceCodeFile.yaml create mode 100644 apify-api/openapi/components/schemas/actors/SourceCodeFolder.yaml diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml index 228f33253d..0d488e2e34 100644 --- a/apify-api/openapi/components/schemas/actors/Actor.yaml +++ b/apify-api/openapi/components/schemas/actors/Actor.yaml @@ -57,8 +57,8 @@ properties: defaultRunOptions: $ref: ./DefaultRunOptions.yaml exampleRunInput: - oneOf: - - nullable: true + nullable: true + allOf: - $ref: ./ExampleRunInput.yaml isDeprecated: type: boolean @@ -72,6 +72,6 @@ properties: nullable: true example: My Actor taggedBuilds: - oneOf: - - nullable: true + nullable: true + allOf: - $ref: ./TaggedBuilds.yaml diff --git a/apify-api/openapi/components/schemas/actors/BuildTag.yaml b/apify-api/openapi/components/schemas/actors/BuildTag.yaml new file mode 100644 index 0000000000..7ed7f13467 --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/BuildTag.yaml @@ -0,0 +1,8 @@ +title: BuildTag +type: object +nullable: true +required: + - buildId +properties: + buildId: + type: string diff --git a/apify-api/openapi/components/schemas/actors/SourceCodeFile.yaml b/apify-api/openapi/components/schemas/actors/SourceCodeFile.yaml new file mode 100644 index 0000000000..7e9da24a23 --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/SourceCodeFile.yaml @@ -0,0 +1,19 @@ +title: SourceCodeFile +type: object +required: + - format + - content + - name +properties: + format: + type: string + enum: + - BASE64 + - TEXT + example: TEXT + content: + type: string + example: "console.log('This is the main.js file');" + name: + type: string + example: src/main.js diff --git a/apify-api/openapi/components/schemas/actors/SourceCodeFolder.yaml b/apify-api/openapi/components/schemas/actors/SourceCodeFolder.yaml new file mode 100644 index 0000000000..1cbbb1b40a --- /dev/null +++ b/apify-api/openapi/components/schemas/actors/SourceCodeFolder.yaml @@ -0,0 +1,14 @@ +title: SourceCodeFolder +type: object +required: + - name + - folder +properties: + name: + type: string + example: src/placeholder + folder: + type: boolean + enum: + - true + example: true diff --git a/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml b/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml index f6056ac3e9..8405b9ea6d 100644 --- a/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml +++ b/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml @@ -1,20 +1,19 @@ -title: taggedBuilds +title: TaggedBuilds type: object properties: latest: - oneOf: - - nullable: true - - type: object - properties: - buildId: - type: string - nullable: true - example: z2EryhbfhgSyqj6Hn - buildNumber: - type: string - nullable: true - example: 0.0.2 - finishedAt: - type: string - nullable: true - example: '2019-06-10T11:15:49.286Z' + type: object + nullable: true + properties: + buildId: + type: string + nullable: true + example: z2EryhbfhgSyqj6Hn + buildNumber: + type: string + nullable: true + example: 0.0.2 + finishedAt: + type: string + nullable: true + example: '2019-06-10T11:15:49.286Z' diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index aef69f5924..a86839b4ba 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -13,7 +13,8 @@ properties: example: false actorPermissionLevel: nullable: true - $ref: ./ActorPermissionLevel.yaml + allOf: + - $ref: ./ActorPermissionLevel.yaml seoTitle: type: string nullable: true @@ -46,7 +47,9 @@ properties: description: '' nullable: true defaultRunOptions: - $ref: ./DefaultRunOptions.yaml + nullable: true + allOf: + - $ref: ./DefaultRunOptions.yaml taggedBuilds: type: object description: | @@ -90,13 +93,7 @@ properties: ``` nullable: true additionalProperties: - type: object - nullable: true - required: - - buildId - properties: - buildId: - type: string + $ref: ./BuildTag.yaml example: latest: buildId: z2EryhbfhgSyqj6Hn diff --git a/apify-api/openapi/components/schemas/actors/VersionSourceFiles.yaml b/apify-api/openapi/components/schemas/actors/VersionSourceFiles.yaml index 5ee2a4ccd6..c00dfe7139 100644 --- a/apify-api/openapi/components/schemas/actors/VersionSourceFiles.yaml +++ b/apify-api/openapi/components/schemas/actors/VersionSourceFiles.yaml @@ -2,37 +2,5 @@ title: VersionSourceFiles type: "array" items: anyOf: - - type: "object" - title: SourceCodeFile - properties: - format: - type: "string" - enum: - - BASE64 - - TEXT - example: "TEXT" - content: - type: "string" - example: "console.log('This is the main.js file');" - name: - type: "string" - example: "src/main.js" - required: - - "format" - - "content" - - "name" - - type: "object" - title: SourceCodeFolder - properties: - name: - type: "string" - example: "src/placeholder" - folder: - type: boolean - enum: - - true - example: true - required: - - "name" - - "folder" - + - $ref: ./SourceCodeFile.yaml + - $ref: ./SourceCodeFolder.yaml From b7eed2b833d31425aa5b5a0075f556871bb08113 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:39:27 +0100 Subject: [PATCH 11/20] Improve datasets schemas --- .../components/schemas/datasets/PutItemResponseError.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/apify-api/openapi/components/schemas/datasets/PutItemResponseError.yaml b/apify-api/openapi/components/schemas/datasets/PutItemResponseError.yaml index 2f6f30ceba..12f9d267ea 100644 --- a/apify-api/openapi/components/schemas/datasets/PutItemResponseError.yaml +++ b/apify-api/openapi/components/schemas/datasets/PutItemResponseError.yaml @@ -4,6 +4,4 @@ required: type: object properties: error: - allOf: - - $ref: ./DatasetSchemaValidationError.yaml - - {} + $ref: ./DatasetSchemaValidationError.yaml From bc4d98cd85e0a1bd677102ea56278969222cb68c Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 19:42:52 +0100 Subject: [PATCH 12/20] Improve request-queues schemas --- .../request-queues/AddRequestResponse.yaml | 4 +--- .../GetRequestQueueResponse.yaml | 4 +--- .../request-queues/GetRequestResponse.yaml | 4 +--- .../schemas/request-queues/RequestQueue.yaml | 18 +----------------- .../request-queues/RequestQueueItems.yaml | 4 +--- .../request-queues/RequestQueueStats.yaml | 18 ++++++++++++++++++ .../UpdateRequestQueueResponse.yaml | 4 +--- .../request-queues/UpdateRequestResponse.yaml | 4 +--- 8 files changed, 25 insertions(+), 35 deletions(-) create mode 100644 apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml b/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml index cc2d4fa07b..1909522664 100644 --- a/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ./RequestOperationInfo.yaml - - {} + $ref: ./RequestOperationInfo.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml index ed21e8c90a..18b30e46ec 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ./RequestQueue.yaml - - {} + $ref: ./RequestQueue.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml index b115bd9207..ce0d899af8 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ./RequestQueueItems.yaml - - {} + $ref: ./RequestQueueItems.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index 54c8debfc9..e8bee80dcf 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -47,22 +47,6 @@ properties: type: string example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC' stats: - type: object - properties: - deleteCount: - type: number - example: 0 - headItemReadCount: - type: number - example: 5 - readCount: - type: number - example: 100 - storageBytes: - type: number - example: 1024 - writeCount: - type: number - example: 10 + $ref: ./RequestQueueStats.yaml generalAccess: $ref: ../common/GeneralAccessEnum.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml index be0e02839d..02835f2daa 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml @@ -41,9 +41,7 @@ properties: type: object nullable: true userData: - allOf: - - $ref: ./UserData.yaml - - {} + $ref: ./UserData.yaml handledAt: type: string nullable: true diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml new file mode 100644 index 0000000000..9c2bef0649 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml @@ -0,0 +1,18 @@ +title: RequestQueueStats +type: object +properties: + deleteCount: + type: number + example: 0 + headItemReadCount: + type: number + example: 5 + readCount: + type: number + example: 100 + storageBytes: + type: number + example: 1024 + writeCount: + type: number + example: 10 diff --git a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml index 8ea4c06dcf..88bd0f8b43 100644 --- a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ./RequestQueue.yaml - - {} + $ref: ./RequestQueue.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml b/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml index 39e1aa71dd..471930ee2c 100644 --- a/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml @@ -4,6 +4,4 @@ required: type: object properties: data: - allOf: - - $ref: ./RequestOperationInfo.yaml - - {} + $ref: ./RequestOperationInfo.yaml From cae6b4183ac8da16020bf7289ff57e5623766d5e Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 20:04:22 +0100 Subject: [PATCH 13/20] Add missing ActorJobStatus --- .../components/schemas/actor-builds/Build.yaml | 3 +-- .../components/schemas/actor-builds/BuildShort.yaml | 3 +-- .../openapi/components/schemas/actor-runs/Run.yaml | 3 +-- .../components/schemas/actor-runs/RunShort.yaml | 3 +-- .../components/schemas/common/ActorJobStatus.yaml | 12 ++++++++++++ 5 files changed, 16 insertions(+), 8 deletions(-) create mode 100644 apify-api/openapi/components/schemas/common/ActorJobStatus.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/Build.yaml b/apify-api/openapi/components/schemas/actor-builds/Build.yaml index 93be297efd..bc7c3854af 100644 --- a/apify-api/openapi/components/schemas/actor-builds/Build.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/Build.yaml @@ -26,8 +26,7 @@ properties: nullable: true example: '2019-12-12T09:30:12.202Z' status: - type: string - example: SUCCEEDED + $ref: ../common/ActorJobStatus.yaml meta: $ref: ./BuildsMeta.yaml stats: diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml index f95537a0b3..e41aac4cf1 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml @@ -14,8 +14,7 @@ properties: type: string example: janedoe~my-actor status: - type: string - example: SUCCEEDED + $ref: ../common/ActorJobStatus.yaml startedAt: type: string example: '2019-11-30T07:34:24.202Z' diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index d5b870697f..032cdc73a7 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -35,8 +35,7 @@ properties: type: string example: '2019-12-12T09:30:12.202Z' status: - type: string - example: RUNNING + $ref: ../common/ActorJobStatus.yaml statusMessage: type: string nullable: true diff --git a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml index 1b40cfe2ef..315675e784 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml @@ -24,8 +24,7 @@ properties: nullable: true example: KJHSKHausidyaJKHs status: - type: string - example: SUCCEEDED + $ref: ../common/ActorJobStatus.yaml startedAt: type: string example: '2019-11-30T07:34:24.202Z' diff --git a/apify-api/openapi/components/schemas/common/ActorJobStatus.yaml b/apify-api/openapi/components/schemas/common/ActorJobStatus.yaml new file mode 100644 index 0000000000..7bb6c157c3 --- /dev/null +++ b/apify-api/openapi/components/schemas/common/ActorJobStatus.yaml @@ -0,0 +1,12 @@ +title: ActorJobStatus +type: string +enum: + - READY + - RUNNING + - SUCCEEDED + - FAILED + - TIMING-OUT + - TIMED-OUT + - ABORTING + - ABORTED +description: Status of an Actor job (run or build). From c162a73b3e3a002ecbfc207f57ab0f8f6f0d2b16 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Wed, 14 Jan 2026 20:12:50 +0100 Subject: [PATCH 14/20] Add missing WebhookEventType --- .../components/schemas/webhooks/Webhook.yaml | 4 ++-- .../schemas/webhooks/WebhookCreate.yaml | 4 ++-- .../schemas/webhooks/WebhookEventType.yaml | 15 +++++++++++++++ .../components/schemas/webhooks/WebhookShort.yaml | 4 ++-- .../schemas/webhooks/WebhookUpdate.yaml | 4 ++-- 5 files changed, 23 insertions(+), 8 deletions(-) create mode 100644 apify-api/openapi/components/schemas/webhooks/WebhookEventType.yaml diff --git a/apify-api/openapi/components/schemas/webhooks/Webhook.yaml b/apify-api/openapi/components/schemas/webhooks/Webhook.yaml index 47c0fa2b4e..ba63518e56 100644 --- a/apify-api/openapi/components/schemas/webhooks/Webhook.yaml +++ b/apify-api/openapi/components/schemas/webhooks/Webhook.yaml @@ -33,8 +33,8 @@ properties: eventTypes: type: array items: - type: string - example: + $ref: ./WebhookEventType.yaml + examples: - ACTOR.RUN.SUCCEEDED condition: $ref: ./WebhookCondition.yaml diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml index 8774ec0331..746cc74e7b 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml @@ -12,8 +12,8 @@ properties: eventTypes: type: array items: - type: string - example: + $ref: ./WebhookEventType.yaml + examples: - ACTOR.RUN.SUCCEEDED condition: $ref: ./WebhookCondition.yaml diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookEventType.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookEventType.yaml new file mode 100644 index 0000000000..adf8bbcb3d --- /dev/null +++ b/apify-api/openapi/components/schemas/webhooks/WebhookEventType.yaml @@ -0,0 +1,15 @@ +title: WebhookEventType +type: string +enum: + - ACTOR.BUILD.ABORTED + - ACTOR.BUILD.CREATED + - ACTOR.BUILD.FAILED + - ACTOR.BUILD.SUCCEEDED + - ACTOR.BUILD.TIMED_OUT + - ACTOR.RUN.ABORTED + - ACTOR.RUN.CREATED + - ACTOR.RUN.FAILED + - ACTOR.RUN.RESURRECTED + - ACTOR.RUN.SUCCEEDED + - ACTOR.RUN.TIMED_OUT +description: Type of event that triggers the webhook. diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml index 8c184e1024..260ebd9d5e 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml @@ -34,8 +34,8 @@ properties: eventTypes: type: array items: - type: string - example: + $ref: ./WebhookEventType.yaml + examples: - ACTOR.RUN.SUCCEEDED condition: $ref: ./WebhookCondition.yaml diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml index 899ce5970f..22d3c6b1b2 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml @@ -8,10 +8,10 @@ properties: eventTypes: type: array items: - type: string + $ref: ./WebhookEventType.yaml description: '' nullable: true - example: + examples: - ACTOR.RUN.SUCCEEDED condition: nullable: true From 4ce7cfae7e70668cc455d66e76c2a020c7873c93 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 16 Jan 2026 14:14:21 +0100 Subject: [PATCH 15/20] Address feedback --- .../schemas/actor-runs/ChargedEventCounts.yaml | 10 ++++++++++ .../openapi/components/schemas/actor-runs/Run.yaml | 4 +--- .../schemas/actor-tasks/CreateTaskResponse.yaml | 3 --- .../openapi/components/schemas/actor-tasks/Task.yaml | 3 +++ .../openapi/components/schemas/webhooks/Webhook.yaml | 3 +-- .../components/schemas/webhooks/WebhookCreate.yaml | 3 +-- .../components/schemas/webhooks/WebhookShort.yaml | 3 +-- .../components/schemas/webhooks/WebhookUpdate.yaml | 3 +-- 8 files changed, 18 insertions(+), 14 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml b/apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml new file mode 100644 index 0000000000..1bc789e5f6 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml @@ -0,0 +1,10 @@ +title: ChargedEventCounts +type: object +additionalProperties: + type: integer + description: A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run. + minimum: 0 + example: + actor-start: 1 + page-crawled: 150 + data-extracted: 75 diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index 032cdc73a7..d75a6cbc08 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -51,9 +51,7 @@ properties: stats: $ref: ./RunStats.yaml chargedEventCounts: - type: object - additionalProperties: - type: integer + $ref: ./ChargedEventCounts.yaml options: $ref: ./RunOptions.yaml buildId: diff --git a/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml b/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml index d014371389..df1e6970c6 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/CreateTaskResponse.yaml @@ -5,6 +5,3 @@ required: properties: data: $ref: ./Task.yaml - standbyUrl: - type: string - nullable: true diff --git a/apify-api/openapi/components/schemas/actor-tasks/Task.yaml b/apify-api/openapi/components/schemas/actor-tasks/Task.yaml index a96278008b..26455df2bf 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/Task.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/Task.yaml @@ -45,3 +45,6 @@ properties: nullable: true allOf: - $ref: ./TaskInput.yaml + standbyUrl: + type: string + nullable: true diff --git a/apify-api/openapi/components/schemas/webhooks/Webhook.yaml b/apify-api/openapi/components/schemas/webhooks/Webhook.yaml index ba63518e56..7dc0a98e63 100644 --- a/apify-api/openapi/components/schemas/webhooks/Webhook.yaml +++ b/apify-api/openapi/components/schemas/webhooks/Webhook.yaml @@ -34,8 +34,7 @@ properties: type: array items: $ref: ./WebhookEventType.yaml - examples: - - ACTOR.RUN.SUCCEEDED + example: ACTOR.RUN.SUCCEEDED condition: $ref: ./WebhookCondition.yaml ignoreSslErrors: diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml index 746cc74e7b..8530969f7c 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml @@ -13,8 +13,7 @@ properties: type: array items: $ref: ./WebhookEventType.yaml - examples: - - ACTOR.RUN.SUCCEEDED + example: ACTOR.RUN.SUCCEEDED condition: $ref: ./WebhookCondition.yaml idempotencyKey: diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml index 260ebd9d5e..d005d7bdbc 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml @@ -35,8 +35,7 @@ properties: type: array items: $ref: ./WebhookEventType.yaml - examples: - - ACTOR.RUN.SUCCEEDED + example: ACTOR.RUN.SUCCEEDED condition: $ref: ./WebhookCondition.yaml ignoreSslErrors: diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml index 22d3c6b1b2..7be0b073cc 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookUpdate.yaml @@ -11,8 +11,7 @@ properties: $ref: ./WebhookEventType.yaml description: '' nullable: true - examples: - - ACTOR.RUN.SUCCEEDED + example: ACTOR.RUN.SUCCEEDED condition: nullable: true allOf: From 3fac4aef14a8ef24af086711a4a90a6ea739e465 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 16 Jan 2026 19:57:29 +0100 Subject: [PATCH 16/20] Fix --- .../actor-runs/ChargedEventCounts.yaml | 10 ----- .../components/schemas/actor-runs/Run.yaml | 40 ++++++++++++++++++- 2 files changed, 38 insertions(+), 12 deletions(-) delete mode 100644 apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml b/apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml deleted file mode 100644 index 1bc789e5f6..0000000000 --- a/apify-api/openapi/components/schemas/actor-runs/ChargedEventCounts.yaml +++ /dev/null @@ -1,10 +0,0 @@ -title: ChargedEventCounts -type: object -additionalProperties: - type: integer - description: A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run. - minimum: 0 - example: - actor-start: 1 - page-crawled: 150 - data-extracted: 75 diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index d75a6cbc08..6969592314 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -1,4 +1,5 @@ title: Run +description: Represents an Actor run and its associated data. required: - id - actId @@ -18,83 +19,118 @@ properties: id: type: string example: HG7ML7M8z78YcAPEB + description: Unique identifier of the Actor run. actId: type: string example: HDSasDasz78YcAPEB + description: ID of the Actor that was run. userId: type: string example: 7sT5jcggjjA9fNcxF + description: ID of the user who started the run. actorTaskId: type: string nullable: true example: KJHSKHausidyaJKHs + description: ID of the Actor task, if the run was started from a task. startedAt: type: string + format: date-time example: '2019-11-30T07:34:24.202Z' + description: Time when the Actor run started. finishedAt: type: string + format: date-time example: '2019-12-12T09:30:12.202Z' + description: Time when the Actor run finished. status: + description: Current status of the Actor run. $ref: ../common/ActorJobStatus.yaml statusMessage: type: string nullable: true example: Actor is running + description: Detailed message about the run status. isStatusMessageTerminal: type: boolean nullable: true example: false + description: Whether the status message is terminal (final). meta: + description: Metadata about the Actor run. $ref: ./RunMeta.yaml pricingInfo: + description: Pricing information for the Actor. $ref: ../actor-pricing-info/ActorRunPricingInfo.yaml stats: + description: Statistics of the Actor run. $ref: ./RunStats.yaml chargedEventCounts: - $ref: ./ChargedEventCounts.yaml + description: A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run. + type: object + additionalProperties: + type: integer + example: + actor-start: 1 + page-crawled: 150 + data-extracted: 75 options: + description: Configuration options for the Actor run. $ref: ./RunOptions.yaml buildId: type: string example: 7sT5jcggjjA9fNcxF + description: ID of the Actor build used for this run. exitCode: - type: number + type: integer nullable: true example: 0 + description: Exit code of the Actor run process. generalAccess: + description: General access level for the Actor run. $ref: ../common/GeneralAccessEnum.yaml defaultKeyValueStoreId: type: string example: eJNzqsbPiopwJcgGQ + description: ID of the default key-value store for this run. defaultDatasetId: type: string example: wmKPijuyDnPZAPRMk + description: ID of the default dataset for this run. defaultRequestQueueId: type: string example: FL35cSF7jrxr3BY39 + description: ID of the default request queue for this run. buildNumber: type: string example: 0.0.36 + description: Build number of the Actor build used for this run. containerUrl: type: string example: 'https://g8kd8kbc5ge8.runs.apify.net' + description: URL of the container running the Actor. isContainerServerReady: type: boolean nullable: true example: true + description: Whether the container's HTTP server is ready to accept requests. gitBranchName: type: string nullable: true example: master + description: Name of the git branch used for the Actor build. usage: nullable: true + description: Resource usage statistics for the run. allOf: - $ref: ./RunUsage.yaml usageTotalUsd: type: number nullable: true example: 0.2654 + description: Total cost of the run in USD. usageUsd: nullable: true + description: Resource usage costs in USD. allOf: - $ref: ./RunUsage.yaml From d5c7d4fc9594e4b4b9a1a8c645ee8dbe9689b54f Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 16 Jan 2026 20:12:39 +0100 Subject: [PATCH 17/20] Use format date-time for datetime values --- apify-api/openapi/components/schemas/actor-builds/Build.yaml | 2 ++ .../openapi/components/schemas/actor-builds/BuildShort.yaml | 2 ++ apify-api/openapi/components/schemas/actor-runs/RunShort.yaml | 2 ++ apify-api/openapi/components/schemas/actor-tasks/Task.yaml | 3 +++ .../openapi/components/schemas/actor-tasks/TaskShort.yaml | 2 ++ .../components/schemas/actor-tasks/UpdateTaskRequest.yaml | 3 +++ apify-api/openapi/components/schemas/actors/Actor.yaml | 2 ++ apify-api/openapi/components/schemas/actors/ActorShort.yaml | 2 ++ apify-api/openapi/components/schemas/actors/ActorStats.yaml | 1 + apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml | 1 + apify-api/openapi/components/schemas/datasets/Dataset.yaml | 3 +++ .../openapi/components/schemas/datasets/DatasetListItem.yaml | 3 +++ .../components/schemas/key-value-stores/KeyValueStore.yaml | 3 +++ .../components/schemas/request-queues/LockedQueueHead.yaml | 1 + .../schemas/request-queues/LockedQueueHeadItem.yaml | 1 + .../openapi/components/schemas/request-queues/QueueHead.yaml | 1 + .../components/schemas/request-queues/RequestLockInfo.yaml | 1 + .../components/schemas/request-queues/RequestQueue.yaml | 3 +++ .../components/schemas/request-queues/RequestQueueItems.yaml | 1 + .../components/schemas/request-queues/RequestQueueShort.yaml | 4 ++++ .../schedules/GetListOfSchedulesResponseDataItems.yaml | 4 ++++ .../openapi/components/schemas/schedules/ScheduleInvoked.yaml | 1 + .../components/schemas/schedules/ScheduleResponseData.yaml | 4 ++++ .../components/schemas/users/EffectivePlatformFeature.yaml | 1 + .../openapi/components/schemas/users/MonthlyUsageCycle.yaml | 2 ++ apify-api/openapi/components/schemas/users/UsageCycle.yaml | 2 ++ .../openapi/components/schemas/users/UserPrivateInfo.yaml | 1 + .../schemas/webhook-dispatches/WebhookDispatch.yaml | 3 +++ .../components/schemas/webhooks/ExampleWebhookDispatch.yaml | 1 + apify-api/openapi/components/schemas/webhooks/Webhook.yaml | 2 ++ .../openapi/components/schemas/webhooks/WebhookShort.yaml | 2 ++ 31 files changed, 64 insertions(+) diff --git a/apify-api/openapi/components/schemas/actor-builds/Build.yaml b/apify-api/openapi/components/schemas/actor-builds/Build.yaml index bc7c3854af..b7b2b460a1 100644 --- a/apify-api/openapi/components/schemas/actor-builds/Build.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/Build.yaml @@ -20,9 +20,11 @@ properties: example: klmdEpoiojmdEMlk3 startedAt: type: string + format: date-time example: '2019-11-30T07:34:24.202Z' finishedAt: type: string + format: date-time nullable: true example: '2019-12-12T09:30:12.202Z' status: diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml index e41aac4cf1..a6830a0cf4 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildShort.yaml @@ -17,9 +17,11 @@ properties: $ref: ../common/ActorJobStatus.yaml startedAt: type: string + format: date-time example: '2019-11-30T07:34:24.202Z' finishedAt: type: string + format: date-time example: '2019-12-12T09:30:12.202Z' usageTotalUsd: type: number diff --git a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml index 315675e784..0bd2b30294 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunShort.yaml @@ -27,9 +27,11 @@ properties: $ref: ../common/ActorJobStatus.yaml startedAt: type: string + format: date-time example: '2019-11-30T07:34:24.202Z' finishedAt: type: string + format: date-time example: '2019-12-12T09:30:12.202Z' buildId: type: string diff --git a/apify-api/openapi/components/schemas/actor-tasks/Task.yaml b/apify-api/openapi/components/schemas/actor-tasks/Task.yaml index 26455df2bf..55f239d32f 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/Task.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/Task.yaml @@ -26,12 +26,15 @@ properties: example: janedoe createdAt: type: string + format: date-time example: '2018-10-26T07:23:14.855Z' modifiedAt: type: string + format: date-time example: '2018-10-26T13:30:49.578Z' removedAt: type: string + format: date-time nullable: true stats: nullable: true diff --git a/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml b/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml index ac003d9445..eeedd3cc87 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/TaskShort.yaml @@ -34,9 +34,11 @@ properties: example: janedoe createdAt: type: string + format: date-time example: '2018-10-26T07:23:14.855Z' modifiedAt: type: string + format: date-time example: '2018-10-26T13:30:49.578Z' stats: nullable: true diff --git a/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml b/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml index 5934a8236e..0e5a3a971c 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml @@ -26,12 +26,15 @@ properties: example: janedoe createdAt: type: string + format: date-time example: '2018-10-26T07:23:14.855Z' modifiedAt: type: string + format: date-time example: '2018-10-26T13:30:49.578Z' removedAt: type: string + format: date-time nullable: true stats: nullable: true diff --git a/apify-api/openapi/components/schemas/actors/Actor.yaml b/apify-api/openapi/components/schemas/actors/Actor.yaml index 0d488e2e34..e4f3b4879a 100644 --- a/apify-api/openapi/components/schemas/actors/Actor.yaml +++ b/apify-api/openapi/components/schemas/actors/Actor.yaml @@ -39,9 +39,11 @@ properties: $ref: ./ActorPermissionLevel.yaml createdAt: type: string + format: date-time example: '2019-07-08T11:27:57.401Z' modifiedAt: type: string + format: date-time example: '2019-07-08T14:01:05.546Z' stats: $ref: ./ActorStats.yaml diff --git a/apify-api/openapi/components/schemas/actors/ActorShort.yaml b/apify-api/openapi/components/schemas/actors/ActorShort.yaml index fffa5e567f..85c2d70c50 100644 --- a/apify-api/openapi/components/schemas/actors/ActorShort.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorShort.yaml @@ -12,9 +12,11 @@ properties: example: br9CKmk457 createdAt: type: string + format: date-time example: '2019-10-29T07:34:24.202Z' modifiedAt: type: string + format: date-time example: '2019-10-30T07:34:24.202Z' name: type: string diff --git a/apify-api/openapi/components/schemas/actors/ActorStats.yaml b/apify-api/openapi/components/schemas/actors/ActorStats.yaml index 868316aee5..9cd57d04c1 100644 --- a/apify-api/openapi/components/schemas/actors/ActorStats.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorStats.yaml @@ -31,4 +31,5 @@ properties: example: 2 lastRunStartedAt: type: string + format: date-time example: '2019-07-08T14:01:05.546Z' diff --git a/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml b/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml index 8405b9ea6d..79e2ec6998 100644 --- a/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml +++ b/apify-api/openapi/components/schemas/actors/TaggedBuilds.yaml @@ -15,5 +15,6 @@ properties: example: 0.0.2 finishedAt: type: string + format: date-time nullable: true example: '2019-06-10T11:15:49.286Z' diff --git a/apify-api/openapi/components/schemas/datasets/Dataset.yaml b/apify-api/openapi/components/schemas/datasets/Dataset.yaml index b8a584d928..0d22f021a2 100644 --- a/apify-api/openapi/components/schemas/datasets/Dataset.yaml +++ b/apify-api/openapi/components/schemas/datasets/Dataset.yaml @@ -21,12 +21,15 @@ properties: example: wRsJZtadYvn4mBZmm createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' accessedAt: type: string + format: date-time example: '2019-12-14T08:36:13.202Z' itemCount: type: number diff --git a/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml b/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml index 2a5820369e..3b0719bb13 100644 --- a/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml +++ b/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml @@ -21,12 +21,15 @@ properties: example: tbXmWu7GCxnyYtSiL createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' accessedAt: type: string + format: date-time example: '2019-12-14T08:36:13.202Z' itemCount: type: number diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml index cf41194edb..ea7a1e8c0a 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStore.yaml @@ -24,12 +24,15 @@ properties: example: janedoe createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' accessedAt: type: string + format: date-time example: '2019-12-14T08:36:13.202Z' actId: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml index f42fc14fc7..c5053452e1 100644 --- a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml +++ b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml @@ -6,6 +6,7 @@ properties: example: 1000 queueModifiedAt: type: string + format: date-time description: The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue. example: '2018-03-14T23:00:00.000Z' queueHasLockedRequests: diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml index 5a50ff1ab0..de575c28c2 100644 --- a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml +++ b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml @@ -18,6 +18,7 @@ properties: example: GET lockExpiresAt: type: string + format: date-time example: '2022-06-14T23:00:00.000Z' required: - id diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml index 14aede5ebc..f7515612cb 100644 --- a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml +++ b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml @@ -6,6 +6,7 @@ properties: example: 1000 queueModifiedAt: type: string + format: date-time example: '2018-03-14T23:00:00.000Z' hadMultipleClients: type: boolean diff --git a/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml b/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml index 3b585db361..9eb21158e3 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml @@ -3,6 +3,7 @@ type: object properties: lockExpiresAt: type: string + format: date-time description: Date when lock expires. example: '2022-01-01T00:00:00.000Z' required: diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index e8bee80dcf..d1153c069a 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -23,13 +23,16 @@ properties: example: wRsJZtadYvn4mBZmm createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time description: The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue. example: '2030-12-13T08:36:13.202Z' accessedAt: type: string + format: date-time example: '2019-12-14T08:36:13.202Z' totalRequestCount: type: number diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml index 02835f2daa..9d5ecd4274 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml @@ -44,5 +44,6 @@ properties: $ref: ./UserData.yaml handledAt: type: string + format: date-time nullable: true example: '2019-06-16T10:23:31.607Z' diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml index 5128a69927..9076663942 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml @@ -28,15 +28,19 @@ properties: example: janedoe createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' accessedAt: type: string + format: date-time example: '2019-12-14T08:36:13.202Z' expireAt: type: string + format: date-time example: '2019-06-02T17:15:06.751Z' totalRequestCount: type: number diff --git a/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseDataItems.yaml b/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseDataItems.yaml index 1234503de0..ed4a644127 100644 --- a/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseDataItems.yaml +++ b/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseDataItems.yaml @@ -25,15 +25,19 @@ properties: example: my-schedule createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-20T06:33:11.202Z' lastRunAt: type: string + format: date-time example: '2019-04-12T07:33:10.202Z' nextRunAt: type: string + format: date-time example: '2019-04-12T07:34:10.202Z' isEnabled: type: boolean diff --git a/apify-api/openapi/components/schemas/schedules/ScheduleInvoked.yaml b/apify-api/openapi/components/schemas/schedules/ScheduleInvoked.yaml index 8bb1c58fa1..0b4a0da0de 100644 --- a/apify-api/openapi/components/schemas/schedules/ScheduleInvoked.yaml +++ b/apify-api/openapi/components/schemas/schedules/ScheduleInvoked.yaml @@ -13,4 +13,5 @@ properties: example: INFO createdAt: type: string + format: date-time example: '2019-03-26T12:28:00.370Z' diff --git a/apify-api/openapi/components/schemas/schedules/ScheduleResponseData.yaml b/apify-api/openapi/components/schemas/schedules/ScheduleResponseData.yaml index 1254e5b540..a855d22751 100644 --- a/apify-api/openapi/components/schemas/schedules/ScheduleResponseData.yaml +++ b/apify-api/openapi/components/schemas/schedules/ScheduleResponseData.yaml @@ -39,16 +39,20 @@ properties: example: Schedule of actor ... createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-20T06:33:11.202Z' nextRunAt: type: string + format: date-time nullable: true example: '2019-04-12T07:34:10.202Z' lastRunAt: type: string + format: date-time nullable: true example: '2019-04-12T07:33:10.202Z' actions: diff --git a/apify-api/openapi/components/schemas/users/EffectivePlatformFeature.yaml b/apify-api/openapi/components/schemas/users/EffectivePlatformFeature.yaml index cbb3ce41a2..03f8676c96 100644 --- a/apify-api/openapi/components/schemas/users/EffectivePlatformFeature.yaml +++ b/apify-api/openapi/components/schemas/users/EffectivePlatformFeature.yaml @@ -23,5 +23,6 @@ properties: example: false trialExpirationAt: type: string + format: date-time example: "2025-01-01T14:00:00.000Z" nullable: true diff --git a/apify-api/openapi/components/schemas/users/MonthlyUsageCycle.yaml b/apify-api/openapi/components/schemas/users/MonthlyUsageCycle.yaml index e8b3248c00..91218d5a36 100644 --- a/apify-api/openapi/components/schemas/users/MonthlyUsageCycle.yaml +++ b/apify-api/openapi/components/schemas/users/MonthlyUsageCycle.yaml @@ -6,7 +6,9 @@ type: object properties: startAt: type: string + format: date-time example: '2022-10-02T00:00:00.000Z' endAt: type: string + format: date-time example: '2022-11-01T23:59:59.999Z' diff --git a/apify-api/openapi/components/schemas/users/UsageCycle.yaml b/apify-api/openapi/components/schemas/users/UsageCycle.yaml index c8783cf515..0b51daa2bf 100644 --- a/apify-api/openapi/components/schemas/users/UsageCycle.yaml +++ b/apify-api/openapi/components/schemas/users/UsageCycle.yaml @@ -6,7 +6,9 @@ type: object properties: startAt: type: string + format: date-time example: '2022-10-02T00:00:00.000Z' endAt: type: string + format: date-time example: '2022-11-01T23:59:59.999Z' diff --git a/apify-api/openapi/components/schemas/users/UserPrivateInfo.yaml b/apify-api/openapi/components/schemas/users/UserPrivateInfo.yaml index 35b9aa984c..906fb523ee 100644 --- a/apify-api/openapi/components/schemas/users/UserPrivateInfo.yaml +++ b/apify-api/openapi/components/schemas/users/UserPrivateInfo.yaml @@ -30,6 +30,7 @@ properties: $ref: ./EffectivePlatformFeatures.yaml createdAt: type: string + format: date-time example: "2022-11-29T14:48:29.381Z" isPaying: type: boolean diff --git a/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml b/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml index e86ed2feb1..c5947070e7 100644 --- a/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml +++ b/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml @@ -20,6 +20,7 @@ properties: example: asdLZtadYvn4mBZmm createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' status: type: string @@ -46,10 +47,12 @@ properties: properties: startedAt: type: string + format: date-time nullable: true example: '2019-12-12T07:34:14.202Z' finishedAt: type: string + format: date-time nullable: true example: '2019-12-12T07:34:14.202Z' errorMessage: diff --git a/apify-api/openapi/components/schemas/webhooks/ExampleWebhookDispatch.yaml b/apify-api/openapi/components/schemas/webhooks/ExampleWebhookDispatch.yaml index 3507152134..3a811b66b5 100644 --- a/apify-api/openapi/components/schemas/webhooks/ExampleWebhookDispatch.yaml +++ b/apify-api/openapi/components/schemas/webhooks/ExampleWebhookDispatch.yaml @@ -9,4 +9,5 @@ properties: example: SUCCEEDED finishedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' diff --git a/apify-api/openapi/components/schemas/webhooks/Webhook.yaml b/apify-api/openapi/components/schemas/webhooks/Webhook.yaml index 7dc0a98e63..644f845f95 100644 --- a/apify-api/openapi/components/schemas/webhooks/Webhook.yaml +++ b/apify-api/openapi/components/schemas/webhooks/Webhook.yaml @@ -15,9 +15,11 @@ properties: example: YiKoxjkaS9gjGTqhF createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' userId: type: string diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml index d005d7bdbc..91d14b509e 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookShort.yaml @@ -16,9 +16,11 @@ properties: example: YiKoxjkaS9gjGTqhF createdAt: type: string + format: date-time example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string + format: date-time example: '2019-12-13T08:36:13.202Z' userId: type: string From 09713ba4b67491f7a984410a664f98580fa14f52 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 16 Jan 2026 20:49:58 +0100 Subject: [PATCH 18/20] Use integer types for integers --- .../schemas/actor-builds/BuildOptions.yaml | 4 +- .../schemas/actor-builds/BuildStats.yaml | 2 +- .../FlatPricePerMonthActorPricingInfo.yaml | 2 +- .../schemas/actor-runs/ChargeRunRequest.yaml | 2 +- .../components/schemas/actor-runs/Run.yaml | 2 +- .../schemas/actor-runs/RunOptions.yaml | 8 +-- .../schemas/actor-runs/RunStats.yaml | 22 ++++---- .../schemas/actor-runs/RunUsage.yaml | 16 +++--- .../schemas/actor-runs/RunUsageUsd.yaml | 52 +++++++++++++++++++ .../schemas/actor-tasks/TaskOptions.yaml | 4 +- .../schemas/actor-tasks/TaskStats.yaml | 2 +- .../components/schemas/actors/ActorStats.yaml | 14 ++--- .../schemas/actors/DefaultRunOptions.yaml | 4 +- .../components/schemas/actors/EnvVarList.yaml | 2 +- .../schemas/actors/VersionList.yaml | 2 +- .../schemas/common/PaginationResponse.yaml | 8 +-- .../components/schemas/datasets/Dataset.yaml | 4 +- .../datasets/DatasetFieldStatistics.yaml | 4 +- .../schemas/datasets/DatasetListItem.yaml | 4 +- .../schemas/datasets/DatasetStats.yaml | 6 +-- .../schemas/datasets/InvalidItem.yaml | 2 +- .../key-value-stores/KeyValueStoreKey.yaml | 2 +- .../key-value-stores/KeyValueStoreStats.yaml | 10 ++-- .../schemas/key-value-stores/ListOfKeys.yaml | 4 +- .../request-queues/ListOfRequests.yaml | 4 +- .../request-queues/LockedQueueHead.yaml | 4 +- .../request-queues/LockedQueueHeadItem.yaml | 2 +- .../schemas/request-queues/QueueHead.yaml | 2 +- .../schemas/request-queues/QueueHeadItem.yaml | 2 +- .../schemas/request-queues/RequestQueue.yaml | 6 +-- .../request-queues/RequestQueueItems.yaml | 2 +- .../request-queues/RequestQueueShort.yaml | 6 +-- .../request-queues/RequestQueueStats.yaml | 10 ++-- .../GetListOfSchedulesResponseData.yaml | 8 +-- .../schedules/ScheduleActionsRunOptions.yaml | 4 +- .../components/schemas/store/StoreData.yaml | 8 +-- .../schemas/users/AvailableProxyGroups.yaml | 4 +- .../components/schemas/users/Current.yaml | 10 ++-- .../components/schemas/users/Limits.yaml | 12 ++--- .../components/schemas/users/Plan.yaml | 10 ++-- .../components/schemas/users/ProxyGroup.yaml | 2 +- .../schemas/users/UpdateLimitsRequest.yaml | 2 +- .../webhook-dispatches/WebhookDispatch.yaml | 2 +- .../schemas/webhooks/WebhookStats.yaml | 2 +- 44 files changed, 168 insertions(+), 116 deletions(-) create mode 100644 apify-api/openapi/components/schemas/actor-runs/RunUsageUsd.yaml diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildOptions.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildOptions.yaml index 9d950fe119..a10276766c 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildOptions.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildOptions.yaml @@ -10,10 +10,10 @@ properties: nullable: true example: false memoryMbytes: - type: number + type: integer nullable: true example: 1024 diskMbytes: - type: number + type: integer nullable: true example: 2048 diff --git a/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml b/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml index 3e97ffeeeb..d32e742cc1 100644 --- a/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml +++ b/apify-api/openapi/components/schemas/actor-builds/BuildStats.yaml @@ -4,7 +4,7 @@ required: type: object properties: durationMillis: - type: number + type: integer example: 1000 runTimeSecs: type: number diff --git a/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml b/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml index db76e4854a..e0d1c864a4 100644 --- a/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml +++ b/apify-api/openapi/components/schemas/actor-pricing-info/FlatPricePerMonthActorPricingInfo.yaml @@ -10,7 +10,7 @@ allOf: pricingModel: $ref: ./PricingModel.yaml trialMinutes: - type: number + type: integer description: "For how long this Actor can be used for free in trial period" pricePerUnitUsd: type: number diff --git a/apify-api/openapi/components/schemas/actor-runs/ChargeRunRequest.yaml b/apify-api/openapi/components/schemas/actor-runs/ChargeRunRequest.yaml index 744fd295af..0f32d9c472 100644 --- a/apify-api/openapi/components/schemas/actor-runs/ChargeRunRequest.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/ChargeRunRequest.yaml @@ -8,5 +8,5 @@ properties: type: string example: ANALYZE_PAGE count: - type: number + type: integer example: 1 diff --git a/apify-api/openapi/components/schemas/actor-runs/Run.yaml b/apify-api/openapi/components/schemas/actor-runs/Run.yaml index 6969592314..3dcac52c69 100644 --- a/apify-api/openapi/components/schemas/actor-runs/Run.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/Run.yaml @@ -133,4 +133,4 @@ properties: nullable: true description: Resource usage costs in USD. allOf: - - $ref: ./RunUsage.yaml + - $ref: ./RunUsageUsd.yaml diff --git a/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml b/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml index 05db2cb5b3..9396ec05d1 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml @@ -10,16 +10,16 @@ properties: type: string example: latest timeoutSecs: - type: number + type: integer example: 300 memoryMbytes: - type: number + type: integer example: 1024 diskMbytes: - type: number + type: integer example: 2048 maxItems: - type: number + type: integer example: 1000 maxTotalChargeUsd: type: number diff --git a/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml b/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml index 14beb19b69..066807886f 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunStats.yaml @@ -6,28 +6,28 @@ required: type: object properties: inputBodyLen: - type: number + type: integer example: 240 migrationCount: - type: number + type: integer example: 0 rebootCount: - type: number + type: integer example: 0 restartCount: - type: number + type: integer example: 0 resurrectCount: - type: number + type: integer example: 2 memAvgBytes: type: number example: 267874071.9 memMaxBytes: - type: number + type: integer example: 404713472 memCurrentBytes: - type: number + type: integer example: 0 cpuAvgUsage: type: number @@ -39,19 +39,19 @@ properties: type: number example: 0 netRxBytes: - type: number + type: integer example: 103508042 netTxBytes: - type: number + type: integer example: 4854600 durationMillis: - type: number + type: integer example: 248472 runTimeSecs: type: number example: 248.472 metamorph: - type: number + type: integer example: 0 computeUnits: type: number diff --git a/apify-api/openapi/components/schemas/actor-runs/RunUsage.yaml b/apify-api/openapi/components/schemas/actor-runs/RunUsage.yaml index b7b631da01..0a5828c8d5 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunUsage.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunUsage.yaml @@ -6,31 +6,31 @@ properties: nullable: true example: 3 DATASET_READS: - type: number + type: integer nullable: true example: 4 DATASET_WRITES: - type: number + type: integer nullable: true example: 4 KEY_VALUE_STORE_READS: - type: number + type: integer nullable: true example: 5 KEY_VALUE_STORE_WRITES: - type: number + type: integer nullable: true example: 3 KEY_VALUE_STORE_LISTS: - type: number + type: integer nullable: true example: 5 REQUEST_QUEUE_READS: - type: number + type: integer nullable: true example: 2 REQUEST_QUEUE_WRITES: - type: number + type: integer nullable: true example: 1 DATA_TRANSFER_INTERNAL_GBYTES: @@ -46,6 +46,6 @@ properties: nullable: true example: 34 PROXY_SERPS: - type: number + type: integer nullable: true example: 3 diff --git a/apify-api/openapi/components/schemas/actor-runs/RunUsageUsd.yaml b/apify-api/openapi/components/schemas/actor-runs/RunUsageUsd.yaml new file mode 100644 index 0000000000..c387694d05 --- /dev/null +++ b/apify-api/openapi/components/schemas/actor-runs/RunUsageUsd.yaml @@ -0,0 +1,52 @@ +title: RunUsageUsd +description: Resource usage costs in USD. All values are monetary amounts in US dollars. +type: object +properties: + ACTOR_COMPUTE_UNITS: + type: number + nullable: true + example: 0.0003 + DATASET_READS: + type: number + nullable: true + example: 0.0001 + DATASET_WRITES: + type: number + nullable: true + example: 0.0001 + KEY_VALUE_STORE_READS: + type: number + nullable: true + example: 0.0001 + KEY_VALUE_STORE_WRITES: + type: number + nullable: true + example: 0.00005 + KEY_VALUE_STORE_LISTS: + type: number + nullable: true + example: 0.0001 + REQUEST_QUEUE_READS: + type: number + nullable: true + example: 0.0001 + REQUEST_QUEUE_WRITES: + type: number + nullable: true + example: 0.0001 + DATA_TRANSFER_INTERNAL_GBYTES: + type: number + nullable: true + example: 0.001 + DATA_TRANSFER_EXTERNAL_GBYTES?: + type: number + nullable: true + example: 0.003 + PROXY_RESIDENTIAL_TRANSFER_GBYTES: + type: number + nullable: true + example: 0.034 + PROXY_SERPS: + type: number + nullable: true + example: 0.003 diff --git a/apify-api/openapi/components/schemas/actor-tasks/TaskOptions.yaml b/apify-api/openapi/components/schemas/actor-tasks/TaskOptions.yaml index 323b1f5bb3..35fd90e129 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/TaskOptions.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/TaskOptions.yaml @@ -6,11 +6,11 @@ properties: nullable: true example: latest timeoutSecs: - type: number + type: integer nullable: true example: 300 memoryMbytes: - type: number + type: integer nullable: true example: 128 restartOnError: diff --git a/apify-api/openapi/components/schemas/actor-tasks/TaskStats.yaml b/apify-api/openapi/components/schemas/actor-tasks/TaskStats.yaml index 28e78edd3d..11d6903284 100644 --- a/apify-api/openapi/components/schemas/actor-tasks/TaskStats.yaml +++ b/apify-api/openapi/components/schemas/actor-tasks/TaskStats.yaml @@ -4,5 +4,5 @@ required: type: object properties: totalRuns: - type: number + type: integer example: 15 diff --git a/apify-api/openapi/components/schemas/actors/ActorStats.yaml b/apify-api/openapi/components/schemas/actors/ActorStats.yaml index 9cd57d04c1..0f4ec478b4 100644 --- a/apify-api/openapi/components/schemas/actors/ActorStats.yaml +++ b/apify-api/openapi/components/schemas/actors/ActorStats.yaml @@ -9,25 +9,25 @@ required: type: object properties: totalBuilds: - type: number + type: integer example: 9 totalRuns: - type: number + type: integer example: 16 totalUsers: - type: number + type: integer example: 6 totalUsers7Days: - type: number + type: integer example: 2 totalUsers30Days: - type: number + type: integer example: 6 totalUsers90Days: - type: number + type: integer example: 6 totalMetamorphs: - type: number + type: integer example: 2 lastRunStartedAt: type: string diff --git a/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml b/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml index d5a4475d20..42d5300dea 100644 --- a/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml +++ b/apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml @@ -8,10 +8,10 @@ properties: type: string example: latest timeoutSecs: - type: number + type: integer example: 3600 memoryMbytes: - type: number + type: integer example: 2048 restartOnError: type: boolean diff --git a/apify-api/openapi/components/schemas/actors/EnvVarList.yaml b/apify-api/openapi/components/schemas/actors/EnvVarList.yaml index 4895a3fb46..b283acb88c 100644 --- a/apify-api/openapi/components/schemas/actors/EnvVarList.yaml +++ b/apify-api/openapi/components/schemas/actors/EnvVarList.yaml @@ -5,7 +5,7 @@ required: - items properties: total: - type: number + type: integer example: 5 items: type: array diff --git a/apify-api/openapi/components/schemas/actors/VersionList.yaml b/apify-api/openapi/components/schemas/actors/VersionList.yaml index 030435fe05..60b5a6d636 100644 --- a/apify-api/openapi/components/schemas/actors/VersionList.yaml +++ b/apify-api/openapi/components/schemas/actors/VersionList.yaml @@ -5,7 +5,7 @@ required: - items properties: total: - type: number + type: integer example: 5 items: type: array diff --git a/apify-api/openapi/components/schemas/common/PaginationResponse.yaml b/apify-api/openapi/components/schemas/common/PaginationResponse.yaml index d196a912ef..402d283b40 100644 --- a/apify-api/openapi/components/schemas/common/PaginationResponse.yaml +++ b/apify-api/openapi/components/schemas/common/PaginationResponse.yaml @@ -8,17 +8,17 @@ required: type: object properties: total: - type: number + type: integer example: 2 offset: - type: number + type: integer example: 0 limit: - type: number + type: integer example: 1000 desc: type: boolean example: false count: - type: number + type: integer example: 2 diff --git a/apify-api/openapi/components/schemas/datasets/Dataset.yaml b/apify-api/openapi/components/schemas/datasets/Dataset.yaml index 0d22f021a2..c68c88fdfb 100644 --- a/apify-api/openapi/components/schemas/datasets/Dataset.yaml +++ b/apify-api/openapi/components/schemas/datasets/Dataset.yaml @@ -32,10 +32,10 @@ properties: format: date-time example: '2019-12-14T08:36:13.202Z' itemCount: - type: number + type: integer example: 7 cleanItemCount: - type: number + type: integer example: 5 actId: type: string diff --git a/apify-api/openapi/components/schemas/datasets/DatasetFieldStatistics.yaml b/apify-api/openapi/components/schemas/datasets/DatasetFieldStatistics.yaml index 44b0e5dd72..377d073fc2 100644 --- a/apify-api/openapi/components/schemas/datasets/DatasetFieldStatistics.yaml +++ b/apify-api/openapi/components/schemas/datasets/DatasetFieldStatistics.yaml @@ -10,10 +10,10 @@ properties: description: 'Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object.' nullable: true nullCount: - type: number + type: integer description: 'How many items in the dataset have a null value for this field.' nullable: true emptyCount: - type: number + type: integer description: 'How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty.' nullable: true diff --git a/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml b/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml index 3b0719bb13..f86b456f66 100644 --- a/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml +++ b/apify-api/openapi/components/schemas/datasets/DatasetListItem.yaml @@ -32,10 +32,10 @@ properties: format: date-time example: '2019-12-14T08:36:13.202Z' itemCount: - type: number + type: integer example: 7 cleanItemCount: - type: number + type: integer example: 5 actId: type: string diff --git a/apify-api/openapi/components/schemas/datasets/DatasetStats.yaml b/apify-api/openapi/components/schemas/datasets/DatasetStats.yaml index a70755971e..440b1094cb 100644 --- a/apify-api/openapi/components/schemas/datasets/DatasetStats.yaml +++ b/apify-api/openapi/components/schemas/datasets/DatasetStats.yaml @@ -6,11 +6,11 @@ required: type: object properties: readCount: - type: number + type: integer example: 22 writeCount: - type: number + type: integer example: 3 storageBytes: - type: number + type: integer example: 783 \ No newline at end of file diff --git a/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml b/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml index 8f75c291b7..e85b624ffc 100644 --- a/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml +++ b/apify-api/openapi/components/schemas/datasets/InvalidItem.yaml @@ -2,7 +2,7 @@ title: InvalidItem type: object properties: itemPosition: - type: number + type: integer description: The position of the invalid item in the array. example: 2 validationErrors: diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml index 864360998b..dba5d7c152 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreKey.yaml @@ -9,7 +9,7 @@ properties: type: string example: second-key size: - type: number + type: integer example: 36 recordPublicUrl: type: string diff --git a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml index 981226e35b..48aa9cd573 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml @@ -7,17 +7,17 @@ required: type: object properties: readCount: - type: number + type: integer example: 9 writeCount: - type: number + type: integer example: 3 deleteCount: - type: number + type: integer example: 6 listCount: - type: number + type: integer example: 2 s3StorageBytes: - type: number + type: integer example: 18 diff --git a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml index 6e23cf19bf..4e4e8a81b2 100644 --- a/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml +++ b/apify-api/openapi/components/schemas/key-value-stores/ListOfKeys.yaml @@ -12,10 +12,10 @@ properties: $ref: ./KeyValueStoreKey.yaml description: '' count: - type: number + type: integer example: 2 limit: - type: number + type: integer example: 2 exclusiveStartKey: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml b/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml index aee6ee621f..75392956fe 100644 --- a/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml @@ -7,10 +7,10 @@ properties: $ref: ./RequestQueueItems.yaml description: '' count: - type: number + type: integer example: 2 limit: - type: number + type: integer example: 2 exclusiveStartId: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml index c5053452e1..81f1e05317 100644 --- a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml +++ b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml @@ -2,7 +2,7 @@ title: LockedQueueHead type: object properties: limit: - type: number + type: integer example: 1000 queueModifiedAt: type: string @@ -20,7 +20,7 @@ properties: type: boolean example: true lockSecs: - type: number + type: integer example: 60 items: type: array diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml index de575c28c2..1108bb6f9a 100644 --- a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml +++ b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml @@ -5,7 +5,7 @@ properties: type: string example: 8OamqXBCpPHxyj9 retryCount: - type: number + type: integer example: 0 uniqueKey: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml index f7515612cb..7d9a555869 100644 --- a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml +++ b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml @@ -2,7 +2,7 @@ title: QueueHead type: object properties: limit: - type: number + type: integer example: 1000 queueModifiedAt: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml index f1b5d9fcbc..c29ca2ed3b 100644 --- a/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml +++ b/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml @@ -5,7 +5,7 @@ properties: type: string example: 8OamqXBCpPHxyH9 retryCount: - type: number + type: integer example: 0 uniqueKey: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index d1153c069a..437f1f0a4d 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -35,13 +35,13 @@ properties: format: date-time example: '2019-12-14T08:36:13.202Z' totalRequestCount: - type: number + type: integer example: 870 handledRequestCount: - type: number + type: integer example: 100 pendingRequestCount: - type: number + type: integer example: 670 hadMultipleClients: type: boolean diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml index 9d5ecd4274..684c17f7a1 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml @@ -9,7 +9,7 @@ properties: type: string example: dnjkDMKLmdlkmlkmld retryCount: - type: number + type: integer example: 0 uniqueKey: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml index 9076663942..8c4ac0d605 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml @@ -43,13 +43,13 @@ properties: format: date-time example: '2019-06-02T17:15:06.751Z' totalRequestCount: - type: number + type: integer example: 100 handledRequestCount: - type: number + type: integer example: 50 pendingRequestCount: - type: number + type: integer example: 50 actId: type: string diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml index 9c2bef0649..7f6f16305e 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml @@ -2,17 +2,17 @@ title: RequestQueueStats type: object properties: deleteCount: - type: number + type: integer example: 0 headItemReadCount: - type: number + type: integer example: 5 readCount: - type: number + type: integer example: 100 storageBytes: - type: number + type: integer example: 1024 writeCount: - type: number + type: integer example: 10 diff --git a/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseData.yaml b/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseData.yaml index c2d7d9f0ab..989e7ebf03 100644 --- a/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseData.yaml +++ b/apify-api/openapi/components/schemas/schedules/GetListOfSchedulesResponseData.yaml @@ -9,19 +9,19 @@ required: type: object properties: total: - type: number + type: integer example: 2 offset: - type: number + type: integer example: 0 limit: - type: number + type: integer example: 1000 desc: type: boolean example: false count: - type: number + type: integer example: 2 items: type: array diff --git a/apify-api/openapi/components/schemas/schedules/ScheduleActionsRunOptions.yaml b/apify-api/openapi/components/schemas/schedules/ScheduleActionsRunOptions.yaml index b63f294a1b..01a881ae15 100644 --- a/apify-api/openapi/components/schemas/schedules/ScheduleActionsRunOptions.yaml +++ b/apify-api/openapi/components/schemas/schedules/ScheduleActionsRunOptions.yaml @@ -6,11 +6,11 @@ properties: nullable: true example: latest timeoutSecs: - type: number + type: integer nullable: true example: 60 memoryMbytes: - type: number + type: integer nullable: true example: 1024 restartOnError: diff --git a/apify-api/openapi/components/schemas/store/StoreData.yaml b/apify-api/openapi/components/schemas/store/StoreData.yaml index 664032bf2d..25ca951e22 100644 --- a/apify-api/openapi/components/schemas/store/StoreData.yaml +++ b/apify-api/openapi/components/schemas/store/StoreData.yaml @@ -9,19 +9,19 @@ required: type: object properties: total: - type: number + type: integer example: 100 offset: - type: number + type: integer example: 0 limit: - type: number + type: integer example: 1000 desc: type: boolean example: false count: - type: number + type: integer example: 1 items: type: array diff --git a/apify-api/openapi/components/schemas/users/AvailableProxyGroups.yaml b/apify-api/openapi/components/schemas/users/AvailableProxyGroups.yaml index 3328961f31..6c496b8f0c 100644 --- a/apify-api/openapi/components/schemas/users/AvailableProxyGroups.yaml +++ b/apify-api/openapi/components/schemas/users/AvailableProxyGroups.yaml @@ -5,8 +5,8 @@ required: type: object properties: SOMEGROUP: - type: number + type: integer example: 20 ANOTHERGROUP: - type: number + type: integer example: 200 diff --git a/apify-api/openapi/components/schemas/users/Current.yaml b/apify-api/openapi/components/schemas/users/Current.yaml index 5ed1fe3aa1..2ec167f1fe 100644 --- a/apify-api/openapi/components/schemas/users/Current.yaml +++ b/apify-api/openapi/components/schemas/users/Current.yaml @@ -22,7 +22,7 @@ properties: type: number example: 3.00861903931946 monthlyProxySerps: - type: number + type: integer example: 34 monthlyResidentialProxyGbytes: type: number @@ -31,14 +31,14 @@ properties: type: number example: 8 actorCount: - type: number + type: integer example: 31 actorTaskCount: - type: number + type: integer example: 130 activeActorJobCount: - type: number + type: integer example: 0 teamAccountSeatCount: - type: number + type: integer example: 5 diff --git a/apify-api/openapi/components/schemas/users/Limits.yaml b/apify-api/openapi/components/schemas/users/Limits.yaml index 198fe442f1..6140650251 100644 --- a/apify-api/openapi/components/schemas/users/Limits.yaml +++ b/apify-api/openapi/components/schemas/users/Limits.yaml @@ -23,7 +23,7 @@ properties: type: number example: 7 maxMonthlyProxySerps: - type: number + type: integer example: 50 maxMonthlyResidentialProxyGbytes: type: number @@ -32,17 +32,17 @@ properties: type: number example: 16 maxActorCount: - type: number + type: integer example: 100 maxActorTaskCount: - type: number + type: integer example: 1000 maxConcurrentActorJobs: - type: number + type: integer example: 256 maxTeamAccountSeatCount: - type: number + type: integer example: 9 dataRetentionDays: - type: number + type: integer example: 90 diff --git a/apify-api/openapi/components/schemas/users/Plan.yaml b/apify-api/openapi/components/schemas/users/Plan.yaml index 091910dc0e..66d1c13508 100644 --- a/apify-api/openapi/components/schemas/users/Plan.yaml +++ b/apify-api/openapi/components/schemas/users/Plan.yaml @@ -64,24 +64,24 @@ properties: type: number example: 10 maxMonthlyProxySerps: - type: number + type: integer example: 30000 maxMonthlyExternalDataTransferGbytes: type: number example: 1000 maxActorCount: - type: number + type: integer example: 100 maxActorTaskCount: - type: number + type: integer example: 1000 dataRetentionDays: - type: number + type: integer example: 14 availableProxyGroups: $ref: ./AvailableProxyGroups.yaml teamAccountSeatCount: - type: number + type: integer example: 1 supportLevel: type: string diff --git a/apify-api/openapi/components/schemas/users/ProxyGroup.yaml b/apify-api/openapi/components/schemas/users/ProxyGroup.yaml index 9c6fbdec2f..7890f3e1c5 100644 --- a/apify-api/openapi/components/schemas/users/ProxyGroup.yaml +++ b/apify-api/openapi/components/schemas/users/ProxyGroup.yaml @@ -12,5 +12,5 @@ properties: type: string example: Group1 description availableCount: - type: number + type: integer example: 10 diff --git a/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml b/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml index d1b7e83b4a..c1974bee51 100644 --- a/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml +++ b/apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml @@ -7,7 +7,7 @@ properties: description: | If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges. dataRetentionDays: - type: number + type: integer example: 90 description: | Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention). diff --git a/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml b/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml index c5947070e7..856925ddb4 100644 --- a/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml +++ b/apify-api/openapi/components/schemas/webhook-dispatches/WebhookDispatch.yaml @@ -60,7 +60,7 @@ properties: nullable: true example: Cannot send request responseStatus: - type: number + type: integer nullable: true example: 200 responseBody: diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookStats.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookStats.yaml index 338ed55a00..030262c4af 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookStats.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookStats.yaml @@ -4,5 +4,5 @@ required: type: object properties: totalDispatches: - type: number + type: integer example: 1 From 31ce1c8a9cc02e87c4bc1f9faabd54d3fe3feb29 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Mon, 19 Jan 2026 11:38:47 +0100 Subject: [PATCH 19/20] Better RQ and request models --- .../request-queues/AddRequestResponse.yaml | 3 +- .../schemas/request-queues/AddedRequest.yaml | 25 ++++++++ .../request-queues/BatchAddResponse.yaml | 8 +++ .../request-queues/BatchAddResult.yaml | 17 ++++++ .../request-queues/BatchDeleteResponse.yaml | 8 +++ .../request-queues/BatchDeleteResult.yaml | 17 ++++++ .../BatchOperationResponse.yaml | 7 --- .../request-queues/BatchOperationResult.yaml | 14 ----- .../CreateRequestQueueResponse.yaml | 1 + .../request-queues/DeletedRequest.yaml | 14 +++++ .../GetHeadAndLockResponse.yaml | 3 +- .../request-queues/GetHeadResponse.yaml | 3 +- .../GetListOfRequestQueuesResponse.yaml | 1 + .../GetListOfRequestsResponse.yaml | 8 +++ .../GetRequestQueueResponse.yaml | 1 + .../request-queues/GetRequestResponse.yaml | 3 +- .../schemas/request-queues/HeadRequest.yaml | 28 +++++++++ .../request-queues/ListOfRequestQueues.yaml | 2 + .../request-queues/ListOfRequests.yaml | 14 +++-- .../request-queues/ListRequestsResponse.yaml | 7 --- .../request-queues/LockedHeadRequest.yaml | 34 +++++++++++ .../request-queues/LockedQueueHead.yaml | 35 ----------- .../request-queues/LockedQueueHeadItem.yaml | 27 --------- .../LockedRequestQueueHead.yaml | 40 +++++++++++++ .../request-queues/ProcessedRequest.yaml | 17 ------ .../ProlongRequestLockResponse.yaml | 5 +- .../schemas/request-queues/QueueHead.yaml | 23 ------- .../schemas/request-queues/QueueHeadItem.yaml | 22 ------- .../schemas/request-queues/Request.yaml | 60 +++++++++++++++++++ .../schemas/request-queues/RequestDraft.yaml | 20 +++++++ .../request-queues/RequestLockInfo.yaml | 7 ++- .../request-queues/RequestOperationInfo.yaml | 16 ----- .../schemas/request-queues/RequestQueue.yaml | 15 ++++- .../request-queues/RequestQueueHead.yaml | 27 +++++++++ .../request-queues/RequestQueueItems.yaml | 49 --------------- .../request-queues/RequestQueueShort.yaml | 15 +++++ .../request-queues/RequestQueueStats.yaml | 6 ++ .../request-queues/RequestRegistration.yaml | 20 +++++++ .../request-queues/RequestUserData.yaml | 15 +++++ .../request-queues/RequestWithoutId.yaml | 16 ----- .../UnlockRequestsResponse.yaml | 8 +++ .../request-queues/UnlockRequestsResult.yaml | 10 ++++ .../request-queues/UnprocessedRequest.yaml | 16 ----- .../UpdateRequestQueueRequest.yaml | 2 + .../UpdateRequestQueueResponse.yaml | 1 + .../request-queues/UpdateRequestResponse.yaml | 3 +- .../schemas/request-queues/UserData.yaml | 12 ---- .../request-queues@{queueId}@requests.yaml | 4 +- ...quest-queues@{queueId}@requests@batch.yaml | 11 ++-- ...uest-queues@{queueId}@requests@unlock.yaml | 13 +--- ...queues@{queueId}@requests@{requestId}.yaml | 2 +- 51 files changed, 436 insertions(+), 299 deletions(-) create mode 100644 apify-api/openapi/components/schemas/request-queues/AddedRequest.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/BatchAddResponse.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/BatchAddResult.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/BatchDeleteResponse.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/BatchDeleteResult.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/DeletedRequest.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/GetListOfRequestsResponse.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/HeadRequest.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/LockedHeadRequest.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/LockedRequestQueueHead.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/QueueHead.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/Request.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/RequestDraft.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/RequestOperationInfo.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/RequestQueueHead.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/RequestRegistration.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/RequestUserData.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/RequestWithoutId.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/UnlockRequestsResponse.yaml create mode 100644 apify-api/openapi/components/schemas/request-queues/UnlockRequestsResult.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/UnprocessedRequest.yaml delete mode 100644 apify-api/openapi/components/schemas/request-queues/UserData.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml b/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml index 1909522664..7f61e42ea1 100644 --- a/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/AddRequestResponse.yaml @@ -1,7 +1,8 @@ title: AddRequestResponse +description: Response containing the result of adding a request to the request queue. required: - data type: object properties: data: - $ref: ./RequestOperationInfo.yaml + $ref: ./RequestRegistration.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/AddedRequest.yaml b/apify-api/openapi/components/schemas/request-queues/AddedRequest.yaml new file mode 100644 index 0000000000..382b5859db --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/AddedRequest.yaml @@ -0,0 +1,25 @@ +title: AddedRequest +description: Information about a request that was successfully added to a request queue. +required: + - requestId + - uniqueKey + - wasAlreadyHandled + - wasAlreadyPresent +type: object +properties: + requestId: + type: string + description: A unique identifier assigned to the request. + example: sbJ7klsdf7ujN9l + uniqueKey: + type: string + description: A unique key used for request de-duplication. Requests with the same unique key are considered identical. + example: GET|60d83e70|e3b0c442|https://apify.com + wasAlreadyPresent: + type: boolean + description: Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created. + example: false + wasAlreadyHandled: + type: boolean + description: Indicates whether a request with the same unique key has already been processed by the request queue. + example: false diff --git a/apify-api/openapi/components/schemas/request-queues/BatchAddResponse.yaml b/apify-api/openapi/components/schemas/request-queues/BatchAddResponse.yaml new file mode 100644 index 0000000000..713f1cb1bc --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/BatchAddResponse.yaml @@ -0,0 +1,8 @@ +title: BatchAddResponse +description: Response containing the result of a batch add operation. +required: + - data +type: object +properties: + data: + $ref: ./BatchAddResult.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/BatchAddResult.yaml b/apify-api/openapi/components/schemas/request-queues/BatchAddResult.yaml new file mode 100644 index 0000000000..63ca5f01e2 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/BatchAddResult.yaml @@ -0,0 +1,17 @@ +title: BatchAddResult +description: Result of a batch add operation containing successfully processed and failed requests. +type: object +required: + - processedRequests + - unprocessedRequests +properties: + processedRequests: + type: array + description: Requests that were successfully added to the request queue. + items: + $ref: ./AddedRequest.yaml + unprocessedRequests: + type: array + description: Requests that failed to be added and can be retried. + items: + $ref: ./RequestDraft.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/BatchDeleteResponse.yaml b/apify-api/openapi/components/schemas/request-queues/BatchDeleteResponse.yaml new file mode 100644 index 0000000000..940f071d4a --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/BatchDeleteResponse.yaml @@ -0,0 +1,8 @@ +title: BatchDeleteResponse +description: Response containing the result of a batch delete operation. +required: + - data +type: object +properties: + data: + $ref: ./BatchDeleteResult.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/BatchDeleteResult.yaml b/apify-api/openapi/components/schemas/request-queues/BatchDeleteResult.yaml new file mode 100644 index 0000000000..aaed612c50 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/BatchDeleteResult.yaml @@ -0,0 +1,17 @@ +title: BatchDeleteResult +description: Result of a batch delete operation containing successfully deleted and failed requests. +type: object +required: + - processedRequests + - unprocessedRequests +properties: + processedRequests: + type: array + description: Requests that were successfully deleted from the request queue. + items: + $ref: ./DeletedRequest.yaml + unprocessedRequests: + type: array + description: Requests that failed to be deleted and can be retried. + items: + $ref: ./RequestDraft.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml b/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml deleted file mode 100644 index 8e24dac8b3..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/BatchOperationResponse.yaml +++ /dev/null @@ -1,7 +0,0 @@ -title: BatchOperationResponse -required: - - data -type: object -properties: - data: - $ref: './BatchOperationResult.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml b/apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml deleted file mode 100644 index 0b28da4595..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/BatchOperationResult.yaml +++ /dev/null @@ -1,14 +0,0 @@ -title: BatchOperationResult -type: object -required: - - processedRequests - - unprocessedRequests -properties: - processedRequests: - type: array - items: - $ref: './ProcessedRequest.yaml' - unprocessedRequests: - type: array - items: - $ref: './UnprocessedRequest.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/CreateRequestQueueResponse.yaml b/apify-api/openapi/components/schemas/request-queues/CreateRequestQueueResponse.yaml index e069a74fe2..a6b7fa964a 100644 --- a/apify-api/openapi/components/schemas/request-queues/CreateRequestQueueResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/CreateRequestQueueResponse.yaml @@ -1,4 +1,5 @@ title: CreateRequestQueueResponse +description: Response containing the created request queue. required: - data type: object diff --git a/apify-api/openapi/components/schemas/request-queues/DeletedRequest.yaml b/apify-api/openapi/components/schemas/request-queues/DeletedRequest.yaml new file mode 100644 index 0000000000..77e95714fd --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/DeletedRequest.yaml @@ -0,0 +1,14 @@ +title: DeletedRequest +description: Confirmation of a request that was successfully deleted from a request queue. +required: + - uniqueKey +type: object +properties: + uniqueKey: + type: string + description: A unique key used for request de-duplication. Requests with the same unique key are considered identical. + example: GET|60d83e70|e3b0c442|https://apify.com + id: + type: string + description: A unique identifier assigned to the request. + example: sbJ7klsdf7ujN9l diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml index ce3fce1f82..eaac26e0e3 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml @@ -1,7 +1,8 @@ title: GetHeadAndLockResponse +description: Response containing locked requests from the request queue head. required: - data type: object properties: data: - $ref: './LockedQueueHead.yaml' + $ref: ./LockedRequestQueueHead.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml index 7a1e8162b3..af013c62ce 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadResponse.yaml @@ -1,7 +1,8 @@ title: GetHeadResponse +description: Response containing requests from the request queue head without locking. required: - data type: object properties: data: - $ref: './QueueHead.yaml' + $ref: ./RequestQueueHead.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml index e5d39c073d..5fd237052b 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetListOfRequestQueuesResponse.yaml @@ -1,4 +1,5 @@ title: GetListOfRequestQueuesResponse +description: Response containing a list of request queues. required: - data type: object diff --git a/apify-api/openapi/components/schemas/request-queues/GetListOfRequestsResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetListOfRequestsResponse.yaml new file mode 100644 index 0000000000..8a1c848bdd --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/GetListOfRequestsResponse.yaml @@ -0,0 +1,8 @@ +title: GetListOfRequestsResponse +description: Response containing a list of requests from the request queue. +required: + - data +type: object +properties: + data: + $ref: ./ListOfRequests.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml index 18b30e46ec..5609fa8ab9 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetRequestQueueResponse.yaml @@ -1,4 +1,5 @@ title: GetRequestQueueResponse +description: Response containing the request queue details. required: - data type: object diff --git a/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml index ce0d899af8..acc689fbe6 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetRequestResponse.yaml @@ -1,7 +1,8 @@ title: GetRequestResponse +description: Response containing a single request from the request queue. required: - data type: object properties: data: - $ref: ./RequestQueueItems.yaml + $ref: ./Request.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/HeadRequest.yaml b/apify-api/openapi/components/schemas/request-queues/HeadRequest.yaml new file mode 100644 index 0000000000..36ca1c2efb --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/HeadRequest.yaml @@ -0,0 +1,28 @@ +title: HeadRequest +description: A request from the request queue head without lock information. +type: object +required: + - id + - uniqueKey + - url +properties: + id: + type: string + description: A unique identifier assigned to the request. + example: 8OamqXBCpPHxyH9 + uniqueKey: + type: string + description: A unique key used for request de-duplication. Requests with the same unique key are considered identical. + example: GET|60d83e70|e3b0c442|https://apify.com + url: + type: string + description: The URL of the request. + example: https://apify.com + method: + type: string + description: The HTTP method of the request. + example: GET + retryCount: + type: integer + description: The number of times this request has been retried. + example: 0 diff --git a/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml b/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml index 9eeb9b857e..3587976478 100644 --- a/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ListOfRequestQueues.yaml @@ -1,4 +1,5 @@ title: ListOfRequestQueues +description: A paginated list of request queues. allOf: - $ref: ../common/PaginationResponse.yaml - type: object @@ -7,5 +8,6 @@ allOf: properties: items: type: array + description: The array of request queues. items: $ref: ./RequestQueueShort.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml b/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml index 75392956fe..75b06d476a 100644 --- a/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ListOfRequests.yaml @@ -1,20 +1,24 @@ title: ListOfRequests +description: A paginated list of requests from the request queue. type: object +required: + - items + - limit properties: items: type: array items: - $ref: ./RequestQueueItems.yaml - description: '' + $ref: ./Request.yaml + description: The array of requests. count: type: integer + description: The total number of requests matching the query. example: 2 limit: type: integer + description: The maximum number of requests returned in this response. example: 2 exclusiveStartId: type: string + description: The ID of the last request from the previous page, used for pagination. example: Ihnsp8YrvJ8102Kj -required: - - items - - limit diff --git a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml b/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml deleted file mode 100644 index e642647d14..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml +++ /dev/null @@ -1,7 +0,0 @@ -title: ListRequestsResponse -required: - - data -type: object -properties: - data: - $ref: './ListOfRequests.yaml' diff --git a/apify-api/openapi/components/schemas/request-queues/LockedHeadRequest.yaml b/apify-api/openapi/components/schemas/request-queues/LockedHeadRequest.yaml new file mode 100644 index 0000000000..246f7f4316 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/LockedHeadRequest.yaml @@ -0,0 +1,34 @@ +title: LockedHeadRequest +description: A request from the request queue head that has been locked for processing. +type: object +required: + - id + - uniqueKey + - url + - lockExpiresAt +properties: + id: + type: string + description: A unique identifier assigned to the request. + example: 8OamqXBCpPHxyH9 + uniqueKey: + type: string + description: A unique key used for request de-duplication. Requests with the same unique key are considered identical. + example: GET|60d83e70|e3b0c442|https://apify.com + url: + type: string + description: The URL of the request. + example: https://apify.com + method: + type: string + description: The HTTP method of the request. + example: GET + retryCount: + type: integer + description: The number of times this request has been retried. + example: 0 + lockExpiresAt: + type: string + format: date-time + description: The timestamp when the lock on this request expires. + example: '2022-06-14T23:00:00.000Z' diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml deleted file mode 100644 index 81f1e05317..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/LockedQueueHead.yaml +++ /dev/null @@ -1,35 +0,0 @@ -title: LockedQueueHead -type: object -properties: - limit: - type: integer - example: 1000 - queueModifiedAt: - type: string - format: date-time - description: The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue. - example: '2018-03-14T23:00:00.000Z' - queueHasLockedRequests: - type: boolean - description: Whether the queue contains requests locked by any client (either the one calling the endpoint or a different one). - example: true - clientKey: - type: string - example: client-one - hadMultipleClients: - type: boolean - example: true - lockSecs: - type: integer - example: 60 - items: - type: array - items: - $ref: './LockedQueueHeadItem.yaml' - description: '' -required: - - limit - - queueModifiedAt - - hadMultipleClients - - lockSecs - - items diff --git a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml deleted file mode 100644 index 1108bb6f9a..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/LockedQueueHeadItem.yaml +++ /dev/null @@ -1,27 +0,0 @@ -title: LockedQueueHeadItem -type: object -properties: - id: - type: string - example: 8OamqXBCpPHxyj9 - retryCount: - type: integer - example: 0 - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET - lockExpiresAt: - type: string - format: date-time - example: '2022-06-14T23:00:00.000Z' -required: - - id - - uniqueKey - - url - - lockExpiresAt diff --git a/apify-api/openapi/components/schemas/request-queues/LockedRequestQueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/LockedRequestQueueHead.yaml new file mode 100644 index 0000000000..457dcde3e6 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/LockedRequestQueueHead.yaml @@ -0,0 +1,40 @@ +title: LockedRequestQueueHead +description: A batch of locked requests from the request queue head. +type: object +required: + - limit + - queueModifiedAt + - hadMultipleClients + - lockSecs + - items +properties: + limit: + type: integer + description: The maximum number of requests returned. + example: 1000 + queueModifiedAt: + type: string + format: date-time + description: The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests. + example: '2018-03-14T23:00:00.000Z' + queueHasLockedRequests: + type: boolean + description: Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one). + example: true + clientKey: + type: string + description: The client key used for locking the requests. + example: client-one + hadMultipleClients: + type: boolean + description: Whether the request queue has been accessed by multiple different clients. + example: true + lockSecs: + type: integer + description: The number of seconds the locks will be held. + example: 60 + items: + type: array + items: + $ref: ./LockedHeadRequest.yaml + description: The array of locked requests from the request queue head. diff --git a/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml b/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml deleted file mode 100644 index cd14d8f908..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/ProcessedRequest.yaml +++ /dev/null @@ -1,17 +0,0 @@ -title: ProcessedRequest -required: - - uniqueKey -type: object -properties: - requestId: - type: string - example: sbJ7klsdf7ujN9l - uniqueKey: - type: string - example: 'http://example.com' - wasAlreadyPresent: - type: boolean - example: false - wasAlreadyHandled: - type: boolean - example: false diff --git a/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml index 82ce7e9129..d50bb729cb 100644 --- a/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/ProlongRequestLockResponse.yaml @@ -1,5 +1,8 @@ title: ProlongRequestLockResponse +description: Response containing updated lock information after prolonging a request lock. +required: + - data type: object properties: data: - $ref: './RequestLockInfo.yaml' + $ref: ./RequestLockInfo.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml deleted file mode 100644 index 7d9a555869..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/QueueHead.yaml +++ /dev/null @@ -1,23 +0,0 @@ -title: QueueHead -type: object -properties: - limit: - type: integer - example: 1000 - queueModifiedAt: - type: string - format: date-time - example: '2018-03-14T23:00:00.000Z' - hadMultipleClients: - type: boolean - example: false - items: - type: array - items: - $ref: './QueueHeadItem.yaml' - description: '' -required: - - limit - - queueModifiedAt - - hadMultipleClients - - items diff --git a/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml b/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml deleted file mode 100644 index c29ca2ed3b..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/QueueHeadItem.yaml +++ /dev/null @@ -1,22 +0,0 @@ -title: QueueHeadItem -type: object -properties: - id: - type: string - example: 8OamqXBCpPHxyH9 - retryCount: - type: integer - example: 0 - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET -required: - - id - - uniqueKey - - url diff --git a/apify-api/openapi/components/schemas/request-queues/Request.yaml b/apify-api/openapi/components/schemas/request-queues/Request.yaml new file mode 100644 index 0000000000..6a22886091 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/Request.yaml @@ -0,0 +1,60 @@ +title: Request +description: A request stored in the request queue, including its metadata and processing state. +required: + - id + - uniqueKey + - url +type: object +properties: + id: + type: string + description: A unique identifier assigned to the request. + example: dnjkDMKLmdlkmlkmld + uniqueKey: + type: string + description: A unique key used for request de-duplication. Requests with the same unique key are considered identical. + example: GET|60d83e70|e3b0c442|https://apify.com/career + url: + type: string + description: The URL of the request. + example: https://apify.com/career + method: + type: string + description: The HTTP method of the request. + example: GET + retryCount: + type: integer + description: The number of times this request has been retried. + example: 0 + loadedUrl: + type: string + nullable: true + description: The final URL that was loaded, after redirects (if any). + example: https://apify.com/jobs + payload: + type: object + nullable: true + description: The request payload, typically used with POST or PUT requests. + headers: + type: object + nullable: true + description: HTTP headers sent with the request. + userData: + $ref: ./RequestUserData.yaml + noRetry: + type: boolean + nullable: true + description: Indicates whether the request should not be retried if processing fails. + example: false + errorMessages: + type: array + nullable: true + description: Error messages recorded from failed processing attempts. + items: + type: string + handledAt: + type: string + format: date-time + nullable: true + description: The timestamp when the request was marked as handled, if applicable. + example: '2019-06-16T10:23:31.607Z' diff --git a/apify-api/openapi/components/schemas/request-queues/RequestDraft.yaml b/apify-api/openapi/components/schemas/request-queues/RequestDraft.yaml new file mode 100644 index 0000000000..d37d86876d --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/RequestDraft.yaml @@ -0,0 +1,20 @@ +title: RequestDraft +description: A request that failed to be processed during a request queue operation and can be retried. +required: + - uniqueKey + - url + - method +type: object +properties: + uniqueKey: + type: string + description: A unique key used for request de-duplication. Requests with the same unique key are considered identical. + example: GET|60d83e70|e3b0c442|https://apify.com + url: + type: string + description: The URL of the request. + example: https://apify.com + method: + type: string + description: The HTTP method of the request. + example: GET diff --git a/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml b/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml index 9eb21158e3..7bbd3397c8 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestLockInfo.yaml @@ -1,10 +1,11 @@ title: RequestLockInfo +description: Information about a request lock. type: object +required: + - lockExpiresAt properties: lockExpiresAt: type: string format: date-time - description: Date when lock expires. + description: The timestamp when the lock expires. example: '2022-01-01T00:00:00.000Z' -required: - - lockExpiresAt diff --git a/apify-api/openapi/components/schemas/request-queues/RequestOperationInfo.yaml b/apify-api/openapi/components/schemas/request-queues/RequestOperationInfo.yaml deleted file mode 100644 index 33934ce350..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/RequestOperationInfo.yaml +++ /dev/null @@ -1,16 +0,0 @@ -title: RequestOperationInfo -required: - - requestId - - wasAlreadyPresent - - wasAlreadyHandled -type: object -properties: - requestId: - type: string - example: YiKoxjkaS9gjGTqhF - wasAlreadyPresent: - type: boolean - example: true - wasAlreadyHandled: - type: boolean - example: false diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index 437f1f0a4d..69a53edf96 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -1,4 +1,5 @@ title: RequestQueue +description: A request queue object containing metadata and statistics. required: - id - userId @@ -14,41 +15,51 @@ type: object properties: id: type: string + description: A unique identifier assigned to the request queue. example: WkzbQMuFYuamGv3YF name: type: string + description: The name of the request queue. example: some-name userId: type: string + description: The ID of the user who owns the request queue. example: wRsJZtadYvn4mBZmm createdAt: type: string format: date-time + description: The timestamp when the request queue was created. example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string format: date-time - description: The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue. + description: The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue. example: '2030-12-13T08:36:13.202Z' accessedAt: type: string format: date-time + description: The timestamp when the request queue was last accessed. example: '2019-12-14T08:36:13.202Z' totalRequestCount: type: integer + description: The total number of requests in the request queue. example: 870 handledRequestCount: type: integer + description: The number of requests that have been handled. example: 100 pendingRequestCount: type: integer + description: The number of requests that are pending and have not been handled yet. example: 670 hadMultipleClients: type: boolean + description: Whether the request queue has been accessed by multiple different clients. example: true consoleUrl: type: string - example: 'https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC' + description: The URL to view the request queue in the Apify console. + example: https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC stats: $ref: ./RequestQueueStats.yaml generalAccess: diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueHead.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueHead.yaml new file mode 100644 index 0000000000..f8a796f0e4 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueHead.yaml @@ -0,0 +1,27 @@ +title: RequestQueueHead +description: A batch of requests from the request queue head without locking. +type: object +required: + - limit + - queueModifiedAt + - hadMultipleClients + - items +properties: + limit: + type: integer + description: The maximum number of requests returned. + example: 1000 + queueModifiedAt: + type: string + format: date-time + description: The timestamp when the request queue was last modified. + example: '2018-03-14T23:00:00.000Z' + hadMultipleClients: + type: boolean + description: Whether the request queue has been accessed by multiple different clients. + example: false + items: + type: array + items: + $ref: ./HeadRequest.yaml + description: The array of requests from the request queue head. diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml deleted file mode 100644 index 684c17f7a1..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml +++ /dev/null @@ -1,49 +0,0 @@ -title: RequestQueueItems -required: - - id - - uniqueKey - - url -type: object -properties: - id: - type: string - example: dnjkDMKLmdlkmlkmld - retryCount: - type: integer - example: 0 - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET - loadedUrl: - type: string - nullable: true - example: 'http://example.com/example-1' - payload: - type: object - nullable: true - noRetry: - type: boolean - nullable: true - example: false - errorMessages: - type: array - items: - type: string - description: '' - nullable: true - headers: - type: object - nullable: true - userData: - $ref: ./UserData.yaml - handledAt: - type: string - format: date-time - nullable: true - example: '2019-06-16T10:23:31.607Z' diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml index 8c4ac0d605..e8607965f7 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueShort.yaml @@ -1,4 +1,5 @@ title: RequestQueueShort +description: A shortened request queue object for list responses. required: - id - name @@ -16,47 +17,61 @@ type: object properties: id: type: string + description: A unique identifier assigned to the request queue. example: WkzbQMuFYuamGv3YF name: type: string + description: The name of the request queue. example: some-name userId: type: string + description: The ID of the user who owns the request queue. example: wRsJZtadYvn4mBZmm username: type: string + description: The username of the user who owns the request queue. example: janedoe createdAt: type: string format: date-time + description: The timestamp when the request queue was created. example: '2019-12-12T07:34:14.202Z' modifiedAt: type: string format: date-time + description: The timestamp when the request queue was last modified. example: '2019-12-13T08:36:13.202Z' accessedAt: type: string format: date-time + description: The timestamp when the request queue was last accessed. example: '2019-12-14T08:36:13.202Z' expireAt: type: string format: date-time + description: The timestamp when the request queue will expire and be deleted. example: '2019-06-02T17:15:06.751Z' totalRequestCount: type: integer + description: The total number of requests in the request queue. example: 100 handledRequestCount: type: integer + description: The number of requests that have been handled. example: 50 pendingRequestCount: type: integer + description: The number of requests that are pending and have not been handled yet. example: 50 actId: type: string nullable: true + description: The ID of the Actor that created this request queue. actRunId: type: string nullable: true + description: The ID of the Actor run that created this request queue. hadMultipleClients: type: boolean + description: Whether the request queue has been accessed by multiple different clients. example: true diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml index 7f6f16305e..1b8a8b6183 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueueStats.yaml @@ -1,18 +1,24 @@ title: RequestQueueStats +description: Statistics about request queue operations and storage. type: object properties: deleteCount: type: integer + description: The number of delete operations performed on the request queue. example: 0 headItemReadCount: type: integer + description: The number of times requests from the head were read. example: 5 readCount: type: integer + description: The total number of read operations performed on the request queue. example: 100 storageBytes: type: integer + description: The total storage size in bytes used by the request queue. example: 1024 writeCount: type: integer + description: The total number of write operations performed on the request queue. example: 10 diff --git a/apify-api/openapi/components/schemas/request-queues/RequestRegistration.yaml b/apify-api/openapi/components/schemas/request-queues/RequestRegistration.yaml new file mode 100644 index 0000000000..c18bc13fb0 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/RequestRegistration.yaml @@ -0,0 +1,20 @@ +title: RequestRegistration +description: Result of registering a request in the request queue, either by adding a new request or updating an existing one. +required: + - requestId + - wasAlreadyPresent + - wasAlreadyHandled +type: object +properties: + requestId: + type: string + description: A unique identifier assigned to the request. + example: YiKoxjkaS9gjGTqhF + wasAlreadyPresent: + type: boolean + description: Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created. + example: false + wasAlreadyHandled: + type: boolean + description: Indicates whether a request with the same unique key has already been processed by the request queue. + example: false diff --git a/apify-api/openapi/components/schemas/request-queues/RequestUserData.yaml b/apify-api/openapi/components/schemas/request-queues/RequestUserData.yaml new file mode 100644 index 0000000000..fe15d9f807 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/RequestUserData.yaml @@ -0,0 +1,15 @@ +title: RequestUserData +description: Custom user data attached to the request. Can contain arbitrary fields. +type: object +additionalProperties: true +properties: + label: + type: string + nullable: true + description: Optional label for categorizing the request. + example: DETAIL + image: + type: string + nullable: true + description: Optional image URL associated with the request. + example: https://picserver1.eu diff --git a/apify-api/openapi/components/schemas/request-queues/RequestWithoutId.yaml b/apify-api/openapi/components/schemas/request-queues/RequestWithoutId.yaml deleted file mode 100644 index e8bb75e956..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/RequestWithoutId.yaml +++ /dev/null @@ -1,16 +0,0 @@ -title: RequestWithoutId -required: - - uniqueKey - - url - - method -type: object -properties: - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET diff --git a/apify-api/openapi/components/schemas/request-queues/UnlockRequestsResponse.yaml b/apify-api/openapi/components/schemas/request-queues/UnlockRequestsResponse.yaml new file mode 100644 index 0000000000..6ba509acb0 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/UnlockRequestsResponse.yaml @@ -0,0 +1,8 @@ +title: UnlockRequestsResponse +description: Response containing the result of unlocking requests. +type: object +required: + - data +properties: + data: + $ref: ./UnlockRequestsResult.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/UnlockRequestsResult.yaml b/apify-api/openapi/components/schemas/request-queues/UnlockRequestsResult.yaml new file mode 100644 index 0000000000..f22743d7a9 --- /dev/null +++ b/apify-api/openapi/components/schemas/request-queues/UnlockRequestsResult.yaml @@ -0,0 +1,10 @@ +title: UnlockRequestsResult +description: Result of unlocking requests in the request queue. +type: object +required: + - unlockedCount +properties: + unlockedCount: + type: integer + description: Number of requests that were successfully unlocked. + example: 10 diff --git a/apify-api/openapi/components/schemas/request-queues/UnprocessedRequest.yaml b/apify-api/openapi/components/schemas/request-queues/UnprocessedRequest.yaml deleted file mode 100644 index b6dcfd8369..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/UnprocessedRequest.yaml +++ /dev/null @@ -1,16 +0,0 @@ -title: UnprocessedRequest -required: - - uniqueKey - - url - - method -type: object -properties: - uniqueKey: - type: string - example: 'http://example.com' - url: - type: string - example: 'http://example.com' - method: - type: string - example: GET diff --git a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml index 9f19037301..14bc5f6104 100644 --- a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueRequest.yaml @@ -1,8 +1,10 @@ title: UpdateRequestQueueRequest +description: Request object for updating a request queue. type: object properties: name: type: string + description: The new name for the request queue. generalAccess: $ref: ../common/GeneralAccessEnum.yaml example: diff --git a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml index 88bd0f8b43..a57eb90e41 100644 --- a/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UpdateRequestQueueResponse.yaml @@ -1,4 +1,5 @@ title: UpdateRequestQueueResponse +description: Response containing the updated request queue. required: - data type: object diff --git a/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml b/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml index 471930ee2c..cf68870ff7 100644 --- a/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/UpdateRequestResponse.yaml @@ -1,7 +1,8 @@ title: UpdateRequestResponse +description: Response containing the result of updating a request in the request queue. required: - data type: object properties: data: - $ref: ./RequestOperationInfo.yaml + $ref: ./RequestRegistration.yaml diff --git a/apify-api/openapi/components/schemas/request-queues/UserData.yaml b/apify-api/openapi/components/schemas/request-queues/UserData.yaml deleted file mode 100644 index 2d9afbfeb5..0000000000 --- a/apify-api/openapi/components/schemas/request-queues/UserData.yaml +++ /dev/null @@ -1,12 +0,0 @@ -title: UserData -type: object -additionalProperties: true -properties: - label: - type: string - nullable: true - example: DETAIL - image: - type: string - nullable: true - example: 'https://picserver1.eu' diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml index 21f7f97825..50d43c4790 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml @@ -55,7 +55,7 @@ get: application/json: schema: allOf: - - $ref: ../../components/schemas/request-queues/ListRequestsResponse.yaml + - $ref: ../../components/schemas/request-queues/GetListOfRequestsResponse.yaml - example: data: items: @@ -186,7 +186,7 @@ post: application/json: schema: allOf: - - $ref: ../../components/schemas/request-queues/RequestWithoutId.yaml + - $ref: ../../components/schemas/request-queues/RequestDraft.yaml - example: uniqueKey: 'http://example.com' url: 'http://example.com' diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml index c05e8ba41b..26361f1332 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml @@ -50,7 +50,7 @@ post: schema: type: array items: - $ref: ../../components/schemas/request-queues/RequestWithoutId.yaml + $ref: ../../components/schemas/request-queues/RequestDraft.yaml description: '' example: - uniqueKey: 'http://example.com' @@ -75,7 +75,7 @@ post: application/json: schema: allOf: - - $ref: ../../components/schemas/request-queues/BatchOperationResponse.yaml + - $ref: ../../components/schemas/request-queues/BatchAddResponse.yaml - example: data: processedRequests: @@ -162,14 +162,11 @@ delete: application/json: schema: allOf: - - $ref: ../../components/schemas/request-queues/BatchOperationResponse.yaml + - $ref: ../../components/schemas/request-queues/BatchDeleteResponse.yaml - example: data: processedRequests: - - requestId: YiKoxjkaS9gjGTqhF - uniqueKey: 'http://example.com/2' - wasAlreadyPresent: true - wasAlreadyHandled: false + - uniqueKey: 'http://example.com' unprocessedRequests: - uniqueKey: 'http://example.com/2' url: 'http://example.com/2' diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@unlock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@unlock.yaml index 3d734853a9..57f2a72b38 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@unlock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@unlock.yaml @@ -33,18 +33,7 @@ post: content: application/json: schema: - type: object - required: - - data - properties: - data: - type: object - required: - - unlockedCount - properties: - unlockedCount: - type: integer - description: 'Number of requests that were successfully unlocked' + $ref: ../../components/schemas/request-queues/UnlockRequestsResponse.yaml example: data: unlockedCount: 10 diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml index 45141a9269..e5b50c854a 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml @@ -130,7 +130,7 @@ put: application/json: schema: allOf: - - $ref: ../../components/schemas/request-queues/RequestQueueItems.yaml + - $ref: ../../components/schemas/request-queues/Request.yaml - example: id: dnjkDMKLmdlkmlkmld retryCount: 0 From 361b2ddb7ddc489dbdcf346eedd7e111a25ed4d6 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Mon, 19 Jan 2026 15:35:26 +0100 Subject: [PATCH 20/20] Add missing space around dash and add description to pagination response --- .../components/schemas/common/PaginationResponse.yaml | 6 ++++++ apify-api/openapi/components/tags.yaml | 3 +-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/components/schemas/common/PaginationResponse.yaml b/apify-api/openapi/components/schemas/common/PaginationResponse.yaml index 402d283b40..33265705e8 100644 --- a/apify-api/openapi/components/schemas/common/PaginationResponse.yaml +++ b/apify-api/openapi/components/schemas/common/PaginationResponse.yaml @@ -1,4 +1,5 @@ title: PaginationResponse +description: Common pagination fields for list responses. required: - total - offset @@ -9,16 +10,21 @@ type: object properties: total: type: integer + description: The total number of items available across all pages. example: 2 offset: type: integer + description: The starting position for this page of results. example: 0 limit: type: integer + description: The maximum number of items returned per page. example: 1000 desc: type: boolean + description: Whether the results are sorted in descending order. example: false count: type: integer + description: The number of items returned in this response. example: 2 diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 95f676de4a..195be4be22 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -255,7 +255,7 @@ ::: - name: Storage/Request queues/Requests - x-displayName: Requests- Introduction + x-displayName: Requests - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - '#/reference/request-queues/request-collection' @@ -420,4 +420,3 @@ description: The API endpoints described in this section return information about user accounts. x-trait: true -