func ConvertToJSON(valueany) (any,error)

func GetType(vany) (string,error)

func NewSpecNotFoundError(messagestring, visitedObjects visitedObjects)error

func NewUnsupportedSpecTypeError(specany)error

func NewUnsupportedTypeError(vreflect.Kind)error

func NewUnsupportedVersionError(versionstring)error

type BoolOrSchema struct {Schema  *RefOrSpec[Schema]Allowedbool}

funcNewBoolOrSchema¶

func NewBoolOrSchema(vany) *BoolOrSchema

func (*BoolOrSchema)MarshalJSON¶

func (o *BoolOrSchema) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*BoolOrSchema)MarshalYAML¶

func (o *BoolOrSchema) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*BoolOrSchema)UnmarshalJSON¶

func (o *BoolOrSchema) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*BoolOrSchema)UnmarshalYAML¶

func (o *BoolOrSchema) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Callback struct {Paths map[string]*RefOrSpec[Extendable[PathItem]]}

func (*Callback)Add¶

func (o *Callback) Add(expressionstring, item *RefOrSpec[Extendable[PathItem]]) *Callback

func (*Callback)MarshalJSON¶

func (o *Callback) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*Callback)MarshalYAML¶

func (o *Callback) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*Callback)UnmarshalJSON¶

func (o *Callback) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*Callback)UnmarshalYAML¶

