diff options
Diffstat (limited to 'vendor/github.com/go-openapi/analysis/README.md')
| -rw-r--r-- | vendor/github.com/go-openapi/analysis/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/vendor/github.com/go-openapi/analysis/README.md b/vendor/github.com/go-openapi/analysis/README.md new file mode 100644 index 000000000..aad6da10f --- /dev/null +++ b/vendor/github.com/go-openapi/analysis/README.md @@ -0,0 +1,31 @@ +# OpenAPI initiative analysis + +[](https://travis-ci.org/go-openapi/analysis) +[](https://ci.appveyor.com/project/casualjim/go-openapi/analysis/branch/master) +[](https://codecov.io/gh/go-openapi/analysis) +[](https://slackin.goswagger.io) +[](https://raw.githubusercontent.com/go-openapi/analysis/master/LICENSE) +[](https://pkg.go.dev/github.com/go-openapi/analysis) +[](https://goreportcard.com/report/github.com/go-openapi/analysis) + + +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 `$ref`s +* A spec merger ("mixin") to merge several spec documents into a primary spec +* A spec "fixer" ensuring that response descriptions are non empty + +[Documentation](https://godoc.org/github.com/go-openapi/analysis) + +## 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](https://github.com/go-openapi/spec/issues/21) relates the full story. +> |