Skip to content

Commit 61e25ee

Browse files
committed
refactor: imrpoved documentation text
1 parent 97daaaf commit 61e25ee

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

apify-api/openapi/paths/actors/acts@{actorId}@[email protected]

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ get:
33
- Actors/Default build object
44
summary: Get default build
55
description: |
6-
By passing the optional `waitForFinish` parameter the API endpoint will
7-
synchronously wait for the build to finish.
8-
This is useful to avoid periodic polling when waiting for an Actor build to
9-
finish.
6+
Get the default build for an Actor.
7+
8+
Use the optional `waitForFinish` parameter to synchronously wait for the build to finish.
9+
This avoids the need for periodic polling when waiting for the build to complete.
1010
11-
This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. However,
12-
if you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.
11+
This endpoint does not require an authentication token. Instead, calls are authenticated using the build's unique ID.
12+
However, if you access the endpoint without a token, certain attributes (e.g., `usageUsd` and `usageTotalUsd`) will be hidden.
1313
operationId: act_build_default_get
1414
security:
1515
- apiKeyActorBuilds: []
@@ -27,9 +27,10 @@ get:
2727
in: query
2828
description: |
2929
The maximum number of seconds the server waits for the build to finish.
30-
By default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
31-
If the build finishes in time then the returned build object will have a terminal status (e.g. `SUCCEEDED`),
30+
If the build finishes within this time, the returned build object will have a terminal status (e.g. `SUCCEEDED`),
3231
otherwise it will have a transitional status (e.g. `RUNNING`).
32+
33+
By default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
3334
style: form
3435
explode: true
3536
schema:

0 commit comments

Comments
 (0)