Skip to content

Commit 859a86e

Browse files
committed
feat: update tagged builds API docs
1 parent f7000af commit 859a86e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,18 @@ properties:
5353
taggedBuilds:
5454
type: object
5555
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.
56+
An object to modify the Actor's tagged builds. The key is the tag name (e.g., `latest`), and the value is either an object with a `buildId` or `null`.
5857
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.
58+
This operation is a patch; any existing tags that you omit from this object will be preserved.
59+
60+
- **To create or reassign a tag:** Provide the tag name as a key with an object containing the desired `buildId`.
61+
- **To remove a tag:** Provide the tag name as a key with a `null` value.
62+
- **To preserve an existing tag:** Omit its key from this object.
63+
- **To make no changes:** Omit this field entirely.
6364
nullable: true
6465
additionalProperties:
6566
type: object
67+
nullable: true
6668
required:
6769
- buildId
6870
properties:
@@ -71,3 +73,4 @@ properties:
7173
example:
7274
latest:
7375
buildId: z2EryhbfhgSyqj6Hn
76+
beta: null

0 commit comments

Comments
 (0)