openapi

Jan 7, 2026

Changes in this version

type OpenAPI

+ func (o *OpenAPI) GetDocumentBaseURI() string

+ func (o *OpenAPI) GetSchemaRegistry() oas3.SchemaRegistry

+ func (o *OpenAPI) SetSchemaRegistry(registry oas3.SchemaRegistry)

Dec 10, 2025

Changes in this version

+ var MaximumSupportedVersion = version.MustParse(Version)

+ var MinimumSupportedVersion = version.MustParse("3.0.0")

+ var TagKindDescriptions = map[TagKind]string

+ func GetTagKindDescription(kind TagKind) string

+ func IsStandardMethod(s string) bool

type Example

+ DataValue values.Value

+ SerializedValue *string

+ func (e *Example) GetDataValue() values.Value

+ func (e *Example) GetSerializedValue() string

type HTTPMethod

+ const HTTPMethodQuery

type MediaType

+ ItemEncoding *Encoding

+ ItemSchema *oas3.JSONSchema[oas3.Referenceable]

+ PrefixEncoding []*Encoding

+ func (m *MediaType) GetItemEncoding() *Encoding

+ func (m *MediaType) GetItemSchema() *oas3.JSONSchema[oas3.Referenceable]

+ func (m *MediaType) GetPrefixEncoding() []*Encoding

+ type MediaTypeContext struct

+ MediaType string

type OAuthFlow

+ DeviceAuthorizationURL *string

+ func (o *OAuthFlow) GetDeviceAuthorizationURL() string

type OAuthFlowType

+ const OAuthFlowTypeDeviceAuthorization

type OAuthFlows

+ DeviceAuthorization *OAuthFlow

+ func (o *OAuthFlows) GetDeviceAuthorization() *OAuthFlow

type OpenAPI

+ Self *string

+ func NewOpenAPI() *OpenAPI

+ func (o *OpenAPI) GetSelf() string

type Option

+ func WithUpgradeSameMinorVersion() Option[UpgradeOptions]

+ func WithUpgradeTargetVersion(version string) Option[UpgradeOptions]

type ParameterIn

+ const ParameterInQueryString

type PathItem

+ AdditionalOperations *sequencedmap.Map[string, *Operation]

+ func (p *PathItem) GetAdditionalOperations() *sequencedmap.Map[string, *Operation]

+ func (p *PathItem) Query() *Operation

type SecurityScheme

+ Deprecated *bool

+ OAuth2MetadataUrl *string

+ func (s *SecurityScheme) GetDeprecated() bool

+ func (s *SecurityScheme) GetOAuth2MetadataUrl() string

type Server

+ Name *string

+ func (s *Server) GetName() string

type Tag

+ Kind *string

+ Parent *string

+ Summary *string

+ func (t *Tag) GetKind() string

+ func (t *Tag) GetParent() string

+ func (t *Tag) GetSummary() string

+ type TagGroup struct

+ Name string

+ Tags []string

+ type TagKind string

+ const TagKindAudience

+ const TagKindBadge

+ const TagKindNav

+ func GetRegisteredTagKinds() []TagKind

+ func (tk TagKind) IsRegistered() bool

+ func (tk TagKind) String() string

Oct 14, 2025

Changes in this version

+ func Snip(ctx context.Context, doc *OpenAPI, operations []OperationIdentifier) (int, error)

+ type OperationIdentifier struct

+ Method string

+ OperationID string

+ Path string

Oct 14, 2025

Changes in this version

+ type ExtensionFilter struct

+ Keep []string

+ Remove []string

Oct 14, 2025

Changes in this version

+ type SanitizeOptions struct

+ ExtensionPatterns []string

+ KeepUnknownProperties bool

+ KeepUnusedComponents bool

+ func LoadSanitizeConfig(r io.Reader) (*SanitizeOptions, error)

+ func LoadSanitizeConfigFromFile(path string) (*SanitizeOptions, error)

+ type SanitizeResult struct

+ Warnings []string

+ func Sanitize(ctx context.Context, doc *OpenAPI, opts *SanitizeOptions) (*SanitizeResult, error)

Oct 3, 2025

Changes in this version

type Callback

+ func (c *Callback) Len() int

type PathItem

+ func (p *PathItem) Len() int

