Versions in this module Expand all Collapse all v0 v0.0.3 Feb 1, 2021 v0.0.2 Feb 1, 2021 Changes in this version + const InCookie + const InHeader + const InPath + const InQuery + const MimeFormData + const MimeJSON + const MimeOctetStream + const MimeTextPlain + const MimeURLEncoded + const MimeXML + const SecurityAPIKey + const SecurityHTTP + const SecurityOAuth2 + const SecurityOpenIDConnect + type Any []byte + func NewAny(v interface{}) Any + func (m *Any) UnmarshalJSON(data []byte) error + func (m Any) MarshalJSON() ([]byte, error) + type AnyOrExpressions struct + Any Any + Expressions Expressions + func (m *AnyOrExpressions) UnmarshalJSON(data []byte) error + func (m AnyOrExpressions) MarshalJSON() ([]byte, error) + type Callback struct + Callback map[Expressions]*PathItem + func (s *Callback) UnmarshalJSON(data []byte) error + func (s Callback) Entity() Entity + func (s Callback) MarshalJSON() ([]byte, error) + type Components struct + Callbacks map[string]*Callback + Examples map[string]*Example + Headers map[string]*Header + Links map[string]*Link + Parameters map[string]*Parameter + RequestBodies map[string]*RequestBody + Responses map[string]*Response + Schemas map[string]*Schema + SecuritySchemes map[string]*SecurityScheme + func NewComponents() *Components + type Contact struct + Email string + Name string + URL string + type Discriminator struct + Mapping map[string]string + PropertyName string + type Encoding struct + AllowReserved bool + ContentType string + Explode bool + Headers map[string]*Header + Style string + type Entiter interface + Entity func() Entity + type Entity uint + const CallbackKind + const ExampleKind + const HeaderKind + const InvalidKind + const LinkKind + const ParameterKind + const PathItemKind + const ReferenceKind + const RequestBodyKind + const ResponseKind + const SchemaKind + const SecuritySchemeKind + func (c Entity) Fragment() pointer.Fragment + func (c Entity) Key() string + func (c Entity) Path() string + type Example struct + Description string + ExternalValue string + Summary string + Value Any + func (s Example) Entity() Entity + type Expressions string + type ExternalDocumentation struct + Description string + URL string + type Header struct + AllowEmptyValue bool + AllowReserved bool + Content map[string]*MediaType + Deprecated bool + Description string + Example Any + Examples map[string]*Example + Explode bool + Required bool + Schema *Schema + Style string + func (h *Header) AllowsEmptyValues() *Header + func (h *Header) AsOptional() *Header + func (h *Header) NoEmptyValues() *Header + func (h *Header) WithDescription(description string) *Header + func (s Header) Entity() Entity + type Info struct + Contact *Contact + Description string + License *License + TermsOfService string + Title string + Version string + type License struct + Name string + URL string + type Link struct + Description string + OperationID string + OperationRef string + Parameters map[string]*AnyOrExpressions + RequestBody *AnyOrExpressions + Server *Server + func (s Link) Entity() Entity + type MediaType struct + Encoding map[string]*Encoding + Example Any + Examples map[string]*Example + Schema *Schema + type OAPIType string + const TypeArray + const TypeBoolean + const TypeInteger + const TypeNumber + const TypeObject + const TypeString + type OAuthFlow struct + Acopes map[string]string + AuthorizationURL string + RefreshURL string + TokenURL string + type OAuthFlows struct + AuthorizationCode *OAuthFlow + ClientCredentials *OAuthFlow + Implicit *OAuthFlow + Password *OAuthFlow + type OpenAPI struct + Components *Components + ExternalDocs *ExternalDocumentation + Info *Info + OpenAPI string + Paths Paths + Security []map[string]SecurityRequirement + Servers []*Server + Tags []*Tag + type Operation struct + Callbacks map[string]*Callback + Deprecated bool + Description string + ExternalDocs *ExternalDocumentation + OperationID string + Parameters []*Parameter + RequestBody *RequestBody + Responses map[string]*Response + Security []map[string]SecurityRequirement + Servers []*Server + Summary string + Tags []string + type Parameter struct + AllowEmptyValue bool + AllowReserved bool + Content map[string]*MediaType + Deprecated bool + Description string + Example Any + Examples map[string]*Example + Explode bool + In string + Name string + Required bool + Schema *Schema + Style string + func CookieParam(name string, schema *Schema) *Parameter + func HeaderParam(name string, schema *Schema) *Parameter + func PathParam(name string, schema *Schema) *Parameter + func QueryParam(name string, schema *Schema) *Parameter + func (p *Parameter) AllowsEmptyValues() *Parameter + func (p *Parameter) AsOptional() *Parameter + func (p *Parameter) NoEmptyValues() *Parameter + func (p *Parameter) WithDescription(description string) *Parameter + func (p *Parameter) WithLocation(in string) *Parameter + func (p *Parameter) WithName(name string) *Parameter + func (p *Parameter) WithSchema(schema *Schema) *Parameter + func (s Parameter) Entity() Entity + type PathItem struct + Delete *Operation + Description string + Get *Operation + Head *Operation + Options *Operation + Parameters []*Parameter + Patch *Operation + Post *Operation + Put *Operation + Servers []*Server + Summary string + Trace *Operation + func (s PathItem) Entity() Entity + func (s PathItem) Operations() (oo []Operation) + type Paths map[string]*PathItem + type Refable struct + Ref *pointer.Pointer + func (s Refable) Entity() Entity + type RequestBody struct + Content map[string]*MediaType + Description string + Required bool + func FormDataRequestBody(schema *Schema) *RequestBody + func JSONRequestBody(schema *Schema) *RequestBody + func NewRequestBody(typ string, schema *Schema) *RequestBody + func OctetStreamRequestBody(schema *Schema) *RequestBody + func TextPlainRequestBody(schema *Schema) *RequestBody + func URLEncodedRequestBody(schema *Schema) *RequestBody + func XMLRequestBody(schema *Schema) *RequestBody + func (s RequestBody) Entity() Entity + type Response struct + Content map[string]*MediaType + Description string + Headers map[string]*Header + Links map[string]*Link + func FormDataResponse(schema *Schema) *Response + func JSONResponse(schema *Schema) *Response + func NewResponse(typ string, schema *Schema) *Response + func OctetStreamResponse(schema *Schema) *Response + func TextPlainResponse(schema *Schema) *Response + func URLEncodedResponse(schema *Schema) *Response + func XMLResponse(schema *Schema) *Response + func (r *Response) AddContent(name string, content *MediaType) *Response + func (r *Response) AddHeader(name string, header *Header) *Response + func (r *Response) AddLink(name string, link *Link) *Response + func (r *Response) RemoveContent(name string) *Response + func (r *Response) RemoveHeader(name string) *Response + func (r *Response) RemoveLink(name string) *Response + func (r *Response) WithDescription(description string) *Response + func (s Response) Entity() Entity + type Schema struct + AdditionalProperties *Schema + AllOf []*Schema + AnyOf []*Schema + Default Any + Deprecated bool + Description string + Discriminator *Discriminator + Enum []Any + Example Any + ExclusiveMaximum bool + ExclusiveMinimum bool + ExternalDocs *ExternalDocumentation + Format string + Items *Schema + MaxItems *int64 + MaxLength *int64 + MaxProperties *int64 + Maximum *float64 + MinItems *int64 + MinLength *int64 + MinProperties *int64 + Minimum *float64 + MultipleOf *float64 + Not *Schema + Nullable bool + OneOf []*Schema + Pattern string + Properties map[string]*Schema + ReadOnly bool + Required []string + Title string + Type OAPIType + UniqueItems bool + WriteOnly bool + XML *XML + func AllSchema(schemas ...*Schema) *Schema + func AnySchema(schemas ...*Schema) *Schema + func ArrayProperty(items *Schema) *Schema + func BinaryProperty() *Schema + func BooleanProperty() *Schema + func ByteProperty() *Schema + func DateProperty() *Schema + func DateTimeProperty() *Schema + func Float32Property() *Schema + func Float64Property() *Schema + func FloatFmtProperty(format string) *Schema + func Int16Property() *Schema + func Int32Property() *Schema + func Int64Property() *Schema + func Int8Property() *Schema + func IntFmtProperty(format string) *Schema + func MapProperty(property *Schema) *Schema + func NotSchema(schema *Schema) *Schema + func OneSchema(schemas ...*Schema) *Schema + func PasswordProperty() *Schema + func StrFmtProperty(format string) *Schema + func StringProperty() *Schema + func (s *Schema) AddRequired(items ...string) *Schema + func (s *Schema) AddToAllOf(schemas ...*Schema) *Schema + func (s *Schema) AllowDuplicates() *Schema + func (s *Schema) AsReadOnly() *Schema + func (s *Schema) AsUnwrappedXML() *Schema + func (s *Schema) AsWrappedXML() *Schema + func (s *Schema) AsWritable() *Schema + func (s *Schema) AsXMLAttribute() *Schema + func (s *Schema) AsXMLElement() *Schema + func (s *Schema) UniqueValues() *Schema + func (s *Schema) WithAllOf(schemas ...*Schema) *Schema + func (s *Schema) WithDefault(defaultValue Any) *Schema + func (s *Schema) WithDescription(description string) *Schema + func (s *Schema) WithEnum(values ...Any) *Schema + func (s *Schema) WithExample(example Any) *Schema + func (s *Schema) WithExternalDocs(description, url string) *Schema + func (s *Schema) WithFormat(format string) *Schema + func (s *Schema) WithMaxItems(size int64) *Schema + func (s *Schema) WithMaxLength(max int64) *Schema + func (s *Schema) WithMaxProperties(max int64) *Schema + func (s *Schema) WithMaximum(max float64, exclusive bool) *Schema + func (s *Schema) WithMinItems(size int64) *Schema + func (s *Schema) WithMinLength(min int64) *Schema + func (s *Schema) WithMinProperties(min int64) *Schema + func (s *Schema) WithMinimum(min float64, exclusive bool) *Schema + func (s *Schema) WithMultipleOf(number float64) *Schema + func (s *Schema) WithPattern(pattern string) *Schema + func (s *Schema) WithProperties(schemas map[string]*Schema) *Schema + func (s *Schema) WithProperty(name string, schema *Schema) *Schema + func (s *Schema) WithRequired(items ...string) *Schema + func (s *Schema) WithTitle(title string) *Schema + func (s *Schema) WithType(typ OAPIType, format string) *Schema + func (s *Schema) WithXMLName(name string) *Schema + func (s *Schema) WithXMLNamespace(namespace string) *Schema + func (s *Schema) WithXMLPrefix(prefix string) *Schema + func (s Schema) Entity() Entity + type SecurityRequirement []string + type SecurityScheme struct + BearerFormat string + Description string + Flows *OAuthFlows + In string + Name string + OpenIDConnectURL string + Scheme string + Type string + func APIKeyAuth(fieldName, valueSource string) *SecurityScheme + func BasicAuth() *SecurityScheme + func BearerAuth(bearerFormat string) *SecurityScheme + func OAuth2AuthorizationCode(tokenURL string) *SecurityScheme + func OAuth2ClientCredentials(authorizationURL, tokenURL string) *SecurityScheme + func OAuth2Implicit(authorizationURL string) *SecurityScheme + func OAuth2Password(tokenURL string) *SecurityScheme + func (s SecurityScheme) Entity() Entity + type Server struct + Description string + URL string + Variables map[string]*ServerVariable + func NewServers(uris ...string) ([]*Server, error) + type ServerVariable struct + Default string + Description string + Enum []string + type Tag struct + Description string + ExternalDocs *ExternalDocumentation + Name string + type XML struct + Attribute bool + Name string + Namespace string + Prefix string + Wrapped bool + func (x *XML) AsAttribute() *XML + func (x *XML) AsElement() *XML + func (x *XML) AsUnwrapped() *XML + func (x *XML) AsWrapped() *XML + func (x *XML) WithName(name string) *XML + func (x *XML) WithNamespace(namespace string) *XML + func (x *XML) WithPrefix(prefix string) *XML
Go to main page