feat: Throw if documented endpoints reference undocumented resources#270
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
louis-pre
changed the title
Fail at build time when a documented endpoint's response references an undocumented resource type. This prevents generating broken links to pages that don't exist. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
louis-pre
force-pushed
the
throw-on-undocumented-resource-response
branch
from
bfc0079 to
4c51bbb
Compare
Picks up the documented customer_portal resource so the seam-blueprint test passes with the new validation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
louis-pre
force-pushed
the
throw-on-undocumented-resource-response
branch
from
216c0bb to
4cb8752
Compare
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
2 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
Fail at build time when a documented endpoint's response references an undocumented resource type. This prevents generating broken links to pages that don't exist in the published docs.
Context
The
customers/create_portalendpoint is documented but returns amagic_linkresource that is marked as undocumented (unstable_partner/building_blocks). The docs codegen generates a link to this resource's page, but since the resource is undocumented, no page exists — resulting in a broken link.Change
Add
assertDocumentedEndpointsDontReferenceUndocumentedResourcesvalidation that runs after blueprint creation. It checks all documented endpoints and throws if any of their response resource types are undocumented.🤖 Generated with Claude Code