fix: Remove undocumented APIs#589
Merged
Merged
Conversation
Build the Blueprint with the omitUndocumented option (added in @seamapi/blueprint 0.61.0) and remove the manual isUndocumented filters from the route generator. Since @seamapi/smith does not forward this option, call createBlueprint directly. Bump @seamapi/blueprint to ^0.61.0 and @seamapi/types to 1.975.0 to satisfy the stricter undocumented-reference validation added in the newer Blueprint. Applying omitUndocumented at the Blueprint level also strips undocumented resources and properties from models.py, which the route-only filters never covered. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ASErrFWD4qfnmhzYZNuwYb
razor-x
marked this pull request as ready for review
July 24, 2026 15:31
@seamapi/smith v1 forwards omitUndocumented to the Blueprint, so drop the direct createBlueprint workaround and pass the option through the smith blueprint plugin. Bump @seamapi/smith and @seamapi/blueprint to ^1.0.0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ASErrFWD4qfnmhzYZNuwYb
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 removes several undocumented model classes from the Python SDK and updates the blueprint generation to use the new
omitUndocumentedoption, which automatically filters out undocumented routes, namespaces, endpoints, and parameters before code generation.Key Changes
Model Removals
AcsCredentialPoolAcsCredentialProvisioningAutomationBridgeClientSessionBridgeConnectedSystemsCustomerCustomizationProfileEnrollmentAutomationMagicLinkPhoneSessionStaffMemberUnmanagedAcsAccessGroupUnmanagedAcsCredentialUnmanagedAcsUserField Removals from Existing Models
AcsUser: Removedlast_successful_sync_atfieldBatch: Removedcustomization_profiles,unmanaged_acs_access_groups,unmanaged_acs_credentials, andunmanaged_acs_usersfieldsConnectWebview: Removedaccepted_devicesandany_device_allowedfieldsSeamEvent: Removedenrollment_automation_idfieldSpace: Removedparent_space_idandparent_space_keyfieldsBlueprint Generation Updates
codegen/smith.tsto use the newcreateBlueprintAPI withomitUndocumented: trueoptioncodegen/lib/routes.tsby removing manual filtering logic for undocumented routes, namespaces, endpoints, and parameters since the blueprint now handles thisDependencies
@seamapi/blueprintfrom^0.59.0to^0.61.0@seamapi/typesfrom1.970.0to1.975.0Implementation Details
The blueprint generation now uses a custom
setBlueprintplugin that callscreateBlueprintwith theomitUndocumentedoption, ensuring all undocumented API elements are stripped out before the routes and models code generation runs. This eliminates the need for manual filtering throughout the codebase.https://claude.ai/code/session_01ASErrFWD4qfnmhzYZNuwYb