From 1c2d459f47edbc696b0a0adf95970ae1d24e15c4 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Tue, 12 May 2026 11:06:12 +0200 Subject: [PATCH] feat(openapi): Tag Actor Runtime API implementation endpoints --- .../objects/datasets/dataset-items.yaml | 6 ++++ .../components/objects/datasets/dataset.yaml | 3 ++ .../key-value-store-keys.yaml | 3 ++ .../key-value-store-record.yaml | 12 +++++++ .../key-value-stores/key-value-store.yaml | 3 ++ apify-api/openapi/components/tags.yaml | 34 +++++++++++++++++++ .../openapi/components/x-tag-groups.yaml | 7 ++++ .../paths/actor-runs/actor-runs@{runId}.yaml | 2 ++ .../actor-runs/actor-runs@{runId}@abort.yaml | 1 + .../actor-runs/actor-runs@{runId}@charge.yaml | 1 + .../actor-runs@{runId}@metamorph.yaml | 1 + .../actor-runs/actor-runs@{runId}@reboot.yaml | 1 + .../paths/actors/acts@{actorId}@runs.yaml | 1 + .../openapi/paths/datasets/datasets.yaml | 1 + .../key-value-stores/key-value-stores.yaml | 1 + 15 files changed, 77 insertions(+) diff --git a/apify-api/openapi/components/objects/datasets/dataset-items.yaml b/apify-api/openapi/components/objects/datasets/dataset-items.yaml index 008e06e3b8..c54e309af1 100644 --- a/apify-api/openapi/components/objects/datasets/dataset-items.yaml +++ b/apify-api/openapi/components/objects/datasets/dataset-items.yaml @@ -94,6 +94,9 @@ sharedGet: &sharedGet getById: <<: [*sharedGet, *sharedTagById, *parametersGetHeadById] + tags: + - Storage/Datasets + - Actor Runtime API/Datasets summary: Get dataset items description: | Returns data stored in the dataset in a desired format. @@ -418,6 +421,9 @@ sharedPost: &sharedPost postById: <<: [*sharedPost, *sharedTagById] + tags: + - Storage/Datasets + - Actor Runtime API/Datasets summary: Store items description: | Appends an item or an array of items to the end of the dataset. diff --git a/apify-api/openapi/components/objects/datasets/dataset.yaml b/apify-api/openapi/components/objects/datasets/dataset.yaml index 5729c6b63b..99aee691c0 100644 --- a/apify-api/openapi/components/objects/datasets/dataset.yaml +++ b/apify-api/openapi/components/objects/datasets/dataset.yaml @@ -54,6 +54,9 @@ sharedGet: &sharedGet getById: <<: [*sharedGet, *sharedById] + tags: + - Storage/Datasets + - Actor Runtime API/Datasets summary: Get dataset description: | Returns dataset object for given dataset ID. diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml index 5c1df9a348..00c0be8951 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store-keys.yaml @@ -42,6 +42,9 @@ sharedGet: &sharedGet getById: <<: [*sharedGet, *sharedTagById] + tags: + - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Get list of keys description: | Returns a list of objects describing keys of a given key-value store, as diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml index 6c21a887c3..5a4a4799e7 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store-record.yaml @@ -95,6 +95,9 @@ sharedPutPost: &sharedPutPost getById: <<: [*sharedGet, *sharedTagById] + tags: + - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Get record description: | Gets a value stored in the key-value store under a specific key. @@ -201,6 +204,9 @@ headById: putById: <<: [*sharedPutPost, *sharedTagById] + tags: + - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Store record description: | Stores a value under a specific key to the key-value store. @@ -281,6 +287,9 @@ putTaskLastRun: postById: <<: [*sharedPutPost, *sharedTagById] + tags: + - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Store record (POST) description: | Stores a value under a specific key to the key-value store. @@ -342,6 +351,9 @@ postTaskLastRun: deleteById: <<: [*sharedDelete, *sharedTagById] + tags: + - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Delete record description: Removes a record specified by a key from the key-value store. operationId: keyValueStore_record_delete diff --git a/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml b/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml index e128e504a4..746abbc151 100644 --- a/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml +++ b/apify-api/openapi/components/objects/key-value-stores/key-value-store.yaml @@ -54,6 +54,9 @@ sharedGet: &sharedGet getById: <<: [*sharedGet, *sharedById] + tags: + - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Get store description: | Gets an object that contains all the details about a specific key-value diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 44d3c3e109..6b6064fbd0 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -427,6 +427,40 @@ description: | The API endpoints described in this section provide utility tools for encoding, signing, and verifying data, as well as inspecting HTTP request details. +- name: Actor Runtime API + x-displayName: "" + description: | + The Actor Runtime API is the HTTP REST interface between a running Actor (front-end SDK) and the Actor runtime system (back-end). + This subset of the Apify API enables thin, language-agnostic SDKs to be auto-generated for any programming language, + and allows third-party implementations of the Actor runtime back-end. + + For the full Actor specification, see the [Actor Programming Model Whitepaper](https://github.com/apify/actor-whitepaper). +- name: Actor Runtime API/Actor runs + x-displayName: Actor runs + x-parent-tag-name: Actor Runtime API + x-trait: "true" + description: | + Manage Actor runs - get status, update status message, abort, reboot, metamorph, and charge users. +- name: Actor Runtime API/Start Actor + x-displayName: Start Actor + x-parent-tag-name: Actor Runtime API + x-trait: "true" + description: | + Start a new Actor run. Requires the Actor ID to identify which Actor to start. +- name: Actor Runtime API/Key-value stores + x-displayName: Key-value stores + x-parent-tag-name: Actor Runtime API + x-trait: "true" + description: | + Read, write, and delete records in key-value stores. Key-value stores hold arbitrary files (binary or JSON) + identified by string keys. Each Actor run has a default key-value store that contains the Actor's input. +- name: Actor Runtime API/Datasets + x-displayName: Datasets + x-parent-tag-name: Actor Runtime API + x-trait: "true" + description: | + Append and read items from datasets. Datasets are append-only storage for structured JSON objects. + Each Actor run has a default dataset for storing results. - name: Default dataset x-displayName: Default dataset - Introduction description: | diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index 7b6a4da627..ac82c31202 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -41,6 +41,13 @@ - name: Tools tags: - Tools +- name: Actor Runtime API + tags: + - Actor Runtime API + - Actor Runtime API/Actor runs + - Actor Runtime API/Start Actor + - Actor Runtime API/Key-value stores + - Actor Runtime API/Datasets - name: Convenience endpoints tags: - Default dataset diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml index ab329bfbab..9594c190cb 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml @@ -1,6 +1,7 @@ get: tags: - Actor runs + - Actor Runtime API/Actor runs summary: Get run description: | This is not a single endpoint, but an entire group of endpoints that lets @@ -55,6 +56,7 @@ get: put: tags: - Actor runs + - Actor Runtime API/Actor runs summary: Update run description: | This endpoint can be used to update both the run's status message and to configure its general resource access level. diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml index d06b77985a..a2e5874303 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml @@ -1,6 +1,7 @@ post: tags: - Actor runs + - Actor Runtime API/Actor runs summary: Abort run description: | Aborts an Actor run and returns an object that contains all the details diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml index 6f9902454b..d4b74dde8c 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml @@ -1,6 +1,7 @@ post: tags: - Actor runs + - Actor Runtime API/Actor runs summary: Charge events in run description: | Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event). diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml index deed646c11..c09de41096 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml @@ -1,6 +1,7 @@ post: tags: - Actor runs + - Actor Runtime API/Actor runs summary: Metamorph run description: | Transforms an Actor run into a run of another Actor with a new input. diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml index 31ced4eb9a..24abe20a6c 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml @@ -1,6 +1,7 @@ post: tags: - Actor runs + - Actor Runtime API/Actor runs summary: Reboot run description: | Reboots an Actor run and returns an object that contains all the details diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index 5e8578d773..9f54c8dccf 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -60,6 +60,7 @@ get: post: tags: - Actors/Actor runs + - Actor Runtime API/Start Actor summary: Run Actor description: | Runs an Actor and immediately returns without waiting for the run to finish. diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index 7c3563c738..b0c71de2bf 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -62,6 +62,7 @@ get: post: tags: - Storage/Datasets + - Actor Runtime API/Datasets summary: Create dataset description: | Creates a dataset and returns its object. diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml index a34ceb5ecd..3ab6450d92 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores.yaml @@ -64,6 +64,7 @@ get: post: tags: - Storage/Key-value stores + - Actor Runtime API/Key-value stores summary: Create key-value store description: | Creates a key-value store and returns its object. The response is the same