Skip to content

fix: Remove undocumented APIs#589

Merged
razor-x merged 2 commits into
mainfrom
claude/blueprint-omit-undocumented-0ordya
Jul 24, 2026
Merged

fix: Remove undocumented APIs#589
razor-x merged 2 commits into
mainfrom
claude/blueprint-omit-undocumented-0ordya

Conversation

@razor-x

@razor-x razor-x commented Jul 24, 2026

Copy link
Copy Markdown
Member

Summary

This PR removes several undocumented model classes from the Python SDK and updates the blueprint generation to use the new omitUndocumented option, which automatically filters out undocumented routes, namespaces, endpoints, and parameters before code generation.

Key Changes

Model Removals

  • Removed entirely undocumented dataclasses:
    • AcsCredentialPool
    • AcsCredentialProvisioningAutomation
    • BridgeClientSession
    • BridgeConnectedSystems
    • Customer
    • CustomizationProfile
    • EnrollmentAutomation
    • MagicLink
    • PhoneSession
    • StaffMember
    • UnmanagedAcsAccessGroup
    • UnmanagedAcsCredential
    • UnmanagedAcsUser

Field Removals from Existing Models

  • AcsUser: Removed last_successful_sync_at field
  • Batch: Removed customization_profiles, unmanaged_acs_access_groups, unmanaged_acs_credentials, and unmanaged_acs_users fields
  • ConnectWebview: Removed accepted_devices and any_device_allowed fields
  • SeamEvent: Removed enrollment_automation_id field
  • Space: Removed parent_space_id and parent_space_key fields

Blueprint Generation Updates

  • Updated codegen/smith.ts to use the new createBlueprint API with omitUndocumented: true option
  • This automatically filters undocumented items before code generation runs
  • Simplified codegen/lib/routes.ts by removing manual filtering logic for undocumented routes, namespaces, endpoints, and parameters since the blueprint now handles this

Dependencies

  • Updated @seamapi/blueprint from ^0.59.0 to ^0.61.0
  • Updated @seamapi/types from 1.970.0 to 1.975.0

Implementation Details

The blueprint generation now uses a custom setBlueprint plugin that calls createBlueprint with the omitUndocumented option, 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

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
razor-x marked this pull request as ready for review July 24, 2026 15:31
@razor-x
razor-x requested a review from a team as a code owner 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
@razor-x razor-x changed the title Remove undocumented models and update blueprint generation fix: Remove undocumented APIs Jul 24, 2026
@razor-x
razor-x merged commit f9a9ecb into main Jul 24, 2026
18 checks passed
@razor-x
razor-x deleted the claude/blueprint-omit-undocumented-0ordya branch July 24, 2026 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants