v3

package
v0.0.9 Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2022 License: MIT Imports: 10 Imported by: 13

Documentation

Index

Constants

View Source 
const (
	ComponentsLabel = "components"
	SchemasLabel    = "schemas"
)
View Source 
const (
	ImplicitLabel          = "implicit"
	PasswordLabel          = "password"
	ClientCredentialsLabel = "clientCredentials"
	AuthorizationCodeLabel = "authorizationCode"
)
View Source 
const (
	ParametersLabel    = "parameters"
	RequestBodyLabel   = "requestBody"
	RequestBodiesLabel = "requestBodies"
	ResponsesLabel     = "responses"
	CallbacksLabel     = "callbacks"
)
View Source 
const (
	PathsLabel             = "paths"
	WebhooksLabel          = "webhooks"
	JSONSchemaDialectLabel = "jsonSchemaDialect"
	GetLabel               = "get"
	PostLabel              = "post"
	PatchLabel             = "patch"
	PutLabel               = "put"
	DeleteLabel            = "delete"
	OptionsLabel           = "options"
	HeadLabel              = "head"
	TraceLabel             = "trace"
)
View Source 
const (
	LinksLabel   = "links"
	DefaultLabel = "default"
)
View Source 
const (
	SecurityLabel        = "security"
	SecuritySchemesLabel = "securitySchemes"
	OAuthFlowsLabel      = "flows"
)
View Source 
const (
	VariablesLabel = "variables"
	ServersLabel   = "servers"
	ServerLabel    = "server"
)
View Source 
const (
	ContentLabel = "content"
)
View Source 
const (
	EncodingLabel = "encoding"
)
View Source 
const (
	HeadersLabel = "headers"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Callback 

type Callback struct {
	Expression low.ValueReference[map[low.KeyReference[string]]low.ValueReference[*PathItem]]
	Extensions map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Callback) Build 

func (cb *Callback) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Callback) FindExpression 

func (cb *Callback) FindExpression(exp string) *low.ValueReference[*PathItem]

type Components 

type Components struct {
	Schemas         low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*base.SchemaProxy]]
	Responses       low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Response]]
	Parameters      low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Parameter]]
	Examples        low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*base.Example]]
	RequestBodies   low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*RequestBody]]
	Headers         low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Header]]
	SecuritySchemes low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*SecurityScheme]]
	Links           low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Link]]
	Callbacks       low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Callback]]
	Extensions      map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Components) Build 

func (co *Components) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Components) FindCallback 

func (co *Components) FindCallback(callback string) *low.ValueReference[*Callback]

func (*Components) FindExample 

func (co *Components) FindExample(example string) *low.ValueReference[*base.Example]

func (*Components) FindExtension 

func (co *Components) FindExtension(ext string) *low.ValueReference[any]

func (*Components) FindHeader 

func (co *Components) FindHeader(header string) *low.ValueReference[*Header]
func (co *Components) FindLink(link string) *low.ValueReference[*Link]

func (*Components) FindParameter 

func (co *Components) FindParameter(response string) *low.ValueReference[*Parameter]

func (*Components) FindRequestBody 

func (co *Components) FindRequestBody(requestBody string) *low.ValueReference[*RequestBody]

func (*Components) FindResponse 

func (co *Components) FindResponse(response string) *low.ValueReference[*Response]

func (*Components) FindSchema 

func (co *Components) FindSchema(schema string) *low.ValueReference[*base.SchemaProxy]

func (*Components) FindSecurityScheme 

func (co *Components) FindSecurityScheme(sScheme string) *low.ValueReference[*SecurityScheme]

type Document 

type Document struct {
	Version           low.ValueReference[string]
	Info              low.NodeReference[*base.Info]
	JsonSchemaDialect low.NodeReference[string]                                                     // 3.1
	Webhooks          low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*PathItem]] // 3.1
	Servers           low.NodeReference[[]low.ValueReference[*Server]]
	Paths             low.NodeReference[*Paths]
	Components        low.NodeReference[*Components]
	Security          low.NodeReference[*SecurityRequirement]
	Tags              low.NodeReference[[]low.ValueReference[*base.Tag]]
	ExternalDocs      low.NodeReference[*base.ExternalDoc]
	Extensions        map[low.KeyReference[string]]low.ValueReference[any]
	Index             *index.SpecIndex
}

func CreateDocument 

func CreateDocument(info *datamodel.SpecInfo) (*Document, []error)

type Encoding 

type Encoding struct {
	ContentType   low.NodeReference[string]
	Headers       low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Header]]
	Style         low.NodeReference[string]
	Explode       low.NodeReference[bool]
	AllowReserved low.NodeReference[bool]
}

func (*Encoding) Build 

func (en *Encoding) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Encoding) FindHeader 

