Topic

openapi

4 min read

Detect breaking API changes in CI with OpenAPI diffs (before your customers do)

Most breaking API changes ship silently: a removed enum value, a field turned nullable, a new required parameter, a tightened status code. OpenAPI diffing in CI classifies changes as breaking or non-breaking, blocks the dangerous ones, and turns API review from memory into a checklist.

Read article
4 min read

How to document webhooks in OpenAPI 3.1 (with signatures, retries, and examples)

Webhooks are reverse APIs: your server is the client, so the documentation has to cover payloads, delivery ordering, retries, signature verification, and endpoint registration. OpenAPI 3.1 made webhooks top-level citizens — here is a complete, consumer-ready webhook definition.

Read article