Documentation
¶
Overview ¶
Package openapi3 parses and writes OpenAPI 3 specification documents.
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md
Example ¶
//go:build go1.16 // +build go1.16 package main import ( "embed" "fmt" "github.com/yaklang/yaklang/common/openapi/openapi3" "net/url" ) //go:embed testdata/recursiveRef/* var fs embed.FS func main() { loader := openapi3.NewLoader() loader.IsExternalRefsAllowed = true loader.ReadFromURIFunc = func(loader *openapi3.Loader, uri *url.URL) ([]byte, error) { return fs.ReadFile(uri.Path) } doc, err := loader.LoadFromFile("testdata/recursiveRef/openapi.yml") if err != nil { panic(err) } if err = doc.Validate(loader.Context); err != nil { panic(err) } fmt.Println(doc. Paths.Value("/foo"). Get.Responses.Value("200").Value. Content["application/json"]. Schema.Value. Properties["foo2"].Value. Properties["foo"].Value. Properties["bar"].Value. Type, ) }
Output: string
Index ¶
- Constants
- Variables
- func BoolPtr(value bool) *bool
- func DefaultRefNameResolver(ref string) string
- func DefineIPv4Format()
- func DefineIPv6Format()
- func DefineStringFormat(name string, pattern string)
- func DefineStringFormatCallback(name string, callback FormatCallback)
- func Float64Ptr(value float64) *float64
- func Int64Ptr(value int64) *int64
- func ReadFromFile(loader *Loader, location *url.URL) ([]byte, error)
- func RegisterArrayUniqueItemsChecker(fn SliceUniqueItemsChecker)
- func Uint64Ptr(value uint64) *uint64
- func ValidateIdentifier(value string) error
- func WithValidationOptions(ctx context.Context, opts ...ValidationOption) context.Context
- type AdditionalProperties
- type Callback
- func (callback Callback) JSONLookup(token string) (interface{}, error)
- func (callback *Callback) Len() int
- func (callback *Callback) Map() (m map[string]*PathItem)
- func (callback *Callback) MarshalJSON() ([]byte, error)
- func (callback *Callback) Set(key string, value *PathItem)
- func (callback *Callback) UnmarshalJSON(data []byte) (err error)
- func (callback *Callback) Validate(ctx context.Context, opts ...ValidationOption) error
- func (callback *Callback) Value(key string) *PathItem
- type CallbackRef
- func (x *CallbackRef) JSONLookup(token string) (interface{}, error)
- func (x CallbackRef) MarshalJSON() ([]byte, error)
- func (x CallbackRef) MarshalYAML() (interface{}, error)
- func (x *CallbackRef) UnmarshalJSON(data []byte) error
- func (x *CallbackRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type Callbacks
- type Components
- type Contact
- type Content
- func NewContent() Content
- func NewContentWithFormDataSchema(schema *Schema) Content
- func NewContentWithFormDataSchemaRef(schema *SchemaRef) Content
- func NewContentWithJSONSchema(schema *Schema) Content
- func NewContentWithJSONSchemaRef(schema *SchemaRef) Content
- func NewContentWithSchema(schema *Schema, consumes []string) Content
- func NewContentWithSchemaRef(schema *SchemaRef, consumes []string) Content
- type Discriminator
- type Encoding
- func (encoding Encoding) MarshalJSON() ([]byte, error)
- func (encoding *Encoding) SerializationMethod() *SerializationMethod
- func (encoding *Encoding) UnmarshalJSON(data []byte) error
- func (encoding *Encoding) Validate(ctx context.Context, opts ...ValidationOption) error
- func (encoding *Encoding) WithHeader(name string, header *Header) *Encoding
- func (encoding *Encoding) WithHeaderRef(name string, ref *HeaderRef) *Encoding
- type Example
- type ExampleRef
- func (x *ExampleRef) JSONLookup(token string) (interface{}, error)
- func (x ExampleRef) MarshalJSON() ([]byte, error)
- func (x ExampleRef) MarshalYAML() (interface{}, error)
- func (x *ExampleRef) UnmarshalJSON(data []byte) error
- func (x *ExampleRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type Examples
- type ExternalDocs
- type Format
- type FormatCallback
- type Header
- func (header Header) JSONLookup(token string) (interface{}, error)
- func (header Header) MarshalJSON() ([]byte, error)
- func (header Header) MarshalYAML() (interface{}, error)
- func (header *Header) SerializationMethod() (*SerializationMethod, error)
- func (header *Header) UnmarshalJSON(data []byte) error
- func (header *Header) Validate(ctx context.Context, opts ...ValidationOption) error
- type HeaderRef
- func (x *HeaderRef) JSONLookup(token string) (interface{}, error)
- func (x HeaderRef) MarshalJSON() ([]byte, error)
- func (x HeaderRef) MarshalYAML() (interface{}, error)
- func (x *HeaderRef) UnmarshalJSON(data []byte) error
- func (x *HeaderRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type Headers
- type Info
- type License
- type Link
- type LinkRef
- type Links
- type Loader
- func (loader *Loader) LoadFromData(data []byte) (*T, error)
- func (loader *Loader) LoadFromDataWithPath(data []byte, location *url.URL) (*T, error)
- func (loader *Loader) LoadFromFile(location string) (*T, error)
- func (loader *Loader) LoadFromStdin() (*T, error)
- func (loader *Loader) LoadFromURI(location *url.URL) (*T, error)
- func (loader *Loader) ResolveRefsIn(doc *T, location *url.URL) (err error)
- type MediaType
- func (mediaType MediaType) JSONLookup(token string) (interface{}, error)
- func (mediaType MediaType) MarshalJSON() ([]byte, error)
- func (mediaType *MediaType) UnmarshalJSON(data []byte) error
- func (mediaType *MediaType) Validate(ctx context.Context, opts ...ValidationOption) error
- func (mediaType *MediaType) WithEncoding(name string, enc *Encoding) *MediaType
- func (mediaType *MediaType) WithExample(name string, value interface{}) *MediaType
- func (mediaType *MediaType) WithSchema(schema *Schema) *MediaType
- func (mediaType *MediaType) WithSchemaRef(schema *SchemaRef) *MediaType
- type MultiError
- type NewCallbackOption
- type NewPathsOption
- type NewResponsesOption
- type OAuthFlow
- type OAuthFlows
- type Operation
- func (operation *Operation) AddParameter(p *Parameter)
- func (operation *Operation) AddResponse(status int, response *Response)
- func (operation Operation) MarshalJSON() ([]byte, error)
- func (operation *Operation) UnmarshalJSON(data []byte) error
- func (operation *Operation) Validate(ctx context.Context, opts ...ValidationOption) error
- type Parameter
- func (parameter Parameter) JSONLookup(token string) (interface{}, error)
- func (parameter Parameter) MarshalJSON() ([]byte, error)
- func (parameter *Parameter) SerializationMethod() (*SerializationMethod, error)
- func (parameter *Parameter) UnmarshalJSON(data []byte) error
- func (parameter *Parameter) Validate(ctx context.Context, opts ...ValidationOption) error
- func (parameter *Parameter) WithDescription(value string) *Parameter
- func (parameter *Parameter) WithRequired(value bool) *Parameter
- func (parameter *Parameter) WithSchema(value *Schema) *Parameter
- type ParameterRef
- func (x *ParameterRef) JSONLookup(token string) (interface{}, error)
- func (x ParameterRef) MarshalJSON() ([]byte, error)
- func (x ParameterRef) MarshalYAML() (interface{}, error)
- func (x *ParameterRef) UnmarshalJSON(data []byte) error
- func (x *ParameterRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type Parameters
- type ParametersMap
- type PathItem
- func (pathItem *PathItem) GetOperation(method string) *Operation
- func (pathItem PathItem) MarshalJSON() ([]byte, error)
- func (pathItem *PathItem) Operations() map[string]*Operation
- func (pathItem *PathItem) SetOperation(method string, operation *Operation)
- func (pathItem *PathItem) UnmarshalJSON(data []byte) error
- func (pathItem *PathItem) Validate(ctx context.Context, opts ...ValidationOption) error
- type Paths
- func (paths *Paths) Find(key string) *PathItem
- func (paths *Paths) InMatchingOrder() []string
- func (paths Paths) JSONLookup(token string) (interface{}, error)
- func (paths *Paths) Len() int
- func (paths *Paths) Map() (m map[string]*PathItem)
- func (paths *Paths) MarshalJSON() ([]byte, error)
- func (paths *Paths) Set(key string, value *PathItem)
- func (paths *Paths) UnmarshalJSON(data []byte) (err error)
- func (paths *Paths) Validate(ctx context.Context, opts ...ValidationOption) error
- func (paths *Paths) Value(key string) *PathItem
- type ReadFromURIFunc
- type Ref
- type RefNameResolver
- type RequestBodies
- type RequestBody
- func (requestBody *RequestBody) GetMediaType(mediaType string) *MediaType
- func (requestBody RequestBody) MarshalJSON() ([]byte, error)
- func (requestBody *RequestBody) UnmarshalJSON(data []byte) error
- func (requestBody *RequestBody) Validate(ctx context.Context, opts ...ValidationOption) error
- func (requestBody *RequestBody) WithContent(content Content) *RequestBody
- func (requestBody *RequestBody) WithDescription(value string) *RequestBody
- func (requestBody *RequestBody) WithFormDataSchema(value *Schema) *RequestBody
- func (requestBody *RequestBody) WithFormDataSchemaRef(value *SchemaRef) *RequestBody
- func (requestBody *RequestBody) WithJSONSchema(value *Schema) *RequestBody
- func (requestBody *RequestBody) WithJSONSchemaRef(value *SchemaRef) *RequestBody
- func (requestBody *RequestBody) WithRequired(value bool) *RequestBody
- func (requestBody *RequestBody) WithSchema(value *Schema, consumes []string) *RequestBody
- func (requestBody *RequestBody) WithSchemaRef(value *SchemaRef, consumes []string) *RequestBody
- type RequestBodyRef
- func (x *RequestBodyRef) JSONLookup(token string) (interface{}, error)
- func (x RequestBodyRef) MarshalJSON() ([]byte, error)
- func (x RequestBodyRef) MarshalYAML() (interface{}, error)
- func (x *RequestBodyRef) UnmarshalJSON(data []byte) error
- func (x *RequestBodyRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type Response
- func (response Response) MarshalJSON() ([]byte, error)
- func (response *Response) UnmarshalJSON(data []byte) error
- func (response *Response) Validate(ctx context.Context, opts ...ValidationOption) error
- func (response *Response) WithContent(content Content) *Response
- func (response *Response) WithDescription(value string) *Response
- func (response *Response) WithJSONSchema(schema *Schema) *Response
- func (response *Response) WithJSONSchemaRef(schema *SchemaRef) *Response
- type ResponseBodies
- type ResponseRef
- func (x *ResponseRef) JSONLookup(token string) (interface{}, error)
- func (x ResponseRef) MarshalJSON() ([]byte, error)
- func (x ResponseRef) MarshalYAML() (interface{}, error)
- func (x *ResponseRef) UnmarshalJSON(data []byte) error
- func (x *ResponseRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type Responses
- func (responses *Responses) Default() *ResponseRef
- func (responses Responses) JSONLookup(token string) (interface{}, error)
- func (responses *Responses) Len() int
- func (responses *Responses) Map() (m map[string]*ResponseRef)
- func (responses *Responses) MarshalJSON() ([]byte, error)
- func (responses *Responses) Set(key string, value *ResponseRef)
- func (responses *Responses) Status(status int) *ResponseRef
- func (responses *Responses) UnmarshalJSON(data []byte) (err error)
- func (responses *Responses) Validate(ctx context.Context, opts ...ValidationOption) error
- func (responses *Responses) Value(key string) *ResponseRef
- type Schema
- func NewAllOfSchema(schemas ...*Schema) *Schema
- func NewAnyOfSchema(schemas ...*Schema) *Schema
- func NewArraySchema() *Schema
- func NewBoolSchema() *Schema
- func NewBytesSchema() *Schema
- func NewDateTimeSchema() *Schema
- func NewFloat64Schema() *Schema
- func NewInt32Schema() *Schema
- func NewInt64Schema() *Schema
- func NewIntegerSchema() *Schema
- func NewObjectSchema() *Schema
- func NewOneOfSchema(schemas ...*Schema) *Schema
- func NewSchema() *Schema
- func NewStringSchema() *Schema
- func NewUUIDSchema() *Schema
- func (schema *Schema) IsEmpty() bool
- func (schema *Schema) IsMatching(value interface{}) bool
- func (schema *Schema) IsMatchingJSONArray(value []interface{}) bool
- func (schema *Schema) IsMatchingJSONBoolean(value bool) bool
- func (schema *Schema) IsMatchingJSONNumber(value float64) bool
- func (schema *Schema) IsMatchingJSONObject(value map[string]interface{}) bool
- func (schema *Schema) IsMatchingJSONString(value string) bool
- func (schema Schema) JSONLookup(token string) (interface{}, error)
- func (schema Schema) MarshalJSON() ([]byte, error)
- func (schema *Schema) NewRef() *SchemaRef
- func (schema *Schema) UnmarshalJSON(data []byte) error
- func (schema *Schema) Validate(ctx context.Context, opts ...ValidationOption) error
- func (schema *Schema) VisitJSON(value interface{}, opts ...SchemaValidationOption) error
- func (schema *Schema) VisitJSONArray(value []interface{}) error
- func (schema *Schema) VisitJSONBoolean(value bool) error
- func (schema *Schema) VisitJSONNumber(value float64) error
- func (schema *Schema) VisitJSONObject(value map[string]interface{}) error
- func (schema *Schema) VisitJSONString(value string) error
- func (schema *Schema) WithAdditionalProperties(v *Schema) *Schema
- func (schema *Schema) WithAnyAdditionalProperties() *Schema
- func (schema *Schema) WithDefault(defaultValue interface{}) *Schema
- func (schema *Schema) WithEnum(values ...interface{}) *Schema
- func (scheme *Schema) WithExample(e any) *Schema
- func (schema *Schema) WithExclusiveMax(value bool) *Schema
- func (schema *Schema) WithExclusiveMin(value bool) *Schema
- func (schema *Schema) WithFormat(value string) *Schema
- func (schema *Schema) WithItems(value *Schema) *Schema
- func (schema *Schema) WithLength(i int64) *Schema
- func (schema *Schema) WithLengthDecodedBase64(i int64) *Schema
- func (schema *Schema) WithMax(value float64) *Schema
- func (schema *Schema) WithMaxItems(i int64) *Schema
- func (schema *Schema) WithMaxLength(i int64) *Schema
- func (schema *Schema) WithMaxLengthDecodedBase64(i int64) *Schema
- func (schema *Schema) WithMaxProperties(i int64) *Schema
- func (schema *Schema) WithMin(value float64) *Schema
- func (schema *Schema) WithMinItems(i int64) *Schema
- func (schema *Schema) WithMinLength(i int64) *Schema
- func (schema *Schema) WithMinLengthDecodedBase64(i int64) *Schema
- func (schema *Schema) WithMinProperties(i int64) *Schema
- func (schema *Schema) WithNullable() *Schema
- func (schema *Schema) WithPattern(pattern string) *Schema
- func (schema *Schema) WithProperties(properties map[string]*Schema) *Schema
- func (schema *Schema) WithProperty(name string, propertySchema *Schema) *Schema
- func (schema *Schema) WithPropertyRef(name string, ref *SchemaRef) *Schema
- func (schema *Schema) WithUniqueItems(unique bool) *Schema
- func (schema *Schema) WithoutAdditionalProperties() *Schema
- type SchemaError
- type SchemaRef
- func (x *SchemaRef) JSONLookup(token string) (interface{}, error)
- func (x SchemaRef) MarshalJSON() ([]byte, error)
- func (x SchemaRef) MarshalYAML() (interface{}, error)
- func (x *SchemaRef) UnmarshalJSON(data []byte) error
- func (x *SchemaRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type SchemaRefs
- type SchemaValidationOption
- func DefaultsSet(f func()) SchemaValidationOption
- func DisablePatternValidation() SchemaValidationOption
- func DisableReadOnlyValidation() SchemaValidationOption
- func DisableWriteOnlyValidation() SchemaValidationOption
- func EnableFormatValidation() SchemaValidationOption
- func FailFast() SchemaValidationOption
- func MultiErrors() SchemaValidationOption
- func SetSchemaErrorMessageCustomizer(f func(err *SchemaError) string) SchemaValidationOption
- func VisitAsRequest() SchemaValidationOption
- func VisitAsResponse() SchemaValidationOption
- type Schemas
- type SecurityRequirement
- type SecurityRequirements
- type SecurityScheme
- func (ss SecurityScheme) MarshalJSON() ([]byte, error)
- func (ss *SecurityScheme) UnmarshalJSON(data []byte) error
- func (ss *SecurityScheme) Validate(ctx context.Context, opts ...ValidationOption) error
- func (ss *SecurityScheme) WithBearerFormat(value string) *SecurityScheme
- func (ss *SecurityScheme) WithDescription(value string) *SecurityScheme
- func (ss *SecurityScheme) WithIn(value string) *SecurityScheme
- func (ss *SecurityScheme) WithName(value string) *SecurityScheme
- func (ss *SecurityScheme) WithScheme(value string) *SecurityScheme
- func (ss *SecurityScheme) WithType(value string) *SecurityScheme
- type SecuritySchemeRef
- func (x *SecuritySchemeRef) JSONLookup(token string) (interface{}, error)
- func (x SecuritySchemeRef) MarshalJSON() ([]byte, error)
- func (x SecuritySchemeRef) MarshalYAML() (interface{}, error)
- func (x *SecuritySchemeRef) UnmarshalJSON(data []byte) error
- func (x *SecuritySchemeRef) Validate(ctx context.Context, opts ...ValidationOption) error
- type SecuritySchemes
- type SerializationMethod
- type Server
- func (server *Server) BasePath() (string, error)
- func (server Server) MarshalJSON() ([]byte, error)
- func (server Server) MatchRawURL(input string) ([]string, string, bool)
- func (server Server) ParameterNames() ([]string, error)
- func (server *Server) UnmarshalJSON(data []byte) error
- func (server *Server) Validate(ctx context.Context, opts ...ValidationOption) (err error)
- type ServerVariable
- type Servers
- type SliceUniqueItemsChecker
- type T
- func (doc *T) AddOperation(path string, method string, operation *Operation)
- func (doc *T) AddServer(server *Server)
- func (doc *T) AddServers(servers ...*Server)
- func (doc *T) InternalizeRefs(ctx context.Context, refNameResolver func(ref string) string)
- func (doc *T) JSONLookup(token string) (interface{}, error)
- func (doc T) MarshalJSON() ([]byte, error)
- func (doc *T) UnmarshalJSON(data []byte) error
- func (doc *T) Validate(ctx context.Context, opts ...ValidationOption) error
- type Tag
- type Tags
- type ValidationOption
- func AllowExtraSiblingFields(fields ...string) ValidationOption
- func DisableExamplesValidation() ValidationOption
- func DisableSchemaDefaultsValidation() ValidationOption
- func DisableSchemaFormatValidation() ValidationOption
- func DisableSchemaPatternValidation() ValidationOption
- func EnableExamplesValidation() ValidationOption
- func EnableSchemaDefaultsValidation() ValidationOption
- func EnableSchemaFormatValidation() ValidationOption
- func EnableSchemaPatternValidation() ValidationOption
- type ValidationOptions
- type XML
Examples ¶
Constants ¶
const ( ParameterInPath = "path" ParameterInQuery = "query" ParameterInHeader = "header" ParameterInCookie = "cookie" )
const ( TypeArray = "array" TypeBoolean = "boolean" TypeInteger = "integer" TypeNumber = "number" TypeObject = "object" TypeString = "string" )
const ( // FormatOfStringForUUIDOfRFC4122 is an optional predefined format for UUID v1-v5 as specified by RFC4122 FormatOfStringForUUIDOfRFC4122 = `` /* 131-byte string literal not displayed */ // FormatOfStringForEmail pattern catches only some suspiciously wrong-looking email addresses. // Use DefineStringFormat(...) if you need something stricter. FormatOfStringForEmail = `^[^@]+@[^@<>",\s]+$` )
const ( SerializationSimple = "simple" SerializationLabel = "label" SerializationMatrix = "matrix" SerializationForm = "form" SerializationSpaceDelimited = "spaceDelimited" SerializationPipeDelimited = "pipeDelimited" SerializationDeepObject = "deepObject" )
Variables ¶
var ( // SchemaErrorDetailsDisabled disables printing of details about schema errors. SchemaErrorDetailsDisabled = false // ErrOneOfConflict is the SchemaError Origin when data matches more than one oneOf schema ErrOneOfConflict = errors.New("input matches more than one oneOf schemas") // ErrSchemaInputNaN may be returned when validating a number ErrSchemaInputNaN = errors.New("floating point NaN is not allowed") // ErrSchemaInputInf may be returned when validating a number ErrSchemaInputInf = errors.New("floating point Inf is not allowed") )
var CircularReferenceCounter = 3
var CircularReferenceError = "kin-openapi bug found: circular schema reference not handled"
var DefaultReadFromURI = URIMapCache(ReadFromURIs(ReadFromHTTP(http.DefaultClient), ReadFromFile))
DefaultReadFromURI returns a caching ReadFromURIFunc which can read remote HTTP URIs and local file URIs.
var ErrURINotSupported = errors.New("unsupported URI")
ErrURINotSupported indicates the ReadFromURIFunc does not know how to handle a given URI.
var IdentifierRegExp = regexp.MustCompile(identifierPattern)
IdentifierRegExp verifies whether Component object key matches 'identifierPattern' pattern, according to OpenAPI v3.x. However, to be able supporting legacy OpenAPI v2.x, there is a need to customize above pattern in order not to fail converted v2-v3 validation
var SchemaStringFormats = make(map[string]Format, 4)
SchemaStringFormats allows for validating string formats
Functions ¶
func DefaultRefNameResolver ¶
DefaultRefResolver is a default implementation of refNameResolver for the InternalizeRefs function.
If a reference points to an element inside a document, it returns the last element in the reference using filepath.Base. Otherwise if the reference points to a file, it returns the file name trimmed of all extensions.
func DefineIPv4Format ¶
func DefineIPv4Format()
DefineIPv4Format opts in ipv4 format validation on top of OAS 3 spec
func DefineIPv6Format ¶
func DefineIPv6Format()
DefineIPv6Format opts in ipv6 format validation on top of OAS 3 spec
func DefineStringFormat ¶
DefineStringFormat defines a new regexp pattern for a given format
func DefineStringFormatCallback ¶
func DefineStringFormatCallback(name string, callback FormatCallback)
DefineStringFormatCallback adds a validation function for a specific schema format entry
func Float64Ptr ¶
Float64Ptr is a helper for defining OpenAPI schemas.
func ReadFromFile ¶
ReadFromFile is a ReadFromURIFunc which reads local file URIs.
func RegisterArrayUniqueItemsChecker ¶
func RegisterArrayUniqueItemsChecker(fn SliceUniqueItemsChecker)
RegisterArrayUniqueItemsChecker is used to register a customized function used to check if JSON array have unique items.
func ValidateIdentifier ¶
ValidateIdentifier returns an error if the given component name does not match IdentifierRegExp.
func WithValidationOptions ¶
func WithValidationOptions(ctx context.Context, opts ...ValidationOption) context.Context
WithValidationOptions allows adding validation options to a context object that can be used when validating any OpenAPI type.
Types ¶
type AdditionalProperties ¶
func (AdditionalProperties) MarshalJSON ¶
func (addProps AdditionalProperties) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of AdditionalProperties.
func (*AdditionalProperties) UnmarshalJSON ¶
func (addProps *AdditionalProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON sets AdditionalProperties to a copy of data.
type Callback ¶
type Callback struct { Extensions map[string]interface{} `json:"-" yaml:"-"` // contains filtered or unexported fields }
Callback is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#callback-object
func NewCallback ¶
func NewCallback(opts ...NewCallbackOption) *Callback
NewCallback builds a Callback object with path items in insertion order.
func NewCallbackWithCapacity ¶
NewCallbackWithCapacity builds a callback object of the given capacity.
func (Callback) JSONLookup ¶
JSONLookup implements https://github.com/go-openapi/jsonpointer#JSONPointable
func (*Callback) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Callback.
func (*Callback) Set ¶
Set adds or replaces key 'key' of 'callback' with 'value'. Note: 'callback' MUST be non-nil
func (*Callback) UnmarshalJSON ¶
UnmarshalJSON sets Callback to a copy of data.
type CallbackRef ¶
CallbackRef represents either a Callback or a $ref to a Callback. When serializing and both fields are set, Ref is preferred over Value.
func (*CallbackRef) JSONLookup ¶
func (x *CallbackRef) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (CallbackRef) MarshalJSON ¶
func (x CallbackRef) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of CallbackRef.
func (CallbackRef) MarshalYAML ¶
func (x CallbackRef) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML encoding of CallbackRef.
func (*CallbackRef) UnmarshalJSON ¶
func (x *CallbackRef) UnmarshalJSON(data []byte) error
UnmarshalJSON sets CallbackRef to a copy of data.
func (*CallbackRef) Validate ¶
func (x *CallbackRef) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if CallbackRef does not comply with the OpenAPI spec.
type Callbacks ¶
type Callbacks map[string]*CallbackRef
func (Callbacks) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type Components ¶
type Components struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Schemas Schemas `json:"schemas,omitempty" yaml:"schemas,omitempty"` Parameters ParametersMap `json:"parameters,omitempty" yaml:"parameters,omitempty"` Headers Headers `json:"headers,omitempty" yaml:"headers,omitempty"` RequestBodies RequestBodies `json:"requestBodies,omitempty" yaml:"requestBodies,omitempty"` Responses ResponseBodies `json:"responses,omitempty" yaml:"responses,omitempty"` SecuritySchemes SecuritySchemes `json:"securitySchemes,omitempty" yaml:"securitySchemes,omitempty"` Examples Examples `json:"examples,omitempty" yaml:"examples,omitempty"` Links Links `json:"links,omitempty" yaml:"links,omitempty"` Callbacks Callbacks `json:"callbacks,omitempty" yaml:"callbacks,omitempty"` }
Components is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#components-object
func NewComponents ¶
func NewComponents() Components
func (Components) MarshalJSON ¶
func (components Components) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of Components.
func (*Components) UnmarshalJSON ¶
func (components *Components) UnmarshalJSON(data []byte) error
UnmarshalJSON sets Components to a copy of data.
func (*Components) Validate ¶
func (components *Components) Validate(ctx context.Context, opts ...ValidationOption) (err error)
Validate returns an error if Components does not comply with the OpenAPI spec.
type Contact ¶
type Contact struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Name string `json:"name,omitempty" yaml:"name,omitempty"` URL string `json:"url,omitempty" yaml:"url,omitempty"` Email string `json:"email,omitempty" yaml:"email,omitempty"` }
Contact is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#contact-object
func (Contact) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Contact.
func (*Contact) UnmarshalJSON ¶
UnmarshalJSON sets Contact to a copy of data.
type Content ¶
Content is specified by OpenAPI/Swagger 3.0 standard.
func NewContent ¶
func NewContent() Content
func NewContentWithSchema ¶
func NewContentWithSchemaRef ¶
type Discriminator ¶
type Discriminator struct { Extensions map[string]interface{} `json:"-" yaml:"-"` PropertyName string `json:"propertyName" yaml:"propertyName"` // required Mapping map[string]string `json:"mapping,omitempty" yaml:"mapping,omitempty"` }
Discriminator is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object
func (Discriminator) MarshalJSON ¶
func (discriminator Discriminator) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of Discriminator.
func (*Discriminator) UnmarshalJSON ¶
func (discriminator *Discriminator) UnmarshalJSON(data []byte) error
UnmarshalJSON sets Discriminator to a copy of data.
func (*Discriminator) Validate ¶
func (discriminator *Discriminator) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Discriminator does not comply with the OpenAPI spec.
type Encoding ¶
type Encoding struct { Extensions map[string]interface{} `json:"-" yaml:"-"` ContentType string `json:"contentType,omitempty" yaml:"contentType,omitempty"` Headers Headers `json:"headers,omitempty" yaml:"headers,omitempty"` Style string `json:"style,omitempty" yaml:"style,omitempty"` Explode *bool `json:"explode,omitempty" yaml:"explode,omitempty"` AllowReserved bool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"` }
Encoding is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#encoding-object
func NewEncoding ¶
func NewEncoding() *Encoding
func (Encoding) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Encoding.
func (*Encoding) SerializationMethod ¶
func (encoding *Encoding) SerializationMethod() *SerializationMethod
SerializationMethod returns a serialization method of request body. When serialization method is not defined the method returns the default serialization method.
func (*Encoding) UnmarshalJSON ¶
UnmarshalJSON sets Encoding to a copy of data.
func (*Encoding) Validate ¶
func (encoding *Encoding) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Encoding does not comply with the OpenAPI spec.
func (*Encoding) WithHeader ¶
type Example ¶
type Example struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Summary string `json:"summary,omitempty" yaml:"summary,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Value interface{} `json:"value,omitempty" yaml:"value,omitempty"` ExternalValue string `json:"externalValue,omitempty" yaml:"externalValue,omitempty"` }
Example is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#example-object
func NewExample ¶
func NewExample(value interface{}) *Example
func (Example) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Example.
func (*Example) UnmarshalJSON ¶
UnmarshalJSON sets Example to a copy of data.
type ExampleRef ¶
ExampleRef represents either a Example or a $ref to a Example. When serializing and both fields are set, Ref is preferred over Value.
func (*ExampleRef) JSONLookup ¶
func (x *ExampleRef) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (ExampleRef) MarshalJSON ¶
func (x ExampleRef) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of ExampleRef.
func (ExampleRef) MarshalYAML ¶
func (x ExampleRef) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML encoding of ExampleRef.
func (*ExampleRef) UnmarshalJSON ¶
func (x *ExampleRef) UnmarshalJSON(data []byte) error
UnmarshalJSON sets ExampleRef to a copy of data.
func (*ExampleRef) Validate ¶
func (x *ExampleRef) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if ExampleRef does not comply with the OpenAPI spec.
type Examples ¶
type Examples map[string]*ExampleRef
func (Examples) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type ExternalDocs ¶
type ExternalDocs struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Description string `json:"description,omitempty" yaml:"description,omitempty"` URL string `json:"url,omitempty" yaml:"url,omitempty"` }
ExternalDocs is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#external-documentation-object
func (ExternalDocs) MarshalJSON ¶
func (e ExternalDocs) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of ExternalDocs.
func (*ExternalDocs) UnmarshalJSON ¶
func (e *ExternalDocs) UnmarshalJSON(data []byte) error
UnmarshalJSON sets ExternalDocs to a copy of data.
func (*ExternalDocs) Validate ¶
func (e *ExternalDocs) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if ExternalDocs does not comply with the OpenAPI spec.
type Format ¶
type Format struct {
// contains filtered or unexported fields
}
Format represents a format validator registered by either DefineStringFormat or DefineStringFormatCallback
type FormatCallback ¶
FormatCallback performs custom checks on exotic formats
type Header ¶
type Header struct {
Parameter
}
Header is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#header-object
func (Header) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (Header) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Header.
func (Header) MarshalYAML ¶
MarshalYAML returns the JSON encoding of Header.
func (*Header) SerializationMethod ¶
func (header *Header) SerializationMethod() (*SerializationMethod, error)
SerializationMethod returns a header's serialization method.
func (*Header) UnmarshalJSON ¶
UnmarshalJSON sets Header to a copy of data.
type HeaderRef ¶
HeaderRef represents either a Header or a $ref to a Header. When serializing and both fields are set, Ref is preferred over Value.
func (*HeaderRef) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (HeaderRef) MarshalJSON ¶
MarshalJSON returns the JSON encoding of HeaderRef.
func (HeaderRef) MarshalYAML ¶
MarshalYAML returns the YAML encoding of HeaderRef.
func (*HeaderRef) UnmarshalJSON ¶
UnmarshalJSON sets HeaderRef to a copy of data.
type Headers ¶
func (Headers) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type Info ¶
type Info struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Title string `json:"title" yaml:"title"` // Required Description string `json:"description,omitempty" yaml:"description,omitempty"` TermsOfService string `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"` Contact *Contact `json:"contact,omitempty" yaml:"contact,omitempty"` License *License `json:"license,omitempty" yaml:"license,omitempty"` Version string `json:"version" yaml:"version"` // Required }
Info is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#info-object
func (Info) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Info.
func (*Info) UnmarshalJSON ¶
UnmarshalJSON sets Info to a copy of data.
type License ¶
type License struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Name string `json:"name" yaml:"name"` // Required URL string `json:"url,omitempty" yaml:"url,omitempty"` }
License is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#license-object
func (License) MarshalJSON ¶
MarshalJSON returns the JSON encoding of License.
func (*License) UnmarshalJSON ¶
UnmarshalJSON sets License to a copy of data.
type Link ¶
type Link struct { Extensions map[string]interface{} `json:"-" yaml:"-"` OperationRef string `json:"operationRef,omitempty" yaml:"operationRef,omitempty"` OperationID string `json:"operationId,omitempty" yaml:"operationId,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` Server *Server `json:"server,omitempty" yaml:"server,omitempty"` RequestBody interface{} `json:"requestBody,omitempty" yaml:"requestBody,omitempty"` }
Link is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object
func (Link) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Link.
func (*Link) UnmarshalJSON ¶
UnmarshalJSON sets Link to a copy of data.
type LinkRef ¶
LinkRef represents either a Link or a $ref to a Link. When serializing and both fields are set, Ref is preferred over Value.
func (*LinkRef) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (LinkRef) MarshalJSON ¶
MarshalJSON returns the JSON encoding of LinkRef.
func (LinkRef) MarshalYAML ¶
MarshalYAML returns the YAML encoding of LinkRef.
func (*LinkRef) UnmarshalJSON ¶
UnmarshalJSON sets LinkRef to a copy of data.
type Links ¶
func (Links) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type Loader ¶
type Loader struct { // IsExternalRefsAllowed enables visiting other files IsExternalRefsAllowed bool // ReadFromURIFunc allows overriding the any file/URL reading func ReadFromURIFunc ReadFromURIFunc Context context.Context // contains filtered or unexported fields }
Loader helps deserialize an OpenAPIv3 document
Example ¶
spec := []byte(` openapi: 3.0.1 paths: {} info: version: 1.1.1 title: title description: An API `[1:]) loader := NewLoader() doc, err := loader.LoadFromData(spec) if err != nil { panic(err) } if err := doc.Validate(loader.Context); err != nil { panic(err) } fmt.Print(doc.Info.Description)
Output: An API
func (*Loader) LoadFromData ¶
LoadFromData loads a spec from a byte array
func (*Loader) LoadFromDataWithPath ¶
LoadFromDataWithPath takes the OpenAPI document data in bytes and a path where the resolver can find referred elements and returns a *T with all resolved data or an error if unable to load data or resolve refs.
func (*Loader) LoadFromFile ¶
LoadFromFile loads a spec from a local file path
func (*Loader) LoadFromStdin ¶
LoadFromStdin loads a spec from stdin
func (*Loader) LoadFromURI ¶
LoadFromURI loads a spec from a remote URL
type MediaType ¶
type MediaType struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Schema *SchemaRef `json:"schema,omitempty" yaml:"schema,omitempty"` Example interface{} `json:"example,omitempty" yaml:"example,omitempty"` Examples Examples `json:"examples,omitempty" yaml:"examples,omitempty"` Encoding map[string]*Encoding `json:"encoding,omitempty" yaml:"encoding,omitempty"` }
MediaType is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#media-type-object
func NewMediaType ¶
func NewMediaType() *MediaType
func (MediaType) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (MediaType) MarshalJSON ¶
MarshalJSON returns the JSON encoding of MediaType.
func (*MediaType) UnmarshalJSON ¶
UnmarshalJSON sets MediaType to a copy of data.
func (*MediaType) Validate ¶
func (mediaType *MediaType) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if MediaType does not comply with the OpenAPI spec.
func (*MediaType) WithEncoding ¶
func (*MediaType) WithExample ¶
func (*MediaType) WithSchema ¶
func (*MediaType) WithSchemaRef ¶
type MultiError ¶
type MultiError []error
MultiError is a collection of errors, intended for when multiple issues need to be reported upstream
func (MultiError) As ¶
func (me MultiError) As(target interface{}) bool
As allows you to use `errors.As()` to set target to the first error within the multi error that matches the target type
func (MultiError) Error ¶
func (me MultiError) Error() string
func (MultiError) Is ¶
func (me MultiError) Is(target error) bool
Is allows you to determine if a generic error is in fact a MultiError using `errors.Is()` It will also return true if any of the contained errors match target
type NewCallbackOption ¶
type NewCallbackOption func(*Callback)
NewCallbackOption describes options to NewCallback func
func WithCallback ¶
func WithCallback(cb string, pathItem *PathItem) NewCallbackOption
WithCallback adds Callback as an option to NewCallback
type NewPathsOption ¶
type NewPathsOption func(*Paths)
NewPathsOption describes options to NewPaths func
func WithPath ¶
func WithPath(path string, pathItem *PathItem) NewPathsOption
WithPath adds a named path item
type NewResponsesOption ¶
type NewResponsesOption func(*Responses)
NewResponsesOption describes options to NewResponses func
func WithName ¶
func WithName(name string, response *Response) NewResponsesOption
WithName adds a name-keyed Response
func WithStatus ¶
func WithStatus(status int, responseRef *ResponseRef) NewResponsesOption
WithStatus adds a status code keyed ResponseRef
type OAuthFlow ¶
type OAuthFlow struct { Extensions map[string]interface{} `json:"-" yaml:"-"` AuthorizationURL string `json:"authorizationUrl,omitempty" yaml:"authorizationUrl,omitempty"` TokenURL string `json:"tokenUrl,omitempty" yaml:"tokenUrl,omitempty"` RefreshURL string `json:"refreshUrl,omitempty" yaml:"refreshUrl,omitempty"` Scopes map[string]string `json:"scopes" yaml:"scopes"` // required }
OAuthFlow is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flow-object
func (OAuthFlow) MarshalJSON ¶
MarshalJSON returns the JSON encoding of OAuthFlow.
func (*OAuthFlow) UnmarshalJSON ¶
UnmarshalJSON sets OAuthFlow to a copy of data.
type OAuthFlows ¶
type OAuthFlows struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Implicit *OAuthFlow `json:"implicit,omitempty" yaml:"implicit,omitempty"` Password *OAuthFlow `json:"password,omitempty" yaml:"password,omitempty"` ClientCredentials *OAuthFlow `json:"clientCredentials,omitempty" yaml:"clientCredentials,omitempty"` AuthorizationCode *OAuthFlow `json:"authorizationCode,omitempty" yaml:"authorizationCode,omitempty"` }
OAuthFlows is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object
func (OAuthFlows) MarshalJSON ¶
func (flows OAuthFlows) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of OAuthFlows.
func (*OAuthFlows) UnmarshalJSON ¶
func (flows *OAuthFlows) UnmarshalJSON(data []byte) error
UnmarshalJSON sets OAuthFlows to a copy of data.
func (*OAuthFlows) Validate ¶
func (flows *OAuthFlows) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if OAuthFlows does not comply with the OpenAPI spec.
type Operation ¶
type Operation struct { Extensions map[string]interface{} `json:"-" yaml:"-"` // Optional tags for documentation. Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"` // Optional short summary. Summary string `json:"summary,omitempty" yaml:"summary,omitempty"` // Optional description. Should use CommonMark syntax. Description string `json:"description,omitempty" yaml:"description,omitempty"` // Optional operation ID. OperationID string `json:"operationId,omitempty" yaml:"operationId,omitempty"` // Optional parameters. Parameters Parameters `json:"parameters,omitempty" yaml:"parameters,omitempty"` // Optional body parameter. RequestBody *RequestBodyRef `json:"requestBody,omitempty" yaml:"requestBody,omitempty"` // Responses. Responses *Responses `json:"responses" yaml:"responses"` // Required // Optional callbacks Callbacks Callbacks `json:"callbacks,omitempty" yaml:"callbacks,omitempty"` Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"` // Optional security requirements that overrides top-level security. Security *SecurityRequirements `json:"security,omitempty" yaml:"security,omitempty"` // Optional servers that overrides top-level servers. Servers *Servers `json:"servers,omitempty" yaml:"servers,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` }
Operation represents "operation" specified by" OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object
func NewOperation ¶
func NewOperation() *Operation
func (*Operation) AddParameter ¶
func (*Operation) AddResponse ¶
func (Operation) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Operation.
func (*Operation) UnmarshalJSON ¶
UnmarshalJSON sets Operation to a copy of data.
type Parameter ¶
type Parameter struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Name string `json:"name,omitempty" yaml:"name,omitempty"` In string `json:"in,omitempty" yaml:"in,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Style string `json:"style,omitempty" yaml:"style,omitempty"` Explode *bool `json:"explode,omitempty" yaml:"explode,omitempty"` AllowEmptyValue bool `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"` AllowReserved bool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"` Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"` Required bool `json:"required,omitempty" yaml:"required,omitempty"` Schema *SchemaRef `json:"schema,omitempty" yaml:"schema,omitempty"` Example interface{} `json:"example,omitempty" yaml:"example,omitempty"` Examples Examples `json:"examples,omitempty" yaml:"examples,omitempty"` Content Content `json:"content,omitempty" yaml:"content,omitempty"` }
Parameter is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object
func NewCookieParameter ¶
func NewHeaderParameter ¶
func NewPathParameter ¶
func NewQueryParameter ¶
func (Parameter) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (Parameter) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Parameter.
func (*Parameter) SerializationMethod ¶
func (parameter *Parameter) SerializationMethod() (*SerializationMethod, error)
SerializationMethod returns a parameter's serialization method. When a parameter's serialization method is not defined the method returns the default serialization method corresponding to a parameter's location.
func (*Parameter) UnmarshalJSON ¶
UnmarshalJSON sets Parameter to a copy of data.
func (*Parameter) Validate ¶
func (parameter *Parameter) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Parameter does not comply with the OpenAPI spec.
func (*Parameter) WithDescription ¶
func (*Parameter) WithRequired ¶
func (*Parameter) WithSchema ¶
type ParameterRef ¶
ParameterRef represents either a Parameter or a $ref to a Parameter. When serializing and both fields are set, Ref is preferred over Value.
func (*ParameterRef) JSONLookup ¶
func (x *ParameterRef) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (ParameterRef) MarshalJSON ¶
func (x ParameterRef) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of ParameterRef.
func (ParameterRef) MarshalYAML ¶
func (x ParameterRef) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML encoding of ParameterRef.
func (*ParameterRef) UnmarshalJSON ¶
func (x *ParameterRef) UnmarshalJSON(data []byte) error
UnmarshalJSON sets ParameterRef to a copy of data.
func (*ParameterRef) Validate ¶
func (x *ParameterRef) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if ParameterRef does not comply with the OpenAPI spec.
type Parameters ¶
type Parameters []*ParameterRef
Parameters is specified by OpenAPI/Swagger 3.0 standard.
func NewParameters ¶
func NewParameters() Parameters
func (Parameters) GetByInAndName ¶
func (parameters Parameters) GetByInAndName(in string, name string) *Parameter
func (Parameters) JSONLookup ¶
func (p Parameters) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (Parameters) Validate ¶
func (parameters Parameters) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Parameters does not comply with the OpenAPI spec.
type ParametersMap ¶
type ParametersMap map[string]*ParameterRef
func (ParametersMap) JSONLookup ¶
func (m ParametersMap) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type PathItem ¶
type PathItem struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"` Summary string `json:"summary,omitempty" yaml:"summary,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Connect *Operation `json:"connect,omitempty" yaml:"connect,omitempty"` Delete *Operation `json:"delete,omitempty" yaml:"delete,omitempty"` Get *Operation `json:"get,omitempty" yaml:"get,omitempty"` Head *Operation `json:"head,omitempty" yaml:"head,omitempty"` Options *Operation `json:"options,omitempty" yaml:"options,omitempty"` Patch *Operation `json:"patch,omitempty" yaml:"patch,omitempty"` Post *Operation `json:"post,omitempty" yaml:"post,omitempty"` Put *Operation `json:"put,omitempty" yaml:"put,omitempty"` Trace *Operation `json:"trace,omitempty" yaml:"trace,omitempty"` Servers Servers `json:"servers,omitempty" yaml:"servers,omitempty"` Parameters Parameters `json:"parameters,omitempty" yaml:"parameters,omitempty"` }
PathItem is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object
func (*PathItem) GetOperation ¶
func (PathItem) MarshalJSON ¶
MarshalJSON returns the JSON encoding of PathItem.
func (*PathItem) Operations ¶
func (*PathItem) SetOperation ¶
func (*PathItem) UnmarshalJSON ¶
UnmarshalJSON sets PathItem to a copy of data.
type Paths ¶
type Paths struct { Extensions map[string]interface{} `json:"-" yaml:"-"` // contains filtered or unexported fields }
Paths is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#paths-object
func NewPaths ¶
func NewPaths(opts ...NewPathsOption) *Paths
NewPaths builds a paths object with path items in insertion order.
func NewPathsWithCapacity ¶
NewPathsWithCapacity builds a paths object of the given capacity.
func (*Paths) Find ¶
Find returns a path that matches the key.
The method ignores differences in template variable names (except possible "*" suffix).
For example:
paths := openapi3.Paths { "/person/{personName}": &openapi3.PathItem{}, } pathItem := path.Find("/person/{name}")
would return the correct path item.
func (*Paths) InMatchingOrder ¶
InMatchingOrder returns paths in the order they are matched against URLs. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#paths-object When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts.
func (Paths) JSONLookup ¶
JSONLookup implements https://github.com/go-openapi/jsonpointer#JSONPointable
func (*Paths) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Paths.
func (*Paths) Set ¶
Set adds or replaces key 'key' of 'paths' with 'value'. Note: 'paths' MUST be non-nil
func (*Paths) UnmarshalJSON ¶
UnmarshalJSON sets Paths to a copy of data.
type ReadFromURIFunc ¶
ReadFromURIFunc defines a function which reads the contents of a resource located at a URI.
func ReadFromHTTP ¶
func ReadFromHTTP(cl *http.Client) ReadFromURIFunc
ReadFromHTTP returns a ReadFromURIFunc which uses the given http.Client to read the contents from a remote HTTP URI. This client may be customized to implement timeouts, RFC 7234 caching, etc.
func ReadFromURIs ¶
func ReadFromURIs(readers ...ReadFromURIFunc) ReadFromURIFunc
ReadFromURIs returns a ReadFromURIFunc which tries to read a URI using the given reader functions, in the same order. If a reader function does not support the URI and returns ErrURINotSupported, the next function is checked until a match is found, or the URI is not supported by any.
func URIMapCache ¶
func URIMapCache(reader ReadFromURIFunc) ReadFromURIFunc
URIMapCache returns a ReadFromURIFunc that caches the contents read from URI locations in a simple map. This cache implementation is suitable for short-lived processes such as command-line tools which process OpenAPI documents.
type Ref ¶
type Ref struct {
Ref string `json:"$ref" yaml:"$ref"`
}
Ref is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#reference-object
type RefNameResolver ¶
type RequestBodies ¶
type RequestBodies map[string]*RequestBodyRef
func (RequestBodies) JSONLookup ¶
func (m RequestBodies) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type RequestBody ¶
type RequestBody struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Required bool `json:"required,omitempty" yaml:"required,omitempty"` Content Content `json:"content" yaml:"content"` }
RequestBody is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object
func NewRequestBody ¶
func NewRequestBody() *RequestBody
func (*RequestBody) GetMediaType ¶
func (requestBody *RequestBody) GetMediaType(mediaType string) *MediaType
func (RequestBody) MarshalJSON ¶
func (requestBody RequestBody) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of RequestBody.
func (*RequestBody) UnmarshalJSON ¶
func (requestBody *RequestBody) UnmarshalJSON(data []byte) error
UnmarshalJSON sets RequestBody to a copy of data.
func (*RequestBody) Validate ¶
func (requestBody *RequestBody) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if RequestBody does not comply with the OpenAPI spec.
func (*RequestBody) WithContent ¶
func (requestBody *RequestBody) WithContent(content Content) *RequestBody
func (*RequestBody) WithDescription ¶
func (requestBody *RequestBody) WithDescription(value string) *RequestBody
func (*RequestBody) WithFormDataSchema ¶
func (requestBody *RequestBody) WithFormDataSchema(value *Schema) *RequestBody
func (*RequestBody) WithFormDataSchemaRef ¶
func (requestBody *RequestBody) WithFormDataSchemaRef(value *SchemaRef) *RequestBody
func (*RequestBody) WithJSONSchema ¶
func (requestBody *RequestBody) WithJSONSchema(value *Schema) *RequestBody
func (*RequestBody) WithJSONSchemaRef ¶
func (requestBody *RequestBody) WithJSONSchemaRef(value *SchemaRef) *RequestBody
func (*RequestBody) WithRequired ¶
func (requestBody *RequestBody) WithRequired(value bool) *RequestBody
func (*RequestBody) WithSchema ¶
func (requestBody *RequestBody) WithSchema(value *Schema, consumes []string) *RequestBody
func (*RequestBody) WithSchemaRef ¶
func (requestBody *RequestBody) WithSchemaRef(value *SchemaRef, consumes []string) *RequestBody
type RequestBodyRef ¶
type RequestBodyRef struct { Ref string Value *RequestBody // contains filtered or unexported fields }
RequestBodyRef represents either a RequestBody or a $ref to a RequestBody. When serializing and both fields are set, Ref is preferred over Value.
func (*RequestBodyRef) JSONLookup ¶
func (x *RequestBodyRef) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (RequestBodyRef) MarshalJSON ¶
func (x RequestBodyRef) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of RequestBodyRef.
func (RequestBodyRef) MarshalYAML ¶
func (x RequestBodyRef) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML encoding of RequestBodyRef.
func (*RequestBodyRef) UnmarshalJSON ¶
func (x *RequestBodyRef) UnmarshalJSON(data []byte) error
UnmarshalJSON sets RequestBodyRef to a copy of data.
func (*RequestBodyRef) Validate ¶
func (x *RequestBodyRef) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if RequestBodyRef does not comply with the OpenAPI spec.
type Response ¶
type Response struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Description *string `json:"description,omitempty" yaml:"description,omitempty"` Headers Headers `json:"headers,omitempty" yaml:"headers,omitempty"` Content Content `json:"content,omitempty" yaml:"content,omitempty"` Links Links `json:"links,omitempty" yaml:"links,omitempty"` }
Response is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#response-object
func NewResponse ¶
func NewResponse() *Response
func (Response) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Response.
func (*Response) UnmarshalJSON ¶
UnmarshalJSON sets Response to a copy of data.
func (*Response) Validate ¶
func (response *Response) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Response does not comply with the OpenAPI spec.
func (*Response) WithContent ¶
func (*Response) WithDescription ¶
func (*Response) WithJSONSchema ¶
func (*Response) WithJSONSchemaRef ¶
type ResponseBodies ¶
type ResponseBodies map[string]*ResponseRef
func (ResponseBodies) JSONLookup ¶
func (m ResponseBodies) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type ResponseRef ¶
ResponseRef represents either a Response or a $ref to a Response. When serializing and both fields are set, Ref is preferred over Value.
func (*ResponseRef) JSONLookup ¶
func (x *ResponseRef) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (ResponseRef) MarshalJSON ¶
func (x ResponseRef) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of ResponseRef.
func (ResponseRef) MarshalYAML ¶
func (x ResponseRef) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML encoding of ResponseRef.
func (*ResponseRef) UnmarshalJSON ¶
func (x *ResponseRef) UnmarshalJSON(data []byte) error
UnmarshalJSON sets ResponseRef to a copy of data.
func (*ResponseRef) Validate ¶
func (x *ResponseRef) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if ResponseRef does not comply with the OpenAPI spec.
type Responses ¶
type Responses struct { Extensions map[string]interface{} `json:"-" yaml:"-"` // contains filtered or unexported fields }
Responses is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#responses-object
func NewResponses ¶
func NewResponses(opts ...NewResponsesOption) *Responses
NewResponses builds a responses object with response objects in insertion order. Given no arguments, NewResponses returns a valid responses object containing a default match-all reponse.
func NewResponsesWithCapacity ¶
NewResponsesWithCapacity builds a responses object of the given capacity.
func (*Responses) Default ¶
func (responses *Responses) Default() *ResponseRef
Default returns the default response
func (Responses) JSONLookup ¶
JSONLookup implements https://github.com/go-openapi/jsonpointer#JSONPointable
func (*Responses) Map ¶
func (responses *Responses) Map() (m map[string]*ResponseRef)
Map returns responses as a 'map'. Note: iteration on Go maps is not ordered.
func (*Responses) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Responses.
func (*Responses) Set ¶
func (responses *Responses) Set(key string, value *ResponseRef)
Set adds or replaces key 'key' of 'responses' with 'value'. Note: 'responses' MUST be non-nil
func (*Responses) Status ¶
func (responses *Responses) Status(status int) *ResponseRef
Status returns a ResponseRef for the given status If an exact match isn't initially found a patterned field is checked using the first digit to determine the range (eg: 201 to 2XX) See https://spec.openapis.org/oas/v3.0.3#patterned-fields-0
func (*Responses) UnmarshalJSON ¶
UnmarshalJSON sets Responses to a copy of data.
func (*Responses) Validate ¶
func (responses *Responses) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Responses does not comply with the OpenAPI spec.
func (*Responses) Value ¶
func (responses *Responses) Value(key string) *ResponseRef
Value returns the responses for key or nil
type Schema ¶
type Schema struct { Extensions map[string]interface{} `json:"-" yaml:"-"` OneOf SchemaRefs `json:"oneOf,omitempty" yaml:"oneOf,omitempty"` AnyOf SchemaRefs `json:"anyOf,omitempty" yaml:"anyOf,omitempty"` AllOf SchemaRefs `json:"allOf,omitempty" yaml:"allOf,omitempty"` Not *SchemaRef `json:"not,omitempty" yaml:"not,omitempty"` Type string `json:"type,omitempty" yaml:"type,omitempty"` Title string `json:"title,omitempty" yaml:"title,omitempty"` Format string `json:"format,omitempty" yaml:"format,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Enum []interface{} `json:"enum,omitempty" yaml:"enum,omitempty"` Default interface{} `json:"default,omitempty" yaml:"default,omitempty"` Example interface{} `json:"example,omitempty" yaml:"example,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` // Array-related, here for struct compactness UniqueItems bool `json:"uniqueItems,omitempty" yaml:"uniqueItems,omitempty"` // Number-related, here for struct compactness ExclusiveMin bool `json:"exclusiveMinimum,omitempty" yaml:"exclusiveMinimum,omitempty"` ExclusiveMax bool `json:"exclusiveMaximum,omitempty" yaml:"exclusiveMaximum,omitempty"` // Properties Nullable bool `json:"nullable,omitempty" yaml:"nullable,omitempty"` ReadOnly bool `json:"readOnly,omitempty" yaml:"readOnly,omitempty"` WriteOnly bool `json:"writeOnly,omitempty" yaml:"writeOnly,omitempty"` AllowEmptyValue bool `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"` Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"` XML *XML `json:"xml,omitempty" yaml:"xml,omitempty"` // Number Min *float64 `json:"minimum,omitempty" yaml:"minimum,omitempty"` Max *float64 `json:"maximum,omitempty" yaml:"maximum,omitempty"` MultipleOf *float64 `json:"multipleOf,omitempty" yaml:"multipleOf,omitempty"` // String MinLength uint64 `json:"minLength,omitempty" yaml:"minLength,omitempty"` MaxLength *uint64 `json:"maxLength,omitempty" yaml:"maxLength,omitempty"` Pattern string `json:"pattern,omitempty" yaml:"pattern,omitempty"` // Array MinItems uint64 `json:"minItems,omitempty" yaml:"minItems,omitempty"` MaxItems *uint64 `json:"maxItems,omitempty" yaml:"maxItems,omitempty"` Items *SchemaRef `json:"items,omitempty" yaml:"items,omitempty"` // Object Required []string `json:"required,omitempty" yaml:"required,omitempty"` Properties Schemas `json:"properties,omitempty" yaml:"properties,omitempty"` MinProps uint64 `json:"minProperties,omitempty" yaml:"minProperties,omitempty"` MaxProps *uint64 `json:"maxProperties,omitempty" yaml:"maxProperties,omitempty"` AdditionalProperties AdditionalProperties `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"` Discriminator *Discriminator `json:"discriminator,omitempty" yaml:"discriminator,omitempty"` }
Schema is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
func NewAllOfSchema ¶
func NewAnyOfSchema ¶
func NewArraySchema ¶
func NewArraySchema() *Schema
func NewBoolSchema ¶
func NewBoolSchema() *Schema
func NewBytesSchema ¶
func NewBytesSchema() *Schema
func NewDateTimeSchema ¶
func NewDateTimeSchema() *Schema
func NewFloat64Schema ¶
func NewFloat64Schema() *Schema
func NewInt32Schema ¶
func NewInt32Schema() *Schema
func NewInt64Schema ¶
func NewInt64Schema() *Schema
func NewIntegerSchema ¶
func NewIntegerSchema() *Schema
func NewObjectSchema ¶
func NewObjectSchema() *Schema
func NewOneOfSchema ¶
func NewStringSchema ¶
func NewStringSchema() *Schema
func NewUUIDSchema ¶
func NewUUIDSchema() *Schema
func (*Schema) IsMatching ¶
func (*Schema) IsMatchingJSONArray ¶
func (*Schema) IsMatchingJSONBoolean ¶
func (*Schema) IsMatchingJSONNumber ¶
func (*Schema) IsMatchingJSONObject ¶
func (*Schema) IsMatchingJSONString ¶
func (Schema) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (Schema) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Schema.
func (*Schema) UnmarshalJSON ¶
UnmarshalJSON sets Schema to a copy of data.
func (*Schema) Validate ¶
func (schema *Schema) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if Schema does not comply with the OpenAPI spec.
func (*Schema) VisitJSON ¶
func (schema *Schema) VisitJSON(value interface{}, opts ...SchemaValidationOption) error
func (*Schema) VisitJSONArray ¶
func (*Schema) VisitJSONBoolean ¶
func (*Schema) VisitJSONNumber ¶
func (*Schema) VisitJSONObject ¶
func (*Schema) VisitJSONString ¶
func (*Schema) WithAdditionalProperties ¶
func (*Schema) WithAnyAdditionalProperties ¶
func (*Schema) WithDefault ¶
func (*Schema) WithExample ¶
func (*Schema) WithExclusiveMax ¶
func (*Schema) WithExclusiveMin ¶
func (*Schema) WithFormat ¶
func (*Schema) WithLength ¶
func (*Schema) WithLengthDecodedBase64 ¶
func (*Schema) WithMaxItems ¶
func (*Schema) WithMaxLength ¶
func (*Schema) WithMaxLengthDecodedBase64 ¶
func (*Schema) WithMaxProperties ¶
func (*Schema) WithMinItems ¶
func (*Schema) WithMinLength ¶
func (*Schema) WithMinLengthDecodedBase64 ¶
func (*Schema) WithMinProperties ¶
func (*Schema) WithNullable ¶
func (*Schema) WithPattern ¶
func (*Schema) WithProperties ¶
func (*Schema) WithProperty ¶
func (*Schema) WithPropertyRef ¶
func (*Schema) WithUniqueItems ¶
func (*Schema) WithoutAdditionalProperties ¶
type SchemaError ¶
type SchemaError struct { // Value is the value that failed validation. Value interface{} // Schema is the schema that failed validation. Schema *Schema // SchemaField is the field of the schema that failed validation. SchemaField string // Reason is a human-readable message describing the error. // The message should never include the original value to prevent leakage of potentially sensitive inputs in error messages. Reason string // Origin is the original error that caused this error. Origin error // contains filtered or unexported fields }
SchemaError is an error that occurs during schema validation.
func (*SchemaError) Error ¶
func (err *SchemaError) Error() string
func (*SchemaError) JSONPointer ¶
func (err *SchemaError) JSONPointer() []string
func (SchemaError) Unwrap ¶
func (err SchemaError) Unwrap() error
type SchemaRef ¶
SchemaRef represents either a Schema or a $ref to a Schema. When serializing and both fields are set, Ref is preferred over Value.
func NewSchemaRef ¶
NewSchemaRef simply builds a SchemaRef
func (*SchemaRef) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (SchemaRef) MarshalJSON ¶
MarshalJSON returns the JSON encoding of SchemaRef.
func (SchemaRef) MarshalYAML ¶
MarshalYAML returns the YAML encoding of SchemaRef.
func (*SchemaRef) UnmarshalJSON ¶
UnmarshalJSON sets SchemaRef to a copy of data.
type SchemaRefs ¶
type SchemaRefs []*SchemaRef
func (SchemaRefs) JSONLookup ¶
func (s SchemaRefs) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type SchemaValidationOption ¶
type SchemaValidationOption func(*schemaValidationSettings)
SchemaValidationOption describes options a user has when validating request / response bodies.
func DefaultsSet ¶
func DefaultsSet(f func()) SchemaValidationOption
DefaultsSet executes the given callback (once) IFF schema validation set default values.
func DisablePatternValidation ¶
func DisablePatternValidation() SchemaValidationOption
DisablePatternValidation setting makes Validate not return an error when validating patterns that are not supported by the Go regexp engine.
func DisableReadOnlyValidation ¶
func DisableReadOnlyValidation() SchemaValidationOption
DisableReadOnlyValidation setting makes Validate not return an error when validating properties marked as read-only
func DisableWriteOnlyValidation ¶
func DisableWriteOnlyValidation() SchemaValidationOption
DisableWriteOnlyValidation setting makes Validate not return an error when validating properties marked as write-only
func EnableFormatValidation ¶
func EnableFormatValidation() SchemaValidationOption
EnableFormatValidation setting makes Validate not return an error when validating documents that mention schema formats that are not defined by the OpenAPIv3 specification.
func FailFast ¶
func FailFast() SchemaValidationOption
FailFast returns schema validation errors quicker.
func MultiErrors ¶
func MultiErrors() SchemaValidationOption
func SetSchemaErrorMessageCustomizer ¶
func SetSchemaErrorMessageCustomizer(f func(err *SchemaError) string) SchemaValidationOption
SetSchemaErrorMessageCustomizer allows to override the schema error message. If the passed function returns an empty string, it returns to the previous Error() implementation.
Example ¶
package main import ( "fmt" "github.com/yaklang/yaklang/common/openapi/openapi3" ) func main() { loader := openapi3.NewLoader() spc := ` components: schemas: Something: type: object properties: field: title: Some field type: string `[1:] doc, err := loader.LoadFromData([]byte(spc)) if err != nil { panic(err) } opt := openapi3.SetSchemaErrorMessageCustomizer(func(err *openapi3.SchemaError) string { return fmt.Sprintf(`field "%s" should be string`, err.Schema.Title) }) err = doc.Components.Schemas["Something"].Value.Properties["field"].Value.VisitJSON(123, opt) fmt.Println(err.Error()) }
Output: field "Some field" should be string
func VisitAsRequest ¶
func VisitAsRequest() SchemaValidationOption
func VisitAsResponse ¶
func VisitAsResponse() SchemaValidationOption
type Schemas ¶
func (Schemas) JSONLookup ¶
var _ jsonpointer.JSONPointable = (*Schemas)(nil)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type SecurityRequirement ¶
SecurityRequirement is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object
func NewSecurityRequirement ¶
func NewSecurityRequirement() SecurityRequirement
func (SecurityRequirement) Authenticate ¶
func (security SecurityRequirement) Authenticate(provider string, scopes ...string) SecurityRequirement
func (*SecurityRequirement) Validate ¶
func (security *SecurityRequirement) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if SecurityRequirement does not comply with the OpenAPI spec.
type SecurityRequirements ¶
type SecurityRequirements []SecurityRequirement
func NewSecurityRequirements ¶
func NewSecurityRequirements() *SecurityRequirements
func (SecurityRequirements) Validate ¶
func (srs SecurityRequirements) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if SecurityRequirements does not comply with the OpenAPI spec.
func (*SecurityRequirements) With ¶
func (srs *SecurityRequirements) With(securityRequirement SecurityRequirement) *SecurityRequirements
type SecurityScheme ¶
type SecurityScheme struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Type string `json:"type,omitempty" yaml:"type,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Name string `json:"name,omitempty" yaml:"name,omitempty"` In string `json:"in,omitempty" yaml:"in,omitempty"` Scheme string `json:"scheme,omitempty" yaml:"scheme,omitempty"` BearerFormat string `json:"bearerFormat,omitempty" yaml:"bearerFormat,omitempty"` Flows *OAuthFlows `json:"flows,omitempty" yaml:"flows,omitempty"` OpenIdConnectUrl string `json:"openIdConnectUrl,omitempty" yaml:"openIdConnectUrl,omitempty"` }
SecurityScheme is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object
func NewCSRFSecurityScheme ¶
func NewCSRFSecurityScheme() *SecurityScheme
func NewJWTSecurityScheme ¶
func NewJWTSecurityScheme() *SecurityScheme
func NewOIDCSecurityScheme ¶
func NewOIDCSecurityScheme(oidcUrl string) *SecurityScheme
func NewSecurityScheme ¶
func NewSecurityScheme() *SecurityScheme
func (SecurityScheme) MarshalJSON ¶
func (ss SecurityScheme) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of SecurityScheme.
func (*SecurityScheme) UnmarshalJSON ¶
func (ss *SecurityScheme) UnmarshalJSON(data []byte) error
UnmarshalJSON sets SecurityScheme to a copy of data.
func (*SecurityScheme) Validate ¶
func (ss *SecurityScheme) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if SecurityScheme does not comply with the OpenAPI spec.
func (*SecurityScheme) WithBearerFormat ¶
func (ss *SecurityScheme) WithBearerFormat(value string) *SecurityScheme
func (*SecurityScheme) WithDescription ¶
func (ss *SecurityScheme) WithDescription(value string) *SecurityScheme
func (*SecurityScheme) WithIn ¶
func (ss *SecurityScheme) WithIn(value string) *SecurityScheme
func (*SecurityScheme) WithName ¶
func (ss *SecurityScheme) WithName(value string) *SecurityScheme
func (*SecurityScheme) WithScheme ¶
func (ss *SecurityScheme) WithScheme(value string) *SecurityScheme
func (*SecurityScheme) WithType ¶
func (ss *SecurityScheme) WithType(value string) *SecurityScheme
type SecuritySchemeRef ¶
type SecuritySchemeRef struct { Ref string Value *SecurityScheme // contains filtered or unexported fields }
SecuritySchemeRef represents either a SecurityScheme or a $ref to a SecurityScheme. When serializing and both fields are set, Ref is preferred over Value.
func (*SecuritySchemeRef) JSONLookup ¶
func (x *SecuritySchemeRef) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (SecuritySchemeRef) MarshalJSON ¶
func (x SecuritySchemeRef) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of SecuritySchemeRef.
func (SecuritySchemeRef) MarshalYAML ¶
func (x SecuritySchemeRef) MarshalYAML() (interface{}, error)
MarshalYAML returns the YAML encoding of SecuritySchemeRef.
func (*SecuritySchemeRef) UnmarshalJSON ¶
func (x *SecuritySchemeRef) UnmarshalJSON(data []byte) error
UnmarshalJSON sets SecuritySchemeRef to a copy of data.
func (*SecuritySchemeRef) Validate ¶
func (x *SecuritySchemeRef) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if SecuritySchemeRef does not comply with the OpenAPI spec.
type SecuritySchemes ¶
type SecuritySchemes map[string]*SecuritySchemeRef
func (SecuritySchemes) JSONLookup ¶
func (m SecuritySchemes) JSONLookup(token string) (interface{}, error)
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
type SerializationMethod ¶
SerializationMethod describes a serialization method of HTTP request's parameters and body.
type Server ¶
type Server struct { Extensions map[string]interface{} `json:"-" yaml:"-"` URL string `json:"url" yaml:"url"` // Required Description string `json:"description,omitempty" yaml:"description,omitempty"` Variables map[string]*ServerVariable `json:"variables,omitempty" yaml:"variables,omitempty"` }
Server is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object
func (*Server) BasePath ¶
BasePath returns the base path extracted from the default values of variables, if any. Assumes a valid struct (per Validate()).
func (Server) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Server.
func (Server) ParameterNames ¶
func (*Server) UnmarshalJSON ¶
UnmarshalJSON sets Server to a copy of data.
type ServerVariable ¶
type ServerVariable struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Enum []string `json:"enum,omitempty" yaml:"enum,omitempty"` Default string `json:"default,omitempty" yaml:"default,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` }
ServerVariable is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object
func (ServerVariable) MarshalJSON ¶
func (serverVariable ServerVariable) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON encoding of ServerVariable.
func (*ServerVariable) UnmarshalJSON ¶
func (serverVariable *ServerVariable) UnmarshalJSON(data []byte) error
UnmarshalJSON sets ServerVariable to a copy of data.
func (*ServerVariable) Validate ¶
func (serverVariable *ServerVariable) Validate(ctx context.Context, opts ...ValidationOption) error
Validate returns an error if ServerVariable does not comply with the OpenAPI spec.
type Servers ¶
type Servers []*Server
Servers is specified by OpenAPI/Swagger standard version 3.
type SliceUniqueItemsChecker ¶
type SliceUniqueItemsChecker func(items []interface{}) bool
SliceUniqueItemsChecker is an function used to check if an given slice have unique items.
type T ¶
type T struct { Extensions map[string]interface{} `json:"-" yaml:"-"` OpenAPI string `json:"openapi" yaml:"openapi"` // Required Components *Components `json:"components,omitempty" yaml:"components,omitempty"` Info *Info `json:"info" yaml:"info"` // Required Paths *Paths `json:"paths" yaml:"paths"` // Required Security SecurityRequirements `json:"security,omitempty" yaml:"security,omitempty"` Servers Servers `json:"servers,omitempty" yaml:"servers,omitempty"` Tags Tags `json:"tags,omitempty" yaml:"tags,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` // contains filtered or unexported fields }
T is the root of an OpenAPI v3 document See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-object
func (*T) AddOperation ¶
func (*T) AddServers ¶
func (*T) InternalizeRefs ¶
InternalizeRefs removes all references to external files from the spec and moves them to the components section.
refNameResolver takes in references to returns a name to store the reference under locally. It MUST return a unique name for each reference type. A default implementation is provided that will suffice for most use cases. See the function documentation for more details.
Example:
doc.InternalizeRefs(context.Background(), nil)
func (*T) JSONLookup ¶
JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable
func (T) MarshalJSON ¶
MarshalJSON returns the JSON encoding of T.
func (*T) UnmarshalJSON ¶
UnmarshalJSON sets T to a copy of data.
type Tag ¶
type Tag struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Name string `json:"name,omitempty" yaml:"name,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` }
Tag is specified by OpenAPI/Swagger 3.0 standard. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#tag-object
func (Tag) MarshalJSON ¶
MarshalJSON returns the JSON encoding of Tag.
func (*Tag) UnmarshalJSON ¶
UnmarshalJSON sets Tag to a copy of data.
type ValidationOption ¶
type ValidationOption func(options *ValidationOptions)
ValidationOption allows the modification of how the OpenAPI document is validated.
func AllowExtraSiblingFields ¶
func AllowExtraSiblingFields(fields ...string) ValidationOption
AllowExtraSiblingFields called as AllowExtraSiblingFields("description") makes Validate not return an error when said field appears next to a $ref.
func DisableExamplesValidation ¶
func DisableExamplesValidation() ValidationOption
DisableExamplesValidation disables all example schema validation. By default, all schema examples are validated.
func DisableSchemaDefaultsValidation ¶
func DisableSchemaDefaultsValidation() ValidationOption
DisableSchemaDefaultsValidation disables schemas' default field validation. By default, schema default values are validated against their schema.
func DisableSchemaFormatValidation ¶
func DisableSchemaFormatValidation() ValidationOption
DisableSchemaFormatValidation does the opposite of EnableSchemaFormatValidation. By default, schema format validation is disabled.
func DisableSchemaPatternValidation ¶
func DisableSchemaPatternValidation() ValidationOption
DisableSchemaPatternValidation makes Validate not return an error when validating patterns that are not supported by the Go regexp engine.
func EnableExamplesValidation ¶
func EnableExamplesValidation() ValidationOption
EnableExamplesValidation does the opposite of DisableExamplesValidation. By default, all schema examples are validated.
func EnableSchemaDefaultsValidation ¶
func EnableSchemaDefaultsValidation() ValidationOption
EnableSchemaDefaultsValidation does the opposite of DisableSchemaDefaultsValidation. By default, schema default values are validated against their schema.
func EnableSchemaFormatValidation ¶
func EnableSchemaFormatValidation() ValidationOption
EnableSchemaFormatValidation makes Validate not return an error when validating documents that mention schema formats that are not defined by the OpenAPIv3 specification. By default, schema format validation is disabled.
func EnableSchemaPatternValidation ¶
func EnableSchemaPatternValidation() ValidationOption
EnableSchemaPatternValidation does the opposite of DisableSchemaPatternValidation. By default, schema pattern validation is enabled.
type ValidationOptions ¶
type ValidationOptions struct {
// contains filtered or unexported fields
}
ValidationOptions provides configuration for validating OpenAPI documents.
type XML ¶
type XML struct { Extensions map[string]interface{} `json:"-" yaml:"-"` Name string `json:"name,omitempty" yaml:"name,omitempty"` Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"` Prefix string `json:"prefix,omitempty" yaml:"prefix,omitempty"` Attribute bool `json:"attribute,omitempty" yaml:"attribute,omitempty"` Wrapped bool `json:"wrapped,omitempty" yaml:"wrapped,omitempty"` }
XML is specified by OpenAPI/Swagger standard version 3. See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object
func (XML) MarshalJSON ¶
MarshalJSON returns the JSON encoding of XML.
func (*XML) UnmarshalJSON ¶
UnmarshalJSON sets XML to a copy of data.
Source Files
¶
- callback.go
- components.go
- contact.go
- content.go
- discriminator.go
- doc.go
- encoding.go
- errors.go
- example.go
- example_validation.go
- extension.go
- external_docs.go
- header.go
- helpers.go
- info.go
- internalize_refs.go
- license.go
- link.go
- loader.go
- loader_uri_reader.go
- maplike.go
- marsh.go
- media_type.go
- openapi3.go
- operation.go
- parameter.go
- path_item.go
- paths.go
- ref.go
- refs.go
- request_body.go
- response.go
- schema.go
- schema_formats.go
- schema_pattern.go
- schema_validation_settings.go
- security_requirements.go
- security_scheme.go
- serialization_method.go
- server.go
- tag.go
- validation_options.go
- visited.go
- xml.go