Skip to content

docs: improve API endpoint summaries for synchronous Actor runs #2482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jancurn wants to merge 5 commits into
base: master
Choose a base branch
from
+8 −8
Open

docs: improve API endpoint summaries for synchronous Actor runs #2482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
810ae7a
docs: improve API docs endpoint naming and remove redundant Introduct…
claude Apr 30, 2026
179e71d
revert: keep Introduction suffix in tag display names
claude May 5, 2026
39a3d5c
Better copy
jancurn May 6, 2026
4e01dbe
Merge branch 'master' into claude/slack-session-dLEIg
jancurn May 7, 2026
8760545
Better copy
jancurn May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions apify-api/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ info:
## Authentication
<span id="/introduction/authentication"></span>

You can find your API token on the
[Integrations](https://console.apify.com/account#/integrations) page in the
Apify Console.
**You can find your API token on the
[Integrations](https://console.apify.com/settings/integrations) page in the
Comment thread
jancurn marked this conversation as resolved.
Apify Console.**
Comment thread
jancurn marked this conversation as resolved.

To use your token in a request, either:

Expand All @@ -54,7 +54,7 @@ info:
in browser history and server logs. This creates a chance for someone
unauthorized to access your API token.

**Do not share your API token or password with untrusted parties.**
**Never share your API token or password with untrusted parties!**

Comment thread
jancurn marked this conversation as resolved.
For more information, see our
[integrations](https://docs.apify.com/platform/integrations) documentation.
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
tags:
- Actors/Actor runs
summary: Run Actor synchronously with input and get dataset items
summary: Run Actor synchronously and get dataset items
description: |
Runs a specific Actor and returns its dataset items.

Expand Down
4 changes: 2 additions & 2 deletions apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
tags:
- Actors/Actor runs
summary: Run Actor synchronously with input and return output
summary: Run Actor synchronously and return output
description: |
Runs a specific Actor and returns its output.

Expand Down Expand Up @@ -85,7 +85,7 @@ post:
get:
tags:
- Actors/Actor runs
summary: Without input
summary: Run Actor synchronously without input
description: |
Runs a specific Actor and returns its output.
The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default function Home() {
align="center"
description={
<Text color={theme.color.neutral.textMuted} size="large">
Learn how to put the web to work with Apify.
Learn how to put the web to work.
</Text>
Comment thread
jancurn marked this conversation as resolved.
}
/>
Expand Down
Loading