Versions in this module Expand all Collapse all v0 v0.16.2 Jun 10, 2024 Changes in this version + const AdditionalPropertiesLabel + const AllOfLabel + const AllowEmptyValueLabel + const AllowReservedLabel + const AnchorLabel + const AnyOfLabel + const AttributeLabel + const AuthorizationCodeLabel + const AuthorizationUrlLabel + const BasePathLabel + const CallbacksLabel + const ClientCredentialsLabel + const CodesLabel + const CollectionFormatLabel + const ComponentsLabel + const ConstLabel + const ConsumesLabel + const ContactLabel + const ContainsLabel + const ContentEncodingLabel + const ContentLabel + const ContentMediaType + const ContentTypeLabel + const DefaultLabel + const DeleteLabel + const DependentSchemasLabel + const DeprecatedLabel + const DescriptionLabel + const DiscriminatorLabel + const ElseLabel + const EmailLabel + const EncodingLabel + const EnumLabel + const ExampleLabel + const ExamplesLabel + const ExclusiveMaximumLabel + const ExclusiveMinimumLabel + const ExplodeLabel + const ExpressionLabel + const ExternalDocsLabel + const ExternalValue + const FlowLabel + const FlowsLabel + const FormatLabel + const GetLabel + const HeadLabel + const HeadersLabel + const HostLabel + const IfLabel + const ImplicitLabel + const InLabel + const InfoLabel + const ItemsLabel + const JSONSchemaDialectLabel + const JSONSchemaLabel + const LicenseLabel + const LinksLabel + const MaxContainsLabel + const MaxItemsLabel + const MaxLengthLabel + const MaxPropertiesLabel + const MaximumLabel + const MinContainsLabel + const MinItemsLabel + const MinLengthLabel + const MinPropertiesLabel + const MinimumLabel + const MultipleOfLabel + const NameLabel + const NamespaceLabel + const NotLabel + const NullableLabel + const OAuthFlowsLabel + const OneOfLabel + const OpenAPILabel + const OpenIdConnectUrlLabel + const OperationIdLabel + const OperationRefLabel + const OptionsLabel + const ParametersLabel + const PasswordLabel + const PatchLabel + const PathLabel + const PathsLabel + const PatternLabel + const PatternPropertiesLabel + const PostLabel + const PrefixLabel + const ProducesLabel + const PropertiesLabel + const PropertyNameLabel + const PropertyNamesLabel + const PutLabel + const ReadOnlyLabel + const RefLabel + const RefreshUrlLabel + const RequestBodiesLabel + const RequestBodyLabel + const RequiredLabel + const ResponsesLabel + const SchemaDialectLabel + const SchemaLabel + const SchemasLabel + const SchemeLabel + const SchemesLabel + const Scopes + const ScopesLabel + const SecurityDefinitionLabel + const SecurityLabel + const SecuritySchemesLabel + const ServerLabel + const ServersLabel + const StyleLabel + const SummaryLabel + const SwaggerLabel + const TagsLabel + const TermsOfServiceLabel + const ThenLabel + const TitleLabel + const TokenUrlLabel + const TraceLabel + const TypeLabel + const URLLabel + const UnevaluatedItemsLabel + const UnevaluatedPropertiesLabel + const UniqueItemsLabel + const ValueLabel + const VariablesLabel + const VersionLabel + const WebhooksLabel + const WrappedLabel + const WriteOnlyLabel + const XMLLabel + type Callback struct + Expression *orderedmap.Map[low.KeyReference[string], low.ValueReference[*PathItem]] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + KeyNode *yaml.Node + RootNode *yaml.Node + func (cb *Callback) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (cb *Callback) FindExpression(exp string) *low.ValueReference[*PathItem] + func (cb *Callback) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (cb *Callback) Hash() [32]byte + type Components struct + Callbacks low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Callback]]] + Examples low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.Example]]] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Headers low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Header]]] + Links low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Link]]] + Parameters low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Parameter]]] + RequestBodies low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*RequestBody]]] + Responses low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Response]]] + Schemas low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.SchemaProxy]]] + SecuritySchemes low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*SecurityScheme]]] + func (co *Components) Build(ctx context.Context, root *yaml.Node, idx *index.SpecIndex) error + func (co *Components) FindCallback(callback string) *low.ValueReference[*Callback] + func (co *Components) FindExample(example string) *low.ValueReference[*base.Example] + func (co *Components) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (co *Components) FindHeader(header string) *low.ValueReference[*Header] + func (co *Components) FindLink(link string) *low.ValueReference[*Link] + func (co *Components) FindParameter(response string) *low.ValueReference[*Parameter] + func (co *Components) FindRequestBody(requestBody string) *low.ValueReference[*RequestBody] + func (co *Components) FindResponse(response string) *low.ValueReference[*Response] + func (co *Components) FindSchema(schema string) *low.ValueReference[*base.SchemaProxy] + func (co *Components) FindSecurityScheme(sScheme string) *low.ValueReference[*SecurityScheme] + func (co *Components) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (co *Components) Hash() [32]byte + type Document struct + Components low.NodeReference[*Components] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + ExternalDocs low.NodeReference[*base.ExternalDoc] + Index *index.SpecIndex + Info low.NodeReference[*base.Info] + JsonSchemaDialect low.NodeReference[string] + Paths low.NodeReference[*Paths] + Rolodex *index.Rolodex + Security low.NodeReference[[]low.ValueReference[*base.SecurityRequirement]] + Servers low.NodeReference[[]low.ValueReference[*Server]] + Tags low.NodeReference[[]low.ValueReference[*base.Tag]] + Version low.NodeReference[string] + Webhooks low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*PathItem]]] + func CreateDocument(info *datamodel.SpecInfo) (*Document, error) + func CreateDocumentFromConfig(info *datamodel.SpecInfo, config *datamodel.DocumentConfiguration) (*Document, error) + func (d *Document) FindSecurityRequirement(name string) []low.ValueReference[string] + func (d *Document) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (d *Document) GetExternalDocs() *low.NodeReference[any] + type Encoding struct + AllowReserved low.NodeReference[bool] + ContentType low.NodeReference[string] + Explode low.NodeReference[bool] + Headers low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Header]]] + KeyNode *yaml.Node + RootNode *yaml.Node + Style low.NodeReference[string] + func (en *Encoding) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (en *Encoding) FindHeader(hType string) *low.ValueReference[*Header] + func (en *Encoding) Hash() [32]byte + type Header struct + AllowEmptyValue low.NodeReference[bool] + AllowReserved low.NodeReference[bool] + Content low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*MediaType]]] + Deprecated low.NodeReference[bool] + Description low.NodeReference[string] + Example low.NodeReference[*yaml.Node] + Examples low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.Example]]] + Explode low.NodeReference[bool] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + KeyNode *yaml.Node + Required low.NodeReference[bool] + RootNode *yaml.Node + Schema low.NodeReference[*base.SchemaProxy] + Style low.NodeReference[string] + func (h *Header) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (h *Header) FindContent(ext string) *low.ValueReference[*MediaType] + func (h *Header) FindExample(eType string) *low.ValueReference[*base.Example] + func (h *Header) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (h *Header) GetAllowEmptyValue() *low.NodeReference[bool] + func (h *Header) GetAllowReserved() *low.NodeReference[bool] + func (h *Header) GetContent() *low.NodeReference[any] + func (h *Header) GetDeprecated() *low.NodeReference[bool] + func (h *Header) GetDescription() *low.NodeReference[string] + func (h *Header) GetExample() *low.NodeReference[*yaml.Node] + func (h *Header) GetExamples() *low.NodeReference[any] + func (h *Header) GetExplode() *low.NodeReference[bool] + func (h *Header) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (h *Header) GetRequired() *low.NodeReference[bool] + func (h *Header) GetSchema() *low.NodeReference[any] + func (h *Header) GetStyle() *low.NodeReference[string] + func (h *Header) Hash() [32]byte + type Link struct + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + KeyNode *yaml.Node + OperationId low.NodeReference[string] + OperationRef low.NodeReference[string] + Parameters low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[string]]] + RequestBody low.NodeReference[string] + RootNode *yaml.Node + Server low.NodeReference[*Server] + func (l *Link) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (l *Link) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (l *Link) FindParameter(pName string) *low.ValueReference[string] + func (l *Link) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (l *Link) Hash() [32]byte + type MediaType struct + Encoding low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Encoding]]] + Example low.NodeReference[*yaml.Node] + Examples low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.Example]]] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + KeyNode *yaml.Node + RootNode *yaml.Node + Schema low.NodeReference[*base.SchemaProxy] + func (mt *MediaType) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (mt *MediaType) FindExample(eType string) *low.ValueReference[*base.Example] + func (mt *MediaType) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (mt *MediaType) FindPropertyEncoding(eType string) *low.ValueReference[*Encoding] + func (mt *MediaType) GetAllExamples() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.Example]] + func (mt *MediaType) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (mt *MediaType) Hash() [32]byte + type OAuthFlow struct + AuthorizationUrl low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + RefreshUrl low.NodeReference[string] + Scopes low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[string]]] + TokenUrl low.NodeReference[string] + func (o *OAuthFlow) Build(_ context.Context, _, root *yaml.Node, idx *index.SpecIndex) error + func (o *OAuthFlow) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (o *OAuthFlow) FindScope(scope string) *low.ValueReference[string] + func (o *OAuthFlow) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (o *OAuthFlow) Hash() [32]byte + type OAuthFlows struct + AuthorizationCode low.NodeReference[*OAuthFlow] + ClientCredentials low.NodeReference[*OAuthFlow] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Implicit low.NodeReference[*OAuthFlow] + KeyNode *yaml.Node + Password low.NodeReference[*OAuthFlow] + RootNode *yaml.Node + func (o *OAuthFlows) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (o *OAuthFlows) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (o *OAuthFlows) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (o *OAuthFlows) Hash() [32]byte + type Operation struct + Callbacks low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Callback]]] + Deprecated low.NodeReference[bool] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + ExternalDocs low.NodeReference[*base.ExternalDoc] + KeyNode *yaml.Node + OperationId low.NodeReference[string] + Parameters low.NodeReference[[]low.ValueReference[*Parameter]] + RequestBody low.NodeReference[*RequestBody] + Responses low.NodeReference[*Responses] + RootNode *yaml.Node + Security low.NodeReference[[]low.ValueReference[*base.SecurityRequirement]] + Servers low.NodeReference[[]low.ValueReference[*Server]] + Summary low.NodeReference[string] + Tags low.NodeReference[[]low.ValueReference[string]] + func (o *Operation) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (o *Operation) FindCallback(callback string) *low.ValueReference[*Callback] + func (o *Operation) FindSecurityRequirement(name string) []low.ValueReference[string] + func (o *Operation) GetCallbacks() ... + 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) GetResponses() low.NodeReference[any] + func (o *Operation) GetSecurity() low.NodeReference[any] + func (o *Operation) GetServers() 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] + AllowReserved low.NodeReference[bool] + Content low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*MediaType]]] + Deprecated low.NodeReference[bool] + Description low.NodeReference[string] + Example low.NodeReference[*yaml.Node] + Examples low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*base.Example]]] + Explode low.NodeReference[bool] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + In low.NodeReference[string] + KeyNode *yaml.Node + Name low.NodeReference[string] + Required low.NodeReference[bool] + RootNode *yaml.Node + Schema low.NodeReference[*base.SchemaProxy] + Style low.NodeReference[string] + func (p *Parameter) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (p *Parameter) FindContent(cType string) *low.ValueReference[*MediaType] + func (p *Parameter) FindExample(eType string) *low.ValueReference[*base.Example] + func (p *Parameter) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (p *Parameter) GetAllowEmptyValue() *low.NodeReference[bool] + func (p *Parameter) GetAllowReserved() *low.NodeReference[bool] + func (p *Parameter) GetContent() *low.NodeReference[any] + func (p *Parameter) GetDeprecated() *low.NodeReference[bool] + func (p *Parameter) GetDescription() *low.NodeReference[string] + func (p *Parameter) GetExample() *low.NodeReference[*yaml.Node] + func (p *Parameter) GetExamples() *low.NodeReference[any] + func (p *Parameter) GetExplode() *low.NodeReference[bool] + func (p *Parameter) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (p *Parameter) GetIn() *low.NodeReference[string] + func (p *Parameter) GetName() *low.NodeReference[string] + func (p *Parameter) GetRequired() *low.NodeReference[bool] + func (p *Parameter) GetSchema() *low.NodeReference[any] + func (p *Parameter) GetStyle() *low.NodeReference[string] + func (p *Parameter) Hash() [32]byte + type PathItem struct + Delete low.NodeReference[*Operation] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Get low.NodeReference[*Operation] + Head low.NodeReference[*Operation] + KeyNode *yaml.Node + Options low.NodeReference[*Operation] + Parameters low.NodeReference[[]low.ValueReference[*Parameter]] + Patch low.NodeReference[*Operation] + Post low.NodeReference[*Operation] + Put low.NodeReference[*Operation] + RootNode *yaml.Node + Servers low.NodeReference[[]low.ValueReference[*Server]] + Summary low.NodeReference[string] + Trace low.NodeReference[*Operation] + func (p *PathItem) Build(ctx context.Context, keyNode, 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]] + KeyNode *yaml.Node + PathItems *orderedmap.Map[low.KeyReference[string], low.ValueReference[*PathItem]] + RootNode *yaml.Node + func (p *Paths) Build(ctx context.Context, keyNode, 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 RequestBody struct + Content low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*MediaType]]] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + KeyNode *yaml.Node + Required low.NodeReference[bool] + RootNode *yaml.Node + func (rb *RequestBody) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (rb *RequestBody) FindContent(cType string) *low.ValueReference[*MediaType] + func (rb *RequestBody) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (rb *RequestBody) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (rb *RequestBody) Hash() [32]byte + type Response struct + Content low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*MediaType]]] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Headers low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Header]]] + KeyNode *yaml.Node + Links low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*Link]]] + RootNode *yaml.Node + func (r *Response) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (r *Response) FindContent(cType string) *low.ValueReference[*MediaType] + func (r *Response) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (r *Response) FindHeader(hType string) *low.ValueReference[*Header] + func (r *Response) FindLink(hType string) *low.ValueReference[*Link] + 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]] + KeyNode *yaml.Node + RootNode *yaml.Node + func (r *Responses) Build(ctx context.Context, keyNode, 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 SecurityScheme struct + BearerFormat low.NodeReference[string] + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + Flows low.NodeReference[*OAuthFlows] + In low.NodeReference[string] + KeyNode *yaml.Node + Name low.NodeReference[string] + OpenIdConnectUrl low.NodeReference[string] + RootNode *yaml.Node + Scheme low.NodeReference[string] + Type low.NodeReference[string] + func (ss *SecurityScheme) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error + func (ss *SecurityScheme) FindExtension(ext string) *low.ValueReference[*yaml.Node] + func (ss *SecurityScheme) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (ss *SecurityScheme) Hash() [32]byte + type Server struct + Description low.NodeReference[string] + Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + KeyNode *yaml.Node + RootNode *yaml.Node + URL low.NodeReference[string] + Variables low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*ServerVariable]]] + func (s *Server) Build(_ context.Context, keyNode, root *yaml.Node, _ *index.SpecIndex) error + func (s *Server) FindVariable(serverVar string) *low.ValueReference[*ServerVariable] + func (s *Server) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] + func (s *Server) Hash() [32]byte + type ServerVariable struct + Default low.NodeReference[string] + Description low.NodeReference[string] + Enum []low.NodeReference[string] + func (s *ServerVariable) Hash() [32]byte
Go to main page