Skip links to undocumented resources in generated API docs#1078
Closed
louis-pre wants to merge 1 commit into
Closed
Skip links to undocumented resources in generated API docs#1078louis-pre wants to merge 1 commit into
louis-pre wants to merge 1 commit into
Conversation
Check isUndocumented before generating resource links in endpoint responses. Prevents broken links to pages that don't exist because the resource namespace is undocumented (e.g., unstable_partner). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
louis-pre
force-pushed
the
fix-undocumented-resource-links
branch
from
27786f9 to
0ce3856
Compare
Member
Author
|
Not needed — fixing in @seamapi/blueprint instead. |
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
1 participant
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
Check
isUndocumentedon resources before generating links in API endpoint response sections. This prevents broken links to pages that don't exist because the resource namespace is undocumented.Fixes the
unstable_partner/building_blocksbroken link incustomers/create_portal.md— themagic_linkresource is marked as undocumented, so no page exists for it.Changes
codegen/lib/layout/api-endpoint.ts— added!responseResource.isUndocumentedcheck for both regular and batch response resource links. When a resource is undocumented, the response type is still shown but without a link.🤖 Generated with Claude Code