4.9 KiB
4.9 KiB
analysis
A foundational library to analyze an OAI specification document for easier reasoning about the content.
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 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
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