Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildSchema ¶
func BuildSchema(comments in.SwagifyComment, schemas map[string]Schema)
Types ¶
type AdditionalProperty ¶
type Schema ¶
type Schema struct { Type string `json:"type,omitempty" yaml:"type,omitempty"` Required []string `json:"required,omitempty" yaml:"required,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Example string `json:"example,omitempty" yaml:"example,omitempty"` Properties map[string]SchemaProperty `json:"properties,omitempty" yaml:"properties,omitempty"` AddlProperties AdditionalProperty `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"` Items map[string]string `json:"items,omitempty" yaml:"items,omitempty"` }
type SchemaProperty ¶
type SchemaProperty struct { Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"` Type string `json:"type,omitempty" yaml:"type,omitempty"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Example interface{} `json:"example,omitempty" yaml:"example,omitempty"` ExampleStr string `json:"-" yaml:"-"` Enum []string `json:"enum,omitempty" yaml:"enum,omitempty"` }
TODO: if type is object or array may need to have self reference
Click to show internal directories.
Click to hide internal directories.