parser

Documentation

Index

• func Parse(spec *ogen.Spec, s Settings) (*openapi.API, error)
• type LocationError
  • func (e *LocationError) Error() string
  • func (e *LocationError) FormatError(p errors.Printer) (next error)
  • func (e *LocationError) Unwrap() error
• type Settings

Functions

func Parse

func Parse(spec *ogen.Spec, s Settings) (*openapi.API, error)

Parse parses raw Spec into

Types

type LocationError

type LocationError struct {
	// contains filtered or unexported fields
}

LocationError is a wrapper for an error that has a location.

func (*LocationError) Error

func (e *LocationError) Error() string

Error implements error.

func (*LocationError) FormatError

func (e *LocationError) FormatError(p errors.Printer) (next error)

FormatError implements errors.Formatter.

func (*LocationError) Unwrap

func (e *LocationError) Unwrap() error

Unwrap implements errors.Wrapper.

type Settings

type Settings struct {
	// External is external JSON Schema resolver. If nil, NoExternal resolver is used.
	External jsonschema.ExternalResolver

	// Filename is a name of the file being parsed.
	//
	// Used for error messages.
	Filename string

	// DepthLimit limits the number of nested references. Default is 1000.
	DepthLimit int

	// Enables type inference.
	//
	// For example:
	//
	//	{
	//		"items": {
	//			"type": "string"
	//		}
	//	}
	//
	// In that case schemaParser will handle that schema as "array" schema, because it has "items" field.
	InferTypes bool
}

Settings is parser settings.