oasmodel

package

Go to main page

Versions in this module

v1

v1.0.12

Jun 26, 2023

v1.0.11

Dec 9, 2022

Changes in this version

type Info

+ XPackage string

type Ref

+ External string

v1.0.10

Nov 28, 2022

v1.0.9

Mar 17, 2022

v1.0.8

Oct 6, 2021

Changes in this version

type OpenAPI

+ func (oa *OpenAPI) ResolveRefsWithFilter(filter []string) map[string]*SchemaOrRef

v1.0.8-rc1

Oct 6, 2021

v1.0.7

Jul 22, 2021

v1.0.6

May 10, 2021

v1.0.5

May 9, 2021

Changes in this version

type OpenAPI

+ func (oa *OpenAPI) Read(file io.Reader) error

type Ref

+ Description string

type SchemaOrRef

+ func (s *SchemaOrRef) Description() string

v1.0.4

Nov 16, 2020

Changes in this version

+ type AdditionalProperties struct

+ BooleanValue bool

+ IsBool bool

+ Schema *SchemaOrRef

+ func (e *AdditionalProperties) MarshalYAML() (interface{}, error)

+ func (e *AdditionalProperties) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Callback map[string]PathItem

+ type CallbackOrRef struct

+ Ref *Ref

+ Val *Callback

+ func (e *CallbackOrRef) MarshalYAML() (interface{}, error)

+ func (e *CallbackOrRef) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Components struct

+ Callbacks map[string]*CallbackOrRef

+ Examples map[string]*ExampleOrRef

+ Headers map[string]*HeaderOrRef

+ Links map[string]*LinkOrRef

+ Parameters map[string]*ParameterOrRef

+ RequestBodies map[string]*RequestBodyOrRef

+ Responses map[string]*ResponseOrRef

+ Schemas map[string]*SchemaOrRef

+ SecuritySchemes map[string]*SecuritySchemeOrRef

+ 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]HeaderOrRef

+ Style string

+ type Example struct

+ Description string

+ ExternalValue string

+ Ref string

+ Summary string

+ Value ExampleValue

+ type ExampleOrRef struct

+ Ref *Ref

+ Val *Example

+ type ExampleValue map[string]interface

+ type ExternalDocs struct

+ Description string

+ URL string

+ type Header struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]MediaType

+ Deprecated bool

+ Description string

+ Example *ExampleValue

+ Examples map[string]Example

+ Explode *bool

+ Ref string

+ Required bool

+ Schema *Schema

+ Style string

+ type HeaderOrRef struct

+ Ref *Ref

+ Val *Header

+ 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]interface{}

+ Ref string

+ RequestBody map[string]interface{}

+ Server Server

+ type LinkOrRef struct

+ Ref *Ref

+ Val *Link

+ type MediaType struct

+ Encoding map[string]Encoding

+ Example ExampleValue

+ Examples map[string]ExampleOrRef

+ Schema *SchemaOrRef

+ type MediaTypeOrRef struct

+ Ref *Ref

+ Val *MediaType

+ func (e *MediaTypeOrRef) MarshalYAML() (interface{}, error)

+ func (e *MediaTypeOrRef) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type OAuth struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuth

+ ClientCredentials *OAuth

+ Implicit *OAuth

+ Password *OAuth

+ type OpenAPI struct

+ Components Components

+ ExternalDocs ExternalDocs

+ Info Info

+ Openapi string

+ Paths map[string]PathItem

+ RefIndex map[string]refIndexElement

+ Security []SecurityReq

+ Servers []Server

+ Tags []Tag

+ XWsRPC map[string]XwsRPCService

+ func (oa *OpenAPI) Load(filename string) error

+ func (oa *OpenAPI) ResolveRefs()

+ func (oa *OpenAPI) Save()

+ func (oa *OpenAPI) UnMarshal(buffer []byte) (*OpenAPI, error)

+ type Operation struct

+ Callbacks map[string]Callback

+ Deprecated bool

+ Description string

+ ExternalDocs *ExternalDocs

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses Responses

+ Security []SecurityReq

+ Servers []Server

+ Summary string

+ Tags []string

+ XWsRPC string

+ type Parameter struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]MediaType

+ Deprecated bool

+ Description string

+ Example *ExampleValue

+ Examples map[string]ExampleOrRef

+ Explode *bool

+ IN string

+ Name string

+ Required bool

+ Schema *SchemaOrRef

+ Style string

+ type ParameterOrRef struct

+ Ref *Ref

+ Val *Parameter

+ func (e *ParameterOrRef) MarshalYAML() (interface{}, error)

+ func (e *ParameterOrRef) UnmarshalYAML(unmarshal func(interface{}) error) error

+ 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

+ Summary string

+ Trace *Operation

+ type Ref struct

+ Ref string

+ RefName string

+ Resolved interface{}

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Ref string

+ Required bool

+ type RequestBodyOrRef struct

+ Ref *Ref

+ Val *RequestBody

+ type Response struct

+ Content map[string]*MediaTypeOrRef

+ Description string

+ Headers map[string]*HeaderOrRef

+ Links map[string]*LinkOrRef

+ type ResponseOrRef struct

+ Ref *Ref

+ Val *Response

+ func (e *ResponseOrRef) MarshalYAML() (interface{}, error)

+ func (e *ResponseOrRef) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Responses map[string]*ResponseOrRef

+ type Schema struct

+ AdditionalProperties *AdditionalProperties

+ AllOf []*SchemaOrRef

+ AnyOf []*SchemaOrRef

+ Default string

+ Deprecated bool

+ Description string

+ Discriminator *Discriminator

+ Enum []string

+ Example *Example

+ ExclusiveMaximum int

+ ExclusiveMinimum int

+ ExternalDocs *ExternalDocs

+ Format string

+ Items *SchemaOrRef

+ MaxItems int

+ MaxLength int

+ MaxProperties int

+ Maximum int

+ MinItems int

+ MinLength int

+ MinProperties int

+ Minimum int

+ MultipleOf int

+ Nullable bool

+ OneOf []*SchemaOrRef

+ Pattern string

+ Properties map[string]*SchemaOrRef

+ ReadOnly bool

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ WriteOnly bool

+ XML XML

+ XPropertiesOrder []string

+ type SchemaOrRef struct

+ Ref *Ref

+ Val *Schema

+ func (s *SchemaOrRef) MarshalYAML() (interface{}, error)

+ func (s *SchemaOrRef) Schema() *Schema

+ func (s *SchemaOrRef) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type SecurityReq map[string][]string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows OAuthFlows

+ IN string

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type string

+ type SecuritySchemeOrRef struct

+ Ref *Ref

+ Val *SecurityScheme

+ type Server struct

+ Description string

+ URL string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ type Tag struct

+ Description string

+ ExternalDocs ExternalDocs

+ Name string

+ type XML struct

+ Attribute bool

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

+ type XwsRPCOperation struct

+ Name string

+ Schema *SchemaOrRef

+ type XwsRPCService struct

+ Client struct{ ... }

+ Server struct{ ... }

v1.0.3

Jun 26, 2020

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