Skip to content

Commit 8f88758

Browse files
jancurnclaude
andauthored
docs: improve API endpoint summaries for synchronous Actor runs (#2482)
Improves clarity and consistency of endpoint summaries for synchronous Actor run operations in the API docs. + few copy changes ## Changes - **POST `/actors/{actorId}/run-sync`**: "Run Actor synchronously with input and return output" → "Run Actor synchronously and return output" - **GET `/actors/{actorId}/run-sync`**: "Without input" → "Run Actor synchronously without input" - **POST `/actors/{actorId}/run-sync-get-dataset-items`**: "Run Actor synchronously with input and get dataset items" → "Run Actor synchronously and get dataset items" ## Why - Removed redundant "with input" from POST endpoints (input is implied by POST method) - Expanded terse "Without input" to full descriptive summary for consistency Slack thread: https://apify.slack.com/archives/CQ96RHG2U/p1777556239984929?thread_ts=1777556206.164759&cid=CQ96RHG2U https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent a11dae6 commit 8f88758

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

apify-api/openapi/openapi.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ info:
3737
## Authentication
3838
<span id="/introduction/authentication"></span>
3939
40-
You can find your API token on the
41-
[Integrations](https://console.apify.com/account#/integrations) page in the
42-
Apify Console.
40+
**You can find your API token on the
41+
[Integrations](https://console.apify.com/settings/integrations) page in the
42+
Apify Console.**
4343
4444
To use your token in a request, either:
4545
@@ -54,7 +54,7 @@ info:
5454
in browser history and server logs. This creates a chance for someone
5555
unauthorized to access your API token.
5656
57-
**Do not share your API token or password with untrusted parties.**
57+
**Never share your API token or password with untrusted parties!**
5858
5959
For more information, see our
6060
[integrations](https://docs.apify.com/platform/integrations) documentation.

apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
post:
22
tags:
33
- Actors/Actor runs
4-
summary: Run Actor synchronously with input and get dataset items
4+
summary: Run Actor synchronously and get dataset items
55
description: |
66
Runs a specific Actor and returns its dataset items.
77

apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
post:
22
tags:
33
- Actors/Actor runs
4-
summary: Run Actor synchronously with input and return output
4+
summary: Run Actor synchronously and return output
55
description: |
66
Runs a specific Actor and returns its output.
77
@@ -85,7 +85,7 @@ post:
8585
get:
8686
tags:
8787
- Actors/Actor runs
88-
summary: Without input
88+
summary: Run Actor synchronously without input
8989
description: |
9090
Runs a specific Actor and returns its output.
9191
The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds

src/pages/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export default function Home() {
6666
align="center"
6767
description={
6868
<Text color={theme.color.neutral.textMuted} size="large">
69-
Learn how to put the web to work with Apify.
69+
Learn how to put the web to work.
7070
</Text>
7171
}
7272
/>

0 commit comments

Comments
 (0)