From 183395da17d7cc307c8f62ac3bd1542701beb3a7 Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 11:04:02 +0200 Subject: [PATCH 1/7] feat: update actor tagged builds openapi --- .../schemas/actors/UpdateActorRequest.yaml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 67fe295422..802a76fbfb 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -34,7 +34,7 @@ properties: versions: type: array items: - $ref: "./CreateOrUpdateEnvVarRequest.yaml" + $ref: './CreateOrUpdateEnvVarRequest.yaml' description: '' pricingInfos: type: array @@ -50,3 +50,15 @@ properties: oneOf: - nullable: true - $ref: ./DefaultRunOptions.yaml + taggedBuilds: + type: object + additionalProperties: + type: object + required: + - buildId + properties: + buildId: + type: string + example: + latest: + buildId: z2EryhbfhgSyqj6Hn From 04d201a5832384d570ad0006524e239f5c177e6c Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 11:18:37 +0200 Subject: [PATCH 2/7] feat: update docs --- .../actors/running/runs_and_builds.md | 31 +++++++++---------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/sources/platform/actors/running/runs_and_builds.md b/sources/platform/actors/running/runs_and_builds.md index e6176b1197..6301f1ab05 100644 --- a/sources/platform/actors/running/runs_and_builds.md +++ b/sources/platform/actors/running/runs_and_builds.md @@ -17,7 +17,7 @@ An Actor is a combination of source code and various settings in a Docker contai A Docker image is a lightweight, standalone, executable package of software that includes everything needed to run an application: code, runtime, system tools, system libraries, and settings. For more information visit Docker's [site](https://www.docker.com/resources/what-container/). ::: -With every new version of an Actor, a new build is created. Each Actor build has its number (for example, **1.2.34**), and some builds are tagged for easier use (for example, _latest_ or _beta_). When running an Actor, you can choose what build you want to run by selecting a tag or number in the run options. +With every new version of an Actor, a new build is created. Each Actor build has its number (for example, **1.2.34**), and some builds are tagged for easier use (for example, _latest_ or _beta_). When running an Actor, you can choose what build you want to run by selecting a tag or number in the run options. To change which build a tag refers to, you can reassign it using the [Actor update](/api/v2/act-put) API endpoint. ![Actor run options](./images/runs_and_builds/actor-run-options.png) @@ -41,16 +41,16 @@ What's happening inside of an Actor is visible on the Actor run log in the Actor Both **Actor runs** and **builds** have the **Origin** field indicating how the Actor run or build was invoked, respectively. The origin is displayed in Apify Console and available via [API](https://docs.apify.com/api/v2/actor-run-get) in the `meta.origin` field. -|Name|Origin| -|:---|:---| -|`DEVELOPMENT`|Manually from Apify Console in the Development mode (own Actor)| -|`WEB`|Manually from Apify Console in "normal" mode (someone else's Actor or task)| -|`API`|From [Apify API](https://docs.apify.com/api)| -|`CLI`|From [Apify CLI](https://docs.apify.com/cli/)| -|`SCHEDULER`|Using a schedule| -|`WEBHOOK`|Using a webhook| -|`ACTOR`|From another Actor run| -|`STANDBY`|From [Actor Standby](./standby)| +| Name | Origin | +| :------------ | :-------------------------------------------------------------------------- | +| `DEVELOPMENT` | Manually from Apify Console in the Development mode (own Actor) | +| `WEB` | Manually from Apify Console in "normal" mode (someone else's Actor or task) | +| `API` | From [Apify API](https://docs.apify.com/api) | +| `CLI` | From [Apify CLI](https://docs.apify.com/cli/) | +| `SCHEDULER` | Using a schedule | +| `WEBHOOK` | Using a webhook | +| `ACTOR` | From another Actor run | +| `STANDBY` | From [Actor Standby](./standby) | ## Lifecycle @@ -81,16 +81,15 @@ flowchart LR --- | Status | Type | Description | -|:-----------|:-------------|:--------------------------------------------| +| :--------- | :----------- | :------------------------------------------ | | READY | initial | Started but not allocated to any worker yet | | RUNNING | transitional | Executing on a worker machine | | SUCCEEDED | terminal | Finished successfully | | FAILED | terminal | Run failed | | TIMING-OUT | transitional | Timing out now | | TIMED-OUT | terminal | Timed out | -| ABORTING | transitional | Being aborted by the user | -| ABORTED | terminal | Aborted by the user | - +| ABORTING | transitional | Being aborted by the user | +| ABORTED | terminal | Aborted by the user | ### Aborting runs @@ -119,7 +118,7 @@ You can also adjust timeout and memory or change Actor build before the resurrec 1. Abort a broken run 2. Update the Actor's code and build the new version 3. Resurrect the run using the new build -::: + ::: ### Data retention From 8a58a033d8db1fbd958372580ad29b27d257b872 Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 11:21:39 +0200 Subject: [PATCH 3/7] fix --- .../openapi/components/schemas/actors/UpdateActorRequest.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 802a76fbfb..dad1a2a50f 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -34,7 +34,7 @@ properties: versions: type: array items: - $ref: './CreateOrUpdateEnvVarRequest.yaml' + $ref: "./CreateOrUpdateEnvVarRequest.yaml" description: '' pricingInfos: type: array From e899fd47fde87ef8d736a92f44eb755562a21a88 Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 11:22:20 +0200 Subject: [PATCH 4/7] fix formatting --- .../actors/running/runs_and_builds.md | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/sources/platform/actors/running/runs_and_builds.md b/sources/platform/actors/running/runs_and_builds.md index 6301f1ab05..9accc07dae 100644 --- a/sources/platform/actors/running/runs_and_builds.md +++ b/sources/platform/actors/running/runs_and_builds.md @@ -41,16 +41,16 @@ What's happening inside of an Actor is visible on the Actor run log in the Actor Both **Actor runs** and **builds** have the **Origin** field indicating how the Actor run or build was invoked, respectively. The origin is displayed in Apify Console and available via [API](https://docs.apify.com/api/v2/actor-run-get) in the `meta.origin` field. -| Name | Origin | -| :------------ | :-------------------------------------------------------------------------- | -| `DEVELOPMENT` | Manually from Apify Console in the Development mode (own Actor) | -| `WEB` | Manually from Apify Console in "normal" mode (someone else's Actor or task) | -| `API` | From [Apify API](https://docs.apify.com/api) | -| `CLI` | From [Apify CLI](https://docs.apify.com/cli/) | -| `SCHEDULER` | Using a schedule | -| `WEBHOOK` | Using a webhook | -| `ACTOR` | From another Actor run | -| `STANDBY` | From [Actor Standby](./standby) | +|Name|Origin| +|:---|:---| +|`DEVELOPMENT`|Manually from Apify Console in the Development mode (own Actor)| +|`WEB`|Manually from Apify Console in "normal" mode (someone else's Actor or task)| +|`API`|From [Apify API](https://docs.apify.com/api)| +|`CLI`|From [Apify CLI](https://docs.apify.com/cli/)| +|`SCHEDULER`|Using a schedule| +|`WEBHOOK`|Using a webhook| +|`ACTOR`|From another Actor run| +|`STANDBY`|From [Actor Standby](./standby)| ## Lifecycle @@ -81,15 +81,16 @@ flowchart LR --- | Status | Type | Description | -| :--------- | :----------- | :------------------------------------------ | +|:-----------|:-------------|:--------------------------------------------| | READY | initial | Started but not allocated to any worker yet | | RUNNING | transitional | Executing on a worker machine | | SUCCEEDED | terminal | Finished successfully | | FAILED | terminal | Run failed | | TIMING-OUT | transitional | Timing out now | | TIMED-OUT | terminal | Timed out | -| ABORTING | transitional | Being aborted by the user | -| ABORTED | terminal | Aborted by the user | +| ABORTING | transitional | Being aborted by the user | +| ABORTED | terminal | Aborted by the user | + ### Aborting runs @@ -118,7 +119,7 @@ You can also adjust timeout and memory or change Actor build before the resurrec 1. Abort a broken run 2. Update the Actor's code and build the new version 3. Resurrect the run using the new build - ::: +::: ### Data retention From c92eef64b150a08a52ed091f4bde71510bbca55d Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 12:58:17 +0200 Subject: [PATCH 5/7] add description --- .../components/schemas/actors/UpdateActorRequest.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index dad1a2a50f..59dce33d92 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -51,6 +51,14 @@ properties: - nullable: true - $ref: ./DefaultRunOptions.yaml taggedBuilds: + description: | + Object containing the Actor's tagged builds, where the key is the tag name (e.g., `latest`) and the value is an object containing the build ID. + The object you provide will completely overwrite all existing tagged builds for the Actor. + + - To create or reassign a tag: Include it in the object with the desired `buildId`. + - To remove a specific tag: Submit the object without that tag's key. + - To remove all tags: Provide an empty object: `{}`. + - If this field is omitted or `null`, the existing tags will not be changed. type: object additionalProperties: type: object From 15b1604c35f8c1f97d8680b12be7774c949e6878 Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 13:34:05 +0200 Subject: [PATCH 6/7] add nullable option --- .../openapi/components/schemas/actors/UpdateActorRequest.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 59dce33d92..f621d413b5 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -51,6 +51,7 @@ properties: - nullable: true - $ref: ./DefaultRunOptions.yaml taggedBuilds: + type: object description: | Object containing the Actor's tagged builds, where the key is the tag name (e.g., `latest`) and the value is an object containing the build ID. The object you provide will completely overwrite all existing tagged builds for the Actor. @@ -59,7 +60,7 @@ properties: - To remove a specific tag: Submit the object without that tag's key. - To remove all tags: Provide an empty object: `{}`. - If this field is omitted or `null`, the existing tags will not be changed. - type: object + nullable: true additionalProperties: type: object required: From 51d630164cd618f742b92b1db727eff4bbe00d39 Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 24 Sep 2025 13:43:44 +0200 Subject: [PATCH 7/7] fix: tag example formatting --- .../openapi/components/schemas/actors/UpdateActorRequest.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index f621d413b5..46a67727f2 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -53,7 +53,7 @@ properties: taggedBuilds: type: object description: | - Object containing the Actor's tagged builds, where the key is the tag name (e.g., `latest`) and the value is an object containing the build ID. + Object containing the Actor's tagged builds, where the key is the tag name (e.g., _latest_) and the value is an object containing the build ID. The object you provide will completely overwrite all existing tagged builds for the Actor. - To create or reassign a tag: Include it in the object with the desired `buildId`.