docs(openapi): Document 404 related errors on acts and actor-builds endpoints

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]

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?]

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]

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

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

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

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

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

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
@@ -161,6 +168,13 @@ post:
             $ref: ../../components/schemas/actor-builds/BuildResponse.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/build-actor

apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml

@@ -45,6 +45,21 @@ get:
             $ref: ../../components/schemas/actor-builds/BuildResponse.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"
+    "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

apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml

@@ -52,6 +52,14 @@ get:
             $ref: ../../components/schemas/actor-builds/BuildResponse.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#/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:

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

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"

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