Remove undocumented filtering from codegen, filter at blueprint creation#451
Merged
Merged
Conversation
Enable the `omitUndocumented` option when creating the blueprint so undocumented routes, endpoints, parameters, resources, events, action attempts, and properties are stripped upstream. This removes the need for the manual `isUndocumented` filters scattered throughout the codegen. Since @seamapi/smith's blueprint plugin does not forward this option, build the blueprint directly with `createBlueprint` and pass it in via Metalsmith metadata. Generated output is unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BrQiAv7j9XMWD12S9ax9Bt
razor-x
marked this pull request as ready for review
July 24, 2026 15:30
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
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 refactors the undocumented content filtering logic by moving it upstream to the blueprint creation step, rather than filtering throughout the codegen code. This simplifies the codegen by removing scattered
isUndocumentedchecks anddocumentedPropertiesfiltering calls.Key Changes
documentedPropertieshelper function that filtered out undocumented properties - this filtering now happens at blueprint creation timeisUndocumentedchecks for resources, events, and action attemptsisUndocumentedchecks for routes and endpoints, and removing parameter filteringsmith.tsto usecreateBlueprintwithomitUndocumented: trueoption, ensuring the blueprint only contains public API elements before codegen processes itImplementation Details
createBlueprintfunction from@seamapi/blueprintis now called withomitUndocumented: true, which pre-filters all undocumented resources, endpoints, parameters, and propertiesblueprintplugin to directly passing the blueprint via metadatahttps://claude.ai/code/session_01BrQiAv7j9XMWD12S9ax9Bt