docs: improve API endpoint summaries for synchronous Actor runs#2482
docs: improve API endpoint summaries for synchronous Actor runs#2482
Conversation
…ion suffixes - Rename "Run Actor synchronously with input and get dataset items" to "Run Actor synchronously and get dataset items" - Rename "Run Actor synchronously with input and return output" to "Run Actor synchronously and return output" - Rename "Without input" to "Run Actor synchronously without input" - Remove "- Introduction" suffix from all tag display names https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo
jancurn
changed the title
|
Preview for this PR was built for commit |
|
Could we leave Without the suffix, the group label and index page render as identical siblings (Actors over Actors). We wanted to take a look at the sidebar soon either way with all those |
Per reviewer feedback - removing the suffix causes duplicate labels in sidebar (group label and index page render as identical siblings). The endpoint summary improvements are kept. https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo
|
Preview for this PR was built for commit |
|
hey @TC-MO, this is a draft, please ignore until ready :) |
|
Preview for this PR was built for commit |
jancurn
changed the title
There was a problem hiding this comment.
Pull request overview
Improves wording in the OpenAPI spec to make synchronous Actor run endpoint summaries clearer and more consistent, but also includes unrelated homepage and OpenAPI introduction text edits.
Changes:
- Refines summaries for synchronous Actor run endpoints (
run-syncandrun-sync-get-dataset-items) to remove redundancy and improve consistency. - Updates OpenAPI introduction authentication copy (including console URL) and emphasizes it with bold formatting.
- Tweaks the docs homepage hero description text.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/pages/index.tsx | Updates homepage hero description copy. |
| apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml | Adjusts POST/GET summaries for synchronous Actor runs (with/without input). |
| apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml | Adjusts POST summary for synchronous run returning dataset items. |
| apify-api/openapi/openapi.yaml | Updates authentication intro text, Integrations URL, and warning wording/formatting. |
Improves clarity and consistency of endpoint summaries for synchronous Actor run operations in the API docs.
Changes
/actors/{actorId}/run-sync: "Run Actor synchronously with input and return output" → "Run Actor synchronously and return output"/actors/{actorId}/run-sync: "Without input" → "Run Actor synchronously without input"/actors/{actorId}/run-sync-get-dataset-items: "Run Actor synchronously with input and get dataset items" → "Run Actor synchronously and get dataset items"Why
Slack thread: https://apify.slack.com/archives/CQ96RHG2U/p1777556239984929?thread_ts=1777556206.164759&cid=CQ96RHG2U
https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo