Skip to content

docs: simplify API documentation tag display names and endpoint summaries#2482

Draft
jancurn wants to merge 1 commit intomasterfrom
claude/slack-session-dLEIg
Draft

docs: simplify API documentation tag display names and endpoint summaries#2482
jancurn wants to merge 1 commit intomasterfrom
claude/slack-session-dLEIg

Conversation

@jancurn
Copy link
Copy Markdown
Member

@jancurn jancurn commented Apr 30, 2026

Summary

This PR removes the "- Introduction" suffix from all API documentation tag display names in the OpenAPI specification, making them more concise and consistent. Additionally, it improves the clarity of endpoint summaries for synchronous Actor run operations.

Key Changes

  • Tag display names: Removed "- Introduction" suffix from 30+ tag x-displayName fields across all API sections (Actors, Storage, Webhooks, Schedules, Store, Logs, Users, Tools, and convenience endpoints)
  • Endpoint summaries:
    • Updated "Run Actor synchronously with input and return output" to "Run Actor synchronously and return output" for the POST /actors/{actorId}/run-sync endpoint
    • Updated "Without input" to "Run Actor synchronously without input" for the GET /actors/{actorId}/run-sync endpoint
    • Updated "Run Actor synchronously with input and get dataset items" to "Run Actor synchronously and get dataset items" for the POST /actors/{actorId}/run-sync-get-dataset-items endpoint

Implementation Details

  • All changes are in the OpenAPI specification files (tags.yaml and endpoint definition files)
  • The removal of "- Introduction" suffix simplifies the documentation UI while maintaining semantic meaning through the full tag descriptions
  • Endpoint summary improvements make them more consistent and clearer about functionality

https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo

…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 jancurn changed the title Simplify API documentation tag display names docs: simplify API documentation tag display names and endpoint summaries Apr 30, 2026
@apify-service-account
Copy link
Copy Markdown

Preview for this PR was built for commit 810ae7a and is ready at https://pr-2482.preview.docs.apify.com!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants