Make generated examples compile against their advertised version
Documentation snippets refer to methods removed two releases ago.
- Focused work estimate
- 1h 30m + prerequisites
- Priority in the scenario
- Medium
- Engineering practice
- Documentation · TypeScript
Estimated field mix
- Developer tooling80%
- Quality engineering20%
Field percentages are editorial estimates of the ticket's engineering focus. They total 100%; they are not measured time, proficiency scores, or ownership evidence.
Review it, then add it to your workspace.
The board opens an editable draft; nothing is saved until you confirm it. Sign-in and workspace permissions apply, and Demo boards remain ephemeral.
Project context
A fictional partner platform publishes TypeScript clients. Generator upgrades create noisy diffs, occasional runtime mismatches, and uncertainty about which schema was packaged.
Setup prerequisites
- Create a small public API schema and two local mock server versions; use a temporary local package registry or archive files.
Preceding work
Complete these dependencies, or supply their agreed outputs before taking this ticket.
- BSDKGEN-101 · Record the exact inputs behind a generated client
- BSDKGEN-102 · Normalize schema ordering without changing semantics
- BSDKGEN-103 · Separate transport code from generated resource methods
- BSDKGEN-104 · Represent nullable and optional fields distinctly in clients
- BSDKGEN-105 · Generate errors that preserve safe machine-readable details
- BSDKGEN-107 · Test a packaged client from a clean consumer directory
Acceptance criteria
- Compile examples using the packaged client.
- Pin examples to a release identifier.
- Show credential placeholders without usable secrets.
Implementation constraints
- Examples must call the local mock service only.
Verification to include
- Run the basic read and paginated examples.
- Detect a snippet using a removed method.
Deliverables
- Executable example suite.
Rollout and recovery
Update examples together with packages; retain versioned previous examples.
Value of the work
For the engineer: Practice reproducible generation, compatibility reviews, and package provenance.
For the team: Reduce partner integration surprises with reviewable clients and recoverable releases.
Evidence boundaries
Outcome Evidence: Tests, patches, and runbooks are requested deliverables. They become Outcome Evidence only through a qualified Mission and immutable Evidence IDs.
Ownership Evidence: Independent adaptation must be observed under a declared verification policy and cite immutable Evidence IDs. Completing a planning ticket establishes no Ownership Evidence.