fix: Remove undocumented APIs#531
Merged
Merged
Conversation
Bump @seamapi/blueprint to ^0.61.0 (and @seamapi/types to 1.975.0, the minimum that satisfies blueprint 0.61.0's undocumented-reference validation) and build the blueprint with the omitUndocumented option so undocumented routes, namespaces, endpoints, parameters, resources, and properties are dropped before codegen runs. The @seamapi/smith blueprint plugin does not forward omitUndocumented to createBlueprint, so smith.ts now calls createBlueprint directly. With undocumented entities already stripped from the blueprint, the manual isUndocumented filters in the route codegen are removed. This also drops undocumented resource classes and properties that the previous codegen emitted (resources were never filtered before), matching the documented API surface. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AQChf9iyLCNXNhNbfH5rB2
Bump @seamapi/blueprint and @seamapi/smith to ^1.0.0. The smith blueprint plugin now forwards omitUndocumented to createBlueprint, so smith.ts passes omitUndocumented: true to the plugin instead of calling createBlueprint directly. Generated output is unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AQChf9iyLCNXNhNbfH5rB2
razor-x
changed the title
razor-x
marked this pull request as ready for review
July 24, 2026 16: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
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
This PR removes manual filtering of undocumented routes, namespaces, endpoints, and parameters from the codegen process. Instead, the blueprint is now built with the
omitUndocumentedoption enabled, which filters out undocumented items before codegen runs.Key Changes
codegen/smith.tsto usecreateBlueprintwithomitUndocumented: trueoption instead of relying on the@seamapi/smithblueprint plugin, which doesn't support this optionisUndocumentedchecks fromcodegen/lib/routes.ts:getClients()getTopLevelClientNamespaces()to work with pre-filtered dataunmanaged_acs_access_group.rb,unmanaged_acs_credential.rb,unmanaged_acs_user.rbbridge_client_session.rb,bridge_connected_systems.rbacs_credential_pool.rb,acs_credential_provisioning_automation.rbcustomer.rb,customization_profile.rb,enrollment_automation.rbmagic_link.rb,phone_session.rb,staff_member.rblib/seam/routes/resources/index.rb@seamapi/blueprintto ^0.61.0 and@seamapi/typesto 1.975.0Implementation Details
The change centralizes undocumented item filtering at the blueprint level rather than scattering it throughout the codegen logic. This approach is cleaner and ensures consistency across all generated code, as the blueprint itself only contains documented items before codegen processes it.
https://claude.ai/code/session_01AQChf9iyLCNXNhNbfH5rB2