openapi31

package

Go to main page

Versions in this module

v0

v0.2.60

Sep 25, 2025

v0.2.59

Jul 18, 2025

Changes in this version

type PathItem

+ func (p *PathItem) PathItemOrReference() PathItemOrReference

type Reflector

+ func (r *Reflector) AddWebhook(oc openapi.OperationContext) error

type Spec

+ func (s *Spec) AddWebhook(method, name string, operation Operation) error

v0.2.58

May 7, 2025

v0.2.57

Feb 19, 2025

v0.2.56

Feb 19, 2025

v0.2.55

Feb 14, 2025

v0.2.54

Sep 9, 2024

Changes in this version

type RequestBodyOrReference

+ func (r *RequestBodyOrReference) SetReference(ref string)

type ResponseOrReference

+ func (r *ResponseOrReference) SetReference(ref string)

v0.2.53

Jun 25, 2024

v0.2.52

Jun 25, 2024

v0.2.51

May 20, 2024

v0.2.50

Mar 18, 2024

v0.2.49

Mar 5, 2024

v0.2.48

Mar 5, 2024

v0.2.47

Mar 5, 2024

v0.2.46

Mar 1, 2024

v0.2.45

Jan 8, 2024

v0.2.44

Dec 8, 2023

v0.2.43

Dec 2, 2023

v0.2.42

Nov 3, 2023

v0.2.41

Oct 3, 2023

v0.2.40

Sep 29, 2023

Changes in this version

type Reference

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

v0.2.39

Aug 8, 2023

v0.2.38

Aug 8, 2023

Changes in this version

+ const EncodingStyleDeepObject

+ const EncodingStyleForm

+ const EncodingStylePipeDelimited

+ const EncodingStyleSpaceDelimited

+ const ParameterInCookie

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ const ParameterStyleDeepObject

+ const ParameterStyleForm

+ const ParameterStylePipeDelimited

+ const ParameterStyleSpaceDelimited

+ const SecuritySchemeAPIKeyInCookie

+ const SecuritySchemeAPIKeyInHeader

+ const SecuritySchemeAPIKeyInQuery

+ func ToJSONSchema(s map[string]interface{}, spec *Spec) jsonschema.SchemaOrBool

+ type Callbacks struct

+ AdditionalProperties map[string]PathItemOrReference

+ MapOfAnything map[string]interface{}

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

+ func (c *Callbacks) WithAdditionalProperties(val map[string]PathItemOrReference) *Callbacks

+ func (c *Callbacks) WithAdditionalPropertiesItem(key string, val PathItemOrReference) *Callbacks

+ func (c *Callbacks) WithMapOfAnything(val map[string]interface{}) *Callbacks

+ func (c *Callbacks) WithMapOfAnythingItem(key string, val interface{}) *Callbacks

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

+ type CallbacksOrReference struct

+ Callbacks *Callbacks

+ Reference *Reference

+ func (c *CallbacksOrReference) CallbacksEns() *Callbacks

+ func (c *CallbacksOrReference) ReferenceEns() *Reference

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

+ func (c *CallbacksOrReference) WithCallbacks(val Callbacks) *CallbacksOrReference

+ func (c *CallbacksOrReference) WithReference(val Reference) *CallbacksOrReference

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

+ type Components struct

+ Callbacks map[string]CallbacksOrReference

+ Examples map[string]ExampleOrReference

+ Headers map[string]HeaderOrReference

+ Links map[string]LinkOrReference

+ Parameters map[string]ParameterOrReference

+ PathItems map[string]PathItemOrReference

+ RequestBodies map[string]RequestBodyOrReference

+ Responses map[string]ResponseOrReference

+ Schemas map[string]map[string]interface{}

+ SecuritySchemes map[string]SecuritySchemeOrReference

+ func (c *Components) WithCallbacks(val map[string]CallbacksOrReference) *Components

+ func (c *Components) WithCallbacksItem(key string, val CallbacksOrReference) *Components

+ func (c *Components) WithExamples(val map[string]ExampleOrReference) *Components

+ func (c *Components) WithExamplesItem(key string, val ExampleOrReference) *Components

+ func (c *Components) WithHeaders(val map[string]HeaderOrReference) *Components

+ func (c *Components) WithHeadersItem(key string, val HeaderOrReference) *Components

+ func (c *Components) WithLinks(val map[string]LinkOrReference) *Components

+ func (c *Components) WithLinksItem(key string, val LinkOrReference) *Components

+ func (c *Components) WithParameters(val map[string]ParameterOrReference) *Components

+ func (c *Components) WithParametersItem(key string, val ParameterOrReference) *Components

+ func (c *Components) WithPathItems(val map[string]PathItemOrReference) *Components

+ func (c *Components) WithPathItemsItem(key string, val PathItemOrReference) *Components