type Paths

+ func (p *Paths) Len() int

type Responses

+ func (r *Responses) Len() int

Sep 17, 2025

Changes in this version

+ func ExtractMethodAndPath(locations Locations) (string, string)

+ func GetParentType(location LocationContext) string

type LocalizeOptions

+ DocumentLocation string

+ HTTPClient system.Client

Sep 16, 2025

Changes in this version

+ func Localize(ctx context.Context, doc *OpenAPI, opts LocalizeOptions) error

+ type LocalizeNamingStrategy int

+ const LocalizeNamingCounter

+ const LocalizeNamingPathBased

+ type LocalizeOptions struct

+ NamingStrategy LocalizeNamingStrategy

+ ResolveOptions ResolveOptions

+ TargetDirectory string

+ VirtualFS system.WritableVirtualFS

Sep 9, 2025

Changes in this version

+ type ConflictingOperation struct

+ Method HTTPMethod

+ Operation *Operation

Sep 3, 2025

Changes in this version

type Reference

+ func (r *Reference[T, V, C]) GetResolvedObject() *T

Aug 29, 2025

Changes in this version

+ func Clean(ctx context.Context, doc *OpenAPI) error

+ func Optimize(ctx context.Context, doc *OpenAPI, nameCallback OptimizeNameCallback) error

+ type OptimizeNameCallback func(suggestedName string, hash string, locations []string, ...) string

type Reference

+ func (r *Reference[T, V, C]) GetObjectAny() any

Aug 28, 2025

Changes in this version

type Reference

+ func (r *Reference[T, V, C]) GetReferenceResolutionInfo() *references.ResolveResult[Reference[T, V, C]]

Aug 20, 2025

Changes in this version

type OpenAPI

+ func Bootstrap() *OpenAPI

Aug 19, 2025

Changes in this version

+ func Join(ctx context.Context, mainDoc *OpenAPI, documents []JoinDocumentInfo, ...) error

+ type JoinConflictStrategy int

+ const JoinConflictCounter

+ const JoinConflictFilePath

+ type JoinDocumentInfo struct

+ Document *OpenAPI

+ FilePath string

+ type JoinOptions struct

+ ConflictStrategy JoinConflictStrategy

+ DocumentPaths map[int]string

type ReferencedCallback

+ func NewReferencedCallbackFromCallback(callback *Callback) *ReferencedCallback

+ func NewReferencedCallbackFromRef(ref *references.Reference) *ReferencedCallback

type ReferencedExample

+ func NewReferencedExampleFromExample(example *Example) *ReferencedExample

+ func NewReferencedExampleFromRef(ref *references.Reference) *ReferencedExample

type ReferencedHeader

+ func NewReferencedHeaderFromHeader(header *Header) *ReferencedHeader

+ func NewReferencedHeaderFromRef(ref *references.Reference) *ReferencedHeader

type ReferencedLink

+ func NewReferencedLinkFromLink(link *Link) *ReferencedLink

+ func NewReferencedLinkFromRef(ref *references.Reference) *ReferencedLink

type ReferencedParameter

+ func NewReferencedParameterFromParameter(parameter *Parameter) *ReferencedParameter

+ func NewReferencedParameterFromRef(ref *references.Reference) *ReferencedParameter

type ReferencedPathItem

+ func NewReferencedPathItemFromPathItem(pathItem *PathItem) *ReferencedPathItem

+ func NewReferencedPathItemFromRef(ref *references.Reference) *ReferencedPathItem

type ReferencedRequestBody

+ func NewReferencedRequestBodyFromRef(ref *references.Reference) *ReferencedRequestBody

+ func NewReferencedRequestBodyFromRequestBody(requestBody *RequestBody) *ReferencedRequestBody

type ReferencedResponse

+ func NewReferencedResponseFromRef(ref *references.Reference) *ReferencedResponse

+ func NewReferencedResponseFromResponse(response *Response) *ReferencedResponse

type ReferencedSecurityScheme

+ func NewReferencedSecuritySchemeFromRef(ref *references.Reference) *ReferencedSecurityScheme

+ func NewReferencedSecuritySchemeFromSecurityScheme(securityScheme *SecurityScheme) *ReferencedSecurityScheme

Aug 19, 2025

Changes in this version

+ func Bundle(ctx context.Context, doc *OpenAPI, opts BundleOptions) error

+ func Inline(ctx context.Context, doc *OpenAPI, opts InlineOptions) error

+ type BundleNamingStrategy int

+ const BundleNamingCounter

+ const BundleNamingFilePath

+ type BundleOptions struct

+ NamingStrategy BundleNamingStrategy

+ ResolveOptions ResolveOptions

+ type InlineOptions struct

+ RemoveUnusedComponents bool

+ ResolveOptions ResolveOptions

Aug 15, 2025

Changes in this version

+ const Version

+ const Version30XMaxPatch

+ const Version31XMaxPatch

+ const VersionMajor

+ const VersionMinor

+ const VersionPatch

+ func Marshal(ctx context.Context, openapi *OpenAPI, w io.Writer) error

+ func Sync(ctx context.Context, model marshaller.Marshallable[OpenAPI]) error

+ func Upgrade(ctx context.Context, doc *OpenAPI, opts ...Option[UpgradeOptions]) (bool, error)

+ func Walk(ctx context.Context, openAPI *OpenAPI) iter.Seq[WalkItem]

+ type Callback struct

+ Extensions *extensions.Extensions

+ func NewCallback() *Callback

+ func (c *Callback) GetExtensions() *extensions.Extensions

+ func (c *Callback) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Components struct

+ Callbacks *sequencedmap.Map[string, *ReferencedCallback]

+ Examples *sequencedmap.Map[string, *ReferencedExample]

+ Extensions *extensions.Extensions

+ Headers *sequencedmap.Map[string, *ReferencedHeader]

+ Links *sequencedmap.Map[string, *ReferencedLink]

+ Parameters *sequencedmap.Map[string, *ReferencedParameter]

+ PathItems *sequencedmap.Map[string, *ReferencedPathItem]

+ RequestBodies *sequencedmap.Map[string, *ReferencedRequestBody]

+ Responses *sequencedmap.Map[string, *ReferencedResponse]

+ Schemas *sequencedmap.Map[string, *oas3.JSONSchema[oas3.Referenceable]]

+ SecuritySchemes *sequencedmap.Map[string, *ReferencedSecurityScheme]

+ func (c *Components) GetCallbacks() *sequencedmap.Map[string, *ReferencedCallback]

+ func (c *Components) GetExamples() *sequencedmap.Map[string, *ReferencedExample]

+ func (c *Components) GetExtensions() *extensions.Extensions

+ func (c *Components) GetHeaders() *sequencedmap.Map[string, *ReferencedHeader]

+ func (c *Components) GetLinks() *sequencedmap.Map[string, *ReferencedLink]

+ func (c *Components) GetParameters() *sequencedmap.Map[string, *ReferencedParameter]

+ func (c *Components) GetPathItems() *sequencedmap.Map[string, *ReferencedPathItem]

+ func (c *Components) GetRequestBodies() *sequencedmap.Map[string, *ReferencedRequestBody]

+ func (c *Components) GetResponses() *sequencedmap.Map[string, *ReferencedResponse]

+ func (c *Components) GetSchemas() *sequencedmap.Map[string, *oas3.JSONSchema[oas3.Referenceable]]

+ func (c *Components) GetSecuritySchemes() *sequencedmap.Map[string, *ReferencedSecurityScheme]

+ func (c *Components) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Contact struct

+ Email *string

+ Extensions *extensions.Extensions

+ Name *string

+ URL *string

+ func (c *Contact) GetEmail() string

+ func (c *Contact) GetExtensions() *extensions.Extensions

+ func (c *Contact) GetName() string

+ func (c *Contact) GetURL() string

+ func (c *Contact) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Encoding struct

+ AllowReserved *bool

+ ContentType *string

+ Explode *bool

+ Extensions *extensions.Extensions

+ Headers *sequencedmap.Map[string, *ReferencedHeader]

+ Style *SerializationStyle

+ func (e *Encoding) GetAllowReserved() bool

+ func (e *Encoding) GetContentType(schema *oas3.JSONSchema[oas3.Concrete]) string

+ func (e *Encoding) GetContentTypeValue() string

+ func (e *Encoding) GetExplode() bool

