From 859a86e893f1dcc2b4537d2b09a38c8e54504720 Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 15 Oct 2025 14:15:30 +0200 Subject: [PATCH 1/5] feat: update tagged builds API docs --- .../schemas/actors/UpdateActorRequest.yaml | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 46a67727f2..23bdfeea07 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -53,16 +53,18 @@ 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. - The object you provide will completely overwrite all existing tagged builds for the Actor. + 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`. - - 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. + This operation is a patch; any existing tags that you omit from this object will be preserved. + + - **To create or reassign a tag:** Provide the tag name as a key with an object containing the desired `buildId`. + - **To remove a tag:** Provide the tag name as a key with a `null` value. + - **To preserve an existing tag:** Omit its key from this object. + - **To make no changes:** Omit this field entirely. nullable: true additionalProperties: type: object + nullable: true required: - buildId properties: @@ -71,3 +73,4 @@ properties: example: latest: buildId: z2EryhbfhgSyqj6Hn + beta: null From a6adb4308ce9198aa364be0cfeed9c150af2c57e Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 15 Oct 2025 14:21:25 +0200 Subject: [PATCH 2/5] fix format --- .../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 23bdfeea07..28762cbb3a 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: | - 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`. + 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`. This operation is a patch; any existing tags that you omit from this object will be preserved. From 052759ff852eca8d1dd53ca792c345e9e2ec26d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludv=C3=ADk=20Prokopec?= <39367469+lewis-wow@users.noreply.github.com> Date: Wed, 15 Oct 2025 15:51:41 +0200 Subject: [PATCH 3/5] Update apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tobiáš Potoček --- .../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 28762cbb3a..62f66d0cc7 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: | - 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`. + An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`. This operation is a patch; any existing tags that you omit from this object will be preserved. From 4d42ee4dd51ad8c02a5c2a4ce950ef9b38164d2c Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Wed, 15 Oct 2025 16:58:07 +0200 Subject: [PATCH 4/5] examples in description --- .../schemas/actors/UpdateActorRequest.yaml | 38 +++++++++++++++++-- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml index 28762cbb3a..52560f708f 100644 --- a/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml +++ b/apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml @@ -57,10 +57,40 @@ properties: This operation is a patch; any existing tags that you omit from this object will be preserved. - - **To create or reassign a tag:** Provide the tag name as a key with an object containing the desired `buildId`. - - **To remove a tag:** Provide the tag name as a key with a `null` value. - - **To preserve an existing tag:** Omit its key from this object. - - **To make no changes:** Omit this field entirely. + - **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag: + +   + + ```json + { + "latest": { + "buildId": "z2EryhbfhgSyqj6Hn" + } + } + ``` + + - **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag: + +   + + ```json + { + "beta": null + } + ``` + + - **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags. + +   + + ```json + { + "latest": { + "buildId": "z2EryhbfhgSyqj6Hn" + }, + "beta": null + } + ``` nullable: true additionalProperties: type: object From 2170efff0662ca3e3f7c8bc7b9043788abec2bae Mon Sep 17 00:00:00 2001 From: lewis-wow Date: Thu, 16 Oct 2025 10:41:10 +0200 Subject: [PATCH 5/5] add examples --- .../openapi/paths/actors/acts@{actorId}.yaml | 73 ++++++++++++------- 1 file changed, 47 insertions(+), 26 deletions(-) diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 7ce22bfe2c..f86cfb3428 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -133,32 +133,53 @@ put: application/json: schema: $ref: "../../components/schemas/actors/UpdateActorRequest.yaml" - example: - name: MyActor - description: My favourite Actor! - isPublic: false - seoTitle: My Actor - seoDescription: My Actor is the best - title: My Actor - restartOnError: false - versions: - - versionNumber: '0.0' - sourceType: SOURCE_FILES - envVars: - - name: DOMAIN - value: 'http://example.com' - isSecret: false - - name: SECRET_PASSWORD - value: MyTopSecretPassword123 - isSecret: true - applyEnvVarsToBuild: false - buildTag: latest - sourceFiles: [] - categories: [] - defaultRunOptions: - build: latest - timeoutSecs: 3600 - memoryMbytes: 2048 + examples: + common: + summary: 'Common example' + value: + name: MyActor + description: My favourite Actor! + isPublic: false + seoTitle: My Actor + seoDescription: My Actor is the best + title: My Actor + restartOnError: false + versions: + - versionNumber: '0.0' + sourceType: SOURCE_FILES + envVars: + - name: DOMAIN + value: 'http://example.com' + isSecret: false + - name: SECRET_PASSWORD + value: MyTopSecretPassword123 + isSecret: true + applyEnvVarsToBuild: false + buildTag: latest + sourceFiles: [] + categories: [] + defaultRunOptions: + build: latest + timeoutSecs: 3600 + memoryMbytes: 2048 + taggedBuildsCreateOrReassignTag: + summary: 'Create or reassign a build tag' + value: + taggedBuilds: + latest: + buildId: 'z2EryhbfhgSyqj6Hn' + taggedBuildsRemoveTag: + summary: 'Remove a build tag' + value: + taggedBuilds: + latest: null + taggedBuildsMultipleOperations: + summary: 'Update multiple build tags at once' + value: + taggedBuilds: + latest: + buildId: 'z2EryhbfhgSyqj6Hn' + beta: null required: true responses: '200':