func (o *Callback) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type CallbackBuilder struct {// contains filtered or unexported fields}

funcNewCallbackBuilder¶

func NewCallbackBuilder() *CallbackBuilder

func (*CallbackBuilder)AddExt¶

func (b *CallbackBuilder) AddExt(namestring, valueany) *CallbackBuilder

func (*CallbackBuilder)AddPathItem¶

func (b *CallbackBuilder) AddPathItem(expressionstring, item *RefOrSpec[Extendable[PathItem]]) *CallbackBuilder

func (*CallbackBuilder)Build¶

func (b *CallbackBuilder) Build() *RefOrSpec[Extendable[Callback]]

func (*CallbackBuilder)Extensions¶

func (b *CallbackBuilder) Extensions(v map[string]any) *CallbackBuilder

func (*CallbackBuilder)Paths¶

func (b *CallbackBuilder) Paths(paths map[string]*RefOrSpec[Extendable[PathItem]]) *CallbackBuilder

type Components struct {// An object to hold reusable Schema Objects.Schemas map[string]*RefOrSpec[Schema] `json:"schemas,omitempty" yaml:"schemas,omitempty"`// An object to hold reusable Response Objects.Responses map[string]*RefOrSpec[Extendable[Response]] `json:"responses,omitempty" yaml:"responses,omitempty"`// An object to hold reusable Parameter Objects.Parameters map[string]*RefOrSpec[Extendable[Parameter]] `json:"parameters,omitempty" yaml:"parameters,omitempty"`// An object to hold reusable Example Objects.Examples map[string]*RefOrSpec[Extendable[Example]] `json:"examples,omitempty" yaml:"examples,omitempty"`// An object to hold reusable Request Body Objects.RequestBodies map[string]*RefOrSpec[Extendable[RequestBody]] `json:"requestBodies,omitempty" yaml:"requestBodies,omitempty"`// An object to hold reusable Header Objects.Headers map[string]*RefOrSpec[Extendable[Header]] `json:"headers,omitempty" yaml:"headers,omitempty"`// An object to hold reusable Security Scheme Objects.SecuritySchemes map[string]*RefOrSpec[Extendable[SecurityScheme]] `json:"securitySchemes,omitempty" yaml:"securitySchemes,omitempty"`// An object to hold reusable Link Objects.Links map[string]*RefOrSpec[Extendable[Link]] `json:"links,omitempty" yaml:"links,omitempty"`// An object to hold reusable Callback Objects.Callbacks map[string]*RefOrSpec[Extendable[Callback]] `json:"callbacks,omitempty" yaml:"callbacks,omitempty"`// An object to hold reusable Path Item Object.Paths map[string]*RefOrSpec[Extendable[PathItem]] `json:"paths,omitempty" yaml:"paths,omitempty"`}

func (*Components)Add¶

func (o *Components) Add(namestring, vany) *Components

Add adds the given object to the appropriate list based on a type and returns the current object (self|this).

type Contact struct {// The identifying name of the contact person/organization.Namestring `json:"name,omitempty" yaml:"name,omitempty"`// The URL pointing to the contact information.// This MUST be in the form of a URL.URLstring `json:"url,omitempty" yaml:"url,omitempty"`// The email address of the contact person/organization.// This MUST be in the form of an email address.Emailstring `json:"email,omitempty" yaml:"email,omitempty"`}

type ContactBuilder struct {// contains filtered or unexported fields}

funcNewContactBuilder¶

func NewContactBuilder() *ContactBuilder

func (*ContactBuilder)AddExt¶

func (b *ContactBuilder) AddExt(namestring, valueany) *ContactBuilder

func (*ContactBuilder)Build¶

func (b *ContactBuilder) Build() *Extendable[Contact]

func (*ContactBuilder)Email¶

func (b *ContactBuilder) Email(vstring) *ContactBuilder

func (*ContactBuilder)Extensions¶

func (b *ContactBuilder) Extensions(v map[string]any) *ContactBuilder

func (*ContactBuilder)Name¶

func (b *ContactBuilder) Name(vstring) *ContactBuilder

func (*ContactBuilder)URL¶

func (b *ContactBuilder) URL(vstring) *ContactBuilder

type Discriminator struct {// An object to hold mappings between payload values and schema names or references.Mapping map[string]string `json:"mapping,omitempty" yaml:"mapping,omitempty"`// REQUIRED.// The name of the property in the payload that will hold the discriminator value.PropertyNamestring `json:"propertyName" yaml:"propertyName"`}

type DiscriminatorBuilder struct {// contains filtered or unexported fields}

funcNewDiscriminatorBuilder¶

func NewDiscriminatorBuilder() *DiscriminatorBuilder

func (*DiscriminatorBuilder)AddMapping¶

func (b *DiscriminatorBuilder) AddMapping(name, valuestring) *DiscriminatorBuilder

func (*DiscriminatorBuilder)Build¶

func (b *DiscriminatorBuilder) Build() *Discriminator

func (*DiscriminatorBuilder)Mapping¶

func (b *DiscriminatorBuilder) Mapping(v map[string]string) *DiscriminatorBuilder

func (*DiscriminatorBuilder)PropertyName¶

func (b *DiscriminatorBuilder) PropertyName(vstring) *DiscriminatorBuilder

type Encoding struct {// The Content-Type for encoding a specific property.// Default value depends on the property type://   for object - application/json;//   for array – the default is defined based on the inner type;//   for all other cases the default is application/octet-stream.// The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*),// or a comma-separated list of the two types.ContentTypestring `json:"contentType,omitempty" yaml:"contentType,omitempty"`// A map allowing additional information to be provided as headers, for example Content-Disposition.// Content-Type is described separately and SHALL be ignored in this section.// This property SHALL be ignored if the request body media type is not a multipart.Headers map[string]*RefOrSpec[Extendable[Header]] `json:"headers,omitempty" yaml:"headers,omitempty"`// Describes how a specific property value will be serialized depending on its type.// See Parameter Object for details on the style property.// The behavior follows the same values as query parameters, including default values.// This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.// If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.Stylestring `json:"style,omitempty" yaml:"style,omitempty"`// When this is true, property values of type array or object generate separate parameters for each value of the array,// or key-value-pair of the map.// For other types of properties this property has no effect.// When style is form, the default value is true.// For all other styles, the default value is false.// This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.// If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.Explodebool `json:"explode,omitempty" yaml:"explode,omitempty"`// Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986]//   :/?#[]@!$&'()*+,;=// to be included without percent-encoding.// The default value is false.// This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.// If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.AllowReservedbool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"`}

type EncodingBuilder struct {// contains filtered or unexported fields}

funcNewEncodingBuilder¶

func NewEncodingBuilder() *EncodingBuilder

func (*EncodingBuilder)AddExt¶

func (b *EncodingBuilder) AddExt(namestring, valueany) *EncodingBuilder

func (*EncodingBuilder)AllowReserved¶

func (b *EncodingBuilder) AllowReserved(vbool) *EncodingBuilder

func (*EncodingBuilder)Build¶

func (b *EncodingBuilder) Build() *Extendable[Encoding]

func (*EncodingBuilder)ContentType¶

func (b *EncodingBuilder) ContentType(vstring) *EncodingBuilder

func (*EncodingBuilder)Explode¶

func (b *EncodingBuilder) Explode(vbool) *EncodingBuilder

func (*EncodingBuilder)Extensions¶

func (b *EncodingBuilder) Extensions(v map[string]any) *EncodingBuilder

func (*EncodingBuilder)Header¶

func (b *EncodingBuilder) Header(namestring, value *RefOrSpec[Extendable[Header]]) *EncodingBuilder

func (*EncodingBuilder)Headers¶

func (b *EncodingBuilder) Headers(v map[string]*RefOrSpec[Extendable[Header]]) *EncodingBuilder

func (*EncodingBuilder)Style¶

func (b *EncodingBuilder) Style(vstring) *EncodingBuilder

type Example struct {// Short description for the example.Summarystring `json:"summary,omitempty" yaml:"summary,omitempty"`// Long description for the example.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// Embedded literal example.// The value field and externalValue field are mutually exclusive.// To represent examples of media types that cannot naturally represented in JSON or YAML,// use a string value to contain the example, escaping where necessary.Valueany `json:"value,omitempty" yaml:"value,omitempty"`// A URI that points to the literal example.// This provides the capability to reference examples that cannot easily be included in JSON or YAML documents.// The value field and externalValue field are mutually exclusive.// See the rules for resolving Relative References.ExternalValuestring `json:"externalValue,omitempty" yaml:"externalValue,omitempty"`}

type ExampleBuilder struct {// contains filtered or unexported fields}

funcNewExampleBuilder¶

func NewExampleBuilder() *ExampleBuilder

func (*ExampleBuilder)AddExt¶

func (b *ExampleBuilder) AddExt(namestring, valueany) *ExampleBuilder

func (*ExampleBuilder)Build¶

func (b *ExampleBuilder) Build() *RefOrSpec[Extendable[Example]]

func (*ExampleBuilder)Description¶

func (b *ExampleBuilder) Description(vstring) *ExampleBuilder

func (*ExampleBuilder)Extensions¶

func (b *ExampleBuilder) Extensions(v map[string]any) *ExampleBuilder

func (*ExampleBuilder)ExternalValue¶

func (b *ExampleBuilder) ExternalValue(vstring) *ExampleBuilder

func (*ExampleBuilder)Summary¶

func (b *ExampleBuilder) Summary(vstring) *ExampleBuilder

func (*ExampleBuilder)Value¶

func (b *ExampleBuilder) Value(vany) *ExampleBuilder

type Extendable[Tany] struct {Spec       *T             `json:"-" yaml:"-"`Extensions map[string]any `json:"-" yaml:"-"`}

funcNewComponents¶

func NewComponents() *Extendable[Components]

funcNewExtendable¶

func NewExtendable[Tany](spec *T) *Extendable[T]

NewExtendable creates new Extendable object for given spec

funcNewPaths¶

func NewPaths() *Extendable[Paths]

func (*Extendable[T])AddExt¶

func (o *Extendable[T]) AddExt(namestring, valueany) *Extendable[T]

AddExt sets the extension and returns the current object.The `x-` prefix will be added automatically to given name.

func (*Extendable[T])GetExt¶

func (o *Extendable[T]) GetExt(namestring)any

GetExt returns the extension value by name.The `x-` prefix will be added automatically to given name.

func (*Extendable[T])MarshalJSON¶

func (o *Extendable[T]) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*Extendable[T])MarshalYAML¶

func (o *Extendable[T]) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*Extendable[T])UnmarshalJSON¶

func (o *Extendable[T]) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*Extendable[T])UnmarshalYAML¶

func (o *Extendable[T]) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type ExternalDocs struct {// A description of the target documentation.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description" yaml:"description"`// REQUIRED.// The URL for the target documentation.// This MUST be in the form of a URL.URLstring `json:"url" yaml:"url"`}

type ExternalDocsBuilder struct {// contains filtered or unexported fields}

funcNewExternalDocsBuilder¶

func NewExternalDocsBuilder() *ExternalDocsBuilder

func (*ExternalDocsBuilder)AddExt¶

func (b *ExternalDocsBuilder) AddExt(namestring, valueany) *ExternalDocsBuilder

func (*ExternalDocsBuilder)Build¶

func (b *ExternalDocsBuilder) Build() *Extendable[ExternalDocs]

func (*ExternalDocsBuilder)Description¶

func (b *ExternalDocsBuilder) Description(vstring) *ExternalDocsBuilder

func (*ExternalDocsBuilder)Extensions¶

func (b *ExternalDocsBuilder) Extensions(v map[string]any) *ExternalDocsBuilder

func (*ExternalDocsBuilder)URL¶

func (b *ExternalDocsBuilder) URL(vstring) *ExternalDocsBuilder

type Header struct {// The schema defining the type used for the header.Schema *RefOrSpec[Schema] `json:"schema,omitempty" yaml:"schema,omitempty"`// A map containing the representations for the header.// The key is the media type and the value describes it.// The map MUST only contain one entry.Content map[string]*Extendable[MediaType] `json:"content,omitempty" yaml:"content,omitempty"`// A brief description of the header.// This could contain examples of use.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// Describes how the header value will be serialized.Stylestring `json:"style,omitempty" yaml:"style,omitempty"`// When this is true, header values of type array or object generate separate headers// for each value of the array or key-value pair of the map.// For other types of parameters this property has no effect.// When style is form, the default value is true.// For all other styles, the default value is false.Explodebool `json:"explode,omitempty" yaml:"explode,omitempty"`// Determines whether this header is mandatory.// The property MAY be included and its default value is false.Requiredbool `json:"required,omitempty" yaml:"required,omitempty"`// Specifies that a header is deprecated and SHOULD be transitioned out of usage.// Default value is false.Deprecatedbool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`}

type HeaderBuilder struct {// contains filtered or unexported fields}

funcNewHeaderBuilder¶

func NewHeaderBuilder() *HeaderBuilder

func (*HeaderBuilder)AddContent¶

func (b *HeaderBuilder) AddContent(namestring, value *Extendable[MediaType]) *HeaderBuilder

func (*HeaderBuilder)AddExt¶

func (b *HeaderBuilder) AddExt(namestring, valueany) *HeaderBuilder

func (*HeaderBuilder)Build¶

func (b *HeaderBuilder) Build() *RefOrSpec[Extendable[Header]]

func (*HeaderBuilder)Content¶

func (b *HeaderBuilder) Content(v map[string]*Extendable[MediaType]) *HeaderBuilder

func (*HeaderBuilder)Deprecated¶

func (b *HeaderBuilder) Deprecated(vbool) *HeaderBuilder

func (*HeaderBuilder)Description¶

func (b *HeaderBuilder) Description(vstring) *HeaderBuilder

func (*HeaderBuilder)Explode¶

func (b *HeaderBuilder) Explode(vbool) *HeaderBuilder

func (*HeaderBuilder)Extensions¶

func (b *HeaderBuilder) Extensions(v map[string]any) *HeaderBuilder

func (*HeaderBuilder)Required¶

func (b *HeaderBuilder) Required(vbool) *HeaderBuilder

func (*HeaderBuilder)Schema¶

func (b *HeaderBuilder) Schema(v *RefOrSpec[Schema]) *HeaderBuilder

func (*HeaderBuilder)Style¶

func (b *HeaderBuilder) Style(vstring) *HeaderBuilder

type Info struct {// REQUIRED.// The title of the API.Titlestring `json:"title" yaml:"title"`// A short summary of the API.Summarystring `json:"summary,omitempty" yaml:"summary,omitempty"`// A description of the API.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// A URL to the Terms of Service for the API.// This MUST be in the form of a URL.TermsOfServicestring `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"`// The contact information for the exposed API.Contact *Extendable[Contact] `json:"contact,omitempty" yaml:"contact,omitempty"`// The license information for the exposed API.License *Extendable[License] `json:"license,omitempty" yaml:"license,omitempty"`// REQUIRED.// The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).Versionstring `json:"version" yaml:"version"`}

type InfoBuilder struct {// contains filtered or unexported fields}

funcNewInfoBuilder¶

func NewInfoBuilder() *InfoBuilder

func (*InfoBuilder)AddExt¶

func (b *InfoBuilder) AddExt(namestring, valueany) *InfoBuilder

func (*InfoBuilder)Build¶

func (b *InfoBuilder) Build() *Extendable[Info]

func (*InfoBuilder)Contact¶

func (b *InfoBuilder) Contact(v *Extendable[Contact]) *InfoBuilder

func (*InfoBuilder)Description¶

func (b *InfoBuilder) Description(vstring) *InfoBuilder

func (*InfoBuilder)Extensions¶

func (b *InfoBuilder) Extensions(v map[string]any) *InfoBuilder

func (*InfoBuilder)License¶

func (b *InfoBuilder) License(v *Extendable[License]) *InfoBuilder

func (*InfoBuilder)Summary¶

func (b *InfoBuilder) Summary(vstring) *InfoBuilder

func (*InfoBuilder)TermsOfService¶

func (b *InfoBuilder) TermsOfService(vstring) *InfoBuilder

func (*InfoBuilder)Title¶

func (b *InfoBuilder) Title(vstring) *InfoBuilder

func (*InfoBuilder)Version¶

func (b *InfoBuilder) Version(vstring) *InfoBuilder

type License struct {// REQUIRED.// The license name used for the API.Namestring `json:"name" yaml:"name"`// An SPDX license expression for the API.// The identifier field is mutually exclusive of the url field.Identifierstring `json:"identifier,omitempty" yaml:"identifier,omitempty"`// A URL to the license used for the API.// This MUST be in the form of a URL.// The url field is mutually exclusive of the identifier field.URLstring `json:"url,omitempty" yaml:"url,omitempty"`}

type LicenseBuilder struct {// contains filtered or unexported fields}

funcNewLicenseBuilder¶

func NewLicenseBuilder() *LicenseBuilder

func (*LicenseBuilder)AddExt¶

func (b *LicenseBuilder) AddExt(namestring, valueany) *LicenseBuilder

func (*LicenseBuilder)Build¶

func (b *LicenseBuilder) Build() *Extendable[License]

func (*LicenseBuilder)Extensions¶

func (b *LicenseBuilder) Extensions(v map[string]any) *LicenseBuilder

func (*LicenseBuilder)Identifier¶

func (b *LicenseBuilder) Identifier(vstring) *LicenseBuilder

func (*LicenseBuilder)Name¶

func (b *LicenseBuilder) Name(vstring) *LicenseBuilder

func (*LicenseBuilder)URL¶

func (b *LicenseBuilder) URL(vstring) *LicenseBuilder

type Link struct {// A literal value or {expression} to use as a request body when calling the target operation.RequestBodyany `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`// A map representing parameters to pass to an operation as specified with operationId or identified via operationRef.// The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and// passed to the linked operation.// The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use// the same parameter name in different locations (e.g. path.id).Parameters map[string]any `json:"parameters,omitempty" yaml:"parameters,omitempty"`// A server object to be used by the target operation.Server *Extendable[Server] `json:"server,omitempty" yaml:"server,omitempty"`// A relative or absolute URI reference to an OAS operation.// This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.// Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.// See the rules for resolving Relative References.OperationRefstring `json:"operationRef,omitempty" yaml:"operationRef,omitempty"`// The name of an existing, resolvable OAS operation, as defined with a unique operationId.// This field is mutually exclusive of the operationRef field.OperationIDstring `json:"operationId,omitempty" yaml:"operationId,omitempty"`// A description of the link.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`}

type LinkBuilder struct {// contains filtered or unexported fields}

funcNewLinkBuilder¶

func NewLinkBuilder() *LinkBuilder

func (*LinkBuilder)AddExt¶

func (b *LinkBuilder) AddExt(namestring, valueany) *LinkBuilder

func (*LinkBuilder)AddParameter¶

func (b *LinkBuilder) AddParameter(namestring, valueany) *LinkBuilder

func (*LinkBuilder)Build¶

func (b *LinkBuilder) Build() *RefOrSpec[Extendable[Link]]

func (*LinkBuilder)Description¶

func (b *LinkBuilder) Description(vstring) *LinkBuilder

func (*LinkBuilder)Extensions¶

func (b *LinkBuilder) Extensions(v map[string]any) *LinkBuilder

func (*LinkBuilder)OperationID¶

func (b *LinkBuilder) OperationID(vstring) *LinkBuilder

func (*LinkBuilder)OperationRef¶

func (b *LinkBuilder) OperationRef(vstring) *LinkBuilder

func (*LinkBuilder)Parameters¶

func (b *LinkBuilder) Parameters(v map[string]any) *LinkBuilder

func (*LinkBuilder)RequestBody¶

func (b *LinkBuilder) RequestBody(vany) *LinkBuilder

func (*LinkBuilder)Server¶

func (b *LinkBuilder) Server(v *Extendable[Server]) *LinkBuilder

type MapKeyMustBeStringError struct {LocationstringKeyTypereflect.Kind}

funcNewMapKeyMustBeStringError¶added inv1.1.0

func NewMapKeyMustBeStringError(locationstring, keyTypereflect.Kind) *MapKeyMustBeStringError

NewMapKeyMustBeStringError creates a new MapKeyMustBeStringError with the given location and key type.

func (*MapKeyMustBeStringError)Error¶added inv1.1.0

func (e *MapKeyMustBeStringError) Error()string

func (*MapKeyMustBeStringError)Is¶added inv1.1.0

func (e *MapKeyMustBeStringError) Is(targeterror)bool

type MediaType struct {// The schema defining the content of the request, response, or parameter.Schema *RefOrSpec[Schema] `json:"schema,omitempty" yaml:"schema,omitempty"`// Example of the media type. The example object SHOULD be in the correct format as specified by the media type.// The example field is mutually exclusive of the examples field.// Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.Exampleany `json:"example,omitempty" yaml:"example,omitempty"`// Examples of the parameter’s potential value.// Each example SHOULD contain a value in the correct format as specified in the parameter encoding.// The examples field is mutually exclusive of the example field.// Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.Examples map[string]*RefOrSpec[Extendable[Example]] `json:"examples,omitempty" yaml:"examples,omitempty"`// A map between a property name and its encoding information.// The key, being the property name, MUST exist in the schema as a property.// The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.Encoding map[string]*Extendable[Encoding] `json:"encoding,omitempty" yaml:"encoding,omitempty"`}

type MediaTypeBuilder struct {// contains filtered or unexported fields}

funcNewMediaTypeBuilder¶

func NewMediaTypeBuilder() *MediaTypeBuilder

func (*MediaTypeBuilder)AddEncoding¶

func (b *MediaTypeBuilder) AddEncoding(namestring, value *Extendable[Encoding]) *MediaTypeBuilder

func (*MediaTypeBuilder)AddExample¶

func (b *MediaTypeBuilder) AddExample(namestring, value *RefOrSpec[Extendable[Example]]) *MediaTypeBuilder

func (*MediaTypeBuilder)AddExt¶

func (b *MediaTypeBuilder) AddExt(namestring, valueany) *MediaTypeBuilder

func (*MediaTypeBuilder)Build¶

func (b *MediaTypeBuilder) Build() *Extendable[MediaType]

func (*MediaTypeBuilder)Encoding¶

func (b *MediaTypeBuilder) Encoding(v map[string]*Extendable[Encoding]) *MediaTypeBuilder

func (*MediaTypeBuilder)Example¶

func (b *MediaTypeBuilder) Example(vany) *MediaTypeBuilder

func (*MediaTypeBuilder)Examples¶

func (b *MediaTypeBuilder) Examples(v map[string]*RefOrSpec[Extendable[Example]]) *MediaTypeBuilder

func (*MediaTypeBuilder)Extensions¶

func (b *MediaTypeBuilder) Extensions(v map[string]any) *MediaTypeBuilder

func (*MediaTypeBuilder)Schema¶

func (b *MediaTypeBuilder) Schema(v *RefOrSpec[Schema]) *MediaTypeBuilder

type OAuthFlow struct {// REQUIRED.// The available scopes for the OAuth2 security scheme.// A map between the scope name and a short description for it.// The map MAY be empty.//// Applies To: oauth2Scopes map[string]string `json:"scopes,omitempty" yaml:"scopes,omitempty"`// REQUIRED.// The authorization URL to be used for this flow.// This MUST be in the form of a URL.// The OAuth2 standard requires the use of TLS.//// Applies To:oauth2 ("implicit", "authorizationCode")AuthorizationURLstring `json:"authorizationUrl,omitempty" yaml:"authorizationUrl,omitempty"`// REQUIRED.// The token URL to be used for this flow.// This MUST be in the form of a URL.// The OAuth2 standard requires the use of TLS.//// Applies To: oauth2 ("password", "clientCredentials", "authorizationCode")TokenURLstring `json:"tokenUrl,omitempty" yaml:"tokenUrl,omitempty"`// The URL to be used for obtaining refresh tokens.// This MUST be in the form of a URL.// The OAuth2 standard requires the use of TLS.//// Applies To: oauth2RefreshURLstring `json:"refreshUrl,omitempty" yaml:"refreshUrl,omitempty"`}

type OAuthFlowBuilder struct {// contains filtered or unexported fields}

funcNewOAuthFlowBuilder¶

func NewOAuthFlowBuilder() *OAuthFlowBuilder

func (*OAuthFlowBuilder)AddExt¶

func (b *OAuthFlowBuilder) AddExt(namestring, valueany) *OAuthFlowBuilder

func (*OAuthFlowBuilder)AddScope¶

func (b *OAuthFlowBuilder) AddScope(name, valuestring) *OAuthFlowBuilder

func (*OAuthFlowBuilder)AuthorizationURL¶

func (b *OAuthFlowBuilder) AuthorizationURL(vstring) *OAuthFlowBuilder

func (*OAuthFlowBuilder)Build¶

func (b *OAuthFlowBuilder) Build() *Extendable[OAuthFlow]

func (*OAuthFlowBuilder)Extensions¶

func (b *OAuthFlowBuilder) Extensions(v map[string]any) *OAuthFlowBuilder

func (*OAuthFlowBuilder)RefreshURL¶

func (b *OAuthFlowBuilder) RefreshURL(vstring) *OAuthFlowBuilder

func (*OAuthFlowBuilder)Scopes¶

func (b *OAuthFlowBuilder) Scopes(v map[string]string) *OAuthFlowBuilder

func (*OAuthFlowBuilder)TokenURL¶

func (b *OAuthFlowBuilder) TokenURL(vstring) *OAuthFlowBuilder

type OAuthFlows struct {// Configuration for the OAuth Implicit flow.Implicit *Extendable[OAuthFlow] `json:"implicit,omitempty" yaml:"implicit,omitempty"`// Configuration for the OAuth Resource Owner Password flow.Password *Extendable[OAuthFlow] `json:"password,omitempty" yaml:"password,omitempty"`// Configuration for the OAuth Client Credentials flow.// Previously called application in OpenAPI 2.0.ClientCredentials *Extendable[OAuthFlow] `json:"clientCredentials,omitempty" yaml:"clientCredentials,omitempty"`// Configuration for the OAuth Authorization Code flow.// Previously called accessCode in OpenAPI 2.0.AuthorizationCode *Extendable[OAuthFlow] `json:"authorizationCode,omitempty" yaml:"authorizationCode,omitempty"`}

type OAuthFlowsBuilder struct {// contains filtered or unexported fields}

funcNewOAuthFlowsBuilder¶

func NewOAuthFlowsBuilder() *OAuthFlowsBuilder

func (*OAuthFlowsBuilder)AddExt¶

func (b *OAuthFlowsBuilder) AddExt(namestring, valueany) *OAuthFlowsBuilder

func (*OAuthFlowsBuilder)AuthorizationCode¶

func (b *OAuthFlowsBuilder) AuthorizationCode(v *Extendable[OAuthFlow]) *OAuthFlowsBuilder

func (*OAuthFlowsBuilder)Build¶

func (b *OAuthFlowsBuilder) Build() *Extendable[OAuthFlows]

func (*OAuthFlowsBuilder)ClientCredentials¶

func (b *OAuthFlowsBuilder) ClientCredentials(v *Extendable[OAuthFlow]) *OAuthFlowsBuilder

func (*OAuthFlowsBuilder)Extensions¶

func (b *OAuthFlowsBuilder) Extensions(v map[string]any) *OAuthFlowsBuilder

func (*OAuthFlowsBuilder)Implicit¶

func (b *OAuthFlowsBuilder) Implicit(v *Extendable[OAuthFlow]) *OAuthFlowsBuilder

func (*OAuthFlowsBuilder)Password¶

func (b *OAuthFlowsBuilder) Password(v *Extendable[OAuthFlow]) *OAuthFlowsBuilder

type OpenAPI struct {// An element to hold various schemas for the document.Components *Extendable[Components] `json:"components,omitempty" yaml:"components,omitempty"`// REQUIRED// Provides metadata about the API. The metadata MAY be used by tooling as required.Info *Extendable[Info] `json:"info" yaml:"info"`// Additional external documentation.ExternalDocs *Extendable[ExternalDocs] `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`// Holds the relative paths to the individual endpoints and their operations.// The path is appended to the URL from the Server Object in order to construct the full URL.// The Paths MAY be empty, due to Access Control List (ACL) constraints.Paths *Extendable[Paths] `json:"paths,omitempty" yaml:"paths,omitempty"`// The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.// Closely related to the callbacks feature, this section describes requests initiated other than by an API call,// for example by an out of band registration.// The key name is a unique string to refer to each webhook, while the (optionally referenced) PathItem Object describes// a request that may be initiated by the API provider and the expected responses.WebHooksWebhooks `json:"webhooks,omitempty" yaml:"webhooks,omitempty"`// The default value for the $schema keyword within Schema Objects contained within this OAS document.// This MUST be in the form of a URI.JsonSchemaDialectstring `json:"jsonSchemaDialect,omitempty" yaml:"jsonSchemaDialect,omitempty"`// REQUIRED// This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses.// The openapi field SHOULD be used by tooling to interpret the OpenAPI document.// This is not related to the API info.version string.OpenAPIstring `json:"openapi" yaml:"openapi"`// A declaration of which security mechanisms can be used across the API.// The list of values includes alternative security requirement objects that can be used.// Only one of the security requirement objects need to be satisfied to authorize a request.// Individual operations can override this definition.// To make security optional, an empty security requirement ({}) can be included in the array.Security []SecurityRequirement `json:"security,omitempty" yaml:"security,omitempty"`// A list of tags used by the document with additional metadata.// The order of the tags can be used to reflect on their order by the parsing tools.// Not all tags that are used by the Operation Object must be declared.// The tags that are not declared MAY be organized randomly or based on the tools’ logic.// Each tag name in the list MUST be unique.Tags []*Extendable[Tag] `json:"tags,omitempty" yaml:"tags,omitempty"`// An array of Server Objects, which provide connectivity information to a target server.// If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.Servers []*Extendable[Server] `json:"servers,omitempty" yaml:"servers,omitempty"`}

type OpenAPIBuilder struct {// contains filtered or unexported fields}

funcNewOpenAPIBuilder¶

func NewOpenAPIBuilder() *OpenAPIBuilder

func (*OpenAPIBuilder)AddComponent¶

func (b *OpenAPIBuilder) AddComponent(namestring, componentany) *OpenAPIBuilder

func (*OpenAPIBuilder)AddExt¶

func (b *OpenAPIBuilder) AddExt(namestring, valueany) *OpenAPIBuilder

func (*OpenAPIBuilder)AddPath¶

func (b *OpenAPIBuilder) AddPath(pathstring, item *RefOrSpec[Extendable[PathItem]]) *OpenAPIBuilder

func (*OpenAPIBuilder)AddSecurity¶

func (b *OpenAPIBuilder) AddSecurity(v ...SecurityRequirement) *OpenAPIBuilder

func (*OpenAPIBuilder)AddServers¶

func (b *OpenAPIBuilder) AddServers(servers ...*Extendable[Server]) *OpenAPIBuilder

func (*OpenAPIBuilder)AddTags¶

func (b *OpenAPIBuilder) AddTags(tags ...*Extendable[Tag]) *OpenAPIBuilder

func (*OpenAPIBuilder)AddWebHook¶

func (b *OpenAPIBuilder) AddWebHook(namestring, path *RefOrSpec[Extendable[PathItem]]) *OpenAPIBuilder

func (*OpenAPIBuilder)Build¶

func (b *OpenAPIBuilder) Build() *Extendable[OpenAPI]

func (*OpenAPIBuilder)Components¶

func (b *OpenAPIBuilder) Components(components *Extendable[Components]) *OpenAPIBuilder

func (*OpenAPIBuilder)Extensions¶

func (b *OpenAPIBuilder) Extensions(v map[string]any) *OpenAPIBuilder

func (*OpenAPIBuilder)ExternalDocs¶

func (b *OpenAPIBuilder) ExternalDocs(externalDocs *Extendable[ExternalDocs]) *OpenAPIBuilder

func (*OpenAPIBuilder)Info¶

func (b *OpenAPIBuilder) Info(info *Extendable[Info]) *OpenAPIBuilder

func (*OpenAPIBuilder)JsonSchemaDialect¶

func (b *OpenAPIBuilder) JsonSchemaDialect(jsonSchemaDialectstring) *OpenAPIBuilder

func (*OpenAPIBuilder)OpenAPI¶

func (b *OpenAPIBuilder) OpenAPI(openAPIstring) *OpenAPIBuilder

func (*OpenAPIBuilder)Paths¶

func (b *OpenAPIBuilder) Paths(paths *Extendable[Paths]) *OpenAPIBuilder

func (*OpenAPIBuilder)Security¶

func (b *OpenAPIBuilder) Security(security ...SecurityRequirement) *OpenAPIBuilder

func (*OpenAPIBuilder)Servers¶

func (b *OpenAPIBuilder) Servers(servers ...*Extendable[Server]) *OpenAPIBuilder

func (*OpenAPIBuilder)Tags¶

func (b *OpenAPIBuilder) Tags(tags ...*Extendable[Tag]) *OpenAPIBuilder

func (*OpenAPIBuilder)WebHooks¶

func (b *OpenAPIBuilder) WebHooks(webHooksWebhooks) *OpenAPIBuilder

type Operation struct {// The request body applicable for this operation.// The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231] has// explicitly defined semantics for request bodies.// In other cases where the HTTP spec is vague (such as [GET](section-4.3.1), [HEAD](section-4.3.2) and// [DELETE](section-4.3.5)), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible.RequestBody *RefOrSpec[Extendable[RequestBody]] `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`// The list of possible responses as they are returned from executing this operation.Responses *Extendable[Responses] `json:"responses,omitempty" yaml:"responses,omitempty"`// A map of possible out-of band callbacks related to the parent operation.// The key is a unique identifier for the Callback Object.// Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.Callbacks map[string]*RefOrSpec[Extendable[Callback]] `json:"callbacks,omitempty" yaml:"callbacks,omitempty"`// Additional external documentation for this operation.ExternalDocs *Extendable[ExternalDocs] `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`// Unique string used to identify the operation.// The id MUST be unique among all operations described in the API.// The operationId value is case-sensitive.// Tools and libraries MAY use the operationId to uniquely identify an operation, therefore,// it is RECOMMENDED to follow common programming naming conventions.OperationIDstring `json:"operationId,omitempty" yaml:"operationId,omitempty"`// A short summary of what the operation does.Summarystring `json:"summary,omitempty" yaml:"summary,omitempty"`// A verbose explanation of the operation behavior.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// A list of parameters that are applicable for this operation.// If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.// The list MUST NOT include duplicated parameters.// A unique parameter is defined by a combination of a name and location.// The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.Parameters []*RefOrSpec[Extendable[Parameter]] `json:"parameters,omitempty" yaml:"parameters,omitempty"`// A list of tags for API documentation control.// Tags can be used for logical grouping of operations by resources or any other qualifier.Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"`// A declaration of which security mechanisms can be used for this operation.// The list of values includes alternative security requirement objects that can be used.// Only one of the security requirement objects need to be satisfied to authorize a request.// To make security optional, an empty security requirement ({}) can be included in the array.// This definition overrides any declared top-level security.// To remove a top-level security declaration, an empty array can be used.Security []SecurityRequirement `json:"security,omitempty" yaml:"security,omitempty"`// An alternative server array to service this operation.// If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.Servers []*Extendable[Server] `json:"servers,omitempty" yaml:"servers,omitempty"`// Declares this operation to be deprecated.// Consumers SHOULD refrain from usage of the declared operation.// Default value is false.Deprecatedbool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`}

type OperationBuilder struct {// contains filtered or unexported fields}

funcNewOperationBuilder¶

func NewOperationBuilder() *OperationBuilder

func (*OperationBuilder)AddCallback¶

func (b *OperationBuilder) AddCallback(namestring, value *RefOrSpec[Extendable[Callback]]) *OperationBuilder

func (*OperationBuilder)AddExt¶

func (b *OperationBuilder) AddExt(namestring, valueany) *OperationBuilder

func (*OperationBuilder)AddParameters¶

func (b *OperationBuilder) AddParameters(v ...*RefOrSpec[Extendable[Parameter]]) *OperationBuilder

func (*OperationBuilder)AddSecurity¶

func (b *OperationBuilder) AddSecurity(v ...SecurityRequirement) *OperationBuilder

func (*OperationBuilder)AddServers¶

func (b *OperationBuilder) AddServers(v ...*Extendable[Server]) *OperationBuilder

func (*OperationBuilder)AddTags¶

func (b *OperationBuilder) AddTags(v ...string) *OperationBuilder

func (*OperationBuilder)Build¶

func (b *OperationBuilder) Build() *Extendable[Operation]

func (*OperationBuilder)Callbacks¶

func (b *OperationBuilder) Callbacks(v map[string]*RefOrSpec[Extendable[Callback]]) *OperationBuilder

func (*OperationBuilder)Deprecated¶

func (b *OperationBuilder) Deprecated(vbool) *OperationBuilder

func (*OperationBuilder)Description¶

func (b *OperationBuilder) Description(vstring) *OperationBuilder

func (*OperationBuilder)Extensions¶

func (b *OperationBuilder) Extensions(v map[string]any) *OperationBuilder

func (*OperationBuilder)ExternalDocs¶

func (b *OperationBuilder) ExternalDocs(v *Extendable[ExternalDocs]) *OperationBuilder

func (*OperationBuilder)OperationID¶

func (b *OperationBuilder) OperationID(vstring) *OperationBuilder

func (*OperationBuilder)Parameters¶

func (b *OperationBuilder) Parameters(v ...*RefOrSpec[Extendable[Parameter]]) *OperationBuilder

func (*OperationBuilder)RequestBody¶

func (b *OperationBuilder) RequestBody(v *RefOrSpec[Extendable[RequestBody]]) *OperationBuilder

func (*OperationBuilder)Security¶

func (b *OperationBuilder) Security(v ...SecurityRequirement) *OperationBuilder

func (*OperationBuilder)Servers¶

func (b *OperationBuilder) Servers(v ...*Extendable[Server]) *OperationBuilder

func (*OperationBuilder)Summary¶

func (b *OperationBuilder) Summary(vstring) *OperationBuilder

func (*OperationBuilder)Tags¶

func (b *OperationBuilder) Tags(v ...string) *OperationBuilder

type Parameter struct {// Example of the parameter’s potential value.// The example SHOULD match the specified schema and encoding properties if present.// The example field is mutually exclusive of the examples field.// Furthermore, if referencing a schema that contains an example, the example value SHALL override the example provided by the schema.// To represent examples of media types that cannot naturally be represented in JSON or YAML,// a string value can contain the example with escaping where necessary.Exampleany `json:"example,omitempty" yaml:"example,omitempty"`// A map containing the representations for the parameter.// The key is the media type and the value describes it.// The map MUST only contain one entry.Content map[string]*Extendable[MediaType] `json:"content,omitempty" yaml:"content,omitempty"`// Examples of the parameter’s potential value.// Each example SHOULD contain a value in the correct format as specified in the parameter encoding.// The examples field is mutually exclusive of the example field.// Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.Examples map[string]*RefOrSpec[Extendable[Example]] `json:"examples,omitempty" yaml:"examples,omitempty"`// The schema defining the type used for the parameter.Schema *RefOrSpec[Schema] `json:"schema,omitempty" yaml:"schema,omitempty"`// REQUIRED.// The location of the parameter.// Possible values are "query", "header", "path" or "cookie".Instring `json:"in" yaml:"in"`// A brief description of the parameter.// This could contain examples of use.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// Describes how the parameter value will be serialized depending on the type of the parameter value.// Default values (based on value of in)://   for query - form;//   for path - simple;//   for header - simple;//   for cookie - form.Stylestring `json:"style,omitempty" yaml:"style,omitempty"`// REQUIRED.// The name of the parameter.// Parameter names are case sensitive.// If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object.// See Path Templating for further information.// If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.// For all other cases, the name corresponds to the parameter name used by the in property.Namestring `json:"name" yaml:"name"`// When this is true, parameter values of type array or object generate separate parameters// for each value of the array or key-value pair of the map.// For other types of parameters this property has no effect.// When style is form, the default value is true.// For all other styles, the default value is false.Explodebool `json:"explode,omitempty" yaml:"explode,omitempty"`// Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986]//   :/?#[]@!$&'()*+,;=// to be included without percent-encoding.// This property only applies to parameters with an in value of query.// The default value is false.AllowReservedbool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"`// Sets the ability to pass empty-valued parameters.// This is valid only for query parameters and allows sending a parameter with an empty value.// Default value is false.// If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.// Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.AllowEmptyValuebool `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"`// Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.// Default value is false.Deprecatedbool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`// Determines whether this parameter is mandatory.// If the parameter location is "path", this property is REQUIRED and its value MUST be true.// Otherwise, the property MAY be included and its default value is false.Requiredbool `json:"required,omitempty" yaml:"required,omitempty"`}

type ParameterBuilder struct {// contains filtered or unexported fields}

funcNewParameterBuilder¶

func NewParameterBuilder() *ParameterBuilder

func (*ParameterBuilder)AddContent¶

func (b *ParameterBuilder) AddContent(namestring, value *Extendable[MediaType]) *ParameterBuilder

func (*ParameterBuilder)AddExample¶

func (b *ParameterBuilder) AddExample(namestring, value *RefOrSpec[Extendable[Example]]) *ParameterBuilder

func (*ParameterBuilder)AddExt¶

func (b *ParameterBuilder) AddExt(namestring, valueany) *ParameterBuilder

func (*ParameterBuilder)AllowEmptyValue¶

func (b *ParameterBuilder) AllowEmptyValue(vbool) *ParameterBuilder

func (*ParameterBuilder)AllowReserved¶

func (b *ParameterBuilder) AllowReserved(vbool) *ParameterBuilder

func (*ParameterBuilder)Build¶

func (b *ParameterBuilder) Build() *RefOrSpec[Extendable[Parameter]]

func (*ParameterBuilder)Content¶

func (b *ParameterBuilder) Content(v map[string]*Extendable[MediaType]) *ParameterBuilder

func (*ParameterBuilder)Deprecated¶

func (b *ParameterBuilder) Deprecated(vbool) *ParameterBuilder

func (*ParameterBuilder)Description¶

func (b *ParameterBuilder) Description(vstring) *ParameterBuilder

func (*ParameterBuilder)Example¶

func (b *ParameterBuilder) Example(vany) *ParameterBuilder

func (*ParameterBuilder)Examples¶

func (b *ParameterBuilder) Examples(v map[string]*RefOrSpec[Extendable[Example]]) *ParameterBuilder

func (*ParameterBuilder)Explode¶

func (b *ParameterBuilder) Explode(vbool) *ParameterBuilder

func (*ParameterBuilder)Extensions¶

func (b *ParameterBuilder) Extensions(v map[string]any) *ParameterBuilder

func (*ParameterBuilder)In¶

func (b *ParameterBuilder) In(vstring) *ParameterBuilder

func (*ParameterBuilder)Name¶

func (b *ParameterBuilder) Name(vstring) *ParameterBuilder

func (*ParameterBuilder)Required¶

func (b *ParameterBuilder) Required(vbool) *ParameterBuilder

func (*ParameterBuilder)Schema¶

func (b *ParameterBuilder) Schema(v *RefOrSpec[Schema]) *ParameterBuilder

func (*ParameterBuilder)Style¶

func (b *ParameterBuilder) Style(vstring) *ParameterBuilder

type ParseOption func(*parseOptions)

funcWithDefaultEncoding¶added inv1.1.0

func WithDefaultEncoding(vstring)ParseOption

WithDefaultEncoding sets the default encoding for the schema for []byte fields.The default encoding is Base64Encoding.

type PathItem struct {// An optional, string summary, intended to apply to all operations in this path.Summarystring `json:"summary,omitempty" yaml:"summary,omitempty"`// An optional, string description, intended to apply to all operations in this path.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// A definition of a GET operation on this path.Get *Extendable[Operation] `json:"get,omitempty" yaml:"get,omitempty"`// A definition of a PUT operation on this path.Put *Extendable[Operation] `json:"put,omitempty" yaml:"put,omitempty"`// A definition of a POST operation on this path.Post *Extendable[Operation] `json:"post,omitempty" yaml:"post,omitempty"`// A definition of a DELETE operation on this path.Delete *Extendable[Operation] `json:"delete,omitempty" yaml:"delete,omitempty"`// A definition of a OPTIONS operation on this path.Options *Extendable[Operation] `json:"options,omitempty" yaml:"options,omitempty"`// A definition of a HEAD operation on this path.Head *Extendable[Operation] `json:"head,omitempty" yaml:"head,omitempty"`// A definition of a PATCH operation on this path.Patch *Extendable[Operation] `json:"patch,omitempty" yaml:"patch,omitempty"`// A definition of a TRACE operation on this path.Trace *Extendable[Operation] `json:"trace,omitempty" yaml:"trace,omitempty"`// An alternative server array to service all operations in this path.Servers []*Extendable[Server] `json:"servers,omitempty" yaml:"servers,omitempty"`// A list of parameters that are applicable for all the operations described under this path.// These parameters can be overridden at the operation level, but cannot be removed there.// The list MUST NOT include duplicated parameters.// A unique parameter is defined by a combination of a name and location.// The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.Parameters []*RefOrSpec[Extendable[Parameter]] `json:"parameters,omitempty" yaml:"parameters,omitempty"`}

type PathItemBuilder struct {// contains filtered or unexported fields}

funcNewPathItemBuilder¶

func NewPathItemBuilder() *PathItemBuilder

func (*PathItemBuilder)AddExt¶

func (b *PathItemBuilder) AddExt(namestring, valueany) *PathItemBuilder

func (*PathItemBuilder)AddParameters¶

func (b *PathItemBuilder) AddParameters(v ...*RefOrSpec[Extendable[Parameter]]) *PathItemBuilder

func (*PathItemBuilder)AddServers¶

func (b *PathItemBuilder) AddServers(v ...*Extendable[Server]) *PathItemBuilder

func (*PathItemBuilder)Build¶

func (b *PathItemBuilder) Build() *RefOrSpec[Extendable[PathItem]]

func (*PathItemBuilder)Delete¶

func (b *PathItemBuilder) Delete(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Description¶

func (b *PathItemBuilder) Description(vstring) *PathItemBuilder

func (*PathItemBuilder)Extensions¶

func (b *PathItemBuilder) Extensions(v map[string]any) *PathItemBuilder

func (*PathItemBuilder)Get¶

func (b *PathItemBuilder) Get(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Head¶

func (b *PathItemBuilder) Head(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Options¶

func (b *PathItemBuilder) Options(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Parameters¶

func (b *PathItemBuilder) Parameters(v ...*RefOrSpec[Extendable[Parameter]]) *PathItemBuilder

func (*PathItemBuilder)Patch¶

func (b *PathItemBuilder) Patch(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Post¶

func (b *PathItemBuilder) Post(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Put¶

func (b *PathItemBuilder) Put(v *Extendable[Operation]) *PathItemBuilder

func (*PathItemBuilder)Servers¶

func (b *PathItemBuilder) Servers(v ...*Extendable[Server]) *PathItemBuilder

func (*PathItemBuilder)Summary¶

func (b *PathItemBuilder) Summary(vstring) *PathItemBuilder

func (*PathItemBuilder)Trace¶

func (b *PathItemBuilder) Trace(v *Extendable[Operation]) *PathItemBuilder

type Paths struct {// A relative path to an individual endpoint.// The field name MUST begin with a forward slash (/).// The path is appended (no relative URL resolution) to the expanded URL// from the Server Object’s url field in order to construct the full URL.// Path templating is allowed.// When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts.// Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical.// In case of ambiguous matching, it’s up to the tooling to decide which one to use.Paths map[string]*RefOrSpec[Extendable[PathItem]] `json:"-" yaml:"-"`}

func (*Paths)Add¶

func (o *Paths) Add(pathstring, item *RefOrSpec[Extendable[PathItem]]) *Paths

func (*Paths)MarshalJSON¶

func (o *Paths) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*Paths)MarshalYAML¶

func (o *Paths) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*Paths)UnmarshalJSON¶

func (o *Paths) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*Paths)UnmarshalYAML¶

func (o *Paths) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Ref struct {// REQUIRED.// The reference identifier.// This MUST be in the form of a URI.Refstring `json:"$ref" yaml:"$ref"`// A short summary which by default SHOULD override that of the referenced component.// If the referenced object-type does not allow a summary field, then this field has no effect.Summarystring `json:"summary,omitempty" yaml:"summary,omitempty"`// A description which by default SHOULD override that of the referenced component.// CommonMark syntax MAY be used for rich text representation.// If the referenced object-type does not allow a description field, then this field has no effect.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`}

type RefOrSpec[Tany] struct {Ref  *Ref `json:"-" yaml:"-"`Spec *T   `json:"-" yaml:"-"`}

funcNewRefOrExtSpec¶

func NewRefOrExtSpec[Tany](vany) *RefOrSpec[Extendable[T]]

NewRefOrExtSpec creates an object of RefOrSpec[Extendable[any]] type from given Ref or string or any form of Spec.

funcNewRefOrSpec¶

func NewRefOrSpec[Tany](vany) *RefOrSpec[T]

NewRefOrSpec creates an object of RefOrSpec type from given Ref or string or any form of Spec.

func (*RefOrSpec[T])GetSpec¶

func (o *RefOrSpec[T]) GetSpec(c *Extendable[Components]) (*T,error)

GetSpec return a Spec if it is set or loads it from Components in case of Ref or an error

func (*RefOrSpec[T])MarshalJSON¶

func (o *RefOrSpec[T]) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*RefOrSpec[T])MarshalYAML¶

func (o *RefOrSpec[T]) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*RefOrSpec[T])UnmarshalJSON¶

func (o *RefOrSpec[T]) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*RefOrSpec[T])UnmarshalYAML¶

func (o *RefOrSpec[T]) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type RequestBody struct {// REQUIRED.// The content of the request body.// The key is a media type or [media type range](appendix-D) and the value describes it.// For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*Content map[string]*Extendable[MediaType] `json:"content,omitempty" yaml:"content,omitempty"`// A brief description of the request body.// This could contain examples of use.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// Determines if the request body is required in the request.// Defaults to false.Requiredbool `json:"required,omitempty" yaml:"required,omitempty"`}

type RequestBodyBuilder struct {// contains filtered or unexported fields}

funcNewRequestBodyBuilder¶

func NewRequestBodyBuilder() *RequestBodyBuilder

func (*RequestBodyBuilder)AddContent¶

func (b *RequestBodyBuilder) AddContent(keystring, value *Extendable[MediaType]) *RequestBodyBuilder

func (*RequestBodyBuilder)AddExt¶

func (b *RequestBodyBuilder) AddExt(namestring, valueany) *RequestBodyBuilder

func (*RequestBodyBuilder)Build¶

func (b *RequestBodyBuilder) Build() *RefOrSpec[Extendable[RequestBody]]

func (*RequestBodyBuilder)Content¶

func (b *RequestBodyBuilder) Content(v map[string]*Extendable[MediaType]) *RequestBodyBuilder

func (*RequestBodyBuilder)Description¶

func (b *RequestBodyBuilder) Description(vstring) *RequestBodyBuilder

func (*RequestBodyBuilder)Extensions¶

func (b *RequestBodyBuilder) Extensions(v map[string]any) *RequestBodyBuilder

func (*RequestBodyBuilder)Required¶

func (b *RequestBodyBuilder) Required(vbool) *RequestBodyBuilder

type Response struct {// Maps a header name to its definition.// [RFC7230] states header names are case insensitive.// If a response header is defined with the name "Content-Type", it SHALL be ignored.Headers map[string]*RefOrSpec[Extendable[Header]] `json:"headers,omitempty" yaml:"headers,omitempty"`// A map containing descriptions of potential response payloads.// The key is a media type or [media type range](appendix-D) and the value describes it.// For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*Content map[string]*Extendable[MediaType] `json:"content,omitempty" yaml:"content,omitempty"`// A map of operations links that can be followed from the response.// The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.Links map[string]*RefOrSpec[Extendable[Link]] `json:"links,omitempty" yaml:"links,omitempty"`// REQUIRED.// A description of the response.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`}

type ResponseBuilder struct {// contains filtered or unexported fields}

funcNewResponseBuilder¶

func NewResponseBuilder() *ResponseBuilder

func (*ResponseBuilder)AddContent¶

func (b *ResponseBuilder) AddContent(keystring, value *Extendable[MediaType]) *ResponseBuilder

func (*ResponseBuilder)AddExt¶

func (b *ResponseBuilder) AddExt(namestring, valueany) *ResponseBuilder

func (*ResponseBuilder)AddHeader¶

func (b *ResponseBuilder) AddHeader(keystring, value *RefOrSpec[Extendable[Header]]) *ResponseBuilder

func (*ResponseBuilder)AddLink¶

func (b *ResponseBuilder) AddLink(keystring, value *RefOrSpec[Extendable[Link]]) *ResponseBuilder

func (*ResponseBuilder)Build¶

func (b *ResponseBuilder) Build() *RefOrSpec[Extendable[Response]]

func (*ResponseBuilder)Content¶

func (b *ResponseBuilder) Content(v map[string]*Extendable[MediaType]) *ResponseBuilder

func (*ResponseBuilder)Description¶

func (b *ResponseBuilder) Description(vstring) *ResponseBuilder

func (*ResponseBuilder)Extensions¶

func (b *ResponseBuilder) Extensions(v map[string]any) *ResponseBuilder

func (*ResponseBuilder)Headers¶

func (b *ResponseBuilder) Headers(v map[string]*RefOrSpec[Extendable[Header]]) *ResponseBuilder

func (*ResponseBuilder)Links¶

func (b *ResponseBuilder) Links(v map[string]*RefOrSpec[Extendable[Link]]) *ResponseBuilder

type Responses struct {// The documentation of responses other than the ones declared for specific HTTP response codes.// Use this field to cover undeclared responses.Default *RefOrSpec[Extendable[Response]] `json:"default,omitempty" yaml:"default,omitempty"`// Any HTTP status code can be used as the property name, but only one property per code,// to describe the expected response for that HTTP status code.// This field MUST be enclosed in quotation marks (for example, “200”) for compatibility between JSON and YAML.// To define a range of response codes, this field MAY contain the uppercase wildcard character X.// For example, 2XX represents all response codes between [200-299].// Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX.// If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.Response map[string]*RefOrSpec[Extendable[Response]] `json:"-" yaml:"-"`}

func (*Responses)MarshalJSON¶

func (o *Responses) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*Responses)MarshalYAML¶

func (o *Responses) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*Responses)UnmarshalJSON¶

func (o *Responses) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*Responses)UnmarshalYAML¶

func (o *Responses) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type ResponsesBuilder struct {// contains filtered or unexported fields}

funcNewResponsesBuilder¶

func NewResponsesBuilder() *ResponsesBuilder

func (*ResponsesBuilder)AddExt¶

func (b *ResponsesBuilder) AddExt(namestring, valueany) *ResponsesBuilder

func (*ResponsesBuilder)AddResponse¶

func (b *ResponsesBuilder) AddResponse(keystring, value *RefOrSpec[Extendable[Response]]) *ResponsesBuilder

func (*ResponsesBuilder)Build¶

func (b *ResponsesBuilder) Build() *RefOrSpec[Extendable[Responses]]

func (*ResponsesBuilder)Default¶

func (b *ResponsesBuilder) Default(v *RefOrSpec[Extendable[Response]]) *ResponsesBuilder

func (*ResponsesBuilder)Extensions¶

func (b *ResponsesBuilder) Extensions(v map[string]any) *ResponsesBuilder

func (*ResponsesBuilder)Response¶

func (b *ResponsesBuilder) Response(v map[string]*RefOrSpec[Extendable[Response]]) *ResponsesBuilder

type Schema struct {// The $schema keyword is used to declare which dialect of JSON Schema the schema was written for.// The value of the $schema keyword is also the identifier for a schema that can be used to verify// that the schema is valid according to the dialect $schema identifies.// A schema that describes another schema is called a "meta-schema".// $schema applies to the entire document and must be at the root level.// It does not apply to externally referenced ($ref, $dynamicRef) documents.// Those schemas need to declare their own $schema.// If $schema is not used, an implementation might allow you to specify a value externally or// it might make assumptions about which specification version should be used to evaluate the schema.// It's recommended that all JSON Schemas have a $schema keyword to communicate to readers and// tooling which specification version is intended.////https://json-schema.org/understanding-json-schema/reference/schema#schemaSchemastring `json:"$schema,omitempty" yaml:"$schema,omitempty"`// The value of $id is a URI-reference without a fragment that resolves against the retrieval-uri.// The resulting URI is the base URI for the schema.////https://json-schema.org/understanding-json-schema/structuring#idIDstring `json:"$id,omitempty" yaml:"$id,omitempty"`//https://json-schema.org/understanding-json-schema/structuring#dollardefsDefs          map[string]*RefOrSpec[Schema] `json:"$defs,omitempty"          yaml:"$defs,omitempty"`DynamicRefstring                        `json:"$dynamicRef,omitempty"    yaml:"$dynamicRef,omitempty"`Vocabulary    map[string]bool               `json:"$vocabulary,omitempty"    yaml:"$vocabulary,omitempty"`DynamicAnchorstring                        `json:"$dynamicAnchor,omitempty" yaml:"dynamicAnchor,omitempty"`//https://json-schema.org/understanding-json-schema/reference/type#type-specific-keywordsType *SingleOrArray[string] `json:"type,omitempty" yaml:"type,omitempty"`// The default keyword specifies a default value.// This value is not used to fill in missing values during the validation process.// Non-validation tools such as documentation generators or form generators may use this value// to give hints to users about how to use a value.// However, default is typically used to express that if a value is missing,// then the value is semantically the same as if the value was present with the default value.// The value of default should validate against the schema in which it resides, but that isn't required.Defaultany `json:"default,omitempty" yaml:"default,omitempty"`// The title keyword preferably be short.Titlestring `json:"title,omitempty" yaml:"title,omitempty"`// The description keyword provides a more lengthy explanation about the purpose of the data described by the schema.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// The const keyword is used to restrict a value to a single value.////https://json-schema.org/understanding-json-schema/reference/constConststring `json:"const,omitempty" yaml:"const,omitempty"`// The $comment keyword is strictly intended for adding comments to a schema.// Its value must always be a string.// Unlike the annotations title, description, and examples, JSON schema implementations aren’t allowed// to attach any meaning or behavior to it whatsoever, and may even strip them at any time.// Therefore, they are useful for leaving notes to future editors of a JSON schema,// but should not be used to communicate to users of the schema.////https://json-schema.org/understanding-json-schema/reference/generic.html#commentsCommentstring `json:"$comment,omitempty" yaml:"$comment,omitempty"`// The enum keyword is used to restrict a value to a fixed set of values.// It must be an array with at least one element, where each element is unique.////https://json-schema.org/understanding-json-schema/reference/generic.html#enumerated-valuesEnum []any `json:"enum,omitempty" yaml:"enum,omitempty"`// The examples keyword is a place to provide an array of examples that validate against the schema.// This isn't used for validation, but may help with explaining the effect and purpose of the schema to a reader.// Each entry should validate against the schema in which it resides, but that isn't strictly required.// There is no need to duplicate the default value in the examples array,// since default will be treated as another example.Examples []any `json:"examples,omitempty" yaml:"examples,omitempty"`// The readOnly indicates that a value should not be modified.// It could be used to indicate that a PUT request that changes a value would result in a 400 Bad Request response.ReadOnlybool `json:"readOnly,omitempty" yaml:"readOnly,omitempty"`// The writeOnly indicates that a value may be set, but will remain hidden.// In could be used to indicate you can set a value with a PUT request,// but it would not be included when retrieving that record with a GET request.WriteOnlybool `json:"writeOnly,omitempty" yaml:"writeOnly,omitempty"`// The deprecated keyword is a boolean that indicates that the instance value the keyword applies to// should not be used and may be removed in the future.Deprecatedbool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`//https://json-schema.org/understanding-json-schema/reference/non_json_data#contentschemaContentSchema *RefOrSpec[Schema] `json:"contentSchema,omitempty" yaml:"contentSchema,omitempty"`// The contentMediaType keyword specifies the MIME type of the contents of a string, as described inRFC 2046.// There is a list of MIME types officially registered by the IANA, but the set of types supported will be// application and operating system dependent.////https://json-schema.org/understanding-json-schema/reference/non_json_data#contentmediatypeContentMediaTypestring `json:"contentMediaType,omitempty" yaml:"contentMediaType,omitempty"`// The contentEncoding keyword specifies the encoding used to store the contents, as specified inRFC 2054, part 6.1 andRFC 4648.////https://json-schema.org/understanding-json-schema/reference/non_json_data#contentencodingContentEncodingstring `json:"contentEncoding,omitempty" yaml:"contentEncoding,omitempty"`// The not keyword declares that an instance validates if it doesn’t validate against the given subschema.////https://json-schema.org/understanding-json-schema/reference/combining.html#notNot *RefOrSpec[Schema] `json:"not,omitempty" yaml:"not,omitempty"`// To validate against allOf, the given data must be valid against all of the given subschemas.////https://json-schema.org/understanding-json-schema/reference/combining.html#allofAllOf []*RefOrSpec[Schema] `json:"allOf,omitempty" yaml:"allOf,omitempty"`// To validate against anyOf, the given data must be valid against any (one or more) of the given subschemas.////https://json-schema.org/understanding-json-schema/reference/combining.html#anyofAnyOf []*RefOrSpec[Schema] `json:"anyOf,omitempty" yaml:"anyOf,omitempty"`// To validate against oneOf, the given data must be valid against exactly one of the given subschemas.////https://json-schema.org/understanding-json-schema/reference/combining.html#oneofOneOf []*RefOrSpec[Schema] `json:"oneOf,omitempty" yaml:"oneOf,omitempty"`// The dependentRequired keyword conditionally requires that certain properties must be present if// a given property is present in an object.// For example, suppose we have a schema representing a customer.// If you have their credit card number, you also want to ensure you have a billing address.// If you don’t have their credit card number, a billing address would not be required.// We represent this dependency of one property on another using the dependentRequired keyword.// The value of the dependentRequired keyword is an object.// Each entry in the object maps from the name of a property, p, to an array of strings listing properties that// are required if p is present.////https://json-schema.org/understanding-json-schema/reference/conditionals.html#dependentrequiredDependentRequired map[string][]string `json:"dependentRequired,omitempty" yaml:"dependentRequired,omitempty"`// The dependentSchemas keyword conditionally applies a subschema when a given property is present.// This schema is applied in the same way allOf applies schemas.// Nothing is merged or extended.// Both schemas apply independently.////https://json-schema.org/understanding-json-schema/reference/conditionals.html#dependentschemasDependentSchemas map[string]*RefOrSpec[Schema] `json:"dependentSchemas,omitempty" yaml:"dependentSchemas,omitempty"`//https://json-schema.org/understanding-json-schema/reference/conditionals.html#if-then-elseIf   *RefOrSpec[Schema] `json:"if,omitempty"   yaml:"if,omitempty"`Then *RefOrSpec[Schema] `json:"then,omitempty" yaml:"then,omitempty"`Else *RefOrSpec[Schema] `json:"else,omitempty" yaml:"else,omitempty"`// MultipleOf restricts the numbers to a multiple of a given number, using the multipleOf keyword.// It may be set to any positive number.////https://json-schema.org/understanding-json-schema/reference/numeric.html#multiplesMultipleOf *int `json:"multipleOf,omitempty" yaml:"multipleOf,omitempty"`// x ≥ minimumMinimum *int `json:"minimum,omitempty" yaml:"minimum,omitempty"`// x > exclusiveMinimumExclusiveMinimum *int `json:"exclusiveMinimum,omitempty" yaml:"exclusiveMinimum,omitempty"`// x ≤ maximumMaximum *int `json:"maximum,omitempty" yaml:"maximum,omitempty"`// x < exclusiveMaximumExclusiveMaximum *int `json:"exclusiveMaximum,omitempty" yaml:"exclusiveMaximum,omitempty"`MinLength *int   `json:"minLength,omitempty" yaml:"minLength,omitempty"`MaxLength *int   `json:"maxLength,omitempty" yaml:"maxLength,omitempty"`Patternstring `json:"pattern,omitempty"   yaml:"pattern,omitempty"`Formatstring `json:"format,omitempty"    yaml:"format,omitempty"`// List validation is useful for arrays of arbitrary length where each item matches the same schema.// For this kind of array, set the items keyword to a single schema that will be used to validate all of the items in the array.////https://json-schema.org/understanding-json-schema/reference/array#itemsItems *BoolOrSchema `json:"items,omitempty" yaml:"items,omitempty"`//https://json-schema.org/understanding-json-schema/reference/array#lengthMaxItems *int `json:"maxItems,omitempty" yaml:"maxItems,omitempty"`// The unevaluatedItems keyword is similar to unevaluatedProperties, but for items.////https://json-schema.org/understanding-json-schema/reference/array#unevaluateditemsUnevaluatedItems *BoolOrSchema `json:"unevaluatedItems,omitempty" yaml:"unevaluatedItems,omitempty"`// While the items schema must be valid for every item in the array, the contains schema only needs// to validate against one or more items in the array.////https://json-schema.org/understanding-json-schema/reference/array.html#containsContains    *RefOrSpec[Schema] `json:"contains,omitempty"    yaml:"contains,omitempty"`MinContains *int               `json:"minContains,omitempty" yaml:"minContains,omitempty"`MaxContains *int               `json:"maxContains,omitempty" yaml:"maxContains,omitempty"`//https://json-schema.org/understanding-json-schema/reference/array.html#lengthMinItems *int `json:"minItems,omitempty" yaml:"minItems,omitempty"`// A schema can ensure that each of the items in an array is unique.// Simply set the uniqueItems keyword to true.////https://json-schema.org/understanding-json-schema/reference/array.html#uniquenessUniqueItems *bool `json:"uniqueItems,omitempty" yaml:"uniqueItems,omitempty"`// The prefixItems is an array, where each item is a schema that corresponds to each index of the document’s array.// That is, an array where the first element validates the first element of the input array,// the second element validates the second element of the input array, etc.////https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validationPrefixItems []*RefOrSpec[Schema] `json:"prefixItems,omitempty" yaml:"prefixItems,omitempty"`// The properties (key-value pairs) on an object are defined using the properties keyword.// The value of properties is an object, where each key is the name of a property and each value is// a schema used to validate that property.// Any property that doesn't match any of the property names in the properties keyword is ignored by this keyword.////https://json-schema.org/understanding-json-schema/reference/object.html#propertiesProperties map[string]*RefOrSpec[Schema] `json:"properties,omitempty" yaml:"properties,omitempty"`// Sometimes you want to say that, given a particular kind of property name, the value should match a particular schema.// That’s where patternProperties comes in: it maps regular expressions to schemas.// If a property name matches the given regular expression, the property value must validate against the corresponding schema.////https://json-schema.org/understanding-json-schema/reference/object.html#pattern-propertiesPatternProperties map[string]*RefOrSpec[Schema] `json:"patternProperties,omitempty" yaml:"patternProperties,omitempty"`// The additionalProperties keyword is used to control the handling of extra stuff, that is,// properties whose names are not listed in the properties keyword or match any of the regular expressions// in the patternProperties keyword.// By default any additional properties are allowed.//// The value of the additionalProperties keyword is a schema that will be used to validate any properties in the instance// that are not matched by properties or patternProperties.// Setting the additionalProperties schema to false means no additional properties will be allowed.////https://json-schema.org/understanding-json-schema/reference/object.html#additional-propertiesAdditionalProperties *BoolOrSchema `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"`// The unevaluatedProperties keyword is similar to additionalProperties except that it can recognize properties declared in subschemas.// So, the example from the previous section can be rewritten without the need to redeclare properties.////https://json-schema.org/understanding-json-schema/reference/object.html#unevaluated-propertiesUnevaluatedProperties *BoolOrSchema `json:"unevaluatedProperties,omitempty" yaml:"unevaluatedProperties,omitempty"`// The names of properties can be validated against a schema, irrespective of their values.// This can be useful if you don’t want to enforce specific properties, but you want to make sure that// the names of those properties follow a specific convention.// You might, for example, want to enforce that all names are valid ASCII tokens so they can be used// as attributes in a particular programming language.////https://json-schema.org/understanding-json-schema/reference/object.html#property-namesPropertyNames *RefOrSpec[Schema] `json:"propertyNames,omitempty" yaml:"propertyNames,omitempty"`// The min number of properties on an object.////https://json-schema.org/understanding-json-schema/reference/object.html#sizeMinProperties *int `json:"minProperties,omitempty" yaml:"minProperties,omitempty"`// The max number of properties on an object.////https://json-schema.org/understanding-json-schema/reference/object.html#sizeMaxProperties *int `json:"maxProperties,omitempty" yaml:"maxProperties,omitempty"`// The required keyword takes an array of zero or more strings.// Each of these strings must be unique.////https://json-schema.org/understanding-json-schema/reference/object.html#required-propertiesRequired []string `json:"required,omitempty" yaml:"required,omitempty"`// Adds support for polymorphism.// The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.// See Composition and Inheritance for more details.Discriminator *Discriminator `json:"discriminator,omitempty" yaml:"discriminator,omitempty"`// Additional external documentation for this tag.// xmlXML *Extendable[XML] `json:"xml,omitempty" yaml:"xml,omitempty"`// Additional external documentation for this schema.ExternalDocs *Extendable[ExternalDocs] `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`// A free-form property to include an example of an instance for this schema.// To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to// contain the example with escaping where necessary.//// Deprecated: The example property has been deprecated in favor of the JSON Schema examples keyword.// Use of example is discouraged, and later versions of this specification may remove it.Exampleany `json:"example,omitempty" yaml:"example,omitempty"`Extensions map[string]any `json:"-" yaml:"-"`// GoPackage is a custom field to store the Go package of the schema.GoPackagestring `json:"x-go-package,omitempty" yaml:"x-go-package,omitempty"`// GoType is a custom field to store the Go type of the schema.GoTypestring `json:"x-go-type,omitempty" yaml:"x-go-type,omitempty"`}

func (*Schema)AddExt¶

func (o *Schema) AddExt(namestring, valueany) *Schema

AddExt sets the extension and returns the current object (self|this).Schema does not require special `x-` prefix.The extension will be ignored if the name overlaps with a struct field during marshaling to JSON or YAML.

func (*Schema)GetExt¶

func (o *Schema) GetExt(namestring)any

func (*Schema)MarshalJSON¶

func (o *Schema) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler interface.

func (*Schema)MarshalYAML¶

func (o *Schema) MarshalYAML() (any,error)

MarshalYAML implements yaml.Marshaler interface.

func (*Schema)UnmarshalJSON¶

func (o *Schema) UnmarshalJSON(data []byte)error

UnmarshalJSON implements json.Unmarshaler interface.

func (*Schema)UnmarshalYAML¶

func (o *Schema) UnmarshalYAML(node *yaml.Node)error

UnmarshalYAML implements yaml.Unmarshaler interface.

type SchemaBuilder struct {// contains filtered or unexported fields}

funcNewSchemaBuilder¶

func NewSchemaBuilder() *SchemaBuilder

funcParseObject¶added inv1.1.0

func ParseObject(objany, components *Extendable[Components], opts ...ParseOption) (*SchemaBuilder,error)

ParseObject parses the object and returns the schema or the reference to the schema.

The object can be a struct, pointer to struct, map, slice, pointer to map or slice, or any other type.The object can contain fields with `json`, `yaml` or `openapi` tags.

`openapi:"<name>[,ref:<ref> || any other tags]"` tag:  - <name> is the name of the field in the schema, can be "-" to skip the field or empty to use the name from json, yaml tags or original field name.json schema fields:  - ref:<ref> is a reference to the schema, can not be used with jsonschema fields.  - required, marks the field as required by adding it to the required list of the parent schema.  - deprecated, marks the field as deprecated.  - title:<title>, sets the title of the field or summary for the fereference.  - summary:<summary>, sets the summary of the reference.  - description:<description>, sets the description of the field.  - type:<type> (boolean, integer, number, string, array, object), may be used multiple times.    The first usage overrides the default type, all other types are added.  - addtype:<type>, adds additional type, may be used multiple times.  - format:<format>, sets the format of the type.

The `components` parameter is needed to store the schemas of the structs, and to avoid the circular references.In case of the given object is struct, the function will return a reference to the schema stored in the componentsOtherwise, the function will return the schema itself.

func (*SchemaBuilder)AddAllOf¶added inv1.1.0

func (b *SchemaBuilder) AddAllOf(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddAnyOf¶added inv1.1.0

func (b *SchemaBuilder) AddAnyOf(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddDef¶added inv1.1.0

func (b *SchemaBuilder) AddDef(namestring, value *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddDependentRequired¶added inv1.1.0

func (b *SchemaBuilder) AddDependentRequired(namestring, value ...string) *SchemaBuilder

func (*SchemaBuilder)AddDependentSchema¶added inv1.1.0

func (b *SchemaBuilder) AddDependentSchema(namestring, value *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddEnum¶added inv1.1.0

func (b *SchemaBuilder) AddEnum(v ...any) *SchemaBuilder

func (*SchemaBuilder)AddExamples¶added inv1.1.0

func (b *SchemaBuilder) AddExamples(v ...any) *SchemaBuilder

func (*SchemaBuilder)AddExt¶added inv1.1.0

func (b *SchemaBuilder) AddExt(namestring, valueany) *SchemaBuilder

func (*SchemaBuilder)AddOneOf¶added inv1.1.0

func (b *SchemaBuilder) AddOneOf(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddPatternProperty¶added inv1.1.0

func (b *SchemaBuilder) AddPatternProperty(namestring, value *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddPrefixItems¶added inv1.1.0

func (b *SchemaBuilder) AddPrefixItems(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddProperty¶added inv1.1.0

func (b *SchemaBuilder) AddProperty(namestring, value *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AddRequired¶added inv1.1.0

func (b *SchemaBuilder) AddRequired(v ...string) *SchemaBuilder

func (*SchemaBuilder)AddType¶added inv1.1.0

func (b *SchemaBuilder) AddType(v ...string) *SchemaBuilder

func (*SchemaBuilder)AddVocabulary¶added inv1.1.0

func (b *SchemaBuilder) AddVocabulary(namestring, valuebool) *SchemaBuilder

func (*SchemaBuilder)AdditionalProperties¶added inv1.1.0

func (b *SchemaBuilder) AdditionalProperties(v *BoolOrSchema) *SchemaBuilder

func (*SchemaBuilder)AllOf¶added inv1.1.0

func (b *SchemaBuilder) AllOf(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)AnyOf¶added inv1.1.0

func (b *SchemaBuilder) AnyOf(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Build¶added inv1.1.0

func (b *SchemaBuilder) Build() *RefOrSpec[Schema]

func (*SchemaBuilder)Comment¶added inv1.1.0

func (b *SchemaBuilder) Comment(vstring) *SchemaBuilder

func (*SchemaBuilder)Const¶added inv1.1.0

func (b *SchemaBuilder) Const(vstring) *SchemaBuilder

func (*SchemaBuilder)Contains¶added inv1.1.0

func (b *SchemaBuilder) Contains(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)ContentEncoding¶added inv1.1.0

func (b *SchemaBuilder) ContentEncoding(vstring) *SchemaBuilder

func (*SchemaBuilder)ContentMediaType¶added inv1.1.0

func (b *SchemaBuilder) ContentMediaType(vstring) *SchemaBuilder

func (*SchemaBuilder)ContentSchema¶added inv1.1.0

func (b *SchemaBuilder) ContentSchema(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Default¶added inv1.1.0

func (b *SchemaBuilder) Default(vany) *SchemaBuilder

func (*SchemaBuilder)Defs¶added inv1.1.0

func (b *SchemaBuilder) Defs(v map[string]*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)DependentRequired¶added inv1.1.0

func (b *SchemaBuilder) DependentRequired(v map[string][]string) *SchemaBuilder

func (*SchemaBuilder)DependentSchemas¶added inv1.1.0

func (b *SchemaBuilder) DependentSchemas(v map[string]*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Deprecated¶added inv1.1.0

func (b *SchemaBuilder) Deprecated(vbool) *SchemaBuilder

func (*SchemaBuilder)Description¶added inv1.1.0

func (b *SchemaBuilder) Description(vstring) *SchemaBuilder

func (*SchemaBuilder)Discriminator¶added inv1.1.0

func (b *SchemaBuilder) Discriminator(v *Discriminator) *SchemaBuilder

func (*SchemaBuilder)DynamicAnchor¶added inv1.1.0

func (b *SchemaBuilder) DynamicAnchor(vstring) *SchemaBuilder

func (*SchemaBuilder)DynamicRef¶added inv1.1.0

func (b *SchemaBuilder) DynamicRef(vstring) *SchemaBuilder

func (*SchemaBuilder)Else¶added inv1.1.0

func (b *SchemaBuilder) Else(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Enum¶added inv1.1.0

func (b *SchemaBuilder) Enum(v ...any) *SchemaBuilder

func (*SchemaBuilder)Example¶added inv1.1.0

func (b *SchemaBuilder) Example(vany) *SchemaBuilder

func (*SchemaBuilder)Examples¶added inv1.1.0

func (b *SchemaBuilder) Examples(v ...any) *SchemaBuilder

func (*SchemaBuilder)ExclusiveMaximum¶added inv1.1.0

func (b *SchemaBuilder) ExclusiveMaximum(vint) *SchemaBuilder

func (*SchemaBuilder)ExclusiveMinimum¶added inv1.1.0

func (b *SchemaBuilder) ExclusiveMinimum(vint) *SchemaBuilder

func (*SchemaBuilder)Extensions¶added inv1.1.0

func (b *SchemaBuilder) Extensions(v map[string]any) *SchemaBuilder

func (*SchemaBuilder)ExternalDocs¶added inv1.1.0

func (b *SchemaBuilder) ExternalDocs(v *Extendable[ExternalDocs]) *SchemaBuilder

func (*SchemaBuilder)Format¶added inv1.1.0

func (b *SchemaBuilder) Format(vstring) *SchemaBuilder

func (*SchemaBuilder)GoPackage¶added inv1.1.0

func (b *SchemaBuilder) GoPackage(vstring) *SchemaBuilder

func (*SchemaBuilder)GoType¶added inv1.1.0

func (b *SchemaBuilder) GoType(vstring) *SchemaBuilder

func (*SchemaBuilder)ID¶added inv1.1.0

func (b *SchemaBuilder) ID(vstring) *SchemaBuilder

func (*SchemaBuilder)If¶added inv1.1.0

func (b *SchemaBuilder) If(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)IsRef¶added inv1.1.0

func (b *SchemaBuilder) IsRef()bool

func (*SchemaBuilder)Items¶added inv1.1.0

func (b *SchemaBuilder) Items(v *BoolOrSchema) *SchemaBuilder

func (*SchemaBuilder)MaxContains¶added inv1.1.0

func (b *SchemaBuilder) MaxContains(vint) *SchemaBuilder

func (*SchemaBuilder)MaxItems¶added inv1.1.0

func (b *SchemaBuilder) MaxItems(vint) *SchemaBuilder

func (*SchemaBuilder)MaxLength¶added inv1.1.0

func (b *SchemaBuilder) MaxLength(vint) *SchemaBuilder

func (*SchemaBuilder)MaxProperties¶added inv1.1.0

func (b *SchemaBuilder) MaxProperties(vint) *SchemaBuilder

func (*SchemaBuilder)Maximum¶added inv1.1.0

func (b *SchemaBuilder) Maximum(vint) *SchemaBuilder

func (*SchemaBuilder)MinContains¶added inv1.1.0

func (b *SchemaBuilder) MinContains(vint) *SchemaBuilder

func (*SchemaBuilder)MinItems¶added inv1.1.0

func (b *SchemaBuilder) MinItems(vint) *SchemaBuilder

func (*SchemaBuilder)MinLength¶added inv1.1.0

func (b *SchemaBuilder) MinLength(vint) *SchemaBuilder

func (*SchemaBuilder)MinProperties¶added inv1.1.0

func (b *SchemaBuilder) MinProperties(vint) *SchemaBuilder

func (*SchemaBuilder)Minimum¶added inv1.1.0

func (b *SchemaBuilder) Minimum(vint) *SchemaBuilder

func (*SchemaBuilder)MultipleOf¶added inv1.1.0

func (b *SchemaBuilder) MultipleOf(vint) *SchemaBuilder

func (*SchemaBuilder)Not¶added inv1.1.0

func (b *SchemaBuilder) Not(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)OneOf¶added inv1.1.0

func (b *SchemaBuilder) OneOf(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Pattern¶added inv1.1.0

func (b *SchemaBuilder) Pattern(vstring) *SchemaBuilder

func (*SchemaBuilder)PatternProperties¶added inv1.1.0

func (b *SchemaBuilder) PatternProperties(v map[string]*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)PrefixItems¶added inv1.1.0

func (b *SchemaBuilder) PrefixItems(v ...*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Properties¶added inv1.1.0

func (b *SchemaBuilder) Properties(v map[string]*RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)PropertyNames¶added inv1.1.0

func (b *SchemaBuilder) PropertyNames(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)ReadOnly¶added inv1.1.0

func (b *SchemaBuilder) ReadOnly(vbool) *SchemaBuilder

func (*SchemaBuilder)Ref¶added inv1.1.0

func (b *SchemaBuilder) Ref(vstring) *SchemaBuilder

func (*SchemaBuilder)Required¶added inv1.1.0

func (b *SchemaBuilder) Required(v ...string) *SchemaBuilder

func (*SchemaBuilder)Schema¶added inv1.1.0

func (b *SchemaBuilder) Schema(vstring) *SchemaBuilder

func (*SchemaBuilder)Then¶added inv1.1.0

func (b *SchemaBuilder) Then(v *RefOrSpec[Schema]) *SchemaBuilder

func (*SchemaBuilder)Title¶added inv1.1.0

func (b *SchemaBuilder) Title(vstring) *SchemaBuilder

func (*SchemaBuilder)Type¶added inv1.1.0

func (b *SchemaBuilder) Type(v ...string) *SchemaBuilder

func (*SchemaBuilder)UnevaluatedItems¶added inv1.1.0

func (b *SchemaBuilder) UnevaluatedItems(v *BoolOrSchema) *SchemaBuilder

func (*SchemaBuilder)UnevaluatedProperties¶added inv1.1.0

func (b *SchemaBuilder) UnevaluatedProperties(v *BoolOrSchema) *SchemaBuilder

func (*SchemaBuilder)UniqueItems¶added inv1.1.0

func (b *SchemaBuilder) UniqueItems(vbool) *SchemaBuilder

func (*SchemaBuilder)Vocabulary¶added inv1.1.0

func (b *SchemaBuilder) Vocabulary(v map[string]bool) *SchemaBuilder

func (*SchemaBuilder)WriteOnly¶added inv1.1.0

func (b *SchemaBuilder) WriteOnly(vbool) *SchemaBuilder

func (*SchemaBuilder)XML¶added inv1.1.0

func (b *SchemaBuilder) XML(v *Extendable[XML]) *SchemaBuilder

type SecurityRequirement map[string][]string

type SecurityRequirementBuilder struct {// contains filtered or unexported fields}

funcNewSecurityRequirementBuilder¶

func NewSecurityRequirementBuilder() *SecurityRequirementBuilder

func (*SecurityRequirementBuilder)Add¶

func (b *SecurityRequirementBuilder) Add(namestring, scopes ...string) *SecurityRequirementBuilder

func (*SecurityRequirementBuilder)Build¶

func (b *SecurityRequirementBuilder) Build() *SecurityRequirement

type SecurityScheme struct {// REQUIRED.// The type of the security scheme.// Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect".//// Applies To: anyTypestring `json:"type" yaml:"type"`// A description for security scheme.// CommonMark syntax MAY be used for rich text representation.//// Applies To: anyDescriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// REQUIRED.// The name of the header, query or cookie parameter to be used.//// Applies To: apiKeyNamestring `json:"name,omitempty" yaml:"name,omitempty"`// REQUIRED.// The location of the API key.// Valid values are "query", "header" or "cookie".//// Applies To: apiKeyInstring `json:"in,omitempty" yaml:"in,omitempty"`// REQUIRED.// The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235].// The values used SHOULD be registered in the IANA Authentication Scheme registry.//// Applies To: httpSchemestring `json:"scheme,omitempty" yaml:"scheme,omitempty"`// A hint to the client to identify how the bearer token is formatted.// Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.//// Applies To: http ("bearer")BearerFormatstring `json:"bearerFormat,omitempty" yaml:"bearerFormat,omitempty"`// REQUIRED.// An object containing configuration information for the flow types supported.//// Applies To: oauth2Flows *Extendable[OAuthFlows] `json:"flows,omitempty" yaml:"flows,omitempty"`// REQUIRED.// OpenId Connect URL to discover OAuth2 configuration values.// This MUST be in the form of a URL.// The OpenID Connect standard requires the use of TLS.//// Applies To: openIdConnectOpenIDConnectURLstring `json:"openIdConnectUrl,omitempty" yaml:"openIdConnectUrl,omitempty"`}

type SecuritySchemeBuilder struct {// contains filtered or unexported fields}

funcNewSecuritySchemeBuilder¶

func NewSecuritySchemeBuilder() *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)AddExt¶

func (b *SecuritySchemeBuilder) AddExt(namestring, valueany) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)BearerFormat¶

func (b *SecuritySchemeBuilder) BearerFormat(vstring) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)Build¶

func (b *SecuritySchemeBuilder) Build() *RefOrSpec[Extendable[SecurityScheme]]

func (*SecuritySchemeBuilder)Description¶

func (b *SecuritySchemeBuilder) Description(vstring) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)Extensions¶

func (b *SecuritySchemeBuilder) Extensions(v map[string]any) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)Flows¶

func (b *SecuritySchemeBuilder) Flows(v *Extendable[OAuthFlows]) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)In¶

func (b *SecuritySchemeBuilder) In(vstring) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)Name¶

func (b *SecuritySchemeBuilder) Name(vstring) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)OpenIDConnectURL¶

func (b *SecuritySchemeBuilder) OpenIDConnectURL(vstring) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)Scheme¶

func (b *SecuritySchemeBuilder) Scheme(vstring) *SecuritySchemeBuilder

func (*SecuritySchemeBuilder)Type¶

func (b *SecuritySchemeBuilder) Type(vstring) *SecuritySchemeBuilder

type Server struct {// A map between a variable name and its value.// The value is used for substitution in the server’s URL template.Variables map[string]*Extendable[ServerVariable] `json:"variables,omitempty" yaml:"variables,omitempty"`// REQUIRED.// A URL to the target host.// This URL supports Server Variables and MAY be relative, to indicate that the host location is relative// to the location where the OpenAPI document is being served.// Variable substitutions will be made when a variable is named in {brackets}.URLstring `json:"url" yaml:"url"`// An optional string describing the host designated by the URL.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`}

type ServerBuilder struct {// contains filtered or unexported fields}

funcNewServerBuilder¶

func NewServerBuilder() *ServerBuilder

func (*ServerBuilder)AddExt¶

func (b *ServerBuilder) AddExt(namestring, valueany) *ServerBuilder

func (*ServerBuilder)AddVariable¶

func (b *ServerBuilder) AddVariable(namestring, value *Extendable[ServerVariable]) *ServerBuilder

func (*ServerBuilder)Build¶

func (b *ServerBuilder) Build() *Extendable[Server]

func (*ServerBuilder)Description¶

func (b *ServerBuilder) Description(vstring) *ServerBuilder

func (*ServerBuilder)Extensions¶

func (b *ServerBuilder) Extensions(v map[string]any) *ServerBuilder

func (*ServerBuilder)URL¶

func (b *ServerBuilder) URL(vstring) *ServerBuilder

func (*ServerBuilder)Variables¶

func (b *ServerBuilder) Variables(v map[string]*Extendable[ServerVariable]) *ServerBuilder

type ServerVariable struct {// REQUIRED.// The default value to use for substitution, which SHALL be sent if an alternate value is not supplied.// Note this behavior is different than the Schema Object’s treatment of default values,// because in those cases parameter values are optional.// If the enum is defined, the value MUST exist in the enum’s values.Defaultstring `json:"default" yaml:"default"`// An optional description for the server variable.// CommonMark syntax MAY be used for rich text representation.Descriptionstring `json:"description,omitempty" yaml:"description,omitempty"`// An enumeration of string values to be used if the substitution options are from a limited set.// The array MUST NOT be empty.Enum []string `json:"enum,omitempty" yaml:"enum,omitempty"`}

type ServerVariableBuilder struct {// contains filtered or unexported fields}

funcNewServerVariableBuilder¶

func NewServerVariableBuilder() *ServerVariableBuilder

func (*ServerVariableBuilder)AddEnum¶

func (b *ServerVariableBuilder) AddEnum(v ...string) *ServerVariableBuilder

func (*ServerVariableBuilder)AddExt¶

func (b *ServerVariableBuilder) AddExt(namestring, valueany) *ServerVariableBuilder

func (*ServerVariableBuilder)Build¶

func (b *ServerVariableBuilder) Build() *Extendable[ServerVariable]

func (*ServerVariableBuilder)Default¶

func (b *ServerVariableBuilder) Default(vstring) *ServerVariableBuilder

func (*ServerVariableBuilder)Description¶

func (b *ServerVariableBuilder) Description(vstring) *ServerVariableBuilder

func (*ServerVariableBuilder)Enum¶

func (b *ServerVariableBuilder) Enum(v ...string) *ServerVariableBuilder

func (*ServerVariableBuilder)Extensions¶

func (b *ServerVariableBuilder) Extensions(v map[string]any) *ServerVariableBuilder