+ func (c *Components) WithRequestBodies(val map[string]RequestBodyOrReference) *Components

+ func (c *Components) WithRequestBodiesItem(key string, val RequestBodyOrReference) *Components

+ func (c *Components) WithResponses(val map[string]ResponseOrReference) *Components

+ func (c *Components) WithResponsesItem(key string, val ResponseOrReference) *Components

+ func (c *Components) WithSchemas(val map[string]map[string]interface{}) *Components

+ func (c *Components) WithSchemasItem(key string, val map[string]interface{}) *Components

+ func (c *Components) WithSecuritySchemes(val map[string]SecuritySchemeOrReference) *Components

+ func (c *Components) WithSecuritySchemesItem(key string, val SecuritySchemeOrReference) *Components

+ type Contact struct

+ Email *string

+ MapOfAnything map[string]interface{}

+ Name *string

+ URL *string

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

+ func (c *Contact) WithEmail(val string) *Contact

+ func (c *Contact) WithMapOfAnything(val map[string]interface{}) *Contact

+ func (c *Contact) WithMapOfAnythingItem(key string, val interface{}) *Contact

+ func (c *Contact) WithName(val string) *Contact

+ func (c *Contact) WithURL(val string) *Contact

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

+ type Encoding struct

+ AllowReserved *bool

+ ContentType *string

+ Explode *bool

+ Headers map[string]HeaderOrReference

+ Style *EncodingStyle

+ func (e *Encoding) WithAllowReserved(val bool) *Encoding

+ func (e *Encoding) WithContentType(val string) *Encoding

+ func (e *Encoding) WithExplode(val bool) *Encoding

+ func (e *Encoding) WithHeaders(val map[string]HeaderOrReference) *Encoding

+ func (e *Encoding) WithHeadersItem(key string, val HeaderOrReference) *Encoding

+ func (e *Encoding) WithStyle(val EncodingStyle) *Encoding

+ type EncodingAllOf0 struct

+ MapOfAnything map[string]interface{}

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

+ func (e *EncodingAllOf0) WithMapOfAnything(val map[string]interface{}) *EncodingAllOf0

+ func (e *EncodingAllOf0) WithMapOfAnythingItem(key string, val interface{}) *EncodingAllOf0

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

+ type EncodingStyle string

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

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

+ type Example struct

+ Description *string

+ ExternalValue *string

+ MapOfAnything map[string]interface{}

+ Summary *string

+ Value *interface{}

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

+ func (e *Example) WithDescription(val string) *Example

+ func (e *Example) WithExternalValue(val string) *Example

+ func (e *Example) WithMapOfAnything(val map[string]interface{}) *Example

+ func (e *Example) WithMapOfAnythingItem(key string, val interface{}) *Example

+ func (e *Example) WithSummary(val string) *Example

+ func (e *Example) WithValue(val interface{}) *Example

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

+ type ExampleOrReference struct

+ Example *Example

+ Reference *Reference

+ func (e *ExampleOrReference) ExampleEns() *Example

+ func (e *ExampleOrReference) ReferenceEns() *Reference

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

+ func (e *ExampleOrReference) WithExample(val Example) *ExampleOrReference

+ func (e *ExampleOrReference) WithReference(val Reference) *ExampleOrReference

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

+ type Examples struct

+ Example *interface{}

+ Examples map[string]ExampleOrReference

+ func (e *Examples) WithExample(val interface{}) *Examples

+ func (e *Examples) WithExamples(val map[string]ExampleOrReference) *Examples

+ func (e *Examples) WithExamplesItem(key string, val ExampleOrReference) *Examples

+ type ExternalDocumentation struct

+ Description *string

+ MapOfAnything map[string]interface{}

+ URL string

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

+ func (e *ExternalDocumentation) WithDescription(val string) *ExternalDocumentation

+ func (e *ExternalDocumentation) WithMapOfAnything(val map[string]interface{}) *ExternalDocumentation

+ func (e *ExternalDocumentation) WithMapOfAnythingItem(key string, val interface{}) *ExternalDocumentation

+ func (e *ExternalDocumentation) WithURL(val string) *ExternalDocumentation

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

+ type Header struct

+ Content map[string]MediaType

+ Deprecated *bool

+ Description *string

+ Example *interface{}

+ Examples map[string]ExampleOrReference

+ Explode *bool

+ MapOfAnything map[string]interface{}

+ Required *bool

+ Schema map[string]interface{}

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

+ func (h *Header) WithContent(val map[string]MediaType) *Header

+ func (h *Header) WithContentItem(key string, val MediaType) *Header

+ func (h *Header) WithDeprecated(val bool) *Header

+ func (h *Header) WithDescription(val string) *Header

+ func (h *Header) WithExample(val interface{}) *Header

