openapi

package module

Go to main page

Versions in this module

v0

v0.2.4

Oct 1, 2022

v0.2.3

Sep 30, 2022

Changes in this version

type Types

+ func (t *Types) UnmarshalYAML(value *yaml.Node) error

+ func (t Types) MarshalYAML() (interface{}, error)

v0.2.2

Sep 28, 2022

v0.2.1

Sep 28, 2022

v0.2.0

Sep 25, 2022

Changes in this version

type Anchors

+ func (a *Anchors) DynamicAnchor(name Text) *Anchor

+ func (a *Anchors) StandardAnchor(name Text) *Anchor

+ type Item struct

+ Key Text

+ Value T

v0.1.8

Sep 24, 2022

v0.1.7

Sep 22, 2022

v0.1.6

Sep 22, 2022

v0.1.5

Sep 22, 2022

v0.1.4

Sep 22, 2022

v0.1.3

Sep 22, 2022

v0.1.2

Sep 22, 2022

v0.1.1

Sep 22, 2022

v0.1.0

Sep 22, 2022

Changes in this version

+ const JSON_SCHEMA_2019_09

+ const JSON_SCHEMA_2020_12

+ const MethodDelete

+ const MethodGet

+ const MethodHead

+ const MethodOptions

+ const MethodPatch

+ const MethodPost

+ const MethodPut

+ const MethodTrace

+ const OPEN_API_3_0_SCHEMA

+ const OPEN_API_3_1_SCHEMA

+ var ErrEmptyRef = errors.New("openapi: empty $ref")

+ var ErrInvalidResolution = errors.New("openapi: invalid resolution")

+ var ErrInvalidSemVer = errors.New("invalid semantic version")

+ var ErrInvalidSemVerMetadata = errors.New("invalid semantic version metadata string")

+ var ErrInvalidSemVerPrerelease = errors.New("invalid semantic version prerelease string")

+ var ErrMissingOpenAPIVersion = errors.New("openapi: missing openapi version")

+ var ErrNotFound = fmt.Errorf("openapi: component not found")

+ var ErrNotResolvable = errors.New("openapi: pointer path not resolvable")

+ var JSONSchemaDialect201909 = *uri.MustParse(JSON_SCHEMA_2019_09)

+ var JSONSchemaDialect202012 = *uri.MustParse(JSON_SCHEMA_2020_12)

+ var OpenAPI30Schema = *uri.MustParse(OPEN_API_3_0_SCHEMA)

+ var OpenAPI31Schema = *uri.MustParse(OPEN_API_3_1_SCHEMA)

+ var SupportedVersions = mustParseConstraints(">= 3.0.0, < 3.2.0")

+ var Version3_0 = *semver.MustParse("3.0")

+ var Version3_1 = *semver.MustParse("3.1")

+ var VersionConstraints3_0 = mustParseConstraints(">= 3.0.0, < 3.1.0")

+ var VersionConstraints3_1 = mustParseConstraints(">= 3.1.0, < 3.2.0")

+ func IsRef(node Node) bool

+ func NewError(err error, resource uri.URI) error

+ func NewResolutionError(r Ref, expected, actual Kind) error

+ func NewSemVerError(err error, value string, uri uri.URI) error

+ func NewValidationError(err error, kind Kind, resource uri.URI) error

+ func SetupCompiler(compiler *jsonschema.Compiler, resources ...fs.FS) (*jsonschema.Compiler, error)

+ func TryGetOpenAPIVersion(data []byte) (string, bool)

+ func TryGetSchemaDialect(data []byte) (string, bool)

+ type Anchor struct

+ In *Schema

+ Name Text

+ Type AnchorType

+ type AnchorType uint8

+ const AnchorTypeDynamic

+ const AnchorTypeRecursive

+ const AnchorTypeRegular

+ const AnchorTypeUndefined

+ type Anchors struct

+ Dynamic map[Text]Anchor

+ Recursive *Anchor

+ Standard map[Text]Anchor

+ type BaseVisitor struct

type Callbacks

+ func (*Callbacks) Kind() Kind

+ func (c *Callbacks) Anchors() (*Anchors, error)

+ func (c *Callbacks) Nodes() []Node

+ func (c *Callbacks) Refs() []Ref

+ func (c Callbacks) MarshalJSON() ([]byte, error)

+ type CallbacksMap = ComponentMap[*Callbacks]

+ type CompiledSchema interface

+ Validate func(data interface{}) error

+ type CompiledSchemas struct

+ JSONSchema map[uri.URI]CompiledSchema

+ OpenAPI map[semver.Version]map[Kind]CompiledSchema

+ func CompileSchemas(compiler *jsonschema.Compiler, openAPISchemas ...map[string]uri.URI) (CompiledSchemas, error)

+ type Component struct

+ Object T

+ Reference *Reference[T]

+ func (c *Component[T]) Anchors() (*Anchors, error)

+ func (c *Component[T]) IsReference() bool

+ func (c *Component[T]) IsResolved() bool

+ func (c *Component[T]) Kind() Kind

+ func (c *Component[T]) MakeReference(ref uri.URI) error

+ func (c *Component[T]) MarshalYAML() (interface{}, error)

+ func (c *Component[T]) ObjectKind() Kind

+ func (c *Component[T]) Refs() []Ref

+ func (c *Component[T]) URI() *uri.URI

+ func (c *Component[T]) UnmarshalJSON(data []byte) error

+ func (c *Component[T]) UnmarshalYAML(value *yaml.Node) error

+ func (c Component[T]) MarshalJSON() ([]byte, error)

+ type ComponentEntry struct

+ Component *Component[V]

+ Key Text

+ type ComponentMap struct

+ Items []*ComponentEntry[T]

+ func (*ComponentMap[T]) Kind() Kind

+ func (cm *ComponentMap[T]) Anchors() (*Anchors, error)

+ func (cm *ComponentMap[T]) Del(key Text)

+ func (cm *ComponentMap[T]) Get(key Text) *Component[T]

+ func (cm *ComponentMap[T]) MarshalYAML() (interface{}, error)

+ func (cm *ComponentMap[T]) Refs() []Ref

+ func (cm *ComponentMap[T]) Set(key Text, value *Component[T])

+ func (cm *ComponentMap[T]) UnmarshalJSON(data []byte) error

+ func (cm *ComponentMap[T]) UnmarshalYAML(value *yaml.Node) error

+ func (cm ComponentMap[T]) Map() map[Text]*Component[T]

+ func (cm ComponentMap[T]) MarshalJSON() ([]byte, error)

+ type ComponentSlice struct

+ Items []*Component[T]

+ func (ComponentSlice[T]) Kind() Kind

+ func (cs *ComponentSlice[T]) Anchors() (*Anchors, error)

+ func (cs *ComponentSlice[T]) MarshalYAML() (interface{}, error)

+ func (cs *ComponentSlice[T]) Refs() []Ref

+ func (cs *ComponentSlice[T]) UnmarshalJSON(data []byte) error

+ func (cs *ComponentSlice[T]) UnmarshalYAML(value *yaml.Node) error

+ func (cs ComponentSlice[T]) MarshalJSON() ([]byte, error)

type Components

+ func (*Components) Kind() Kind

