ogen

Aug 7, 2024

Changes in this version

type Operation

+ func (s *Operation) MarshalJSON() ([]byte, error)

type PathItem

+ func (s *PathItem) MarshalJSON() ([]byte, error)

Feb 20, 2024

Changes in this version

type Spec

+ Swagger string

Jun 12, 2023

Changes in this version

+ type Items struct

+ Item *Schema

+ Items []*Schema

+ func (p *Items) ToJSONSchema() *jsonschema.RawItems

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

+ func (p *Items) UnmarshalYAML(node *yaml.Node) error

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

+ func (p Items) MarshalYAML() (any, error)

May 31, 2023

Changes in this version

type Schema

+ func (s *Schema) SetSummary(smry string) *Schema

May 23, 2023

Changes in this version

type Schema

+ func (s *Schema) SetDeprecated(d bool) *Schema

Jan 23, 2023

Changes in this version

+ type SecurityRequirement = map[string][]string

Sep 28, 2022

Changes in this version

type Server

+ Common OpenAPICommon

type ServerVariable

+ Common OpenAPICommon

Sep 22, 2022

Changes in this version

type Components

+ Common OpenAPICommon

type Contact

+ Extensions Extensions

type Discriminator

+ Common OpenAPICommon

type Encoding

+ Common OpenAPICommon

type Example

+ Common OpenAPICommon

+ type Extensions = jsonschema.Extensions

type ExternalDocumentation

+ Extensions Extensions

type Info

+ Extensions Extensions

type License

+ Extensions Extensions

type Link

+ Common OpenAPICommon

type Media

+ Common OpenAPICommon

type OAuthFlow

+ Common OpenAPICommon

type OAuthFlows

+ Common OpenAPICommon

+ type OpenAPICommon = jsonschema.OpenAPICommon

type Operation

+ Common OpenAPICommon

type Parameter

+ Common OpenAPICommon

type PathItem

+ Common OpenAPICommon

type RequestBody

+ Common OpenAPICommon

type Response

+ Common OpenAPICommon

type Schema

+ Common jsonschema.OpenAPICommon

type SecurityScheme

+ Common OpenAPICommon

type Server

+ Extensions Extensions

type ServerVariable

+ Extensions Extensions

type Spec

+ Extensions Extensions

type Tag

+ Extensions Extensions

type XML

+ Common OpenAPICommon

Jul 25, 2022

Changes in this version

type Components

+ PathItems map[string]*PathItem

Jul 21, 2022

Changes in this version

type AdditionalProperties

+ func (p AdditionalProperties) MarshalYAML() (interface{}, error)

+ type Callback map[string]*PathItem

type Components

+ Callbacks map[string]*Callback

+ Links map[string]*Link

+ Locator Locator

type Encoding

+ Locator Locator

type Example

+ Locator Locator

type License

+ Identifier string

+ type Link struct

+ OperationID string

+ OperationRef string

+ Parameters map[string]RawValue

+ Ref string

type Media

+ Locator Locator

type OAuthFlow

+ Locator Locator

type OAuthFlows

+ Locator Locator

type Operation

+ Callbacks map[string]*Callback

+ Locator Locator

+ Servers []Server

type Parameter

+ AllowReserved bool

+ Locator Locator

type PathItem

+ Locator Locator

type PatternProperties

+ func (p PatternProperties) MarshalYAML() (interface{}, error)

type Properties

+ func (p Properties) MarshalYAML() (interface{}, error)

+ type RawValue = jsonschema.RawValue

type RequestBody

+ Locator Locator

type Response

+ Locator Locator

type Schema

+ Locator Locator

+ XML *XML

type SecurityScheme

+ Locator Locator

type Spec

+ JSONSchemaDialect string

+ Webhooks map[string]*PathItem

+ func (s *Spec) UnmarshalYAML(n *yaml.Node) error

+ type XML struct

+ Attribute bool

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

+ func (d *XML) ToJSONSchema() *jsonschema.XML

Jul 7, 2022

Changes in this version

type AdditionalProperties

+ func (p *AdditionalProperties) UnmarshalYAML(node *yaml.Node) error

type Components

+ func (c *Components) UnmarshalYAML(n *yaml.Node) error

+ type Default = jsonschema.Default

type Encoding

+ func (e *Encoding) UnmarshalYAML(n *yaml.Node) error

type Example

+ func (e *Example) UnmarshalYAML(n *yaml.Node) error

+ type ExampleValue = jsonschema.Example