+ func (e *Encoding) GetExtensions() *extensions.Extensions

+ func (e *Encoding) GetHeaders() *sequencedmap.Map[string, *ReferencedHeader]

+ func (e *Encoding) GetStyle() SerializationStyle

+ func (e *Encoding) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Example struct

+ Description *string

+ Extensions *extensions.Extensions

+ ExternalValue *string

+ Summary *string

+ Value values.Value

+ func (e *Example) GetDescription() string

+ func (e *Example) GetExtensions() *extensions.Extensions

+ func (e *Example) GetExternalValue() string

+ func (e *Example) GetSummary() string

+ func (e *Example) GetValue() values.Value

+ func (e *Example) ResolveExternalValue(ctx context.Context) (values.Value, error)

+ func (e *Example) Validate(ctx context.Context, opts ...validation.Option) []error

+ type HTTPMethod string

+ const HTTPMethodDelete

+ const HTTPMethodGet

+ const HTTPMethodHead

+ const HTTPMethodOptions

+ const HTTPMethodPatch

+ const HTTPMethodPost

+ const HTTPMethodPut

+ const HTTPMethodTrace

+ func (m HTTPMethod) Is(method string) bool

+ type Header struct

+ Content *sequencedmap.Map[string, *MediaType]

+ Deprecated *bool

+ Description *string

+ Example values.Value

+ Examples *sequencedmap.Map[string, *ReferencedExample]

+ Explode *bool

+ Extensions *extensions.Extensions

+ Required *bool

+ Schema *oas3.JSONSchema[oas3.Referenceable]

+ Style *SerializationStyle

+ func (h *Header) GetContent() *sequencedmap.Map[string, *MediaType]

+ func (h *Header) GetDeprecated() bool

+ func (h *Header) GetDescription() string

+ func (h *Header) GetExample() values.Value

+ func (h *Header) GetExamples() *sequencedmap.Map[string, *ReferencedExample]

+ func (h *Header) GetExplode() bool

+ func (h *Header) GetExtensions() *extensions.Extensions

+ func (h *Header) GetRequired() bool

+ func (h *Header) GetSchema() *oas3.JSONSchema[oas3.Referenceable]

+ func (h *Header) GetStyle() SerializationStyle

+ func (h *Header) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Info struct

+ Contact *Contact

+ Description *string

+ Extensions *extensions.Extensions

+ License *License

+ Summary *string

+ TermsOfService *string

+ Title string

+ Version string

+ func (i *Info) GetContact() *Contact

+ func (i *Info) GetDescription() string

+ func (i *Info) GetExtensions() *extensions.Extensions

+ func (i *Info) GetLicense() *License

+ func (i *Info) GetSummary() string

+ func (i *Info) GetTermsOfService() string

+ func (i *Info) GetTitle() string

+ func (i *Info) GetVersion() string

+ func (i *Info) Validate(ctx context.Context, opts ...validation.Option) []error

+ type License struct

+ Extensions *extensions.Extensions

+ Identifier *string

+ Name string

+ URL *string

+ func (l *License) GetExtensions() *extensions.Extensions

+ func (l *License) GetIdentifier() string

+ func (l *License) GetName() string

+ func (l *License) GetURL() string

+ func (l *License) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Link struct

+ Description *string

+ Extensions *extensions.Extensions

+ OperationID *string

+ OperationRef *string

+ Parameters *sequencedmap.Map[string, expression.ValueOrExpression]

+ RequestBody expression.ValueOrExpression

+ Server *Server

+ func (l *Link) GetDescription() string

+ func (l *Link) GetExtensions() *extensions.Extensions

+ func (l *Link) GetOperationID() string

+ func (l *Link) GetOperationRef() string

+ func (l *Link) GetParameters() *sequencedmap.Map[string, expression.ValueOrExpression]

+ func (l *Link) GetRequestBody() expression.ValueOrExpression

+ func (l *Link) GetServer() *Server

+ func (l *Link) ResolveOperation(ctx context.Context) (*Operation, error)

+ func (l *Link) Validate(ctx context.Context, opts ...validation.Option) []error

+ type LocationContext = walkpkg.LocationContext[MatchFunc]

+ type Locations = walkpkg.Locations[MatchFunc]

+ type MatchFunc func(Matcher) error

