Publish a bulk client example covering timeout and partial failure
Partners have only a happy-path example that treats HTTP acceptance as completion.
- Focused work estimate
- 1h 30m + prerequisites
- Priority in the scenario
- Low
- Engineering practice
- SDK design · Documentation
Estimated field mix
- Developer tooling50%
- API design50%
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 catalog API needs to accept imports too large for one synchronous request. Partners need to distinguish accepted work, completed items, and recoverable failures.
Setup prerequisites
- Create a local API and worker double with synthetic catalog records and controlled interruption points.
Preceding work
Complete these dependencies, or supply their agreed outputs before taking this ticket.
- BAPIBULK-101 · Define the difference between accepted and completed bulk work
- BAPIBULK-102 · Bound bulk request size and record counts before admission
- BAPIBULK-103 · Create bulk operations with tenant-scoped idempotency
- BAPIBULK-104 · Return per-item problems without exposing other tenant records
- BAPIBULK-105 · Checkpoint item progress without changing retry outcomes
- BAPIBULK-106 · Define cancellation after some items have committed
- BAPIBULK-107 · Paginate bulk item outcomes with stable ordering
- BAPIBULK-108 · Expose progress that does not imply unobserved completion
- BAPIBULK-109 · Choose atomic or partial bulk semantics for dependent items
Acceptance criteria
- Show admission retry with one idempotency key.
- Poll to a terminal operation state.
- Inspect item errors and retained committed results.
Implementation constraints
- Use local mock data and no credentials.
Verification to include
- Run a successful example.
- Run timeout, partial failure, and cancellation examples without duplicate submissions.
Deliverables
- Executable bulk client guide.
Rollout and recovery
Version the example with the operation contract.
Value of the work
For the engineer: Practice asynchronous resource contracts, partial outcomes, and idempotent operations.
For the team: Provide predictable bulk integration behavior without ambiguous success or repeated effects.
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.