analysis

A foundational library to analyze, diff, flatten, merge, and fix OAI specification documents for easier reasoning about the content.

Announcements

• 2025-12-19 : new community chat on discord
  • a new discord community channel is available to be notified of changes and support users
  • our venerable Slack channel remains open, and will be eventually discontinued on 2026-03-31

You may join the discord community by clicking the invite link on the discord badge (also above).

Or join our Slack channel:

Status

API is stable.

Import this library in your project

go get github.com/go-openapi/analysis

What's inside

• An analyzer providing methods to walk the functional content of a specification
• A spec flattener producing a self-contained document bundle, while preserving $refs
• A spec differ (“diff”) to compare two specs and report structural and compatibility changes
• A spec merger (“mixin”) to merge several spec documents into a primary spec
• A spec “fixer” ensuring that response descriptions are non empty

FAQ

• Does this library support OpenAPI 3?

No. This package currently only supports OpenAPI 2.0 (aka Swagger 2.0). There is no plan to make it evolve toward supporting OpenAPI 3.x. This discussion thread relates the full story.

Change log

See https://github.com/go-openapi/analysis/releases

Licensing

This library ships under the SPDX-License-Identifier: Apache-2.0.

Other documentation

• All-time contributors
• Contributing guidelines
• Maintainers documentation
• Code style

Cutting a new release

Maintainers can cut a new release by either:

• running this workflow
• or pushing a semver tag
  • signed tags are preferred
  • The tag message is prepended to release notes