Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapi3

package

Go to main page

Versions in this module

v1

v1.3.3-rc7

May 17, 2024

v1.3.3-rc6

May 16, 2024

v1.3.3-rc5

May 16, 2024

v1.3.3-rc4

May 8, 2024

v1.3.3-rc3

May 8, 2024

v1.3.3-rc2

Apr 30, 2024

v1.3.3-beta9

May 15, 2024

v1.3.3-beta8

May 11, 2024

v1.3.3-beta7

May 6, 2024

v1.3.3-beta6

May 6, 2024

v1.3.3-beta5

May 4, 2024

v1.3.3-beta3

Apr 30, 2024

v1.3.3-beta2

Apr 30, 2024

v1.3.3-beta1

Apr 30, 2024

v1.3.3-beta

Apr 30, 2024

v1.3.3-alpha7

May 6, 2024

v1.3.2

Apr 12, 2024

v1.3.2-sp2

Apr 26, 2024

v1.3.2-sp1

Apr 19, 2024

v1.3.1

Mar 1, 2024

Changes in this version

+ const FormatOfStringForEmail

+ const FormatOfStringForUUIDOfRFC4122

+ const ParameterInCookie

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ const SerializationDeepObject

+ const SerializationForm

+ const SerializationLabel

+ const SerializationMatrix

+ const SerializationPipeDelimited

+ const SerializationSimple

+ const SerializationSpaceDelimited

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNumber

+ const TypeObject

+ const TypeString

+ var CircularReferenceCounter = 3

+ var CircularReferenceError = "kin-openapi bug found: circular schema reference not handled"

+ var DefaultReadFromURI = URIMapCache(ReadFromURIs(ReadFromHTTP(http.DefaultClient), ReadFromFile))

+ var ErrOneOfConflict = errors.New("input matches more than one oneOf schemas")

+ var ErrSchemaInputInf = errors.New("floating point Inf is not allowed")

+ var ErrSchemaInputNaN = errors.New("floating point NaN is not allowed")

+ var ErrURINotSupported = errors.New("unsupported URI")

+ var IdentifierRegExp = regexp.MustCompile(identifierPattern)

+ var SchemaErrorDetailsDisabled = false

+ var SchemaStringFormats = make(map[string]Format, 4)

+ 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 struct

+ Has *bool

+ Schema *SchemaRef

+ func (addProps *AdditionalProperties) UnmarshalJSON(data []byte) error

+ func (addProps AdditionalProperties) MarshalJSON() ([]byte, error)

+ type Callback struct

+ Extensions map[string]interface{}

+ func NewCallback(opts ...NewCallbackOption) *Callback

+ func NewCallbackWithCapacity(cap int) *Callback

+ 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

+ func (callback Callback) JSONLookup(token string) (interface{}, error)

+ type CallbackRef struct

+ Ref string

+ Value *Callback

+ func (x *CallbackRef) JSONLookup(token string) (interface{}, error)

+ func (x *CallbackRef) UnmarshalJSON(data []byte) error

+ func (x *CallbackRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x CallbackRef) MarshalJSON() ([]byte, error)

+ func (x CallbackRef) MarshalYAML() (interface{}, error)

+ type Callbacks map[string]*CallbackRef

+ func (m Callbacks) JSONLookup(token string) (interface{}, error)

+ type Components struct

+ Callbacks Callbacks

+ Examples Examples

+ Extensions map[string]interface{}

+ Headers Headers

+ Links Links

+ Parameters ParametersMap

+ RequestBodies RequestBodies

+ Responses ResponseBodies

+ Schemas Schemas

+ SecuritySchemes SecuritySchemes

+ func NewComponents() Components

+ func (components *Components) UnmarshalJSON(data []byte) error

+ func (components *Components) Validate(ctx context.Context, opts ...ValidationOption) (err error)

+ func (components Components) MarshalJSON() ([]byte, error)

+ type Contact struct

+ Email string

+ Extensions map[string]interface{}

+ Name string

+ URL string

+ func (contact *Contact) UnmarshalJSON(data []byte) error

+ func (contact *Contact) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (contact Contact) MarshalJSON() ([]byte, error)

+ type Content map[string]*MediaType

+ 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

+ func (content Content) Get(mime string) *MediaType

+ func (content Content) Validate(ctx context.Context, opts ...ValidationOption) error

+ type Discriminator struct

+ Extensions map[string]interface{}

+ Mapping map[string]string

+ PropertyName string

+ func (discriminator *Discriminator) UnmarshalJSON(data []byte) error