+ func (c *Components) Anchors() (*Anchors, error)

+ func (c *Components) Refs() []Ref

type Contact

+ func (*Contact) Anchors() (*Anchors, error)

+ func (*Contact) Kind() Kind

+ func (*Contact) Refs() []Ref

+ type ContentMap = ObjMap[*MediaType]

type Discriminator

+ func (*Discriminator) Kind() Kind

+ func (*Discriminator) Refs() []Ref

+ func (d *Discriminator) Anchors() (*Anchors, error)

+ func (d *Discriminator) Clone() *Discriminator

+ func (d *Discriminator) Nodes() []Node

+ type Document struct

+ Components *Components

+ ExternalDocs *ExternalDocs

+ Info *Info

+ JSONSchemaDialect *uri.URI

+ OpenAPI *semver.Version

+ Paths *Paths

+ Security *SecurityRequirementSlice

+ Servers *ServerSlice

+ Tags *TagSlice

+ Webhooks *PathItemMap

+ func Load(ctx context.Context, documentURI string, validator Validator, ...) (*Document, error)

+ func (*Document) Kind() Kind

+ func (d *Document) Anchors() (*Anchors, error)

+ func (d *Document) Refs() []Ref

+ func (d *Document) UnmarshalJSON(data []byte) error

+ func (d *Document) UnmarshalYAML(value *yaml.Node) error

+ func (d Document) MarshalJSON() ([]byte, error)

+ func (d Document) MarshalYAML() (interface{}, error)

+ type DuplicateAnchorError struct

+ A *Anchor

+ B *Anchor

+ func (dae *DuplicateAnchorError) Error() string

type Encoding

+ func (*Encoding) Kind() Kind

+ func (e *Encoding) Anchors() (*Anchors, error)

+ func (e *Encoding) Nodes() []Node

+ func (e *Encoding) Refs() []Ref

+ type EncodingMap = ComponentMap[*Encoding]

+ type Error struct

+ Err error

+ ResourceURI uri.URI

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

type Example

+ Description Text

+ ExternalValue *uri.URI

+ Summary Text

+ Value jsonx.RawMessage

+ func (*Example) Kind() Kind

+ func (*Example) Refs() []Ref

+ func (e *Example) Anchors() (*Anchors, error)

+ func (e *Example) Nodes() []Node

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

+ func (e *Example) UnmarshalYAML(value *yaml.Node) error

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

+ func (e Example) MarshalYAML() (interface{}, error)

+ type ExampleMap = ComponentMap[*Example]

type Extensions

+ func (e *Extensions) SetRawExtension(key Text, val []byte)

+ func (e Extensions) DecodeExtensions(dst interface{}) error

type ExternalDocs

+ func (*ExternalDocs) Anchors() (*Anchors, error)

+ func (*ExternalDocs) Kind() Kind

+ func (*ExternalDocs) Refs() []Ref

+ func (ed *ExternalDocs) Nodes() []Node

type Header

+ AllowEmptyValue *bool

+ AllowReserved *bool

+ Deprecated *bool

+ Description Text

+ Example jsonx.RawMessage

+ Examples *ExampleMap

+ Explode *bool

+ Required *bool

+ Schema *Schema

+ Style Text

+ func (*Header) Kind() Kind

+ func (h *Header) Anchors() (*Anchors, error)

+ func (h *Header) Nodes() []Node

+ func (h *Header) Refs() []Ref

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

+ func (h *Header) UnmarshalYAML(value *yaml.Node) error

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

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

+ type HeaderMap = ComponentMap[*Header]

type Info

+ func (*Info) Anchors() (*Anchors, error)

+ func (*Info) Kind() Kind

+ func (*Info) Refs() []Ref

+ func (i *Info) SemVer() (*semver.Version, error)

+ type JSONObjEntry struct

+ Key Text

+ Value jsonx.RawMessage

+ type KeyValue struct

+ Key Text

+ Value V

+ type Kind uint16

+ const KindCallbacks

+ const KindCallbacksComponent

+ const KindCallbacksMap

+ const KindComponents

+ const KindContact

+ const KindDiscriminator

+ const KindDocument

+ const KindEncoding

+ const KindEncodingMap

+ const KindExample

+ const KindExampleComponent

+ const KindExampleMap

+ const KindExternalDocs

+ const KindHeader

+ const KindHeaderComponent

+ const KindHeaderMap

+ const KindHeaderSlice

+ const KindInfo

+ const KindLicense

+ const KindLink

+ const KindLinkComponent

+ const KindLinkMap

+ const KindMediaType

+ const KindMediaTypeMap

+ const KindOAuthFlow

+ const KindOAuthFlows

+ const KindOperation

+ const KindOperationRef

+ const KindParameter

+ const KindParameterComponent

+ const KindParameterMap

+ const KindParameterSlice

+ const KindPathItem

+ const KindPathItemComponent

+ const KindPathItemMap

+ const KindPaths

+ const KindReference

+ const KindRequestBody

+ const KindRequestBodyComponent

+ const KindRequestBodyMap

+ const KindResponse

+ const KindResponseComponent

+ const KindResponseMap

+ const KindSchema

+ const KindSchemaMap

+ const KindSchemaRef

+ const KindSchemaSlice

+ const KindScope

+ const KindScopes

+ const KindSecurityRequirement

+ const KindSecurityRequirementItem

+ const KindSecurityRequirementSlice

+ const KindSecurityScheme

+ const KindSecuritySchemeComponent

+ const KindSecuritySchemeMap

+ const KindServer

+ const KindServerComponent

+ const KindServerSlice

+ const KindServerVariable

+ const KindServerVariableMap

+ const KindTag

+ const KindTagSlice

+ const KindUndefined

+ const KindXML

+ func (k Kind) String() string

type License

+ func (*License) Anchors() (*Anchors, error)

+ func (*License) Kind() Kind

+ func (*License) Refs() []Ref

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

+ func (l *License) UnmarshalYAML(value *yaml.Node) error

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

+ func (l License) MarshalYAML() (interface{}, error)

type Link

+ Description Text

+ OperationID Text

+ OperationRef *OperationRef

+ Parameters OrderedJSONObj

+ RequestBody jsonx.RawMessage

+ func (*Link) Kind() Kind

+ func (l *Link) Anchors() (*Anchors, error)

+ func (l *Link) DecodeRequestBody(dst interface{}) error

+ func (l *Link) Nodes() []Node

+ func (l *Link) Refs() []Ref

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

+ func (l *Link) UnmarshalYAML(value *yaml.Node) error

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

+ func (l Link) MarshalYAML() (interface{}, error)

+ type LinkMap = ComponentMap[*Link]

+ type LoadOpts struct

+ DefaultSchemaDialect *uri.URI

+ type Location struct

+ func NewLocation(uri uri.URI) (Location, error)

+ func (l Location) AbsoluteLocation() uri.URI

+ func (l Location) AppendLocation(p string) Location

+ func (l Location) IsRelativeTo(uri *uri.URI) bool

+ func (l Location) RelativeLocation() jsonpointer.Pointer

+ func (l Location) String() string

+ type Map struct

+ Items []KeyValue[T]

+ func (m *Map[T]) Del(key Text)

