v2

package
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2022 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Definitions

type Definitions struct {
	Definitions map[string]*highbase.SchemaProxy
	// contains filtered or unexported fields
}

func NewDefinitions

func NewDefinitions(definitions *low.Definitions) *Definitions

func (*Definitions) GoLow

func (d *Definitions) GoLow() *low.Definitions

type Examples

type Examples struct {
	Values map[string]any
	// contains filtered or unexported fields
}

func NewExamples

func NewExamples(examples *low.Examples) *Examples

func (*Examples) GoLow

func (e *Examples) GoLow() *low.Examples
type Header struct {
	Type             string
	Format           string
	Description      string
	Items            *Items
	CollectionFormat string
	Default          any
	Maximum          int
	ExclusiveMaximum bool
	Minimum          int
	ExclusiveMinimum bool
	MaxLength        int
	MinLength        int
	Pattern          string
	MaxItems         int
	MinItems         int
	UniqueItems      bool
	Enum             []string
	MultipleOf       int
	Extensions       map[string]any
	// contains filtered or unexported fields
}

func NewHeader

func NewHeader(header *low.Header) *Header

func (*Header) GoLow

func (h *Header) GoLow() *low.Header

type Items

type Items struct {
	Type             string
	Format           string
	CollectionFormat string
	Items            *Items
	Default          any
	Maximum          int
	ExclusiveMaximum bool
	Minimum          int
	ExclusiveMinimum bool
	MaxLength        int
	MinLength        int
	Pattern          string
	MaxItems         int
	MinItems         int
	UniqueItems      bool
	Enum             []string
	MultipleOf       int
	// contains filtered or unexported fields
}

func NewItems

func NewItems(items *low.Items) *Items

func (*Items) GoLow

func (i *Items) GoLow() *low.Items

type Operation

type Operation struct {
	Tags         []string
	Summary      string
	Description  string
	ExternalDocs *base.ExternalDoc
	OperationId  string
	Consumes     []string
	Produces     []string
	Parameters   []*Parameter
	Responses    *Responses
	Schemes      []string
	Deprecated   bool
	Security     []*SecurityRequirement
	Extensions   map[string]any
	// contains filtered or unexported fields
}

func NewOperation

func NewOperation(operation *low.Operation) *Operation

func (*Operation) GoLow

func (o *Operation) GoLow() *low.Operation

type Parameter

type Parameter struct {
	Name             string
	In               string
	Type             string
	Format           string
	Description      string
	Required         bool
	AllowEmptyValue  bool
	Schema           *base.SchemaProxy
	Items            *Items
	CollectionFormat string
	Default          any
	Maximum          int
	ExclusiveMaximum bool
	Minimum          int
	ExclusiveMinimum bool
	MaxLength        int
	MinLength        int
	Pattern          string
	MaxItems         int
	MinItems         int
	UniqueItems      bool
	Enum             []string
	MultipleOf       int
	Extensions       map[string]any
	// contains filtered or unexported fields
}

func NewParameter

func NewParameter(parameter *low.Parameter) *Parameter

func (*Parameter) GoLow

func (p *Parameter) GoLow() *low.Parameter

type ParameterDefinitions

type ParameterDefinitions struct {
	Definitions map[string]*Parameter
	// contains filtered or unexported fields
}

func NewParametersDefinitions

func NewParametersDefinitions(parametersDefinitions *low.ParameterDefinitions) *ParameterDefinitions

func (*ParameterDefinitions) GoLow

type PathItem

type PathItem struct {
	Ref        string
	Get        *Operation
	Put        *Operation
	Post       *Operation
	Delete     *Operation
	Options    *Operation
	Head       *Operation
	Patch      *Operation
	Parameters []*Parameter
	Extensions map[string]any
	// contains filtered or unexported fields
}

func NewPathItem

func NewPathItem(pathItem *low.PathItem) *PathItem

func (*PathItem) GoLow

func (p *PathItem) GoLow() *low.PathItem

type Paths

type Paths struct {
	PathItems  map[string]*PathItem
	Extensions map[string]any
	// contains filtered or unexported fields
}

func NewPaths

func NewPaths(paths *low.Paths) *Paths

func (*Paths) GoLow

func (p *Paths) GoLow() *low.Paths

type Response

type Response struct {
	Description string
	Schema      *base.SchemaProxy
	Headers     map[string]*Header
	Examples    *Examples
	Extensions  map[string]any
	// contains filtered or unexported fields
}

func NewResponse

func NewResponse(response *low.Response) *Response

func (*Response) GoLow

func (r *Response) GoLow() *low.Response

type Responses

type Responses struct {
	Codes      map[string]*Response
	Default    *Response
	Extensions map[string]any
	// contains filtered or unexported fields
}

func NewResponses

func NewResponses(responses *low.Responses) *Responses

func (*Responses) GoLow

func (r *Responses) GoLow() *low.Responses

type ResponsesDefinitions

type ResponsesDefinitions struct {
	Definitions map[string]*Response
	// contains filtered or unexported fields
}

func NewResponsesDefinitions

func NewResponsesDefinitions(responsesDefinitions *low.ResponsesDefinitions) *ResponsesDefinitions

func (*ResponsesDefinitions) GoLow

type Scopes

type Scopes struct {
	Values map[string]string
	// contains filtered or unexported fields
}

func NewScopes

func NewScopes(scopes *low.Scopes) *Scopes

func (*Scopes) GoLow

func (s *Scopes) GoLow() *low.Scopes

type SecurityDefinitions

type SecurityDefinitions struct {
	Definitions map[string]*SecurityScheme
	// contains filtered or unexported fields
}

func NewSecurityDefinitions

func NewSecurityDefinitions(definitions *low.SecurityDefinitions) *SecurityDefinitions

func (*SecurityDefinitions) GoLow

type SecurityRequirement

type SecurityRequirement struct {
	Requirements map[string][]string
	// contains filtered or unexported fields
}

func NewSecurityRequirement

func NewSecurityRequirement(req *low.SecurityRequirement) *SecurityRequirement

func (*SecurityRequirement) GoLow

type SecurityScheme

type SecurityScheme struct {
	Type             string
	Description      string
	Name             string
	In               string
	Flow             string
	AuthorizationUrl string
	TokenUrl         string
	Scopes           *Scopes
	Extensions       map[string]any
	// contains filtered or unexported fields
}

func NewSecurityScheme

func NewSecurityScheme(securityScheme *low.SecurityScheme) *SecurityScheme

func (*SecurityScheme) GoLow

func (s *SecurityScheme) GoLow() *low.SecurityScheme

type Swagger

type Swagger struct {
	Swagger             string
	Info                *base.Info
	Host                string
	BasePath            string
	Schemes             []string
	Consumes            []string
	Produces            []string
	Paths               *Paths
	Definitions         *Definitions
	Parameters          *ParameterDefinitions
	Responses           *ResponsesDefinitions
	SecurityDefinitions *SecurityDefinitions
	Security            []*SecurityRequirement
	Tags                []*base.Tag
	ExternalDocs        *base.ExternalDoc
	Extensions          map[string]any
	// contains filtered or unexported fields
}

func NewSwaggerDocument

func NewSwaggerDocument(document *low.Swagger) *Swagger

func (*Swagger) GoLow

func (s *Swagger) GoLow() *low.Swagger

Jump to

Keyboard shortcuts

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