type Media

+ func (m *Media) UnmarshalYAML(n *yaml.Node) error

type Operation

+ func (o *Operation) UnmarshalYAML(n *yaml.Node) error

type Parameter

+ func (p *Parameter) UnmarshalYAML(n *yaml.Node) error

type PathItem

+ func (p *PathItem) UnmarshalYAML(n *yaml.Node) error

type PatternProperties

+ func (p *PatternProperties) UnmarshalYAML(node *yaml.Node) error

type Properties

+ func (p *Properties) UnmarshalYAML(node *yaml.Node) error

type RequestBody

+ func (r *RequestBody) UnmarshalYAML(n *yaml.Node) error

type Response

+ func (r *Response) UnmarshalYAML(n *yaml.Node) error

type Schema

+ func (s *Schema) UnmarshalYAML(n *yaml.Node) error

Jul 5, 2022

Changes in this version

type AdditionalProperties

+ func (p *AdditionalProperties) UnmarshalNextJSON(opts json.UnmarshalOptions, d *json.Decoder) error

+ func (p AdditionalProperties) MarshalNextJSON(opts json.MarshalOptions, e *json.Encoder) error

type Components

+ func (c *Components) Init()

+ type Locator = ogenjson.Locator

type PatternProperties

+ func (p *PatternProperties) UnmarshalNextJSON(opts json.UnmarshalOptions, d *json.Decoder) error

+ func (p PatternProperties) MarshalNextJSON(opts json.MarshalOptions, e *json.Encoder) error

type Properties

+ func (p *Properties) UnmarshalNextJSON(opts json.UnmarshalOptions, d *json.Decoder) error

+ func (p Properties) MarshalNextJSON(opts json.MarshalOptions, e *json.Encoder) error

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIDConnectURL string

+ Ref string

+ Scheme string

+ Type string

type Spec

+ func (s *Spec) UnmarshalNextJSON(opts json.UnmarshalOptions, d *json.Decoder) error

Jun 22, 2022

Changes in this version

+ type ExternalDocumentation struct

+ Description string

+ URL string

type Operation

+ ExternalDocs *ExternalDocumentation

type Schema

+ ContentEncoding string

+ ContentMediaType string

+ ExternalDocs *ExternalDocumentation

type Server

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

type Spec

+ ExternalDocs *ExternalDocumentation

type Tag

+ ExternalDocs *ExternalDocumentation

Jun 16, 2022

Changes in this version

+ type Enum = jsonschema.Enum

Jun 14, 2022

Changes in this version

type Info

+ Summary string

type PathItem

+ Summary string

type Schema

+ Summary string

May 30, 2022

Changes in this version

type Encoding

+ ContentType string

+ Headers map[string]*Header

May 24, 2022

Changes in this version

type Components

+ Headers map[string]*Header

+ type Encoding struct

+ AllowReserved bool

+ Explode *bool

+ Style string

+ type Header = Parameter

type Media

+ Encoding map[string]Encoding

type Response

+ Headers map[string]*Header

+ func (r *Response) SetHeaders(h map[string]*Header) *Response

Apr 3, 2022

Changes in this version

+ type PatternProperties []PatternProperty

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

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

+ func (r PatternProperties) ToJSONSchema() (result jsonschema.RawPatternProperties)

+ type PatternProperty struct

+ Pattern string

+ Schema *Schema

type Schema

+ PatternProperties PatternProperties

Apr 1, 2022

Changes in this version

type Spec

+ Raw []byte

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

Mar 6, 2022

Changes in this version

type Components

+ SecuritySchemes map[string]*SecuritySchema

+ type OAuthFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

type Operation

+ Security SecurityRequirements

+ type SecurityRequirements []map[string][]string

+ type SecuritySchema struct

+ BearerFormat string

+ Description string

+ Flows OAuthFlows

+ In string

+ Name string

+ OpenIDConnectURL string

+ Ref string

+ Scheme string

+ Type string

type Spec

+ Security SecurityRequirements

Feb 18, 2022

Changes in this version

+ type Num = jsonschema.Num

Feb 7, 2022

Changes in this version

type AdditionalProperties

+ func (p *AdditionalProperties) ToJSONSchema() *jsonschema.AdditionalProperties

type Discriminator

+ func (d *Discriminator) ToJSONSchema() *jsonschema.Discriminator

type Properties

+ func (p Properties) ToJSONSchema() jsonschema.RawProperties

type Property

