Generate SDK migration examples from packaged client versions
Migration documentation uses methods not present in the released client archive.
- Focused work estimate
- 2h 30m + prerequisites
- Priority in the scenario
- Medium
- Engineering practice
- SDK lifecycle · Documentation
Estimated field mix
- Developer tooling60%
- API design40%
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 inventory platform must replace a legacy availability response. Existing partners upgrade on different schedules, and the team needs a versioned transition.
Setup prerequisites
- Create two local API versions and synthetic partner clients with different upgrade schedules; no real partner traffic.
Preceding work
Complete these dependencies, or supply their agreed outputs before taking this ticket.
- BAPIVER-101 · Inventory breaking and additive availability-contract changes
- BAPIVER-102 · Define version selection and unsupported-version errors
- BAPIVER-103 · Keep legacy and new projections over one domain authority
- BAPIVER-104 · Use Problem Details for versioned validation failures
- BAPIVER-105 · Preserve idempotency semantics across client version upgrades
Acceptance criteria
- Compile old and new examples against local packaged clients.
- Show equivalent availability and error handling.
- Document changed optional and nullable fields.
Implementation constraints
- Use local archives and mock servers only.
Verification to include
- Run both documented examples.
- Detect a snippet importing a removed method.
Deliverables
- Executable SDK migration examples.
Rollout and recovery
Publish examples with the matching contract revision.
Value of the work
For the engineer: Practice public-contract design, compatible evolution, and client lifecycle management.
For the team: Provide a predictable migration that keeps supported integrations inspectable and recoverable.
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.