func (en *Encoding) FindHeader(hType string) *low.ValueReference[*Header]
type Header struct {
	Description     low.NodeReference[string]
	Required        low.NodeReference[bool]
	Deprecated      low.NodeReference[bool]
	AllowEmptyValue low.NodeReference[bool]
	Style           low.NodeReference[string]
	Explode         low.NodeReference[bool]
	AllowReserved   low.NodeReference[bool]
	Schema          low.NodeReference[*base.SchemaProxy]
	Example         low.NodeReference[any]
	Examples        low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*base.Example]]
	Content         low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*MediaType]]
	Extensions      map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Header) Build 

func (h *Header) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Header) FindContent 

func (h *Header) FindContent(ext string) *low.ValueReference[*MediaType]

func (*Header) FindExample 

func (h *Header) FindExample(eType string) *low.ValueReference[*base.Example]

func (*Header) FindExtension 

func (h *Header) FindExtension(ext string) *low.ValueReference[any]
type Link struct {
	OperationRef low.NodeReference[string]
	OperationId  low.NodeReference[string]
	Parameters   low.KeyReference[map[low.KeyReference[string]]low.ValueReference[string]]
	RequestBody  low.NodeReference[string]
	Description  low.NodeReference[string]
	Server       low.NodeReference[*Server]
	Extensions   map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Link) Build 

func (l *Link) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Link) FindExtension 

func (l *Link) FindExtension(ext string) *low.ValueReference[any]

func (*Link) FindParameter 

func (l *Link) FindParameter(pName string) *low.ValueReference[string]

type MediaType 

type MediaType struct {
	Schema     low.NodeReference[*base.SchemaProxy]
	Example    low.NodeReference[any]
	Examples   low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*base.Example]]
	Encoding   low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Encoding]]
	Extensions map[low.KeyReference[string]]low.ValueReference[any]
}

func (*MediaType) Build 

func (mt *MediaType) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*MediaType) FindExample 

func (mt *MediaType) FindExample(eType string) *low.ValueReference[*base.Example]

func (*MediaType) FindExtension 

func (mt *MediaType) FindExtension(ext string) *low.ValueReference[any]

func (*MediaType) FindPropertyEncoding 

func (mt *MediaType) FindPropertyEncoding(eType string) *low.ValueReference[*Encoding]

func (*MediaType) GetAllExamples 

func (mt *MediaType) GetAllExamples() map[low.KeyReference[string]]low.ValueReference[*base.Example]

type OAuthFlow 

type OAuthFlow struct {
	AuthorizationUrl low.NodeReference[string]
	TokenUrl         low.NodeReference[string]
	RefreshUrl       low.NodeReference[string]
	Scopes           low.KeyReference[map[low.KeyReference[string]]low.ValueReference[string]]
	Extensions       map[low.KeyReference[string]]low.ValueReference[any]
}

func (*OAuthFlow) Build 

func (o *OAuthFlow) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*OAuthFlow) FindExtension 

func (o *OAuthFlow) FindExtension(ext string) *low.ValueReference[any]

func (*OAuthFlow) FindScope 

func (o *OAuthFlow) FindScope(scope string) *low.ValueReference[string]

type OAuthFlows 

type OAuthFlows struct {
	Implicit          low.NodeReference[*OAuthFlow]
	Password          low.NodeReference[*OAuthFlow]
	ClientCredentials low.NodeReference[*OAuthFlow]
	AuthorizationCode low.NodeReference[*OAuthFlow]
	Extensions        map[low.KeyReference[string]]low.ValueReference[any]
}

func (*OAuthFlows) Build 

func (o *OAuthFlows) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*OAuthFlows) FindExtension 

func (o *OAuthFlows) FindExtension(ext string) *low.ValueReference[any]

type Operation 

type Operation struct {
	Tags         low.NodeReference[[]low.ValueReference[string]]
	Summary      low.NodeReference[string]
	Description  low.NodeReference[string]
	ExternalDocs low.NodeReference[*base.ExternalDoc]
	OperationId  low.NodeReference[string]
	Parameters   low.NodeReference[[]low.ValueReference[*Parameter]]
	RequestBody  low.NodeReference[*RequestBody]
	Responses    low.NodeReference[*Responses]
	Callbacks    low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Callback]]
	Deprecated   low.NodeReference[bool]
	Security     low.NodeReference[*SecurityRequirement]
	Servers      low.NodeReference[[]low.ValueReference[*Server]]
	Extensions   map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Operation) Build 

func (o *Operation) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Operation) FindCallback 

func (o *Operation) FindCallback(callback string) *low.ValueReference[*Callback]

type Parameter 

type Parameter struct {
	Name            low.NodeReference[string]
	In              low.NodeReference[string]
	Description     low.NodeReference[string]
	Required        low.NodeReference[bool]
	Deprecated      low.NodeReference[bool]
	AllowEmptyValue low.NodeReference[bool]
	Style           low.NodeReference[string]
	Explode         low.NodeReference[bool]
	AllowReserved   low.NodeReference[bool]
	Schema          low.NodeReference[*base.SchemaProxy]
	Example         low.NodeReference[any]
	Examples        low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*base.Example]]
	Content         low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*MediaType]]
	Extensions      map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Parameter) Build 

