From 14a93120398efea0632456dc66eb89d37ad9583e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 5 Feb 2025 22:41:49 +0100 Subject: [PATCH 01/11] docs: reorganize api docs --- apify-api/openapi/components/tags.yaml | 700 ++++-------------- .../openapi/components/x-tag-groups.yaml | 92 +-- apify-api/openapi/openapi.yaml | 4 +- .../paths/actor-builds/actor-builds.yaml | 2 +- .../actor-builds/actor-builds@{buildId}.yaml | 2 +- .../actor-builds@{buildId}@abort.yaml | 2 +- .../actor-builds@{buildId}@log.yaml | 2 +- .../actor-builds@{buildId}@openapi.json.yaml | 9 +- .../openapi/paths/actor-runs/actor-runs.yaml | 2 +- .../paths/actor-runs/actor-runs@{runId}.yaml | 69 +- .../actor-runs/actor-runs@{runId}@abort.yaml | 2 +- .../actor-runs/actor-runs@{runId}@charge.yaml | 6 +- .../actor-runs@{runId}@metamorph.yaml | 2 +- .../actor-runs/actor-runs@{runId}@reboot.yaml | 2 +- .../actor-runs@{runId}@resurrect.yaml | 4 +- .../paths/actor-tasks/actor-tasks.yaml | 4 +- .../actor-tasks@{actorTaskId}.yaml | 6 +- .../actor-tasks@{actorTaskId}@input.yaml | 4 +- ...torTaskId}@run-sync-get-dataset-items.yaml | 4 +- .../actor-tasks@{actorTaskId}@run-sync.yaml | 4 +- .../actor-tasks@{actorTaskId}@runs.yaml | 4 +- .../actor-tasks@{actorTaskId}@webhooks.yaml | 2 +- apify-api/openapi/paths/actors/acts.yaml | 4 +- .../openapi/paths/actors/acts@{actorId}.yaml | 6 +- .../paths/actors/acts@{actorId}@builds.yaml | 4 +- .../actors/acts@{actorId}@builds@default.yaml | 10 +- .../acts@{actorId}@builds@{buildId}.yaml | 2 +- ...acts@{actorId}@builds@{buildId}@abort.yaml | 2 +- ...ctorId}@builds@{buildId}@openapi.json.yaml | 10 +- ...@{actorId}@run-sync-get-dataset-items.yaml | 4 +- .../paths/actors/acts@{actorId}@run-sync.yaml | 4 +- .../paths/actors/acts@{actorId}@runs.yaml | 4 +- .../actors/acts@{actorId}@runs@{runId}.yaml | 2 +- .../acts@{actorId}@runs@{runId}@abort.yaml | 2 +- ...acts@{actorId}@runs@{runId}@metamorph.yaml | 2 +- ...acts@{actorId}@runs@{runId}@resurrect.yaml | 2 +- .../paths/actors/acts@{actorId}@versions.yaml | 4 +- ...ts@{actorId}@versions@{versionNumber}.yaml | 6 +- ...Id}@versions@{versionNumber}@env-vars.yaml | 4 +- ...{versionNumber}@env-vars@{envVarName}.yaml | 6 +- .../openapi/paths/datasets/datasets.yaml | 4 +- .../paths/datasets/datasets@{datasetId}.yaml | 6 +- .../datasets/datasets@{datasetId}@items.yaml | 4 +- .../datasets@{datasetId}@statistics.yaml | 2 +- .../key-value-stores/key-value-stores.yaml | 4 +- .../key-value-stores@{storeId}.yaml | 6 +- .../key-value-stores@{storeId}@keys.yaml | 2 +- ...-stores@{storeId}@records@{recordKey}.yaml | 10 +- .../paths/request-queues/request-queues.yaml | 4 +- .../request-queues@{queueId}.yaml | 6 +- .../request-queues@{queueId}@head.yaml | 2 +- .../request-queues@{queueId}@head@lock.yaml | 2 +- .../request-queues@{queueId}@requests.yaml | 4 +- ...quest-queues@{queueId}@requests@batch.yaml | 4 +- ...queues@{queueId}@requests@{requestId}.yaml | 6 +- ...s@{queueId}@requests@{requestId}@lock.yaml | 4 +- .../webhook-dispatches.yaml | 2 +- .../webhook-dispatches@{dispatchId}.yaml | 2 +- .../openapi/paths/webhooks/webhooks.yaml | 4 +- .../paths/webhooks/webhooks@{webhookId}.yaml | 6 +- .../webhooks@{webhookId}@dispatches.yaml | 2 +- .../webhooks/webhooks@{webhookId}@test.yaml | 2 +- 62 files changed, 325 insertions(+), 769 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 545660f32..8dfdb278d 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -3,6 +3,10 @@ x-legacy-doc-urls: - '#/reference/actors' - '#tag/Actors' + - '#/reference/actors/actor-collection' + - '#tag/ActorsActor-collection' + - '#/reference/actors/actor-object' + - '#tag/ActorsActor-object' description: | The API endpoints described in this section enable you to manage, build and run Apify actors. For more information, see the Actor documentation. @@ -16,33 +20,18 @@ has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. You can learn more about platform usage in the documentation. -- name: Actors/Actor collection - x-displayName: Actor collection - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/actor-collection' - - '#tag/ActorsActor-collection' - x-trait: 'true' -- name: Actors/Actor object - x-displayName: Actor object - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/actor-object' - - '#tag/ActorsActor-object' - x-trait: 'true' -- name: Actors/Version collection - x-displayName: Version collection +- name: Actors/Actor versions + x-displayName: Actor versions x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/version-collection' - '#tag/ActorsVersion-collection' - x-trait: 'true' -- name: Actors/Version object - x-displayName: Version object - x-parent-tag-name: Actors - x-legacy-doc-urls: - '#/reference/actors/version-object' - '#tag/ActorsVersion-object' + - '#/reference/actors/environment-variable-collection' + - '#tag/ActorsEnvironment-variable-collection' + - '#/reference/actors/environment-variable-object' + - '#tag/ActorsEnvironment-variable-object' x-trait: 'true' description: | The **Version object** contains the source code of a specific version of an actor. @@ -90,109 +79,39 @@ For more information about source code and actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) in Actors documentation. -- name: Actors/Environment variable collection - x-displayName: Environment variable collection - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/environment-variable-collection' - - '#tag/ActorsEnvironment-variable-collection' - x-trait: 'true' -- name: Actors/Environment variable object - x-displayName: Environment variable object - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/environment-variable-object' - - '#tag/ActorsEnvironment-variable-object' - x-trait: 'true' -- name: Actors/Webhook collection - x-displayName: Webhook collection - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/webhook-collection' - - '#tag/ActorsWebhook-collection' - x-trait: 'true' -- name: Actors/Build collection - x-displayName: Build collection +- name: Actors/Actor builds + x-displayName: Actor builds x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/build-collection' - '#tag/ActorsBuild-collection' - x-trait: 'true' -- name: Actors/Build object - x-displayName: Build object - x-parent-tag-name: Actors - x-legacy-doc-urls: - '#/reference/actors/build-object' - '#tag/ActorsBuild-object' - x-trait: 'true' - description: '**[DEPRECATED]** API endpoints related to build of the actor were - moved under new namespace [`actor-builds`](#/reference/actor-builds).' -- name: Actors/Default build object - x-displayName: Default build object - x-parent-tag-name: Actor builds - x-trait: 'true' -- name: Actors/Abort build - x-displayName: Abort build - x-parent-tag-name: Actors - x-trait: 'true' - description: '**[DEPRECATED]** API endpoints related to build of the actor were - moved under new namespace [`actor-builds`](#/reference/actor-builds).' - x-legacy-doc-urls: - '#tag/ActorsAbort-build' -- name: Actors/Run collection - x-displayName: Run collection + x-trait: 'true' +- name: Actors/Actor runs + x-displayName: Actor runs x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/run-collection' - '#tag/ActorsRun-collection' - x-trait: 'true' -- name: Actors/Run actor synchronously - x-displayName: Run actor synchronously - x-parent-tag-name: Actors - x-legacy-doc-urls: + - '#tag/ActorsResurrect-run' + - '#tag/ActorsMetamorph-run' + - '#tag/ActorsAbort-run' + - '#/reference/actors/run-object' + - '#tag/ActorsRun-object' - '#/reference/actors/run-actor-synchronously' - '#tag/ActorsRun-actor-synchronously' - x-trait: 'true' -- name: Actors/Run Actor synchronously and get dataset items - x-displayName: Run Actor synchronously and get dataset items - x-parent-tag-name: Actors - x-legacy-doc-urls: - '#/reference/actors/run-actor-synchronously-and-get-dataset-items' - '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items' x-trait: 'true' -- name: Actors/Run object - x-displayName: Run object - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/run-object' - - '#tag/ActorsRun-object' - x-trait: 'true' - description: '**[DEPRECATED]** API endpoints related to run of the actor were moved - under new namespace [`actor-runs`](#/reference/actor-runs).' -- name: Actors/Abort run - x-displayName: Abort run - x-parent-tag-name: Actors - x-trait: 'true' - description: '**[DEPRECATED]** API endpoints related to run of the actor were moved - under new namespace [`actor-runs`](#/reference/actor-runs).' - x-legacy-doc-urls: - - '#tag/ActorsAbort-run' -- name: Actors/Metamorph run - x-displayName: Metamorph run +- name: Actors/Webhook collection + x-displayName: Webhook collection x-parent-tag-name: Actors - x-trait: 'true' - description: '**[DEPRECATED]** API endpoints related to run of the actor were moved - under new namespace [`actor-runs`](#/reference/actor-runs).' x-legacy-doc-urls: - - '#tag/ActorsMetamorph-run' -- name: Actors/Resurrect run - x-displayName: Resurrect run - x-parent-tag-name: Actors + - '#/reference/actors/webhook-collection' + - '#tag/ActorsWebhook-collection' x-trait: 'true' - description: '**[DEPRECATED]** API endpoints related to run of the actor were moved - under new namespace [`actor-runs`](#/reference/actor-runs).' - x-legacy-doc-urls: - - '#tag/ActorsResurrect-run' - name: Actors/Last run object and its storages x-displayName: Last run object and its storages x-parent-tag-name: Actors @@ -255,321 +174,41 @@ ``` In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. -- name: Actors/Get OpenAPI definition - x-displayName: Get OpenAPI definition - x-parent-tag-name: Actors - x-trait: 'true' - description: | - Get the OpenAPI definition for Actor builds. Two similar endpoints are available: - - - [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. - - [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`. -- name: Actor tasks - x-displayName: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks' - - '#tag/Actor-tasks' - description: | - The API endpoints described in this section enable you to manage and run Apify actor tasks. - For more information, see the Actor - tasks documentation. - - Note that for all the API endpoints that accept the `actorTaskId` parameter to - specify a task, you can pass either the task ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated - username of the task's owner and the task's name (e.g. `janedoe~my-task`). - - Some of the API endpoints return runs objects. Note that if any such run object - contains usage in dollars, your effective unit pricing at the time of query - has been used for computation of this dollar equivalent, and hence it should be - used only for informative purposes. You can learn more - about platform usage in the documentation. -- name: Actor tasks/Task collection - x-displayName: Task collection - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/task-collection' - - '#tag/Actor-tasksTask-collection' - x-trait: 'true' -- name: Actor tasks/Task object - x-displayName: Task object - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/task-object' - - '#tag/Actor-tasksTask-object' - x-trait: 'true' -- name: Actor tasks/Task input object - x-displayName: Task input object - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/task-input-object' - - '#tag/Actor-tasksTask-input-object' - x-trait: 'true' -- name: Actor tasks/Webhook collection - x-displayName: Webhook collection - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/webhook-collection' - - '#tag/Actor-tasksWebhook-collection' - x-trait: 'true' -- name: Actor tasks/Run collection - x-displayName: Run collection - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/run-collection' - - '#tag/Actor-tasksRun-collection' - x-trait: 'true' -- name: Actor tasks/Run task synchronously - x-displayName: Run task synchronously - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/run-task-synchronously' - - '#tag/Actor-tasksRun-task-synchronously' - x-trait: 'true' -- name: Actor tasks/Run task synchronously and get dataset items - x-displayName: Run task synchronously and get dataset items - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items' - - '#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items' - x-trait: 'true' -- name: Actor tasks/Last run object and its storages - x-displayName: Last run object and its storages - x-parent-tag-name: Actor tasks - x-legacy-doc-urls: - - '#/reference/actor-tasks/last-run-object-and-its-storages' - - '#tag/Actor-tasksLast-run-object-and-its-storages' - x-trait: 'true' - description: | - This is not a single endpoint, but an entire group of endpoints that lets you to - retrieve and manage the last run of given actor task or any of its default storages. - All the endpoints require an authentication token. - - The endpoints accept the same HTTP methods and query parameters as - the respective storage endpoints. - The base path represents the last actor task run object is: - - `/v2/actor-tasks/{actorTaskId}/runs/last{?token,status}` - - Using the `status` query parameter you can ensure to only get a run with a certain status - (e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters - are the same as in the [Run object](#/reference/actors/run-object) endpoint. - - In order to access the default storages of the last actor task run, i.e. log, - key-value store, dataset and request queue, use the following endpoints: - - * `/v2/actor-tasks/{actorTaskId}/runs/last/log{?token,status}` - * `/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store{?token,status}` - * `/v2/actor-tasks/{actorTaskId}/runs/last/dataset{?token,status}` - * `/v2/actor-tasks/{actorTaskId}/runs/last/request-queue{?token,status}` - - These API endpoints have the same usage as the equivalent storage endpoints. - For example, `/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store` has the same HTTP method - and parameters as the [Key-value store object](#/reference/key-value-stores/store-object) endpoint. - - Additionally, each of the above API endpoints supports all sub-endpoints of the original one: - - #### Key-value store - - * `/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/keys{?token,status}` - [Key collection](#/reference/key-value-stores/key-collection) - * `/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey}{?token,status}` - [Record](#/reference/key-value-stores/record) - - #### Dataset - - * `/v2/actor-tasks/{actorTaskId}/runs/last/dataset/items{?token,status}` [Item - collection](#/reference/datasets/item-collection) - - #### Request queue - - * `/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests{?token,status}` - [Request collection](#/reference/request-queues/request-collection) - * `/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}{?token,status}` - [Request collection](#/reference/request-queues/request) - * `/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head{?token,status}` - [Queue head](#/reference/request-queues/queue-head) - - For example, to download data from a dataset of the last succeeded actor task run in XML format, - send HTTP GET request to the following URL: - - ``` - https://api.apify.com/v2/actor-tasks/{actorTaskId}/runs/last/dataset/items?token={yourApiToken}&format=xml&status=SUCCEEDED - ``` - - In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. -- name: Actor runs - x-displayName: Actor runs - x-legacy-doc-urls: - - '#/reference/actor-runs' - - '#tag/Actor-runs' - description: | - The API endpoints described in this section enable you to manage Apify actor runs. - - Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query - has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. - You can learn more about platform usage in the documentation. -- name: Actor runs/Run collection - x-displayName: Run collection - x-parent-tag-name: Actor runs - x-legacy-doc-urls: - - '#/reference/actor-runs/run-collection' - - '#tag/Actor-runsRun-collection' - x-trait: 'true' -- name: Actor runs/Run object and its storages - x-displayName: Run object and its storages - x-parent-tag-name: Actor runs - x-legacy-doc-urls: - - '#/reference/actor-runs/run-object-and-its-storages' - - '#tag/Actor-runsRun-object-and-its-storages' - x-trait: 'true' - description: | - This is not a single endpoint, but an entire group of endpoints that lets you - retrieve the run or any of its default storages. - - The endpoints accept the same HTTP methods and query parameters as the respective storage endpoints. - The base path that represents the actor run object is: - - `/v2/actor-runs/{runId}{?token}` - - In order to access the default storages of the actor run, i.e. log, key-value - store, dataset and request queue, use the following endpoints: - - * `/v2/actor-runs/{runId}/log{?token}` - * `/v2/actor-runs/{runId}/key-value-store{?token}` - * `/v2/actor-runs/{runId}/dataset{?token}` - * `/v2/actor-runs/{runId}/request-queue{?token}` - - These API endpoints have the same usage as the equivalent storage endpoints. - For example, `/v2/actor-runs/{runId}/key-value-store` has the same HTTP method and parameters - as the [Key-value store object](#/reference/key-value-stores/store-object) endpoint. - - Additionally, each of the above API endpoints supports all sub-endpoints of the original one: - - #### Log - - * `/v2/actor-runs/{runId}/log` [Log](#/reference/logs) - - #### Key-value store - - * `/v2/actor-runs/{runId}/key-value-store/keys{?token}` [Key collection](#/reference/key-value-stores/key-collection) - * `/v2/actor-runs/{runId}/key-value-store/records/{recordKey}{?token}` [Record](#/reference/key-value-stores/record) - - #### Dataset - - * `/v2/actor-runs/{runId}/dataset/items{?token}` [Item collection](#/reference/datasets/item-collection) - - #### Request queue - - * `/v2/actor-runs/{runId}/request-queue/requests{?token}` [Request collection](#/reference/request-queues/request-collection) - * `/v2/actor-runs/{runId}/request-queue/requests/{requestId}{?token}` [Request collection](#/reference/request-queues/request) - * `/v2/actor-runs/{runId}/request-queue/head{?token}` [Queue head](#/reference/request-queues/queue-head) - - For example, to download data from a dataset of the actor run in XML format, - send HTTP GET request to the following URL: - - ``` - https://api.apify.com/v2/actor-runs/{runId}/dataset/items?format=xml - ``` - - In order to save new items to the dataset, send HTTP POST request with JSON payload - to the same URL. -- name: Actor runs/Delete run - x-displayName: Delete run - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsDelete-run' -- name: Actor runs/Abort run - x-displayName: Abort run - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsAbort-run' -- name: Actor runs/Metamorph run - x-displayName: Metamorph run - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsMetamorph-run' -- name: Actor runs/Reboot run - x-displayName: Reboot run - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsReboot-run' -- name: Actor runs/Resurrect run - x-displayName: Resurrect run - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsResurrect-run' -- name: Actor runs/Charge events in run - x-displayName: Charge events in run - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsCharge-events-in-run' -- name: Actor runs/Update status message - x-displayName: Update status message - x-parent-tag-name: Actor runs - x-trait: 'true' - x-legacy-doc-urls: - - '#tag/Actor-runsUpdate-status-message' - name: Actor builds - x-displayName: Actor builds + x-displayName: Introduction x-legacy-doc-urls: - '#/reference/actor-builds' - '#tag/Actor-builds' - description: | - The API endpoints described in this section enable you to manage Apify actor builds. - - Note that if any returned build object contains usage in dollars, your effective - unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be - used only for informative purposes. - You can learn more about platform usage in the documentation. -- name: Actor builds/Build collection - x-displayName: Build collection - x-parent-tag-name: Actor builds - x-legacy-doc-urls: - '#/reference/actor-builds/build-collection' - '#tag/Actor-buildsBuild-collection' - x-trait: 'true' -- name: Actor builds/Build object - x-displayName: Build object - x-parent-tag-name: Actor builds - x-legacy-doc-urls: - '#/reference/actor-builds/build-object' - '#tag/Actor-buildsBuild-object' - x-trait: 'true' -- name: Actor builds/Delete build - x-displayName: Delete build - x-parent-tag-name: Actor builds - x-trait: 'true' - x-legacy-doc-urls: - '#tag/Actor-buildsDelete-build' -- name: Actor builds/Abort build - x-displayName: Abort build - x-parent-tag-name: Actor builds - x-trait: 'true' - x-legacy-doc-urls: - '#tag/Actor-buildsAbort-build' -- name: Actor builds/Build log - x-displayName: Build log - x-parent-tag-name: Actor builds - x-legacy-doc-urls: - '#/reference/actor-builds/build-log' - '#tag/Actor-buildsBuild-log' - x-trait: 'true' - description: Check out [Logs](#/reference/logs) for full reference. -- name: Actor builds/Get OpenAPI definition - x-displayName: Get OpenAPI definition - x-parent-tag-name: Actor builds - x-trait: 'true' description: | - Get the OpenAPI definition for Actor builds. Two similar endpoints are available: + The API endpoints described in this section enable you to manage Apify actor builds. - - [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. - - [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`. + Note that if any returned build object contains usage in dollars, your effective + unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be + used only for informative purposes. + You can learn more about platform usage in the documentation. +- name: Actor runs + x-displayName: Introduction + x-legacy-doc-urls: + - '#/reference/actor-runs' + - '#tag/Actor-runs' + - '#/reference/actor-runs/run-collection' + - '#tag/Actor-runsRun-collection' + - '#/reference/actor-runs/run-object-and-its-storages' + - '#tag/Actor-runsRun-object-and-its-storages' + description: | + The API endpoints described in this section enable you to manage Apify Actor runs. + + Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query + has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. + You can learn more about platform usage in the documentation. - name: Key-value stores x-displayName: Key-value stores x-legacy-doc-urls: @@ -586,39 +225,56 @@ Note that some of the endpoints do not require the authentication token, the calls are authenticated using a hard-to-guess ID of the key-value store. -- name: Key-value stores/Store collection - x-displayName: Store collection - x-parent-tag-name: Key-value stores - x-legacy-doc-urls: - - '#/reference/key-value-stores/store-collection' - - '#tag/Key-value-storesStore-collection' - x-trait: 'true' -- name: Key-value stores/Store object - x-displayName: Store object - x-parent-tag-name: Key-value stores - x-legacy-doc-urls: - - '#/reference/key-value-stores/store-object' - - '#tag/Key-value-storesStore-object' - x-trait: 'true' -- name: Key-value stores/Key collection - x-displayName: Key collection - x-parent-tag-name: Key-value stores +- name: Actor tasks + x-displayName: Actor tasks x-legacy-doc-urls: - - '#/reference/key-value-stores/key-collection' - - '#tag/Key-value-storesKey-collection' - x-trait: 'true' -- name: Key-value stores/Record - x-displayName: Record - x-parent-tag-name: Key-value stores + - '#/reference/actor-tasks' + - '#tag/Actor-tasks' + - '#/reference/actor-tasks/task-collection' + - '#tag/Actor-tasksTask-collection' + - '#/reference/actor-tasks/task-object' + - '#tag/Actor-tasksTask-object' + - '#/reference/actor-tasks/task-input-object' + - '#tag/Actor-tasksTask-input-object' + - '#/reference/actor-tasks/webhook-collection' + - '#tag/Actor-tasksWebhook-collection' + - '#/reference/actor-tasks/run-collection' + - '#tag/Actor-tasksRun-collection' + - '#/reference/actor-tasks/run-task-synchronously' + - '#tag/Actor-tasksRun-task-synchronously' + - '#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items' + - '#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items' + - '#/reference/actor-tasks/last-run-object-and-its-storages' + - '#tag/Actor-tasksLast-run-object-and-its-storages' + description: | + The API endpoints described in this section enable you to manage and run Apify actor tasks. + For more information, see the Actor + tasks documentation. + + Note that for all the API endpoints that accept the `actorTaskId` parameter to + specify a task, you can pass either the task ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated + username of the task's owner and the task's name (e.g. `janedoe~my-task`). + + Some of the API endpoints return runs objects. Note that if any such run object + contains usage in dollars, your effective unit pricing at the time of query + has been used for computation of this dollar equivalent, and hence it should be + used only for informative purposes. You can learn more + about platform usage in the documentation. +- name: Storage + x-displayName: x-legacy-doc-urls: - - '#/reference/key-value-stores/record' - - '#tag/Key-value-storesRecord' - x-trait: 'true' -- name: Datasets +- name: Storage/Datasets x-displayName: Datasets + x-parent-tag-name: Storage x-legacy-doc-urls: - '#/reference/datasets' - '#tag/Datasets' + - '#/reference/datasets/dataset-collection' + - '#tag/DatasetsDataset-collection' + - '#/reference/datasets/dataset' + - '#tag/DatasetsDataset' + - '#/reference/datasets/item-collection' + - '#tag/DatasetsItem-collection' description: | This section describes API endpoints to manage Datasets. @@ -630,111 +286,96 @@ For more information, see the Datasets documentation. + :::note + Note that some of the endpoints do not require the authentication token, the calls are authenticated using the hard-to-guess ID of the dataset. -- name: Datasets/Dataset collection - x-displayName: Dataset collection - x-parent-tag-name: Datasets - x-legacy-doc-urls: - - '#/reference/datasets/dataset-collection' - - '#tag/DatasetsDataset-collection' - x-trait: 'true' -- name: Datasets/Dataset - x-displayName: Dataset - x-parent-tag-name: Datasets - x-legacy-doc-urls: - - '#/reference/datasets/dataset' - - '#tag/DatasetsDataset' - x-trait: 'true' -- name: Datasets/Item collection - x-displayName: Item collection - x-parent-tag-name: Datasets - x-legacy-doc-urls: - - '#/reference/datasets/item-collection' - - '#tag/DatasetsItem-collection' - x-trait: 'true' -- name: Datasets/Statistics - x-displayName: Statistics - x-parent-tag-name: Datasets + + ::: x-trait: 'true' -- name: Request queues - x-displayName: Request queues +- name: Storage/Key-value stores + x-displayName: Key-value stores + x-parent-tag-name: Storage x-legacy-doc-urls: - - '#/reference/request-queues' - - '#tag/Request-queues' + - '#/reference/key-value-stores/key-collection' + - '#tag/Key-value-storesKey-collection' + - '#/reference/key-value-stores/store-collection' + - '#tag/Key-value-storesStore-collection' + - '#/reference/key-value-stores/store-object' + - '#tag/Key-value-storesStore-object' + - '#/reference/key-value-stores/record' + - '#tag/Key-value-storesRecord' description: | - This section describes API endpoints to manage request queues. + This section describes API endpoints to manage Key-value stores. + Key-value store is a simple storage for saving and reading data records or files. + Each data record is represented by a unique key and associated with a MIME content type. + Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages, + PDFs or to persist the state of crawlers. + For more information, see the Key-value + store documentation. - Request queue is a storage for a queue of HTTP URLs to crawl, which is typically - used for deep crawling of websites where you - start with several URLs and then recursively follow links to other pages. - The storage supports both breadth-first and depth-first crawling orders. - For more information, see the Request - queue documentation. + :::note Note that some of the endpoints do not require the authentication token, the calls - are authenticated using the hard-to-guess ID of the queue. -- name: Request queues/Queue collection - x-displayName: Queue collection - x-parent-tag-name: Request queues + are authenticated using a hard-to-guess ID of the key-value store. + + ::: + x-trait: 'true' +- name: Storage/Request queues + x-displayName: Request queues + x-parent-tag-name: Storage x-legacy-doc-urls: + - '#/reference/request-queues' + - '#tag/Request-queues' - '#/reference/request-queues/queue-collection' - '#tag/Request-queuesQueue-collection' - x-trait: 'true' -- name: Request queues/Queue - x-displayName: Queue - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/queue' - '#tag/Request-queuesQueue' - x-trait: 'true' -- name: Request queues/Request collection - x-displayName: Request collection - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/request-collection' - '#tag/Request-queuesRequest-collection' - x-trait: 'true' -- name: Request queues/Request - x-displayName: Request - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/request' - '#tag/Request-queuesRequest' - x-trait: 'true' -- name: Request queues/Request lock - x-displayName: Request lock - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/request-lock' - '#tag/Request-queuesRequest-lock' - x-trait: 'true' -- name: Request queues/Queue head - x-displayName: Queue head - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/queue-head' - '#tag/Request-queuesQueue-head' - x-trait: 'true' -- name: Request queues/Queue head with locks - x-displayName: Queue head with locks - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/queue-head-with-locks' - '#tag/Request-queuesQueue-head-with-locks' - x-trait: 'true' -- name: Request queues/Batch request operations - x-displayName: Batch request operations - x-parent-tag-name: Request queues - x-legacy-doc-urls: - '#/reference/request-queues/batch-request-operations' - '#tag/Request-queuesBatch-request-operations' - x-trait: 'true' + description: | + This section describes API endpoints to manage request queues. + + Request queue is a storage for a queue of HTTP URLs to crawl, which is typically + used for deep crawling of websites where you + start with several URLs and then recursively follow links to other pages. + The storage supports both breadth-first and depth-first crawling orders. + For more information, see the Request + queue documentation. + + :::note + + Note that some of the endpoints do not require the authentication token, the calls + are authenticated using the hard-to-guess ID of the queue. + + ::: - name: Webhooks + x-displayName: + x-legacy-doc-urls: +- name: Webhooks/Webhooks x-displayName: Webhooks + x-parent-tag-name: Webhooks x-legacy-doc-urls: - '#/reference/webhooks' - '#tag/Webhooks' + - '#/reference/webhooks/webhook-collection' + - '#tag/WebhooksWebhook-collection' + - '#/reference/webhooks/webhook-object' + - '#tag/WebhooksWebhook-object' + - '#/reference/webhooks/webhook-test' + - '#tag/WebhooksWebhook-test' + - '#/reference/webhooks/dispatches-collection' + - '#tag/WebhooksDispatches-collection' description: | This section describes API endpoints to manage webhooks. @@ -745,54 +386,17 @@ or fails. For more information see Webhooks documentation. -- name: Webhooks/Webhook collection - x-displayName: Webhook collection - x-parent-tag-name: Webhooks - x-legacy-doc-urls: - - '#/reference/webhooks/webhook-collection' - - '#tag/WebhooksWebhook-collection' - x-trait: 'true' -- name: Webhooks/Webhook object - x-displayName: Webhook object - x-parent-tag-name: Webhooks - x-legacy-doc-urls: - - '#/reference/webhooks/webhook-object' - - '#tag/WebhooksWebhook-object' - x-trait: 'true' -- name: Webhooks/Webhook test - x-displayName: Webhook test - x-parent-tag-name: Webhooks - x-legacy-doc-urls: - - '#/reference/webhooks/webhook-test' - - '#tag/WebhooksWebhook-test' - x-trait: 'true' -- name: Webhooks/Dispatches collection - x-displayName: Dispatches collection - x-parent-tag-name: Webhooks - x-legacy-doc-urls: - - '#/reference/webhooks/dispatches-collection' - - '#tag/WebhooksDispatches-collection' - x-trait: 'true' -- name: Webhook dispatches +- name: Webhooks/Webhook dispatches x-displayName: Webhook dispatches + x-parent-tag-name: Webhooks x-legacy-doc-urls: - '#/reference/webhook-dispatches' - '#tag/Webhook-dispatches' - description: This section describes API endpoints to get webhook dispatches. -- name: Webhook dispatches/Webhook dispatches collection - x-displayName: Webhook dispatches collection - x-parent-tag-name: Webhook dispatches - x-legacy-doc-urls: - '#/reference/webhook-dispatches/webhook-dispatches-collection' - '#tag/Webhook-dispatchesWebhook-dispatches-collection' - x-trait: 'true' -- name: Webhook dispatches/Webhook dispatch object - x-displayName: Webhook dispatch object - x-parent-tag-name: Webhook dispatches - x-legacy-doc-urls: - '#/reference/webhook-dispatches/webhook-dispatch-object' - '#tag/Webhook-dispatchesWebhook-dispatch-object' - x-trait: 'true' + description: This section describes API endpoints to get webhook dispatches. - name: Schedules x-displayName: Schedules x-legacy-doc-urls: diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index 8dc529920..edb4865ac 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -1,95 +1,29 @@ - name: Actors tags: - Actors - - Actors/Actor collection - - Actors/Actor object - - Actors/Version collection - - Actors/Version object - - Actors/Environment variable collection - - Actors/Environment variable object + - Actors/Actor versions + - Actors/Actor builds + - Actors/Actor runs - Actors/Webhook collection - - Actors/Build collection - - Actors/Build object - - Actors/Default build object - - Actors/Abort build - - Actors/Run collection - - Actors/Run actor synchronously - - Actors/Run Actor synchronously and get dataset items - - Actors/Run object - - Actors/Abort run - - Actors/Metamorph run - - Actors/Resurrect run - Actors/Last run object and its storages - - Actors/Get OpenAPI definition -- name: Actor tasks - tags: - - Actor tasks - - Actor tasks/Task collection - - Actor tasks/Task object - - Actor tasks/Task input object - - Actor tasks/Webhook collection - - Actor tasks/Run collection - - Actor tasks/Run task synchronously - - Actor tasks/Run task synchronously and get dataset items - - Actor tasks/Last run object and its storages -- name: Actor runs - tags: - - Actor runs - - Actor runs/Run collection - - Actor runs/Run object and its storages - - Actor runs/Delete run - - Actor runs/Abort run - - Actor runs/Metamorph run - - Actor runs/Reboot run - - Actor runs/Resurrect run - - Actor runs/Charge events in run - - Actor runs/Update status message - name: Actor builds tags: - Actor builds - - Actor builds/Build collection - - Actor builds/Build object - - Actor builds/Delete build - - Actor builds/Abort build - - Actor builds/Build log - - Actor builds/Get OpenAPI definition -- name: Key-value stores +- name: Actor runs tags: - - Key-value stores - - Key-value stores/Store collection - - Key-value stores/Store object - - Key-value stores/Key collection - - Key-value stores/Record -- name: Datasets + - Actor runs +- name: Actor tasks tags: - - Datasets - - Datasets/Dataset collection - - Datasets/Dataset - - Datasets/Item collection - - Datasets/Statistics -- name: Request queues + - Actor tasks +- name: Storage tags: - - Request queues - - Request queues/Queue collection - - Request queues/Queue - - Request queues/Request collection - - Request queues/Request - - Request queues/Request lock - - Request queues/Queue head - - Request queues/Queue head with locks - - Request queues/Batch request operations + - Storage/Datasets + - Storage/Key-value stores + - Storage/Request queues - name: Webhooks tags: - - Webhooks - - Webhooks/Webhook collection - - Webhooks/Webhook object - - Webhooks/Webhook test - - Webhooks/Dispatches collection -- name: Webhook dispatches - tags: - - Webhook dispatches - - Webhook dispatches/Webhook dispatches collection - - Webhook dispatches/Webhook dispatch object + - Webhooks/Webhooks + - Webhooks/Webhook dispatches - name: Schedules tags: - Schedules diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index a421aae0e..7ab129138 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -10,8 +10,8 @@ info: The Apify API (version 2) provides programmatic access to the [Apify platform](https://docs.apify.com). The API is organized around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) - HTTP endpoints. - + HTTP endpoints. + You can download the complete OpenAPI schema of Apify API in the [YAML](http://docs.apify.com/api/openapi.yaml) or [JSON](http://docs.apify.com/api/openapi.json) formats. The source code is also available on [GitHub](https://github.com/apify/apify-docs/tree/master/apify-api/openapi). All requests and responses (including errors) are encoded in diff --git a/apify-api/openapi/paths/actor-builds/actor-builds.yaml b/apify-api/openapi/paths/actor-builds/actor-builds.yaml index fdd05a15f..4e64de244 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor builds/Build collection + - Actor builds summary: Get user builds list x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml index b811dbdac..93eb5575d 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor builds/Build object + - Actor builds summary: Get build description: | Gets an object that contains all the details about a specific build of an diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml index 8097c4ff8..c9cebbb36 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@abort.yaml @@ -1,6 +1,6 @@ post: tags: - - Actor builds/Abort build + - Actor builds summary: Abort build description: | Aborts an Actor build and returns an object that contains all the details diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml index 1243ee402..b372c62e2 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@log.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor builds/Build log + - Actor builds summary: Get log # TODO: Fix description once /logs is cleaned up as well description: 'Check out [Logs](#/reference/logs) for full reference.' diff --git a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml index bde5be9ed..ae5bacadf 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi.json.yaml @@ -1,11 +1,16 @@ get: tags: - - Actor builds/Get OpenAPI definition + - Actor builds summary: Get OpenAPI definition description: | + Get the OpenAPI definition for Actor builds. Two similar endpoints are available: + + - [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`. + Get the OpenAPI definition for a specific Actor build. Authentication is based on the build's unique ID. No authentication token is required. - + **Note**: You can also use the `/api/v2/act-openapi-json-get` endpoint to get the OpenAPI definition for a build. operationId: actorBuild_openapi_json_get security: diff --git a/apify-api/openapi/paths/actor-runs/actor-runs.yaml b/apify-api/openapi/paths/actor-runs/actor-runs.yaml index 811f376d7..e414e9c80 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor runs/Run collection + - Actor runs summary: Get user runs list description: | Gets a list of all runs for a user. The response is a list of objects, where 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 4a75770a6..887f9a7a8 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,6 @@ get: tags: - - Actor runs/Run object and its storages + - Actor runs summary: Get run description: | This is not a single endpoint, but an entire group of endpoints that lets @@ -62,7 +62,9 @@ get: ``` In order to save new items to the dataset, send HTTP POST request with JSON - payload to the same URL.Gets an object that contains all the details about a + payload to the same URL. + + Gets an object that contains all the details about a specific run of an Actor. By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait @@ -180,39 +182,9 @@ get: - https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages/get-run - https://docs.apify.com/api/v2#/reference/actor-runs/get-run - https://docs.apify.com/api/v2#tag/Actor-runsRun-object-and-its-storages/operation/actorRun_get -delete: - tags: - - Actor runs/Delete run - summary: Delete run - description: | - Delete the run. Only finished runs can be deleted. Only the person or - organization that initiated the run can delete it. - operationId: actorRun_delete - parameters: - - name: runId - in: path - description: Run ID. - required: true - style: simple - schema: - type: string - example: 3KH8gEpp4d8uQSe8T - responses: - '204': - description: '' - headers: {} - content: {} - deprecated: false - x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run - - https://docs.apify.com/api/v2#/reference/actor-runs/delete-run - - https://docs.apify.com/api/v2#tag/Actor-runsDelete-run/operation/actorRun_delete - x-js-parent: RunClient - x-js-name: delete - x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#delete put: tags: - - Actor runs/Update status message + - Actor runs summary: Update status message description: | You can set a single status message on your run that will be displayed in @@ -334,3 +306,34 @@ put: - https://docs.apify.com/api/v2#/reference/actor-runs/update-status-message/update-status-message - https://docs.apify.com/api/v2#/reference/actor-runs/update-status-message - https://docs.apify.com/api/v2#tag/Actor-runsUpdate-status-message/operation/actorRun_put +delete: + tags: + - Actor runs + summary: Delete run + description: | + Delete the run. Only finished runs can be deleted. Only the person or + organization that initiated the run can delete it. + operationId: actorRun_delete + parameters: + - name: runId + in: path + description: Run ID. + required: true + style: simple + schema: + type: string + example: 3KH8gEpp4d8uQSe8T + responses: + '204': + description: '' + headers: {} + content: {} + deprecated: false + x-legacy-doc-urls: + - https://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run + - https://docs.apify.com/api/v2#/reference/actor-runs/delete-run + - https://docs.apify.com/api/v2#tag/Actor-runsDelete-run/operation/actorRun_delete + x-js-parent: RunClient + x-js-name: delete + x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#delete + 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 4aea0d9b9..9c7e32e15 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,6 @@ post: tags: - - Actor runs/Abort run + - 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 f65d60f75..852a0eaf2 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,13 +1,17 @@ post: tags: - - Actor runs/Charge events in run + - 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). The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured, the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with. + :::note + Note that pay per events Actors are still in alpha. Please, reach out to us with any questions or feedback. + + ::: operationId: PostChargeRun parameters: - name: runId 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 0172d54c4..19bab4f6d 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,6 @@ post: tags: - - Actor runs/Metamorph run + - 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 1ed0677ec..6fb233cef 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,6 @@ post: tags: - - Actor runs/Reboot run + - 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/actor-runs/actor-runs@{runId}@resurrect.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml index 446a342f1..16b09d80a 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml @@ -1,6 +1,6 @@ post: tags: - - Actor runs/Resurrect run + - Actor runs summary: Resurrect run description: | Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run. @@ -8,7 +8,7 @@ post: Run status will be updated to RUNNING and its container will be restarted with the same storages (the same behaviour as when the run gets migrated to the new server). - For more information, + For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). operationId: PostResurrectRun parameters: diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml index dcc7c37da..92e86f32d 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor tasks/Task collection + - Actor tasks summary: Get list of tasks description: | Gets the complete list of tasks that a user has created or used. The @@ -111,7 +111,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/TaskCollectionClientAsync#list post: tags: - - Actor tasks/Task collection + - Actor tasks summary: Create task description: | Create a new task with settings specified by the object passed as JSON in diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}.yaml index 6002144bc..1cc5683e5 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor tasks/Task object + - Actor tasks summary: Get task description: Get an object that contains all the details about a task. operationId: actorTask_get @@ -57,7 +57,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#get put: tags: - - Actor tasks/Task object + - Actor tasks summary: Update task description: | Update settings of a task using values specified by an object passed as JSON @@ -152,7 +152,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#update delete: tags: - - Actor tasks/Task object + - Actor tasks summary: Delete task description: Delete the task specified through the `actorTaskId` parameter. operationId: actorTask_delete diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml index 9ead70e9b..0e32da95f 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@input.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor tasks/Task input object + - Actor tasks summary: Get task input description: Returns the input of a given task. operationId: actorTask_input_get @@ -38,7 +38,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#get_input put: tags: - - Actor tasks/Task input object + - Actor tasks summary: Update task input description: | Updates the input of a task using values specified by an object passed as diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml index f46c96e8c..3cec9ba47 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml @@ -1,6 +1,6 @@ post: tags: - - Actor tasks/Run task synchronously and get dataset items + - Actor tasks summary: Run task synchronously and get dataset items (POST) description: | Runs an Actor task and synchronously returns its dataset items. @@ -385,7 +385,7 @@ post: - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_post get: tags: - - Actor tasks/Run task synchronously and get dataset items + - Actor tasks summary: Run task synchronously and get dataset items (GET) description: | Run a specific task and return its dataset items. diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml index 42f26e091..f6f1ce168 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml @@ -1,6 +1,6 @@ post: tags: - - Actor tasks/Run task synchronously + - Actor tasks summary: Run task synchronously (POST) description: | Runs an Actor task and synchronously returns its output. @@ -148,7 +148,7 @@ post: - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_post get: tags: - - Actor tasks/Run task synchronously + - Actor tasks summary: Run task synchronously (GET) description: | Run a specific task and return its output. diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml index 4de254c43..470f09a38 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor tasks/Run collection + - Actor tasks summary: Get list of task runs description: | Get a list of runs of a specific task. The response is a list of objects, @@ -129,7 +129,7 @@ get: - https://docs.apify.com/api/v2#tag/Actor-tasksRun-collection/operation/actorTask_runs_get post: tags: - - Actor tasks/Run collection + - Actor tasks summary: Run task description: | Runs an Actor task and immediately returns without waiting for the run to diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@webhooks.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@webhooks.yaml index d0d3ff27b..0df37bca1 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@webhooks.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@webhooks.yaml @@ -1,6 +1,6 @@ get: tags: - - Actor tasks/Webhook collection + - Actor tasks summary: Get list of webhooks description: | Gets the list of webhooks of a specific Actor task. The response is a JSON diff --git a/apify-api/openapi/paths/actors/acts.yaml b/apify-api/openapi/paths/actors/acts.yaml index dc5983455..ad7faa7b6 100644 --- a/apify-api/openapi/paths/actors/acts.yaml +++ b/apify-api/openapi/paths/actors/acts.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Actor collection + - Actors summary: Get list of Actors description: | Gets the list of all Actors that the user created or used. The response is a @@ -97,7 +97,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#list post: tags: - - Actors/Actor collection + - Actors summary: Create Actor description: | Creates a new Actor with settings specified in an Actor object passed as diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 0993fedfd..7ce22bfe2 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Actor object + - Actors summary: Get Actor description: Gets an object that contains all the details about a specific Actor. operationId: act_get @@ -94,7 +94,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#get put: tags: - - Actors/Actor object + - Actors summary: Update Actor description: | Updates settings of an Actor using values specified by an Actor object @@ -241,7 +241,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#update delete: tags: - - Actors/Actor object + - Actors summary: Delete Actor description: Deletes an Actor. operationId: act_delete diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index ccf602d0e..8d106ac3b 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Build collection + - Actors/Actor builds summary: Get list of builds description: | Gets the list of builds of a specific Actor. The response is a JSON with the @@ -74,7 +74,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync#list post: tags: - - Actors/Build collection + - Actors/Actor builds summary: Build Actor description: | Builds an Actor. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml index f4de87c06..8ae6a9782 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@default.yaml @@ -1,11 +1,11 @@ get: tags: - - Actors/Default build object + - Actors/Actor builds summary: Get default build description: | - Get the default build for an Actor. - - Use the optional `waitForFinish` parameter to synchronously wait for the build to finish. + Get the default build for an Actor. + + Use the optional `waitForFinish` parameter to synchronously wait for the build to finish. This avoids the need for periodic polling when waiting for the build to complete. This endpoint does not require an authentication token. Instead, calls are authenticated using the build's unique ID. @@ -29,7 +29,7 @@ get: The maximum number of seconds the server waits for the build to finish. If the build finishes within this time, the returned build object will have a terminal status (e.g. `SUCCEEDED`), otherwise it will have a transitional status (e.g. `RUNNING`). - + By default it is `0`, the maximum value is `60`. style: form explode: true diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml index 5b1ea59e4..2c11a74b9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Build object + - Actors/Actor builds summary: Get build description: | By passing the optional `waitForFinish` parameter the API endpoint will diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml index 9bd337476..65f1e2735 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml @@ -1,6 +1,6 @@ post: tags: - - Actors/Abort build + - Actors/Actor builds summary: Abort build description: | **[DEPRECATED]** API endpoints related to build of the Actor were moved diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml index ffb9f9457..2066c566f 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml @@ -1,13 +1,19 @@ get: tags: - - Actors/Get OpenAPI definition + - Actors/Actor builds summary: Get OpenAPI definition description: | + + Get the OpenAPI definition for Actor builds. Two similar endpoints are available: + + - [First endpoint](/api/v2/act-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build. + - [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`. + Get the OpenAPI definition for a specific Actor build. To fetch the default Actor build, simply pass `default` as the `buildId`. Authentication is based on the build's unique ID. No authentication token is required. - + **Note**: You can also use the `/api/v2/actor-build-openapi-json-get` endpoint to get the OpenAPI definition for a build. operationId: act_openapi_json_get security: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml index c0b494a1d..a9e1b5f43 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -1,6 +1,6 @@ post: tags: - - Actors/Run Actor synchronously and get dataset items + - Actors/Actor runs summary: Run Actor synchronously with input and get dataset items description: | Runs a specific Actor and returns its dataset items. @@ -395,7 +395,7 @@ post: - https://docs.apify.com/api/v2#tag/ActorsRun-Actor-synchronously-and-get-dataset-items/operation/act_runSyncGetDatasetItems_post get: tags: - - Actors/Run Actor synchronously and get dataset items + - Actors/Actor runs summary: Run Actor synchronously without input and get dataset items description: | Runs a specific Actor and returns its dataset items. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index 946f40235..aec3f0a1a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -1,6 +1,6 @@ post: tags: - - Actors/Run actor synchronously + - Actors/Actor runs summary: With input description: | Runs a specific Actor and returns its output. @@ -153,7 +153,7 @@ post: - https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_post get: tags: - - Actors/Run actor synchronously + - Actors/Actor runs summary: Without input description: | Runs a specific Actor and returns its output. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index a78b630de..6c0314fa9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Run collection + - Actors/Actor runs summary: Get list of runs description: | Gets the list of runs of a specific Actor. The response is a list of @@ -123,7 +123,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunCollectionClientAsync#list post: tags: - - Actors/Run collection + - Actors/Actor runs summary: Run Actor description: | Runs an Actor and immediately returns without waiting for the run to finish. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml index 9e54df937..0f07053ad 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Run object + - Actors/Actor runs summary: Get run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml index 8286fce4c..5fbb4e55a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@abort.yaml @@ -1,6 +1,6 @@ post: tags: - - Actors/Abort run + - Actors/Actor runs summary: Abort run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml index 8752c7172..9ef0ab893 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml @@ -1,6 +1,6 @@ post: tags: - - Actors/Metamorph run + - Actors/Actor runs summary: Metamorph run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml index 5aede9c2e..11547d902 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml @@ -1,6 +1,6 @@ post: tags: - - Actors/Resurrect run + - Actors/Actor runs summary: Resurrect run description: | **[DEPRECATED]** API endpoints related to run of the Actor were moved under diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index 1db0ff46c..b4f22bc4d 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Version collection + - Actors/Actor versions summary: Get list of versions description: | Gets the list of versions of a specific Actor. The response is a JSON object @@ -62,7 +62,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#list post: tags: - - Actors/Version collection + - Actors/Actor versions summary: Create version description: | Creates a version of an Actor using values specified in a [Version diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml index 0dad94777..5e24886d3 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Version object + - Actors/Actor versions summary: Get version description: | The **Version object** contains the source code of a specific version of an @@ -85,7 +85,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#get put: tags: - - Actors/Version object + - Actors/Actor versions summary: Update version description: | The **Version object** contains the source code of a specific version of an @@ -200,7 +200,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#update delete: tags: - - Actors/Version object + - Actors/Actor versions summary: Delete version description: | The **Version object** contains the source code of a specific version of an Actor. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml index e8838e68e..c4bed5bfd 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Environment variable collection + - Actors/Actor versions summary: Get list of environment variables description: | Gets the list of environment variables for a specific version of an Actor. @@ -42,7 +42,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#list post: tags: - - Actors/Environment variable collection + - Actors/Actor versions summary: Create environment variable description: | Creates an environment variable of an Actor using values specified in a diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml index 48c327477..70c3402a6 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars@{envVarName}.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Environment variable object + - Actors/Actor versions summary: Get environment variable description: | Gets a [EnvVar object](#/reference/actors/environment-variable-object) that @@ -56,7 +56,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#get put: tags: - - Actors/Environment variable object + - Actors/Actor versions summary: Update environment variable description: | Updates Actor environment variable using values specified by a [EnvVar @@ -135,7 +135,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update delete: tags: - - Actors/Environment variable object + - Actors/Actor versions summary: Delete environment variable description: Deletes a specific environment variable. operationId: act_version_envVar_delete diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index 3ff0685ad..2892ef254 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -1,6 +1,6 @@ get: tags: - - Datasets/Dataset collection + - Storage/Datasets summary: Get list of datasets description: | Lists all of a user's datasets. The response is a JSON array of objects, @@ -100,7 +100,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClientAsync#list post: tags: - - Datasets/Dataset collection + - Storage/Datasets summary: Create dataset description: | Creates a dataset and returns its object. diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml index 7d741f93e..6ab21ba44 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Datasets/Dataset + - Storage/Datasets summary: Get dataset description: | Returns dataset object for given dataset ID. @@ -60,7 +60,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#get put: tags: - - Datasets/Dataset + - Storage/Datasets summary: Update dataset description: | Updates a dataset's name using a value specified by a JSON object passed in the PUT payload. @@ -118,7 +118,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#update delete: tags: - - Datasets/Dataset + - Storage/Datasets summary: Delete dataset description: Deletes a specific dataset. operationId: dataset_delete diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml index cc7dd9f7c..31c4676a2 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml @@ -1,6 +1,6 @@ get: tags: - - Datasets/Item collection + - Storage/Datasets summary: Get items description: | Returns data stored in the dataset in a desired format. @@ -432,7 +432,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#stream_items post: tags: - - Datasets/Item collection + - Storage/Datasets summary: Put items description: | Appends an item or an array of items to the end of the dataset. diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml index ef3057577..756272082 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml @@ -1,6 +1,6 @@ get: tags: - - Datasets/Statistics + - Storage/Datasets summary: Get dataset statistics description: | Returns statistics for given dataset. 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 ca08b3c6d..57b20fb6b 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 @@ -1,6 +1,6 @@ get: tags: - - Key-value stores/Store collection + - Storage/Key-value stores summary: Get list of key-value stores description: | Gets the list of key-value stores owned by the user. @@ -80,7 +80,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClientAsync#list post: tags: - - Key-value stores/Store collection + - Storage/Key-value stores summary: Create key-value store description: | Creates a key-value store and returns its object. The response is the same diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml index 583f6c149..ce6a15d1f 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Key-value stores/Store object + - Storage/Key-value stores summary: Get store description: | Gets an object that contains all the details about a specific key-value @@ -39,7 +39,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#get put: tags: - - Key-value stores/Store object + - Storage/Key-value stores summary: Update store description: | Updates a key-value store's name using a value specified by a JSON object @@ -87,7 +87,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#update delete: tags: - - Key-value stores/Store object + - Storage/Key-value stores summary: Delete store description: Deletes a key-value store. operationId: keyValueStore_delete diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@keys.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@keys.yaml index c9a1e5808..24b9501ad 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@keys.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@keys.yaml @@ -1,6 +1,6 @@ get: tags: - - Key-value stores/Key collection + - Storage/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/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml index 3741a4b3f..69750d881 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml @@ -1,6 +1,6 @@ get: tags: - - Key-value stores/Record + - Storage/Key-value stores summary: Get record description: | Gets a value stored in the key-value store under a specific key. @@ -72,7 +72,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#stream_record put: tags: - - Key-value stores/Record + - Storage/Key-value stores summary: Put record description: | Stores a value under a specific key to the key-value store. @@ -82,8 +82,8 @@ put: `Content-Encoding` header. To save bandwidth, storage, and speed up your upload, send the request - payload compressed with Gzip compression and add the `Content-Encoding: gzip` - header. It is possible to set up another compression type with `Content-Encoding` + payload compressed with Gzip compression and add the `Content-Encoding: gzip` + header. It is possible to set up another compression type with `Content-Encoding` request header. Below is a list of supported `Content-Encoding` types. @@ -157,7 +157,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#set_record delete: tags: - - Key-value stores/Record + - Storage/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/paths/request-queues/request-queues.yaml b/apify-api/openapi/paths/request-queues/request-queues.yaml index 632d495b4..e3099fc00 100644 --- a/apify-api/openapi/paths/request-queues/request-queues.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues.yaml @@ -1,6 +1,6 @@ get: tags: - - Request queues/Queue collection + - Storage/Request queues summary: Get list of request queues description: | Lists all of a user's request queues. The response is a JSON array of @@ -78,7 +78,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClientAsync#list post: tags: - - Request queues/Queue collection + - Storage/Request queues summary: Create request queue description: | Creates a request queue and returns its object. diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml index 5c8c84228..2518d7de4 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Request queues/Queue + - Storage/Request queues summary: Get request queue description: Returns queue object for given queue ID. operationId: requestQueue_get @@ -62,7 +62,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get put: tags: - - Request queues/Queue + - Storage/Request queues summary: Update request queue description: | Updates a request queue's name using a value specified by a JSON object @@ -138,7 +138,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update delete: tags: - - Request queues/Queue + - Storage/Request queues summary: Delete request queue description: Deletes given queue. operationId: requestQueue_delete diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml index b0916e6cd..388f53ead 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml @@ -1,6 +1,6 @@ get: tags: - - Request queues/Queue head + - Storage/Request queues summary: Get head description: | Returns given number of first requests from the queue. diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml index 97eff316b..508ea7dc8 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml @@ -1,6 +1,6 @@ post: tags: - - Request queues/Queue head with locks + - Storage/Request queues summary: Get head and lock description: | Returns the given number of first requests from the queue and locks them for diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml index 23b5f962a..f9aa8c7e1 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml @@ -1,6 +1,6 @@ get: tags: - - Request queues/Request collection + - Storage/Request queues summary: List requests description: | Returns a list of requests. This endpoint is paginated using @@ -137,7 +137,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_requests post: tags: - - Request queues/Request collection + - Storage/Request queues summary: Add request description: | Adds request to the queue. Response contains ID of the request and info if diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml index b08590180..c05e8ba41 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@batch.yaml @@ -1,6 +1,6 @@ post: tags: - - Request queues/Batch request operations + - Storage/Request queues summary: Add requests description: | Adds requests to the queue in batch. The maximum requests in batch is limit @@ -110,7 +110,7 @@ post: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_add_requests delete: tags: - - Request queues/Batch request operations + - Storage/Request queues summary: Delete requests description: | Batch-deletes given requests from the queue. The number of requests in a diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml index d6392c5be..7e4b5fe12 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Request queues/Queue + - Storage/Request queues summary: Get request description: Returns request from queue. operationId: requestQueue_request_get @@ -78,7 +78,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get put: tags: - - Request queues/Queue + - Storage/Request queues summary: Update request description: | Updates a request in a queue. Mark request as handled by setting @@ -197,7 +197,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update delete: tags: - - Request queues/Queue + - Storage/Request queues summary: Delete request description: Deletes given request from queue. operationId: requestQueue_request_delete diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml index 0fa063870..57a2095fa 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml @@ -1,6 +1,6 @@ put: tags: - - Request queues/Request lock + - Storage/Request queues summary: Prolong request lock description: | Prolongs request lock. The request lock can be prolonged only by the client @@ -84,7 +84,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#prolong_request_lock delete: tags: - - Request queues/Request lock + - Storage/Request queues summary: Delete request lock description: | Deletes a request lock. The request lock can be deleted only by the client diff --git a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml index b04cd9ed9..952125e05 100644 --- a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml +++ b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml @@ -1,6 +1,6 @@ get: tags: - - Webhook dispatches/Webhook dispatches collection + - Webhooks/Webhook dispatches summary: Get list of webhook dispatches description: | Gets the list of webhook dispatches that the user have. diff --git a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml index e0b5525ba..baa07d458 100644 --- a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml +++ b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Webhook dispatches/Webhook dispatch object + - Webhooks/Webhook dispatches summary: Get webhook dispatch description: Gets webhook dispatch object with all details. operationId: webhookDispatch_get diff --git a/apify-api/openapi/paths/webhooks/webhooks.yaml b/apify-api/openapi/paths/webhooks/webhooks.yaml index 1af6827b6..e0d06a571 100644 --- a/apify-api/openapi/paths/webhooks/webhooks.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks.yaml @@ -1,6 +1,6 @@ get: tags: - - Webhooks/Webhook collection + - Webhooks/Webhooks summary: Get list of webhooks description: | Gets the list of webhooks that the user created. @@ -65,7 +65,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClientAsync#list post: tags: - - Webhooks/Webhook collection + - Webhooks/Webhooks summary: Create webhook description: | Creates a new webhook with settings provided by the webhook object passed as diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml index 3a160e24d..ea5a0a8f2 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Webhooks/Webhook object + - Webhooks/Webhooks summary: Get webhook description: Gets webhook object with all details. operationId: webhook_get @@ -34,7 +34,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#get put: tags: - - Webhooks/Webhook object + - Webhooks/Webhooks summary: Update webhook description: | Updates a webhook using values specified by a webhook object passed as JSON @@ -89,7 +89,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#update delete: tags: - - Webhooks/Webhook object + - Webhooks/Webhooks summary: Delete webhook description: Deletes a webhook. operationId: webhook_delete diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml index d7f92e138..e1dd12846 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml @@ -1,6 +1,6 @@ get: tags: - - Webhooks/Dispatches collection + - Webhooks/Webhooks summary: Get collection description: Gets a given webhook's list of dispatches. operationId: webhook_dispatches_get diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml index 726fb3207..cb1a82957 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml @@ -1,6 +1,6 @@ post: tags: - - Webhooks/Webhook test + - Webhooks/Webhooks summary: Test webhook description: Tests a webhook. Creates a webhook dispatch with a dummy payload. operationId: webhook_test_post From 79ed75b1ef8461f7d1e1397c2e6d20f688a2c91a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 5 Feb 2025 23:39:05 +0100 Subject: [PATCH 02/11] finish api sidebar reorganization --- apify-api/openapi/components/tags.yaml | 62 ++++--------------- .../openapi/components/x-tag-groups.yaml | 10 +-- apify-api/openapi/openapi.yaml | 2 +- .../paths/logs/logs@{buildOrRunId}.yaml | 2 +- .../openapi/paths/schedules/schedules.yaml | 4 +- .../schedules/schedules@{scheduleId}.yaml | 8 +-- .../schedules/schedules@{scheduleId}@log.yaml | 2 +- apify-api/openapi/paths/store/store.yaml | 2 +- apify-api/openapi/paths/users/users@me.yaml | 2 +- .../openapi/paths/users/users@me@limits.yaml | 4 +- .../paths/users/users@me@usage@monthly.yaml | 2 +- .../openapi/paths/users/users@{userId}.yaml | 2 +- .../webhooks@{webhookId}@dispatches.yaml | 2 +- 13 files changed, 28 insertions(+), 76 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 8dfdb278d..c2c721bfa 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -262,7 +262,6 @@ about platform usage in the documentation. - name: Storage x-displayName: - x-legacy-doc-urls: - name: Storage/Datasets x-displayName: Datasets x-parent-tag-name: Storage @@ -361,7 +360,6 @@ ::: - name: Webhooks x-displayName: - x-legacy-doc-urls: - name: Webhooks/Webhooks x-displayName: Webhooks x-parent-tag-name: Webhooks @@ -415,24 +413,13 @@ Each schedule is assigned actions for it to perform. Actions can be of two types - `RUN_ACTOR` and `RUN_ACTOR_TASK`. For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. -- name: Schedules/Schedules collection - x-displayName: Schedules collection - x-parent-tag-name: Schedules +- name: Schedules + x-displayName: Schedules x-legacy-doc-urls: - '#/reference/schedules/schedules-collection' - '#tag/SchedulesSchedules-collection' - x-trait: 'true' -- name: Schedules/Schedule object - x-displayName: Schedule object - x-parent-tag-name: Schedules - x-legacy-doc-urls: - '#/reference/schedules/schedule-object' - '#tag/SchedulesSchedule-object' - x-trait: 'true' -- name: Schedules/Schedule log - x-displayName: Schedule log - x-parent-tag-name: Schedules - x-legacy-doc-urls: - '#/reference/schedules/schedule-log' - '#tag/SchedulesSchedule-log' x-trait: 'true' @@ -441,24 +428,22 @@ x-legacy-doc-urls: - '#/reference/store' - '#tag/Store' + - '#/reference/store/store-actors-collection' + - '#tag/StoreStore-Actors-collection' description: | [Apify Store](https://apify.com/store) is home to hundreds of public Actors available to the Apify community. The API endpoints described in this section are used to retrieve these Actors. Note that the endpoints do not require the authentication token. -- name: Store/Store Actors collection - x-displayName: Store Actors collection - x-parent-tag-name: Store - x-legacy-doc-urls: - - '#/reference/store/store-actors-collection' - - '#tag/StoreStore-Actors-collection' - x-trait: 'true' + x-trait: true - name: Logs x-displayName: Logs x-legacy-doc-urls: - '#/reference/logs' - '#tag/Logs' + - '#/reference/logs/log' + - '#tag/LogsLog' description: | The API endpoints described in this section are used the download the logs generated by actor builds and runs. Note that only the trailing 5M characters @@ -466,46 +451,21 @@ Note that the endpoints do not require the authentication token, the calls are authenticated using a hard-to-guess ID of the actor build or run. -- name: Logs/Log - x-displayName: Log - x-parent-tag-name: Logs - x-legacy-doc-urls: - - '#/reference/logs/log' - - '#tag/LogsLog' - x-trait: 'true' + x-trait: true - name: Users x-displayName: Users x-legacy-doc-urls: - '#/reference/users' - '#tag/Users' - description: The API endpoints described in this section return information about - user accounts. -- name: Users/Public data - x-displayName: Public data - x-parent-tag-name: Users - x-legacy-doc-urls: - '#/reference/users/public-data' - '#tag/UsersPublic-data' - x-trait: 'true' -- name: Users/Private data - x-displayName: Private data - x-parent-tag-name: Users - x-legacy-doc-urls: - '#/reference/users/private-data' - '#tag/UsersPrivate-data' - x-trait: 'true' -- name: Users/Monthly usage - x-displayName: Monthly usage - x-parent-tag-name: Users - x-legacy-doc-urls: - '#/reference/users/monthly-usage' - '#tag/UsersMonthly-usage' - x-trait: 'true' -- name: Users/Account and usage limits - x-displayName: Account and usage limits - x-parent-tag-name: Users - x-legacy-doc-urls: - '#/reference/users/account-and-usage-limits' - '#tag/UsersAccount-and-usage-limits' - x-trait: 'true' + description: The API endpoints described in this section return information about + user accounts. + x-trait: true diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index edb4865ac..dd22e1570 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -27,22 +27,14 @@ - name: Schedules tags: - Schedules - - Schedules/Schedules collection - - Schedules/Schedule object - - Schedules/Schedule log - name: Store tags: - Store - - Store/Store Actors collection - name: Logs tags: - Logs - - Logs/Log - name: Users tags: - Users - - Users/Public data - - Users/Private data - - Users/Monthly usage - - Users/Account and usage limits + diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 7ab129138..b4e1ffa43 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -602,7 +602,7 @@ paths: '/v2/webhooks/{webhookId}/dispatches': $ref: 'paths/webhooks/webhooks@{webhookId}@dispatches.yaml' /v2/webhook-dispatches: - $ref: paths/webhook-dispatches/webhook-dispatches.yaml + $ref: 'paths/webhook-dispatches/webhook-dispatches.yaml' '/v2/webhook-dispatches/{dispatchId}': $ref: 'paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml' /v2/schedules: diff --git a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml index 0ee1eecb8..003a2e032 100644 --- a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml +++ b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Logs/Log + - Logs summary: Get log x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/logs/log/get-log diff --git a/apify-api/openapi/paths/schedules/schedules.yaml b/apify-api/openapi/paths/schedules/schedules.yaml index 4733dbea5..22af4d436 100644 --- a/apify-api/openapi/paths/schedules/schedules.yaml +++ b/apify-api/openapi/paths/schedules/schedules.yaml @@ -1,6 +1,6 @@ get: tags: - - Schedules/Schedules collection + - Schedules summary: Get list of schedules description: | Gets the list of schedules that the user created. @@ -63,7 +63,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClientAsync#list post: tags: - - Schedules/Schedules collection + - Schedules summary: Create schedule description: | Creates a new schedule with settings provided by the schedule object passed diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml index bf83c8d56..592c96821 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Schedules/Schedule object + - Schedules summary: Get schedule description: Gets the schedule object with all details. operationId: schedule_get @@ -34,12 +34,12 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#get put: tags: - - Schedules/Schedule object + - Schedules summary: Update schedule description: | Updates a schedule using values specified by a schedule object passed as JSON in the POST payload. If the object does not define a specific property, - its value will not be updated. + its value will not be updated. The response is the full schedule object as returned by the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. @@ -88,7 +88,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#update delete: tags: - - Schedules/Schedule object + - Schedules summary: Delete schedule description: Deletes a schedule. operationId: schedule_delete diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml index f2ed655db..14e706b49 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml @@ -1,6 +1,6 @@ get: tags: - - Schedules/Schedule log + - Schedules summary: Get schedule log description: | Gets the schedule log as a JSON array containing information about up to a diff --git a/apify-api/openapi/paths/store/store.yaml b/apify-api/openapi/paths/store/store.yaml index 839dd5edd..ab81913c4 100644 --- a/apify-api/openapi/paths/store/store.yaml +++ b/apify-api/openapi/paths/store/store.yaml @@ -1,6 +1,6 @@ get: tags: - - Store/Store Actors collection + - Store summary: Get list of Actors in store description: | Gets the list of public Actors in Apify Store. You can use `search` diff --git a/apify-api/openapi/paths/users/users@me.yaml b/apify-api/openapi/paths/users/users@me.yaml index 68214ad0f..a4d728ef6 100644 --- a/apify-api/openapi/paths/users/users@me.yaml +++ b/apify-api/openapi/paths/users/users@me.yaml @@ -1,6 +1,6 @@ get: tags: - - Users/Private data + - Users summary: Get private user data description: | Returns information about the current user account, including both public diff --git a/apify-api/openapi/paths/users/users@me@limits.yaml b/apify-api/openapi/paths/users/users@me@limits.yaml index c3a6f47e3..42b35aa93 100644 --- a/apify-api/openapi/paths/users/users@me@limits.yaml +++ b/apify-api/openapi/paths/users/users@me@limits.yaml @@ -1,6 +1,6 @@ get: tags: - - Users/Account and usage limits + - Users summary: Get limits description: | Returns a complete summary of your account's limits. It is the same @@ -22,7 +22,7 @@ get: - https://docs.apify.com/api/v2#tag/UsersAccount-and-usage-limits/operation/users_me_limits_get put: tags: - - Users/Account and usage limits + - Users summary: Update limits description: | Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits). diff --git a/apify-api/openapi/paths/users/users@me@usage@monthly.yaml b/apify-api/openapi/paths/users/users@me@usage@monthly.yaml index 9ff07a82e..7b49f2b78 100644 --- a/apify-api/openapi/paths/users/users@me@usage@monthly.yaml +++ b/apify-api/openapi/paths/users/users@me@usage@monthly.yaml @@ -1,6 +1,6 @@ get: tags: - - Users/Monthly usage + - Users summary: Get monthly usage description: | Returns a complete summary of your usage for the current usage cycle, diff --git a/apify-api/openapi/paths/users/users@{userId}.yaml b/apify-api/openapi/paths/users/users@{userId}.yaml index e98f9d367..49db3ff62 100644 --- a/apify-api/openapi/paths/users/users@{userId}.yaml +++ b/apify-api/openapi/paths/users/users@{userId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Users/Public data + - Users summary: Get public user data description: | Returns public information about a specific user account, similar to what diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml index e1dd12846..0836491e9 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml @@ -20,7 +20,7 @@ get: content: application/json: schema: - $ref: ../../components/schemas/webhook-dispatches/WebhookDispatchList.yaml + $ref: ../../components/schemas/webhooks/WebhookDispatchList.yaml deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection From f151fb65f9337e72ab9d6af07d7dd2168c2a172e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 5 Feb 2025 23:47:27 +0100 Subject: [PATCH 03/11] fix broken ref --- .../openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml index 0836491e9..e1dd12846 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml @@ -20,7 +20,7 @@ get: content: application/json: schema: - $ref: ../../components/schemas/webhooks/WebhookDispatchList.yaml + $ref: ../../components/schemas/webhook-dispatches/WebhookDispatchList.yaml deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection From 0516f78674a53b85a3a7fb35d896eb52941f15e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 5 Feb 2025 23:50:44 +0100 Subject: [PATCH 04/11] remove duplicated schedules endpoints --- apify-api/openapi/components/tags.yaml | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index c2c721bfa..22b1b177f 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -400,6 +400,12 @@ x-legacy-doc-urls: - '#/reference/schedules' - '#tag/Schedules' + - '#/reference/schedules/schedules-collection' + - '#tag/SchedulesSchedules-collection' + - '#/reference/schedules/schedule-object' + - '#tag/SchedulesSchedule-object' + - '#/reference/schedules/schedule-log' + - '#tag/SchedulesSchedule-log' description: | This section describes API endpoints for managing schedules. @@ -413,15 +419,6 @@ Each schedule is assigned actions for it to perform. Actions can be of two types - `RUN_ACTOR` and `RUN_ACTOR_TASK`. For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. -- name: Schedules - x-displayName: Schedules - x-legacy-doc-urls: - - '#/reference/schedules/schedules-collection' - - '#tag/SchedulesSchedules-collection' - - '#/reference/schedules/schedule-object' - - '#tag/SchedulesSchedule-object' - - '#/reference/schedules/schedule-log' - - '#tag/SchedulesSchedule-log' x-trait: 'true' - name: Store x-displayName: Store From c8924542b5c5dea258a62016edb0a5f073b54156 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 00:35:25 +0100 Subject: [PATCH 05/11] fix Actor capilatization --- apify-api/openapi/components/tags.yaml | 38 +++++++++++++------------- apify-api/openapi/openapi.yaml | 34 +++++++++++------------ 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 22b1b177f..45018f442 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -8,12 +8,12 @@ - '#/reference/actors/actor-object' - '#tag/ActorsActor-object' description: | - The API endpoints described in this section enable you to manage, build and run Apify actors. + The API endpoints described in this section enable you to manage, build and run Apify Actors. For more information, see the Actor documentation. - Note that for all the API endpoints that accept the `actorId` parameter to specify an actor, - you can pass either the actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated - username of the actor owner and the actor name (e.g. `janedoe~my-actor`). + Note that for all the API endpoints that accept the `actorId` parameter to specify an Actor, + you can pass either the Actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated + username of the Actor owner and the Actor name (e.g. `janedoe~my-actor`). Some of the API endpoints return runs objects. Note that if any such run object contains usage in dollars, your effective unit pricing at the time of query @@ -77,7 +77,7 @@ - For more information about source code and actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) + For more information about source code and Actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) in Actors documentation. - name: Actors/Actor builds x-displayName: Actor builds @@ -121,12 +121,12 @@ x-trait: 'true' description: | This is not a single endpoint, but an entire group of endpoints that lets you to - retrieve and manage the last run of given actor or any of its default storages. + retrieve and manage the last run of given Actor or any of its default storages. All the endpoints require an authentication token. The endpoints accept the same HTTP methods and query parameters as the respective storage endpoints. - The base path represents the last actor run object is: + The base path represents the last Actor run object is: `/v2/acts/{actorId}/runs/last{?token,status}` @@ -134,7 +134,7 @@ (e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters are the same as in the [Run object](#/reference/actors/run-object) endpoint. - In order to access the default storages of the last actor run, i.e. log, key-value + In order to access the default storages of the last Actor run, i.e. log, key-value store, dataset and request queue, use the following endpoints: * `/v2/acts/{actorId}/runs/last/log{?token,status}` @@ -166,7 +166,7 @@ [Request collection](#/reference/request-queues/request) * `/v2/acts/{actorId}/runs/last/request-queue/head{?token,status}` [Queue head](#/reference/request-queues/queue-head) - For example, to download data from a dataset of the last succeeded actor run in XML format, + For example, to download data from a dataset of the last succeeded Actor run in XML format, send HTTP GET request to the following URL: ``` @@ -188,7 +188,7 @@ - '#/reference/actor-builds/build-log' - '#tag/Actor-buildsBuild-log' description: | - The API endpoints described in this section enable you to manage Apify actor builds. + The API endpoints described in this section enable you to manage Apify Actor builds. Note that if any returned build object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be @@ -218,7 +218,7 @@ This section describes API endpoints to manage Key-value stores. Key-value store is a simple storage for saving and reading data records or files. Each data record is represented by a unique key and associated with a MIME content type. - Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages, + Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, PDFs or to persist the state of crawlers. For more information, see the Key-value store documentation. @@ -247,7 +247,7 @@ - '#/reference/actor-tasks/last-run-object-and-its-storages' - '#tag/Actor-tasksLast-run-object-and-its-storages' description: | - The API endpoints described in this section enable you to manage and run Apify actor tasks. + The API endpoints described in this section enable you to manage and run Apify Actor tasks. For more information, see the Actor tasks documentation. @@ -308,7 +308,7 @@ This section describes API endpoints to manage Key-value stores. Key-value store is a simple storage for saving and reading data records or files. Each data record is represented by a unique key and associated with a MIME content type. - Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages, + Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, PDFs or to persist the state of crawlers. For more information, see the Key-value store documentation. @@ -380,7 +380,7 @@ Webhooks provide an easy and reliable way to configure the Apify platform to carry out an action (e.g. a HTTP request to another service) when a certain system event occurs. - For example, you can use webhooks to start another actor when an actor run finishes + For example, you can use webhooks to start another Actor when an Actor run finishes or fails. For more information see Webhooks documentation. @@ -409,9 +409,9 @@ description: | This section describes API endpoints for managing schedules. - Schedules are used to automatically start your actors at certain times. Each schedule - can be associated with a number of actors and actor tasks. It is also possible - to override the settings of each actor (task) similarly to when invoking the actor + Schedules are used to automatically start your Actors at certain times. Each schedule + can be associated with a number of Actors and Actor tasks. It is also possible + to override the settings of each Actor (task) similarly to when invoking the Actor (task) using the API. For more information, see Schedules documentation. @@ -443,11 +443,11 @@ - '#tag/LogsLog' description: | The API endpoints described in this section are used the download the logs - generated by actor builds and runs. Note that only the trailing 5M characters + generated by Actor builds and runs. Note that only the trailing 5M characters of the log are stored, the rest is discarded. Note that the endpoints do not require the authentication token, the calls - are authenticated using a hard-to-guess ID of the actor build or run. + are authenticated using a hard-to-guess ID of the Actor build or run. x-trait: true - name: Users x-displayName: Users diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index b4e1ffa43..c59bf41f7 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -66,14 +66,14 @@ info: ## Basic usage - To run an actor, send a POST request to the [Run - actor](#/reference/actors/run-collection/run-actor) endpoint using either the - actor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g. + To run an Actor, send a POST request to the [Run + Actor](#/reference/actors/run-collection/run-actor) endpoint using either the + Actor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g. `janedoe~my-actor`): `https://api.apify.com/v2/acts/[actor_id]/runs` - If the actor is not runnable anonymously, you will receive a 401 or 403 + If the Actor is not runnable anonymously, you will receive a 401 or 403 [response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). This means you need to add your [secret API token](https://console.apify.com/account#/integrations) to the request's @@ -81,24 +81,24 @@ info: URL query parameter `?token=[your_token]` (less secure). Optionally, you can include the query parameters described in the [Run - actor](#/reference/actors/run-collection/run-actor) section to customize your + Actor](#/reference/actors/run-collection/run-actor) section to customize your run. - If you're using Node.js, the best way to run an actor is using the + If you're using Node.js, the best way to run an Actor is using the `Apify.call()` method from the [Apify SDK](https://sdk.apify.com/docs/api/apify#apifycallactid-input-options). It - runs the actor using the account you are currently logged into (determined + runs the Actor using the account you are currently logged into (determined by the [secret API token](https://console.apify.com/account#/integrations)). - The result is an [actor run + The result is an [Actor run object](https://sdk.apify.com/docs/typedefs/actor-run) and its output (if any). A typical workflow is as follows: - 1. Run an actor or task using the [Run - actor](#/reference/actors/run-collection/run-actor) or [Run + 1. Run an Actor or task using the [Run + Actor](#/reference/actors/run-collection/run-actor) or [Run task](#/reference/actor-tasks/run-collection/run-task) API endpoints. - 2. Monitor the actor run by periodically polling its progress using the [Get + 2. Monitor the Actor run by periodically polling its progress using the [Get run](#/reference/actor-runs/run-object-and-its-storages/get-run) API endpoint. 3. Fetch the results from the [Get @@ -109,7 +109,7 @@ info: using the `defaultKeyValueStoreId` and the store's `key`. **Note**: Instead of periodic polling, you can also run your - [actor](#/reference/actors/run-actor-synchronously) or + [Actor](#/reference/actors/run-actor-synchronously) or [task](#/reference/actor-tasks/runs-collection/run-task-synchronously) synchronously. This will ensure that the request waits for 300 seconds (5 minutes) for the run to finish and returns its output. If the run takes @@ -151,7 +151,7 @@ info: All API endpoints that return a list of records (e.g. [Get list of - actors](#/reference/actors/actor-collection/get-list-of-actors)) + Actors](#/reference/actors/actor-collection/get-list-of-actors)) enforce pagination in order to limit the size of their responses. Most of these API endpoints are paginated using the `offset` and `limit` @@ -417,10 +417,10 @@ info: operations on key-value store records These endpoints have a rate limit of _200 requests per second per resource_: - * [Run actor](#/reference/actors/run-collection/run-actor) - * [Run actor task asynchronously](#/reference/actor-tasks/runs-collection/run-task-asynchronously) - * [Run actor task synchronously](#/reference/actor-tasks/runs-collection/run-task-synchronously) - * [Metamorph actor run](#/reference/actors/metamorph-run/metamorph-run) + * [Run Actor](#/reference/actors/run-collection/run-actor) + * [Run Actor task asynchronously](#/reference/actor-tasks/runs-collection/run-task-asynchronously) + * [Run Actor task synchronously](#/reference/actor-tasks/runs-collection/run-task-synchronously) + * [Metamorph Actor run](#/reference/actors/metamorph-run/metamorph-run) * [Push items](#/reference/datasets/item-collection/put-items) to dataset * CRUD ([add](#/reference/request-queues/request-collection/add-request), From 39e44d798a36e1c439b6515bf5fee3c90262f396 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 10:44:58 +0100 Subject: [PATCH 06/11] rewrite description change HTML to markdown where possible change title of first pages --- apify-api/openapi/components/tags.yaml | 94 ++++++++++---------------- 1 file changed, 37 insertions(+), 57 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 45018f442..d95002cc5 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -1,5 +1,5 @@ - name: Actors - x-displayName: Actors + x-displayName: Actors - Introduction x-legacy-doc-urls: - '#/reference/actors' - '#tag/Actors' @@ -8,18 +8,12 @@ - '#/reference/actors/actor-object' - '#tag/ActorsActor-object' description: | - The API endpoints described in this section enable you to manage, build and run Apify Actors. - For more information, see the Actor documentation. + The API endpoints in this section allow you to manage Apify Actors. For more details about Actors, refer to the [Actor documentation](https://docs.apify.com/platform/actors). - Note that for all the API endpoints that accept the `actorId` parameter to specify an Actor, - you can pass either the Actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated - username of the Actor owner and the Actor name (e.g. `janedoe~my-actor`). + For API endpoints that require the `actorId` parameter to identify an Actor, you can provide either: + - The Actor ID (e.g., `HG7ML7M8z78YcAPEB`), or + - A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`). - Some of the API endpoints return runs objects. Note that if any such run object - contains usage in dollars, your effective unit pricing at the time of query - has been used for computation of this dollar equivalent, and hence it should be - used only for informative purposes. You can learn more - about platform usage in the documentation. - name: Actors/Actor versions x-displayName: Actor versions x-parent-tag-name: Actors @@ -34,50 +28,20 @@ - '#tag/ActorsEnvironment-variable-object' x-trait: 'true' description: | - The **Version object** contains the source code of a specific version of an actor. - The `sourceType` property indicates where the source code is hosted, and based + The API endpoints in this section allow you to manage your Apify Actors versions. + + - The _Version object_ contains the source code of a specific version of an Actor. + - The `sourceType` property indicates where the source code is hosted, and based on its value the Version object has the following additional property: - - - - - - - - - - - - - - - - - -
"SOURCE_FILES" - Source code is comprised of multiple files specified in the sourceFiles array. - Each item of the array is an object with the following fields:
-
    -
  • name
    • - File path and name
    -
  • format
    • - Format of the content, can be either "TEXT" - or "BASE64"
    -
  • content
    • - File content
    -
