openapi

Documentation

Index

• func DiscoverOpenApiSpecs(configDir string) []string
• type Operation
• type OperationResponse
• type PartialModel
  • func Parse(specFile string) (*PartialModel, error)

Functions

func DiscoverOpenApiSpecs

func DiscoverOpenApiSpecs(configDir string) []string

DiscoverOpenApiSpecs finds JSON and YAML OpenAPI specification files within the given directory. It returns fully qualified paths to the files discovered.

Types

type Operation

type Operation struct {
	// key is status code
	Responses   map[string]OperationResponse
	Description string
}

type OperationResponse

type OperationResponse struct {
	Description string

	// key is content type
	Content map[string]interface{}
}

type PartialModel

type PartialModel struct {
	// key is path
	Paths map[string]map[string]Operation
}

func Parse

func Parse(specFile string) (*PartialModel, error)