v2

package
v0.0.49 Latest Latest
Warning

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

Go to latest
Published: Mar 8, 2026 License: Apache-2.0 Imports: 4 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 *orderedmap.Map[string, *highbase.SchemaProxy]
	// contains filtered or unexported fields
}

type Example

type Example struct {
	Values *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}
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             []any
	MultipleOf       int
	Extensions       *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

type Items

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

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     []*base.SecurityRequirement
	Extensions   *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

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          *yaml.Node
	Maximum          *int
	ExclusiveMaximum *bool
	Minimum          *int
	ExclusiveMinimum *bool
	MaxLength        *int
	MinLength        *int
	Pattern          string
	MaxItems         *int
	MinItems         *int
	UniqueItems      *bool
	Enum             []*yaml.Node
	MultipleOf       *int
	Extensions       *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

type ParameterDefinitions

type ParameterDefinitions struct {
	Definitions *orderedmap.Map[string, *Parameter]
	// contains filtered or unexported fields
}

type PathItem

type PathItem struct {
	Ref        string
	Get        *Operation
	Put        *Operation
	Post       *Operation
	Delete     *Operation
	Options    *Operation
	Head       *Operation
	Patch      *Operation
	Parameters []*Parameter
	Extensions *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

type Paths

type Paths struct {
	PathItems  *orderedmap.Map[string, *PathItem]
	Extensions *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

type Response

type Response struct {
	Description string
	Schema      *base.SchemaProxy
	Headers     *orderedmap.Map[string, *Header]
	Examples    *Example
	Extensions  *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

type Responses

type Responses struct {
	Codes      *orderedmap.Map[string, *Response]
	Default    *Response
	Extensions *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

type ResponsesDefinitions

type ResponsesDefinitions struct {
	Definitions *orderedmap.Map[string, *Response]
	// contains filtered or unexported fields
}

type Scopes

type Scopes struct {
	Values *orderedmap.Map[string, string]
	// contains filtered or unexported fields
}

type SecurityDefinitions

type SecurityDefinitions struct {
	Definitions *orderedmap.Map[string, *SecurityScheme]
	// contains filtered or unexported fields
}

type SecurityScheme

type SecurityScheme struct {
	Type             string
	Description      string
	Name             string
	In               string
	Flow             string
	AuthorizationUrl string
	TokenUrl         string
	Scopes           *Scopes
	Extensions       *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

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            []*base.SecurityRequirement
	Tags                []*base.Tag
	ExternalDocs        *base.ExternalDoc
	Extensions          *orderedmap.Map[string, *yaml.Node]
	// contains filtered or unexported fields
}

Jump to

Keyboard shortcuts

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