+ func (p Property) ToJSONSchema() jsonschema.RawProperty

type Schema

+ func (s *Schema) ToJSONSchema() *jsonschema.RawSchema

Feb 2, 2022

Changes in this version

type AdditionalProperties

+ Bool bool

+ Schema Schema

Jan 28, 2022

Changes in this version

+ type AdditionalProperties Schema

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

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

type Schema

+ AdditionalProperties *AdditionalProperties

Dec 20, 2021

Changes in this version

type Schema

+ func Int() *Schema

+ func UUID() *Schema

Dec 17, 2021

Changes in this version

+ type Components struct

+ Examples map[string]*Example

+ Parameters map[string]*Parameter

+ RequestBodies map[string]*RequestBody

+ Responses map[string]*Response

+ Schemas map[string]*Schema

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ func NewContact() *Contact

+ func (c *Contact) SetEmail(e string) *Contact

+ func (c *Contact) SetName(n string) *Contact

+ func (c *Contact) SetURL(url string) *Contact

+ type Discriminator struct

+ Mapping map[string]string

+ PropertyName string

+ type Example struct

+ Description string

+ ExternalValue string

+ Ref string

+ Summary string

+ Value json.RawMessage

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ func NewInfo() *Info

+ func (i *Info) SetContact(c *Contact) *Info

+ func (i *Info) SetDescription(d string) *Info

+ func (i *Info) SetLicense(l *License) *Info

+ func (i *Info) SetTermsOfService(t string) *Info

+ func (i *Info) SetTitle(t string) *Info

+ func (i *Info) SetVersion(v string) *Info

+ type License struct

+ Name string

+ URL string

+ func NewLicense() *License

+ func (l *License) SetName(n string) *License

+ func (l *License) SetURL(url string) *License

+ type Media struct

+ Example json.RawMessage

+ Examples map[string]*Example

+ Schema Schema

+ type NamedParameter struct

+ Name string

+ Parameter *Parameter

+ func NewNamedParameter(n string, p *Parameter) *NamedParameter

+ func (p *NamedParameter) AsLocalRef() *Parameter

+ type NamedPathItem struct

+ Name string

+ PathItem *PathItem

+ func NewNamedPathItem(n string, p *PathItem) *NamedPathItem

+ func (p *NamedPathItem) AsLocalRef() *PathItem

+ type NamedRequestBody struct

+ Name string

+ RequestBody *RequestBody

+ func NewNamedRequestBody(n string, p *RequestBody) *NamedRequestBody

+ func (p *NamedRequestBody) AsLocalRef() *RequestBody

+ type NamedResponse struct

+ Name string

+ Response *Response

+ func NewNamedResponse(n string, p *Response) *NamedResponse

+ func (p *NamedResponse) AsLocalRef() *Response

+ type NamedSchema struct

+ Name string

+ Schema *Schema

+ func NewNamedSchema(n string, p *Schema) *NamedSchema

+ func (p *NamedSchema) AsLocalRef() *Schema

+ type Operation struct

+ Deprecated bool

+ Description string

+ OperationID string

+ Parameters []*Parameter

+ RequestBody *RequestBody

+ Responses Responses

+ Summary string

+ Tags []string

+ func NewOperation() *Operation

+ func (o *Operation) AddNamedResponses(ps ...*NamedResponse) *Operation

+ func (o *Operation) AddParameters(ps ...*Parameter) *Operation

+ func (o *Operation) AddResponse(n string, p *Response) *Operation

+ func (o *Operation) AddTags(ts ...string) *Operation

+ func (o *Operation) SetDescription(d string) *Operation

+ func (o *Operation) SetOperationID(id string) *Operation

+ func (o *Operation) SetParameters(ps []*Parameter) *Operation

+ func (o *Operation) SetRequestBody(r *RequestBody) *Operation

+ func (o *Operation) SetResponses(r Responses) *Operation

+ func (o *Operation) SetSummary(s string) *Operation

+ func (o *Operation) SetTags(ts []string) *Operation

+ type Parameter struct

+ Content map[string]Media

+ Deprecated bool

+ Description string

+ Example json.RawMessage

+ Examples map[string]*Example

+ Explode *bool

+ In string

+ Name string

+ Ref string

+ Required bool

+ Schema Schema

+ Style string

+ func NewParameter() *Parameter

+ func (p *Parameter) InCookie() *Parameter

+ func (p *Parameter) InHeader() *Parameter

+ func (p *Parameter) InPath() *Parameter

+ func (p *Parameter) InQuery() *Parameter

+ func (p *Parameter) SetContent(c map[string]Media) *Parameter

+ func (p *Parameter) SetDeprecated(d bool) *Parameter

+ func (p *Parameter) SetDescription(d string) *Parameter

+ func (p *Parameter) SetExplode(e bool) *Parameter

+ func (p *Parameter) SetIn(i string) *Parameter

+ func (p *Parameter) SetName(n string) *Parameter

+ func (p *Parameter) SetRef(r string) *Parameter

+ func (p *Parameter) SetRequired(r bool) *Parameter

+ func (p *Parameter) SetSchema(s *Schema) *Parameter

+ func (p *Parameter) SetStyle(s string) *Parameter

+ func (p *Parameter) ToNamed(n string) *NamedParameter

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers []Server

+ Trace *Operation

+ func NewPathItem() *PathItem

+ func (p *PathItem) AddParameters(ps ...*Parameter) *PathItem

+ func (p *PathItem) AddServers(srvs ...*Server) *PathItem

+ func (p *PathItem) SetDelete(o *Operation) *PathItem

+ func (p *PathItem) SetDescription(d string) *PathItem

+ func (p *PathItem) SetGet(o *Operation) *PathItem

+ func (p *PathItem) SetHead(o *Operation) *PathItem

+ func (p *PathItem) SetOptions(o *Operation) *PathItem

+ func (p *PathItem) SetParameters(ps []*Parameter) *PathItem

+ func (p *PathItem) SetPatch(o *Operation) *PathItem

+ func (p *PathItem) SetPost(o *Operation) *PathItem

+ func (p *PathItem) SetPut(o *Operation) *PathItem

+ func (p *PathItem) SetRef(r string) *PathItem

+ func (p *PathItem) SetServers(srvs []Server) *PathItem

+ func (p *PathItem) SetTrace(o *Operation) *PathItem

+ func (p *PathItem) ToNamed(n string) *NamedPathItem

+ type Paths map[string]*PathItem

+ type Properties []Property

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

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

+ type Property struct

+ Name string

+ Schema *Schema

+ func NewProperty() *Property

+ func (p *Property) SetName(n string) *Property

+ func (p *Property) SetSchema(s *Schema) *Property

+ type RequestBody struct

+ Content map[string]Media

+ Description string

+ Ref string

+ Required bool

+ func NewRequestBody() *RequestBody

+ func (r *RequestBody) AddContent(mt string, s *Schema) *RequestBody

+ func (r *RequestBody) SetContent(c map[string]Media) *RequestBody

+ func (r *RequestBody) SetDescription(d string) *RequestBody

+ func (r *RequestBody) SetJSONContent(s *Schema) *RequestBody

+ func (r *RequestBody) SetRef(ref string) *RequestBody

+ func (r *RequestBody) SetRequired(req bool) *RequestBody

+ func (r *RequestBody) ToNamed(n string) *NamedRequestBody

+ type Response struct

+ Content map[string]Media

+ Description string

+ Header map[string]interface{}

+ Links map[string]interface{}

+ Ref string

+ func NewResponse() *Response

+ func (r *Response) AddContent(mt string, s *Schema) *Response

+ func (r *Response) SetContent(c map[string]Media) *Response

+ func (r *Response) SetDescription(d string) *Response

+ func (r *Response) SetHeader(h map[string]interface{}) *Response

+ func (r *Response) SetJSONContent(s *Schema) *Response

+ func (r *Response) SetLinks(l map[string]interface{}) *Response

+ func (r *Response) SetRef(ref string) *Response

+ func (r *Response) ToNamed(n string) *NamedResponse

+ type Responses map[string]*Response

+ type Schema struct

+ AllOf []*Schema

+ AnyOf []*Schema

+ Default json.RawMessage

+ Deprecated bool

+ Description string

+ Discriminator *Discriminator

+ Enum []json.RawMessage

+ Example json.RawMessage

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Schema

+ MaxItems *uint64

+ MaxLength *uint64

+ MaxProperties *uint64

+ Maximum *int64

+ MinItems *uint64

+ MinLength *int64

+ MinProperties *uint64

+ Minimum *int64

+ MultipleOf *int

+ Nullable bool

+ OneOf []*Schema

+ Pattern string

+ Properties Properties

+ Ref string

+ Required []string

+ Type string

+ UniqueItems bool

+ func Binary() *Schema

+ func Bool() *Schema

