parser

Documentation

Index

• type Config
• type ParseResult
  • func Parse(specPath string, cfg Config) (*ParseResult, error)

Types

type Config

type Config struct {
	AllowRemoteRefs bool
}

Config controls parser behavior.

type ParseResult

type ParseResult struct {
	Document libopenapi.Document
	Model    *v3high.Document
	Version  string
}

ParseResult holds the parsed OpenAPI document and its high-level model.

func Parse

func Parse(specPath string, cfg Config) (*ParseResult, error)

Parse reads an OpenAPI spec file and returns a parsed result.