Text file src/github.com/go-openapi/analysis/README.md

Documentation: github.com/go-openapi/analysis

     1# OpenAPI analysis [![Build Status](https://github.com/go-openapi/analysis/actions/workflows/go-test.yml/badge.svg)](https://github.com/go-openapi/analysis/actions?query=workflow%3A"go+test") [![codecov](https://codecov.io/gh/go-openapi/analysis/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/analysis)
     2
     3[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
     4[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/analysis/master/LICENSE)
     5[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/analysis.svg)](https://pkg.go.dev/github.com/go-openapi/analysis)
     6[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/analysis)](https://goreportcard.com/report/github.com/go-openapi/analysis)
     7
     8
     9A foundational library to analyze an OAI specification document for easier reasoning about the content.
    10
    11## What's inside?
    12
    13* An analyzer providing methods to walk the functional content of a specification
    14* A spec flattener producing a self-contained document bundle, while preserving `$ref`s
    15* A spec merger ("mixin") to merge several spec documents into a primary spec
    16* A spec "fixer" ensuring that response descriptions are non empty
    17
    18[Documentation](https://pkg.go.dev/github.com/go-openapi/analysis)
    19
    20## FAQ
    21
    22* Does this library support OpenAPI 3?
    23
    24> No.
    25> This package currently only supports OpenAPI 2.0 (aka Swagger 2.0).
    26> There is no plan to make it evolve toward supporting OpenAPI 3.x.
    27> This [discussion thread](https://github.com/go-openapi/spec/issues/21) relates the full story.

View as plain text