Versions in this module Expand all Collapse all v0 v0.16.2 Jun 10, 2024 Changes in this version + const DefaultLabel + const DefinitionsLabel + const DeleteLabel + const ExamplesLabel + const GetLabel + const HeadLabel + const HeadersLabel + const ItemsLabel + const OptionsLabel + const ParametersLabel + const PatchLabel + const PathsLabel + const PostLabel + const PutLabel + const ResponsesLabel + const ScopesLabel + const SecurityDefinitionsLabel + const SecurityLabel + type Definitions struct + Schemas *orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.SchemaProxy]] + func (d *Definitions) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (d *Definitions) FindSchema(schema string) *low.ValueReference[*base.SchemaProxy] + func (d *Definitions) Hash() [32]byte + type Examples struct + Values *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (e *Examples) Build(_ context.Context, _, root *yaml.Node, _ *index.SpecIndex) error + func (e *Examples) FindExample(name string) *low.ValueReference[*yaml.Node] + func (e *Examples) Hash() [32]byte + type Header struct + CollectionFormat low.NodeReference[string] + Default low.NodeReference[*yaml.Node] + Description low.NodeReference[string] + Enum low.NodeReference[[]low.ValueReference[*yaml.Node]] + ExclusiveMaximum low.NodeReference[bool] + ExclusiveMinimum low.NodeReference[bool] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Format low.NodeReference[string] + Items low.NodeReference[*Items] + MaxItems low.NodeReference[int] + MaxLength low.NodeReference[int] + Maximum low.NodeReference[int] + MinItems low.NodeReference[int] + MinLength low.NodeReference[int] + Minimum low.NodeReference[int] + MultipleOf low.NodeReference[int] + Pattern low.NodeReference[string] + Type low.NodeReference[string] + UniqueItems low.NodeReference[bool] + func (h *Header) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (h *Header) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (h *Header) GetCollectionFormat() *low.NodeReference[string] + func (h *Header) GetDefault() *low.NodeReference[*yaml.Node] + func (h *Header) GetDescription() *low.NodeReference[string] + func (h *Header) GetEnum() *low.NodeReference[[]low.ValueReference[*yaml.Node]] + func (h *Header) GetExclusiveMaximum() *low.NodeReference[bool] + func (h *Header) GetExclusiveMinimum() *low.NodeReference[bool] + func (h *Header) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (h *Header) GetFormat() *low.NodeReference[string] + func (h *Header) GetItems() *low.NodeReference[any] + func (h *Header) GetMaxItems() *low.NodeReference[int] + func (h *Header) GetMaxLength() *low.NodeReference[int] + func (h *Header) GetMaximum() *low.NodeReference[int] + func (h *Header) GetMinItems() *low.NodeReference[int] + func (h *Header) GetMinLength() *low.NodeReference[int] + func (h *Header) GetMinimum() *low.NodeReference[int] + func (h *Header) GetMultipleOf() *low.NodeReference[int] + func (h *Header) GetPattern() *low.NodeReference[string] + func (h *Header) GetType() *low.NodeReference[string] + func (h *Header) GetUniqueItems() *low.NodeReference[bool] + func (h *Header) Hash() [32]byte + type Items struct + CollectionFormat low.NodeReference[string] + Default low.NodeReference[*yaml.Node] + Enum low.NodeReference[[]low.ValueReference[*yaml.Node]] + ExclusiveMaximum low.NodeReference[bool] + ExclusiveMinimum low.NodeReference[bool] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Format low.NodeReference[string] + Items low.NodeReference[*Items] + MaxItems low.NodeReference[int] + MaxLength low.NodeReference[int] + Maximum low.NodeReference[int] + MinItems low.NodeReference[int] + MinLength low.NodeReference[int] + Minimum low.NodeReference[int] + MultipleOf low.NodeReference[int] + Pattern low.NodeReference[string] + Type low.NodeReference[string] + UniqueItems low.NodeReference[bool] + func (i *Items) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (i *Items) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (i *Items) GetCollectionFormat() *low.NodeReference[string] + func (i *Items) GetDefault() *low.NodeReference[*yaml.Node] + func (i *Items) GetDescription() *low.NodeReference[string] + func (i *Items) GetEnum() *low.NodeReference[[]low.ValueReference[*yaml.Node]] + func (i *Items) GetExclusiveMaximum() *low.NodeReference[bool] + func (i *Items) GetExclusiveMinimum() *low.NodeReference[bool] + func (i *Items) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (i *Items) GetFormat() *low.NodeReference[string] + func (i *Items) GetItems() *low.NodeReference[any] + func (i *Items) GetMaxItems() *low.NodeReference[int] + func (i *Items) GetMaxLength() *low.NodeReference[int] + func (i *Items) GetMaximum() *low.NodeReference[int] + func (i *Items) GetMinItems() *low.NodeReference[int] + func (i *Items) GetMinLength() *low.NodeReference[int] + func (i *Items) GetMinimum() *low.NodeReference[int] + func (i *Items) GetMultipleOf() *low.NodeReference[int] + func (i *Items) GetPattern() *low.NodeReference[string] + func (i *Items) GetType() *low.NodeReference[string] + func (i *Items) GetUniqueItems() *low.NodeReference[bool] + func (i *Items) Hash() [32]byte + type Operation struct + Consumes low.NodeReference[[]low.ValueReference[string]] + Deprecated low.NodeReference[bool] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + ExternalDocs low.NodeReference[*base.ExternalDoc] + OperationId low.NodeReference[string] + Parameters low.NodeReference[[]low.ValueReference[*Parameter]] + Produces low.NodeReference[[]low.ValueReference[string]] + Responses low.NodeReference[*Responses] + Schemes low.NodeReference[[]low.ValueReference[string]] + Security low.NodeReference[[]low.ValueReference[*base.SecurityRequirement]] + Summary low.NodeReference[string] + Tags low.NodeReference[[]low.ValueReference[string]] + func (o *Operation) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (o *Operation) GetConsumes() low.NodeReference[[]low.ValueReference[string]] + func (o *Operation) GetDeprecated() low.NodeReference[bool] + func (o *Operation) GetDescription() low.NodeReference[string] + func (o *Operation) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (o *Operation) GetExternalDocs() low.NodeReference[any] + func (o *Operation) GetOperationId() low.NodeReference[string] + func (o *Operation) GetParameters() low.NodeReference[any] + func (o *Operation) GetProduces() low.NodeReference[[]low.ValueReference[string]] + func (o *Operation) GetResponses() low.NodeReference[any] + func (o *Operation) GetSchemes() low.NodeReference[[]low.ValueReference[string]] + func (o *Operation) GetSecurity() low.NodeReference[any] + func (o *Operation) GetSummary() low.NodeReference[string] + func (o *Operation) GetTags() low.NodeReference[[]low.ValueReference[string]] + func (o *Operation) Hash() [32]byte + type Parameter struct + AllowEmptyValue low.NodeReference[bool] + CollectionFormat low.NodeReference[string] + Default low.NodeReference[*yaml.Node] + Description low.NodeReference[string] + Enum low.NodeReference[[]low.ValueReference[*yaml.Node]] + ExclusiveMaximum low.NodeReference[bool] + ExclusiveMinimum low.NodeReference[bool] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Format low.NodeReference[string] + In low.NodeReference[string] + Items low.NodeReference[*Items] + MaxItems low.NodeReference[int] + MaxLength low.NodeReference[int] + Maximum low.NodeReference[int] + MinItems low.NodeReference[int] + MinLength low.NodeReference[int] + Minimum low.NodeReference[int] + MultipleOf low.NodeReference[int] + Name low.NodeReference[string] + Pattern low.NodeReference[string] + Required low.NodeReference[bool] + Schema low.NodeReference[*base.SchemaProxy] + Type low.NodeReference[string] + UniqueItems low.NodeReference[bool] + func (p *Parameter) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (p *Parameter) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (p *Parameter) GetAllowEmptyValue() *low.NodeReference[bool] + func (p *Parameter) GetCollectionFormat() *low.NodeReference[string] + func (p *Parameter) GetDefault() *low.NodeReference[*yaml.Node] + func (p *Parameter) GetDescription() *low.NodeReference[string] + func (p *Parameter) GetEnum() *low.NodeReference[[]low.ValueReference[*yaml.Node]] + func (p *Parameter) GetExclusiveMaximum() *low.NodeReference[bool] + func (p *Parameter) GetExclusiveMinimum() *low.NodeReference[bool] + func (p *Parameter) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (p *Parameter) GetFormat() *low.NodeReference[string] + func (p *Parameter) GetIn() *low.NodeReference[string] + func (p *Parameter) GetItems() *low.NodeReference[any] + func (p *Parameter) GetMaxItems() *low.NodeReference[int] + func (p *Parameter) GetMaxLength() *low.NodeReference[int] + func (p *Parameter) GetMaximum() *low.NodeReference[int] + func (p *Parameter) GetMinItems() *low.NodeReference[int] + func (p *Parameter) GetMinLength() *low.NodeReference[int] + func (p *Parameter) GetMinimum() *low.NodeReference[int] + func (p *Parameter) GetMultipleOf() *low.NodeReference[int] + func (p *Parameter) GetName() *low.NodeReference[string] + func (p *Parameter) GetPattern() *low.NodeReference[string] + func (p *Parameter) GetRequired() *low.NodeReference[bool] + func (p *Parameter) GetSchema() *low.NodeReference[any] + func (p *Parameter) GetType() *low.NodeReference[string] + func (p *Parameter) GetUniqueItems() *low.NodeReference[bool] + func (p *Parameter) Hash() [32]byte + type ParameterDefinitions struct + Definitions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*Parameter]] + func (pd *ParameterDefinitions) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (pd *ParameterDefinitions) FindParameter(parameter string) *low.ValueReference[*Parameter] + type PathItem struct + Delete low.NodeReference[*Operation] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Get low.NodeReference[*Operation] + Head low.NodeReference[*Operation] + Options low.NodeReference[*Operation] + Parameters low.NodeReference[[]low.ValueReference[*Parameter]] + Patch low.NodeReference[*Operation] + Post low.NodeReference[*Operation] + Put low.NodeReference[*Operation] + Ref low.NodeReference[string] + func (p *PathItem) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (p *PathItem) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (p *PathItem) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (p *PathItem) Hash() [32]byte + type Paths struct + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + PathItems *orderedmap.Map[low.KeyReference[string], low.ValueReference[*PathItem]] + func (p *Paths) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (p *Paths) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (p *Paths) FindPath(path string) (result *low.ValueReference[*PathItem]) + func (p *Paths) FindPathAndKey(path string) (key *low.KeyReference[string], value *low.ValueReference[*PathItem]) + func (p *Paths) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (p *Paths) Hash() [32]byte + type Response struct + Description low.NodeReference[string] + Examples low.NodeReference[*Examples] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Headers low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Header]]] + Schema low.NodeReference[*base.SchemaProxy] + func (r *Response) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (r *Response) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (r *Response) FindHeader(hType string) *low.ValueReference[*Header] + func (r *Response) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (r *Response) Hash() [32]byte + type Responses struct + Codes *orderedmap.Map[low.KeyReference[string], low.ValueReference[*Response]] + Default low.NodeReference[*Response] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (r *Responses) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (r *Responses) FindResponseByCode(code string) *low.ValueReference[*Response] + func (r *Responses) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (r *Responses) Hash() [32]byte + type ResponsesDefinitions struct + Definitions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*Response]] + func (r *ResponsesDefinitions) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (r *ResponsesDefinitions) FindResponse(response string) *low.ValueReference[*Response] + type Scopes struct + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Values *orderedmap.Map[low.KeyReference[string], low.ValueReference[string]] + func (s *Scopes) Build(_ context.Context, _, root *yaml.Node, _ *index.SpecIndex) error + func (s *Scopes) FindScope(scope string) *low.ValueReference[string] + func (s *Scopes) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (s *Scopes) Hash() [32]byte + type SecurityDefinitions struct + Definitions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*SecurityScheme]] + func (s *SecurityDefinitions) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (s *SecurityDefinitions) FindSecurityDefinition(securityDef string) *low.ValueReference[*SecurityScheme] + type SecurityScheme struct + AuthorizationUrl low.NodeReference[string] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Flow low.NodeReference[string] + In low.NodeReference[string] + Name low.NodeReference[string] + Scopes low.NodeReference[*Scopes] + TokenUrl low.NodeReference[string] + Type low.NodeReference[string] + func (ss *SecurityScheme) Build(ctx context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (ss *SecurityScheme) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (ss *SecurityScheme) Hash() [32]byte + type Swagger struct + BasePath low.NodeReference[string] + Consumes low.NodeReference[[]low.ValueReference[string]] + Definitions low.NodeReference[*Definitions] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + ExternalDocs low.NodeReference[*base.ExternalDoc] + Host low.NodeReference[string] + Index *index.SpecIndex + Info low.NodeReference[*base.Info] + Parameters low.NodeReference[*ParameterDefinitions] + Paths low.NodeReference[*Paths] + Produces low.NodeReference[[]low.ValueReference[string]] + Responses low.NodeReference[*ResponsesDefinitions] + Rolodex *index.Rolodex + Schemes low.NodeReference[[]low.ValueReference[string]] + Security low.NodeReference[[]low.ValueReference[*base.SecurityRequirement]] + SecurityDefinitions low.NodeReference[*SecurityDefinitions] + SpecInfo *datamodel.SpecInfo + Swagger low.ValueReference[string] + Tags low.NodeReference[[]low.ValueReference[*base.Tag]] + func CreateDocumentFromConfig(info *datamodel.SpecInfo, configuration *datamodel.DocumentConfiguration) (*Swagger, error) + func (s *Swagger) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (s *Swagger) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (s *Swagger) GetExternalDocs() *low.NodeReference[any]