+ func Bytes() *Schema

+ func Date() *Schema

+ func DateTime() *Schema

+ func Double() *Schema

+ func Float() *Schema

+ func Int32() *Schema

+ func Int64() *Schema

+ func NewSchema() *Schema

+ func Password() *Schema

+ func String() *Schema

+ func (s *Schema) AddOptionalProperties(ps ...*Property) *Schema

+ func (s *Schema) AddRequiredProperties(ps ...*Property) *Schema

+ func (s *Schema) AsArray() *Schema

+ func (s *Schema) AsEnum(def json.RawMessage, values ...json.RawMessage) *Schema

+ func (s *Schema) SetAllOf(a []*Schema) *Schema

+ func (s *Schema) SetAnyOf(a []*Schema) *Schema

+ func (s *Schema) SetDefault(d json.RawMessage) *Schema

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

+ func (s *Schema) SetDiscriminator(d *Discriminator) *Schema

+ func (s *Schema) SetEnum(e []json.RawMessage) *Schema

+ func (s *Schema) SetExclusiveMaximum(e bool) *Schema

+ func (s *Schema) SetExclusiveMinimum(e bool) *Schema

+ func (s *Schema) SetFormat(f string) *Schema

+ func (s *Schema) SetItems(i *Schema) *Schema

+ func (s *Schema) SetMaxItems(m *uint64) *Schema

+ func (s *Schema) SetMaxLength(m *uint64) *Schema

+ func (s *Schema) SetMaxProperties(m *uint64) *Schema

+ func (s *Schema) SetMaximum(m *int64) *Schema

+ func (s *Schema) SetMinItems(m *uint64) *Schema

+ func (s *Schema) SetMinLength(m *int64) *Schema

+ func (s *Schema) SetMinProperties(m *uint64) *Schema

+ func (s *Schema) SetMinimum(m *int64) *Schema

+ func (s *Schema) SetMultipleOf(m *int) *Schema

+ func (s *Schema) SetNullable(n bool) *Schema

+ func (s *Schema) SetOneOf(o []*Schema) *Schema

+ func (s *Schema) SetPattern(p string) *Schema

+ func (s *Schema) SetProperties(p *Properties) *Schema

+ func (s *Schema) SetRef(r string) *Schema

+ func (s *Schema) SetRequired(r []string) *Schema

+ func (s *Schema) SetType(t string) *Schema

+ func (s *Schema) SetUniqueItems(u bool) *Schema

+ func (s *Schema) ToNamed(n string) *NamedSchema

+ func (s *Schema) ToProperty(n string) *Property

+ type Server struct

+ Description string

+ URL string

+ func NewServer() *Server

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

+ func (s *Server) SetURL(url string) *Server

+ type Spec struct

+ Components *Components

+ Info Info

+ OpenAPI string

+ Paths Paths

+ Servers []Server

+ Tags []Tag

+ func NewSpec() *Spec

+ func Parse(data []byte) (*Spec, error)

+ func (s *Spec) AddNamedParameters(ps ...*NamedParameter) *Spec

+ func (s *Spec) AddNamedPathItems(ps ...*NamedPathItem) *Spec

+ func (s *Spec) AddNamedRequestBodies(scs ...*NamedRequestBody) *Spec

+ func (s *Spec) AddNamedResponses(scs ...*NamedResponse) *Spec

+ func (s *Spec) AddNamedSchemas(scs ...*NamedSchema) *Spec

+ func (s *Spec) AddParameter(n string, p *Parameter) *Spec

+ func (s *Spec) AddPathItem(n string, p *PathItem) *Spec

+ func (s *Spec) AddRequestBody(n string, sc *RequestBody) *Spec

+ func (s *Spec) AddResponse(n string, sc *Response) *Spec

+ func (s *Spec) AddSchema(n string, sc *Schema) *Spec

+ func (s *Spec) AddServers(srvs ...*Server) *Spec

+ func (s *Spec) Init()

+ func (s *Spec) RefRequestBody(n string) *NamedRequestBody

+ func (s *Spec) RefResponse(n string) *NamedResponse

+ func (s *Spec) RefSchema(n string) *NamedSchema

+ func (s *Spec) SetComponents(c *Components) *Spec

+ func (s *Spec) SetInfo(i *Info) *Spec

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

+ func (s *Spec) SetPaths(p Paths) *Spec

+ func (s *Spec) SetServers(srvs []Server) *Spec

+ type Tag struct

+ Description string

+ Name string