docs: simplify API documentation tag display names and endpoint summaries#2482
Draft
docs: simplify API documentation tag display names and endpoint summaries#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 |
Contributor
|
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 |
Member
Author
|
hey @TC-MO, this is a draft, please ignore until ready :) |
|
Preview for this PR was built for commit |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
x-displayNamefields across all API sections (Actors, Storage, Webhooks, Schedules, Store, Logs, Users, Tools, and convenience endpoints)/actors/{actorId}/run-syncendpoint/actors/{actorId}/run-syncendpoint/actors/{actorId}/run-sync-get-dataset-itemsendpointImplementation Details
tags.yamland endpoint definition files)https://claude.ai/code/session_01FiuLv5wqNDLtKCU4jSJpdo