+ type Matcher struct

+ Any func(any) error

+ Components func(*Components) error

+ Contact func(*Contact) error

+ Discriminator func(*oas3.Discriminator) error

+ Encoding func(*Encoding) error

+ Extensions func(*extensions.Extensions) error

+ ExternalDocs func(*oas3.ExternalDocumentation) error

+ Info func(*Info) error

+ License func(*License) error

+ MediaType func(*MediaType) error

+ OAuthFlow func(*OAuthFlow) error

+ OAuthFlows func(*OAuthFlows) error

+ OpenAPI func(*OpenAPI) error

+ Operation func(*Operation) error

+ Paths func(*Paths) error

+ ReferencedCallback func(*ReferencedCallback) error

+ ReferencedExample func(*ReferencedExample) error

+ ReferencedHeader func(*ReferencedHeader) error

+ ReferencedLink func(*ReferencedLink) error

+ ReferencedParameter func(*ReferencedParameter) error

+ ReferencedPathItem func(*ReferencedPathItem) error

+ ReferencedRequestBody func(*ReferencedRequestBody) error

+ ReferencedResponse func(*ReferencedResponse) error

+ ReferencedSecurityScheme func(*ReferencedSecurityScheme) error

+ Responses func(*Responses) error

+ Schema func(*oas3.JSONSchema[oas3.Referenceable]) error

+ Security func(*SecurityRequirement) error

+ Server func(*Server) error

+ ServerVariable func(*ServerVariable) error

+ Tag func(*Tag) error

+ XML func(*oas3.XML) error

+ type MediaType struct

+ Encoding *sequencedmap.Map[string, *Encoding]

+ Example values.Value

+ Examples *sequencedmap.Map[string, *ReferencedExample]

+ Extensions *extensions.Extensions

+ Schema *oas3.JSONSchema[oas3.Referenceable]

+ func (m *MediaType) GetEncoding() *sequencedmap.Map[string, *Encoding]

+ func (m *MediaType) GetExample() values.Value

+ func (m *MediaType) GetExamples() *sequencedmap.Map[string, *ReferencedExample]

+ func (m *MediaType) GetExtensions() *extensions.Extensions

+ func (m *MediaType) GetSchema() *oas3.JSONSchema[oas3.Referenceable]

+ func (m *MediaType) Validate(ctx context.Context, opts ...validation.Option) []error

+ type OAuthFlow struct

+ AuthorizationURL *string

+ Extensions *extensions.Extensions

+ RefreshURL *string

+ Scopes *sequencedmap.Map[string, string]

+ TokenURL *string

+ func (o *OAuthFlow) GetAuthorizationURL() string

+ func (o *OAuthFlow) GetExtensions() *extensions.Extensions

+ func (o *OAuthFlow) GetRefreshURL() string

+ func (o *OAuthFlow) GetScopes() *sequencedmap.Map[string, string]

+ func (o *OAuthFlow) GetTokenURL() string

+ func (o *OAuthFlow) Validate(ctx context.Context, opts ...validation.Option) []error

+ type OAuthFlowType string

+ const OAuthFlowTypeAuthorizationCode

+ const OAuthFlowTypeClientCredentials

+ const OAuthFlowTypeImplicit

+ const OAuthFlowTypePassword

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Extensions *extensions.Extensions

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ func (o *OAuthFlows) GetAuthorizationCode() *OAuthFlow

+ func (o *OAuthFlows) GetClientCredentials() *OAuthFlow

+ func (o *OAuthFlows) GetExtensions() *extensions.Extensions

+ func (o *OAuthFlows) GetImplicit() *OAuthFlow

+ func (o *OAuthFlows) GetPassword() *OAuthFlow

+ func (o *OAuthFlows) Validate(ctx context.Context, opts ...validation.Option) []error

+ type OpenAPI struct

+ Components *Components

+ Extensions *extensions.Extensions

+ ExternalDocs *oas3.ExternalDocumentation

+ Info Info

+ JSONSchemaDialect *string

+ OpenAPI string

+ Paths *Paths

+ Security []*SecurityRequirement

+ Servers []*Server

+ Tags []*Tag

+ Webhooks *sequencedmap.Map[string, *ReferencedPathItem]

