Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions apify-api/openapi/components/objects/datasets/dataset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
34 changes: 34 additions & 0 deletions apify-api/openapi/components/tags.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
7 changes: 7 additions & 0 deletions apify-api/openapi/components/x-tag-groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions apify-api/openapi/paths/datasets/datasets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ get:
post:
tags:
- Storage/Datasets
- Actor Runtime API/Datasets
summary: Create dataset
description: |
Creates a dataset and returns its object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading