The Octri Blog
News, guides & deep-dives
Product updates and practical writing on API documentation, SDKs, and developer experience.
Showing articles tagged #sdk.
Engineering2 min read
Your streaming API returned 200. Then it failed
An HTTP success status starts a stream; it does not prove the operation finished. Design explicit completion, interruption and recovery semantics.
Engineering2 min read
Who built this SDK? Proving package provenance from spec to registry
Connect a published SDK to its inputs and build workflow. Understand what trusted publishing and provenance establish, and what still needs review.
Engineering2 min read
Your API examples compile. Do they actually work?
Run published examples against isolated fixtures and verify their outcomes. Compilation catches only one class of documentation failure.
Engineering3 min read
202 Accepted is the beginning: designing APIs for long-running jobs
Give asynchronous work an operation handle, explicit states and a documented recovery path. Acceptance is different from completion.
Engineering2 min read
Your API's integer survived Python. JavaScript changed it
A valid JSON number is not a portable precision guarantee. Protect identifiers and decimal amounts with explicit wire contracts and cross-language tests.
Engineering2 min read
Works in Node.js. Breaks at the edge. Is your SDK portable?
Test SDK behavior against named runtimes and versions. Successful imports and familiar web APIs do not establish full runtime compatibility.
Engineering3 min read
Follow one API request from the customer's SDK to your database
Join request spans through context propagation. Understand retry attempts, database operations and trust boundaries without treating trace metadata as authorization.