+ func Unmarshal(ctx context.Context, doc io.Reader, opts ...Option[UnmarshalOptions]) (*OpenAPI, []error, error)

+ func (o *OpenAPI) GetComponents() *Components

+ func (o *OpenAPI) GetExtensions() *extensions.Extensions

+ func (o *OpenAPI) GetExternalDocs() *oas3.ExternalDocumentation

+ func (o *OpenAPI) GetInfo() *Info

+ func (o *OpenAPI) GetJSONSchemaDialect() string

+ func (o *OpenAPI) GetOpenAPI() string

+ func (o *OpenAPI) GetPaths() *Paths

+ func (o *OpenAPI) GetSecurity() []*SecurityRequirement

+ func (o *OpenAPI) GetServers() []*Server

+ func (o *OpenAPI) GetTags() []*Tag

+ func (o *OpenAPI) GetWebhooks() *sequencedmap.Map[string, *ReferencedPathItem]

+ func (o *OpenAPI) ResolveAllReferences(ctx context.Context, opts ResolveAllOptions) ([]error, error)

+ func (o *OpenAPI) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Operation struct

+ Callbacks *sequencedmap.Map[string, *ReferencedCallback]

+ Deprecated *bool

+ Description *string

+ Extensions *extensions.Extensions

+ ExternalDocs *oas3.ExternalDocumentation

+ OperationID *string

+ Parameters []*ReferencedParameter

+ RequestBody *ReferencedRequestBody

+ Responses *Responses

+ Security []*SecurityRequirement

+ Servers []*Server

+ Summary *string

+ Tags []string

+ func (o *Operation) GetCallbacks() *sequencedmap.Map[string, *ReferencedCallback]

+ func (o *Operation) GetDeprecated() bool

+ func (o *Operation) GetDescription() string

+ func (o *Operation) GetExtensions() *extensions.Extensions

+ func (o *Operation) GetExternalDocs() *oas3.ExternalDocumentation

+ func (o *Operation) GetOperationID() string

+ func (o *Operation) GetParameters() []*ReferencedParameter

+ func (o *Operation) GetRequestBody() *ReferencedRequestBody

+ func (o *Operation) GetResponses() *Responses

+ func (o *Operation) GetSecurity() []*SecurityRequirement

+ func (o *Operation) GetServers() []*Server

+ func (o *Operation) GetSummary() string

+ func (o *Operation) GetTags() []string

+ func (o *Operation) IsDeprecated() bool

+ func (o *Operation) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Option func(o *T)

+ func WithSkipValidation() Option[UnmarshalOptions]

+ func WithUpgradeSamePatchVersion() Option[UpgradeOptions]

+ type Parameter struct

+ AllowEmptyValue *bool

+ AllowReserved *bool

+ Content *sequencedmap.Map[string, *MediaType]

+ Deprecated *bool

+ Description *string

+ Example values.Value

+ Examples *sequencedmap.Map[string, *ReferencedExample]

+ Explode *bool

+ Extensions *extensions.Extensions

+ In ParameterIn

+ Name string

+ Required *bool

+ Schema *oas3.JSONSchema[oas3.Referenceable]

+ Style *SerializationStyle

+ func (p *Parameter) GetAllowEmptyValue() bool

+ func (p *Parameter) GetAllowReserved() bool

+ func (p *Parameter) GetContent() *sequencedmap.Map[string, *MediaType]

+ func (p *Parameter) GetDeprecated() bool

+ func (p *Parameter) GetDescription() string

+ func (p *Parameter) GetExample() values.Value

+ func (p *Parameter) GetExamples() *sequencedmap.Map[string, *ReferencedExample]

+ func (p *Parameter) GetExplode() bool

+ func (p *Parameter) GetExtensions() *extensions.Extensions

+ func (p *Parameter) GetIn() ParameterIn

+ func (p *Parameter) GetName() string

+ func (p *Parameter) GetRequired() bool

+ func (p *Parameter) GetSchema() *oas3.JSONSchema[oas3.Referenceable]

+ func (p *Parameter) GetStyle() SerializationStyle

+ func (p *Parameter) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ParameterIn string

+ const ParameterInCookie

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ func (p ParameterIn) String() string

+ type PathItem struct

+ Description *string