+ func (h *Header) WithExamples(val map[string]ExampleOrReference) *Header

+ func (h *Header) WithExamplesItem(key string, val ExampleOrReference) *Header

+ func (h *Header) WithExplode(val bool) *Header

+ func (h *Header) WithMapOfAnything(val map[string]interface{}) *Header

+ func (h *Header) WithMapOfAnythingItem(key string, val interface{}) *Header

+ func (h *Header) WithRequired(val bool) *Header

+ func (h *Header) WithSchema(val map[string]interface{}) *Header

+ func (h *Header) WithSchemaItem(key string, val interface{}) *Header

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

+ type HeaderOrReference struct

+ Header *Header

+ Reference *Reference

+ func (h *HeaderOrReference) HeaderEns() *Header

+ func (h *HeaderOrReference) ReferenceEns() *Reference

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

+ func (h *HeaderOrReference) WithHeader(val Header) *HeaderOrReference

+ func (h *HeaderOrReference) WithReference(val Reference) *HeaderOrReference

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

+ type Info struct

+ Contact *Contact

+ Description *string

+ License *License

+ MapOfAnything map[string]interface{}

+ Summary *string

+ TermsOfService *string

+ Title string

+ Version string

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

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

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

+ func (i *Info) WithContact(val Contact) *Info

+ func (i *Info) WithDescription(val string) *Info

+ func (i *Info) WithLicense(val License) *Info

+ func (i *Info) WithMapOfAnything(val map[string]interface{}) *Info

+ func (i *Info) WithMapOfAnythingItem(key string, val interface{}) *Info

+ func (i *Info) WithSummary(val string) *Info

+ func (i *Info) WithTermsOfService(val string) *Info

+ func (i *Info) WithTitle(val string) *Info

+ func (i *Info) WithVersion(val string) *Info

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

+ type License struct

+ Identifier *string

+ MapOfAnything map[string]interface{}

+ Name string

+ URL *string

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

+ func (l *License) WithIdentifier(val string) *License

+ func (l *License) WithMapOfAnything(val map[string]interface{}) *License

+ func (l *License) WithMapOfAnythingItem(key string, val interface{}) *License

+ func (l *License) WithName(val string) *License

+ func (l *License) WithURL(val string) *License

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

+ type Link struct

+ Body *Server

+ Description *string

+ MapOfAnything map[string]interface{}

+ OperationID *string

+ OperationRef *string

+ Parameters map[string]string

+ RequestBody *interface{}

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

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

+ func (l *Link) WithBody(val Server) *Link

+ func (l *Link) WithDescription(val string) *Link

+ func (l *Link) WithMapOfAnything(val map[string]interface{}) *Link

+ func (l *Link) WithMapOfAnythingItem(key string, val interface{}) *Link

+ func (l *Link) WithOperationID(val string) *Link

+ func (l *Link) WithOperationRef(val string) *Link

+ func (l *Link) WithParameters(val map[string]string) *Link

+ func (l *Link) WithParametersItem(key string, val string) *Link

+ func (l *Link) WithRequestBody(val interface{}) *Link

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

+ type LinkOrReference struct

+ Link *Link

+ Reference *Reference

+ func (l *LinkOrReference) LinkEns() *Link

+ func (l *LinkOrReference) ReferenceEns() *Reference

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

+ func (l *LinkOrReference) WithLink(val Link) *LinkOrReference

+ func (l *LinkOrReference) WithReference(val Reference) *LinkOrReference

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

+ type MediaType struct

+ Encoding map[string]Encoding

+ Example *interface{}

+ Examples map[string]ExampleOrReference

+ MapOfAnything map[string]interface{}

+ Schema map[string]interface{}

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

+ func (m *MediaType) WithEncoding(val map[string]Encoding) *MediaType

+ func (m *MediaType) WithEncodingItem(key string, val Encoding) *MediaType

+ func (m *MediaType) WithExample(val interface{}) *MediaType

+ func (m *MediaType) WithExamples(val map[string]ExampleOrReference) *MediaType

+ func (m *MediaType) WithExamplesItem(key string, val ExampleOrReference) *MediaType

+ func (m *MediaType) WithMapOfAnything(val map[string]interface{}) *MediaType

+ func (m *MediaType) WithMapOfAnythingItem(key string, val interface{}) *MediaType

+ func (m *MediaType) WithSchema(val map[string]interface{}) *MediaType

+ func (m *MediaType) WithSchemaItem(key string, val interface{}) *MediaType

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

+ type MutualTLS struct

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

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

+ type OauthFlows struct

+ AuthorizationCode *OauthFlowsDefsAuthorizationCode

+ ClientCredentials *OauthFlowsDefsClientCredentials

+ Implicit *OauthFlowsDefsImplicit

