Skip to content

Commit c892454

Browse files
committed
fix Actor capilatization
1 parent 0516f78 commit c892454

File tree

2 files changed

+36
-36
lines changed

2 files changed

+36
-36
lines changed

apify-api/openapi/components/tags.yaml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
- '#/reference/actors/actor-object'
99
- '#tag/ActorsActor-object'
1010
description: |
11-
The API endpoints described in this section enable you to manage, build and run Apify actors.
11+
The API endpoints described in this section enable you to manage, build and run Apify Actors.
1212
For more information, see the <a href="https://docs.apify.com/platform/actors">Actor documentation</a>.
1313
14-
Note that for all the API endpoints that accept the `actorId` parameter to specify an actor,
15-
you can pass either the actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated
16-
username of the actor owner and the actor name (e.g. `janedoe~my-actor`).
14+
Note that for all the API endpoints that accept the `actorId` parameter to specify an Actor,
15+
you can pass either the Actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated
16+
username of the Actor owner and the Actor name (e.g. `janedoe~my-actor`).
1717
1818
Some of the API endpoints return runs objects. Note that if any such run object
1919
contains usage in dollars, your effective unit pricing at the time of query
@@ -77,7 +77,7 @@
7777
</tr>
7878
</table>
7979
80-
For more information about source code and actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)
80+
For more information about source code and Actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)
8181
in Actors documentation.
8282
- name: Actors/Actor builds
8383
x-displayName: Actor builds
@@ -121,20 +121,20 @@
121121
x-trait: 'true'
122122
description: |
123123
This is not a single endpoint, but an entire group of endpoints that lets you to
124-
retrieve and manage the last run of given actor or any of its default storages.
124+
retrieve and manage the last run of given Actor or any of its default storages.
125125
All the endpoints require an authentication token.
126126
127127
The endpoints accept the same HTTP methods and query parameters as
128128
the respective storage endpoints.
129-
The base path represents the last actor run object is:
129+
The base path represents the last Actor run object is:
130130
131131
`/v2/acts/{actorId}/runs/last{?token,status}`
132132
133133
Using the `status` query parameter you can ensure to only get a run with a certain status
134134
(e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters
135135
are the same as in the [Run object](#/reference/actors/run-object) endpoint.
136136
137-
In order to access the default storages of the last actor run, i.e. log, key-value
137+
In order to access the default storages of the last Actor run, i.e. log, key-value
138138
store, dataset and request queue, use the following endpoints:
139139
140140
* `/v2/acts/{actorId}/runs/last/log{?token,status}`
@@ -166,7 +166,7 @@
166166
[Request collection](#/reference/request-queues/request)
167167
* `/v2/acts/{actorId}/runs/last/request-queue/head{?token,status}` [Queue head](#/reference/request-queues/queue-head)
168168
169-
For example, to download data from a dataset of the last succeeded actor run in XML format,
169+
For example, to download data from a dataset of the last succeeded Actor run in XML format,
170170
send HTTP GET request to the following URL:
171171
172172
```
@@ -188,7 +188,7 @@
188188
- '#/reference/actor-builds/build-log'
189189
- '#tag/Actor-buildsBuild-log'
190190
description: |
191-
The API endpoints described in this section enable you to manage Apify actor builds.
191+
The API endpoints described in this section enable you to manage Apify Actor builds.
192192
193193
Note that if any returned build object contains usage in dollars, your effective
194194
unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be
@@ -218,7 +218,7 @@
218218
This section describes API endpoints to manage Key-value stores.
219219
Key-value store is a simple storage for saving and reading data records or files.
220220
Each data record is represented by a unique key and associated with a MIME content type.
221-
Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages,
221+
Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages,
222222
PDFs or to persist the state of crawlers.
223223
For more information, see the <a href="https://docs.apify.com/platform/storage/key-value-store">Key-value
224224
store documentation</a>.
@@ -247,7 +247,7 @@
247247
- '#/reference/actor-tasks/last-run-object-and-its-storages'
248248
- '#tag/Actor-tasksLast-run-object-and-its-storages'
249249
description: |
250-
The API endpoints described in this section enable you to manage and run Apify actor tasks.
250+
The API endpoints described in this section enable you to manage and run Apify Actor tasks.
251251
For more information, see the <a href="https://docs.apify.com/platform/actors/running/tasks">Actor
252252
tasks documentation</a>.
253253
@@ -308,7 +308,7 @@
308308
This section describes API endpoints to manage Key-value stores.
309309
Key-value store is a simple storage for saving and reading data records or files.
310310
Each data record is represented by a unique key and associated with a MIME content type.
311-
Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages,
311+
Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages,
312312
PDFs or to persist the state of crawlers.
313313
For more information, see the <a href="https://docs.apify.com/platform/storage/key-value-store">Key-value
314314
store documentation</a>.
@@ -380,7 +380,7 @@
380380
Webhooks provide an easy and reliable way to configure the Apify platform
381381
to carry out an action (e.g. a HTTP request to another service) when a certain
382382
system event occurs.
383-
For example, you can use webhooks to start another actor when an actor run finishes
383+
For example, you can use webhooks to start another Actor when an Actor run finishes
384384
or fails.
385385
For more information see <a href="https://docs.apify.com/platform/integrations/webhooks">Webhooks
386386
documentation</a>.
@@ -409,9 +409,9 @@
409409
description: |
410410
This section describes API endpoints for managing schedules.
411411
412-
Schedules are used to automatically start your actors at certain times. Each schedule
413-
can be associated with a number of actors and actor tasks. It is also possible
414-
to override the settings of each actor (task) similarly to when invoking the actor
412+
Schedules are used to automatically start your Actors at certain times. Each schedule
413+
can be associated with a number of Actors and Actor tasks. It is also possible
414+
to override the settings of each Actor (task) similarly to when invoking the Actor
415415
(task) using the API.
416416
For more information, see <a href="https://docs.apify.com/platform/schedules">Schedules
417417
documentation</a>.
@@ -443,11 +443,11 @@
443443
- '#tag/LogsLog'
444444
description: |
445445
The API endpoints described in this section are used the download the logs
446-
generated by actor builds and runs. Note that only the trailing 5M characters
446+
generated by Actor builds and runs. Note that only the trailing 5M characters
447447
of the log are stored, the rest is discarded.
448448
449449
Note that the endpoints do not require the authentication token, the calls
450-
are authenticated using a hard-to-guess ID of the actor build or run.
450+
are authenticated using a hard-to-guess ID of the Actor build or run.
451451
x-trait: true
452452
- name: Users
453453
x-displayName: Users

apify-api/openapi/openapi.yaml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,39 +66,39 @@ info:
6666
## Basic usage
6767
<span id="/introduction/basic-usage"></span>
6868
69-
To run an actor, send a POST request to the [Run
70-
actor](#/reference/actors/run-collection/run-actor) endpoint using either the
71-
actor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g.
69+
To run an Actor, send a POST request to the [Run
70+
Actor](#/reference/actors/run-collection/run-actor) endpoint using either the
71+
Actor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g.
7272
`janedoe~my-actor`):
7373
7474
`https://api.apify.com/v2/acts/[actor_id]/runs`
7575
76-
If the actor is not runnable anonymously, you will receive a 401 or 403
76+
If the Actor is not runnable anonymously, you will receive a 401 or 403
7777
[response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status).
7878
This means you need to add your [secret API
7979
token](https://console.apify.com/account#/integrations) to the request's
8080
`Authorization` header ([recommended](#/introduction/authentication)) or as a
8181
URL query parameter `?token=[your_token]` (less secure).
8282
8383
Optionally, you can include the query parameters described in the [Run
84-
actor](#/reference/actors/run-collection/run-actor) section to customize your
84+
Actor](#/reference/actors/run-collection/run-actor) section to customize your
8585
run.
8686
87-
If you're using Node.js, the best way to run an actor is using the
87+
If you're using Node.js, the best way to run an Actor is using the
8888
`Apify.call()` method from the [Apify
8989
SDK](https://sdk.apify.com/docs/api/apify#apifycallactid-input-options). It
90-
runs the actor using the account you are currently logged into (determined
90+
runs the Actor using the account you are currently logged into (determined
9191
by the [secret API token](https://console.apify.com/account#/integrations)).
92-
The result is an [actor run
92+
The result is an [Actor run
9393
object](https://sdk.apify.com/docs/typedefs/actor-run) and its output (if
9494
any).
9595
9696
A typical workflow is as follows:
9797
98-
1. Run an actor or task using the [Run
99-
actor](#/reference/actors/run-collection/run-actor) or [Run
98+
1. Run an Actor or task using the [Run
99+
Actor](#/reference/actors/run-collection/run-actor) or [Run
100100
task](#/reference/actor-tasks/run-collection/run-task) API endpoints.
101-
2. Monitor the actor run by periodically polling its progress using the [Get
101+
2. Monitor the Actor run by periodically polling its progress using the [Get
102102
run](#/reference/actor-runs/run-object-and-its-storages/get-run) API
103103
endpoint.
104104
3. Fetch the results from the [Get
@@ -109,7 +109,7 @@ info:
109109
using the `defaultKeyValueStoreId` and the store's `key`.
110110
111111
**Note**: Instead of periodic polling, you can also run your
112-
[actor](#/reference/actors/run-actor-synchronously) or
112+
[Actor](#/reference/actors/run-actor-synchronously) or
113113
[task](#/reference/actor-tasks/runs-collection/run-task-synchronously)
114114
synchronously. This will ensure that the request waits for 300 seconds (5
115115
minutes) for the run to finish and returns its output. If the run takes
@@ -151,7 +151,7 @@ info:
151151
152152
All API endpoints that return a list of records
153153
(e.g. [Get list of
154-
actors](#/reference/actors/actor-collection/get-list-of-actors))
154+
Actors](#/reference/actors/actor-collection/get-list-of-actors))
155155
enforce pagination in order to limit the size of their responses.
156156
157157
Most of these API endpoints are paginated using the `offset` and `limit`
@@ -417,10 +417,10 @@ info:
417417
operations on key-value store records
418418
419419
These endpoints have a rate limit of _200 requests per second per resource_:
420-
* [Run actor](#/reference/actors/run-collection/run-actor)
421-
* [Run actor task asynchronously](#/reference/actor-tasks/runs-collection/run-task-asynchronously)
422-
* [Run actor task synchronously](#/reference/actor-tasks/runs-collection/run-task-synchronously)
423-
* [Metamorph actor run](#/reference/actors/metamorph-run/metamorph-run)
420+
* [Run Actor](#/reference/actors/run-collection/run-actor)
421+
* [Run Actor task asynchronously](#/reference/actor-tasks/runs-collection/run-task-asynchronously)
422+
* [Run Actor task synchronously](#/reference/actor-tasks/runs-collection/run-task-synchronously)
423+
* [Metamorph Actor run](#/reference/actors/metamorph-run/metamorph-run)
424424
* [Push items](#/reference/datasets/item-collection/put-items) to dataset
425425
* CRUD
426426
([add](#/reference/request-queues/request-collection/add-request),

0 commit comments

Comments
 (0)