|
3 | 3 | - Actors/Default build object |
4 | 4 | summary: Get default build |
5 | 5 | 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. |
10 | 10 |
|
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. |
13 | 13 | operationId: act_build_default_get |
14 | 14 | security: |
15 | 15 | - apiKeyActorBuilds: [] |
|
27 | 27 | in: query |
28 | 28 | description: | |
29 | 29 | 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`), |
32 | 31 | 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 --> |
33 | 34 | style: form |
34 | 35 | explode: true |
35 | 36 | schema: |
|
0 commit comments