+ MapOfAnything map[string]interface{}

+ Password *OauthFlowsDefsPassword

+ func (o *OauthFlows) AuthorizationCodeEns() *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlows) ClientCredentialsEns() *OauthFlowsDefsClientCredentials

+ func (o *OauthFlows) ImplicitEns() *OauthFlowsDefsImplicit

+ func (o *OauthFlows) PasswordEns() *OauthFlowsDefsPassword

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

+ func (o *OauthFlows) WithAuthorizationCode(val OauthFlowsDefsAuthorizationCode) *OauthFlows

+ func (o *OauthFlows) WithClientCredentials(val OauthFlowsDefsClientCredentials) *OauthFlows

+ func (o *OauthFlows) WithImplicit(val OauthFlowsDefsImplicit) *OauthFlows

+ func (o *OauthFlows) WithMapOfAnything(val map[string]interface{}) *OauthFlows

+ func (o *OauthFlows) WithMapOfAnythingItem(key string, val interface{}) *OauthFlows

+ func (o *OauthFlows) WithPassword(val OauthFlowsDefsPassword) *OauthFlows

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

+ type OauthFlowsDefsAuthorizationCode struct

+ AuthorizationURL string

+ MapOfAnything map[string]interface{}

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

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

+ func (o *OauthFlowsDefsAuthorizationCode) WithAuthorizationURL(val string) *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlowsDefsAuthorizationCode) WithMapOfAnything(val map[string]interface{}) *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlowsDefsAuthorizationCode) WithMapOfAnythingItem(key string, val interface{}) *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlowsDefsAuthorizationCode) WithRefreshURL(val string) *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlowsDefsAuthorizationCode) WithScopes(val map[string]string) *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlowsDefsAuthorizationCode) WithScopesItem(key string, val string) *OauthFlowsDefsAuthorizationCode

+ func (o *OauthFlowsDefsAuthorizationCode) WithTokenURL(val string) *OauthFlowsDefsAuthorizationCode

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

+ type OauthFlowsDefsClientCredentials struct

+ MapOfAnything map[string]interface{}

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

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

+ func (o *OauthFlowsDefsClientCredentials) WithMapOfAnything(val map[string]interface{}) *OauthFlowsDefsClientCredentials

+ func (o *OauthFlowsDefsClientCredentials) WithMapOfAnythingItem(key string, val interface{}) *OauthFlowsDefsClientCredentials

+ func (o *OauthFlowsDefsClientCredentials) WithRefreshURL(val string) *OauthFlowsDefsClientCredentials

+ func (o *OauthFlowsDefsClientCredentials) WithScopes(val map[string]string) *OauthFlowsDefsClientCredentials

+ func (o *OauthFlowsDefsClientCredentials) WithScopesItem(key string, val string) *OauthFlowsDefsClientCredentials

+ func (o *OauthFlowsDefsClientCredentials) WithTokenURL(val string) *OauthFlowsDefsClientCredentials

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

+ type OauthFlowsDefsImplicit struct

+ AuthorizationURL string

+ MapOfAnything map[string]interface{}

+ RefreshURL *string

+ Scopes map[string]string

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

+ func (o *OauthFlowsDefsImplicit) WithAuthorizationURL(val string) *OauthFlowsDefsImplicit

+ func (o *OauthFlowsDefsImplicit) WithMapOfAnything(val map[string]interface{}) *OauthFlowsDefsImplicit

+ func (o *OauthFlowsDefsImplicit) WithMapOfAnythingItem(key string, val interface{}) *OauthFlowsDefsImplicit

+ func (o *OauthFlowsDefsImplicit) WithRefreshURL(val string) *OauthFlowsDefsImplicit

+ func (o *OauthFlowsDefsImplicit) WithScopes(val map[string]string) *OauthFlowsDefsImplicit

+ func (o *OauthFlowsDefsImplicit) WithScopesItem(key string, val string) *OauthFlowsDefsImplicit

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

+ type OauthFlowsDefsPassword struct

+ MapOfAnything map[string]interface{}

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

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

+ func (o *OauthFlowsDefsPassword) WithMapOfAnything(val map[string]interface{}) *OauthFlowsDefsPassword

+ func (o *OauthFlowsDefsPassword) WithMapOfAnythingItem(key string, val interface{}) *OauthFlowsDefsPassword

+ func (o *OauthFlowsDefsPassword) WithRefreshURL(val string) *OauthFlowsDefsPassword

+ func (o *OauthFlowsDefsPassword) WithScopes(val map[string]string) *OauthFlowsDefsPassword

+ func (o *OauthFlowsDefsPassword) WithScopesItem(key string, val string) *OauthFlowsDefsPassword

+ func (o *OauthFlowsDefsPassword) WithTokenURL(val string) *OauthFlowsDefsPassword

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

