helpinfo

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CustomRenderSignatures 

func CustomRenderSignatures(signatures []*lsp.SignatureInformation) string

CustomRenderSignatures renders a list of signatures as a markdown string.

func FormatLinkCardinality added in v0.2.0 

func FormatLinkCardinality(c provider.LinkCardinality) string

FormatLinkCardinality renders a provider.LinkCardinality as a short human-readable range (e.g. "exactly 1", "at least 2", "at most 5", "1..3", "unconstrained").

func RenderAnnotationKeyInfo added in v0.2.0 

func RenderAnnotationKeyInfo(annotationKey string, annotationValue string) string

RenderAnnotationKeyInfo renders basic annotation key information as a fallback when a link annotation definition is not found.

func RenderAnnotationsDefinition added in v0.2.0 

func RenderAnnotationsDefinition() string

RenderAnnotationsDefinition renders a schema definition for an annotations map.

func RenderBasicDataSourceInfo 

func RenderBasicDataSourceInfo(
	dataSourceName string,
	dataSource *schema.DataSource,
) string

RenderBasicDataSourceInfo renders basic data source information for use in help info.

func RenderBasicResourceInfo 

func RenderBasicResourceInfo(resourceName string, resource *schema.Resource) string

RenderBasicResourceInfo renders basic resource information for use in help info.

func RenderByLabelDefinition added in v0.2.0 

func RenderByLabelDefinition() string

RenderByLabelDefinition renders a schema definition for a byLabel selector.

func RenderByLabelHoverContent added in v0.2.0 

func RenderByLabelHoverContent(
	labelKey string,
	labelValue string,
	matchingResources []MatchingResourceInfo,
) string

RenderByLabelHoverContent renders hover content for a byLabel selector, showing the base definition, optional focused label key, and matching resources.

func RenderChildExportFieldInfo added in v0.2.0 

func RenderChildExportFieldInfo(
	fieldName string,
	childRef *substitutions.SubstitutionChild,
	exportType string,
	exportField string,
	exportDescription string,
) string

RenderChildExportFieldInfo renders enriched hover information for a child blueprint exported field, showing the export's type, field path, and description.

func RenderChildInfo 

func RenderChildInfo(childName string, child *schema.Include) string

RenderChildInfo renders child blueprint information for use in help info.

func RenderChildPathItemInfo added in v0.2.0 

func RenderChildPathItemInfo(
	fieldName string,
	childRef *substitutions.SubstitutionChild,
	pathItem *substitutions.SubstitutionPathItem,
) string

RenderChildPathItemInfo renders path item information for child references.

func RenderDataSourceExportFieldDefinition added in v0.2.0 

func RenderDataSourceExportFieldDefinition(
	fieldName string,
	ds *schema.DataSource,
	export *schema.DataSourceFieldExport,
	specSchema *provider.DataSourceSpecSchema,
) string

RenderDataSourceExportFieldDefinition renders a data source export field definition without requiring a substitution reference. When specSchema is provided, it shows the provider-sourced field definition; otherwise falls back to the blueprint-level description.

func RenderDataSourceFieldInfo 

func RenderDataSourceFieldInfo(
	dataSourceName string,
	dataSource *schema.DataSource,
	dataSourceRef *substitutions.SubstitutionDataSourceProperty,
	dataSourceField *schema.DataSourceFieldExport,
) string

RenderDataSourceFieldInfo renders data source field information for use in help info.

func RenderDataSourceFieldTypeDefinition added in v0.2.0 

func RenderDataSourceFieldTypeDefinition(fieldType string) string

RenderDataSourceFieldTypeDefinition renders hover info for a data source export field type.

func RenderDataSourceFilterDefinition added in v0.2.0 

func RenderDataSourceFilterDefinition(filter *schema.DataSourceFilter) string

RenderDataSourceFilterDefinition renders hover info for a data source filter.

func RenderDataSourceFilterFieldKeyDefinition added in v0.2.0 

func RenderDataSourceFilterFieldKeyDefinition(
	fieldValue string,
	filterSchema *provider.DataSourceFilterSchema,
) string

RenderDataSourceFilterFieldKeyDefinition renders hover info for the "field" key within a data source filter, showing the field value and optional provider-sourced field definition.

func RenderDataSourceFilterOperatorDefinition added in v0.2.0 

func RenderDataSourceFilterOperatorDefinition(operator string) string

RenderDataSourceFilterOperatorDefinition renders hover info for a filter operator.

func RenderDataSourceFilterSearchDefinition added in v0.2.0 

func RenderDataSourceFilterSearchDefinition() string

RenderDataSourceFilterSearchDefinition renders hover info for a filter search field.

func RenderDataSourceHoverInfo added in v0.2.0 

func RenderDataSourceHoverInfo(name string, ds *schema.DataSource) string

RenderDataSourceHoverInfo renders a schema definition for a data source combined with contextual type and description info.

func RenderElemIndexRefInfo 

func RenderElemIndexRefInfo(
	resourceName string,
	resource *schema.Resource,
) string

RenderElemIndexRefInfo renders element index reference information for use in help info.

func RenderElemRefInfo 

func RenderElemRefInfo(
	resourceName string,
	resource *schema.Resource,
	elemRef *substitutions.SubstitutionElemReference,
) string

RenderElemRefInfo renders element reference information for use in help info.

func RenderExcludeDefinition added in v0.2.0 

func RenderExcludeDefinition() string

RenderExcludeDefinition renders a schema definition for an exclude list.

func RenderExportHoverInfo added in v0.2.0 

func RenderExportHoverInfo(name string, export *schema.Export) string

RenderExportHoverInfo renders a schema definition for an export combined with contextual type, field, and description info.

func RenderFieldDefinition added in v0.2.0 

func RenderFieldDefinition(fieldName string, parentContext string) string

RenderFieldDefinition renders a schema definition for a known blueprint field, contextualised by the parent element type (e.g. "resource", "variable").

func RenderIncludeHoverInfo added in v0.2.0 

func RenderIncludeHoverInfo(name string, include *schema.Include) string

RenderIncludeHoverInfo renders a schema definition for an include (child blueprint) combined with contextual path and description info.

func RenderLabelsDefinition added in v0.2.0 

func RenderLabelsDefinition() string

RenderLabelsDefinition renders a schema definition for a labels map.

func RenderLinkAnnotationDefinition added in v0.2.0 

func RenderLinkAnnotationDefinition(
	annotationKey string,
	def *provider.LinkAnnotationDefinition,
	cardinality *LinkCardinalityInfo,
) string

RenderLinkAnnotationDefinition renders a link annotation definition with type, description, allowed values, and default.

func RenderLinkSelectorDefinition added in v0.2.0 

func RenderLinkSelectorDefinition() string

RenderLinkSelectorDefinition renders a schema definition for a link selector.

func RenderLinkSelectorHoverContent added in v0.2.0 

func RenderLinkSelectorHoverContent(targets []LinkSelectorTargetInfo) string

RenderLinkSelectorHoverContent renders hover content for a linkSelector, showing the base definition and the list of resources the selecting resource will link to, along with per-target outgoing link cardinality.

func RenderMetadataDefinition added in v0.2.0 

func RenderMetadataDefinition(parentContext string) string

RenderMetadataDefinition renders a schema definition for a metadata section.

func RenderMetadataFieldDefinition added in v0.2.0 

func RenderMetadataFieldDefinition(fieldName string) string

RenderMetadataFieldDefinition renders a schema definition for a specific field within a metadata section.

func RenderPathItemFieldInfo added in v0.2.0 

func RenderPathItemFieldInfo(
	fieldName string,
	specFieldSchema *provider.ResourceDefinitionsSchema,
) string

