Skip to content

Commit 7b110ab

Browse files
committed
docs: fix Actor capitalization throughout open api docs
1 parent 6873e01 commit 7b110ab

20 files changed

+98
-98
lines changed

apify-api/openapi/paths/actor-runs/actor-runs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ get:
44
summary: Get user runs list
55
description: |
66
Gets a list of all runs for a user. The response is a list of objects, where
7-
each object contains basic information about a single actor run.
7+
each object contains basic information about a single Actor run.
88
99
The endpoint supports pagination using the `limit` and `offset` parameters
1010
and it will not return more than 1000 array elements.

apify-api/openapi/paths/actor-runs/actor-runs@{runId}.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ get:
99
The endpoints accept the same HTTP methods and query parameters as
1010
the respective storage endpoints.
1111
12-
The base path that represents the actor run object is:
12+
The base path that represents the Actor run object is:
1313
1414
`/v2/actor-runs/{runId}{?token}`
1515
16-
In order to access the default storages of the actor run, i.e. log,
16+
In order to access the default storages of the Actor run, i.e. log,
1717
key-value store, dataset and request queue, use the following endpoints:
1818
1919
* `/v2/actor-runs/{runId}/log{?token}`
@@ -55,7 +55,7 @@ get:
5555
* `/v2/actor-runs/{runId}/request-queue/head{?token}` [Queue
5656
head](#/reference/request-queues/queue-head)
5757
58-
For example, to download data from a dataset of the actor run in XML format,
58+
For example, to download data from a dataset of the Actor run in XML format,
5959
send HTTP GET request to the following URL:
6060
6161
```
@@ -64,12 +64,12 @@ get:
6464
6565
In order to save new items to the dataset, send HTTP POST request with JSON
6666
payload to the same URL.Gets an object that contains all the details about a
67-
specific run of an actor.
67+
specific run of an Actor.
6868
6969
By passing the optional `waitForFinish` parameter the API endpoint will
7070
synchronously wait for the run to finish.
7171
72-
This is useful to avoid periodic polling when waiting for actor run to
72+
This is useful to avoid periodic polling when waiting for Actor run to
7373
complete.
7474
7575
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:
218218
summary: Update status message
219219
description: |
220220
You can set a single status message on your run that will be displayed in
221-
the Apify Console UI. During an actor run, you will typically do this in order
222-
to inform users of your actor about the actor's progress.
221+
the Apify Console UI. During an Actor run, you will typically do this in order
222+
to inform users of your Actor about the Actor's progress.
223223
224224
The request body must contain `runId` and `statusMessage` properties. The
225225
`isStatusMessageTerminal` property is optional and it indicates if the

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@abort.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ post:
33
- Actor runs/Abort run
44
summary: Abort run
55
description: |
6-
Aborts an actor run and returns an object that contains all the details
6+
Aborts an Actor run and returns an object that contains all the details
77
about the run.
88
99
Only runs that are starting or running are aborted. For runs with status
@@ -21,7 +21,7 @@ post:
2121
- name: gracefully
2222
in: query
2323
description: |-
24-
If true passed, the actor run will abort gracefully.
24+
If true passed, the Actor run will abort gracefully.
2525
It will send `aborting` and `persistState` event into run and force-stop the run after 30 seconds.
2626
It is helpful in cases where you plan to resurrect the run later.
2727
style: form

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ post:
33
- Actor runs/Metamorph run
44
summary: Metamorph run
55
description: |
6-
Transforms an actor run into a run of another actor with a new input.
6+
Transforms an Actor run into a run of another Actor with a new input.
77
8-
This is useful if you want to use another actor to finish the work
9-
of your current actor run, without the need to create a completely new run
8+
This is useful if you want to use another Actor to finish the work
9+
of your current Actor run, without the need to create a completely new run
1010
and waiting for its finish.
1111
12-
For the users of your actors, the metamorph operation is transparent, they
13-
will just see your actor got the work done.
12+
For the users of your Actors, the metamorph operation is transparent, they
13+
will just see your Actor got the work done.
1414
15-
Internally, the system stops the Docker container corresponding to the actor
15+
Internally, the system stops the Docker container corresponding to the Actor
1616
run and starts a new container using a different Docker image.
1717
1818
All the default storages are preserved and the new input is stored under the
@@ -32,7 +32,7 @@ post:
3232
example: 3KH8gEpp4d8uQSe8T
3333
- name: targetActorId
3434
in: query
35-
description: ID of a target actor that the run should be transformed into.
35+
description: ID of a target Actor that the run should be transformed into.
3636
required: true
3737
style: form
3838
explode: true
@@ -42,11 +42,11 @@ post:
4242
- name: build
4343
in: query
4444
description: |
45-
Optional build of the target actor.
45+
Optional build of the target Actor.
4646
4747
It can be either a build tag or build number. By default, the run uses
4848
the build specified in the default run configuration for the target
49-
actor (typically `latest`).
49+
Actor (typically `latest`).
5050
style: form
5151
explode: true
5252
schema:

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@reboot.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ post:
33
- Actor runs/Reboot run
44
summary: Reboot run
55
description: |
6-
Reboots an actor run and returns an object that contains all the details
6+
Reboots an Actor run and returns an object that contains all the details
77
about the rebooted run.
88
99
Only runs that are running, i.e. runs with status `RUNNING` can be rebooted.

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ post:
33
- Actor runs/Resurrect run
44
summary: Resurrect run
55
description: |
6-
Resurrects a finished actor run and returns an object that contains all the details about the resurrected run.
6+
Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run.
77
Only finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected.
88
Run status will be updated to RUNNING and its container will be restarted with the same storages
99
(the same behaviour as when the run gets migrated to the new server).
@@ -25,7 +25,7 @@ post:
2525
schema:
2626
type: string
2727
example: 0.1.234
28-
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`).
28+
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`).
2929
- name: timeout
3030
in: query
3131
required: false

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ post:
33
- Actor tasks/Run task synchronously and get dataset items
44
summary: Run task synchronously and get dataset items (POST)
55
description: |
6-
Runs an actor task and synchronously returns its dataset items.
6+
Runs an Actor task and synchronously returns its dataset items.
77
88
The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
99
otherwise the HTTP request fails with a timeout error (this won't abort
1010
the run itself).
1111
12-
Optionally, you can override the actor input configuration by passing a JSON
12+
Optionally, you can override the Actor input configuration by passing a JSON
1313
object as the POST payload and setting the `Content-Type: application/json` HTTP header.
1414
1515
Note that if the object in the POST payload does not define a particular
16-
input property, the actor run uses the default value defined by the task (or the actor's
16+
input property, the Actor run uses the default value defined by the task (or the Actor's
1717
input schema if not defined by the task).
1818
1919
You can send all the same options in parameters as the [Get Dataset
@@ -26,7 +26,7 @@ post:
2626
If the connection breaks, you will not receive any information about the run
2727
and its status.
2828
29-
Input fields from actor task configuration can be overloaded with values
29+
Input fields from Actor task configuration can be overloaded with values
3030
passed as the POST payload.
3131
3232
Just make sure to specify the `Content-Type` header as `application/json`
@@ -73,7 +73,7 @@ post:
7373
The maximum number of items that the task run should return. This is
7474
useful for pay-per-result tasks, as it allows you to limit the number of
7575
results that will be charged to your subscription. You can access the
76-
maximum number of items in your actor by using the
76+
maximum number of items in your Actor by using the
7777
`ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.
7878
style: form
7979
explode: true
@@ -84,7 +84,7 @@ post:
8484
- name: build
8585
in: query
8686
description: |
87-
Specifies the actor build to run. It can be either a build tag or build
87+
Specifies the Actor build to run. It can be either a build tag or build
8888
number. By default, the run uses the build specified in the task
8989
settings (typically `latest`).
9090
style: form
@@ -95,10 +95,10 @@ post:
9595
- name: webhooks
9696
in: query
9797
description: |
98-
Specifies optional webhooks associated with the actor run, which can be
98+
Specifies optional webhooks associated with the Actor run, which can be
9999
used to receive a notification
100100
101-
e.g. when the actor finished or failed. The value is a Base64-encoded
101+
e.g. when the Actor finished or failed. The value is a Base64-encoded
102102
JSON array of objects defining the webhooks. For more information, see
103103
104104
[Webhooks
@@ -462,7 +462,7 @@ get:
462462
The maximum number of items that the task run should return. This is
463463
useful for pay-per-result tasks, as it allows you to limit the number of
464464
results that will be charged to your subscription. You can access the
465-
maximum number of items in your actor by using the
465+
maximum number of items in your Actor by using the
466466
`ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.
467467
style: form
468468
explode: true
@@ -473,7 +473,7 @@ get:
473473
- name: build
474474
in: query
475475
description: |
476-
Specifies the actor build to run. It can be either a build tag or build
476+
Specifies the Actor build to run. It can be either a build tag or build
477477
number. By default, the run uses the build specified in the task
478478
settings (typically `latest`).
479479
style: form
@@ -484,10 +484,10 @@ get:
484484
- name: webhooks
485485
in: query
486486
description: |
487-
Specifies optional webhooks associated with the actor run, which can be
487+
Specifies optional webhooks associated with the Actor run, which can be
488488
used to receive a notification
489489
490-
e.g. when the actor finished or failed. The value is a Base64-encoded
490+
e.g. when the Actor finished or failed. The value is a Base64-encoded
491491
JSON array of objects defining the webhooks. For more information, see
492492
493493
[Webhooks

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ post:
33
- Actor tasks/Run task synchronously
44
summary: Run task synchronously (POST)
55
description: |
6-
Runs an actor task and synchronously returns its output.
6+
Runs an Actor task and synchronously returns its output.
77
88
The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
99
otherwise the HTTP request fails with a timeout error (this won't abort
1010
the run itself).
1111
12-
Optionally, you can override the actor input configuration by passing a JSON
12+
Optionally, you can override the Actor input configuration by passing a JSON
1313
object as the POST payload and setting the `Content-Type: application/json` HTTP header.
1414
1515
Note that if the object in the POST payload does not define a particular
16-
input property, the actor run uses the default value defined by the task (or actor's input
16+
input property, the Actor run uses the default value defined by the task (or Actor's input
1717
schema if not defined by the task).
1818
1919
Beware that it might be impossible to maintain an idle HTTP connection for
@@ -23,7 +23,7 @@ post:
2323
If the connection breaks, you will not receive any information about the run
2424
and its status.
2525
26-
Input fields from actor task configuration can be overloaded with values
26+
Input fields from Actor task configuration can be overloaded with values
2727
passed as the POST payload.
2828
2929
Just make sure to specify `Content-Type` header to be `application/json` and
@@ -70,7 +70,7 @@ post:
7070
The maximum number of items that the task run should return. This is
7171
useful for pay-per-result tasks, as it allows you to limit the number of
7272
results that will be charged to your subscription. You can access the
73-
maximum number of items in your actor by using the
73+
maximum number of items in your Actor by using the
7474
`ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.
7575
style: form
7676
explode: true
@@ -81,7 +81,7 @@ post:
8181
- name: build
8282
in: query
8383
description: |
84-
Specifies the actor build to run. It can be either a build tag or build
84+
Specifies the Actor build to run. It can be either a build tag or build
8585
number. By default, the run uses the build specified in the task
8686
settings (typically `latest`).
8787
style: form
@@ -102,10 +102,10 @@ post:
102102
- name: webhooks
103103
in: query
104104
description: |
105-
Specifies optional webhooks associated with the actor run, which can be
105+
Specifies optional webhooks associated with the Actor run, which can be
106106
used to receive a notification
107107
108-
e.g. when the actor finished or failed. The value is a Base64-encoded
108+
e.g. when the Actor finished or failed. The value is a Base64-encoded
109109
JSON array of objects defining the webhooks. For more information, see
110110
111111
[Webhooks
@@ -205,7 +205,7 @@ get:
205205
The maximum number of items that the task run should return. This is
206206
useful for pay-per-result tasks, as it allows you to limit the number of
207207
results that will be charged to your subscription. You can access the
208-
maximum number of items in your actor by using the
208+
maximum number of items in your Actor by using the
209209
`ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.
210210
style: form
211211
explode: true
@@ -216,7 +216,7 @@ get:
216216
- name: build
217217
in: query
218218
description: |
219-
Specifies the actor build to run. It can be either a build tag or build
219+
Specifies the Actor build to run. It can be either a build tag or build
220220
number. By default, the run uses the build specified in the task
221221
settings (typically `latest`).
222222
style: form
@@ -237,10 +237,10 @@ get:
237237
- name: webhooks
238238
in: query
239239
description: |
240-
Specifies optional webhooks associated with the actor run, which can be
240+
Specifies optional webhooks associated with the Actor run, which can be
241241
used to receive a notification
242242
243-
e.g. when the actor finished or failed. The value is a Base64-encoded
243+
e.g. when the Actor finished or failed. The value is a Base64-encoded
244244
JSON array of objects defining the webhooks. For more information, see
245245
246246
[Webhooks

0 commit comments

Comments
 (0)