Versions in this module Expand all Collapse all v0 v0.0.11 Jul 31, 2024 Changes in this version + const ParameterInPath + const ParameterInQuery + const ParameterStylePipeDelimited + const ParameterStyleSimple + const ParameterStyleSpaceDelimited + const ParameterStyleTabDelimited + const TypeArray + const TypeBoolean + const TypeInteger + const TypeNull + const TypeNumber + const TypeObject + const TypeString + const Version + func Validate(obj any, doc *DocumentCore) error + type Components = Extensible[ComponentsCore] + type ComponentsCore struct + Examples map[string]*Ref[Example] + Headers map[string]*Ref[Header] + Links map[string]*Ref[Link] + Parameters map[string]*Ref[Parameter] + RequestBodies map[string]*Ref[RequestBody] + Responses map[string]*Ref[Response] + Schemas map[string]*Extensible[SchemaCore] + SecuritySchemes map[string]*Ref[SecurityScheme] + type Contact = Extensible[ContactCore] + type ContactCore struct + Email string + Name string + URL string + type Discriminator = Extensible[DiscriminatorCore] + type DiscriminatorCore struct + Mapping map[string]string + PropertyName string + type Document = Extensible[DocumentCore] + type DocumentCore struct + Components *Components + ExternalDocumentation *ExternalDocumentation + Info *Info + OpenAPI string + Paths map[string]*Path + SchemaDialect string + Security []map[string][]string + Servers []*Server + Tags []*Tag + func (d *DocumentCore) Validate() error + type Encoding = Extensible[EncodingCore] + type EncodingCore struct + AllowReserved bool + ContentType string + Explode bool + Headers map[string]*Ref[Header] + Style string + type Example = Extensible[ExampleCore] + type ExampleCore struct + Description string + ExternalValue string + Summary string + Value any + type Extensible struct + Extensions Extensions + Object T + func (e Extensible[T]) MarshalJSON() ([]byte, error) + type Extensions map[string]any + type ExternalDocumentation = Extensible[ExternalDocumentationCore] + type ExternalDocumentationCore struct + Description string + URL string + type Header = Extensible[HeaderCore] + type HeaderCore struct + AllowEmptyValue bool + Content map[string]*Extensible[MediaTypeCore] + Deprecated bool + Description string + Example any + Examples map[string]*Ref[Extensible[ExampleCore]] + Explode bool + Required bool + Schema *Extensible[SchemaCore] + Style string + type Info = Extensible[InfoCore] + type InfoCore struct + Contact *Contact + Description string + License *License + Summary string + TermsOfService string + Title string + Version string + type ItemSpec struct + Items []*Schema + Schema *Schema + func (i *ItemSpec) MarshalJSON() ([]byte, error) + func (i *ItemSpec) MarshalYAML() (any, error) + type License = Extensible[LicenseCore] + type LicenseCore struct + Identifier string + Name string + URL string + type Link = Extensible[LinkCore] + type LinkCore struct + Description string + OperationID string + OperationRef string + Parameters map[string]any + RequestBody any + Server *Server + type MediaType = Extensible[MediaTypeCore] + type MediaTypeCore struct + Encoding map[string]*Extensible[EncodingCore] + Example any + Examples map[string]*Ref[Extensible[ExampleCore]] + Schema *Extensible[SchemaCore] + type OAuthFlow = Extensible[OAuthFlowCore] + type OAuthFlowCore struct + AuthorizationURL string + RefreshURL string + Scopes map[string]string + TokenURL string + type OAuthFlows = Extensible[OAuthFlowsCore] + type OAuthFlowsCore struct + AuthorizationCode *OAuthFlow + ClientCredentials *OAuthFlow + Implicit *OAuthFlow + Password *OAuthFlow + type Operation = Extensible[OperationCore] + type OperationCore struct + Deprecated bool + Description string + ExternalDocs *ExternalDocumentation + OperationID string + Parameters []*Ref[Parameter] + RequestBody *Ref[RequestBody] + Responses map[string]*Ref[Response] + Security []map[string][]string + Servers []*Server + Summary string + Tags []string + type Parameter = Extensible[ParameterCore] + type ParameterCore struct + AllowEmptyValue bool + AllowReserved bool + Content map[string]*Extensible[MediaTypeCore] + Deprecated bool + Description string + Example any + Examples map[string]*Ref[Extensible[ExampleCore]] + Explode bool + In string + Name string + Required bool + Schema *Extensible[SchemaCore] + Style string + type Path = Extensible[PathCore] + type PathCore struct + Delete *Operation + Description string + Get *Operation + Head *Operation + Options *Operation + Parameters []*Ref[Server] + Patch *Operation + Post *Operation + Put *Operation + Servers []*Server + Summary string + Trace *Operation + type Ref struct + Data T + Reference *Reference + func (r Ref[T]) MarshalJSON() ([]byte, error) + func (r Ref[T]) MarshalYAML() (any, error) + type Reference struct + Description string + Ref string + Summary string + type RequestBody = Extensible[RequestBodyCore] + type RequestBodyCore struct + Content map[string]*Extensible[MediaTypeCore] + Description string + Required bool + type Response = Extensible[ResponseCore] + type ResponseCore struct + Content map[string]*Extensible[MediaTypeCore] + Description string + Headers map[string]*Ref[Extensible[HeaderCore]] + Links map[string]*Ref[Extensible[LinkCore]] + type Schema = Extensible[SchemaCore] + type SchemaCore struct + AdditionalProperties *Schema + AllOf []*Schema + AnyOf []*Schema + Default any + Deprecated bool + Description string + Discriminator *Discriminator + Enum []string + Examples []any + ExclusiveMaximum float64 + ExclusiveMinimum float64 + ExternalDocumentation *ExternalDocumentation + Format string + Items *ItemSpec + MaxItems uint64 + MaxLength uint64 + MaxProperties uint64 + Maximum float64 + MinItems uint64 + MinLength uint64 + MinProperties uint64 + Minimum float64 + MultipleOf float64 + Not *Schema + OneOf []*Schema + Pattern string + Properties map[string]*Schema + ReadOnly bool + Ref string + Required []string + Schema string + Title string + Type TypeSet + UniqueItems bool + WriteOnly bool + type SecurityScheme = Extensible[SecuritySchemeCore] + type SecuritySchemeCore struct + BearerFormat string + Description string + Flows *OAuthFlows + In string + Name string + OpenIDConnectURL string + Scheme string + Type string + type Server = Extensible[ServerCore] + type ServerCore struct + Description string + URL string + Variables map[string]ServerVariable + type ServerVariable = Extensible[ServerVariableCore] + type ServerVariableCore struct + Default string + Description string + Enum []string + type Tag = Extensible[TagCore] + type TagCore struct + Description string + ExternalDocs *ExternalDocumentation + Name string + type TypeSet []string + func (t TypeSet) MarshalJSON() ([]byte, error) + func (t TypeSet) MarshalYAML() (any, error) + type Validator interface + Validate func(*DocumentCore) error v0.0.1-alpha May 18, 2024
Go to main page