Topic

Documentation

4 min read

Generating an API Changelog Automatically from Spec Diffs

Quick answer: A reliable API changelog is generated by diffing two versions of the OpenAPI spec and classifying each change as breaking, non-breaking, or a deprecation, rather than maintained by

Read article
4 min read

Keeping Docs in Sync: Regenerating on Every Spec Change

Quick answer: Documentation stays accurate only when regeneration is wired into the same pipeline that changes the spec, not when it depends on a person remembering to rebuild the docs

Read article