+ func (m *Map[T]) Set(key Text, value T)

+ func (m *Map[T]) UnmarshalJSON(data []byte) error

+ func (m Map[T]) Get(key Text) (T, bool)

+ func (m Map[T]) Has(key Text) bool

+ func (m Map[T]) MarshalJSON() ([]byte, error)

type MediaType

+ func (*MediaType) Kind() Kind

+ func (mt *MediaType) Anchors() (*Anchors, error)

+ func (mt *MediaType) Nodes() []Node

+ func (mt *MediaType) Refs() []Ref

+ type MediaTypeMap = ObjMap[*MediaType]

+ type Node interface

+ AbsoluteLocation func() uri.URI

+ Anchors func() (*Anchors, error)

+ Kind func() Kind

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

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

+ Refs func() []Ref

+ RelativeLocation func() jsonpointer.Pointer

+ UnmarshalJSON func(data []byte) error

+ UnmarshalYAML func(value *yaml.Node) error

type OAuthFlow

+ func (*OAuthFlow) Kind() Kind

+ func (f *OAuthFlow) Anchors() (*Anchors, error)

+ func (f *OAuthFlow) Refs() []Ref

+ func (r *OAuthFlow) Nodes() []Node

type OAuthFlows

+ func (*OAuthFlows) Kind() Kind

+ func (f *OAuthFlows) Anchors() (*Anchors, error)

+ func (f *OAuthFlows) Nodes() []Node

+ func (f *OAuthFlows) Refs() []Ref

+ type ObjMap struct

+ Items []ObjMapEntry[T]

+ func (*ObjMap[T]) Kind() Kind

+ func (om *ObjMap[T]) Anchors() (*Anchors, error)

+ func (om *ObjMap[T]) Del(key Text)

+ func (om *ObjMap[T]) Get(key Text) T

+ func (om *ObjMap[T]) MarshalJSON() ([]byte, error)

+ func (om *ObjMap[T]) Refs() []Ref

+ func (om *ObjMap[T]) Set(key Text, obj T)

+ func (om *ObjMap[T]) UnmarshalJSON(data []byte) error

+ func (om *ObjMap[T]) UnmarshalYAML(value *yaml.Node) error

+ func (om ObjMap[T]) MarshalYAML() (interface{}, error)

+ type ObjMapEntry struct

+ Key Text

+ Value T

+ type ObjSlice struct

+ Items []T

+ func (os *ObjSlice[T]) Anchors() (*Anchors, error)

+ func (os *ObjSlice[T]) Kind() Kind

+ func (os *ObjSlice[T]) MarshalJSON() ([]byte, error)

+ func (os *ObjSlice[T]) Refs() []Ref

+ func (os *ObjSlice[T]) UnmarshalJSON(data []byte) error

+ func (os *ObjSlice[T]) UnmarshalYAML(value *yaml.Node) error

+ func (os ObjSlice[T]) MarshalYAML() (interface{}, error)

type Operation

+ func (*Operation) Kind() Kind

+ func (o *Operation) Anchors() (*Anchors, error)

+ func (o *Operation) Nodes() []Node

+ func (o *Operation) Refs() []Ref

+ type OperationRef struct

+ Ref *uri.URI

+ Resolved *Operation

+ func (*OperationRef) Anchors() (*Anchors, error)

+ func (*OperationRef) Kind() Kind

+ func (*OperationRef) RefKind() Kind

+ func (*OperationRef) RefType() RefType

+ func (or *OperationRef) IsResolved() bool

+ func (or *OperationRef) Nodes() []Node

+ func (or *OperationRef) Refs() []Ref

+ func (or *OperationRef) ResolvedNode() Node

+ func (or *OperationRef) URI() *uri.URI

+ func (or *OperationRef) UnmarshalJSON(data []byte) error

+ func (or *OperationRef) UnmarshalYAML(value *yaml.Node) error

+ func (or OperationRef) MarshalJSON() ([]byte, error)

+ func (or OperationRef) MarshalYAML() (interface{}, error)

+ type OrderedJSONObj []JSONObjEntry

+ func (j *OrderedJSONObj) Set(key Text, value interface{}) error

+ func (j *OrderedJSONObj) UnmarshalJSON(data []byte) error

+ func (j OrderedJSONObj) Decode(dst interface{}) error

+ func (j OrderedJSONObj) DecodeValue(key Text, dst interface{}) error

+ func (j OrderedJSONObj) Get(key Text) jsonx.RawMessage

+ func (j OrderedJSONObj) Has(key Text) bool

+ func (j OrderedJSONObj) Map() map[string]jsonx.RawMessage

+ func (j OrderedJSONObj) MarshalJSON() ([]byte, error)

type Parameter

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content *ContentMap

+ Deprecated bool

+ Description Text

+ Example jsonx.RawMessage

+ Examples *ExampleMap

+ Explode bool

+ In In

+ Name Text

+ Required *bool

+ Schema *Schema

+ Style Text

+ func (*Parameter) Kind() Kind

+ func (p *Parameter) Anchors() (*Anchors, error)

+ func (p *Parameter) Nodes() []Node

+ func (p *Parameter) Refs() []Ref

+ func (p *Parameter) UnmarshalJSON(data []byte) error

+ func (p *Parameter) UnmarshalYAML(value *yaml.Node) error

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

+ func (p Parameter) MarshalYAML() (interface{}, error)

+ type ParameterMap = ComponentMap[*Parameter]

+ type ParameterSlice = ComponentSlice[*Parameter]

+ type PathItem struct

+ Delete *Operation

+ Description Text

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters *ParameterSlice

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Servers *ServerSlice

+ Summary Text

+ Trace *Operation

+ func (*PathItem) Kind() Kind

+ func (p *PathItem) UnmarshalJSON(data []byte) error

+ func (p *PathItem) UnmarshalYAML(value *yaml.Node) error

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

+ func (p PathItem) MarshalYAML() (interface{}, error)

+ func (pi *PathItem) Anchors() (*Anchors, error)

+ func (pi *PathItem) Nodes() []Node

+ func (pi *PathItem) Refs() []Ref

+ type PathItemEntry struct

+ Key string

+ PathItem *PathItem

+ type PathItemMap = ComponentMap[*PathItem]

type Paths

+ func (*Paths) Kind() Kind

+ func (p *Paths) Anchors() (*Anchors, error)

+ func (p *Paths) Nodes() []Node

+ func (p *Paths) UnmarshalYAML(value *yaml.Node) error

+ func (p Paths) MarshalYAML() (interface{}, error)

+ type Ref interface

+ IsResolved func() bool

+ RefKind func() Kind

+ RefType func() RefType

+ ResolvedNode func() Node

+ URI func() *uri.URI

+ type RefType uint8

+ const RefTypeComponent

+ const RefTypeOperationRef

+ const RefTypeSchema

+ const RefTypeSchemaDynamicRef

+ const RefTypeSchemaRecursiveRef

+ const RefTypeUndefined

+ func (rk RefType) String() string

type Reference

+ ReferencedKind Kind

+ Resolved T

+ func (*Reference[T]) RefType() RefType

+ func (*Reference[T]) Refs() []Ref

+ func (r *Reference[T]) Anchors() (*Anchors, error)