+ Extensions *extensions.Extensions

+ Parameters []*ReferencedParameter

+ Servers []*Server

+ Summary *string

+ func NewPathItem() *PathItem

+ func (p *PathItem) Delete() *Operation

+ func (p *PathItem) Get() *Operation

+ func (p *PathItem) GetDescription() string

+ func (p *PathItem) GetExtensions() *extensions.Extensions

+ func (p *PathItem) GetOperation(method HTTPMethod) *Operation

+ func (p *PathItem) GetParameters() []*ReferencedParameter

+ func (p *PathItem) GetServers() []*Server

+ func (p *PathItem) GetSummary() string

+ func (p *PathItem) Head() *Operation

+ func (p *PathItem) Options() *Operation

+ func (p *PathItem) Patch() *Operation

+ func (p *PathItem) Post() *Operation

+ func (p *PathItem) Put() *Operation

+ func (p *PathItem) Trace() *Operation

+ func (p *PathItem) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Paths struct

+ Extensions *extensions.Extensions

+ func NewPaths() *Paths

+ func (p *Paths) GetExtensions() *extensions.Extensions

+ func (p *Paths) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Reference struct

+ Description *string

+ Object *T

+ Reference *references.Reference

+ Summary *string

+ func (r *Reference[T, V, C]) GetDescription() string

+ func (r *Reference[T, V, C]) GetNavigableNode() (any, error)

+ func (r *Reference[T, V, C]) GetObject() *T

+ func (r *Reference[T, V, C]) GetParent() *Reference[T, V, C]

+ func (r *Reference[T, V, C]) GetReference() references.Reference

+ func (r *Reference[T, V, C]) GetSummary() string

+ func (r *Reference[T, V, C]) GetTopLevelParent() *Reference[T, V, C]

+ func (r *Reference[T, V, C]) IsReference() bool

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

+ func (r *Reference[T, V, C]) MustGetObject() *T

+ func (r *Reference[T, V, C]) Populate(source any) error

+ func (r *Reference[T, V, C]) Resolve(ctx context.Context, opts ResolveOptions) ([]error, error)

+ func (r *Reference[T, V, C]) SetParent(parent *Reference[T, V, C])

+ func (r *Reference[T, V, C]) SetTopLevelParent(topLevelParent *Reference[T, V, C])

+ func (r *Reference[T, V, C]) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ReferencedCallback = Reference[Callback, *Callback, *core.Callback]

+ type ReferencedExample = Reference[Example, *Example, *core.Example]

+ type ReferencedHeader = Reference[Header, *Header, *core.Header]

+ type ReferencedLink = Reference[Link, *Link, *core.Link]

+ type ReferencedObject interface

+ GetObject func() *T

+ IsReference func() bool

+ type ReferencedParameter = Reference[Parameter, *Parameter, *core.Parameter]

+ type ReferencedPathItem = Reference[PathItem, *PathItem, *core.PathItem]

+ type ReferencedRequestBody = Reference[RequestBody, *RequestBody, *core.RequestBody]

+ type ReferencedResponse = Reference[Response, *Response, *core.Response]

+ type ReferencedSecurityScheme = Reference[SecurityScheme, *SecurityScheme, *core.SecurityScheme]

+ type RequestBody struct

+ Content *sequencedmap.Map[string, *MediaType]

+ Description *string

+ Extensions *extensions.Extensions

+ Required *bool

+ func (r *RequestBody) GetContent() *sequencedmap.Map[string, *MediaType]

+ func (r *RequestBody) GetDescription() string

+ func (r *RequestBody) GetRequired() bool

+ func (r *RequestBody) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ResolveAllOptions struct

+ DisableExternalRefs bool

+ HTTPClient system.Client

+ OpenAPILocation string

+ VirtualFS system.VirtualFS

+ type ResolveOptions = references.ResolveOptions

+ type Response struct

+ Content *sequencedmap.Map[string, *MediaType]

+ Description string

+ Extensions *extensions.Extensions

+ Headers *sequencedmap.Map[string, *ReferencedHeader]

+ Links *sequencedmap.Map[string, *ReferencedLink]

+ func (r *Response) GetContent() *sequencedmap.Map[string, *MediaType]

+ func (r *Response) GetDescription() string

