diff --git a/apify-api/openapi/components/objects/actor-runs/abort.yaml b/apify-api/openapi/components/objects/actor-runs/abort.yaml new file mode 100644 index 0000000000..9c6ea44610 --- /dev/null +++ b/apify-api/openapi/components/objects/actor-runs/abort.yaml @@ -0,0 +1,111 @@ +sharedAbort: &sharedAbort + responses: + "200": + description: "" + headers: {} + content: + application/json: + schema: + $ref: ../../schemas/actor-runs/RunResponse.yaml + example: + $ref: ../../examples/AbortedRunExample.yaml + "400": + $ref: ../../responses/BadRequest.yaml + "401": + $ref: ../../responses/Unauthorized.yaml + "403": + $ref: ../../responses/Forbidden.yaml + "404": + $ref: ../../responses/NotFound.yaml + "405": + $ref: ../../responses/MethodNotAllowed.yaml + "429": + $ref: ../../responses/TooManyRequests.yaml + deprecated: false + +byRunId: + <<: *sharedAbort + tags: + - Actor runs + summary: Abort run + description: | + Aborts an Actor run and returns an object that contains all the details + about the run. + + Only runs that are starting or running are aborted. For runs with status + `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing. + operationId: actorRun_abort_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/gracefully" + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run + - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run + - https://docs.apify.com/api/v2#tag/Actor-runsAbort-run/operation/actorRun_abort_post + x-js-parent: RunClient + x-js-name: abort + x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#abort + x-py-parent: RunClientAsync + x-py-name: abort + x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#abort + +byActorRunId: + <<: *sharedAbort + tags: + - Actors/Actor runs + summary: Abort run + description: | + **[DEPRECATED]** API endpoints related to run of the Actor were moved under + new namespace [`actor-runs`](#/reference/actor-runs). Aborts an Actor run and + returns an object that contains all the details about the run. + + Only runs that are starting or running are aborted. For runs with status + `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing. + operationId: act_run_abort_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/gracefully" + deprecated: true + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actors/abort-run/abort-run + - https://docs.apify.com/api/v2#/reference/actors/abort-run + - https://docs.apify.com/api/v2#tag/ActorsAbort-run/operation/act_run_abort_post + +lastRunByActor: + <<: *sharedAbort + tags: + - Last Actor run's abort + summary: Abort Actor's last run + description: | + Aborts the last run of the specified Actor and returns an object that + contains all the details about the run. + + This endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run) + on the Actor's last run. Only runs that are starting or running are aborted. + For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call + does nothing. + operationId: act_runs_last_abort_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" + - $ref: "../../parameters/runAndBuildParameters.yaml#/gracefully" + +lastRunByActorTask: + <<: *sharedAbort + tags: + - Last Actor task run's abort + summary: Abort Actor task's last run + description: | + Aborts the last run of the specified Actor task and returns an object that + contains all the details about the run. + + This endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run) + on the Actor task's last run. Only runs that are starting or running are aborted. + For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call + does nothing. + operationId: actorTask_runs_last_abort_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" + - $ref: "../../parameters/runAndBuildParameters.yaml#/gracefully" diff --git a/apify-api/openapi/components/objects/actor-runs/charge.yaml b/apify-api/openapi/components/objects/actor-runs/charge.yaml new file mode 100644 index 0000000000..612f22da3c --- /dev/null +++ b/apify-api/openapi/components/objects/actor-runs/charge.yaml @@ -0,0 +1,69 @@ +byRunId: + tags: + - Actor runs + summary: Charge events in run + description: | + Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event). + The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured, + the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with. + + :::info Learn more about pay-per-event pricing + + For more details about pay-per-event (PPE) pricing, refer to our [PPE documentation](/platform/actors/publishing/monetize/pay-per-event). + + ::: + + operationId: PostChargeRun + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - name: idempotency-key + in: header + required: false + schema: + type: string + example: 2024-12-09T01:23:45.000Z-random-uuid + description: Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors. + requestBody: + description: "Define which event, and how many times, you want to charge for." + content: + application/json: + schema: + $ref: ../../schemas/actor-runs/ChargeRunRequest.yaml + example: + eventName: ANALYZE_PAGE + count: 1 + required: true + responses: + "201": + description: "The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually." + content: + application/json: + schema: + type: object + additionalProperties: false + "400": + $ref: ../../responses/BadRequest.yaml + "401": + $ref: ../../responses/Unauthorized.yaml + "403": + $ref: ../../responses/Forbidden.yaml + "404": + $ref: ../../responses/NotFound.yaml + "405": + $ref: ../../responses/MethodNotAllowed.yaml + "413": + $ref: ../../responses/PayloadTooLarge.yaml + "415": + $ref: ../../responses/UnsupportedMediaType.yaml + "429": + $ref: ../../responses/TooManyRequests.yaml + deprecated: false + x-js-parent: RunClient + x-js-name: charge + x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#charge + x-py-parent: RunClientAsync + x-py-name: charge + x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#charge + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run + - https://docs.apify.com/api/v2#tag/Actor-runsCharge-events-in-run/operation/PostChargeRun diff --git a/apify-api/openapi/components/objects/actor-runs/metamorph.yaml b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml new file mode 100644 index 0000000000..be3cffff4a --- /dev/null +++ b/apify-api/openapi/components/objects/actor-runs/metamorph.yaml @@ -0,0 +1,148 @@ +sharedMetamorph: &sharedMetamorph + responses: + "200": + description: "" + headers: {} + content: + application/json: + schema: + $ref: ../../schemas/actor-runs/RunResponse.yaml + "400": + $ref: ../../responses/BadRequest.yaml + "401": + $ref: ../../responses/Unauthorized.yaml + "403": + $ref: ../../responses/Forbidden.yaml + "404": + $ref: ../../responses/NotFound.yaml + "405": + $ref: ../../responses/MethodNotAllowed.yaml + "429": + $ref: ../../responses/TooManyRequests.yaml + deprecated: false + +buildQueryParameter: &buildQueryParameter + name: build + in: query + description: | + Optional build of the target Actor. + + It can be either a build tag or build number. By default, the run uses + the build specified in the default run configuration for the target + Actor (typically `latest`). + style: form + explode: true + schema: + type: string + example: beta + +byRunId: + <<: *sharedMetamorph + tags: + - Actor runs + summary: Metamorph run + description: | + Transforms an Actor run into a run of another Actor with a new input. + + This is useful if you want to use another Actor to finish the work + of your current Actor run, without the need to create a completely new run + and waiting for its finish. + + For the users of your Actors, the metamorph operation is transparent, they + will just see your Actor got the work done. + + Internally, the system stops the Docker container corresponding to the Actor + run and starts a new container using a different Docker image. + + All the default storages are preserved and the new input is stored under the + `INPUT-METAMORPH-1` key in the same default key-value store. + + For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph). + operationId: actorRun_metamorph_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/targetActorId" + - *buildQueryParameter + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run + - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run + - https://docs.apify.com/api/v2#tag/Actor-runsMetamorph-run/operation/actorRun_metamorph_post + x-js-parent: RunClient + x-js-name: metamorph + x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#metamorph + x-py-parent: RunClientAsync + x-py-name: metamorph + x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#metamorph + +byActorRunId: + <<: *sharedMetamorph + tags: + - Actors/Actor runs + summary: Metamorph run + description: | + **[DEPRECATED]** API endpoints related to run of the Actor were moved under + new namespace [`actor-runs`](#/reference/actor-runs). Transforms an Actor run + into a run of another Actor with a new input. + + This is useful if you want to use another Actor to finish the work + of your current Actor run, without the need to create a completely new run + and waiting for its finish. + For the users of your Actors, the metamorph operation is transparent, they + will just see your Actor got the work done. + + There is a limit on how many times you can metamorph a single run. You can + check the limit in [the Actor runtime limits](https://docs.apify.com/platform/limits#actor-limits). + + Internally, the system stops the Docker container corresponding to the Actor + run and starts a new container using a different Docker image. + All the default storages are preserved and the new input is stored under the + `INPUT-METAMORPH-1` key in the same default key-value store. + + For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph). + operationId: act_run_metamorph_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/targetActorId" + - *buildQueryParameter + deprecated: true + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actors/metamorph-run/metamorph-run + - https://docs.apify.com/api/v2#/reference/actors/metamorph-run + - https://docs.apify.com/api/v2#tag/ActorsMetamorph-run/operation/act_run_metamorph_post + +lastRunByActor: + <<: *sharedMetamorph + tags: + - Last Actor run's metamorph + summary: Metamorph Actor's last run + description: | + Transforms the last run of the specified Actor into a run of another Actor with + a new input. + + This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run) + on the Actor's last run. + operationId: act_runs_last_metamorph_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" + - $ref: "../../parameters/runAndBuildParameters.yaml#/targetActorId" + - *buildQueryParameter + +lastRunByActorTask: + <<: *sharedMetamorph + tags: + - Last Actor task run's metamorph + summary: Metamorph Actor task's last run + description: | + Transforms the last run of the specified Actor task into a run of another Actor with + a new input. + + This endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run) + on the Actor task's last run. + operationId: actorTask_runs_last_metamorph_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" + - $ref: "../../parameters/runAndBuildParameters.yaml#/targetActorId" + - *buildQueryParameter diff --git a/apify-api/openapi/components/objects/actor-runs/reboot.yaml b/apify-api/openapi/components/objects/actor-runs/reboot.yaml new file mode 100644 index 0000000000..1928d0145f --- /dev/null +++ b/apify-api/openapi/components/objects/actor-runs/reboot.yaml @@ -0,0 +1,85 @@ +sharedReboot: &sharedReboot + responses: + "200": + description: "" + headers: {} + content: + application/json: + schema: + $ref: ../../schemas/actor-runs/RunResponse.yaml + "400": + $ref: ../../responses/BadRequest.yaml + "401": + $ref: ../../responses/Unauthorized.yaml + "403": + $ref: ../../responses/Forbidden.yaml + "404": + $ref: ../../responses/NotFound.yaml + "405": + $ref: ../../responses/MethodNotAllowed.yaml + "429": + $ref: ../../responses/TooManyRequests.yaml + deprecated: false + +byRunId: + <<: *sharedReboot + tags: + - Actor runs + summary: Reboot run + description: | + Reboots an Actor run and returns an object that contains all the details + about the rebooted run. + + Only runs that are running, i.e. runs with status `RUNNING` can be rebooted. + + The run's container will be restarted, so any data not persisted in the + key-value store, dataset, or request queue will be lost. + operationId: actorRun_reboot_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run + - https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run + - https://docs.apify.com/api/v2#tag/Actor-runsReboot-run/operation/actorRun_reboot_post + x-js-parent: RunClient + x-js-name: reboot + x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#reboot + x-py-parent: RunClientAsync + x-py-name: reboot + x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#reboot + +lastRunByActor: + <<: *sharedReboot + tags: + - Last Actor run's reboot + summary: Reboot Actor's last run + description: | + Reboots the last run of the specified Actor and returns an object that + contains all the details about the rebooted run. + + This endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run) + on the Actor's last run. Only runs with status `RUNNING` can be rebooted. The run's + container will be restarted, so any data not persisted in the key-value store, dataset, + or request queue will be lost. + operationId: act_runs_last_reboot_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" + +lastRunByActorTask: + <<: *sharedReboot + tags: + - Last Actor task run's reboot + summary: Reboot Actor task's last run + description: | + Reboots the last run of the specified Actor task and returns an object that + contains all the details about the rebooted run. + + This endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run) + on the Actor task's last run. Only runs with status `RUNNING` can be rebooted. The run's + container will be restarted, so any data not persisted in the key-value store, dataset, + or request queue will be lost. + operationId: actorTask_runs_last_reboot_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun" diff --git a/apify-api/openapi/components/objects/actor-runs/resurrect.yaml b/apify-api/openapi/components/objects/actor-runs/resurrect.yaml new file mode 100644 index 0000000000..ffc76f0d0f --- /dev/null +++ b/apify-api/openapi/components/objects/actor-runs/resurrect.yaml @@ -0,0 +1,87 @@ +sharedResurrect: &sharedResurrect + responses: + "200": + description: "" + headers: {} + content: + application/json: + schema: + allOf: + - $ref: ../../schemas/actor-runs/RunResponse.yaml + "400": + $ref: ../../responses/BadRequest.yaml + "401": + $ref: ../../responses/Unauthorized.yaml + "403": + $ref: ../../responses/Forbidden.yaml + "404": + $ref: ../../responses/NotFound.yaml + "405": + $ref: ../../responses/MethodNotAllowed.yaml + "429": + $ref: ../../responses/TooManyRequests.yaml + deprecated: false + +byRunId: + <<: *sharedResurrect + tags: + - Actor runs + summary: Resurrect run + description: | + Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run. + Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected. + Run status will be updated to RUNNING and its container will be restarted with the same storages + (the same behaviour as when the run gets migrated to the new server). + + For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). + operationId: PostResurrectRun + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/buildResurrect" + - $ref: "../../parameters/runAndBuildParameters.yaml#/timeoutResurrect" + - $ref: "../../parameters/runAndBuildParameters.yaml#/memoryResurrect" + - $ref: "../../parameters/runAndBuildParameters.yaml#/maxItems" + - $ref: "../../parameters/runAndBuildParameters.yaml#/maxTotalChargeUsd" + - $ref: "../../parameters/runAndBuildParameters.yaml#/restartOnErrorResurrect" + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run + - https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run + - https://docs.apify.com/api/v2#tag/Actor-runsResurrect-run/operation/PostResurrectRun + x-js-parent: RunClient + x-js-name: resurrect + x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#resurrect + x-py-parent: RunClientAsync + x-py-name: resurrect + x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#resurrect + +byActorRunId: + <<: *sharedResurrect + tags: + - Actors/Actor runs + summary: Resurrect run + description: | + **[DEPRECATED]** API endpoints related to run of the Actor were moved under + new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished + Actor run and returns an object that contains all the details about the + resurrected run. + + Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` + and `TIMED-OUT` can be resurrected. + Run status will be updated to RUNNING and its container will be restarted + with the same storages + (the same behaviour as when the run gets migrated to the new server). + + For more information, see the [Actor + docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). + operationId: act_run_resurrect_post + parameters: + - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/runId" + - $ref: "../../parameters/runAndBuildParameters.yaml#/buildResurrect" + - $ref: "../../parameters/runAndBuildParameters.yaml#/timeoutResurrect" + - $ref: "../../parameters/runAndBuildParameters.yaml#/memoryResurrect" + - $ref: "../../parameters/runAndBuildParameters.yaml#/restartOnErrorResurrect" + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actors/resurrect-run/resurrect-run + - https://docs.apify.com/api/v2#/reference/actors/resurrect-run + - https://docs.apify.com/api/v2#tag/ActorsResurrect-run/operation/act_run_resurrect_post diff --git a/apify-api/openapi/components/schemas/common/ErrorType.yaml b/apify-api/openapi/components/schemas/common/ErrorType.yaml index 7d18ec687c..90259633db 100644 --- a/apify-api/openapi/components/schemas/common/ErrorType.yaml +++ b/apify-api/openapi/components/schemas/common/ErrorType.yaml @@ -126,6 +126,7 @@ enum: - expired-conference-token - failed-to-charge-user - final-invoice-negative + - full-permission-actor-not-approved - github-branch-empty - github-issue-already-exists - github-public-key-not-found @@ -297,6 +298,7 @@ enum: - requested-dataset-view-does-not-exist - resume-token-expired - run-failed + - run-input-body-not-valid-json - run-timeout-exceeded - russia-is-evil - same-user diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 44d3c3e109..2f89d6ab97 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -469,12 +469,48 @@ The API endpoint described in this section is convenience endpoint that provides access to last Actor run's log. Same as of functionality described in: [Logs](/api/v2/logs) +- name: Last Actor run's abort + x-displayName: Last Actor run's abort - Introduction + description: | + The API endpoint described in this section is a convenience endpoint that aborts the Actor's last run. + + Same as of functionality described in: [Abort run](/api/v2/actor-run-abort-post) +- name: Last Actor run's metamorph + x-displayName: Last Actor run's metamorph - Introduction + description: | + The API endpoint described in this section is a convenience endpoint that metamorphs the Actor's last run into a run of another Actor. + + Same as of functionality described in: [Metamorph run](/api/v2/actor-run-metamorph-post) +- name: Last Actor run's reboot + x-displayName: Last Actor run's reboot - Introduction + description: | + The API endpoint described in this section is a convenience endpoint that reboots the Actor's last run. + + Same as of functionality described in: [Reboot run](/api/v2/actor-run-reboot-post) - name: Last Actor task run's log x-displayName: Last Actor task run's log - Introduction description: | The API endpoint described in this section is convenience endpoint that provides access to last Actor task run's log. Same as of functionality described in: [Logs](/api/v2/logs) +- name: Last Actor task run's abort + x-displayName: Last Actor task run's abort - Introduction + description: | + The API endpoint described in this section is a convenience endpoint that aborts the Actor task's last run. + + Same as of functionality described in: [Abort run](/api/v2/actor-run-abort-post) +- name: Last Actor task run's metamorph + x-displayName: Last Actor task run's metamorph - Introduction + description: | + The API endpoint described in this section is a convenience endpoint that metamorphs the Actor task's last run into a run of another Actor. + + Same as of functionality described in: [Metamorph run](/api/v2/actor-run-metamorph-post) +- name: Last Actor task run's reboot + x-displayName: Last Actor task run's reboot - Introduction + description: | + The API endpoint described in this section is a convenience endpoint that reboots the Actor task's last run. + + Same as of functionality described in: [Reboot run](/api/v2/actor-run-reboot-post) - name: Last Actor task run's default dataset x-displayName: Last Actor task run's default dataset - Introduction description: | diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index 7b6a4da627..965604fe1b 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -50,7 +50,13 @@ - Last Actor run's default key-value store - Last Actor run's default request queue - Last Actor run's log + - Last Actor run's abort + - Last Actor run's metamorph + - Last Actor run's reboot - Last Actor task run's default dataset - Last Actor task run's default key-value store - Last Actor task run's default request queue - Last Actor task run's log + - Last Actor task run's abort + - Last Actor task run's metamorph + - Last Actor task run's reboot diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 54e44f9e9b..9d2e88b96c 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -548,6 +548,12 @@ paths: $ref: "paths/actors/acts@{actorId}@runs@last@request-queue@head@lock.yaml" "/v2/acts/{actorId}/runs/last/log": $ref: "paths/actors/acts@{actorId}@runs@last@log.yaml" + "/v2/acts/{actorId}/runs/last/abort": + $ref: "paths/actors/acts@{actorId}@runs@last@abort.yaml" + "/v2/acts/{actorId}/runs/last/metamorph": + $ref: "paths/actors/acts@{actorId}@runs@last@metamorph.yaml" + "/v2/acts/{actorId}/runs/last/reboot": + $ref: "paths/actors/acts@{actorId}@runs@last@reboot.yaml" "/v2/acts/{actorId}/runs/{runId}": $ref: "paths/actors/acts@{actorId}@runs@{runId}.yaml" "/v2/acts/{actorId}/runs/{runId}/abort": @@ -572,6 +578,12 @@ paths: $ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last.yaml" "/v2/actor-tasks/{actorTaskId}/runs/last/log": $ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@log.yaml" + "/v2/actor-tasks/{actorTaskId}/runs/last/abort": + $ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@abort.yaml" + "/v2/actor-tasks/{actorTaskId}/runs/last/metamorph": + $ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@metamorph.yaml" + "/v2/actor-tasks/{actorTaskId}/runs/last/reboot": + $ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@reboot.yaml" "/v2/actor-tasks/{actorTaskId}/runs/last/dataset": $ref: "paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@dataset.yaml" "/v2/actor-tasks/{actorTaskId}/runs/last/dataset/items": diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml index d06b77985a..59a085a8d8 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml @@ -1,47 +1,2 @@ post: - tags: - - Actor runs - summary: Abort run - description: | - Aborts an Actor run and returns an object that contains all the details - about the run. - - Only runs that are starting or running are aborted. For runs with status - `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing. - operationId: actorRun_abort_post - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/gracefully" - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - example: - $ref: ../../components/examples/AbortedRunExample.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: false - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run - - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run - - https://docs.apify.com/api/v2#tag/Actor-runsAbort-run/operation/actorRun_abort_post - x-js-parent: RunClient - x-js-name: abort - x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#abort - x-py-parent: RunClientAsync - x-py-name: abort - x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#abort + $ref: "../../components/objects/actor-runs/abort.yaml#/byRunId" diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml index 6f9902454b..8b557a574a 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml @@ -1,69 +1,2 @@ post: - tags: - - Actor runs - summary: Charge events in run - description: | - Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event). - The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured, - the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with. - - :::info Learn more about pay-per-event pricing - - For more details about pay-per-event (PPE) pricing, refer to our [PPE documentation](/platform/actors/publishing/monetize/pay-per-event). - - ::: - - operationId: PostChargeRun - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - name: idempotency-key - in: header - required: false - schema: - type: string - example: 2024-12-09T01:23:45.000Z-random-uuid - description: Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors. - requestBody: - description: "Define which event, and how many times, you want to charge for." - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/ChargeRunRequest.yaml - example: - eventName: ANALYZE_PAGE - count: 1 - required: true - responses: - "201": - description: "The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually." - content: - application/json: - schema: - type: object - additionalProperties: false - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "413": - $ref: ../../components/responses/PayloadTooLarge.yaml - "415": - $ref: ../../components/responses/UnsupportedMediaType.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: false - x-js-parent: RunClient - x-js-name: charge - x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#charge - x-py-parent: RunClientAsync - x-py-name: charge - x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#charge - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run - - https://docs.apify.com/api/v2#tag/Actor-runsCharge-events-in-run/operation/PostChargeRun + $ref: "../../components/objects/actor-runs/charge.yaml#/byRunId" diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml index deed646c11..8e24a3ab30 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml @@ -1,69 +1,2 @@ post: - tags: - - Actor runs - summary: Metamorph run - description: | - Transforms an Actor run into a run of another Actor with a new input. - - This is useful if you want to use another Actor to finish the work - of your current Actor run, without the need to create a completely new run - and waiting for its finish. - - For the users of your Actors, the metamorph operation is transparent, they - will just see your Actor got the work done. - - Internally, the system stops the Docker container corresponding to the Actor - run and starts a new container using a different Docker image. - - All the default storages are preserved and the new input is stored under the - `INPUT-METAMORPH-1` key in the same default key-value store. - - For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph). - operationId: actorRun_metamorph_post - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/targetActorId" - - name: build - in: query - description: | - Optional build of the target Actor. - - It can be either a build tag or build number. By default, the run uses - the build specified in the default run configuration for the target - Actor (typically `latest`). - style: form - explode: true - schema: - type: string - example: beta - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: false - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run - - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run - - https://docs.apify.com/api/v2#tag/Actor-runsMetamorph-run/operation/actorRun_metamorph_post - x-js-parent: RunClient - x-js-name: metamorph - x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#metamorph - x-py-parent: RunClientAsync - x-py-name: metamorph - x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#metamorph + $ref: "../../components/objects/actor-runs/metamorph.yaml#/byRunId" diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml index 31ced4eb9a..5e71248d4b 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml @@ -1,46 +1,2 @@ post: - tags: - - Actor runs - summary: Reboot run - description: | - Reboots an Actor run and returns an object that contains all the details - about the rebooted run. - - Only runs that are running, i.e. runs with status `RUNNING` can be rebooted. - - The run's container will be restarted, so any data not persisted in the - key-value store, dataset, or request queue will be lost. - operationId: actorRun_reboot_post - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: false - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run - - https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run - - https://docs.apify.com/api/v2#tag/Actor-runsReboot-run/operation/actorRun_reboot_post - x-js-parent: RunClient - x-js-name: reboot - x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#reboot - x-py-parent: RunClientAsync - x-py-name: reboot - x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#reboot + $ref: "../../components/objects/actor-runs/reboot.yaml#/byRunId" diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml index c3a1d996b3..838edab527 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml @@ -1,52 +1,2 @@ post: - tags: - - Actor runs - summary: Resurrect run - description: | - Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run. - Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected. - Run status will be updated to RUNNING and its container will be restarted with the same storages - (the same behaviour as when the run gets migrated to the new server). - - For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). - operationId: PostResurrectRun - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/buildResurrect" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/timeoutResurrect" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/memoryResurrect" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/maxItems" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/maxTotalChargeUsd" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/restartOnErrorResurrect" - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - allOf: - - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: false - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run - - https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run - - https://docs.apify.com/api/v2#tag/Actor-runsResurrect-run/operation/PostResurrectRun - x-js-parent: RunClient - x-js-name: resurrect - x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#resurrect - x-py-parent: RunClientAsync - x-py-name: resurrect - x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#resurrect + $ref: "../../components/objects/actor-runs/resurrect.yaml#/byRunId" diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@abort.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@abort.yaml new file mode 100644 index 0000000000..b54a5f6223 --- /dev/null +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@abort.yaml @@ -0,0 +1,2 @@ +post: + $ref: "../../components/objects/actor-runs/abort.yaml#/lastRunByActorTask" diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@metamorph.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@metamorph.yaml new file mode 100644 index 0000000000..478bf3a197 --- /dev/null +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@metamorph.yaml @@ -0,0 +1,2 @@ +post: + $ref: "../../components/objects/actor-runs/metamorph.yaml#/lastRunByActorTask" diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@reboot.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@reboot.yaml new file mode 100644 index 0000000000..8019770677 --- /dev/null +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs@last@reboot.yaml @@ -0,0 +1,2 @@ +post: + $ref: "../../components/objects/actor-runs/reboot.yaml#/lastRunByActorTask" 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 a6664423b7..9a642e2e92 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml @@ -27,11 +27,7 @@ get: $ref: ../../components/responses/BadRequest.yaml "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: - $ref: "../../components/schemas/common/errors/BuildErrors.yaml#/UnknownBuildTagError" + $ref: ../../components/responses/Forbidden.yaml "404": $ref: ../../components/responses/NotFound.yaml "405": diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@abort.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@abort.yaml new file mode 100644 index 0000000000..da4a719e45 --- /dev/null +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@abort.yaml @@ -0,0 +1,2 @@ +post: + $ref: "../../components/objects/actor-runs/abort.yaml#/lastRunByActor" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@metamorph.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@metamorph.yaml new file mode 100644 index 0000000000..38bbdd7c43 --- /dev/null +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@metamorph.yaml @@ -0,0 +1,2 @@ +post: + $ref: "../../components/objects/actor-runs/metamorph.yaml#/lastRunByActor" diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@reboot.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@reboot.yaml new file mode 100644 index 0000000000..e5ba2efee4 --- /dev/null +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last@reboot.yaml @@ -0,0 +1,2 @@ +post: + $ref: "../../components/objects/actor-runs/reboot.yaml#/lastRunByActor" 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 da58067506..bf2aee4646 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 @@ -1,43 +1,2 @@ post: - tags: - - Actors/Actor runs - summary: Abort run - description: | - **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs). Aborts an Actor run and - returns an object that contains all the details about the run. - - Only runs that are starting or running are aborted. For runs with status - `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing. - operationId: act_run_abort_post - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/gracefully" - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - example: - $ref: ../../components/examples/AbortedRunExample.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: true - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actors/abort-run/abort-run - - https://docs.apify.com/api/v2#/reference/actors/abort-run - - https://docs.apify.com/api/v2#tag/ActorsAbort-run/operation/act_run_abort_post + $ref: "../../components/objects/actor-runs/abort.yaml#/byActorRunId" 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 0e2c4002a0..efed960884 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 @@ -1,68 +1,2 @@ post: - tags: - - Actors/Actor runs - summary: Metamorph run - description: | - **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs).Transforms an Actor run - into a run of another Actor with a new input. - - This is useful if you want to use another Actor to finish the work - of your current Actor run, without the need to create a completely new run - and waiting for its finish. - For the users of your Actors, the metamorph operation is transparent, they - will just see your Actor got the work done. - - There is a limit on how many times you can metamorph a single run. You can - check the limit in [the Actor runtime limits](https://docs.apify.com/platform/limits#actor-limits). - - Internally, the system stops the Docker container corresponding to the Actor - run and starts a new container using a different Docker image. - All the default storages are preserved and the new input is stored under the - `INPUT-METAMORPH-1` key in the same default key-value store. - - For more information, see the [Actor - docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph). - operationId: act_run_metamorph_post - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/targetActorId" - - name: build - in: query - description: | - Optional build of the target Actor. - - It can be either a build tag or build number. By default, the run uses - the build specified in the default run configuration for the target - Actor (typically `latest`). - style: form - explode: true - schema: - type: string - example: beta - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: true - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actors/metamorph-run/metamorph-run - - https://docs.apify.com/api/v2#/reference/actors/metamorph-run - - https://docs.apify.com/api/v2#tag/ActorsMetamorph-run/operation/act_run_metamorph_post + $ref: "../../components/objects/actor-runs/metamorph.yaml#/byActorRunId" 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 af7c2fa1a1..3e1a747af5 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 @@ -1,51 +1,2 @@ post: - tags: - - Actors/Actor runs - summary: Resurrect run - description: | - **[DEPRECATED]** API endpoints related to run of the Actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished - Actor run and returns an object that contains all the details about the - resurrected run. - - Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` - and `TIMED-OUT` can be resurrected. - Run status will be updated to RUNNING and its container will be restarted - with the same storages - (the same behaviour as when the run gets migrated to the new server). - - For more information, see the [Actor - docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). - operationId: act_run_resurrect_post - parameters: - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/runId" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/buildResurrect" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/timeoutResurrect" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/memoryResurrect" - - $ref: "../../components/parameters/runAndBuildParameters.yaml#/restartOnErrorResurrect" - responses: - "200": - description: "" - headers: {} - content: - application/json: - schema: - $ref: ../../components/schemas/actor-runs/RunResponse.yaml - "400": - $ref: ../../components/responses/BadRequest.yaml - "401": - $ref: ../../components/responses/Unauthorized.yaml - "403": - $ref: ../../components/responses/Forbidden.yaml - "404": - $ref: ../../components/responses/NotFound.yaml - "405": - $ref: ../../components/responses/MethodNotAllowed.yaml - "429": - $ref: ../../components/responses/TooManyRequests.yaml - deprecated: false - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actors/resurrect-run/resurrect-run - - https://docs.apify.com/api/v2#/reference/actors/resurrect-run - - https://docs.apify.com/api/v2#tag/ActorsResurrect-run/operation/act_run_resurrect_post + $ref: "../../components/objects/actor-runs/resurrect.yaml#/byActorRunId"