+ func (r *Reference[T]) IsResolved() bool

+ func (r *Reference[T]) Kind() Kind

+ func (r *Reference[T]) Nodes() []Node

+ func (r *Reference[T]) RefKind() Kind

+ func (r *Reference[T]) ResolvedNode() Node

+ func (r *Reference[T]) String() string

+ func (r *Reference[T]) URI() *uri.URI

+ func (r *Reference[T]) UnmarshalJSON(data []byte) error

+ func (r Reference[T]) MarshalJSON() ([]byte, error)

type RequestBody

+ Content *ContentMap

+ Description Text

+ Required bool

+ func (*RequestBody) Kind() Kind

+ func (rb *RequestBody) Anchors() (*Anchors, error)

+ func (rb *RequestBody) Nodes() []Node

+ func (rb *RequestBody) Refs() []Ref

+ func (rb *RequestBody) UnmarshalJSON(data []byte) error

+ func (rb *RequestBody) UnmarshalYAML(value *yaml.Node) error

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

+ func (rb RequestBody) MarshalYAML() (interface{}, error)

+ type RequestBodyMap = ComponentMap[*RequestBody]

+ type ResolutionError struct

+ Actual Kind

+ Expected Kind

+ RefType RefType

+ URI uri.URI

+ func (e *ResolutionError) Error() string

+ func (e *ResolutionError) Unwrap() error

type Response

+ Content *ContentMap

+ Description Text

+ Headers *HeaderMap

+ Links *LinkMap

+ func (*Response) Kind() Kind

+ func (r *Response) Anchors() (*Anchors, error)

+ func (r *Response) Nodes() []Node

+ func (r *Response) Refs() []Ref

+ func (r *Response) UnmarshalJSON(data []byte) error

+ func (r *Response) UnmarshalYAML(value *yaml.Node) error

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

+ func (r Response) MarshalYAML() (interface{}, error)

+ type ResponseMap = ComponentMap[*Response]

type Schema

+ AdditionalItems *Schema

+ AdditionalProperties *Schema

+ AllOf *SchemaSlice

+ Anchor Text

+ AnyOf *SchemaSlice

+ Comments Text

+ Const jsonx.RawMessage

+ Contains *Schema

+ ContentEncoding Text

+ ContentMediaType Text

+ Default jsonx.RawMessage

+ Definitions *SchemaMap

+ DependentRequired *Map[Texts]

+ DependentSchemas *SchemaMap

+ Deprecated *bool

+ Description Text

+ Discriminator *Discriminator

+ DynamicAnchor Text

+ DynamicRef *SchemaRef

+ Else *Schema

+ Enum Texts

+ Example jsonx.RawMessage

+ Examples []jsonx.RawMessage

+ ExclusiveMaximum *Number

+ ExclusiveMinimum *Number

+ ExternalDocs Text

+ Format Text

+ ID *uri.URI

+ If *Schema

+ Items *Schema

+ Keywords map[Text]jsonx.RawMessage

+ MaxContains *Number

+ MaxLength *Number

+ MaxProperties *Number

+ Maximum *Number

+ MinContains *Number

+ MinLength *Number

+ MinProperties *Number

+ Minimum *Number

+ MultipleOf *Number

+ Not *Schema

+ OneOf *SchemaSlice

+ Pattern *Regexp

+ PatternProperties *SchemaMap

+ PrefixItems *SchemaSlice

+ Properties *SchemaMap

+ PropertyNames *Schema

+ ReadOnly *bool

+ RecursiveAnchor *bool

+ RecursiveRef *SchemaRef

+ Ref *SchemaRef

+ RegexProperties *bool

+ Required Texts

+ Schema *uri.URI

+ Then *Schema

+ Title Text

+ Type Types

+ UnevaluatedItems *Schema

+ UnevaluatedProperties *Schema

+ UniqueItems *bool

+ WriteOnly *bool

+ XML *XML

+ func (*Schema) Kind() Kind

+ func (s *Schema) Anchors() (*Anchors, error)

+ func (s *Schema) Clone() *Schema

+ func (s *Schema) DecodeKeyword(key Text, dst interface{}) error

+ func (s *Schema) DecodeKeywords(dst interface{}) error

+ func (s *Schema) Nodes() []Node

+ func (s *Schema) Refs() []Ref

+ func (s *Schema) SetKeyword(key Text, value interface{}) error

+ func (s *Schema) UnmarshalJSON(data []byte) error

+ func (s *Schema) UnmarshalYAML(value *yaml.Node) error

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

+ func (s Schema) MarshalYAML() (interface{}, error)

+ type SchemaItem struct

+ Key Text

+ Schema *Schema

+ func (si *SchemaItem) Clone() SchemaItem

+ type SchemaMap struct

+ Items []SchemaItem

+ func (*SchemaMap) Kind() Kind

+ func (sm *SchemaMap) Anchors() (*Anchors, error)

+ func (sm *SchemaMap) Clone() *SchemaMap

+ func (sm *SchemaMap) Nodes() []Node

+ func (sm *SchemaMap) Refs() []Ref

+ func (sm *SchemaMap) Set(key Text, s *Schema)

+ func (sm *SchemaMap) UnmarshalJSON(data []byte) error

+ func (sm *SchemaMap) UnmarshalYAML(value *yaml.Node) error

+ func (sm SchemaMap) Get(key Text) *Schema

+ func (sm SchemaMap) MarshalJSON() ([]byte, error)

+ func (sm SchemaMap) MarshalYAML() (interface{}, error)

+ type SchemaRef struct

+ Ref *uri.URI

+ Resolved *Schema

+ SchemaRefKind SchemaRefType

+ func (*SchemaRef) Anchors() (*Anchors, error)

+ func (*SchemaRef) Kind() Kind

+ func (*SchemaRef) Refs() []Ref

+ func (sr *SchemaRef) Clone() *SchemaRef

+ func (sr *SchemaRef) IsResolved() bool

+ func (sr *SchemaRef) Nodes() []Node

+ func (sr *SchemaRef) RefKind() Kind

+ func (sr *SchemaRef) RefType() RefType

+ func (sr *SchemaRef) ResolvedNode() Node

+ func (sr *SchemaRef) URI() *uri.URI

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

+ func (sr *SchemaRef) UnmarshalYAML(value *yaml.Node) error

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

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

+ type SchemaRefType uint8

+ const SchamRefTypeUndefined

+ const SchemaRefTypeDynamic

+ const SchemaRefTypeRecursive

+ const SchemaRefTypeRef

+ type SchemaSlice struct

+ Items []*Schema

+ func (*SchemaSlice) Kind() Kind

+ func (ss *SchemaSlice) Anchors() (*Anchors, error)

+ func (ss *SchemaSlice) Clone() *SchemaSlice

+ func (ss *SchemaSlice) Nodes() []Node

+ func (ss *SchemaSlice) Refs() []Ref

+ func (ss *SchemaSlice) UnmarshalJSON(data []byte) error

+ func (ss *SchemaSlice) UnmarshalYAML(value *yaml.Node) error

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

+ func (ss SchemaSlice) MarshalYAML() (interface{}, error)

+ type Scope struct

+ Key Text

+ Value Text

