Commit 8f88758
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
- paths/actors
- src/pages
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
41 | | - | |
42 | | - | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
| |||
0 commit comments