func (p *Parameter) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Parameter) FindContent 

func (p *Parameter) FindContent(cType string) *low.ValueReference[*MediaType]

func (*Parameter) FindExample 

func (p *Parameter) FindExample(eType string) *low.ValueReference[*base.Example]

func (*Parameter) FindExtension 

func (p *Parameter) FindExtension(ext string) *low.ValueReference[any]

type PathItem 

type PathItem struct {
	Description low.NodeReference[string]
	Summary     low.NodeReference[string]
	Get         low.NodeReference[*Operation]
	Put         low.NodeReference[*Operation]
	Post        low.NodeReference[*Operation]
	Delete      low.NodeReference[*Operation]
	Options     low.NodeReference[*Operation]
	Head        low.NodeReference[*Operation]
	Patch       low.NodeReference[*Operation]
	Trace       low.NodeReference[*Operation]
	Servers     low.NodeReference[[]low.ValueReference[*Server]]
	Parameters  low.NodeReference[[]low.ValueReference[*Parameter]]
	Extensions  map[low.KeyReference[string]]low.ValueReference[any]
}

func (*PathItem) Build 

func (p *PathItem) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*PathItem) FindExtension 

func (p *PathItem) FindExtension(ext string) *low.ValueReference[any]

type Paths 

type Paths struct {
	PathItems  map[low.KeyReference[string]]low.ValueReference[*PathItem]
	Extensions map[low.KeyReference[string]]low.ValueReference[any]
}

func (*Paths) Build 

func (p *Paths) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Paths) FindExtension 

func (p *Paths) FindExtension(ext string) *low.ValueReference[any]

func (*Paths) FindPath 

func (p *Paths) FindPath(path string) *low.ValueReference[*PathItem]

type RequestBody 

type RequestBody struct {
	Description low.NodeReference[string]
	Content     low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*MediaType]]
	Required    low.NodeReference[bool]
	Extensions  map[low.KeyReference[string]]low.ValueReference[any]
}

func (*RequestBody) Build 

func (rb *RequestBody) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*RequestBody) FindContent 

func (rb *RequestBody) FindContent(cType string) *low.ValueReference[*MediaType]

func (*RequestBody) FindExtension 

func (rb *RequestBody) FindExtension(ext string) *low.ValueReference[any]

type Response 

type Response struct {
	Description low.NodeReference[string]
	Headers     low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Header]]
	Content     low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*MediaType]]
	Extensions  map[low.KeyReference[string]]low.ValueReference[any]
	Links       low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Link]]
}

func (*Response) Build 

func (r *Response) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Response) FindContent 

func (r *Response) FindContent(cType string) *low.ValueReference[*MediaType]

func (*Response) FindExtension 

func (r *Response) FindExtension(ext string) *low.ValueReference[any]

func (*Response) FindHeader 

func (r *Response) FindHeader(hType string) *low.ValueReference[*Header]
func (r *Response) FindLink(hType string) *low.ValueReference[*Link]

type Responses 

type Responses struct {
	Codes   map[low.KeyReference[string]]low.ValueReference[*Response]
	Default low.NodeReference[*Response]
}

func (*Responses) Build 

func (r *Responses) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Responses) FindResponseByCode 

func (r *Responses) FindResponseByCode(code string) *low.ValueReference[*Response]

type SecurityRequirement 

type SecurityRequirement struct {
	ValueRequirements []low.ValueReference[map[low.KeyReference[string]][]low.ValueReference[string]]
}

func (*SecurityRequirement) Build 

func (sr *SecurityRequirement) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*SecurityRequirement) FindRequirement 

func (sr *SecurityRequirement) FindRequirement(name string) []low.ValueReference[string]

type SecurityScheme 

type SecurityScheme struct {
	Type             low.NodeReference[string]
	Description      low.NodeReference[string]
	Name             low.NodeReference[string]
	In               low.NodeReference[string]
	Scheme           low.NodeReference[string]
	BearerFormat     low.NodeReference[string]
	Flows            low.NodeReference[*OAuthFlows]
	OpenIdConnectUrl low.NodeReference[string]
	Extensions       map[low.KeyReference[string]]low.ValueReference[any]
}

func (*SecurityScheme) Build 

func (ss *SecurityScheme) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*SecurityScheme) FindExtension 

func (ss *SecurityScheme) FindExtension(ext string) *low.ValueReference[any]

type Server 

type Server struct {
	URL         low.NodeReference[string]
	Description low.NodeReference[string]
	Variables   low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*ServerVariable]]
}

func (*Server) Build 

func (s *Server) Build(root *yaml.Node, idx *index.SpecIndex) error

func (*Server) FindVariable 

func (s *Server) FindVariable(ext string) *low.ValueReference[*ServerVariable]

type ServerVariable 

type ServerVariable struct {
	Enum        []low.NodeReference[string]
	Default     low.NodeReference[string]
	Description low.NodeReference[string]
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.