+ type Operation struct

+ Callbacks map[string]CallbacksOrReference

+ Deprecated *bool

+ Description *string

+ ExternalDocs *ExternalDocumentation

+ ID *string

+ MapOfAnything map[string]interface{}

+ Parameters []ParameterOrReference

+ RequestBody *RequestBodyOrReference

+ Responses *Responses

+ Security []map[string][]string

+ Servers []Server

+ Summary *string

+ Tags []string

+ func (o *Operation) ExternalDocsEns() *ExternalDocumentation

+ func (o *Operation) RequestBodyEns() *RequestBodyOrReference

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

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

+ func (o *Operation) WithCallbacks(val map[string]CallbacksOrReference) *Operation

+ func (o *Operation) WithCallbacksItem(key string, val CallbacksOrReference) *Operation

+ func (o *Operation) WithDeprecated(val bool) *Operation

+ func (o *Operation) WithDescription(val string) *Operation

+ func (o *Operation) WithExternalDocs(val ExternalDocumentation) *Operation

+ func (o *Operation) WithID(val string) *Operation

+ func (o *Operation) WithMapOfAnything(val map[string]interface{}) *Operation

+ func (o *Operation) WithMapOfAnythingItem(key string, val interface{}) *Operation

+ func (o *Operation) WithParameters(val ...ParameterOrReference) *Operation

+ func (o *Operation) WithRequestBody(val RequestBodyOrReference) *Operation

+ func (o *Operation) WithResponses(val Responses) *Operation

+ func (o *Operation) WithSecurity(val ...map[string][]string) *Operation

+ func (o *Operation) WithServers(val ...Server) *Operation

+ func (o *Operation) WithSummary(val string) *Operation

+ func (o *Operation) WithTags(val ...string) *Operation

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

+ func (o Operation) UnknownParamIsForbidden(in ParameterIn) bool

+ type OperationExposer interface

+ Operation func() *Operation

+ type Parameter struct

+ Content map[string]MediaType

+ Deprecated *bool

+ Description *string

+ Example *interface{}

+ Examples map[string]ExampleOrReference

+ Explode *bool

+ In ParameterIn

+ MapOfAnything map[string]interface{}

+ Name string

+ Required *bool

+ Schema map[string]interface{}

+ Style *ParameterStyle

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

+ func (p *Parameter) WithContent(val map[string]MediaType) *Parameter

+ func (p *Parameter) WithContentItem(key string, val MediaType) *Parameter

+ func (p *Parameter) WithDeprecated(val bool) *Parameter

+ func (p *Parameter) WithDescription(val string) *Parameter

+ func (p *Parameter) WithExample(val interface{}) *Parameter

+ func (p *Parameter) WithExamples(val map[string]ExampleOrReference) *Parameter

+ func (p *Parameter) WithExamplesItem(key string, val ExampleOrReference) *Parameter

+ func (p *Parameter) WithExplode(val bool) *Parameter

+ func (p *Parameter) WithIn(val ParameterIn) *Parameter

+ func (p *Parameter) WithMapOfAnything(val map[string]interface{}) *Parameter

+ func (p *Parameter) WithMapOfAnythingItem(key string, val interface{}) *Parameter

+ func (p *Parameter) WithName(val string) *Parameter

+ func (p *Parameter) WithRequired(val bool) *Parameter

+ func (p *Parameter) WithSchema(val map[string]interface{}) *Parameter

+ func (p *Parameter) WithSchemaItem(key string, val interface{}) *Parameter

+ func (p *Parameter) WithStyle(val ParameterStyle) *Parameter

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

+ func (p Parameter) ToParameterOrRef() ParameterOrReference

+ type ParameterIn string

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

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

+ type ParameterOrReference struct

+ Parameter *Parameter

+ Reference *Reference

+ func (p *ParameterOrReference) ParameterEns() *Parameter

+ func (p *ParameterOrReference) ReferenceEns() *Reference

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

+ func (p *ParameterOrReference) WithParameter(val Parameter) *ParameterOrReference

+ func (p *ParameterOrReference) WithReference(val Reference) *ParameterOrReference

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

+ type ParameterStyle string

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

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

+ type PathItem struct

+ Delete *Operation

+ Description *string

+ Get *Operation

+ Head *Operation

+ MapOfAnything map[string]interface{}

+ Options *Operation

+ Parameters []ParameterOrReference

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Servers []Server

+ Summary *string

+ Trace *Operation

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

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

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

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

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

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

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

+ func (p *PathItem) SetOperation(method string, op *Operation) error

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

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

+ func (p *PathItem) WithDelete(val Operation) *PathItem

+ func (p *PathItem) WithDescription(val string) *PathItem

+ func (p *PathItem) WithGet(val Operation) *PathItem

