diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 67fe295422..46a67727f2 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -50,3 +50,24 @@ properties: oneOf: - 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. + + - 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. + nullable: true + additionalProperties: + type: object + required: + - buildId + properties: + buildId: + type: string + example: + latest: + buildId: z2EryhbfhgSyqj6Hn diff --git a/sources/platform/actors/running/runs_and_builds.md b/sources/platform/actors/running/runs_and_builds.md index e6176b1197..9accc07dae 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)