RenderPathItemFieldInfo renders path item field information from a resource spec schema.

func RenderResourceDefinitionFieldInfo 

func RenderResourceDefinitionFieldInfo(
	resourceName string,
	resource *schema.Resource,
	resRef *substitutions.SubstitutionResourceProperty,
	specFieldSchema *provider.ResourceDefinitionsSchema,
) string

RenderResourceDefinitionFieldInfo renders resource definition field information for use in help info.

func RenderResourceHoverInfo added in v0.2.0 

func RenderResourceHoverInfo(name string, resource *schema.Resource) string

RenderResourceHoverInfo renders a schema definition for a resource combined with contextual type and description info.

func RenderResourceMetadataFieldInfo added in v0.2.0 

func RenderResourceMetadataFieldInfo(
	resourceName string,
	resource *schema.Resource,
	resRef *substitutions.SubstitutionResourceProperty,
) string

RenderResourceMetadataFieldInfo renders resource metadata field information for use in help info.

func RenderResourceMetadataPathItemInfo added in v0.2.0 

func RenderResourceMetadataPathItemInfo(
	fieldName string,
	resRef *substitutions.SubstitutionResourceProperty,
	pathItemIndex int,
) string

RenderResourceMetadataPathItemInfo renders path item information for resource metadata fields.

func RenderSectionDefinition added in v0.2.0 

func RenderSectionDefinition(sectionName string) string

RenderSectionDefinition renders a schema definition for a top-level section.

func RenderSpecFieldDefinition added in v0.2.0 

func RenderSpecFieldDefinition(
	fieldName string,
	specFieldSchema *provider.ResourceDefinitionsSchema,
) string

RenderSpecFieldDefinition renders a provider-sourced field definition with type and description.

func RenderValueHoverInfo added in v0.2.0 

func RenderValueHoverInfo(name string, value *schema.Value) string

RenderValueHoverInfo renders a schema definition for a value combined with contextual type and description info.

func RenderValueInfo 

func RenderValueInfo(valueName string, value *schema.Value) string

RenderValueInfo renders value information for use in help info.

func RenderValuePathItemInfo added in v0.2.0 

func RenderValuePathItemInfo(
	fieldName string,
	valRef *substitutions.SubstitutionValueReference,
	pathItem *substitutions.SubstitutionPathItem,
) string

RenderValuePathItemInfo renders path item information for value references.

func RenderVariableHoverInfo added in v0.2.0 

func RenderVariableHoverInfo(name string, variable *schema.Variable) string

RenderVariableHoverInfo renders a schema definition for a variable combined with contextual type and description info.

func RenderVariableInfo 

func RenderVariableInfo(varName string, variable *schema.Variable) string

RenderVariableInfo renders variable information for use in help info.

Types

type LinkCardinalityInfo added in v0.2.0 

type LinkCardinalityInfo struct {
	TypeA        string
	TypeB        string
	CardinalityA provider.LinkCardinality
	CardinalityB provider.LinkCardinality
}

LinkCardinalityInfo carries the cardinality of a link in both directions along with the resource types on each side. It is passed to renderers so cardinality can be surfaced alongside annotation definitions.

type LinkSelectorTargetInfo added in v0.2.0 

type LinkSelectorTargetInfo struct {
	Name         string
	ResourceType string
	Cardinality  *provider.LinkCardinality
}

LinkSelectorTargetInfo describes a single resource that a linkSelector will link to, with the outgoing-link cardinality from the selecting resource. Cardinality may be nil when no link is registered between the pair of resource types.

type MatchingResourceInfo added in v0.2.0 

type MatchingResourceInfo struct {
	Name         string
	ResourceType string
	Linked       bool
	// Cardinality describes how many targets of this type the selecting
	// resource may link to. Nil when no link is registered for the pair.
	Cardinality *provider.LinkCardinality
}

MatchingResourceInfo holds information about a resource that matches a byLabel selector.

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.