+ func (discriminator *Discriminator) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (discriminator Discriminator) MarshalJSON() ([]byte, error)

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode *bool

+ Extensions map[string]interface{}

+ Headers Headers

+ Style string

+ func NewEncoding() *Encoding

+ 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

+ func (encoding Encoding) MarshalJSON() ([]byte, error)

+ type Example struct

+ Description string

+ Extensions map[string]interface{}

+ ExternalValue string

+ Summary string

+ Value interface{}

+ func NewExample(value interface{}) *Example

+ func (example *Example) UnmarshalJSON(data []byte) error

+ func (example *Example) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (example Example) MarshalJSON() ([]byte, error)

+ type ExampleRef struct

+ Ref string

+ Value *Example

+ func (x *ExampleRef) JSONLookup(token string) (interface{}, error)

+ func (x *ExampleRef) UnmarshalJSON(data []byte) error

+ func (x *ExampleRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x ExampleRef) MarshalJSON() ([]byte, error)

+ func (x ExampleRef) MarshalYAML() (interface{}, error)

+ type Examples map[string]*ExampleRef

+ func (m Examples) JSONLookup(token string) (interface{}, error)

+ type ExternalDocs struct

+ Description string

+ Extensions map[string]interface{}

+ URL string

+ func (e *ExternalDocs) UnmarshalJSON(data []byte) error

+ func (e *ExternalDocs) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (e ExternalDocs) MarshalJSON() ([]byte, error)

+ type Format struct

+ type FormatCallback func(value string) error

+ type Header struct

+ func (header *Header) SerializationMethod() (*SerializationMethod, error)

+ func (header *Header) UnmarshalJSON(data []byte) error

+ func (header *Header) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (header Header) JSONLookup(token string) (interface{}, error)

+ func (header Header) MarshalJSON() ([]byte, error)

+ func (header Header) MarshalYAML() (interface{}, error)

+ type HeaderRef struct

+ Ref string

+ Value *Header

+ func (x *HeaderRef) JSONLookup(token string) (interface{}, error)

+ func (x *HeaderRef) UnmarshalJSON(data []byte) error

+ func (x *HeaderRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x HeaderRef) MarshalJSON() ([]byte, error)

+ func (x HeaderRef) MarshalYAML() (interface{}, error)

+ type Headers map[string]*HeaderRef

+ func (m Headers) JSONLookup(token string) (interface{}, error)

+ type Info struct

+ Contact *Contact

+ Description string

+ Extensions map[string]interface{}

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ func (info *Info) UnmarshalJSON(data []byte) error

+ func (info *Info) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (info Info) MarshalJSON() ([]byte, error)

+ type License struct

+ Extensions map[string]interface{}

+ Name string

+ URL string

+ func (license *License) UnmarshalJSON(data []byte) error

+ func (license *License) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (license License) MarshalJSON() ([]byte, error)

+ type Link struct

+ Description string

+ Extensions map[string]interface{}

+ OperationID string

+ OperationRef string

+ Parameters map[string]interface{}

+ RequestBody interface{}

+ Server *Server

+ func (link *Link) UnmarshalJSON(data []byte) error

+ func (link *Link) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (link Link) MarshalJSON() ([]byte, error)

+ type LinkRef struct

+ Ref string

+ Value *Link

+ func (x *LinkRef) JSONLookup(token string) (interface{}, error)

+ func (x *LinkRef) UnmarshalJSON(data []byte) error

+ func (x *LinkRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x LinkRef) MarshalJSON() ([]byte, error)

+ func (x LinkRef) MarshalYAML() (interface{}, error)

+ type Links map[string]*LinkRef

+ func (m Links) JSONLookup(token string) (interface{}, error)

+ type Loader struct

+ Context context.Context

+ IsExternalRefsAllowed bool

+ ReadFromURIFunc ReadFromURIFunc

+ func NewLoader() *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 struct

+ Encoding map[string]*Encoding

+ Example interface{}

+ Examples Examples

+ Extensions map[string]interface{}

+ Schema *SchemaRef

+ func NewMediaType() *MediaType

+ 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

+ func (mediaType MediaType) JSONLookup(token string) (interface{}, error)

+ func (mediaType MediaType) MarshalJSON() ([]byte, error)

+ type MultiError []error

+ func (me MultiError) As(target interface{}) bool

+ func (me MultiError) Error() string

+ func (me MultiError) Is(target error) bool

+ type NewCallbackOption func(*Callback)

