From e43a091f38311f9a4abb98ee433609edb844a0e6 Mon Sep 17 00:00:00 2001 From: Josef Prochazka Date: Wed, 4 Mar 2026 13:27:09 +0100 Subject: [PATCH 1/4] Document 404 related errors on acts endpoints --- .../schemas/common/errors/ActorErrors.yaml | 85 +++++++++++++++++++ .../schemas/common/errors/BuildErrors.yaml | 13 +++ .../common/errors/EnvVariableErrors.yaml | 13 +++ .../openapi/paths/actors/acts@{actorId}.yaml | 21 +++++ .../paths/actors/acts@{actorId}@builds.yaml | 14 +++ .../actors/acts@{actorId}@builds@default.yaml | 15 ++++ .../acts@{actorId}@builds@{buildId}.yaml | 8 ++ ...acts@{actorId}@builds@{buildId}@abort.yaml | 8 ++ ...ctorId}@builds@{buildId}@openapi.json.yaml | 8 ++ ...@{actorId}@run-sync-get-dataset-items.yaml | 46 +++++----- .../paths/actors/acts@{actorId}@run-sync.yaml | 45 +++++----- .../paths/actors/acts@{actorId}@runs.yaml | 14 +++ .../actors/acts@{actorId}@runs@last.yaml | 8 ++ .../actors/acts@{actorId}@runs@{runId}.yaml | 8 ++ .../acts@{actorId}@runs@{runId}@abort.yaml | 8 ++ ...acts@{actorId}@runs@{runId}@metamorph.yaml | 8 ++ ...acts@{actorId}@runs@{runId}@resurrect.yaml | 8 ++ .../paths/actors/acts@{actorId}@versions.yaml | 14 +++ ...ts@{actorId}@versions@{versionNumber}.yaml | 23 +++++ ...Id}@versions@{versionNumber}@env-vars.yaml | 15 ++++ ...{versionNumber}@env-vars@{envVarName}.yaml | 27 ++++++ .../paths/actors/acts@{actorId}@webhooks.yaml | 7 ++ 22 files changed, 369 insertions(+), 47 deletions(-) create mode 100644 apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml create mode 100644 apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml create mode 100644 apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml diff --git a/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml b/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml new file mode 100644 index 0000000000..97d7af6578 --- /dev/null +++ b/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml @@ -0,0 +1,85 @@ +ActorNotFoundError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [actor-not-found] + message: + type: string + enum: [Actor was not found] + +ActorBuildNotFoundError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Actor build was not found] + +ActorRunNotFoundError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Actor run was not found] + +ActorRunTimeoutExceededError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [run-timeout-exceeded] + message: + type: string + pattern: '^Actor run exceeded the timeout of \d+ seconds for this API endpoint' + example: Actor run exceeded the timeout of 300 seconds for this API endpoint + +ActorRunFailedError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [run-failed] + message: + type: string + pattern: '^Actor run did not succeed \(run ID: .+, status: .+\)' + example: "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)" + +ActorVersionNotFoundError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Actor version was not found] diff --git a/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml b/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml new file mode 100644 index 0000000000..fa66c08ff5 --- /dev/null +++ b/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml @@ -0,0 +1,13 @@ +UnknownBuildTagError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [unknown-build-tag] + message: + type: string + enum: [Build with tag \"latest\" was not found. Has the Actor been built already?] diff --git a/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml b/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml new file mode 100644 index 0000000000..53098e5371 --- /dev/null +++ b/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml @@ -0,0 +1,13 @@ +EnvironmentVariableNotFoundError: + allOf: + - type: object + properties: + error: + type: object + properties: + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Environment variable was not found] diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 18c8b64ec0..5419abef27 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -83,6 +83,13 @@ get: finishedAt: "2019-06-10T11:15:49.286Z" "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor @@ -264,6 +271,13 @@ put: finishedAt: "2019-06-10T11:15:49.286Z" "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor @@ -302,6 +316,13 @@ delete: example: {} "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index 8d29deaabb..a9bd01955b 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -63,6 +63,13 @@ get: $ref: ../../components/schemas/actor-builds/ListOfBuildsResponse.yaml "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds @@ -190,6 +197,13 @@ post: buildNumber: 0.1.1 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml index c08ea12a70..a8292594cf 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml @@ -74,6 +74,21 @@ get: buildNumber: 0.1.1 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + "403": + # It should be 404, but is 403 for backwards compatibility. https://github.com/apify/apify-core/pull/17414 + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/BuildErrors.yaml#/UnknownBuildTagError" x-js-parent: ActorClient x-js-name: defaultBuild x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#defaultBuild diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml index 93fa25068a..806aa49d90 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml @@ -81,6 +81,14 @@ get: buildNumber: 0.1.1 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: true x-deprecated-description: "API endpoints related to build of the Actor were moved under new namespace [`actor-builds`](#/reference/actor-builds). Gets an object that contains all the details about a specific build of an Actor." x-legacy-doc-urls: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml index 164145fcc0..8ef4777642 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml @@ -63,6 +63,14 @@ post: buildNumber: 0.1.1 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: true x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/abort-build/abort-build diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml index 743c3a2533..95fb28d532 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml @@ -49,3 +49,11 @@ get: description: A standard OpenAPI 3.x JSON document. "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml index 9e8518f0bc..8be720cf19 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -366,24 +366,23 @@ post: content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-failed - message: >- - Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: - FAILED) + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-timeout-exceeded - message: Actor run exceeded timeout of 300 seconds for this API endpoint + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-with-input-and-get-dataset-items @@ -732,24 +731,23 @@ get: content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-failed - message: >- - Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: - FAILED) + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-timeout-exceeded - message: Actor run exceeded timeout of 60 seconds for this API endpoint + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-without-input-and-get-dataset-items diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index b9da3b0a7d..4abd6190e7 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -126,23 +126,23 @@ post: content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-failed - message: | - Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED) + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-timeout-exceeded - message: Actor run exceeded timeout of 300 seconds for this API endpoint + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/with-input @@ -261,24 +261,23 @@ get: content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-failed - message: >- - Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: - FAILED) + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - $ref: ../../components/schemas/common/ErrorResponse.yaml - example: - error: - type: run-timeout-exceeded - message: Actor run exceeded timeout of 60 seconds for this API endpoint + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/without-input diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index fc7ff45c80..afb63da4dc 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -134,6 +134,13 @@ get: defaultRequestQueueId: soowucklrmDzKpA8x "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs @@ -366,6 +373,13 @@ post: PROXY_SERPS: 0.0006 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml index 1307b9cf47..4c8cb7b560 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml @@ -158,6 +158,14 @@ get: PROXY_SERPS: 0.0006 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages/get-last-run diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml index bb52dfeb68..268b0a6a72 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml @@ -130,6 +130,14 @@ get: PROXY_SERPS: 0.0006 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunNotFoundError" deprecated: true x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-object/get-run diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml index cb06edfd66..b85e4eaf0d 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml @@ -120,6 +120,14 @@ post: PROXY_SERPS: 0.0006 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunNotFoundError" deprecated: true x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/abort-run/abort-run diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml index 7b028833c2..874ba081b7 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml @@ -151,6 +151,14 @@ post: PROXY_SERPS: 0.0006 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunNotFoundError" deprecated: true x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/metamorph-run/metamorph-run diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml index 644d211a8e..e0e7748b99 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml @@ -161,6 +161,14 @@ post: PROXY_SERPS: 0.0006 "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/resurrect-run/resurrect-run diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index b2b9bc2305..04e622bc20 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -54,6 +54,13 @@ get: gitHubGistUrl: "https://gist.github.com/jane35/e51feb784yu89" "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions @@ -133,6 +140,13 @@ post: $ref: ../../components/schemas/actors/VersionResponse.yaml "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml index c5f9d0b4d6..3214e52be2 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -32,6 +32,14 @@ get: $ref: ../../components/schemas/actors/VersionResponse.yaml "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/get-version @@ -107,6 +115,13 @@ put: $ref: ../../components/schemas/actors/VersionResponse.yaml "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version @@ -151,6 +166,14 @@ delete: example: {} "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/delete-version diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml index a78dd47216..5ad73c00c6 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml @@ -33,6 +33,14 @@ get: $ref: ../../components/schemas/actors/ListOfEnvVarsResponse.yaml "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables @@ -114,6 +122,13 @@ post: isSecret: false "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml index 83652dae03..07a1aede56 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml @@ -48,6 +48,15 @@ get: isSecret: false "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError" + - $ref: "../../components/schemas/common/errors/EnvVariableErrors.yaml#/EnvironmentVariableNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable @@ -129,6 +138,15 @@ put: isSecret: false "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError" + - $ref: "../../components/schemas/common/errors/EnvVariableErrors.yaml#/EnvironmentVariableNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable @@ -180,6 +198,15 @@ delete: example: {} "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorVersionNotFoundError" + - $ref: "../../components/schemas/common/errors/EnvVariableErrors.yaml#/EnvironmentVariableNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml index 615f846444..67aecda12c 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml @@ -63,6 +63,13 @@ get: $ref: ../../components/schemas/webhooks/ListOfWebhooksResponse.yaml "400": $ref: ../../components/responses/BadRequest.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/webhook-collection/get-list-of-webhooks From 1cf995a53841f90209f6791788089e4005dea483 Mon Sep 17 00:00:00 2001 From: Josef Prochazka Date: Wed, 4 Mar 2026 14:00:27 +0100 Subject: [PATCH 2/4] Use response schema in actor-builds endpoint as well --- .../paths/actor-builds/actor-builds@{buildId}.yaml | 14 ++++++++++++-- .../actor-builds/actor-builds@{buildId}@abort.yaml | 7 +++++++ .../actor-builds/actor-builds@{buildId}@log.yaml | 7 ++++++- .../actor-builds@{buildId}@openapi.json.yaml | 7 ++++++- 4 files changed, 31 insertions(+), 4 deletions(-) diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml index 7a11dee179..fdbf973944 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml @@ -53,7 +53,12 @@ get: "403": $ref: ../../components/responses/Forbidden.yaml "404": - $ref: ../../components/responses/NotFound.yaml + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build @@ -95,7 +100,12 @@ delete: "401": $ref: ../../components/responses/Unauthorized.yaml "404": - $ref: ../../components/responses/NotFound.yaml + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml index 1f15312003..12f046859e 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml @@ -33,6 +33,13 @@ post: $ref: ../../components/responses/Unauthorized.yaml "403": $ref: ../../components/responses/Forbidden.yaml + "404": + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml index b4dd54442a..d1e3a19974 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml @@ -55,7 +55,12 @@ get: "400": $ref: ../../components/responses/BadRequest.yaml "404": - $ref: ../../components/responses/NotFound.yaml + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-log/get-log diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml index 71e2102fc3..f2a96549d5 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml @@ -39,7 +39,12 @@ get: "400": $ref: ../../components/responses/BadRequest.yaml "404": - $ref: ../../components/responses/NotFound.yaml + description: Not found - the requested resource was not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" x-js-parent: BuildClient x-js-name: getOpenApiDefinition x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#getOpenApiDefinition From 560a4c89cb56bb90ba347cd20c200d0665f35844 Mon Sep 17 00:00:00 2001 From: Josef Prochazka Date: Wed, 4 Mar 2026 15:06:59 +0100 Subject: [PATCH 3/4] Remove redundant `allOf` from error response schemas --- .../schemas/common/errors/ActorErrors.yaml | 130 +++++++++--------- .../schemas/common/errors/BuildErrors.yaml | 21 ++- .../common/errors/EnvVariableErrors.yaml | 21 ++- 3 files changed, 82 insertions(+), 90 deletions(-) diff --git a/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml b/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml index 97d7af6578..dd5a7fbfd1 100644 --- a/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml +++ b/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml @@ -1,85 +1,79 @@ ActorNotFoundError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [actor-not-found] - message: - type: string - enum: [Actor was not found] + type: + type: string + enum: [actor-not-found] + message: + type: string + enum: [Actor was not found] ActorBuildNotFoundError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [record-not-found] - message: - type: string - enum: [Actor build was not found] + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Actor build was not found] ActorRunNotFoundError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [record-not-found] - message: - type: string - enum: [Actor run was not found] + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Actor run was not found] ActorRunTimeoutExceededError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [run-timeout-exceeded] - message: - type: string - pattern: '^Actor run exceeded the timeout of \d+ seconds for this API endpoint' - example: Actor run exceeded the timeout of 300 seconds for this API endpoint + type: + type: string + enum: [run-timeout-exceeded] + message: + type: string + pattern: '^Actor run exceeded the timeout of \d+ seconds for this API endpoint' + example: Actor run exceeded the timeout of 300 seconds for this API endpoint ActorRunFailedError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [run-failed] - message: - type: string - pattern: '^Actor run did not succeed \(run ID: .+, status: .+\)' - example: "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)" + type: + type: string + enum: [run-failed] + message: + type: string + pattern: '^Actor run did not succeed \(run ID: .+, status: .+\)' + example: "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)" ActorVersionNotFoundError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [record-not-found] - message: - type: string - enum: [Actor version was not found] + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Actor version was not found] diff --git a/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml b/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml index fa66c08ff5..e0e7286daa 100644 --- a/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml +++ b/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml @@ -1,13 +1,12 @@ UnknownBuildTagError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [unknown-build-tag] - message: - type: string - enum: [Build with tag \"latest\" was not found. Has the Actor been built already?] + type: + type: string + enum: [unknown-build-tag] + message: + type: string + enum: [Build with tag \"latest\" was not found. Has the Actor been built already?] diff --git a/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml b/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml index 53098e5371..a3b0b7aa17 100644 --- a/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml +++ b/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml @@ -1,13 +1,12 @@ EnvironmentVariableNotFoundError: - allOf: - - type: object + type: object + properties: + error: + type: object properties: - error: - type: object - properties: - type: - type: string - enum: [record-not-found] - message: - type: string - enum: [Environment variable was not found] + type: + type: string + enum: [record-not-found] + message: + type: string + enum: [Environment variable was not found] From a3f21554120591ced792f999f38ee55378977a2f Mon Sep 17 00:00:00 2001 From: Josef Prochazka Date: Thu, 5 Mar 2026 11:15:09 +0100 Subject: [PATCH 4/4] Remove redudant `oneOf`s Relax the error message constraints --- .../schemas/common/errors/ActorErrors.yaml | 10 ++++------ .../schemas/common/errors/BuildErrors.yaml | 2 +- .../common/errors/EnvVariableErrors.yaml | 2 +- .../actor-builds/actor-builds@{buildId}.yaml | 6 ++---- .../actor-builds@{buildId}@abort.yaml | 3 +-- .../actor-builds@{buildId}@log.yaml | 3 +-- .../actor-builds@{buildId}@openapi.json.yaml | 3 +-- .../openapi/paths/actors/acts@{actorId}.yaml | 9 +++------ .../paths/actors/acts@{actorId}@builds.yaml | 6 ++---- .../actors/acts@{actorId}@builds@default.yaml | 6 ++---- ...s@{actorId}@run-sync-get-dataset-items.yaml | 18 ++++++------------ .../paths/actors/acts@{actorId}@run-sync.yaml | 18 ++++++------------ .../paths/actors/acts@{actorId}@runs.yaml | 6 ++---- .../paths/actors/acts@{actorId}@versions.yaml | 6 ++---- ...cts@{actorId}@versions@{versionNumber}.yaml | 3 +-- ...rId}@versions@{versionNumber}@env-vars.yaml | 3 +-- .../paths/actors/acts@{actorId}@webhooks.yaml | 3 +-- 17 files changed, 37 insertions(+), 70 deletions(-) diff --git a/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml b/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml index dd5a7fbfd1..f3c75b1282 100644 --- a/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml +++ b/apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml @@ -9,7 +9,7 @@ ActorNotFoundError: enum: [actor-not-found] message: type: string - enum: [Actor was not found] + example: Actor was not found ActorBuildNotFoundError: type: object @@ -22,7 +22,7 @@ ActorBuildNotFoundError: enum: [record-not-found] message: type: string - enum: [Actor build was not found] + example: Actor build was not found ActorRunNotFoundError: type: object @@ -35,7 +35,7 @@ ActorRunNotFoundError: enum: [record-not-found] message: type: string - enum: [Actor run was not found] + example: Actor run was not found ActorRunTimeoutExceededError: type: object @@ -48,7 +48,6 @@ ActorRunTimeoutExceededError: enum: [run-timeout-exceeded] message: type: string - pattern: '^Actor run exceeded the timeout of \d+ seconds for this API endpoint' example: Actor run exceeded the timeout of 300 seconds for this API endpoint ActorRunFailedError: @@ -62,7 +61,6 @@ ActorRunFailedError: enum: [run-failed] message: type: string - pattern: '^Actor run did not succeed \(run ID: .+, status: .+\)' example: "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)" ActorVersionNotFoundError: @@ -76,4 +74,4 @@ ActorVersionNotFoundError: enum: [record-not-found] message: type: string - enum: [Actor version was not found] + example: Actor version was not found diff --git a/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml b/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml index e0e7286daa..a5e56c7e2b 100644 --- a/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml +++ b/apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml @@ -9,4 +9,4 @@ UnknownBuildTagError: enum: [unknown-build-tag] message: type: string - enum: [Build with tag \"latest\" was not found. Has the Actor been built already?] + example: 'Build with tag "latest" was not found. Has the Actor been built already?' diff --git a/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml b/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml index a3b0b7aa17..4f4d75e498 100644 --- a/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml +++ b/apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml @@ -9,4 +9,4 @@ EnvironmentVariableNotFoundError: enum: [record-not-found] message: type: string - enum: [Environment variable was not found] + example: Environment variable was not found diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml index fdbf973944..b947fbc385 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml @@ -57,8 +57,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build @@ -104,8 +103,7 @@ delete: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml index 12f046859e..d35055d54b 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml @@ -38,8 +38,7 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml index d1e3a19974..c103d009cd 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml @@ -59,8 +59,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-log/get-log diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml index f2a96549d5..644fb8abde 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml @@ -43,8 +43,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorBuildNotFoundError" x-js-parent: BuildClient x-js-name: getOpenApiDefinition x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#getOpenApiDefinition diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 5419abef27..d7ec26a3bc 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -88,8 +88,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor @@ -276,8 +275,7 @@ put: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor @@ -321,8 +319,7 @@ delete: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index e33cc5b8e5..f7ffdccdea 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -68,8 +68,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds @@ -173,8 +172,7 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml index 4c46b15734..4d7e6c2464 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml @@ -50,16 +50,14 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "403": # It should be 404, but is 403 for backwards compatibility. https://github.com/apify/apify-core/pull/17414 description: Not found - the requested resource was not found. content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/BuildErrors.yaml#/UnknownBuildTagError" + $ref: "../../components/schemas/common/errors/BuildErrors.yaml#/UnknownBuildTagError" x-js-parent: ActorClient x-js-name: defaultBuild x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#defaultBuild diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml index 8be720cf19..87ed0aaffb 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -366,23 +366,20 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" "404": description: Not found - the requested resource was not found. content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-with-input-and-get-dataset-items @@ -731,23 +728,20 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" "404": description: Not found - the requested resource was not found. content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-without-input-and-get-dataset-items diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index 4abd6190e7..ba33da783a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -126,23 +126,20 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" "404": description: Not found - the requested resource was not found. content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/with-input @@ -261,23 +258,20 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunFailedError" "404": description: Not found - the requested resource was not found. content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" "408": description: "" headers: {} content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorRunTimeoutExceededError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/without-input diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index 146ea8b375..4fcfcb0c13 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -106,8 +106,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs @@ -271,8 +270,7 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index 04e622bc20..332a3774a5 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -59,8 +59,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions @@ -145,8 +144,7 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml index 3214e52be2..4b08316ed0 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -120,8 +120,7 @@ put: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml index 5ad73c00c6..1585434079 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml @@ -127,8 +127,7 @@ post: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml index 67aecda12c..21f30f1f19 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml @@ -68,8 +68,7 @@ get: content: application/json: schema: - oneOf: - - $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" + $ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError" deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/webhook-collection/get-list-of-webhooks