+ func (p *PathItem) WithHead(val Operation) *PathItem

+ func (p *PathItem) WithMapOfAnything(val map[string]interface{}) *PathItem

+ func (p *PathItem) WithMapOfAnythingItem(key string, val interface{}) *PathItem

+ func (p *PathItem) WithOptions(val Operation) *PathItem

+ func (p *PathItem) WithParameters(val ...ParameterOrReference) *PathItem

+ func (p *PathItem) WithPatch(val Operation) *PathItem

+ func (p *PathItem) WithPost(val Operation) *PathItem

+ func (p *PathItem) WithPut(val Operation) *PathItem

+ func (p *PathItem) WithServers(val ...Server) *PathItem

+ func (p *PathItem) WithSummary(val string) *PathItem

+ func (p *PathItem) WithTrace(val Operation) *PathItem

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

+ func (p PathItem) Operation(method string) (*Operation, error)

+ type PathItemOrReference struct

+ PathItem *PathItem

+ Reference *Reference

+ func (p *PathItemOrReference) PathItemEns() *PathItem

+ func (p *PathItemOrReference) ReferenceEns() *Reference

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

+ func (p *PathItemOrReference) WithPathItem(val PathItem) *PathItemOrReference

+ func (p *PathItemOrReference) WithReference(val Reference) *PathItemOrReference

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

+ type Paths struct

+ MapOfAnything map[string]interface{}

+ MapOfPathItemValues map[string]PathItem

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

+ func (p *Paths) WithMapOfAnything(val map[string]interface{}) *Paths

+ func (p *Paths) WithMapOfAnythingItem(key string, val interface{}) *Paths

+ func (p *Paths) WithMapOfPathItemValues(val map[string]PathItem) *Paths

+ func (p *Paths) WithMapOfPathItemValuesItem(key string, val PathItem) *Paths

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

+ type Reference struct

+ Description *string

+ Ref *string

+ Summary *string

+ func (r *Reference) WithDescription(val string) *Reference

+ func (r *Reference) WithRef(val string) *Reference

+ func (r *Reference) WithSummary(val string) *Reference

+ type Reflector struct

+ Spec *Spec

+ func NewReflector() *Reflector

+ func (r *Reflector) AddOperation(oc openapi.OperationContext) error

+ func (r *Reflector) JSONSchemaReflector() *jsonschema.Reflector

+ func (r *Reflector) NewOperationContext(method, pathPattern string) (openapi.OperationContext, error)

+ func (r *Reflector) ResolveJSONSchemaRef(ref string) (s jsonschema.SchemaOrBool, found bool)

+ func (r *Reflector) SpecEns() *Spec

+ func (r *Reflector) SpecSchema() openapi.SpecSchema

+ func (r *Reflector) WalkRequestJSONSchemas(method string, cu openapi.ContentUnit, cb openapi.JSONSchemaCallback, ...) error

+ func (r *Reflector) WalkResponseJSONSchemas(cu openapi.ContentUnit, cb openapi.JSONSchemaCallback, ...) error

+ type RequestBody struct

+ Content map[string]MediaType

+ Description *string

+ MapOfAnything map[string]interface{}

+ Required *bool

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

+ func (r *RequestBody) WithContent(val map[string]MediaType) *RequestBody

+ func (r *RequestBody) WithContentItem(key string, val MediaType) *RequestBody

+ func (r *RequestBody) WithDescription(val string) *RequestBody

+ func (r *RequestBody) WithMapOfAnything(val map[string]interface{}) *RequestBody

+ func (r *RequestBody) WithMapOfAnythingItem(key string, val interface{}) *RequestBody

+ func (r *RequestBody) WithRequired(val bool) *RequestBody

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

+ type RequestBodyOrReference struct

+ Reference *Reference

+ RequestBody *RequestBody

+ func (r *RequestBodyOrReference) ReferenceEns() *Reference

+ func (r *RequestBodyOrReference) RequestBodyEns() *RequestBody

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

+ func (r *RequestBodyOrReference) WithReference(val Reference) *RequestBodyOrReference

+ func (r *RequestBodyOrReference) WithRequestBody(val RequestBody) *RequestBodyOrReference

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

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ Headers map[string]HeaderOrReference

+ Links map[string]LinkOrReference

+ MapOfAnything map[string]interface{}

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

+ func (r *Response) WithContent(val map[string]MediaType) *Response

+ func (r *Response) WithContentItem(key string, val MediaType) *Response

+ func (r *Response) WithDescription(val string) *Response

+ func (r *Response) WithHeaders(val map[string]HeaderOrReference) *Response

+ func (r *Response) WithHeadersItem(key string, val HeaderOrReference) *Response

+ func (r *Response) WithLinks(val map[string]LinkOrReference) *Response