-
- Source files can be shown and edited in the Apify Console's Web IDE. -
"GIT_REPO" - Source code is cloned from a Git repository, whose URL is specified in - the gitRepoUrl field. -
"TARBALL" - Source code is downloaded using a tarball or Zip file from a URL specified - in the tarballUrl field. -
"GITHUB_GIST" - Source code is taken from a GitHub Gist, whose URL is specified in the - gitHubGistUrl field. -
- - For more information about source code and Actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) + | **Value** | **Description** | + |---|---| + | `"SOURCE_FILES"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:
- `name`: File path and name
- `format`: Format of the content, can be either `"TEXT"` or `"BASE64"`
- `content`: File content

Source files can be shown and edited in the Apify Console's Web IDE. | + | `"GIT_REPO"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. | + | `"TARBALL"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. | + |`"GITHUB_GIST"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. | + + For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) in Actors documentation. - name: Actors/Actor builds x-displayName: Actor builds @@ -104,6 +68,12 @@ - '#tag/ActorsRun-actor-synchronously' - '#/reference/actors/run-actor-synchronously-and-get-dataset-items' - '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items' + description: | + The API endpoints in this section allow you to run Apify Actors. + + Some API endpoints return run objects. If a run object includes usage costs in dollars, note that these values are calculated based on your effective unit pricing at the time of the query. As a result, the dollar amounts should be treated as informational only and not as exact figures. + + For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). x-trait: 'true' - name: Actors/Webhook collection x-displayName: Webhook collection @@ -111,6 +81,8 @@ x-legacy-doc-urls: - '#/reference/actors/webhook-collection' - '#tag/ActorsWebhook-collection' + description: | + The API endpoint in this section allows you to get a list of webhooks of a specific Actor. x-trait: 'true' - name: Actors/Last run object and its storages x-displayName: Last run object and its storages @@ -175,7 +147,7 @@ In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. - name: Actor builds - x-displayName: Introduction + x-displayName: Actor builds - Introduction x-legacy-doc-urls: - '#/reference/actor-builds' - '#tag/Actor-builds' @@ -188,14 +160,18 @@ - '#/reference/actor-builds/build-log' - '#tag/Actor-buildsBuild-log' description: | - The API endpoints described in this section enable you to manage Apify Actor builds. + The API endpoints described in this section enable you to create, manage, and delete Apify Actor builds. + + :::note Note that if any returned build object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. You can learn more about platform usage in the documentation. + + ::: - name: Actor runs - x-displayName: Introduction + x-displayName: Actor runs - Introduction x-legacy-doc-urls: - '#/reference/actor-runs' - '#tag/Actor-runs' @@ -206,16 +182,20 @@ description: | The API endpoints described in this section enable you to manage Apify Actor runs. + :::note + Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. You can learn more about platform usage in the documentation. + + ::: - name: Key-value stores x-displayName: Key-value stores x-legacy-doc-urls: - '#/reference/key-value-stores' - '#tag/Key-value-stores' description: | - This section describes API endpoints to manage Key-value stores. + The API endpoints described in this section enable you to manage Key-value stores. Key-value store is a simple storage for saving and reading data records or files. Each data record is represented by a unique key and associated with a MIME content type. Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, From 59178bba15c7cbdde5123a8384f6a56b30593af8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 16:14:22 +0100 Subject: [PATCH 07/11] change formatting & order within sidebar --- apify-api/openapi/components/tags.yaml | 6 ++++-- apify-api/openapi/openapi.yaml | 12 ++++++------ 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index d95002cc5..b0cce21c9 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -30,7 +30,7 @@ description: | The API endpoints in this section allow you to manage your Apify Actors versions. - - The _Version object_ contains the source code of a specific version of an Actor. + - The version object contains the source code of a specific version of an Actor. - The `sourceType` property indicates where the source code is hosted, and based on its value the Version object has the following additional property: @@ -53,6 +53,8 @@ - '#tag/ActorsBuild-object' - '#tag/ActorsAbort-build' x-trait: 'true' + description: | + The API endpoints in this section allow you to manage your Apify Actors builds. - name: Actors/Actor runs x-displayName: Actor runs x-parent-tag-name: Actors @@ -69,7 +71,7 @@ - '#/reference/actors/run-actor-synchronously-and-get-dataset-items' - '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items' description: | - The API endpoints in this section allow you to run Apify Actors. + The API endpoints in this section allow you to manage your Apify Actors runs. Some API endpoints return run objects. If a run object includes usage costs in dollars, note that these values are calculated based on your effective unit pricing at the time of the query. As a result, the dollar amounts should be treated as informational only and not as exact figures. diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index c59bf41f7..5ec130cae 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -499,28 +499,28 @@ paths: $ref: 'paths/actors/acts@{actorId}@webhooks.yaml' '/v2/acts/{actorId}/builds': $ref: 'paths/actors/acts@{actorId}@builds.yaml' - '/v2/acts/{actorId}/builds/{buildId}': - $ref: 'paths/actors/acts@{actorId}@builds@{buildId}.yaml' '/v2/acts/{actorId}/builds/default': $ref: 'paths/actors/acts@{actorId}@builds@default.yaml' - '/v2/acts/{actorId}/builds/{buildId}/abort': - $ref: 'paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml' '/v2/acts/{actorId}/builds/{buildId}/openapi.json': $ref: 'paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml' + '/v2/acts/{actorId}/builds/{buildId}': + $ref: 'paths/actors/acts@{actorId}@builds@{buildId}.yaml' + '/v2/acts/{actorId}/builds/{buildId}/abort': + $ref: 'paths/actors/acts@{actorId}@builds@{buildId}@abort.yaml' '/v2/acts/{actorId}/runs': $ref: 'paths/actors/acts@{actorId}@runs.yaml' '/v2/acts/{actorId}/run-sync': $ref: 'paths/actors/acts@{actorId}@run-sync.yaml' '/v2/acts/{actorId}/run-sync-get-dataset-items': $ref: 'paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml' + '/v2/acts/{actorId}/runs/{runId}/resurrect': + $ref: 'paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml' '/v2/acts/{actorId}/runs/{runId}': $ref: 'paths/actors/acts@{actorId}@runs@{runId}.yaml' '/v2/acts/{actorId}/runs/{runId}/abort': $ref: 'paths/actors/acts@{actorId}@runs@{runId}@abort.yaml' '/v2/acts/{actorId}/runs/{runId}/metamorph': $ref: 'paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml' - '/v2/acts/{actorId}/runs/{runId}/resurrect': - $ref: 'paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml' '/v2/acts/{actorId}/runs/last': $ref: 'paths/actors/acts@{actorId}@runs@last.yaml' /v2/actor-tasks: From 91b1c1463e7dbe37bddd0703e87c0786a1696090 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 17:22:01 +0100 Subject: [PATCH 08/11] remove HTML from section descriptions remove HTMl from section descriptions change order of operations so deprecated endpoints are always last --- apify-api/openapi/components/tags.yaml | 95 +++++++++---------- apify-api/openapi/openapi.yaml | 4 +- .../actors/acts@{actorId}@runs@last.yaml | 2 +- 3 files changed, 47 insertions(+), 54 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index b0cce21c9..79f104766 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -162,16 +162,13 @@ - '#/reference/actor-builds/build-log' - '#tag/Actor-buildsBuild-log' description: | - The API endpoints described in this section enable you to create, manage, and delete Apify Actor builds. - - :::note + The API endpoints described in this section enable you to manage, and delete Apify Actor builds. Note that if any returned build object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. - You can learn more about platform usage in the documentation. - ::: + You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor runs x-displayName: Actor runs - Introduction x-legacy-doc-urls: @@ -182,31 +179,12 @@ - '#/reference/actor-runs/run-object-and-its-storages' - '#tag/Actor-runsRun-object-and-its-storages' description: | - The API endpoints described in this section enable you to manage Apify Actor runs. - - :::note + The API endpoints described in this section enable you to manage, and delete Apify Actor runs. - Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query + If any returned run object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. - You can learn more about platform usage in the documentation. - ::: -- name: Key-value stores - x-displayName: Key-value stores - x-legacy-doc-urls: - - '#/reference/key-value-stores' - - '#tag/Key-value-stores' - description: | - The API endpoints described in this section enable you to manage Key-value stores. - Key-value store is a simple storage for saving and reading data records or files. - Each data record is represented by a unique key and associated with a MIME content type. - Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, - PDFs or to persist the state of crawlers. - For more information, see the Key-value - store documentation. - - Note that some of the endpoints do not require the authentication token, the calls - are authenticated using a hard-to-guess ID of the key-value store. + You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor tasks x-displayName: Actor tasks x-legacy-doc-urls: @@ -229,19 +207,23 @@ - '#/reference/actor-tasks/last-run-object-and-its-storages' - '#tag/Actor-tasksLast-run-object-and-its-storages' description: | - The API endpoints described in this section enable you to manage and run Apify Actor tasks. - For more information, see the Actor - tasks documentation. + The API endpoints described in this section enable you to create, manage, delete, and run Apify Actor tasks. + For more information, see the [Actor tasts documentation](https://docs.apify.com/platform/actors/running/tasks). + + :::note - Note that for all the API endpoints that accept the `actorTaskId` parameter to + For all the API endpoints that accept the `actorTaskId` parameter to specify a task, you can pass either the task ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated username of the task's owner and the task's name (e.g. `janedoe~my-task`). - Some of the API endpoints return runs objects. Note that if any such run object + ::: + + Some of the API endpoints return run objects. If any such run object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be - used only for informative purposes. You can learn more - about platform usage in the documentation. + used only for informative purposes. + + You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Storage x-displayName: - name: Storage/Datasets @@ -264,12 +246,12 @@ where each object is a row and its attributes are columns. Dataset is an append-only storage - you can only add new records to it but you cannot modify or remove existing records. Typically it is used to store crawling results. - For more information, see the Datasets - documentation. + + For more information, see the [Datasets documentation](https://docs.apify.com/platform/storage/dataset). :::note - Note that some of the endpoints do not require the authentication token, the calls + Some of the endpoints do not require the authentication token, the calls are authenticated using the hard-to-guess ID of the dataset. ::: @@ -286,18 +268,20 @@ - '#tag/Key-value-storesStore-object' - '#/reference/key-value-stores/record' - '#tag/Key-value-storesRecord' + - '#/reference/key-value-stores' + - '#tag/Key-value-stores' description: | This section describes API endpoints to manage Key-value stores. Key-value store is a simple storage for saving and reading data records or files. Each data record is represented by a unique key and associated with a MIME content type. Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, PDFs or to persist the state of crawlers. - For more information, see the Key-value - store documentation. + + For more information, see the [Key-value store documentation](https://docs.apify.com/platform/storage/key-value-store). :::note - Note that some of the endpoints do not require the authentication token, the calls + Some of the endpoints do not require the authentication token, the calls are authenticated using a hard-to-guess ID of the key-value store. ::: @@ -325,18 +309,18 @@ - '#/reference/request-queues/batch-request-operations' - '#tag/Request-queuesBatch-request-operations' description: | - This section describes API endpoints to manage request queues. + This section describes API endpoints to create, manage, and delete request queues. Request queue is a storage for a queue of HTTP URLs to crawl, which is typically used for deep crawling of websites where you start with several URLs and then recursively follow links to other pages. The storage supports both breadth-first and depth-first crawling orders. - For more information, see the Request - queue documentation. + + For more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue). :::note - Note that some of the endpoints do not require the authentication token, the calls + Some of the endpoints do not require the authentication token, the calls are authenticated using the hard-to-guess ID of the queue. ::: @@ -364,8 +348,8 @@ system event occurs. For example, you can use webhooks to start another Actor when an Actor run finishes or fails. - For more information see Webhooks - documentation. + + For more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). - name: Webhooks/Webhook dispatches x-displayName: Webhook dispatches x-parent-tag-name: Webhooks @@ -395,12 +379,13 @@ can be associated with a number of Actors and Actor tasks. It is also possible to override the settings of each Actor (task) similarly to when invoking the Actor (task) using the API. - For more information, see Schedules - documentation. + For more information, see [Schedules documentation](https://docs.apify.com/platform/schedules">Schedules + documentation). Each schedule is assigned actions for it to perform. Actions can be of two types - - `RUN_ACTOR` and `RUN_ACTOR_TASK`. For details, see the documentation of the - [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. + - `RUN_ACTOR` and `RUN_ACTOR_TASK`. + + For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. x-trait: 'true' - name: Store x-displayName: Store @@ -414,7 +399,11 @@ to the Apify community. The API endpoints described in this section are used to retrieve these Actors. - Note that the endpoints do not require the authentication token. + :::note + + These endpoints do not require the authentication token. + + ::: x-trait: true - name: Logs x-displayName: Logs @@ -428,8 +417,12 @@ generated by Actor builds and runs. Note that only the trailing 5M characters of the log are stored, the rest is discarded. + :::note + Note that the endpoints do not require the authentication token, the calls are authenticated using a hard-to-guess ID of the Actor build or run. + + ::: x-trait: true - name: Users x-displayName: Users diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 5ec130cae..8a8517e40 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -515,14 +515,14 @@ paths: $ref: 'paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml' '/v2/acts/{actorId}/runs/{runId}/resurrect': $ref: 'paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml' + '/v2/acts/{actorId}/runs/last': + $ref: 'paths/actors/acts@{actorId}@runs@last.yaml' '/v2/acts/{actorId}/runs/{runId}': $ref: 'paths/actors/acts@{actorId}@runs@{runId}.yaml' '/v2/acts/{actorId}/runs/{runId}/abort': $ref: 'paths/actors/acts@{actorId}@runs@{runId}@abort.yaml' '/v2/acts/{actorId}/runs/{runId}/metamorph': $ref: 'paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml' - '/v2/acts/{actorId}/runs/last': - $ref: 'paths/actors/acts@{actorId}@runs@last.yaml' /v2/actor-tasks: $ref: 'paths/actor-tasks/actor-tasks.yaml' '/v2/actor-tasks/{actorTaskId}': diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml index 696855b3a..f478d46ee 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml @@ -1,6 +1,6 @@ get: tags: - - Actors/Last run object and its storages + - Actors/Actor runs summary: Get last run description: | This is not a single endpoint, but an entire group of endpoints that lets you to From 5d2824863ffc77a048e16bb2233f02481d3a7357 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 20:26:24 +0100 Subject: [PATCH 09/11] streamline descriptions, fix formatting & add redirects add redirects to group sections in nginx.conf streamline descriptions by moving shared parts to grouping introductions fix formatting remove HTML when possible --- .../actor-runs/actor-runs@{runId}@charge.yaml | 2 +- .../actor-runs@{runId}@metamorph.yaml | 3 +- .../actor-runs@{runId}@resurrect.yaml | 3 +- .../paths/actor-tasks/actor-tasks.yaml | 5 +- ...torTaskId}@run-sync-get-dataset-items.yaml | 140 +++++++++--------- .../actor-tasks@{actorTaskId}@run-sync.yaml | 106 ++++++------- ...ctorId}@builds@{buildId}@openapi.json.yaml | 6 +- ...ts@{actorId}@versions@{versionNumber}.yaml | 134 +---------------- ...Id}@versions@{versionNumber}@env-vars.yaml | 3 +- .../openapi/paths/datasets/datasets.yaml | 5 +- .../paths/datasets/datasets@{datasetId}.yaml | 7 +- .../datasets@{datasetId}@statistics.yaml | 3 +- .../paths/logs/logs@{buildOrRunId}.yaml | 3 +- nginx.conf | 78 ++++++++++ 14 files changed, 228 insertions(+), 270 deletions(-) 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 852a0eaf2..e7992fd40 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 @@ -9,7 +9,7 @@ post: :::note - Note that pay per events Actors are still in alpha. Please, reach out to us with any questions or feedback. + Pay per events Actors are still in alpha. Please, reach out to us with any questions or feedback. ::: operationId: PostChargeRun 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 19bab4f6d..3592b61db 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 @@ -18,8 +18,7 @@ post: All the default storages are preserved and the new input is stored under the `INPUT-METAMORPH-1` key in the same default key-value store. - For more information, see the [Actor - docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph). + For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph). operationId: actorRun_metamorph_post parameters: - name: runId diff --git a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml index 16b09d80a..f006bac31 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml @@ -8,8 +8,7 @@ post: Run status will be updated to RUNNING and its container will be restarted with the same storages (the same behaviour as when the run gets migrated to the new server). - For more information, - see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). + For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run). operationId: PostResurrectRun parameters: - name: runId diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml index 92e86f32d..c150f2e3e 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml @@ -3,8 +3,9 @@ get: - Actor tasks summary: Get list of tasks description: | - Gets the complete list of tasks that a user has created or used. The - response is a list of objects in which each object contains essential + Gets the complete list of tasks that a user has created or used. + + The response is a list of objects in which each object contains essential information about a single task. The endpoint supports pagination using the `limit` and `offset` parameters, diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml index 3cec9ba47..619ae8343 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml @@ -1,21 +1,14 @@ -post: +get: tags: - Actor tasks - summary: Run task synchronously and get dataset items (POST) + summary: Run task synchronously and get dataset items description: | - Runs an Actor task and synchronously returns its dataset items. + Run a specific task and return its dataset items. The run must finish in 300 seconds otherwise the HTTP request fails with a timeout error (this won't abort the run itself). - Optionally, you can override the Actor input configuration by passing a JSON - object as the POST payload and setting the `Content-Type: application/json` HTTP header. - - Note that if the object in the POST payload does not define a particular - input property, the Actor run uses the default value defined by the task (or the Actor's - input schema if not defined by the task). - You can send all the same options in parameters as the [Get Dataset Items](#/reference/datasets/item-collection/get-items) API endpoint. @@ -26,15 +19,10 @@ post: If the connection breaks, you will not receive any information about the run and its status. - Input fields from Actor task configuration can be overloaded with values - passed as the POST payload. - - Just make sure to specify the `Content-Type` header as `application/json` - and that the input is an object. - - To run the task asynchronously, use the [Run - task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead. - operationId: actorTask_runSyncGetDatasetItems_post + To run the Task asynchronously, use the [Run task + asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint + instead. + operationId: actorTask_runSyncGetDatasetItems_get parameters: - name: actorTaskId in: path @@ -96,11 +84,9 @@ post: in: query description: | Specifies optional webhooks associated with the Actor run, which can be - used to receive a notification - e.g. when the Actor finished or failed. The value is a Base64-encoded + used to receive a notification e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see - [Webhooks - documentation](https://docs.apify.com/platform/integrations/webhooks). + [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). style: form explode: true schema: @@ -121,9 +107,12 @@ post: description: | If `true` or `1` then the API endpoint returns only non-empty items and skips hidden fields + (i.e. fields starting with the # character). + The `clean` parameter is just a shortcut for `skipHidden=true` and `skipEmpty=true` parameters. + Note that since some objects might be skipped from the output, that the result might contain less items than the `limit` value. style: form @@ -155,9 +144,12 @@ post: in: query description: | A comma-separated list of fields which should be picked from the items, + only these fields will remain in the resulting record objects. + Note that the fields in the outputted items are sorted the same way as they are specified in the `fields` query parameter. + You can use this feature to effectively fix the output format. style: form explode: true @@ -177,13 +169,18 @@ post: description: | A comma-separated list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. + If the field is an array then every element of + the array will become a separate record and merged with parent object. + If the unwound field is an object then it is merged with the parent object + If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object then the item gets preserved as it is. + Note that the unwound items ignore the `desc` parameter. style: form explode: true @@ -195,8 +192,10 @@ post: description: | A comma-separated list of fields which should transform nested objects into flat structures. + For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}` is turned into `{"foo.bar": "hello"}`. + The original object with properties is replaced with the flattened object. style: form @@ -241,8 +240,10 @@ post: description: | All text responses are encoded in UTF-8 encoding. By default, the `format=csv` files are prefixed with + the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html` and `rss` files are not. + If you want to override this default behavior, specify `bom=1` query parameter to include the BOM or `bom=0` to skip it. style: form @@ -305,10 +306,8 @@ post: description: | If `true` or `1` then, the endpoint applies the `fields=url,pageFunctionResult,errorInfo` - and `unwind=pageFunctionResult` query parameters. This feature is used to emulate simplified results provided by the - legacy Apify Crawler product and it's not recommended to use it in new integrations. style: form @@ -321,7 +320,6 @@ post: description: | If `true` or `1` then, the all the items with errorInfo property will be skipped from the output. - This feature is here to emulate functionality of API version 1 used for the legacy Apify Crawler product and it's not recommended to use it in new integrations. @@ -330,15 +328,6 @@ post: schema: type: boolean example: false - requestBody: - description: '' - content: - application/json: - schema: - type: object - example: - foo: bar - required: true responses: '201': description: '' @@ -378,22 +367,36 @@ post: application/json: schema: $ref: "../../components/schemas/common/ErrorResponse.yaml" + '408': + description: 'Request Timeout: the HTTP request exceeded the 300 second limit' + headers: {} + content: + application/json: + schema: + $ref: "../../components/schemas/common/ErrorResponse.yaml" deprecated: false x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-post - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-post - - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_post -get: + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-get + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-get + - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_get +post: tags: - Actor tasks - summary: Run task synchronously and get dataset items (GET) + summary: Run task synchronously and get dataset items description: | - Run a specific task and return its dataset items. + Runs an Actor task and synchronously returns its dataset items. The run must finish in 300 seconds otherwise the HTTP request fails with a timeout error (this won't abort the run itself). + Optionally, you can override the Actor input configuration by passing a JSON + object as the POST payload and setting the `Content-Type: application/json` HTTP header. + + Note that if the object in the POST payload does not define a particular + input property, the Actor run uses the default value defined by the task (or the Actor's + input schema if not defined by the task). + You can send all the same options in parameters as the [Get Dataset Items](#/reference/datasets/item-collection/get-items) API endpoint. @@ -404,10 +407,15 @@ get: If the connection breaks, you will not receive any information about the run and its status. - To run the Task asynchronously, use the [Run task - asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint - instead. - operationId: actorTask_runSyncGetDatasetItems_get + Input fields from Actor task configuration can be overloaded with values + passed as the POST payload. + + Just make sure to specify the `Content-Type` header as `application/json` + and that the input is an object. + + To run the task asynchronously, use the [Run + task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead. + operationId: actorTask_runSyncGetDatasetItems_post parameters: - name: actorTaskId in: path @@ -470,10 +478,8 @@ get: description: | Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see - [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). style: form @@ -496,12 +502,9 @@ get: description: | If `true` or `1` then the API endpoint returns only non-empty items and skips hidden fields - (i.e. fields starting with the # character). - The `clean` parameter is just a shortcut for `skipHidden=true` and `skipEmpty=true` parameters. - Note that since some objects might be skipped from the output, that the result might contain less items than the `limit` value. style: form @@ -533,12 +536,9 @@ get: in: query description: | A comma-separated list of fields which should be picked from the items, - only these fields will remain in the resulting record objects. - Note that the fields in the outputted items are sorted the same way as they are specified in the `fields` query parameter. - You can use this feature to effectively fix the output format. style: form explode: true @@ -558,18 +558,13 @@ get: description: | A comma-separated list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. - If the field is an array then every element of - the array will become a separate record and merged with parent object. - If the unwound field is an object then it is merged with the parent object - If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object then the item gets preserved as it is. - Note that the unwound items ignore the `desc` parameter. style: form explode: true @@ -581,10 +576,8 @@ get: description: | A comma-separated list of fields which should transform nested objects into flat structures. - For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}` is turned into `{"foo.bar": "hello"}`. - The original object with properties is replaced with the flattened object. style: form @@ -629,10 +622,8 @@ get: description: | All text responses are encoded in UTF-8 encoding. By default, the `format=csv` files are prefixed with - the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html` and `rss` files are not. - If you want to override this default behavior, specify `bom=1` query parameter to include the BOM or `bom=0` to skip it. style: form @@ -695,8 +686,10 @@ get: description: | If `true` or `1` then, the endpoint applies the `fields=url,pageFunctionResult,errorInfo` + and `unwind=pageFunctionResult` query parameters. This feature is used to emulate simplified results provided by the + legacy Apify Crawler product and it's not recommended to use it in new integrations. style: form @@ -709,6 +702,7 @@ get: description: | If `true` or `1` then, the all the items with errorInfo property will be skipped from the output. + This feature is here to emulate functionality of API version 1 used for the legacy Apify Crawler product and it's not recommended to use it in new integrations. @@ -717,6 +711,15 @@ get: schema: type: boolean example: false + requestBody: + description: '' + content: + application/json: + schema: + type: object + example: + foo: bar + required: true responses: '201': description: '' @@ -756,15 +759,8 @@ get: application/json: schema: $ref: "../../components/schemas/common/ErrorResponse.yaml" - '408': - description: 'Request Timeout: the HTTP request exceeded the 300 second limit' - headers: {} - content: - application/json: - schema: - $ref: "../../components/schemas/common/ErrorResponse.yaml" deprecated: false x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-get - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-get - - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_get + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-post + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-post + - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_post diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml index f6f1ce168..83551144e 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml @@ -1,21 +1,14 @@ -post: +get: tags: - Actor tasks - summary: Run task synchronously (POST) + summary: Run task synchronously description: | - Runs an Actor task and synchronously returns its output. + Run a specific task and return its output. The run must finish in 300 seconds otherwise the HTTP request fails with a timeout error (this won't abort the run itself). - Optionally, you can override the Actor input configuration by passing a JSON - object as the POST payload and setting the `Content-Type: application/json` HTTP header. - - Note that if the object in the POST payload does not define a particular - input property, the Actor run uses the default value defined by the task (or Actor's input - schema if not defined by the task). - Beware that it might be impossible to maintain an idle HTTP connection for an extended period, due to client timeout or network conditions. Make sure your HTTP client is configured to have a long enough connection timeout. @@ -23,15 +16,10 @@ post: If the connection breaks, you will not receive any information about the run and its status. - Input fields from Actor task configuration can be overloaded with values - passed as the POST payload. - - Just make sure to specify `Content-Type` header to be `application/json` and - input to be an object. - - To run the task asynchronously, use the [Run - task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead. - operationId: actorTask_runSync_post + To run the Task asynchronously, use the + [Run task asynchronously](#/reference/actor-tasks/run-collection/run-task) + endpoint instead. + operationId: actorTask_runSync_get parameters: - name: actorTaskId in: path @@ -104,26 +92,14 @@ post: description: | Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see - - [Webhooks - documentation](https://docs.apify.com/platform/integrations/webhooks). + [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). style: form explode: true schema: type: string example: dGhpcyBpcyBqdXN0IGV4YW1wbGUK... - requestBody: - description: '' - content: - application/json: - schema: - type: object - example: - foo: bar - required: true responses: '201': description: '' @@ -141,22 +117,36 @@ post: application/json: schema: $ref: "../../components/schemas/common/ErrorResponse.yaml" + '408': + description: 'Request Timeout: the HTTP request exceeded the 300 second limit' + headers: {} + content: + application/json: + schema: + $ref: "../../components/schemas/common/ErrorResponse.yaml" deprecated: false x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously/run-task-synchronously-post - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-post - - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_post -get: + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously/run-task-synchronously-get + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-get + - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_get +post: tags: - Actor tasks - summary: Run task synchronously (GET) + summary: Run task synchronously description: | - Run a specific task and return its output. + Runs an Actor task and synchronously returns its output. The run must finish in 300 seconds otherwise the HTTP request fails with a timeout error (this won't abort the run itself). + Optionally, you can override the Actor input configuration by passing a JSON + object as the POST payload and setting the `Content-Type: application/json` HTTP header. + + Note that if the object in the POST payload does not define a particular + input property, the Actor run uses the default value defined by the task (or Actor's input + schema if not defined by the task). + Beware that it might be impossible to maintain an idle HTTP connection for an extended period, due to client timeout or network conditions. Make sure your HTTP client is configured to have a long enough connection timeout. @@ -164,10 +154,15 @@ get: If the connection breaks, you will not receive any information about the run and its status. - To run the Task asynchronously, use the - [Run task asynchronously](#/reference/actor-tasks/run-collection/run-task) - endpoint instead. - operationId: actorTask_runSync_get + Input fields from Actor task configuration can be overloaded with values + passed as the POST payload. + + Just make sure to specify `Content-Type` header to be `application/json` and + input to be an object. + + To run the task asynchronously, use the [Run + task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead. + operationId: actorTask_runSync_post parameters: - name: actorTaskId in: path @@ -240,14 +235,26 @@ get: description: | Specifies optional webhooks associated with the Actor run, which can be used to receive a notification + e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see - [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). + + [Webhooks + documentation](https://docs.apify.com/platform/integrations/webhooks). style: form explode: true schema: type: string example: dGhpcyBpcyBqdXN0IGV4YW1wbGUK... + requestBody: + description: '' + content: + application/json: + schema: + type: object + example: + foo: bar + required: true responses: '201': description: '' @@ -265,15 +272,8 @@ get: application/json: schema: $ref: "../../components/schemas/common/ErrorResponse.yaml" - '408': - description: 'Request Timeout: the HTTP request exceeded the 300 second limit' - headers: {} - content: - application/json: - schema: - $ref: "../../components/schemas/common/ErrorResponse.yaml" deprecated: false x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously/run-task-synchronously-get - - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-get - - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_get + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously/run-task-synchronously-post + - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-post + - https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_post diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml index 2066c566f..af8bc3eac 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi.json.yaml @@ -14,7 +14,11 @@ get: To fetch the default Actor build, simply pass `default` as the `buildId`. Authentication is based on the build's unique ID. No authentication token is required. - **Note**: You can also use the `/api/v2/actor-build-openapi-json-get` endpoint to get the OpenAPI definition for a build. + :::note + + You can also use the [`/api/v2/actor-build-openapi-json-get`](/api/v2/actor-build-openapi-json-get) endpoint to get the OpenAPI definition for a build. + + ::: operationId: act_openapi_json_get security: - apiKeyActorBuilds: [] diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml index 5e24886d3..314b2a56a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -3,52 +3,7 @@ get: - Actors/Actor versions summary: Get version description: | - The **Version object** contains the source code of a specific version of an - Actor. - - The `sourceType` property indicates where the source code is hosted, and - based on its value the Version object has the following additional property: - - - - - - - - - - - - - - - - - - -
"SOURCE_FILES" - Source code is comprised of multiple files specified in the sourceFiles array. - Each item of the array is an object with the following fields:
-
    -
  • name
    • - File path and name
    -
  • format
    • - Format of the content, can be either "TEXT" or "BASE64"
    -
  • content
    • - File content
    -
-
- Source files can be shown and edited in the Apify Console's Web IDE. -
"GIT_REPO" - Source code is cloned from a Git repository, whose URL is specified in the gitRepoUrl field. -
"TARBALL" - Source code is downloaded using a tarball or Zip file from a URL specified in the tarballUrl field. -
"GITHUB_GIST" - Source code is taken from a GitHub Gist, whose URL is specified in the gitHubGistUrl field. -
- - For more information about source code and Actor versions, see [Source - code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) - in Actors documentation. Gets a [Version - object](#/reference/actors/version-object) that contains all the details - about a specific version of an Actor. + Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor. operationId: act_version_get parameters: - name: actorId @@ -88,49 +43,7 @@ put: - Actors/Actor versions summary: Update version description: | - The **Version object** contains the source code of a specific version of an - Actor. The `sourceType` property indicates where the source code is hosted, and - based on its value the Version object has the following additional property: - - - - - - - - - - - - - - - - - - -
"SOURCE_FILES" - Source code is comprised of multiple files specified in the sourceFiles array. - Each item of the array is an object with the following fields:
-
    -
  • name
    • - File path and name
    -
  • format
    • - Format of the content, can be either "TEXT" or "BASE64"
    -
  • content
    • - File content
    -
-
- Source files can be shown and edited in the Apify Console's Web IDE. -
"GIT_REPO" - Source code is cloned from a Git repository, whose URL is specified in the gitRepoUrl field. -
"TARBALL" - Source code is downloaded using a tarball or Zip file from a URL specified in the tarballUrl field. -
"GITHUB_GIST" - Source code is taken from a GitHub Gist, whose URL is specified in the gitHubGistUrl field. -
- - For more information about source code and Actor versions, see [Source - code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) - in Actors documentation. Updates Actor version using values specified by a - [Version object](#/reference/actors/version-object) passed as JSON in the POST payload. + Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload. If the object does not define a specific property, its value will not be updated. @@ -203,48 +116,7 @@ delete: - Actors/Actor versions summary: Delete version description: | - The **Version object** contains the source code of a specific version of an Actor. - The `sourceType` property indicates where the source code is hosted, and based - on its value the Version object has the following additional property: - - - - - - - - - - - - - - - - - - -
"SOURCE_FILES" - Source code is comprised of multiple files specified in the sourceFiles array. - Each item of the array is an object with the following fields:
-
    -
  • name
    • - File path and name
    -
  • format
    • - Format of the content, can be either "TEXT" or "BASE64"
    -
  • content
    • - File content
    -
-
- Source files can be shown and edited in the Apify Console's Web IDE. -
"GIT_REPO" - Source code is cloned from a Git repository, whose URL is specified in the gitRepoUrl field. -
"TARBALL" - Source code is downloaded using a tarball or Zip file from a URL specified in the tarballUrl field. -
"GITHUB_GIST" - Source code is taken from a GitHub Gist, whose URL is specified in the gitHubGistUrl field. -
- - For more information about source code and Actor versions, see [Source - code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) - in Actors documentation. Deletes a specific version of Actor's source code. + Deletes a specific version of Actor's source code. operationId: act_version_delete parameters: - name: actorId diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml index c4bed5bfd..b31df4b3a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}@env-vars.yaml @@ -4,8 +4,7 @@ get: summary: Get list of environment variables description: | Gets the list of environment variables for a specific version of an Actor. - The response is a JSON object with the list of [EnvVar objects](#/reference/actors/environment-variable-object), where - each contains basic information about a single environment variable. + The response is a JSON object with the list of [EnvVar objects](#/reference/actors/environment-variable-object), where each contains basic information about a single environment variable. operationId: act_version_envVars_get parameters: - name: actorId diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index 2892ef254..6f161e4e2 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -3,8 +3,11 @@ get: - Storage/Datasets summary: Get list of datasets description: | - Lists all of a user's datasets. The response is a JSON array of objects, + Lists all of a user's datasets. + + The response is a JSON array of objects, where each object contains basic information about one dataset. + By default, the objects are sorted by the `createdAt` field in ascending order, therefore you can use pagination to incrementally fetch all datasets while new ones are still being created. To sort them in descending order, use `desc=1` diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml index 6ab21ba44..8d46b60f7 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml @@ -5,7 +5,12 @@ get: description: | Returns dataset object for given dataset ID. - **NOTE:** Keep in mind that attributes `itemCount` and `cleanItemCount` are not propagated right away after data are pushed into a dataset. + :::note + + Keep in mind that attributes `itemCount` and `cleanItemCount` are not propagated right away after data are pushed into a dataset. + + ::: + There is a short period (up to 5 seconds) during which these counters may not match with exact counts in dataset items. operationId: dataset_get parameters: diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml index 756272082..fa55f4286 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}@statistics.yaml @@ -4,7 +4,8 @@ get: summary: Get dataset statistics description: | Returns statistics for given dataset. - Currently provides only [field statistics](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics). + + Provides only [field statistics](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics). operationId: dataset_statistics_get parameters: diff --git a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml index 003a2e032..528cf2c35 100644 --- a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml +++ b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml @@ -6,7 +6,8 @@ get: - https://docs.apify.com/api/v2#/reference/logs/log/get-log - https://docs.apify.com/api/v2#/reference/logs/get-log - https://docs.apify.com/api/v2#tag/LogsLog/operation/log_get - description: '' + description: | + Retrieves logs for a specific Actor build or run. operationId: log_get parameters: - name: buildOrRunId diff --git a/nginx.conf b/nginx.conf index 287606acd..b99bb3c7d 100644 --- a/nginx.conf +++ b/nginx.conf @@ -307,6 +307,84 @@ server { rewrite ^/platform/integrations/chatgpt-plugin$ https://blog.apify.com/add-custom-actions-to-your-gpts/ redirect; } + # API docs reorganization + + # Actor Collection & Object to Actors + rewrite ^/api/v2/actors-actor-collection$ /api/v2/actors permanent; + rewrite ^/api/v2/actors-actor-object$ /api/v2/actors permanent; + + # Actor Version Collection & Object to Actors Actor Versions + rewrite ^/api/v2/actors-version-collection$ /api/v2/actors-actor-versions permanent; + rewrite ^/api/v2/actors-version-object$ /api/v2/actors-actor-versions permanent; + + # Actor Environment Variable Collection & Object to Actors Actor Versions + rewrite ^/api/v2/actors-environment-variable-collection$ /api/v2/actors-actor-versions permanent; + rewrite ^/api/v2/actors-environment-variable-object$ /api/v2/actors-actor-versions permanent; + + # Actor Build Collection, Object, Default Build, and Abort Build to Actors Actor Builds + rewrite ^/api/v2/actors-build-collection$ /api/v2/actors-actor-builds permanent; + rewrite ^/api/v2/actors-build-object$ /api/v2/actors-actor-builds permanent; + rewrite ^/api/v2/actors-default-build-object$ /api/v2/actors-actor-builds permanent; + rewrite ^/api/v2/actors-abort-build$ /api/v2/actors-actor-builds permanent; + + # Actor Run Collection, Object, Synchronous Runs, and Related Actions to Actors Actor Runs + rewrite ^/api/v2/actors-run-collection$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-run-object$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-run-actor-synchronously$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-run-actor-synchronously-and-get-dataset-items$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-abort-run$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-metamorph-run$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-resurrect-run$ /api/v2/actors-actor-runs permanent; + rewrite ^/api/v2/actors-last-run-object-and-its-storages$ /api/v2/actors-actor-runs permanent; + + # Actor Tasks Task Collection, Object, Input Object, Webhook, Run Collection, and Synchronous Actions to Actor Tasks + rewrite ^/api/v2/actor-tasks-task-collection$ /api/v2/actor-tasks permanent; + rewrite ^/api/v2/actor-tasks-task-object$ /api/v2/actor-tasks permanent; + rewrite ^/api/v2/actor-tasks-task-input-object$ /api/v2/actor-tasks permanent; + rewrite ^/api/v2/actor-tasks-webhook-collection$ /api/v2/actor-tasks permanent; + rewrite ^/api/v2/actor-tasks-run-collection$ /api/v2/actor-tasks permanent; + rewrite ^/api/v2/actor-tasks-run-task-synchronously$ /api/v2/actor-tasks permanent; + rewrite ^/api/v2/actor-tasks-run-task-synchronously-and-get-dataset-items$ /api/v2/actor-tasks permanent; + + # Datasets Dataset Collection, Dataset, Item Collection, and Statistics to Storage Datasets + rewrite ^/api/v2/datasets-dataset-collection$ /api/v2/storage-datasets permanent; + rewrite ^/api/v2/datasets-dataset$ /api/v2/storage-datasets permanent; + rewrite ^/api/v2/datasets-item-collection$ /api/v2/storage-datasets permanent; + rewrite ^/api/v2/datasets-statistics$ /api/v2/storage-datasets permanent; + + # Key-Value Stores Store Collection, Store Object, Key Collection, and Record to Storage Key-Value Stores + rewrite ^/api/v2/key-value-stores-store-collection$ /api/v2/storage-key-value-stores permanent; + rewrite ^/api/v2/key-value-stores-store-object$ /api/v2/storage-key-value-stores permanent; + rewrite ^/api/v2/key-value-stores-key-collection$ /api/v2/storage-key-value-stores permanent; + rewrite ^/api/v2/key-value-stores-record$ /api/v2/storage-key-value-stores permanent; + + # Webhooks Webhook Collection, Webhook Object, Webhook Test, and Dispatches Collection to Webhooks Webhooks + rewrite ^/api/v2/webhooks-webhook-collection$ /api/v2/webhooks-webhooks permanent; + rewrite ^/api/v2/webhooks-webhook-object$ /api/v2/webhooks-webhooks permanent; + rewrite ^/api/v2/webhooks-webhook-test$ /api/v2/webhooks-webhooks permanent; + rewrite ^/api/v2/webhooks-dispatches-collection$ /api/v2/webhooks-webhooks permanent; + + # Webhook Dispatches Collection and Dispatch Object to Webhooks Webhook Dispatches + rewrite ^/api/v2/webhook-dispatches-webhook-dispatches-collection$ /api/v2/webhooks-webhook-dispatches permanent; + rewrite ^/api/v2/webhook-dispatches-webhook-dispatch-object$ /api/v2/webhooks-webhook-dispatches permanent; + + # Schedules Collection, Schedule Object, and Schedule Log to Schedules + rewrite ^/api/v2/schedules-schedules-collection$ /api/v2/schedules permanent; + rewrite ^/api/v2/schedules-schedule-object$ /api/v2/schedules permanent; + rewrite ^/api/v2/schedules-schedule-log$ /api/v2/schedules permanent; + + # Store Store Actors Collection to Store + rewrite ^/api/v2/store-store-actors-collection$ /api/v2/store permanent; + + # Logs Log to Logs + rewrite ^/api/v2/logs-log$ /api/v2/logs permanent; + + # Users Public Data, Private Data, Monthly Usage, and Account and Usage Limits to Users + rewrite ^/api/v2/users-public-data$ /api/v2/users permanent; + rewrite ^/api/v2/users-private-data$ /api/v2/users permanent; + rewrite ^/api/v2/users-monthly-usage$ /api/v2/users permanent; + rewrite ^/api/v2/users-account-and-usage-limits$ /api/v2/users permanent; + # Temporarily used to route crawlee.dev to the Crawlee GitHub pages. # TODO: create a separate nginx deployment for Crawlee and move this there. server { From 20eba7e202c62a3183e3ead7134f81a9203f7e36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 21:24:37 +0100 Subject: [PATCH 10/11] add introduction to name of introductory page --- apify-api/openapi/components/tags.yaml | 92 +++++--------------------- 1 file changed, 16 insertions(+), 76 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index 79f104766..b4595b421 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -15,7 +15,7 @@ - A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`). - name: Actors/Actor versions - x-displayName: Actor versions + x-displayName: Actor versions - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/version-collection' @@ -44,7 +44,7 @@ For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) in Actors documentation. - name: Actors/Actor builds - x-displayName: Actor builds + x-displayName: Actor builds - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/build-collection' @@ -56,7 +56,7 @@ description: | The API endpoints in this section allow you to manage your Apify Actors builds. - name: Actors/Actor runs - x-displayName: Actor runs + x-displayName: Actor runs - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/run-collection' @@ -70,6 +70,8 @@ - '#tag/ActorsRun-actor-synchronously' - '#/reference/actors/run-actor-synchronously-and-get-dataset-items' - '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items' + - '#/reference/actors/last-run-object-and-its-storages' + - '#tag/ActorsLast-run-object-and-its-storages' description: | The API endpoints in this section allow you to manage your Apify Actors runs. @@ -78,7 +80,7 @@ For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). x-trait: 'true' - name: Actors/Webhook collection - x-displayName: Webhook collection + x-displayName: Webhook collection - Introduction x-parent-tag-name: Actors x-legacy-doc-urls: - '#/reference/actors/webhook-collection' @@ -86,68 +88,6 @@ description: | The API endpoint in this section allows you to get a list of webhooks of a specific Actor. x-trait: 'true' -- name: Actors/Last run object and its storages - x-displayName: Last run object and its storages - x-parent-tag-name: Actors - x-legacy-doc-urls: - - '#/reference/actors/last-run-object-and-its-storages' - - '#tag/ActorsLast-run-object-and-its-storages' - x-trait: 'true' - description: | - This is not a single endpoint, but an entire group of endpoints that lets you to - retrieve and manage the last run of given Actor or any of its default storages. - All the endpoints require an authentication token. - - The endpoints accept the same HTTP methods and query parameters as - the respective storage endpoints. - The base path represents the last Actor run object is: - - `/v2/acts/{actorId}/runs/last{?token,status}` - - Using the `status` query parameter you can ensure to only get a run with a certain status - (e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters - are the same as in the [Run object](#/reference/actors/run-object) endpoint. - - In order to access the default storages of the last Actor run, i.e. log, key-value - store, dataset and request queue, use the following endpoints: - - * `/v2/acts/{actorId}/runs/last/log{?token,status}` - * `/v2/acts/{actorId}/runs/last/key-value-store{?token,status}` - * `/v2/acts/{actorId}/runs/last/dataset{?token,status}` - * `/v2/acts/{actorId}/runs/last/request-queue{?token,status}` - - These API endpoints have the same usage as the equivalent storage endpoints. - For example, `/v2/acts/{actorId}/runs/last/key-value-store` has the same HTTP method and parameters - as the [Key-value store object](#/reference/key-value-stores/store-object) endpoint. - - Additionally, each of the above API endpoints supports all sub-endpoints - of the original one: - - #### Key-value store - - * `/v2/acts/{actorId}/runs/last/key-value-store/keys{?token,status}` [Key collection](#/reference/key-value-stores/key-collection) - * `/v2/acts/{actorId}/runs/last/key-value-store/records/{recordKey}{?token,status}` [Record](#/reference/key-value-stores/record) - - #### Dataset - - * `/v2/acts/{actorId}/runs/last/dataset/items{?token,status}` [Item collection](#/reference/datasets/item-collection) - - #### Request queue - - * `/v2/acts/{actorId}/runs/last/request-queue/requests{?token,status}` [Request - collection](#/reference/request-queues/request-collection) - * `/v2/acts/{actorId}/runs/last/request-queue/requests/{requestId}{?token,status}` - [Request collection](#/reference/request-queues/request) - * `/v2/acts/{actorId}/runs/last/request-queue/head{?token,status}` [Queue head](#/reference/request-queues/queue-head) - - For example, to download data from a dataset of the last succeeded Actor run in XML format, - send HTTP GET request to the following URL: - - ``` - https://api.apify.com/v2/acts/{actorId}/runs/last/dataset/items?token={yourApiToken}&format=xml&status=SUCCEEDED - ``` - - In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. - name: Actor builds x-displayName: Actor builds - Introduction x-legacy-doc-urls: @@ -186,7 +126,7 @@ You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). - name: Actor tasks - x-displayName: Actor tasks + x-displayName: Actor tasks - Introduction x-legacy-doc-urls: - '#/reference/actor-tasks' - '#tag/Actor-tasks' @@ -227,7 +167,7 @@ - name: Storage x-displayName: - name: Storage/Datasets - x-displayName: Datasets + x-displayName: Datasets - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - '#/reference/datasets' @@ -257,7 +197,7 @@ ::: x-trait: 'true' - name: Storage/Key-value stores - x-displayName: Key-value stores + x-displayName: Key-value stores - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - '#/reference/key-value-stores/key-collection' @@ -287,7 +227,7 @@ ::: x-trait: 'true' - name: Storage/Request queues - x-displayName: Request queues + x-displayName: Request queues - Introduction x-parent-tag-name: Storage x-legacy-doc-urls: - '#/reference/request-queues' @@ -327,7 +267,7 @@ - name: Webhooks x-displayName: - name: Webhooks/Webhooks - x-displayName: Webhooks + x-displayName: Webhooks - Introduction x-parent-tag-name: Webhooks x-legacy-doc-urls: - '#/reference/webhooks' @@ -351,7 +291,7 @@ For more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). - name: Webhooks/Webhook dispatches - x-displayName: Webhook dispatches + x-displayName: Webhook dispatches - Introduction x-parent-tag-name: Webhooks x-legacy-doc-urls: - '#/reference/webhook-dispatches' @@ -362,7 +302,7 @@ - '#tag/Webhook-dispatchesWebhook-dispatch-object' description: This section describes API endpoints to get webhook dispatches. - name: Schedules - x-displayName: Schedules + x-displayName: Schedules - Introduction x-legacy-doc-urls: - '#/reference/schedules' - '#tag/Schedules' @@ -388,7 +328,7 @@ For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. x-trait: 'true' - name: Store - x-displayName: Store + x-displayName: Store - Introduction x-legacy-doc-urls: - '#/reference/store' - '#tag/Store' @@ -406,7 +346,7 @@ ::: x-trait: true - name: Logs - x-displayName: Logs + x-displayName: Logs - Introduction x-legacy-doc-urls: - '#/reference/logs' - '#tag/Logs' @@ -425,7 +365,7 @@ ::: x-trait: true - name: Users - x-displayName: Users + x-displayName: Users - Introduction x-legacy-doc-urls: - '#/reference/users' - '#tag/Users' From 11ded32b6946f1293d7cce13f05a754c0ca7fb0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Thu, 6 Feb 2025 22:11:28 +0100 Subject: [PATCH 11/11] split request queues into 3 sub categories split request queues into 3 sub-categories change descriptions for introductory pages to reflect new division reorganize sidebar further add missin request queues redirects to ngninx.conf --- apify-api/openapi/components/tags.yaml | 47 +++++++++++++++++-- .../openapi/components/x-tag-groups.yaml | 2 + apify-api/openapi/openapi.yaml | 8 ++-- .../datasets/datasets@{datasetId}@items.yaml | 2 +- ...-stores@{storeId}@records@{recordKey}.yaml | 2 +- .../request-queues@{queueId}@head.yaml | 2 +- .../request-queues@{queueId}@head@lock.yaml | 2 +- .../request-queues@{queueId}@requests.yaml | 4 +- ...queues@{queueId}@requests@{requestId}.yaml | 6 +-- ...s@{queueId}@requests@{requestId}@lock.yaml | 4 +- nginx.conf | 13 +++++ 11 files changed, 74 insertions(+), 18 deletions(-) diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index b4595b421..dd79b246a 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -236,20 +236,61 @@ - '#tag/Request-queuesQueue-collection' - '#/reference/request-queues/queue' - '#tag/Request-queuesQueue' + - '#/reference/request-queues/batch-request-operations' + - '#tag/Request-queuesBatch-request-operations' + description: | + This section describes API endpoints to create, manage, and delete request queues. + + Request queue is a storage for a queue of HTTP URLs to crawl, which is typically + used for deep crawling of websites where you + start with several URLs and then recursively follow links to other pages. + The storage supports both breadth-first and depth-first crawling orders. + + For more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue). + + :::note + + Some of the endpoints do not require the authentication token, the calls + are authenticated using the hard-to-guess ID of the queue. + + ::: +- name: Storage/Request queues/Requests + x-displayName: Requests- Introduction + x-parent-tag-name: Storage + x-legacy-doc-urls: - '#/reference/request-queues/request-collection' - '#tag/Request-queuesRequest-collection' - '#/reference/request-queues/request' - '#tag/Request-queuesRequest' + description: | + This section describes API endpoints to create, manage, and delete requests within request queues. + + Request queue is a storage for a queue of HTTP URLs to crawl, which is typically + used for deep crawling of websites where you + start with several URLs and then recursively follow links to other pages. + The storage supports both breadth-first and depth-first crawling orders. + + For more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue). + + :::note + + Some of the endpoints do not require the authentication token, the calls + are authenticated using the hard-to-guess ID of the queue. + + ::: +- name: Storage/Request queues/Requests locks + x-displayName: Requests locks - Introduction + x-parent-tag-name: Storage + x-legacy-doc-urls: + - '#/reference/request-queues/request-lock' - '#tag/Request-queuesRequest-lock' - '#/reference/request-queues/queue-head' - '#tag/Request-queuesQueue-head' - '#/reference/request-queues/queue-head-with-locks' - '#tag/Request-queuesQueue-head-with-locks' - - '#/reference/request-queues/batch-request-operations' - - '#tag/Request-queuesBatch-request-operations' description: | - This section describes API endpoints to create, manage, and delete request queues. + This section describes API endpoints to create, manage, and delete request locks within request queues. Request queue is a storage for a queue of HTTP URLs to crawl, which is typically used for deep crawling of websites where you diff --git a/apify-api/openapi/components/x-tag-groups.yaml b/apify-api/openapi/components/x-tag-groups.yaml index dd22e1570..d5e698d53 100644 --- a/apify-api/openapi/components/x-tag-groups.yaml +++ b/apify-api/openapi/components/x-tag-groups.yaml @@ -20,6 +20,8 @@ - Storage/Datasets - Storage/Key-value stores - Storage/Request queues + - Storage/Request queues/Requests + - Storage/Request queues/Requests locks - name: Webhooks tags: - Webhooks/Webhooks diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 8a8517e40..8875cab89 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -581,18 +581,18 @@ paths: $ref: paths/request-queues/request-queues.yaml '/v2/request-queues/{queueId}': $ref: 'paths/request-queues/request-queues@{queueId}.yaml' + '/v2/request-queues/{queueId}/requests/batch': + $ref: 'paths/request-queues/request-queues@{queueId}@requests@batch.yaml' '/v2/request-queues/{queueId}/requests': $ref: 'paths/request-queues/request-queues@{queueId}@requests.yaml' '/v2/request-queues/{queueId}/requests/{requestId}': $ref: 'paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml' - '/v2/request-queues/{queueId}/requests/{requestId}/lock': - $ref: 'paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml' '/v2/request-queues/{queueId}/head': $ref: 'paths/request-queues/request-queues@{queueId}@head.yaml' '/v2/request-queues/{queueId}/head/lock': $ref: 'paths/request-queues/request-queues@{queueId}@head@lock.yaml' - '/v2/request-queues/{queueId}/requests/batch': - $ref: 'paths/request-queues/request-queues@{queueId}@requests@batch.yaml' + '/v2/request-queues/{queueId}/requests/{requestId}/lock': + $ref: 'paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml' /v2/webhooks: $ref: paths/webhooks/webhooks.yaml '/v2/webhooks/{webhookId}': diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml index 31c4676a2..b59f05f39 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml @@ -433,7 +433,7 @@ get: post: tags: - Storage/Datasets - summary: Put items + summary: Store items description: | Appends an item or an array of items to the end of the dataset. The POST payload is a JSON object or a JSON array of objects to save into the dataset. diff --git a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml index 69750d881..f813cf0d9 100644 --- a/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml +++ b/apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml @@ -73,7 +73,7 @@ get: put: tags: - Storage/Key-value stores - summary: Put record + summary: Store record description: | Stores a value under a specific key to the key-value store. diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml index 388f53ead..81f901bb1 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml @@ -1,6 +1,6 @@ get: tags: - - Storage/Request queues + - Storage/Request queues/Requests locks summary: Get head description: | Returns given number of first requests from the queue. diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml index 508ea7dc8..632dd95b5 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml @@ -1,6 +1,6 @@ post: tags: - - Storage/Request queues + - Storage/Request queues/Requests locks summary: Get head and lock description: | Returns the given number of first requests from the queue and locks them for diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml index f9aa8c7e1..21f7f9782 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml @@ -1,6 +1,6 @@ get: tags: - - Storage/Request queues + - Storage/Request queues/Requests summary: List requests description: | Returns a list of requests. This endpoint is paginated using @@ -137,7 +137,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_requests post: tags: - - Storage/Request queues + - Storage/Request queues/Requests summary: Add request description: | Adds request to the queue. Response contains ID of the request and info if diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml index 7e4b5fe12..ab03a76b5 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Storage/Request queues + - Storage/Request queues/Requests summary: Get request description: Returns request from queue. operationId: requestQueue_request_get @@ -78,7 +78,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get put: tags: - - Storage/Request queues + - Storage/Request queues/Requests summary: Update request description: | Updates a request in a queue. Mark request as handled by setting @@ -197,7 +197,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update delete: tags: - - Storage/Request queues + - Storage/Request queues/Requests summary: Delete request description: Deletes given request from queue. operationId: requestQueue_request_delete diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml index 57a2095fa..900584359 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml @@ -1,6 +1,6 @@ put: tags: - - Storage/Request queues + - Storage/Request queues/Requests locks summary: Prolong request lock description: | Prolongs request lock. The request lock can be prolonged only by the client @@ -84,7 +84,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#prolong_request_lock delete: tags: - - Storage/Request queues + - Storage/Request queues/Requests locks summary: Delete request lock description: | Deletes a request lock. The request lock can be deleted only by the client diff --git a/nginx.conf b/nginx.conf index b99bb3c7d..2bd446741 100644 --- a/nginx.conf +++ b/nginx.conf @@ -358,6 +358,19 @@ server { rewrite ^/api/v2/key-value-stores-key-collection$ /api/v2/storage-key-value-stores permanent; rewrite ^/api/v2/key-value-stores-record$ /api/v2/storage-key-value-stores permanent; + # Request Queues Queue Collection, Queue, and Batch Request Operations to Storage Request Queues + rewrite ^/api/v2/request-queues-queue-collection$ /api/v2/storage-request-queues permanent; + rewrite ^/api/v2/request-queues-queue$ /api/v2/storage-request-queues permanent; + rewrite ^/api/v2/request-queues-batch-request-operations$ /api/v2/storage-request-queues permanent; + + # Request Queues Request Collection to Storage Request Queues Requests + rewrite ^/api/v2/request-queues-request-collection$ /api/v2/storage-request-queues-requests permanent; + + # Request Queues Queue Head, Queue Head With Locks, and Request Lock to Storage Request Queues Requests Locks + rewrite ^/api/v2/request-queues-queue-head$ /api/v2/storage-request-queues-requests-locks permanent; + rewrite ^/api/v2/request-queues-queue-head-with-locks$ /api/v2/storage-request-queues-requests-locks permanent; + rewrite ^/api/v2/request-queues-request-lock$ /api/v2/storage-request-queues-requests-locks permanent; + # Webhooks Webhook Collection, Webhook Object, Webhook Test, and Dispatches Collection to Webhooks Webhooks rewrite ^/api/v2/webhooks-webhook-collection$ /api/v2/webhooks-webhooks permanent; rewrite ^/api/v2/webhooks-webhook-object$ /api/v2/webhooks-webhooks permanent;