linden123/githaven-fork
1
1
Fork 0
forked from Shiloh/githaven
Code Pull Requests Activity
7613f31c6b
githaven-fork/vendor/github.com/go-openapi/analysis/README.md
techknowlogick 47f6a4ec3f
go1.16 (#14783)
2021-02-28 18:08:33 -05:00

1.8 KiB
Vendored
Raw Blame History

OpenAPI initiative analysis

Build Status Build status codecov Slack Status license Go Reference GolangCI Go Report Card

A foundational library to analyze an OAI specification document for easier reasoning about the content.

What's inside?

  • A 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

Documentation

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.