diff --git a/apify-api/openapi/paths/actor-runs/actor-runs.yaml b/apify-api/openapi/paths/actor-runs/actor-runs.yaml index 6dd2e58790..811f376d75 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 01a8ffeb2c..cf201ca95a 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, @@ -220,8 +220,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 db165270f8..d81203e179 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 63920b008f..0172d54c46 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 66e1714d47..1ed0677eca 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 321f82ecf7..446a342f11 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 8a5034a5a2..4d87b50d22 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 @@ -463,7 +463,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 @@ -474,7 +474,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 @@ -485,10 +485,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 71574a4cd9..90ab55a502 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 @@ -206,7 +206,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 @@ -217,7 +217,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 @@ -238,10 +238,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 31ce63b8bc..d3a514edf3 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 @@ -132,25 +132,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. @@ -190,10 +190,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 @@ -204,7 +204,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 @@ -232,13 +232,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 a065e7efb5..d0d3ff27b8 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 878c2509d0..7cbbbb08eb 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 + 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. @@ -98,7 +98,7 @@ get: post: tags: - Actors/Actor collection - summary: Create actor + 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 74f7275465..0d69a71629 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 + summary: Get Actor description: Gets an object that contains all the details about a specific Actor. operationId: act_get parameters: @@ -95,7 +95,7 @@ get: put: tags: - Actors/Actor object - summary: Update actor + summary: Update Actor description: | Updates settings of an Actor using values specified by an Actor object passed as JSON in the POST payload. @@ -247,7 +247,7 @@ put: delete: tags: - Actors/Actor object - summary: Delete actor + 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 ceafb55c49..cfa60194ae 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@builds.yaml @@ -77,7 +77,7 @@ get: post: tags: - Actors/Build collection - summary: Build actor + 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 4117878382..321f41c439 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 + summary: Run Actor synchronously with input and get dataset items description: | Runs a specific Actor and returns its dataset items. @@ -429,14 +429,14 @@ post: get: tags: - Actors/Run Actor synchronously and get dataset items - summary: Run actor synchronously without input and get dataset items + 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 19f4473898..7f25b54ee4 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 @@ -126,7 +126,7 @@ get: post: tags: - Actors/Run collection - summary: Run actor + summary: Run Actor description: | Runs an Actor and immediately returns without waiting for the run to finish. diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs@{runId}@metamorph.yaml index 92c39cd452..c55d422634 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 697ca3519e..7b2f2468e8 100644 --- a/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml +++ b/apify-api/openapi/paths/logs/logs@{buildOrRunId}.yaml @@ -11,7 +11,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 b250a40215..f2ed655dbe 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 e6f98692f2..16b57aae82 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 740f7302b9..ffed50327f 100644 --- a/apify-api/openapi/paths/webhooks/webhooks.yaml +++ b/apify-api/openapi/paths/webhooks/webhooks.yaml @@ -88,7 +88,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. @@ -97,10 +97,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.