+ func WithCallback(cb string, pathItem *PathItem) NewCallbackOption

+ type NewPathsOption func(*Paths)

+ func WithPath(path string, pathItem *PathItem) NewPathsOption

+ type NewResponsesOption func(*Responses)

+ func WithName(name string, response *Response) NewResponsesOption

+ func WithStatus(status int, responseRef *ResponseRef) NewResponsesOption

+ type OAuthFlow struct

+ AuthorizationURL string

+ Extensions map[string]interface{}

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ func (flow *OAuthFlow) UnmarshalJSON(data []byte) error

+ func (flow *OAuthFlow) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (flow OAuthFlow) MarshalJSON() ([]byte, error)

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Extensions map[string]interface{}

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ func (flows *OAuthFlows) UnmarshalJSON(data []byte) error

+ func (flows *OAuthFlows) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (flows OAuthFlows) MarshalJSON() ([]byte, error)

+ type Operation struct

+ Callbacks Callbacks

+ Deprecated bool

+ Description string

+ Extensions map[string]interface{}

+ ExternalDocs *ExternalDocs

+ OperationID string

+ Parameters Parameters

+ RequestBody *RequestBodyRef

+ Responses *Responses

+ Security *SecurityRequirements

+ Servers *Servers

+ Summary string

+ Tags []string

+ func NewOperation() *Operation

+ func (operation *Operation) AddParameter(p *Parameter)

+ func (operation *Operation) AddResponse(status int, response *Response)

+ func (operation *Operation) UnmarshalJSON(data []byte) error

+ func (operation *Operation) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (operation Operation) MarshalJSON() ([]byte, error)

+ type Parameter struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content Content

+ Deprecated bool

+ Description string

+ Example interface{}

+ Examples Examples

+ Explode *bool

+ Extensions map[string]interface{}

+ In string

+ Name string

+ Required bool

+ Schema *SchemaRef

+ Style string

+ func NewCookieParameter(name string) *Parameter

+ func NewHeaderParameter(name string) *Parameter

+ func NewPathParameter(name string) *Parameter

+ func NewQueryParameter(name string) *Parameter

+ 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

+ func (parameter Parameter) JSONLookup(token string) (interface{}, error)

+ func (parameter Parameter) MarshalJSON() ([]byte, error)

+ type ParameterRef struct

+ Ref string

+ Value *Parameter

+ func (x *ParameterRef) JSONLookup(token string) (interface{}, error)

+ func (x *ParameterRef) UnmarshalJSON(data []byte) error

+ func (x *ParameterRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x ParameterRef) MarshalJSON() ([]byte, error)

+ func (x ParameterRef) MarshalYAML() (interface{}, error)

+ type Parameters []*ParameterRef

+ func NewParameters() Parameters

+ func (p Parameters) JSONLookup(token string) (interface{}, error)

+ func (parameters Parameters) GetByInAndName(in string, name string) *Parameter

+ func (parameters Parameters) Validate(ctx context.Context, opts ...ValidationOption) error

+ type ParametersMap map[string]*ParameterRef

+ func (m ParametersMap) JSONLookup(token string) (interface{}, error)

+ type PathItem struct

+ Connect *Operation

+ Delete *Operation

+ Description string

+ Extensions map[string]interface{}

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters Parameters

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers Servers

+ Summary string

+ Trace *Operation

+ func (pathItem *PathItem) GetOperation(method string) *Operation

+ 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

+ func (pathItem PathItem) MarshalJSON() ([]byte, error)

+ type Paths struct

+ Extensions map[string]interface{}

+ func NewPaths(opts ...NewPathsOption) *Paths

+ func NewPathsWithCapacity(cap int) *Paths

+ func (paths *Paths) Find(key string) *PathItem

+ func (paths *Paths) InMatchingOrder() []string

+ 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

+ func (paths Paths) JSONLookup(token string) (interface{}, error)

+ type ReadFromURIFunc func(loader *Loader, url *url.URL) ([]byte, error)

+ func ReadFromHTTP(cl *http.Client) ReadFromURIFunc

+ func ReadFromURIs(readers ...ReadFromURIFunc) ReadFromURIFunc

+ func URIMapCache(reader ReadFromURIFunc) ReadFromURIFunc

+ type Ref struct

+ Ref string

+ type RefNameResolver func(string) string

+ type RequestBodies map[string]*RequestBodyRef

+ func (m RequestBodies) JSONLookup(token string) (interface{}, error)

+ type RequestBody struct

