From 7b110abd4159f7ebb3ca16bcf4cf7597fba7b763 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:36:43 +0100 Subject: [PATCH 1/5] docs: fix Actor capitalization throughout open api docs --- .../openapi/paths/actor-runs/actor-runs.yaml | 2 +- .../paths/actor-runs/actor-runs@{runId}.yaml | 14 +++++----- .../actor-runs/actor-runs@{runId}@abort.yaml | 4 +-- .../actor-runs@{runId}@metamorph.yaml | 18 ++++++------- .../actor-runs/actor-runs@{runId}@reboot.yaml | 2 +- .../actor-runs@{runId}@resurrect.yaml | 4 +-- ...torTaskId}@run-sync-get-dataset-items.yaml | 24 ++++++++--------- .../actor-tasks@{actorTaskId}@run-sync.yaml | 24 ++++++++--------- .../actor-tasks@{actorTaskId}@runs.yaml | 26 +++++++++---------- .../actor-tasks@{actorTaskId}@webhooks.yaml | 2 +- apify-api/openapi/paths/actors/acts.yaml | 8 +++--- .../openapi/paths/actors/acts@{actorId}.yaml | 12 ++++----- .../paths/actors/acts@{actorId}@builds.yaml | 4 +-- ...@{actorId}@run-sync-get-dataset-items.yaml | 12 ++++----- .../paths/actors/acts@{actorId}@runs.yaml | 8 +++--- ...acts@{actorId}@runs@{runId}@metamorph.yaml | 16 ++++++------ .../paths/logs/logs@{buildOrRunId}.yaml | 2 +- .../schedules/schedules@{scheduleId}@log.yaml | 2 +- apify-api/openapi/paths/store/store.yaml | 6 ++--- .../openapi/paths/webhooks/webhooks.yaml | 6 ++--- 20 files changed, 98 insertions(+), 98 deletions(-) diff --git a/apify-api/openapi/paths/actor-runs/actor-runs.yaml b/apify-api/openapi/paths/actor-runs/actor-runs.yaml index 620c22a454..a95bb6700c 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs.yaml @@ -4,7 +4,7 @@ get: summary: Get user runs list description: | Gets a list of all runs for a user. The response is a list of objects, where - each object contains basic information about a single actor run. + each object contains basic information about a single Actor run. The endpoint supports pagination using the `limit` and `offset` parameters and it will not return more than 1000 array elements. 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 faca05ad13..7ac8185efd 100644 --- a/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml +++ b/apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml @@ -9,11 +9,11 @@ get: The endpoints accept the same HTTP methods and query parameters as the respective storage endpoints. - The base path that represents the actor run object is: + The base path that represents the Actor run object is: `/v2/actor-runs/{runId}{?token}` - In order to access the default storages of the actor run, i.e. log, + In order to access the default storages of the Actor run, i.e. log, key-value store, dataset and request queue, use the following endpoints: * `/v2/actor-runs/{runId}/log{?token}` @@ -55,7 +55,7 @@ get: * `/v2/actor-runs/{runId}/request-queue/head{?token}` [Queue head](#/reference/request-queues/queue-head) - For example, to download data from a dataset of the actor run in XML format, + For example, to download data from a dataset of the Actor run in XML format, send HTTP GET request to the following URL: ``` @@ -64,12 +64,12 @@ get: In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL.Gets an object that contains all the details about a - specific run of an actor. + specific run of an Actor. By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait for the run to finish. - This is useful to avoid periodic polling when waiting for actor run to + This is useful to avoid periodic polling when waiting for Actor run to complete. This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However, @@ -218,8 +218,8 @@ put: summary: Update status message description: | You can set a single status message on your run that will be displayed in - the Apify Console UI. During an actor run, you will typically do this in order - to inform users of your actor about the actor's progress. + the Apify Console UI. During an Actor run, you will typically do this in order + to inform users of your Actor about the Actor's progress. The request body must contain `runId` and `statusMessage` properties. The `isStatusMessageTerminal` property is optional and it indicates if the 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 53b9693384..39b4b4f84e 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 @@ -3,7 +3,7 @@ post: - Actor runs/Abort run summary: Abort run description: | - Aborts an actor run and returns an object that contains all the details + Aborts an Actor run and returns an object that contains all the details about the run. Only runs that are starting or running are aborted. For runs with status @@ -21,7 +21,7 @@ post: - name: gracefully in: query description: |- - If true passed, the actor run will abort gracefully. + If true passed, the Actor run will abort gracefully. It will send `aborting` and `persistState` event into run and force-stop the run after 30 seconds. It is helpful in cases where you plan to resurrect the run later. style: form 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 2c186b620b..b4d992fb08 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 @@ -3,16 +3,16 @@ post: - Actor runs/Metamorph run summary: Metamorph run description: | - Transforms an actor run into a run of another actor with a new input. + Transforms an Actor run into a run of another Actor with a new input. - This is useful if you want to use another actor to finish the work - of your current actor run, without the need to create a completely new run + This is useful if you want to use another Actor to finish the work + of your current Actor run, without the need to create a completely new run and waiting for its finish. - For the users of your actors, the metamorph operation is transparent, they - will just see your actor got the work done. + For the users of your Actors, the metamorph operation is transparent, they + will just see your Actor got the work done. - Internally, the system stops the Docker container corresponding to the actor + Internally, the system stops the Docker container corresponding to the Actor run and starts a new container using a different Docker image. All the default storages are preserved and the new input is stored under the @@ -32,7 +32,7 @@ post: example: 3KH8gEpp4d8uQSe8T - name: targetActorId in: query - description: ID of a target actor that the run should be transformed into. + description: ID of a target Actor that the run should be transformed into. required: true style: form explode: true @@ -42,11 +42,11 @@ post: - name: build in: query description: | - Optional build of the target actor. + Optional build of the target Actor. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the target - actor (typically `latest`). + Actor (typically `latest`). style: form explode: true schema: 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 4d265095cd..c74cf6cefe 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 @@ -3,7 +3,7 @@ post: - Actor runs/Reboot run summary: Reboot run description: | - Reboots an actor run and returns an object that contains all the details + Reboots an Actor run and returns an object that contains all the details about the rebooted run. Only runs that are running, i.e. runs with status `RUNNING` can be rebooted. 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 8c199467ad..f479f9f0f2 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 @@ -3,7 +3,7 @@ post: - Actor runs/Resurrect run summary: Resurrect run description: | - Resurrects a finished actor run and returns an object that contains all the details about the resurrected run. + Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run. Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected. Run status will be updated to RUNNING and its container will be restarted with the same storages (the same behaviour as when the run gets migrated to the new server). @@ -25,7 +25,7 @@ post: schema: type: string example: 0.1.234 - description: Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the run that is being resurrected (typically `latest`). + description: Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the run that is being resurrected (typically `latest`). - name: timeout in: query required: false 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 a1a06a2543..1ff8170994 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 @@ -3,17 +3,17 @@ post: - Actor tasks/Run task synchronously and get dataset items summary: Run task synchronously and get dataset items (POST) description: | - Runs an actor task and synchronously returns its dataset items. + Runs an Actor task and synchronously returns its dataset items. The run must finish in 300 seconds otherwise the HTTP request fails with a timeout error (this won't abort the run itself). - Optionally, you can override the actor input configuration by passing a JSON + Optionally, you can override the Actor input configuration by passing a JSON object as the POST payload and setting the `Content-Type: application/json` HTTP header. Note that if the object in the POST payload does not define a particular - input property, the actor run uses the default value defined by the task (or the actor's + input property, the Actor run uses the default value defined by the task (or the Actor's input schema if not defined by the task). You can send all the same options in parameters as the [Get Dataset @@ -26,7 +26,7 @@ post: If the connection breaks, you will not receive any information about the run and its status. - Input fields from actor task configuration can be overloaded with values + Input fields from Actor task configuration can be overloaded with values passed as the POST payload. Just make sure to specify the `Content-Type` header as `application/json` @@ -73,7 +73,7 @@ post: The maximum number of items that the task run should return. This is useful for pay-per-result tasks, as it allows you to limit the number of results that will be charged to your subscription. You can access the - maximum number of items in your actor by using the + maximum number of items in your Actor by using the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -84,7 +84,7 @@ post: - name: build in: query description: | - Specifies the actor build to run. It can be either a build tag or build + Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`). style: form @@ -95,10 +95,10 @@ post: - name: webhooks in: query description: | - Specifies optional webhooks associated with the actor run, which can be + Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the actor finished or failed. The value is a Base64-encoded + e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see [Webhooks @@ -462,7 +462,7 @@ get: The maximum number of items that the task run should return. This is useful for pay-per-result tasks, as it allows you to limit the number of results that will be charged to your subscription. You can access the - maximum number of items in your actor by using the + maximum number of items in your Actor by using the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -473,7 +473,7 @@ get: - name: build in: query description: | - Specifies the actor build to run. It can be either a build tag or build + Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`). style: form @@ -484,10 +484,10 @@ get: - name: webhooks in: query description: | - Specifies optional webhooks associated with the actor run, which can be + Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the actor finished or failed. The value is a Base64-encoded + e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see [Webhooks 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 e9c3a957df..2febf6b936 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 @@ -3,17 +3,17 @@ post: - Actor tasks/Run task synchronously summary: Run task synchronously (POST) description: | - Runs an actor task and synchronously returns its output. + Runs an Actor task and synchronously returns its output. The run must finish in 300 seconds otherwise the HTTP request fails with a timeout error (this won't abort the run itself). - Optionally, you can override the actor input configuration by passing a JSON + Optionally, you can override the Actor input configuration by passing a JSON object as the POST payload and setting the `Content-Type: application/json` HTTP header. Note that if the object in the POST payload does not define a particular - input property, the actor run uses the default value defined by the task (or actor's input + input property, the Actor run uses the default value defined by the task (or Actor's input schema if not defined by the task). Beware that it might be impossible to maintain an idle HTTP connection for @@ -23,7 +23,7 @@ post: If the connection breaks, you will not receive any information about the run and its status. - Input fields from actor task configuration can be overloaded with values + Input fields from Actor task configuration can be overloaded with values passed as the POST payload. Just make sure to specify `Content-Type` header to be `application/json` and @@ -70,7 +70,7 @@ post: The maximum number of items that the task run should return. This is useful for pay-per-result tasks, as it allows you to limit the number of results that will be charged to your subscription. You can access the - maximum number of items in your actor by using the + maximum number of items in your Actor by using the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -81,7 +81,7 @@ post: - name: build in: query description: | - Specifies the actor build to run. It can be either a build tag or build + Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`). style: form @@ -102,10 +102,10 @@ post: - name: webhooks in: query description: | - Specifies optional webhooks associated with the actor run, which can be + Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the actor finished or failed. The value is a Base64-encoded + e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see [Webhooks @@ -205,7 +205,7 @@ get: The maximum number of items that the task run should return. This is useful for pay-per-result tasks, as it allows you to limit the number of results that will be charged to your subscription. You can access the - maximum number of items in your actor by using the + maximum number of items in your Actor by using the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -216,7 +216,7 @@ get: - name: build in: query description: | - Specifies the actor build to run. It can be either a build tag or build + Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`). style: form @@ -237,10 +237,10 @@ get: - name: webhooks in: query description: | - Specifies optional webhooks associated with the actor run, which can be + Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the actor finished or failed. The value is a Base64-encoded + e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see [Webhooks 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 b7ef14cfb4..2521f9a2da 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 @@ -131,25 +131,25 @@ post: - Actor tasks/Run collection summary: Run task description: | - Runs an actor task and immediately returns without waiting for the run to + Runs an Actor task and immediately returns without waiting for the run to finish. - Optionally, you can override the actor input configuration by passing a JSON + Optionally, you can override the Actor input configuration by passing a JSON object as the POST payload and setting the `Content-Type: application/json` HTTP header. Note that if the object in the POST payload does not define a particular - input property, the actor run uses the default value defined by the task (or actor's input + input property, the Actor run uses the default value defined by the task (or Actor's input schema if not defined by the task). - The response is the actor Run object as returned by the [Get + The response is the Actor Run object as returned by the [Get run](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint. If you want to wait for the run to finish and receive the actual output of - the actor run as the response, use one of the [Run task + the Actor run as the response, use one of the [Run task synchronously](#/reference/actor-tasks/run-task-synchronously) API endpoints instead. - To fetch the actor run results that are typically stored in the default + To fetch the Actor run results that are typically stored in the default dataset, you'll need to pass the ID received in the `defaultDatasetId` field received in the response JSON to the [Get items](#/reference/datasets/item-collection/get-items) API endpoint. @@ -189,10 +189,10 @@ post: - name: maxItems in: query description: | - The maximum number of items that the actor run should return. This is - useful for pay-per-result actors, as it allows you to limit the number + The maximum number of items that the Actor run should return. This is + useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the - maximum number of items in your actor by using the + maximum number of items in your Actor by using the `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -203,7 +203,7 @@ post: - name: build in: query description: | - Specifies the actor build to run. It can be either a build tag or build + Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`). style: form @@ -231,13 +231,13 @@ post: - name: webhooks in: query description: | - Specifies optional webhooks associated with the actor run, which can be + Specifies optional webhooks associated with the Actor run, which can be used to receive a notification - e.g. when the actor finished or failed. The value is a Base64-encoded + e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. - **Note**: if you already have a webhook set up for the actor or task, + **Note**: if you already have a webhook set up for the Actor or task, you do not have to add it again here. For more information, see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). 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 e6311fb2a9..090b2e80af 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 @@ -3,7 +3,7 @@ get: - Actor tasks/Webhook collection summary: Get list of webhooks description: | - Gets the list of webhooks of a specific actor task. The response is a JSON + Gets the list of webhooks of a specific Actor task. The response is a JSON with the list of objects, where each object contains basic information about a single webhook. The endpoint supports pagination using the `limit` and `offset` parameters diff --git a/apify-api/openapi/paths/actors/acts.yaml b/apify-api/openapi/paths/actors/acts.yaml index 12cc4c8770..c60bab1f9a 100644 --- a/apify-api/openapi/paths/actors/acts.yaml +++ b/apify-api/openapi/paths/actors/acts.yaml @@ -1,7 +1,7 @@ get: tags: - - Actors/Actor collection - summary: Get list of actors + - Basic operations + summary: Get list of Actors description: | Gets the list of all Actors that the user created or used. The response is a list of objects, where each object contains a basic information about a single Actor. @@ -96,8 +96,8 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#list post: tags: - - Actors/Actor collection - summary: Create actor + - Basic operations + summary: Create Actor description: | Creates a new Actor with settings specified in an Actor object passed as JSON in the POST payload. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 2e354d7a9b..8c216d895d 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -1,7 +1,7 @@ get: tags: - - Actors/Actor object - summary: Get actor + - Basic operations + summary: Get Actor description: Gets an object that contains all the details about a specific Actor. operationId: act_get parameters: @@ -93,8 +93,8 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#get put: tags: - - Actors/Actor object - summary: Update actor + - Basic operations + summary: Update Actor description: | Updates settings of an Actor using values specified by an Actor object passed as JSON in the POST payload. @@ -244,8 +244,8 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#update delete: tags: - - Actors/Actor object - summary: Delete actor + - Basic operations + summary: Delete Actor description: Deletes an Actor. operationId: act_delete parameters: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index d972728449..baf6345632 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -75,8 +75,8 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync#list post: tags: - - Actors/Build collection - summary: Build actor + - Builds + summary: Build Actor description: |- Builds an Actor. The response is the build object as returned by the 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 8483fb093d..a339dce74d 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -1,7 +1,7 @@ post: tags: - - Actors/Run Actor synchronously and get dataset items - summary: Run actor synchronously with input and get dataset items + - Sync Runs + summary: Run Actor synchronously with input and get dataset items description: | Runs a specific Actor and returns its dataset items. @@ -427,15 +427,15 @@ post: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-with-input-and-get-dataset-items get: tags: - - Actors/Run Actor synchronously and get dataset items - summary: Run actor synchronously without input and get dataset items + - Sync Runs + summary: Run Actor synchronously without input and get dataset items description: | - Runs a specific actor and returns its dataset items. + Runs a specific Actor and returns its dataset items. The run must finish in 300 seconds otherwise the API endpoint returns a timeout error. - The actor is not passed any input. + The Actor is not passed any input. It allows to send all possible options in parameters from [Get Dataset diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index 1a1f27789c..4d39ec3045 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -3,8 +3,8 @@ get: - Actors/Run collection summary: Get list of runs description: | - Gets the list of runs of a specific actor. The response is a list of - objects, where each object contains basic information about a single actor run. + Gets the list of runs of a specific Actor. The response is a list of + objects, where each object contains basic information about a single Actor run. The endpoint supports pagination using the `limit` and `offset` parameters @@ -124,8 +124,8 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunCollectionClientAsync#list post: tags: - - Actors/Run collection - summary: Run actor + - Runs + summary: Run Actor description: | Runs an Actor and immediately returns without waiting for the run to finish. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml index 85c78da436..4cd305b22b 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 @@ -3,17 +3,17 @@ post: - Actors/Metamorph run summary: Metamorph run description: | - **[DEPRECATED]** API endpoints related to run of the actor were moved under - new namespace [`actor-runs`](#/reference/actor-runs).Transforms an actor run - into a run of another actor with a new input. + **[DEPRECATED]** API endpoints related to run of the Actor were moved under + new namespace [`actor-runs`](#/reference/actor-runs).Transforms an Actor run + into a run of another Actor with a new input. - This is useful if you want to use another actor to finish the work + This is useful if you want to use another Actor to finish the work - of your current actor run, without the need to create a completely new run + of your current Actor run, without the need to create a completely new run and waiting for its finish. - For the users of your actors, the metamorph operation is transparent, they - will just see your actor got the work done. + For the users of your Actors, the metamorph operation is transparent, they + will just see your Actor got the work done. There is a limit on how many times you can metamorph a single run. You can @@ -21,7 +21,7 @@ post: limits](https://docs.apify.com/platform/limits#actor-limits). - Internally, the system stops the Docker container corresponding to the actor + Internally, the system stops the Docker container corresponding to the Actor run and starts a new container using a different Docker image. diff --git a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml index f547ef5358..234d67fa74 100644 --- a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml +++ b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml @@ -10,7 +10,7 @@ get: parameters: - name: buildOrRunId in: path - description: ID of the actor build or run. + description: ID of the Actor build or run. required: true style: simple schema: diff --git a/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml b/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml index c9b3874dcb..261b265a15 100644 --- a/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml +++ b/apify-api/openapi/paths/schedules/schedules@{scheduleId}@log.yaml @@ -29,7 +29,7 @@ get: level: INFO createdAt: '2019-03-26T12:28:00.370Z' - message: >- - Cannot start actor task \"iEvfA6pm6DWjRTGxS\": Provided input + Cannot start Actor task \"iEvfA6pm6DWjRTGxS\": Provided input must be object, got \"string\" instead. level: ERROR createdAt: '2019-03-26T12:30:00.325Z' diff --git a/apify-api/openapi/paths/store/store.yaml b/apify-api/openapi/paths/store/store.yaml index 0abd542971..1342b41e11 100644 --- a/apify-api/openapi/paths/store/store.yaml +++ b/apify-api/openapi/paths/store/store.yaml @@ -8,7 +8,7 @@ get: and readme. If you need detailed info about a specific Actor, use the [Get - actor](#/reference/actors/actor-object/get-actor) endpoint. + Actor](#/reference/actors/actor-object/get-actor) endpoint. The endpoint supports pagination using the `limit` and `offset` parameters. @@ -103,7 +103,7 @@ get: title: My Public Actor name: my-public-actor username: jane35 - description: My public actor! + description: My public Actor! pictureUrl: 'https://...' userPictureUrl: 'https://...' url: 'https://...' @@ -126,7 +126,7 @@ get: categories: - "MARKETING" - "LEAD_GENERATION" - description: My public actor! + description: My public Actor! pictureUrl: 'https://...' userPictureUrl: 'https://...' url: 'https://...' diff --git a/apify-api/openapi/paths/webhooks/webhooks.yaml b/apify-api/openapi/paths/webhooks/webhooks.yaml index 61409855ad..a75548726a 100644 --- a/apify-api/openapi/paths/webhooks/webhooks.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks.yaml @@ -87,7 +87,7 @@ post: enough entropy. - To assign the new webhook to an actor or task, the request body must contain + To assign the new webhook to an Actor or task, the request body must contain `requestUrl`, `eventTypes`, and `condition` properties. @@ -96,10 +96,10 @@ post: * `eventTypes` is a list of events that will trigger the webhook, e.g. when - the actor run succeeds. + the Actor run succeeds. - * `condition` should be an object containing the ID of the actor or task to + * `condition` should be an object containing the ID of the Actor or task to which the webhook will be assigned. From 65f4729c6f3dc48b33e45b263e47c7796a38ea6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Mon, 9 Dec 2024 21:00:25 +0100 Subject: [PATCH 2/5] fix wrongly rendered backticks --- apify-api/openapi/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index 4d0c6d021b..ccdc9e4f18 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -45,8 +45,8 @@ info: To use your token in a request, either: - - Add the token to your request's `Authorization` header as `Bearer - `. + - Add the token to your request's `Authorization` header as Bearer + <token>. E.g., `Authorization: Bearer xxxxxxx`. [More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization). (Recommended). From 54cf70e660f4f40442e6e90cf6137951ff3d6808 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Mon, 9 Dec 2024 21:10:40 +0100 Subject: [PATCH 3/5] revert changes done to tags --- apify-api/openapi/paths/actors/acts.yaml | 4 ++-- apify-api/openapi/paths/actors/acts@{actorId}.yaml | 6 +++--- .../actors/acts@{actorId}@run-sync-get-dataset-items.yaml | 4 ++-- apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/apify-api/openapi/paths/actors/acts.yaml b/apify-api/openapi/paths/actors/acts.yaml index c60bab1f9a..a8f30251bc 100644 --- a/apify-api/openapi/paths/actors/acts.yaml +++ b/apify-api/openapi/paths/actors/acts.yaml @@ -1,6 +1,6 @@ get: tags: - - Basic operations + - Actors/Actor collection summary: Get list of Actors description: | Gets the list of all Actors that the user created or used. The response is a @@ -96,7 +96,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#list post: tags: - - Basic operations + - Actors/Actor collection summary: Create Actor description: | Creates a new Actor with settings specified in an Actor object passed as diff --git a/apify-api/openapi/paths/actors/acts@{actorId}.yaml b/apify-api/openapi/paths/actors/acts@{actorId}.yaml index 8c216d895d..3683a3cd27 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}.yaml @@ -1,6 +1,6 @@ get: tags: - - Basic operations + - Actors/Actor object summary: Get Actor description: Gets an object that contains all the details about a specific Actor. operationId: act_get @@ -93,7 +93,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#get put: tags: - - Basic operations + - Actors/Actor object summary: Update Actor description: | Updates settings of an Actor using values specified by an Actor object @@ -244,7 +244,7 @@ put: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#update delete: tags: - - Basic operations + - Actors/Actor object summary: Delete Actor description: Deletes an Actor. operationId: act_delete 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 a339dce74d..193e9abdb9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -1,6 +1,6 @@ post: tags: - - Sync Runs + - Actors/Run Actor synchronously and get dataset items summary: Run Actor synchronously with input and get dataset items description: | Runs a specific Actor and returns its dataset items. @@ -427,7 +427,7 @@ post: - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-with-input-and-get-dataset-items get: tags: - - Sync Runs + - Actors/Run Actor synchronously and get dataset items summary: Run Actor synchronously without input and get dataset items description: | Runs a specific Actor and returns its dataset items. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index 4d39ec3045..d9bd49b8d7 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -124,7 +124,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RunCollectionClientAsync#list post: tags: - - Runs + - Actors/Run collection summary: Run Actor description: | Runs an Actor and immediately returns without waiting for the run to finish. From 8234151880540ff620dbd9a9a97918ddf9cfb394 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Tue, 10 Dec 2024 16:23:20 +0100 Subject: [PATCH 4/5] fix tag in OpenAPI specs --- apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml index baf6345632..ba928b2a30 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -75,7 +75,7 @@ get: x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync#list post: tags: - - Builds + - Actors/Build collection summary: Build Actor description: |- Builds an Actor. From a7ce8bacb0beab5c065da1f5e098042fd7dc5224 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= Date: Thu, 9 Jan 2025 12:59:43 +0100 Subject: [PATCH 5/5] revert changes done to openapi.yaml revert changes to Bearer token description --- apify-api/openapi/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/openapi.yaml b/apify-api/openapi/openapi.yaml index ccdc9e4f18..21b3aa70a8 100644 --- a/apify-api/openapi/openapi.yaml +++ b/apify-api/openapi/openapi.yaml @@ -45,8 +45,8 @@ info: To use your token in a request, either: - - Add the token to your request's `Authorization` header as Bearer - <token>. + - Add the token to your request's `Authorization` header as `Bearer + `. E.g., `Authorization: Bearer xxxxxxx`. [More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization). (Recommended).