From 865d70d547c9446e7e57dce11cd2176bad23d5a0 Mon Sep 17 00:00:00 2001 From: Adam Kliment <79609+netmilk@users.noreply.github.com> Date: Tue, 7 Jan 2025 14:42:51 +0100 Subject: [PATCH] feat: add Redoc legacy urls and a script for traversing and safe dumping the yamls (#1372) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Martin Adámek --- apify-api/openapi/components/tags.yaml | 96 +++++++++++++++++++ .../paths/actor-builds/actor-builds.yaml | 1 + .../actor-builds/actor-builds@{buildId}.yaml | 2 + .../actor-builds@{buildId}@abort.yaml | 1 + .../actor-builds@{buildId}@log.yaml | 1 + .../openapi/paths/actor-runs/actor-runs.yaml | 1 + .../paths/actor-runs/actor-runs@{runId}.yaml | 3 + .../actor-runs/actor-runs@{runId}@abort.yaml | 1 + .../actor-runs/actor-runs@{runId}@charge.yaml | 21 ++-- .../actor-runs@{runId}@metamorph.yaml | 1 + .../actor-runs/actor-runs@{runId}@reboot.yaml | 1 + .../actor-runs@{runId}@resurrect.yaml | 1 + .../paths/actor-tasks/actor-tasks.yaml | 2 + .../actor-tasks@{actorTaskId}.yaml | 3 + .../actor-tasks@{actorTaskId}@input.yaml | 2 + ...torTaskId}@run-sync-get-dataset-items.yaml | 2 + .../actor-tasks@{actorTaskId}@run-sync.yaml | 2 + .../actor-tasks@{actorTaskId}@runs.yaml | 2 + .../actor-tasks@{actorTaskId}@webhooks.yaml | 1 + apify-api/openapi/paths/actors/acts.yaml | 2 + .../openapi/paths/actors/acts@{actorId}.yaml | 3 + .../paths/actors/acts@{actorId}@builds.yaml | 2 + .../acts@{actorId}@builds@{buildId}.yaml | 5 +- ...acts@{actorId}@builds@{buildId}@abort.yaml | 1 + ...@{actorId}@run-sync-get-dataset-items.yaml | 2 + .../paths/actors/acts@{actorId}@run-sync.yaml | 2 + .../paths/actors/acts@{actorId}@runs.yaml | 2 + .../actors/acts@{actorId}@runs@last.yaml | 1 + .../actors/acts@{actorId}@runs@{runId}.yaml | 1 + .../acts@{actorId}@runs@{runId}@abort.yaml | 1 + ...acts@{actorId}@runs@{runId}@metamorph.yaml | 1 + ...acts@{actorId}@runs@{runId}@resurrect.yaml | 1 + .../paths/actors/acts@{actorId}@versions.yaml | 2 + ...ts@{actorId}@versions@{versionNumber}.yaml | 3 + ...Id}@versions@{versionNumber}@env-vars.yaml | 2 + ...{versionNumber}@env-vars@{envVarName}.yaml | 3 + .../paths/actors/acts@{actorId}@webhooks.yaml | 1 + .../openapi/paths/datasets/datasets.yaml | 2 + .../paths/datasets/datasets@{datasetId}.yaml | 3 + .../datasets/datasets@{datasetId}@items.yaml | 42 ++++---- .../key-value-stores/key-value-stores.yaml | 2 + .../key-value-stores@{storeId}.yaml | 3 + .../key-value-stores@{storeId}@keys.yaml | 1 + ...-stores@{storeId}@records@{recordKey}.yaml | 3 + .../paths/logs/logs@{buildOrRunId}.yaml | 1 + .../paths/request-queues/request-queues.yaml | 2 + .../request-queues@{queueId}.yaml | 3 + .../request-queues@{queueId}@head.yaml | 1 + .../request-queues@{queueId}@head@lock.yaml | 1 + .../request-queues@{queueId}@requests.yaml | 2 + ...quest-queues@{queueId}@requests@batch.yaml | 2 + ...queues@{queueId}@requests@{requestId}.yaml | 3 + ...s@{queueId}@requests@{requestId}@lock.yaml | 18 ++-- .../openapi/paths/schedules/schedules.yaml | 2 + .../schedules/schedules@{scheduleId}.yaml | 3 + .../schedules/schedules@{scheduleId}@log.yaml | 1 + apify-api/openapi/paths/store/store.yaml | 1 + apify-api/openapi/paths/users/users@me.yaml | 1 + .../openapi/paths/users/users@me@limits.yaml | 2 + .../paths/users/users@me@usage@monthly.yaml | 1 + .../openapi/paths/users/users@{userId}.yaml | 1 + .../webhook-dispatches.yaml | 1 + .../webhook-dispatches@{dispatchId}.yaml | 1 + .../openapi/paths/webhooks/webhooks.yaml | 2 + .../paths/webhooks/webhooks@{webhookId}.yaml | 3 + .../webhooks@{webhookId}@dispatches.yaml | 1 + .../webhooks/webhooks@{webhookId}@test.yaml | 1 + .../add-redoc-legacy-urls-to-operations.py | 63 ++++++++++++ .../scripts/add-redoc-legacy-urls-to-tags.py | 44 +++++++++ apify-api/scripts/requirements.txt | 45 +++++++++ 70 files changed, 400 insertions(+), 41 deletions(-) create mode 100644 apify-api/scripts/add-redoc-legacy-urls-to-operations.py create mode 100644 apify-api/scripts/add-redoc-legacy-urls-to-tags.py create mode 100644 apify-api/scripts/requirements.txt diff --git a/apify-api/openapi/components/tags.yaml b/apify-api/openapi/components/tags.yaml index bd304ac97..3dbfe44b5 100644 --- a/apify-api/openapi/components/tags.yaml +++ b/apify-api/openapi/components/tags.yaml @@ -2,6 +2,7 @@ x-displayName: Actors x-legacy-doc-urls: - '#/reference/actors' + - '#tag/Actors' description: >- The API endpoints described in this section enable you to manage, build and run Apify actors. @@ -30,24 +31,28 @@ 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 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' x-trait: 'true' description: >- The **Version object** contains the source code of a specific version of an actor. @@ -105,30 +110,35 @@ 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 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).' @@ -138,29 +148,35 @@ 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-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: - '#/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).' @@ -170,23 +186,30 @@ 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 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 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 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 @@ -297,6 +320,7 @@ 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. @@ -325,48 +349,56 @@ 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 @@ -480,6 +512,7 @@ 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. @@ -496,12 +529,14 @@ 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 @@ -604,34 +639,49 @@ 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-legacy-doc-urls: - '#/reference/actor-builds' + - '#tag/Actor-builds' description: >- The API endpoints described in this section enable you to manage Apify actor builds. @@ -648,32 +698,40 @@ 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: 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. @@ -699,29 +757,34 @@ 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 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 x-legacy-doc-urls: - '#/reference/key-value-stores/record' + - '#tag/Key-value-storesRecord' x-trait: 'true' - name: Datasets x-displayName: Datasets x-legacy-doc-urls: - '#/reference/datasets' + - '#tag/Datasets' description: >- This section describes API endpoints to manage Datasets. @@ -749,18 +812,21 @@ 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 @@ -770,6 +836,7 @@ x-displayName: Request queues x-legacy-doc-urls: - '#/reference/request-queues' + - '#tag/Request-queues' description: >- This section describes API endpoints to manage request queues. @@ -792,53 +859,62 @@ x-parent-tag-name: Request queues x-legacy-doc-urls: - '#/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' - name: Webhooks x-displayName: Webhooks x-legacy-doc-urls: - '#/reference/webhooks' + - '#tag/Webhooks' description: >- This section describes API endpoints to manage webhooks. @@ -858,46 +934,54 @@ 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 x-displayName: Webhook dispatches 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' - name: Schedules x-displayName: Schedules x-legacy-doc-urls: - '#/reference/schedules' + - '#tag/Schedules' description: >- This section describes API endpoints for managing schedules. @@ -921,23 +1005,27 @@ x-parent-tag-name: 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' - name: Store x-displayName: Store x-legacy-doc-urls: - '#/reference/store' + - '#tag/Store' description: >- [Apify Store](https://apify.com/store) is home to hundreds of public Actors available to the Apify community. @@ -951,11 +1039,13 @@ x-parent-tag-name: Store x-legacy-doc-urls: - '#/reference/store/store-actors-collection' + - '#tag/StoreStore-Actors-collection' x-trait: 'true' - name: Logs x-displayName: Logs x-legacy-doc-urls: - '#/reference/logs' + - '#tag/Logs' description: >- The API endpoints described in this section are used the download the logs @@ -972,11 +1062,13 @@ x-parent-tag-name: Logs x-legacy-doc-urls: - '#/reference/logs/log' + - '#tag/LogsLog' 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 @@ -984,23 +1076,27 @@ 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' diff --git a/apify-api/openapi/paths/actor-builds/actor-builds.yaml b/apify-api/openapi/paths/actor-builds/actor-builds.yaml index 7fb27230a..fdd05a15f 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds.yaml @@ -5,6 +5,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list - https://docs.apify.com/api/v2#/reference/actor-builds/get-user-builds-list + - https://docs.apify.com/api/v2#tag/Actor-buildsBuild-collection/operation/actorBuilds_get description: | Gets a list of all builds for a user. The response is a JSON array of objects, where each object contains basic information about a single build. 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 0a8b1f648..144c03993 100644 --- a/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actor-builds/actor-builds@{buildId}.yaml @@ -54,6 +54,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build - https://docs.apify.com/api/v2#/reference/actor-builds/get-build + - https://docs.apify.com/api/v2#tag/Actor-buildsBuild-object/operation/actorBuild_get x-js-parent: BuildClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#get @@ -89,6 +90,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build - https://docs.apify.com/api/v2#/reference/actor-builds/delete-build + - https://docs.apify.com/api/v2#tag/Actor-builds/operation/actorBuild_delete x-js-parent: BuildClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#delete 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 3d8833eed..8097c4ff8 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 @@ -31,6 +31,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build - https://docs.apify.com/api/v2#/reference/actor-builds/abort-build + - https://docs.apify.com/api/v2#tag/Actor-buildsAbort-build/operation/actorBuild_abort_post x-js-parent: BuildClient x-js-name: abort x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildClient#abort 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 ff6573fd7..33956cb74 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 @@ -56,3 +56,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-builds/build-log/get-log - https://docs.apify.com/api/v2#/reference/actor-builds/get-log + - https://docs.apify.com/api/v2#tag/Actor-buildsBuild-log/operation/actorBuild_log_get diff --git a/apify-api/openapi/paths/actor-runs/actor-runs.yaml b/apify-api/openapi/paths/actor-runs/actor-runs.yaml index 620c22a45..6dd2e5879 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs.yaml @@ -108,3 +108,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list - https://docs.apify.com/api/v2#/reference/actor-runs/get-user-runs-list + - https://docs.apify.com/api/v2#tag/Actor-runsRun-collection/operation/actorRuns_get 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 faca05ad1..01a8ffeb2 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml @@ -183,6 +183,7 @@ get: x-legacy-doc-urls: - 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 @@ -209,6 +210,7 @@ delete: 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 @@ -335,3 +337,4 @@ put: x-legacy-doc-urls: - 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 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 53b969338..db165270f 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 @@ -111,6 +111,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run - https://docs.apify.com/api/v2#/reference/actor-runs/abort-run + - https://docs.apify.com/api/v2#tag/Actor-runsAbort-run/operation/actorRun_abort_post x-js-parent: RunClient x-js-name: abort x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#abort 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 30f383400..f65d60f75 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 @@ -25,15 +25,15 @@ post: example: 2024-12-09T01:23:45.000Z-random-uuid description: Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors. requestBody: - description: 'Define which event, and how many times, you want to charge for.' - content: - application/json: - schema: - $ref: "../../components/schemas/actor-runs/ChargeRunRequest.yaml" - example: - eventName: 'ANALYZE_PAGE' - eventCount: 1 - required: true + description: 'Define which event, and how many times, you want to charge for.' + content: + application/json: + schema: + $ref: "../../components/schemas/actor-runs/ChargeRunRequest.yaml" + example: + eventName: 'ANALYZE_PAGE' + eventCount: 1 + required: true responses: '201': description: 'The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually.' @@ -45,4 +45,5 @@ post: x-py-name: charge x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunClientAsync#charge x-legacy-doc-urls: - - https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run + - https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run + - https://docs.apify.com/api/v2#tag/Actor-runsCharge-events-in-run/operation/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 2c186b620..63920b008 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 @@ -139,6 +139,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run - https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run + - https://docs.apify.com/api/v2#tag/Actor-runsMetamorph-run/operation/actorRun_metamorph_post x-js-parent: RunClient x-js-name: metamorph x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#metamorph 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 4d265095c..66e1714d4 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 @@ -104,6 +104,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run - https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run + - https://docs.apify.com/api/v2#tag/Actor-runsReboot-run/operation/actorRun_reboot_post x-js-parent: RunClient x-js-name: reboot x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#reboot 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 8c199467a..321f82ecf 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 @@ -124,6 +124,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run - https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run + - https://docs.apify.com/api/v2#tag/Actor-runsResurrect-run/operation/PostResurrectRun x-js-parent: RunClient x-js-name: resurrect x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunClient#resurrect diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml index 8c76fef51..dcc7c37da 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks.yaml @@ -102,6 +102,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks - https://docs.apify.com/api/v2#/reference/actor-tasks/get-list-of-tasks + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-collection/operation/actorTasks_get x-js-parent: TaskCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskCollectionClient#list @@ -190,6 +191,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task - https://docs.apify.com/api/v2#/reference/actor-tasks/create-task + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-collection/operation/actorTasks_post x-js-parent: TaskCollectionClient x-js-name: create x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskCollectionClient#create 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 a6fb3e537..6002144bc 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}.yaml @@ -48,6 +48,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task - https://docs.apify.com/api/v2#/reference/actor-tasks/get-task + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-object/operation/actorTask_get x-js-parent: TaskClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskClient#get @@ -142,6 +143,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task - https://docs.apify.com/api/v2#/reference/actor-tasks/update-task + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-object/operation/actorTask_put x-js-parent: TaskClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskClient#update @@ -176,6 +178,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task - https://docs.apify.com/api/v2#/reference/actor-tasks/delete-task + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-object/operation/actorTask_delete x-js-parent: TaskClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskClient#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 3e95ed73d..6297221d8 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 @@ -29,6 +29,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input - https://docs.apify.com/api/v2#/reference/actor-tasks/get-task-input + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-input-object/operation/actorTask_input_get x-js-parent: TaskClient x-js-name: getInput x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskClient#getInput @@ -90,6 +91,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input - https://docs.apify.com/api/v2#/reference/actor-tasks/update-task-input + - https://docs.apify.com/api/v2#tag/Actor-tasksTask-input-object/operation/actorTask_input_put x-js-parent: TaskClient x-js-name: updateInput x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskClient#updateInput 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 a1a06a254..8a5034a5a 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 @@ -399,6 +399,7 @@ post: 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: tags: - Actor tasks/Run task synchronously and get dataset items @@ -786,3 +787,4 @@ get: 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 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 e9c3a957d..71574a4cd 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 @@ -145,6 +145,7 @@ post: 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: tags: - Actor tasks/Run task synchronously @@ -278,3 +279,4 @@ get: 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 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 b7ef14cfb..31ce63b8b 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 @@ -126,6 +126,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/get-list-of-task-runs - https://docs.apify.com/api/v2#/reference/actor-tasks/get-list-of-task-runs + - https://docs.apify.com/api/v2#tag/Actor-tasksRun-collection/operation/actorTask_runs_get post: tags: - Actor tasks/Run collection @@ -353,6 +354,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task - https://docs.apify.com/api/v2#/reference/actor-tasks/run-task + - https://docs.apify.com/api/v2#tag/Actor-tasksRun-collection/operation/actorTask_runs_post x-js-parent: TaskClient x-js-name: start x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/TaskClient#start 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 e6311fb2a..a065e7efb 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 @@ -133,3 +133,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actor-tasks/webhook-collection/get-list-of-webhooks - https://docs.apify.com/api/v2#/reference/actor-tasks/get-list-of-webhooks + - https://docs.apify.com/api/v2#tag/Actor-tasksWebhook-collection/operation/actorTask_webhooks_get diff --git a/apify-api/openapi/paths/actors/acts.yaml b/apify-api/openapi/paths/actors/acts.yaml index 12cc4c877..878c2509d 100644 --- a/apify-api/openapi/paths/actors/acts.yaml +++ b/apify-api/openapi/paths/actors/acts.yaml @@ -88,6 +88,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors - https://docs.apify.com/api/v2#/reference/actors/get-list-of-actors + - https://docs.apify.com/api/v2#tag/ActorsActor-collection/operation/acts_get x-js-parent: ActorCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorCollectionClient#list @@ -233,6 +234,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor - https://docs.apify.com/api/v2#/reference/actors/create-actor + - https://docs.apify.com/api/v2#tag/ActorsActor-collection/operation/acts_post x-js-parent: ActorCollectionClient x-js-name: create x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorCollectionClient#create diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 2e354d7a9..74f727546 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -85,6 +85,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor - https://docs.apify.com/api/v2#/reference/actors/get-actor + - https://docs.apify.com/api/v2#tag/ActorsActor-object/operation/act_get x-js-parent: ActorClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#get @@ -236,6 +237,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor - https://docs.apify.com/api/v2#/reference/actors/update-actor + - https://docs.apify.com/api/v2#tag/ActorsActor-object/operation/act_put x-js-parent: ActorClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#update @@ -271,6 +273,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor - https://docs.apify.com/api/v2#/reference/actors/delete-actor + - https://docs.apify.com/api/v2#tag/ActorsActor-object/operation/act_delete x-js-parent: ActorClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#delete diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index d97272844..ceafb55c4 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -67,6 +67,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds - https://docs.apify.com/api/v2#/reference/actors/get-list-of-builds + - https://docs.apify.com/api/v2#tag/ActorsBuild-collection/operation/act_builds_get x-js-parent: BuildCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/BuildCollectionClient#list @@ -192,6 +193,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor - https://docs.apify.com/api/v2#/reference/actors/build-actor + - https://docs.apify.com/api/v2#tag/ActorsBuild-collection/operation/act_builds_post x-js-parent: ActorClient x-js-name: build x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#build 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 7816b2b1a..894b4a3d5 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}.yaml @@ -85,9 +85,8 @@ get: readme: '# Magic Actor\nThis Actor is magic.' buildNumber: 0.1.1 deprecated: true - x-deprecated-description: 'API endpoints related to build of the Actor were moved - under new namespace [`actor-builds`](#/reference/actor-builds). Gets an object - that contains all the details about a specific build of an Actor.' + x-deprecated-description: 'API endpoints related to build of the Actor were moved under new namespace [`actor-builds`](#/reference/actor-builds). Gets an object that contains all the details about a specific build of an Actor.' x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/build-object/get-build - https://docs.apify.com/api/v2#/reference/actors/get-build + - https://docs.apify.com/api/v2#tag/ActorsBuild-object/operation/act_build_get 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 3c167b229..9bd337476 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 @@ -62,3 +62,4 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/abort-build/abort-build - https://docs.apify.com/api/v2#/reference/actors/abort-build + - https://docs.apify.com/api/v2#tag/ActorsAbort-build/operation/act_build_abort_post 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 8483fb093..411787838 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 @@ -425,6 +425,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-with-input-and-get-dataset-items - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-with-input-and-get-dataset-items + - 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 @@ -830,3 +831,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-without-input-and-get-dataset-items - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-without-input-and-get-dataset-items + - https://docs.apify.com/api/v2#tag/ActorsRun-Actor-synchronously-and-get-dataset-items/operation/act_runSyncGetDatasetItems_get 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 636d72c15..47fb777f6 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -161,6 +161,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/with-input - https://docs.apify.com/api/v2#/reference/actors/with-input + - https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_post get: tags: - Actors/Run actor synchronously @@ -308,3 +309,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/without-input - https://docs.apify.com/api/v2#/reference/actors/without-input + - https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_get diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index 1a1f27789..19f447389 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -116,6 +116,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs - https://docs.apify.com/api/v2#/reference/actors/get-list-of-runs + - https://docs.apify.com/api/v2#tag/ActorsRun-collection/operation/act_runs_get x-js-parent: RunCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RunCollectionClient#list @@ -332,6 +333,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor - https://docs.apify.com/api/v2#/reference/actors/run-actor + - https://docs.apify.com/api/v2#tag/ActorsRun-collection/operation/act_runs_post x-js-parent: ActorClient x-js-name: start x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ActorClient#start 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 83fa53ccc..696855b3a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@last.yaml @@ -157,3 +157,4 @@ get: deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages/get-last-run + - https://docs.apify.com/api/v2#tag/ActorsLast-run-object-and-its-storages/operation/act_runs_last_get 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 39becde8e..9649a777a 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}.yaml @@ -136,3 +136,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/run-object/get-run - https://docs.apify.com/api/v2#/reference/actors/get-run + - https://docs.apify.com/api/v2#tag/ActorsRun-object/operation/act_run_get 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 68590892b..2b64707d3 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 @@ -120,3 +120,4 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/abort-run/abort-run - https://docs.apify.com/api/v2#/reference/actors/abort-run + - https://docs.apify.com/api/v2#tag/ActorsAbort-run/operation/act_run_abort_post 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 85c78da43..92c39cd45 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 @@ -159,3 +159,4 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/metamorph-run/metamorph-run - https://docs.apify.com/api/v2#/reference/actors/metamorph-run + - https://docs.apify.com/api/v2#tag/ActorsMetamorph-run/operation/act_run_metamorph_post 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 0762e8ace..d5d373333 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 @@ -155,3 +155,4 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/resurrect-run/resurrect-run - https://docs.apify.com/api/v2#/reference/actors/resurrect-run + - https://docs.apify.com/api/v2#tag/ActorsResurrect-run/operation/act_run_resurrect_post diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml index 8ff89025d..1db0ff46c 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions.yaml @@ -56,6 +56,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions - https://docs.apify.com/api/v2#/reference/actors/get-list-of-versions + - https://docs.apify.com/api/v2#tag/ActorsVersion-collection/operation/act_versions_get x-py-parent: ActorVersionCollectionClientAsync x-py-name: list x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#list @@ -132,6 +133,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version - https://docs.apify.com/api/v2#/reference/actors/create-version + - https://docs.apify.com/api/v2#tag/ActorsVersion-collection/operation/act_versions_post x-py-parent: ActorVersionCollectionClientAsync x-py-name: create x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#create 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 ef40611c0..820c8b1b9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@versions@{versionNumber}.yaml @@ -79,6 +79,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/get-version - https://docs.apify.com/api/v2#/reference/actors/get-version + - https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_get x-py-parent: ActorVersionClientAsync x-py-name: get x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#get @@ -196,6 +197,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/update-version - https://docs.apify.com/api/v2#/reference/actors/update-version + - https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_put x-py-parent: ActorVersionClientAsync x-py-name: update x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#update @@ -284,3 +286,4 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/version-object/delete-version - https://docs.apify.com/api/v2#/reference/actors/delete-version + - https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_delete 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 84d14ec1a..e5680f5c5 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 @@ -36,6 +36,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables - https://docs.apify.com/api/v2#/reference/actors/get-list-of-environment-variables + - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-collection/operation/act_version_envVars_get x-py-parent: ActorEnvVarCollectionClientAsync x-py-name: list x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#list @@ -116,6 +117,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable - https://docs.apify.com/api/v2#/reference/actors/create-environment-variable + - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-collection/operation/act_version_envVars_post x-py-parent: ActorEnvVarCollectionClientAsync x-py-name: create x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#create 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 8afe065f4..f53d1f480 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 @@ -50,6 +50,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable - https://docs.apify.com/api/v2#/reference/actors/get-environment-variable + - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_get x-py-parent: ActorEnvVarClientAsync x-py-name: get x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#get @@ -136,6 +137,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable - https://docs.apify.com/api/v2#/reference/actors/update-environment-variable + - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put x-py-parent: ActorEnvVarClientAsync x-py-name: update x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update @@ -184,3 +186,4 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable - https://docs.apify.com/api/v2#/reference/actors/delete-environment-variable + - https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_delete diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml index 0c63bcb66..e88f55574 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@webhooks.yaml @@ -65,3 +65,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/actors/webhook-collection/get-list-of-webhooks - https://docs.apify.com/api/v2#/reference/actors/get-list-of-webhooks + - https://docs.apify.com/api/v2#tag/ActorsWebhook-collection/operation/act_webhooks_get diff --git a/apify-api/openapi/paths/datasets/datasets.yaml b/apify-api/openapi/paths/datasets/datasets.yaml index b9f734fe5..7ef4a5c76 100644 --- a/apify-api/openapi/paths/datasets/datasets.yaml +++ b/apify-api/openapi/paths/datasets/datasets.yaml @@ -91,6 +91,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets - https://docs.apify.com/api/v2#/reference/datasets/get-list-of-datasets + - https://docs.apify.com/api/v2#tag/DatasetsDataset-collection/operation/datasets_get x-js-parent: DatasetCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetCollectionClient#list @@ -149,6 +150,7 @@ post: - https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset - https://docs.apify.com/api/v2#/reference/datasets/create-dataset + - https://docs.apify.com/api/v2#tag/DatasetsDataset-collection/operation/datasets_post x-js-parent: DatasetCollectionClient x-js-name: getOrCreate x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetCollectionClient#getOrCreate diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml index 130c4b0e6..520455938 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}.yaml @@ -52,6 +52,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset - https://docs.apify.com/api/v2#/reference/datasets/get-dataset + - https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_get x-js-parent: DatasetClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#get @@ -109,6 +110,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset - https://docs.apify.com/api/v2#/reference/datasets/update-dataset + - https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_put x-js-parent: DatasetClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#update @@ -139,6 +141,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset - https://docs.apify.com/api/v2#/reference/datasets/delete-dataset + - https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_delete x-js-parent: DatasetClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#delete diff --git a/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml b/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml index 4cad700ad..dead3dffc 100644 --- a/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml +++ b/apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml @@ -462,6 +462,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items - https://docs.apify.com/api/v2#/reference/datasets/get-items + - https://docs.apify.com/api/v2#tag/DatasetsItem-collection/operation/dataset_items_get x-js-parent: DatasetClient x-js-name: listItems x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#listItems @@ -532,32 +533,33 @@ post: headers: {} content: application/json: - schema: - allOf: - - $ref: >- - ../../components/schemas/datasets/PutItemResponseError.yaml - - example: - error: - type: schema-validation-error - message: Schema validation failed - example: - error: + schema: + allOf: + - $ref: >- + ../../components/schemas/datasets/PutItemResponseError.yaml + - example: + error: type: schema-validation-error message: Schema validation failed - data: - invalidItems: - - itemPosition: 2 - validationErrors: - - instancePath: /1/stringField - schemaPath: /items/properties/stringField/type - keyword: type - params: - type: string - message: 'must be string' + example: + error: + type: schema-validation-error + message: Schema validation failed + data: + invalidItems: + - itemPosition: 2 + validationErrors: + - instancePath: /1/stringField + schemaPath: /items/properties/stringField/type + keyword: type + params: + type: string + message: 'must be string' deprecated: false x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items - https://docs.apify.com/api/v2#/reference/datasets/put-items + - https://docs.apify.com/api/v2#tag/DatasetsItem-collection/operation/dataset_items_post x-js-parent: DatasetClient x-js-name: pushItems x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/DatasetClient#pushItems 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 a3337a082..ca08b3c6d 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 @@ -71,6 +71,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores - https://docs.apify.com/api/v2#/reference/key-value-stores/get-list-of-key-value-stores + - https://docs.apify.com/api/v2#tag/Key-value-storesStore-collection/operation/keyValueStores_get x-js-parent: KeyValueStoreCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreCollectionClient#list @@ -130,6 +131,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store - https://docs.apify.com/api/v2#/reference/key-value-stores/create-key-value-store + - https://docs.apify.com/api/v2#tag/Key-value-storesStore-collection/operation/keyValueStores_post x-js-parent: KeyValueStoreCollectionClient x-js-name: getOrCreate x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreCollectionClient#getOrCreate 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 e1bbafc38..583f6c149 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 @@ -30,6 +30,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store - https://docs.apify.com/api/v2#/reference/key-value-stores/get-store + - https://docs.apify.com/api/v2#tag/Key-value-storesStore-object/operation/keyValueStore_get x-js-parent: KeyValueStoreClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#get @@ -77,6 +78,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store - https://docs.apify.com/api/v2#/reference/key-value-stores/update-store + - https://docs.apify.com/api/v2#tag/Key-value-storesStore-object/operation/keyValueStore_put x-js-parent: KeyValueStoreClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#update @@ -107,6 +109,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store - https://docs.apify.com/api/v2#/reference/key-value-stores/delete-store + - https://docs.apify.com/api/v2#tag/Key-value-storesStore-object/operation/keyValueStore_delete x-js-parent: KeyValueStoreClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#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 3ab98415d..c9a1e5808 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 @@ -62,6 +62,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys - https://docs.apify.com/api/v2#/reference/key-value-stores/get-list-of-keys + - https://docs.apify.com/api/v2#tag/Key-value-storesKey-collection/operation/keyValueStore_keys_get x-js-parent: KeyValueStoreClient x-js-name: listKeys x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#listKeys 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 dc77fd617..3741a4b3f 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 @@ -63,6 +63,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record - https://docs.apify.com/api/v2#/reference/key-value-stores/get-record + - https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_get x-js-parent: KeyValueStoreClient x-js-name: recordExists x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#recordExists @@ -147,6 +148,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record - https://docs.apify.com/api/v2#/reference/key-value-stores/put-record + - https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_put x-js-parent: KeyValueStoreClient x-js-name: setRecord x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#setRecord @@ -185,6 +187,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record - https://docs.apify.com/api/v2#/reference/key-value-stores/delete-record + - https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_delete x-js-parent: KeyValueStoreClient x-js-name: deleteRecord x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#deleteRecord diff --git a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml index f547ef535..697ca3519 100644 --- a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml +++ b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml @@ -5,6 +5,7 @@ get: x-legacy-doc-urls: - 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: '' operationId: log_get parameters: diff --git a/apify-api/openapi/paths/request-queues/request-queues.yaml b/apify-api/openapi/paths/request-queues/request-queues.yaml index ddfdfe516..39b274405 100644 --- a/apify-api/openapi/paths/request-queues/request-queues.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues.yaml @@ -76,6 +76,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues - https://docs.apify.com/api/v2#/reference/request-queues/get-list-of-request-queues + - https://docs.apify.com/api/v2#tag/Request-queuesQueue-collection/operation/requestQueues_get x-js-parent: RequestQueueCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueCollectionClient#list @@ -151,6 +152,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue - https://docs.apify.com/api/v2#/reference/request-queues/create-request-queue + - https://docs.apify.com/api/v2#tag/Request-queuesQueue-collection/operation/requestQueues_post x-js-parent: RequestQueueCollectionClient x-js-name: getOrCreate x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueCollectionClient#getOrCreate 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 0b9053a67..b6228d2aa 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}.yaml @@ -53,6 +53,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue - https://docs.apify.com/api/v2#/reference/request-queues/get-request-queue + - https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_get x-js-parent: RequestQueueClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#get @@ -132,6 +133,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue - https://docs.apify.com/api/v2#/reference/request-queues/update-request-queue + - https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_put x-js-parent: RequestQueueClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#update @@ -162,6 +164,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue - https://docs.apify.com/api/v2#/reference/request-queues/delete-request-queue + - https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_delete x-js-parent: RequestQueueClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#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 a46f01d73..0506a2300 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 @@ -103,6 +103,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head - https://docs.apify.com/api/v2#/reference/request-queues/get-head + - https://docs.apify.com/api/v2#tag/Request-queuesQueue-head/operation/requestQueue_head_get x-js-parent: RequestQueueClient x-js-name: listHead x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#listHead 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 e5ea3ccb8..97eff316b 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 @@ -115,6 +115,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock - https://docs.apify.com/api/v2#/reference/request-queues/get-head-and-lock + - https://docs.apify.com/api/v2#tag/Request-queuesQueue-head-with-locks/operation/requestQueue_head_lock_post x-js-parent: RequestQueueClient x-js-name: listAndLockHead x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#listAndLockHead 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 9a4ae84d9..ec4fe9211 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 @@ -129,6 +129,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests - https://docs.apify.com/api/v2#/reference/request-queues/list-requests + - https://docs.apify.com/api/v2#tag/Request-queuesRequest-collection/operation/requestQueue_requests_get x-js-parent: RequestQueueClient x-js-name: paginateRequests x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#paginateRequests @@ -221,6 +222,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request - https://docs.apify.com/api/v2#/reference/request-queues/add-request + - https://docs.apify.com/api/v2#tag/Request-queuesRequest-collection/operation/requestQueue_requests_post x-js-parent: RequestQueueClient x-js-name: addRequest x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#addRequest 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 1c6b11da9..3a62eb1f4 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 @@ -105,6 +105,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests - https://docs.apify.com/api/v2#/reference/request-queues/add-requests + - https://docs.apify.com/api/v2#tag/Request-queuesBatch-request-operations/operation/requestQueue_requests_batch_post x-js-parent: RequestQueueClient x-js-name: batchAddRequests x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchAddRequests @@ -191,6 +192,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests - https://docs.apify.com/api/v2#/reference/request-queues/delete-requests + - https://docs.apify.com/api/v2#tag/Request-queuesBatch-request-operations/operation/requestQueue_requests_batch_delete x-js-parent: RequestQueueClient x-js-name: batchDeleteRequests x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchDeleteRequests 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 6569309cc..f6982fc34 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 @@ -69,6 +69,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/get-request - https://docs.apify.com/api/v2#/reference/request-queues/get-request + - https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_get x-js-parent: RequestQueueClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#get @@ -190,6 +191,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request - https://docs.apify.com/api/v2#/reference/request-queues/update-request + - https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_put x-js-parent: RequestQueueClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#update @@ -244,6 +246,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request - https://docs.apify.com/api/v2#/reference/request-queues/delete-request + - https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_delete x-js-parent: RequestQueueClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#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 3a533468b..0fa063870 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 @@ -37,10 +37,10 @@ put: - name: clientKey in: query description: | - A unique identifier of the client accessing the request queue. It must - be a string between 1 and 32 characters long. This identifier is used to for locking - and unlocking requests. You can delete or prolong lock only for requests that were locked by by same - client key or from the same Actor run. + A unique identifier of the client accessing the request queue. It must + be a string between 1 and 32 characters long. This identifier is used to for locking + and unlocking requests. You can delete or prolong lock only for requests that were locked by by same + client key or from the same Actor run. style: form explode: true schema: @@ -75,6 +75,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock - https://docs.apify.com/api/v2#/reference/request-queues/prolong-request-lock + - https://docs.apify.com/api/v2#tag/Request-queuesRequest-lock/operation/requestQueue_request_lock_put x-js-parent: RequestQueueClient x-js-name: prolongRequestLock x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#prolongRequestLock @@ -120,10 +121,10 @@ delete: - name: clientKey in: query description: | - A unique identifier of the client accessing the request queue. It must - be a string between 1 and 32 characters long. This identifier is used to for locking - and unlocking requests. You can delete or prolong lock only for requests that were locked by by same - client key or from the same Actor run. + A unique identifier of the client accessing the request queue. It must + be a string between 1 and 32 characters long. This identifier is used to for locking + and unlocking requests. You can delete or prolong lock only for requests that were locked by by same + client key or from the same Actor run. style: form explode: true schema: @@ -148,6 +149,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock - https://docs.apify.com/api/v2#/reference/request-queues/delete-request-lock + - https://docs.apify.com/api/v2#tag/Request-queuesRequest-lock/operation/requestQueue_request_lock_delete x-js-parent: RequestQueueClient x-js-name: deleteRequestLock x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#deleteRequestLock diff --git a/apify-api/openapi/paths/schedules/schedules.yaml b/apify-api/openapi/paths/schedules/schedules.yaml index 5c98830ac..4733dbea5 100644 --- a/apify-api/openapi/paths/schedules/schedules.yaml +++ b/apify-api/openapi/paths/schedules/schedules.yaml @@ -54,6 +54,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules - https://docs.apify.com/api/v2#/reference/schedules/get-list-of-schedules + - https://docs.apify.com/api/v2#tag/SchedulesSchedules-collection/operation/schedules_get x-js-parent: ScheduleCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ScheduleCollectionClient#list @@ -99,6 +100,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule - https://docs.apify.com/api/v2#/reference/schedules/create-schedule + - https://docs.apify.com/api/v2#tag/SchedulesSchedules-collection/operation/schedules_post x-js-parent: ScheduleCollectionClient x-js-name: create x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ScheduleCollectionClient#create diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml index 902f744b1..bf83c8d56 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}.yaml @@ -25,6 +25,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule - https://docs.apify.com/api/v2#/reference/schedules/get-schedule + - https://docs.apify.com/api/v2#tag/SchedulesSchedule-object/operation/schedule_get x-js-parent: ScheduleClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ScheduleClient#get @@ -78,6 +79,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule - https://docs.apify.com/api/v2#/reference/schedules/update-schedule + - https://docs.apify.com/api/v2#tag/SchedulesSchedule-object/operation/schedule_put x-js-parent: ScheduleClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ScheduleClient#update @@ -113,6 +115,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule - https://docs.apify.com/api/v2#/reference/schedules/delete-schedule + - https://docs.apify.com/api/v2#tag/SchedulesSchedule-object/operation/schedule_delete x-js-parent: ScheduleClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ScheduleClient#delete diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml index c9b3874dc..b250a4021 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml @@ -37,6 +37,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log - https://docs.apify.com/api/v2#/reference/schedules/get-schedule-log + - https://docs.apify.com/api/v2#tag/SchedulesSchedule-log/operation/schedule_log_get x-js-parent: ScheduleClient x-js-name: getLog x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/ScheduleClient#getLog diff --git a/apify-api/openapi/paths/store/store.yaml b/apify-api/openapi/paths/store/store.yaml index 0abd54297..e6f98692f 100644 --- a/apify-api/openapi/paths/store/store.yaml +++ b/apify-api/openapi/paths/store/store.yaml @@ -145,3 +145,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/store/store-actors-collection/get-list-of-actors-in-store - https://docs.apify.com/api/v2#/reference/store/get-list-of-actors-in-store + - https://docs.apify.com/api/v2#tag/StoreStore-Actors-collection/operation/store_get diff --git a/apify-api/openapi/paths/users/users@me.yaml b/apify-api/openapi/paths/users/users@me.yaml index b5be31ef6..68214ad0f 100644 --- a/apify-api/openapi/paths/users/users@me.yaml +++ b/apify-api/openapi/paths/users/users@me.yaml @@ -22,3 +22,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/users/private-data/get-private-user-data - https://docs.apify.com/api/v2#/reference/users/get-private-user-data + - https://docs.apify.com/api/v2#tag/UsersPrivate-data/operation/users_me_get diff --git a/apify-api/openapi/paths/users/users@me@limits.yaml b/apify-api/openapi/paths/users/users@me@limits.yaml index 36ca334f6..c3a6f47e3 100644 --- a/apify-api/openapi/paths/users/users@me@limits.yaml +++ b/apify-api/openapi/paths/users/users@me@limits.yaml @@ -19,6 +19,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/users/account-and-usage-limits/get-limits - https://docs.apify.com/api/v2#/reference/users/get-limits + - https://docs.apify.com/api/v2#tag/UsersAccount-and-usage-limits/operation/users_me_limits_get put: tags: - Users/Account and usage limits @@ -45,3 +46,4 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/users/account-and-usage-limits/update-limits - https://docs.apify.com/api/v2#/reference/users/update-limits + - https://docs.apify.com/api/v2#tag/UsersAccount-and-usage-limits/operation/users_me_limits_put 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 9ed8bf5e7..9ff07a82e 100644 --- a/apify-api/openapi/paths/users/users@me@usage@monthly.yaml +++ b/apify-api/openapi/paths/users/users@me@usage@monthly.yaml @@ -32,3 +32,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/users/monthly-usage/get-monthly-usage - https://docs.apify.com/api/v2#/reference/users/get-monthly-usage + - https://docs.apify.com/api/v2#tag/UsersMonthly-usage/operation/users_me_usage_monthly_get diff --git a/apify-api/openapi/paths/users/users@{userId}.yaml b/apify-api/openapi/paths/users/users@{userId}.yaml index 885a05b5a..e98f9d367 100644 --- a/apify-api/openapi/paths/users/users@{userId}.yaml +++ b/apify-api/openapi/paths/users/users@{userId}.yaml @@ -29,3 +29,4 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/users/public-data/get-public-user-data - https://docs.apify.com/api/v2#/reference/users/get-public-user-data + - https://docs.apify.com/api/v2#tag/UsersPublic-data/operation/user_get diff --git a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml index f7f643559..e851c7d3c 100644 --- a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml +++ b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches.yaml @@ -59,6 +59,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches - https://docs.apify.com/api/v2#/reference/webhook-dispatches/get-list-of-webhook-dispatches + - https://docs.apify.com/api/v2#tag/Webhook-dispatchesWebhook-dispatches-collection/operation/webhookDispatches_get x-js-parent: WebhookDispatchCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookDispatchCollectionClient#list 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 2401c30c1..e0b5525ba 100644 --- a/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml +++ b/apify-api/openapi/paths/webhook-dispatches/webhook-dispatches@{dispatchId}.yaml @@ -25,6 +25,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch - https://docs.apify.com/api/v2#/reference/webhook-dispatches/get-webhook-dispatch + - https://docs.apify.com/api/v2#tag/Webhook-dispatchesWebhook-dispatch-object/operation/webhookDispatch_get x-js-parent: WebhookDispatchClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookDispatchClient#get diff --git a/apify-api/openapi/paths/webhooks/webhooks.yaml b/apify-api/openapi/paths/webhooks/webhooks.yaml index 61409855a..740f7302b 100644 --- a/apify-api/openapi/paths/webhooks/webhooks.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks.yaml @@ -59,6 +59,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks - https://docs.apify.com/api/v2#/reference/webhooks/get-list-of-webhooks + - https://docs.apify.com/api/v2#tag/WebhooksWebhook-collection/operation/webhooks_get x-js-parent: WebhookCollectionClient x-js-name: list x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookCollectionClient#list @@ -188,6 +189,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook - https://docs.apify.com/api/v2#/reference/webhooks/create-webhook + - https://docs.apify.com/api/v2#tag/WebhooksWebhook-collection/operation/webhooks_post x-js-parent: WebhookCollectionClient x-js-name: create x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookCollectionClient#create diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml index 39d0fa838..2208e7e9e 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}.yaml @@ -25,6 +25,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook - https://docs.apify.com/api/v2#/reference/webhooks/get-webhook + - https://docs.apify.com/api/v2#tag/WebhooksWebhook-object/operation/webhook_get x-js-parent: WebhookClient x-js-name: get x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookClient#get @@ -84,6 +85,7 @@ put: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook - https://docs.apify.com/api/v2#/reference/webhooks/update-webhook + - https://docs.apify.com/api/v2#tag/WebhooksWebhook-object/operation/webhook_put x-js-parent: WebhookClient x-js-name: update x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookClient#update @@ -118,6 +120,7 @@ delete: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook - https://docs.apify.com/api/v2#/reference/webhooks/delete-webhook + - https://docs.apify.com/api/v2#tag/WebhooksWebhook-object/operation/webhook_delete x-js-parent: WebhookClient x-js-name: delete x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookClient#delete diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml index 85d04e179..d7f92e138 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@dispatches.yaml @@ -25,6 +25,7 @@ get: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection - https://docs.apify.com/api/v2#/reference/webhooks/get-collection + - https://docs.apify.com/api/v2#tag/WebhooksDispatches-collection/operation/webhook_dispatches_get x-py-parent: WebhookClientAsync x-py-name: dispatches x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#dispatches diff --git a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml index 5f6e5534b..726fb3207 100644 --- a/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks@{webhookId}@test.yaml @@ -25,6 +25,7 @@ post: x-legacy-doc-urls: - https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook - https://docs.apify.com/api/v2#/reference/webhooks/test-webhook + - https://docs.apify.com/api/v2#tag/WebhooksWebhook-test/operation/webhook_test_post x-js-parent: WebhookClient x-js-name: test x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/WebhookClient#test diff --git a/apify-api/scripts/add-redoc-legacy-urls-to-operations.py b/apify-api/scripts/add-redoc-legacy-urls-to-operations.py new file mode 100644 index 000000000..9428e0e9e --- /dev/null +++ b/apify-api/scripts/add-redoc-legacy-urls-to-operations.py @@ -0,0 +1,63 @@ +import ruamel.yaml +import csv +import json +from slugify import slugify +from ruamel.yaml.scalarstring import LiteralScalarString +import re +from functools import reduce + +yaml = ruamel.yaml.YAML(typ='rt') +yaml.indent(mapping=2, sequence=4, offset=2) + +# https://stackoverflow.com/questions/78075152/preserve-line-wrapping-in-ruamel-yaml +# needed to convert flow scalars (>-) to literal blocks (|) +yaml.width = 10000 + +# https://stackoverflow.com/questions/42094599/preserving-quotes-in-ruamel-yaml +yaml.preserve_quotes = True + +# non empty null +# https://stackoverflow.com/questions/57172997/yaml-dumper-outputs-blank-instead-of-null-from-none-value-how-to-make-it-output +def my_represent_none(self, data): + return self.represent_scalar(u'tag:yaml.org,2002:null', u'null') + +yaml.representer.add_representer(type(None), my_represent_none) + +# Path to the root openapi.yaml file +openapi_file_path = '../openapi/openapi.yaml' + +# Get all paths from root openapi.yaml file and create operationId for each path. +with open(openapi_file_path, 'r') as file: + openapi_yaml = yaml.load(file) + +# Load tags +#tags_file_path = '../openapi/components/tags.yaml' +#with open(tags_file_path, 'r') as file: +# tags = yaml.load(file) + + +# Update each path with custom logic +for path, ref in openapi_yaml.get('paths').items(): + print(f'Working with path: {path}') + + # Get the yaml file for the path and parse it + path_path = '../openapi/' + ref.get('$ref') + with open(path_path, 'r') as file: + path_yaml = yaml.load(file) + + # For each method in path do the following + for method, operation in path_yaml.items(): + print(f'Method: {method}') + + #tag = next(item for item in tags if item["name"] == operation['tags'][0]) + #print(tag) + + safe_tag = re.sub(r'\/', "", operation['tags'][0]) + safe_tag = re.sub(r' ',"-", safe_tag) + print(safe_tag) + redoc_url = f'https://docs.apify.com/api/v2#tag/{safe_tag}/operation/{operation['operationId']}' + operation['x-legacy-doc-urls'].append(redoc_url) + + with open(path_path, 'w') as file: + yaml.dump(path_yaml, file) + diff --git a/apify-api/scripts/add-redoc-legacy-urls-to-tags.py b/apify-api/scripts/add-redoc-legacy-urls-to-tags.py new file mode 100644 index 000000000..bce5b2eec --- /dev/null +++ b/apify-api/scripts/add-redoc-legacy-urls-to-tags.py @@ -0,0 +1,44 @@ +import ruamel.yaml +import csv +import json +from slugify import slugify +from ruamel.yaml.scalarstring import LiteralScalarString +import re +from functools import reduce + +yaml = ruamel.yaml.YAML(typ='rt') +yaml.indent(mapping=2, sequence=2, offset=0) + +# https://stackoverflow.com/questions/78075152/preserve-line-wrapping-in-ruamel-yaml +# needed to convert flow scalars (>-) to literal blocks (|) +#yaml.width = 10000 + +# https://stackoverflow.com/questions/42094599/preserving-quotes-in-ruamel-yaml +yaml.preserve_quotes = True + +# non empty null +# https://stackoverflow.com/questions/57172997/yaml-dumper-outputs-blank-instead-of-null-from-none-value-how-to-make-it-output +#def my_represent_none(self, data): +# return self.represent_scalar(u'tag:yaml.org,2002:null', u'null') +# +#yaml.representer.add_representer(type(None), my_represent_none) + + +# Load tags +tags_file_path = '../openapi/components/tags.yaml' +with open(tags_file_path, 'r') as file: + tags = yaml.load(file) + for tag in tags: + print(tag) + safe_tag = re.sub(r'\/', "", tag['name']) + safe_tag = re.sub(r' ',"-", safe_tag) + print(safe_tag) + redoc_url = f'#tag/{safe_tag}' + try: + tag['x-legacy-doc-urls'].append(redoc_url) + except KeyError: + tag['x-legacy-doc-urls'] = [redoc_url] + + with open(tags_file_path, 'w') as file: + yaml.dump(tags, file) + diff --git a/apify-api/scripts/requirements.txt b/apify-api/scripts/requirements.txt new file mode 100644 index 000000000..f9af418d0 --- /dev/null +++ b/apify-api/scripts/requirements.txt @@ -0,0 +1,45 @@ +anyio==4.4.0 +attrs==23.2.0 +backoff==2.2.1 +certifi==2024.6.2 +charset-normalizer==3.3.2 +click==8.1.7 +colorama==0.4.6 +graphql-core==3.2.3 +h11==0.14.0 +httpcore==1.0.5 +httpx==0.27.0 +hypothesis==6.104.1 +hypothesis-graphql==0.11.0 +hypothesis-jsonschema==0.23.1 +idna==3.7 +iniconfig==2.0.0 +jsonschema==4.22.0 +jsonschema-specifications==2023.12.1 +junit-xml==1.9 +MarkupSafe==2.1.5 +multidict==6.0.5 +packaging==24.1 +pluggy==1.5.0 +pyrate-limiter==3.6.1 +pytest==8.2.2 +pytest-subtests==0.7.0 +python-slugify==8.0.4 +PyYAML==6.0.1 +referencing==0.35.1 +requests==2.32.3 +rpds-py==0.18.1 +ruamel.yaml==0.18.6 +ruamel.yaml.clib==0.2.8 +schemathesis==3.30.3 +six==1.16.0 +sniffio==1.3.1 +sortedcontainers==2.4.0 +starlette==0.37.2 +starlette-testclient==0.4.1 +text-unidecode==1.3 +tomli==2.0.1 +tomli_w==1.0.0 +urllib3==2.2.2 +Werkzeug==3.0.3 +yarl==1.9.4