+ func (r *Response) WithLinksItem(key string, val LinkOrReference) *Response

+ func (r *Response) WithMapOfAnything(val map[string]interface{}) *Response

+ func (r *Response) WithMapOfAnythingItem(key string, val interface{}) *Response

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

+ type ResponseOrReference struct

+ Reference *Reference

+ Response *Response

+ func (r *ResponseOrReference) ReferenceEns() *Reference

+ func (r *ResponseOrReference) ResponseEns() *Response

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

+ func (r *ResponseOrReference) WithReference(val Reference) *ResponseOrReference

+ func (r *ResponseOrReference) WithResponse(val Response) *ResponseOrReference

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

+ type Responses struct

+ Default *ResponseOrReference

+ MapOfAnything map[string]interface{}

+ MapOfResponseOrReferenceValues map[string]ResponseOrReference

+ func (r *Responses) DefaultEns() *ResponseOrReference

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

+ func (r *Responses) WithDefault(val ResponseOrReference) *Responses

+ func (r *Responses) WithMapOfAnything(val map[string]interface{}) *Responses

+ func (r *Responses) WithMapOfAnythingItem(key string, val interface{}) *Responses

+ func (r *Responses) WithMapOfResponseOrReferenceValues(val map[string]ResponseOrReference) *Responses

+ func (r *Responses) WithMapOfResponseOrReferenceValuesItem(key string, val ResponseOrReference) *Responses

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

+ type SecurityScheme struct

+ APIKey *SecuritySchemeAPIKey

+ Description *string

+ HTTP *SecuritySchemeHTTP

+ HTTPBearer *SecuritySchemeHTTPBearer

+ MapOfAnything map[string]interface{}

+ MutualTLS *MutualTLS

+ Oauth2 *SecuritySchemeOauth2

+ Oidc *SecuritySchemeOidc

+ func (s *SecurityScheme) APIKeyEns() *SecuritySchemeAPIKey

+ func (s *SecurityScheme) HTTPBearerEns() *SecuritySchemeHTTPBearer

+ func (s *SecurityScheme) HTTPEns() *SecuritySchemeHTTP

+ func (s *SecurityScheme) MutualTLSEns() *MutualTLS

+ func (s *SecurityScheme) Oauth2Ens() *SecuritySchemeOauth2

+ func (s *SecurityScheme) OidcEns() *SecuritySchemeOidc

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

+ func (s *SecurityScheme) WithAPIKey(val SecuritySchemeAPIKey) *SecurityScheme

+ func (s *SecurityScheme) WithDescription(val string) *SecurityScheme

+ func (s *SecurityScheme) WithHTTP(val SecuritySchemeHTTP) *SecurityScheme

+ func (s *SecurityScheme) WithHTTPBearer(val SecuritySchemeHTTPBearer) *SecurityScheme

+ func (s *SecurityScheme) WithMapOfAnything(val map[string]interface{}) *SecurityScheme

+ func (s *SecurityScheme) WithMapOfAnythingItem(key string, val interface{}) *SecurityScheme

+ func (s *SecurityScheme) WithMutualTLS(val MutualTLS) *SecurityScheme

+ func (s *SecurityScheme) WithOauth2(val SecuritySchemeOauth2) *SecurityScheme

+ func (s *SecurityScheme) WithOidc(val SecuritySchemeOidc) *SecurityScheme

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

+ type SecuritySchemeAPIKey struct

+ In SecuritySchemeAPIKeyIn

+ Name string

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

+ func (s *SecuritySchemeAPIKey) WithIn(val SecuritySchemeAPIKeyIn) *SecuritySchemeAPIKey

+ func (s *SecuritySchemeAPIKey) WithName(val string) *SecuritySchemeAPIKey

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

+ type SecuritySchemeAPIKeyIn string

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

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

+ type SecuritySchemeHTTP struct

+ Scheme string

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

+ func (s *SecuritySchemeHTTP) WithScheme(val string) *SecuritySchemeHTTP

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

+ type SecuritySchemeHTTPBearer struct

+ BearerFormat *string

+ Scheme string

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

+ func (s *SecuritySchemeHTTPBearer) WithBearerFormat(val string) *SecuritySchemeHTTPBearer

+ func (s *SecuritySchemeHTTPBearer) WithScheme(val string) *SecuritySchemeHTTPBearer

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

+ type SecuritySchemeOauth2 struct

+ Flows OauthFlows

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

+ func (s *SecuritySchemeOauth2) WithFlows(val OauthFlows) *SecuritySchemeOauth2

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

+ type SecuritySchemeOidc struct

+ OpenIDConnectURL string

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

+ func (s *SecuritySchemeOidc) WithOpenIDConnectURL(val string) *SecuritySchemeOidc

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