+ func (*Scope) Anchors() (*Anchors, error)

+ func (*Scope) Kind() Kind

+ func (s *Scope) Nodes() []Node

+ func (s *Scope) Refs() []Ref

+ func (s *Scope) UnmarshalJSON(data []byte) error

+ func (s *Scope) UnmarshalYAML(value *yaml.Node) error

+ func (s Scope) MarshalJSON() ([]byte, error)

+ func (s Scope) MarshalYAML() (interface{}, error)

+ func (s Scope) String() string

+ func (s Scope) Text() Text

+ type Scopes struct

+ Items []*Scope

+ func (*Scopes) Anchors() (*Anchors, error)

+ func (*Scopes) Kind() Kind

+ func (s *Scopes) Map() map[Text]Text

+ func (s *Scopes) Nodes() []Node

+ func (s *Scopes) Refs() []Ref

+ func (s *Scopes) Set(key Text, value Text)

+ func (s *Scopes) UnmarshalJSON(data []byte) error

+ func (s *Scopes) UnmarshalYAML(value *yaml.Node) error

+ func (s Scopes) Get(key Text) *Scope

+ func (s Scopes) Has(key Text) bool

+ func (s Scopes) MarshalJSON() ([]byte, error)

+ func (s Scopes) MarshalYAML() (interface{}, error)

+ type SecurityRequirementItem struct

+ Key Text

+ Value Texts

+ func (*SecurityRequirementItem) Kind() Kind

+ func (sri *SecurityRequirementItem) Anchors() (*Anchors, error)

+ func (sri *SecurityRequirementItem) Nodes() []Node

+ func (sri *SecurityRequirementItem) Refs() []Ref

+ func (sri *SecurityRequirementItem) UnmarshalJSON(data []byte) error

+ func (sri *SecurityRequirementItem) UnmarshalYAML(value *yaml.Node) error

+ func (sri SecurityRequirementItem) MarshalJSON() ([]byte, error)

+ func (sri SecurityRequirementItem) MarshalYAML() (interface{}, error)

+ type SecurityRequirementMap = ObjMap[*SecurityRequirement]

+ type SecurityRequirementSlice = ObjSlice[*SecurityRequirement]

type SecurityScheme

+ BearerFormat Text

+ Description Text

+ Flows *OAuthFlows

+ In In

+ Name Text

+ OpenIDConnectURL Text

+ Scheme Text

+ Type Text

+ func (*SecurityScheme) Kind() Kind

+ func (ss *SecurityScheme) Anchors() (*Anchors, error)

+ func (ss *SecurityScheme) Nodes() []Node

+ func (ss *SecurityScheme) Refs() []Ref

+ func (ss *SecurityScheme) UnmarshalJSON(data []byte) error

+ func (ss *SecurityScheme) UnmarshalYAML(value *yaml.Node) error

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

+ func (ss SecurityScheme) MarshalYAML() (interface{}, error)

+ type SecuritySchemeMap = ComponentMap[*SecurityScheme]

+ type SemVerError struct

+ Err error

+ URI uri.URI

+ Value string

+ func (e SemVerError) Error() string

+ func (e SemVerError) Is(err error) bool

+ func (e SemVerError) Unwrap() error

type Server

+ func (*Server) Anchors() (*Anchors, error)

+ func (*Server) Kind() Kind

+ func (s *Server) Nodes() []Node

+ func (s *Server) Refs() []Ref

+ type ServerSlice = ObjSlice[*Server]

type ServerVariable

+ func (*ServerVariable) Kind() Kind

+ func (*ServerVariable) Refs() []Ref

+ func (sv *ServerVariable) Anchors() (*Anchors, error)

+ func (sv *ServerVariable) Nodes() []Node

+ type ServerVariableMap = ObjMap[*ServerVariable]

+ type StdValidator struct

+ Schemas CompiledSchemas

+ func NewValidator(compiler *jsonschema.Compiler, resources ...fs.FS) (*StdValidator, error)

+ func (sv *StdValidator) Validate(data []byte, resource uri.URI, kind Kind, openapi semver.Version, ...) error

+ func (sv *StdValidator) ValidateDocument(doc *Document) error

type Tag

+ func (*Tag) Anchors() (*Anchors, error)

+ func (*Tag) Kind() Kind

+ func (*Tag) Refs() []Ref

+ func (t *Tag) Nodes() []Node

+ type TagMap = ObjMap[*Tag]

+ type TagSlice struct

+ Items []*Tag

+ func (*TagSlice) Anchors() (*Anchors, error)

+ func (*TagSlice) Kind() Kind

+ func (t *TagSlice) UnmarshalYAML(value *yaml.Node) error

+ func (t TagSlice) MarshalYAML() (interface{}, error)

+ func (tl *TagSlice) Nodes() []Node

+ func (ts *TagSlice) MarshalJSON() ([]byte, error)

+ func (ts *TagSlice) Refs() []Ref

+ func (ts *TagSlice) UnmarshalJSON(data []byte) error

+ type Text = text.Text

+ type Texts = text.Texts

+ type Type = Text

type Types

+ func (t Types) Clone() Types

+ type UnsupportedVersionError struct

+ Errs []error

+ Version string

+ func (e *UnsupportedVersionError) As(target interface{}) bool

+ func (e *UnsupportedVersionError) Error() string

+ func (e *UnsupportedVersionError) Is(err error) bool

+ type ValidationError struct

+ Err error

+ Kind Kind

+ URI uri.URI

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Unwrap() error

+ type Validator interface

+ Validate func(data []byte, resource uri.URI, kind Kind, openapi semver.Version, ...) error

+ ValidateDocument func(document *Document) error

type XML

+ func (*XML) Anchors() (*Anchors, error)

+ func (*XML) Kind() Kind

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

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

+ func (xml *XML) Clone() *XML

+ func (xml *XML) Nodes() []Node

+ func (xml *XML) Refs() []Ref

+ func (xml *XML) UnmarshalYAML(value *yaml.Node) error

+ func (xml XML) MarshalYAML() (interface{}, error)

v0.0.8

Feb 24, 2022

v0.0.7

Jan 31, 2022

Changes in this version

type SchemaObj

+ Example json.RawMessage

v0.0.6

Jan 3, 2022

Changes in this version

type HeaderObj

+ Example json.RawMessage

type ParameterObj

+ Example json.RawMessage

v0.0.5

Dec 3, 2021

Changes in this version

type Callback

+ ResolveCallback func(CallbackResolver) (*CallbackObj, error)

type CallbackObj

+ func (c *CallbackObj) ResolveCallback(CallbackResolver) (*CallbackObj, error)

+ type CallbackResolver func(ref string) (*CallbackObj, error)

type Example

+ ResolveExample func(ExampleResolver) (*ExampleObj, error)

type ExampleObj

+ func (e *ExampleObj) ResolveExample(ExampleResolver) (*ExampleObj, error)

+ type ExampleResolver func(ref string) (*ExampleObj, error)

type Header

+ ResolveHeader func(HeaderResolver) (*HeaderObj, error)

type HeaderObj

+ func (h *HeaderObj) ResolveHeader(HeaderResolver) (*HeaderObj, error)

+ type HeaderResolver func(ref string) (*HeaderObj, error)