+ func (r *Response) GetExtensions() *extensions.Extensions

+ func (r *Response) GetHeaders() *sequencedmap.Map[string, *ReferencedHeader]

+ func (r *Response) GetLinks() *sequencedmap.Map[string, *ReferencedLink]

+ func (r *Response) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Responses struct

+ Default *ReferencedResponse

+ Extensions *extensions.Extensions

+ func NewResponses() *Responses

+ func (r *Responses) GetDefault() *ReferencedResponse

+ func (r *Responses) GetExtensions() *extensions.Extensions

+ func (r *Responses) Populate(source any) error

+ func (r *Responses) Validate(ctx context.Context, opts ...validation.Option) []error

+ type SecurityRequirement struct

+ func NewSecurityRequirement() *SecurityRequirement

+ func (s *SecurityRequirement) Populate(source any) error

+ func (s *SecurityRequirement) Validate(ctx context.Context, opts ...validation.Option) []error

+ type SecuritySchemaType string

+ const SecuritySchemeTypeAPIKey

+ const SecuritySchemeTypeHTTP

+ const SecuritySchemeTypeMutualTLS

+ const SecuritySchemeTypeOAuth2

+ const SecuritySchemeTypeOpenIDConnect

+ func (s SecuritySchemaType) String() string

+ type SecurityScheme struct

+ BearerFormat *string

+ Description *string

+ Extensions *extensions.Extensions

+ Flows *OAuthFlows

+ In *SecuritySchemeIn

+ Name *string

+ OpenIdConnectUrl *string

+ Scheme *string

+ Type SecuritySchemaType

+ func (s *SecurityScheme) GetBearerFormat() string

+ func (s *SecurityScheme) GetDescription() string

+ func (s *SecurityScheme) GetExtensions() *extensions.Extensions

+ func (s *SecurityScheme) GetFlows() *OAuthFlows

+ func (s *SecurityScheme) GetIn() SecuritySchemeIn

+ func (s *SecurityScheme) GetName() string

+ func (s *SecurityScheme) GetOpenIdConnectUrl() string

+ func (s *SecurityScheme) GetScheme() string

+ func (s *SecurityScheme) GetType() SecuritySchemaType

+ func (s *SecurityScheme) Validate(ctx context.Context, opts ...validation.Option) []error

+ type SecuritySchemeIn string

+ const SecuritySchemeInCookie

+ const SecuritySchemeInHeader

+ const SecuritySchemeInQuery

+ func (s SecuritySchemeIn) String() string

+ type SerializationStyle string

+ const SerializationStyleDeepObject

+ const SerializationStyleForm

+ const SerializationStyleLabel

+ const SerializationStyleMatrix

+ const SerializationStylePipeDelimited

+ const SerializationStyleSimple

+ const SerializationStyleSpaceDelimited

+ func (s SerializationStyle) String() string

+ type Server struct

+ Description *string

+ Extensions *extensions.Extensions

+ URL string

+ Variables *sequencedmap.Map[string, *ServerVariable]

+ func (s *Server) GetDescription() string

+ func (s *Server) GetExtensions() *extensions.Extensions

+ func (s *Server) GetURL() string

+ func (s *Server) GetVariables() *sequencedmap.Map[string, *ServerVariable]

+ func (s *Server) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ServerVariable struct

+ Default string

+ Description *string

+ Enum []string

+ Extensions *extensions.Extensions

+ func (v *ServerVariable) GetDefault() string

+ func (v *ServerVariable) GetDescription() string

+ func (v *ServerVariable) GetEnum() []string

+ func (v *ServerVariable) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Tag struct

+ Description *string

+ Extensions *extensions.Extensions

+ ExternalDocs *oas3.ExternalDocumentation

+ Name string

+ func (t *Tag) GetDescription() string

+ func (t *Tag) GetExtensions() *extensions.Extensions

+ func (t *Tag) GetExternalDocs() *oas3.ExternalDocumentation

+ func (t *Tag) GetName() string

+ func (t *Tag) Validate(ctx context.Context, opts ...validation.Option) []error

+ type UnmarshalOptions struct

+ type UpgradeOptions struct

+ type WalkItem struct

+ Location Locations

+ Match MatchFunc

+ OpenAPI *OpenAPI