Versions in this module Expand all Collapse all v0 v0.2.0 Apr 25, 2026 Changes in this version + var ErrInvalidPluginType = errors.New(...) + var ErrPluginMetadataNotFound = errors.New("plugin metadata not found, this is required to produce documentation") + type AttributeType struct + Nullable bool + type FunctionDefinition struct + Parameters []*FunctionParameter + Return *FunctionReturn + type FunctionParameter struct + AllowNullValue bool + Description string + ElementValueTypeDefinition *ValueTypeDefinition + Label string + MapValueTypeDefinition *ValueTypeDefinition + Name string + Optional bool + ParamType string + UnionValueTypeDefinitions []*ValueTypeDefinition + ValueTypeDefinition *ValueTypeDefinition + VariadicNamed bool + VariadicSingleType bool + type FunctionReturn struct + Description string + ElementValueTypeDefinition *ValueTypeDefinition + MapValueTypeDefinition *ValueTypeDefinition + ReturnType string + UnionValueTypeDefinitions []*ValueTypeDefinition + ValueTypeDefinition *ValueTypeDefinition + type PluginDocResourceSpec struct + DestroyBeforeCreate bool + IDField string + Schema *PluginDocResourceSpecSchema + TaggingSupport string + type PluginDocResourceSpecSchema struct + AllowedValues []*core.MappingNode + Attributes map[string]*PluginDocResourceSpecSchema + Computed bool + Default *core.MappingNode + Description string + Examples []*core.MappingNode + IgnoreDrift bool + Items *PluginDocResourceSpecSchema + Label string + MapValues *PluginDocResourceSpecSchema + MaxLength int + Maximum *core.ScalarValue + MinLength int + Minimum *core.ScalarValue + MustRecreate bool + Nullable bool + OneOf []*PluginDocResourceSpecSchema + Pattern string + Required []string + Sensitive bool + SortArrayByField string + TrackDrift bool + Type string + type PluginDocs struct + AbstractLinks []*PluginDocsLink + AbstractResources []*PluginDocsResource + Author string + Config *PluginDocsVersionConfig + CustomVarTypes []*PluginDocsCustomVarType + DataSources []*PluginDocsDataSource + Description string + DisplayName string + Functions []*PluginDocsFunction + ID string + Links []*PluginDocsLink + ProtocolVersions []string + Repository string + Resources []*PluginDocsResource + TransformName string + Version string + func GeneratePluginDocs(pluginID string, pluginInstance any, manager pluginservicev1.Manager, ...) (*PluginDocs, error) + type PluginDocsCustomVarType struct + Description string + Examples []string + Label string + Options map[string]*PluginDocsCustomVarTypeOption + Summary string + Type string + type PluginDocsCustomVarTypeOption struct + Description string + Label string + type PluginDocsDataSource struct + Description string + Examples []string + Label string + Specification *PluginDocsDataSourceSpec + Summary string + Type string + type PluginDocsDataSourceFieldSpec struct + Description string + Filterable bool + Nullable bool + Sensitive bool + Type string + type PluginDocsDataSourceFilterFieldSpec struct + ConflictsWith []string + Description string + SupportedOperators []string + Type string + type PluginDocsDataSourceSpec struct + Fields map[string]*PluginDocsDataSourceFieldSpec + FilterFields map[string]*PluginDocsDataSourceFilterFieldSpec + type PluginDocsFunction struct + Description string + Internal bool + Name string + Summary string + type PluginDocsLink struct + AnnotationDefinitions map[string]*PluginDocsLinkAnnotationDefinition + CardinalityA *PluginDocsLinkCardinality + CardinalityB *PluginDocsLinkCardinality + Description string + Summary string + Type string + type PluginDocsLinkAnnotationDefinition struct + AllowedValues []*core.ScalarValue + AppliesTo string + Default *core.ScalarValue + Description string + Examples []*core.ScalarValue + Label string + Name string + Required bool + Type string + type PluginDocsLinkCardinality struct + Max int + Min int + type PluginDocsResource struct + Description string + Examples []string + Label string + Specification *PluginDocResourceSpec + Summary string + Type string + type PluginDocsVersionConfig struct + AllowAdditionalFields bool + Fields map[string]*PluginDocsVersionConfigField + type PluginDocsVersionConfigField struct + AllowedValues []*core.ScalarValue + Default *core.ScalarValue + Description string + Examples []*core.ScalarValue + Label string + Required bool + Secret bool + Type string + type ValueTypeDefinition struct + AttributeValueTypeDefinitions map[string]*AttributeType + Description string + ElementValueTypeDefinition *ValueTypeDefinition + FunctionDefinition *FunctionDefinition + Label string + MapValueTypeDefinition *ValueTypeDefinition + StringChoices []string + Type string + UnionValueTypeDefinitions []*ValueTypeDefinition
Go to main page