parser

Documentation

Overview

Package parser contains the parser for OpenAPI Spec.

Index

• func Expand(api *openapi.API) (*ogen.Spec, error)
• func Parse(spec *ogen.Spec, s Settings) (_ *openapi.API, rerr error)
• type FeatureVersionError
  • func (f *FeatureVersionError) Error() string
• type LocationError
• type Settings

Functions

func Expand

func Expand(api *openapi.API) (*ogen.Spec, error)

Expand generates an expanded ogen.Spec from given api.

func Parse

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

Parse parses raw Spec into

Types

type FeatureVersionError

type FeatureVersionError struct {
	Feature string
	Minimum openapi.Version
	Actual  openapi.Version
}

FeatureVersionError is an error that is returned when a feature is used that requires a newer version of OpenAPI.

func (*FeatureVersionError) Error

func (f *FeatureVersionError) Error() string

Error implements error.

type LocationError

type LocationError = location.Error

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

type Settings

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

	// File is the file that is being parsed.
	//
	// Used for error messages.
	File location.File

	// RootURL is the root URL of the spec.
	//
	// If nil, jsonpointer.DummyURL is used.
	RootURL *url.URL

	// 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.