type Link

+ ResolveLink func(LinkResolver) (*LinkObj, error)

type LinkObj

+ func (l *LinkObj) ResolveLink(LinkResolver) (*LinkObj, error)

+ type LinkResolver func(ref string) (*LinkObj, error)

type Parameter

+ ParameterKind func() ParameterKind

+ ResolveParameter func(ParameterResolver) (*ParameterObj, error)

+ type ParameterKind uint

+ const ParameterKindObj

+ const ParameterKindReference

type ParameterObj

+ func (p *ParameterObj) ParameterKind() ParameterKind

+ func (p *ParameterObj) ResolveParameter(resolve ParameterResolver) (*ParameterObj, error)

+ type ParameterResolver func(ref string) (*ParameterObj, error)

type Path

+ ResolvePath func(PathResolver) (*PathObj, error)

type PathObj

+ func (p *PathObj) ResolvePath(PathResolver) (*PathObj, error)

+ type PathResolver func(ref string) (*PathObj, error)

type Reference

+ func (r *Reference) ParameterKind() ParameterKind

+ func (r *Reference) ResolveCallback(resolve CallbackResolver) (*CallbackObj, error)

+ func (r *Reference) ResolveExample(resolve ExampleResolver) (*ExampleObj, error)

+ func (r *Reference) ResolveHeader(resolve HeaderResolver) (*HeaderObj, error)

+ func (r *Reference) ResolveLink(resolve LinkResolver) (*LinkObj, error)

+ func (r *Reference) ResolveParameter(resolve ParameterResolver) (*ParameterObj, error)

+ func (r *Reference) ResolvePath(resolve PathResolver) (*PathObj, error)

+ func (r *Reference) ResolveRequestBody(resolve RequestBodyResolver) (*RequestBodyObj, error)

+ func (r *Reference) ResolveResponse(resolve ResponseResolver) (*ResponseObj, error)

+ func (r *Reference) ResolveSecurityScheme(resolve SecuritySchemeResolver) (*SecuritySchemeObj, error)

type RequestBody

+ ResolveRequestBody func(RequestBodyResolver) (*RequestBodyObj, error)

type RequestBodyObj

+ func (rb *RequestBodyObj) ResolveRequestBody(RequestBodyResolver) (*RequestBodyObj, error)

+ type RequestBodyResolver func(ref string) (*RequestBodyObj, error)

type Response

+ ResolveResponse func(ResponseResolver) (*ResponseObj, error)

type ResponseObj

+ func (r *ResponseObj) ResolveResponse(ResponseResolver) (*ResponseObj, error)

+ type ResponseResolver func(ref string) (*ResponseObj, error)

type SchemaObj

+ Always *bool

+ func (s *SchemaObj) ResolveSchema(SchemaResolver) (*SchemaObj, error)

+ type SchemaResolver func(ref string) (*SchemaObj, error)

type SecurityScheme

+ ResolveSecurityScheme func(SecuritySchemeResolver) (*SecuritySchemeObj, error)

type SecuritySchemeObj

+ func (sso *SecuritySchemeObj) ResolveSecurityScheme(SecuritySchemeResolver) (*SecuritySchemeObj, error)

+ type SecuritySchemeResolver func(ref string) (*SecuritySchemeObj, error)

v0.0.4

Nov 30, 2021

v0.0.2

Nov 30, 2021

v0.0.1

Nov 30, 2021

Changes in this version

+ var ErrLinkParameterNotFound = errors.New("error: link parameter not found")

+ var ErrNotReference = errors.New("error: data is not a Reference")

+ func IsExtensionKey(key string) bool

+ func Validate(data []byte) error

+ type Boolean bool

+ func (b Boolean) IsRef() bool

+ func (b Boolean) SchemaKind() SchemaKind

+ type Callback interface

+ CallbackKind func() CallbackKind

+ type CallbackKind uint8

+ const CallbackKindObj

+ const CallbackKindRef

+ type CallbackObj struct

+ Paths PathItems

+ func (c *CallbackObj) CallbackKind() CallbackKind

+ func (c *CallbackObj) UnmarshalJSON(data []byte) error

