Skip to content

Commit 5ee5a14

Browse files
authored
docs: update actor tagged builds manually (#1945)
This PR updates the API documentation to reflect that tagged builds can now be modified manually via the public API.
1 parent 3f023dd commit 5ee5a14

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,24 @@ properties:
5050
oneOf:
5151
- nullable: true
5252
- $ref: ./DefaultRunOptions.yaml
53+
taggedBuilds:
54+
type: object
55+
description: |
56+
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.
57+
The object you provide will completely overwrite all existing tagged builds for the Actor.
58+
59+
- To create or reassign a tag: Include it in the object with the desired `buildId`.
60+
- To remove a specific tag: Submit the object without that tag's key.
61+
- To remove all tags: Provide an empty object: `{}`.
62+
- If this field is omitted or `null`, the existing tags will not be changed.
63+
nullable: true
64+
additionalProperties:
65+
type: object
66+
required:
67+
- buildId
68+
properties:
69+
buildId:
70+
type: string
71+
example:
72+
latest:
73+
buildId: z2EryhbfhgSyqj6Hn

sources/platform/actors/running/runs_and_builds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ An Actor is a combination of source code and various settings in a Docker contai
1717
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/).
1818
:::
1919

20-
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.
20+
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.
2121

2222
![Actor run options](./images/runs_and_builds/actor-run-options.png)
2323

0 commit comments

Comments
 (0)