+ Content Content

+ Description string

+ Extensions map[string]interface{}

+ Required bool

+ func NewRequestBody() *RequestBody

+ func (requestBody *RequestBody) GetMediaType(mediaType string) *MediaType

+ 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

+ func (requestBody RequestBody) MarshalJSON() ([]byte, error)

+ type RequestBodyRef struct

+ Ref string

+ Value *RequestBody

+ func (x *RequestBodyRef) JSONLookup(token string) (interface{}, error)

+ func (x *RequestBodyRef) UnmarshalJSON(data []byte) error

+ func (x *RequestBodyRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x RequestBodyRef) MarshalJSON() ([]byte, error)

+ func (x RequestBodyRef) MarshalYAML() (interface{}, error)

+ type Response struct

+ Content Content

+ Description *string

+ Extensions map[string]interface{}

+ Headers Headers

+ Links Links

+ func NewResponse() *Response

+ 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

+ func (response Response) MarshalJSON() ([]byte, error)

+ type ResponseBodies map[string]*ResponseRef

+ func (m ResponseBodies) JSONLookup(token string) (interface{}, error)

+ type ResponseRef struct

+ Ref string

+ Value *Response

+ func (x *ResponseRef) JSONLookup(token string) (interface{}, error)

+ func (x *ResponseRef) UnmarshalJSON(data []byte) error

+ func (x *ResponseRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x ResponseRef) MarshalJSON() ([]byte, error)

+ func (x ResponseRef) MarshalYAML() (interface{}, error)

+ type Responses struct

+ Extensions map[string]interface{}

+ func NewResponses(opts ...NewResponsesOption) *Responses

+ func NewResponsesWithCapacity(cap int) *Responses

+ func (responses *Responses) Default() *ResponseRef

+ 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

+ func (responses Responses) JSONLookup(token string) (interface{}, error)

+ type Schema struct

+ AdditionalProperties AdditionalProperties

+ AllOf SchemaRefs

+ AllowEmptyValue bool

+ AnyOf SchemaRefs

+ Default interface{}

+ Deprecated bool

+ Description string

+ Discriminator *Discriminator

+ Enum []interface{}

+ Example interface{}

+ ExclusiveMax bool

+ ExclusiveMin bool

+ Extensions map[string]interface{}

+ ExternalDocs *ExternalDocs

+ Format string

+ Items *SchemaRef

+ Max *float64

+ MaxItems *uint64

+ MaxLength *uint64

+ MaxProps *uint64

+ Min *float64

+ MinItems uint64

+ MinLength uint64

+ MinProps uint64

+ MultipleOf *float64

+ Not *SchemaRef

+ Nullable bool

+ OneOf SchemaRefs

+ Pattern string

+ Properties Schemas

+ ReadOnly bool

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ WriteOnly bool

+ XML *XML

+ 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) 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 (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

+ func (schema Schema) JSONLookup(token string) (interface{}, error)

+ func (schema Schema) MarshalJSON() ([]byte, error)

+ func (scheme *Schema) WithExample(e any) *Schema

+ type SchemaError struct

+ Origin error

+ Reason string

+ Schema *Schema

+ SchemaField string

+ Value interface{}

+ func (err *SchemaError) Error() string

+ func (err *SchemaError) JSONPointer() []string

+ func (err SchemaError) Unwrap() error

+ type SchemaRef struct

+ Ref string

+ Value *Schema

+ func NewSchemaRef(ref string, value *Schema) *SchemaRef

+ func (x *SchemaRef) JSONLookup(token string) (interface{}, error)

+ func (x *SchemaRef) UnmarshalJSON(data []byte) error

+ func (x *SchemaRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x SchemaRef) MarshalJSON() ([]byte, error)

+ func (x SchemaRef) MarshalYAML() (interface{}, error)

+ type SchemaRefs []*SchemaRef

+ func (s SchemaRefs) JSONLookup(token string) (interface{}, error)

+ type SchemaValidationOption func(*schemaValidationSettings)

+ 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 map[string]*SchemaRef

+ func (m Schemas) JSONLookup(token string) (interface{}, error)

+ type SecurityRequirement map[string][]string

+ func NewSecurityRequirement() SecurityRequirement

+ func (security *SecurityRequirement) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (security SecurityRequirement) Authenticate(provider string, scopes ...string) SecurityRequirement

+ type SecurityRequirements []SecurityRequirement

+ func NewSecurityRequirements() *SecurityRequirements

+ func (srs *SecurityRequirements) With(securityRequirement SecurityRequirement) *SecurityRequirements

+ func (srs SecurityRequirements) Validate(ctx context.Context, opts ...ValidationOption) error

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Extensions map[string]interface{}

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIdConnectUrl string

+ Scheme string

+ Type string

+ func NewCSRFSecurityScheme() *SecurityScheme

+ func NewJWTSecurityScheme() *SecurityScheme

+ func NewOIDCSecurityScheme(oidcUrl string) *SecurityScheme

+ func NewSecurityScheme() *SecurityScheme

+ 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

+ func (ss SecurityScheme) MarshalJSON() ([]byte, error)

+ type SecuritySchemeRef struct

+ Ref string

+ Value *SecurityScheme

+ func (x *SecuritySchemeRef) JSONLookup(token string) (interface{}, error)

+ func (x *SecuritySchemeRef) UnmarshalJSON(data []byte) error

+ func (x *SecuritySchemeRef) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (x SecuritySchemeRef) MarshalJSON() ([]byte, error)

+ func (x SecuritySchemeRef) MarshalYAML() (interface{}, error)

+ type SecuritySchemes map[string]*SecuritySchemeRef

+ func (m SecuritySchemes) JSONLookup(token string) (interface{}, error)

+ type SerializationMethod struct

+ Explode bool

+ Style string

+ type Server struct

+ Description string

+ Extensions map[string]interface{}

+ URL string

+ Variables map[string]*ServerVariable

+ func (server *Server) BasePath() (string, error)

+ func (server *Server) UnmarshalJSON(data []byte) error

+ func (server *Server) Validate(ctx context.Context, opts ...ValidationOption) (err error)

+ func (server Server) MarshalJSON() ([]byte, error)

+ func (server Server) MatchRawURL(input string) ([]string, string, bool)

+ func (server Server) ParameterNames() ([]string, error)

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ Extensions map[string]interface{}

+ func (serverVariable *ServerVariable) UnmarshalJSON(data []byte) error

+ func (serverVariable *ServerVariable) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (serverVariable ServerVariable) MarshalJSON() ([]byte, error)

+ type Servers []*Server

+ func (servers Servers) BasePath() (string, error)

+ func (servers Servers) MatchURL(parsedURL *url.URL) (*Server, []string, string)

+ func (servers Servers) Validate(ctx context.Context, opts ...ValidationOption) error

+ type SliceUniqueItemsChecker func(items []interface{}) bool

+ type T struct

+ Components *Components

+ Extensions map[string]interface{}

+ ExternalDocs *ExternalDocs

+ Info *Info

+ OpenAPI string

+ Paths *Paths

+ Security SecurityRequirements

+ Servers Servers

+ Tags Tags

+ 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) UnmarshalJSON(data []byte) error

+ func (doc *T) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (doc T) MarshalJSON() ([]byte, error)

+ type Tag struct

+ Description string

+ Extensions map[string]interface{}

+ ExternalDocs *ExternalDocs

+ Name string

+ func (t *Tag) UnmarshalJSON(data []byte) error

+ func (t *Tag) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (t Tag) MarshalJSON() ([]byte, error)

+ type Tags []*Tag

+ func (tags Tags) Get(name string) *Tag

+ func (tags Tags) Validate(ctx context.Context, opts ...ValidationOption) error

+ type ValidationOption func(options *ValidationOptions)

+ 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 struct

+ type XML struct

+ Attribute bool

+ Extensions map[string]interface{}

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

+ func (xml *XML) UnmarshalJSON(data []byte) error

+ func (xml *XML) Validate(ctx context.Context, opts ...ValidationOption) error

+ func (xml XML) MarshalJSON() ([]byte, error)

v1.3.1-sp7

Mar 29, 2024

v1.3.1-sp6

Mar 25, 2024

v1.3.1-sp5

Mar 22, 2024

v1.3.1-sp4

Mar 19, 2024

v1.3.1-sp3

Mar 15, 2024

v1.3.1-sp2

Mar 11, 2024

v1.3.1-sp1

Mar 6, 2024

v1.3.0-sp8

Feb 26, 2024

v1.3.0-sp7

Feb 23, 2024

v1.3.0-sp6

Feb 19, 2024

v1.3.0-sp5

Feb 6, 2024

v1.3.0-sp4

Feb 2, 2024

v1.3.0-sp3

Jan 26, 2024

v1.3.0-sp2

Jan 19, 2024

v1.3.0-sp1

Jan 12, 2024