+ func (c *CallbackObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (c CallbackObj) MarshalJSON() ([]byte, error)

+ func (c CallbackObj) MarshalYAML() (interface{}, error)

+ type Callbacks map[string]Callback

+ func (c *Callbacks) UnmarshalJSON(data []byte) error

+ func (c *Callbacks) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (c Callbacks) MarshalYAML() (interface{}, error)

+ type Components struct

+ Callbacks *Callbacks

+ Examples *Examples

+ Headers *Headers

+ Links *Links

+ Parameters *Parameters

+ PathItems *PathItems

+ RequestBodies *RequestBodies

+ Responses *Responses

+ Schemas *Schemas

+ SecuritySchemes *SecuritySchemes

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

+ func (c *Components) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (c Components) MarshalYAML() (interface{}, error)

+ type Contact struct

+ Emails string

+ Name string

+ URL string

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

+ func (c *Contact) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (c Contact) MarshalYAML() (interface{}, error)

+ type Content map[string]*MediaType

+ type Discriminator struct

+ Mapping map[string]string

+ PropertyName string

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

+ func (d *Discriminator) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (d Discriminator) MarshalYAML() (interface{}, error)

+ type Encoding struct

+ AllowReserved *bool

+ ContentType string

+ Explode *bool

+ Headers Headers

+ Style Style

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

+ func (e *Encoding) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (e Encoding) MarshalYAML() (interface{}, error)

+ type Encodings map[string]*Encoding

+ type Example interface

+ ExampleKind func() ExampleKind

+ type ExampleKind uint8

+ const ExampleKindObj

+ const ExampleKindRef

+ type ExampleObj struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value json.RawMessage

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

+ func (e *ExampleObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (e ExampleObj) ExampleKind() ExampleKind

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

+ func (e ExampleObj) MarshalYAML() (interface{}, error)

+ type Examples map[string]Example

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

+ type Extensions map[string]json.RawMessage

+ func (e *Extensions) SetEncodedExtension(key string, val []byte)

+ func (e *Extensions) SetExtension(key string, val interface{}) error

+ func (e Extensions) Decode(dst interface{}) error

+ func (e Extensions) DecodeExtension(key string, dst interface{}) error

+ func (e Extensions) Extension(name string) (interface{}, bool)

+ type ExternalDocs struct

+ Description string

+ URL string

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

+ func (ed *ExternalDocs) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (ed ExternalDocs) MarshalYAML() (interface{}, error)

+ type Header interface

+ HeaderKind func() HeaderKind

+ type HeaderKind uint8

+ const HeaderKindObj

+ const HeaderKindRef

+ type HeaderObj struct

+ AllowEmptyValue *bool

+ AllowReserved *bool

+ Deprecated *bool

+ Description string

+ Examples map[string]Example

+ Explode *bool

+ Required *bool

+ Schema *SchemaObj

+ Style string

+ func (h *HeaderObj) UnmarshalJSON(data []byte) error

+ func (h *HeaderObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (h HeaderObj) HeaderKind() HeaderKind

+ func (h HeaderObj) MarshalJSON() ([]byte, error)

+ func (h HeaderObj) MarshalYAML() (interface{}, error)

+ type Headers map[string]Header

+ func (h *Headers) UnmarshalJSON(data []byte) error

+ func (h *Headers) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (h Headers) MarshalYAML() (interface{}, error)

+ type In string

+ const InCookie

+ const InHeader

+ const InPath

+ const InQuery

+ func (in In) String() string

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ Summary string

+ TermsOfService string

+ Title string

+ Version string

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

+ func (i *Info) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (i Info) MarshalYAML() (interface{}, error)

+ type License struct

+ Identifier string

+ Name string

+ URL string

+ type Link interface

+ LinkKind func() LinkKind

+ type LinkKind uint8

+ const LinkKindObj

+ const LinkKindRef

+ type LinkObj struct

+ Description string

+ OperationID string

+ OperationRef string

+ Parameters LinkParameters

+ RequestBody json.RawMessage

+ func (l *LinkObj) DecodeRequestBody(dst interface{}) error

+ func (l *LinkObj) LinkKind() LinkKind

+ func (l *LinkObj) UnmarshalJSON(data []byte) error

+ func (l *LinkObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (l LinkObj) MarshalJSON() ([]byte, error)

+ func (l LinkObj) MarshalYAML() (interface{}, error)

+ type LinkParameters map[string]json.RawMessage

+ func (lp *LinkParameters) Set(key string, value interface{}) error

+ func (lp *LinkParameters) SetEncoded(key string, value []byte)

+ func (lp LinkParameters) Decode(dst interface{}) error

+ func (lp LinkParameters) DecodeParameter(key string, dst interface{}) error

+ func (lp LinkParameters) Has(key string) bool

+ type Links map[string]Link

+ func (l *Links) UnmarshalJSON(data []byte) error

+ type MediaType struct

+ Encoding Encodings

+ Example json.RawMessage

+ Examples Examples

+ Schema Schema

+ func (mt *MediaType) UnmarshalJSON(data []byte) error

+ func (mt *MediaType) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (mt MediaType) MarshalYAML() (interface{}, error)

+ type Number json.Number

+ func (n *Number) UnmarshalJSON(data []byte) error

+ func (n Number) BigFloat(m big.RoundingMode) (*big.Float, error)

+ func (n Number) BigInt() (*big.Int, bool)

+ func (n Number) BigRat() (*big.Rat, bool)

+ func (n Number) Float64() (float64, error)

+ func (n Number) Int64() (int64, error)

+ func (n Number) MarshalJSON() ([]byte, error)

+ func (n Number) String() string

+ type OAuthFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

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

+ func (o *OAuthFlow) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (o OAuthFlow) MarshalYAML() (interface{}, error)

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

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

+ func (oaf *OAuthFlows) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (oaf OAuthFlows) MarshalYAML() (interface{}, error)

+ type OpenAPI struct

+ Components *Components

+ ExternalDocs *ExternalDocs

+ Info *Info

+ JSONSchemaDialect string

+ Paths *Paths

+ Security []*SecurityRequirement

+ Servers []*Server

+ Tags []*Tag

+ Version string

+ Webhooks *PathItems

+ func (o *OpenAPI) UnmarshalJSON(data []byte) error

+ func (o *OpenAPI) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (o OpenAPI) MarshalJSON() ([]byte, error)

+ func (o OpenAPI) MarshalYAML() (interface{}, error)

+ func (o OpenAPI) Validate() error

+ type OpenAPIs []*OpenAPI

+ type Operation struct

+ Callbacks Callbacks

+ Deprecated bool

+ Description string

+ ExternalDocs *ExternalDocs

+ OperationID string

+ Parameters *ParameterList

+ RequestBody RequestBody

+ Responses Responses

+ Security SecurityRequirements

+ Servers []*Server

+ Summary string

+ Tags []string

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

+ func (o *Operation) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (o Operation) MarshalYAML() (interface{}, error)

+ type Parameter interface

+ ParameterType func() ParameterType

+ type ParameterList []Parameter

+ func (p *ParameterList) UnmarshalJSON(data []byte) error

+ func (p *ParameterList) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (p ParameterList) MarshalJSON() ([]byte, error)

+ func (p ParameterList) MarshalYAML() (interface{}, error)

+ type ParameterObj struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content Content

+ Deprecated bool

+ Description string

+ Examples map[string]Example

+ Explode bool

+ In In

+ Name string

+ Required *bool

+ Schema Schema

+ Style string

+ func (p *ParameterObj) ParameterType() ParameterType

+ func (p *ParameterObj) UnmarshalJSON(data []byte) error

+ func (p *ParameterObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (p ParameterObj) MarshalJSON() ([]byte, error)

+ func (p ParameterObj) MarshalYAML() (interface{}, error)

+ type ParameterType uint

+ const ParameterTypeObj

+ const ParameterTypeReference

+ type Parameters map[string]Parameter

+ func (p *Parameters) UnmarshalJSON(data []byte) error

+ type Path interface

+ PathKind func() PathKind

+ type PathItems map[string]Path

+ func (rp *PathItems) UnmarshalJSON(data []byte) error

+ func (rp *PathItems) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (rp PathItems) MarshalYAML() (interface{}, error)

+ type PathKind uint8

+ const PathKindObj

+ const PathKindRef

+ type PathObj struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters *ParameterList

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers []*Server

+ Summary string

+ Trace *Operation

+ func (p *PathObj) PathKind() PathKind

+ func (p *PathObj) UnmarshalJSON(data []byte) error

+ func (p *PathObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (p PathObj) MarshalJSON() ([]byte, error)

+ func (p PathObj) MarshalYAML() (interface{}, error)

+ type PathValue string

+ func (pv PathValue) MarshalJSON() ([]byte, error)

+ func (pv PathValue) MarshalYAML() ([]byte, error)

+ func (pv PathValue) Params() []string

+ func (pv PathValue) String() string

+ type Paths struct

+ Items map[PathValue]*PathObj

+ func (p *Paths) UnmarshalJSON(data []byte) error

+ func (p Paths) MarshalJSON() ([]byte, error)

+ type Referencable interface

+ IsRef func() bool

+ type Reference struct

+ Description string

+ Ref string

+ Summary string

+ func (r *Reference) CallbackKind() CallbackKind

+ func (r *Reference) ExampleKind() ExampleKind

+ func (r *Reference) HeaderKind() HeaderKind

+ func (r *Reference) LinkKind() LinkKind

+ func (r *Reference) ParameterType() ParameterType

+ func (r *Reference) PathKind() PathKind

+ func (r *Reference) RequestBodyKind() RequestBodyKind

+ func (r *Reference) ResponseKind() ResponseKind

+ func (r *Reference) SecuritySchemeKind() SecuritySchemeKind

+ func (r *Reference) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (r Reference) MarshalYAML() (interface{}, error)

+ type Regexp struct

+ func (sr *Regexp) IsNil() bool

+ func (sr *Regexp) UnmarshalJSON(data []byte) error

+ func (sr Regexp) MarshalJSON() ([]byte, error)

+ type RequestBodies map[string]RequestBody

+ func (rb RequestBodies) UnmarshalJSON(data []byte) error

+ type RequestBody interface

+ RequestBodyKind func() RequestBodyKind

+ type RequestBodyKind int

+ const RequestBodyKindObj

+ const RequestBodyKindRef

+ type RequestBodyObj struct

+ Content Content

+ Description string

+ Required bool

+ func (rb *RequestBodyObj) RequestBodyKind() RequestBodyKind

+ func (rb *RequestBodyObj) UnmarshalJSON(data []byte) error

+ func (rb *RequestBodyObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (rb RequestBodyObj) MarshalJSON() ([]byte, error)

+ func (rb RequestBodyObj) MarshalYAML() (interface{}, error)

+ type Response interface

+ ResponseKind func() ResponseKind

+ type ResponseKind int

+ const ResponseKindObj

+ const ResponseKindRef

+ type ResponseObj struct

+ Content Content

+ Description string

+ Headers Headers

+ Links Links

+ func (r *ResponseObj) UnmarshalJSON(data []byte) error

+ func (r *ResponseObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (r ResponseObj) MarshalJSON() ([]byte, error)

+ func (r ResponseObj) MarshalYAML() (interface{}, error)

+ func (r ResponseObj) ResponseKind() ResponseKind

+ type Responses map[string]Response

+ func (r *Responses) UnmarshalJSON(data []byte) error

+ func (r *Responses) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (r Responses) MarshalYAML() (interface{}, error)

+ type Schema interface

+ IsRef func() bool

+ SchemaKind func() SchemaKind

+ type SchemaKind uint8

+ const SchemaKindBool

+ const SchemaKindObj

+ type SchemaObj struct

+ AdditionalObjs Schema

+ AdditionalProperties Schema

+ AllOf SchemaSet

+ Anchor string

+ AnyOf SchemaSet

+ Comments string

+ Const json.RawMessage

+ Contains Schema

+ ContentEncoding string

+ ContentMediaType string

+ Default json.RawMessage

+ Definitions Schemas

+ DependentRequired map[string][]string

+ DependentSchemas Schemas

+ Deprecated *bool

+ Description string

+ Discriminator *Discriminator

+ DynamicAnchor string

+ DynamicRef string

+ Else Schema

+ Enum []string

+ Examples json.RawMessage

+ ExclusiveMaximum *Number

+ ExclusiveMinimum *Number

+ ExternalDocs string

+ Format string

+ ID string

+ If Schema

+ Items Schema

+ Keywords map[string]json.RawMessage

+ MaxContains *Number

+ MaxLength *Number

+ MaxProperties *int

+ Maximum *Number

+ MinContains *Number

+ MinLength *Number

+ MinProperties *int

+ Minimum *Number

+ MultipleOf *Number

+ Not Schema

+ OneOf SchemaSet

+ Pattern *Regexp

+ PatternProperties Schemas

+ PrefixObjs SchemaSet

+ Properties Schemas

+ PropertyNames Schema

+ ReadOnly *bool

+ RecursiveAnchor *bool

+ RecursiveRef string

+ Ref string

+ RegexProperties *bool

+ Required []string

+ Schema string

+ Then Schema

+ Title string

+ Type Types

+ UnevaluatedObjs Schema

+ UnevaluatedProperties Schema

+ UniqueObjs *bool

+ WriteOnly *bool

+ XML *XML

+ func (s *SchemaObj) DecodeKeyword(key string, dst interface{}) error

+ func (s *SchemaObj) DecodeKeywords(dst interface{}) error

+ func (s *SchemaObj) IsBool() bool

+ func (s *SchemaObj) IsRef() bool

+ func (s *SchemaObj) IsStrings() bool

+ func (s *SchemaObj) SchemaKind() SchemaKind

+ func (s *SchemaObj) SetEncodedKeyword(key string, value []byte) error

+ func (s *SchemaObj) SetKeyword(key string, value interface{}) error

+ func (s *SchemaObj) UnmarshalJSON(data []byte) error

+ func (s *SchemaObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (s SchemaObj) Detail() *SchemaObj

+ func (s SchemaObj) MarshalJSON() ([]byte, error)

+ func (s SchemaObj) MarshalYAML() (interface{}, error)

+ type SchemaSet []Schema

+ func (s *SchemaSet) UnmarshalJSON(data []byte) error

+ type SchemaType string

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNull

+ const TypeNumber

+ const TypeObject

+ const TypeString

+ func (t SchemaType) IsEmpty() bool

+ func (t SchemaType) String() string

+ type Schemas map[string]Schema

+ func (s *Schemas) UnmarshalJSON(data []byte) error

+ type SecurityRequirement map[string][]string

+ type SecurityRequirements []SecurityRequirement

+ type SecurityScheme interface

+ SecuritySchemeKind func() SecuritySchemeKind

+ type SecuritySchemeKind uint8

+ const SecuritySchemeKindObj

+ const SecuritySchemeKindRef

+ type SecuritySchemeObj struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ In In

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type SecuritySchemeType

+ func (sso *SecuritySchemeObj) UnmarshalJSON(data []byte) error

+ func (sso *SecuritySchemeObj) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (sso SecuritySchemeObj) MarshalJSON() ([]byte, error)

+ func (sso SecuritySchemeObj) MarshalYAML() (interface{}, error)

+ func (sso SecuritySchemeObj) SecuritySchemeKind() SecuritySchemeKind

+ type SecuritySchemeType string

+ const SecuritySchemeTypeAPIKey

+ const SecuritySchemeTypeHTTP

+ const SecuritySchemeTypeMutualTLS

+ const SecuritySchemeTypeOAuth2

+ const SecuritySchemeTypeOpenIDConnect

+ func (ss SecuritySchemeType) String() string

+ type SecuritySchemes map[string]SecurityScheme

+ func (ss *SecuritySchemes) UnmarshalJSON(data []byte) error

+ func (ss *SecuritySchemes) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (ss SecuritySchemes) MarshalYAML() (interface{}, error)

+ type Server struct

+ Description string

+ URL string

+ Variables map[string]*ServerVariable

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

+ func (s *Server) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (s Server) MarshalYAML() (interface{}, error)

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

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

+ func (sv *ServerVariable) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (sv ServerVariable) MarshalYAML() (interface{}, error)

+ type Style string

+ const StyleDeepObject

+ const StyleForm

+ const StyleLabel

+ const StyleMatrix

+ const StylePipeDelimited

+ const StyleSimple

+ func (s Style) String() string

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ Name string

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

+ func (t *Tag) UnmarshalYAML(unmarshal func(interface{}) error) error

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

+ func (t Tag) MarshalYAML() (interface{}, error)

+ type Types []SchemaType

+ func (t *Types) Add(typ SchemaType) Types

+ func (t *Types) Remove(typ SchemaType) Types

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

+ func (t Types) Contains(typ SchemaType) bool

+ func (t Types) ContainsArray() bool

+ func (t Types) ContainsBoolean() bool

+ func (t Types) ContainsInteger() bool

+ func (t Types) ContainsNull() bool

+ func (t Types) ContainsNumber() bool

+ func (t Types) ContainsObject() bool

+ func (t Types) ContainsString() bool

+ func (t Types) IsSingle() bool

+ func (t Types) Len() int

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

+ type XML struct

+ Attribute bool

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL