Documentation
¶
Index ¶
- func ValidateFile(path string) error
- type BuildError
- type CodeSample
- type ComposedSchema
- type ExternalDoc
- type Flow
- type Header
- type Info
- type License
- type MetaSchema
- type Metadata
- type OpenAPI
- type Path
- type RequestBody
- type Response
- type Schema
- type SecuritySchemes
- type Server
- type ServerVariable
- type Tag
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateFile ¶
Types ¶
type BuildError ¶
func (BuildError) Error ¶
func (e BuildError) Error() string
type CodeSample ¶
type ComposedSchema ¶
func (*ComposedSchema) CustomName ¶
func (c *ComposedSchema) CustomName() string
func (*ComposedSchema) RealName ¶
func (c *ComposedSchema) RealName() string
func (*ComposedSchema) SetCustomName ¶
func (c *ComposedSchema) SetCustomName(customName string)
type ExternalDoc ¶
type MetaSchema ¶
type OpenAPI ¶
type OpenAPI struct {
Openapi string `yaml:"openapi"`
Info Info `yaml:"info"`
Servers []Server `yaml:"servers,omitempty"`
Paths map[string]Path `yaml:"paths,omitempty"`
Tags []Tag `yaml:"tags,omitempty"`
Components map[string]interface{} `yaml:"components,omitempty"`
Security []map[string][]string `yaml:"security,omitempty"`
XGroupTags []interface{} `yaml:"x-tagGroups,omitempty"`
// contains filtered or unexported fields
}
func CombineOAS ¶
func NewOpenAPI ¶
func NewOpenAPI() OpenAPI
func (*OpenAPI) AddOperation ¶
type RequestBody ¶
type Schema ¶
type Schema struct {
Metadata `yaml:"-"`
Description string `yaml:"description,omitempty"`
Nullable *bool `yaml:"nullable,omitempty"`
Required []string `yaml:"required,omitempty"`
Type string `yaml:"type,omitempty"`
Items map[string]interface{} `yaml:"items,omitempty"`
Format string `yaml:"format,omitempty"`
Ref string `yaml:"$ref,omitempty"`
Enum []string `yaml:"enum,omitempty"`
Properties map[string]*Schema `yaml:"properties,omitempty"`
AdditionalProperties *Schema `yaml:"additionalProperties,omitempty"`
OneOf []Schema `yaml:"oneOf,omitempty"`
Example interface{} `yaml:"example,omitempty"`
}
func (*Schema) CustomName ¶
func (*Schema) SetCustomName ¶
type SecuritySchemes ¶
type Server ¶
type Server struct {
URL string `yaml:"url,omitempty"`
Description string `yaml:"description,omitempty"`
Variables map[string]ServerVariable `yaml:"variables,omitempty"`
}
type ServerVariable ¶
Click to show internal directories.
Click to hide internal directories.