+ type SecuritySchemeOrReference struct

+ Reference *Reference

+ SecurityScheme *SecurityScheme

+ func (s *SecuritySchemeOrReference) ReferenceEns() *Reference

+ func (s *SecuritySchemeOrReference) SecuritySchemeEns() *SecurityScheme

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

+ func (s *SecuritySchemeOrReference) WithReference(val Reference) *SecuritySchemeOrReference

+ func (s *SecuritySchemeOrReference) WithSecurityScheme(val SecurityScheme) *SecuritySchemeOrReference

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

+ type Server struct

+ Description *string

+ MapOfAnything map[string]interface{}

+ URL string

+ Variables map[string]ServerVariable

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

+ func (s *Server) WithDescription(val string) *Server

+ func (s *Server) WithMapOfAnything(val map[string]interface{}) *Server

+ func (s *Server) WithMapOfAnythingItem(key string, val interface{}) *Server

+ func (s *Server) WithURL(val string) *Server

+ func (s *Server) WithVariables(val map[string]ServerVariable) *Server

+ func (s *Server) WithVariablesItem(key string, val ServerVariable) *Server

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

+ type ServerVariable struct

+ Default string

+ Description *string

+ Enum []string

+ MapOfAnything map[string]interface{}

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

+ func (s *ServerVariable) WithDefault(val string) *ServerVariable

+ func (s *ServerVariable) WithDescription(val string) *ServerVariable

+ func (s *ServerVariable) WithEnum(val ...string) *ServerVariable

+ func (s *ServerVariable) WithMapOfAnything(val map[string]interface{}) *ServerVariable

+ func (s *ServerVariable) WithMapOfAnythingItem(key string, val interface{}) *ServerVariable

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

+ type Spec struct

+ Components *Components

+ ExternalDocs *ExternalDocumentation

+ Info Info

+ JSONSchemaDialect *string

+ MapOfAnything map[string]interface{}

+ Openapi string

+ Paths *Paths

+ Security []map[string][]string

+ Servers []Server

+ Tags []Tag

+ Webhooks map[string]PathItemOrReference

+ func (s *Spec) AddOperation(method, path string, operation Operation) error

+ func (s *Spec) ComponentsEns() *Components

+ func (s *Spec) Description() string

+ func (s *Spec) ExternalDocsEns() *ExternalDocumentation

+ func (s *Spec) MarshalYAML() ([]byte, error)

+ func (s *Spec) PathsEns() *Paths

+ func (s *Spec) SetAPIKeySecurity(securityName string, fieldName string, fieldIn openapi.In, description string)

+ func (s *Spec) SetDescription(d string)

+ func (s *Spec) SetHTTPBasicSecurity(securityName string, description string)

+ func (s *Spec) SetHTTPBearerTokenSecurity(securityName string, format string, description string)

+ func (s *Spec) SetTitle(t string)

+ func (s *Spec) SetVersion(v string)

+ func (s *Spec) SetupOperation(method, path string, setup ...func(*Operation) error) error

+ func (s *Spec) Title() string

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

+ func (s *Spec) UnmarshalYAML(data []byte) error

+ func (s *Spec) Version() string

+ func (s *Spec) WithComponents(val Components) *Spec

+ func (s *Spec) WithExternalDocs(val ExternalDocumentation) *Spec

+ func (s *Spec) WithInfo(val Info) *Spec

+ func (s *Spec) WithJSONSchemaDialect(val string) *Spec

+ func (s *Spec) WithMapOfAnything(val map[string]interface{}) *Spec

+ func (s *Spec) WithMapOfAnythingItem(key string, val interface{}) *Spec

+ func (s *Spec) WithOpenapi(val string) *Spec

+ func (s *Spec) WithPaths(val Paths) *Spec

+ func (s *Spec) WithSecurity(val ...map[string][]string) *Spec

+ func (s *Spec) WithServers(val ...Server) *Spec

+ func (s *Spec) WithTags(val ...Tag) *Spec

+ func (s *Spec) WithWebhooks(val map[string]PathItemOrReference) *Spec

+ func (s *Spec) WithWebhooksItem(key string, val PathItemOrReference) *Spec

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

+ type Tag struct

+ Description *string

+ ExternalDocs *ExternalDocumentation

+ MapOfAnything map[string]interface{}

+ Name string

+ func (t *Tag) ExternalDocsEns() *ExternalDocumentation

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

+ func (t *Tag) WithDescription(val string) *Tag

+ func (t *Tag) WithExternalDocs(val ExternalDocumentation) *Tag

+ func (t *Tag) WithMapOfAnything(val map[string]interface{}) *Tag

+ func (t *Tag) WithMapOfAnythingItem(key string, val interface{}) *Tag

+ func (t *Tag) WithName(val string) *Tag

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

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