metadata

package

Go to main page

Versions in this module

v0

v0.3.0

May 18, 2026

Changes in this version

+ func IndentFollowingLines(s, indent string) string

v0.2.3

Mar 31, 2026

v0.2.2

Mar 31, 2026

v0.2.1

Mar 31, 2026

Changes in this version

+ func WrapErrDiags(diags diag.Diagnostics, context string) diag.Diagnostics

v0.2.0

Mar 27, 2026

Changes in this version

type Field

+ func (field Field) Lint() error

type Fields

+ func (fields Fields) Lint() error

type FunctionField

+ func (field FunctionField) Lint() error

type FunctionFields

+ func (fields FunctionFields) Lint() error

type FunctionObject

+ func (object FunctionObject) Lint() error

type FunctionObjects

+ func (objects FunctionObjects) Lint() error

type NestedFields

+ func (fields NestedFields) Lint() error

type ResourceIdentityFields

+ func (fields ResourceIdentityFields) Lint() error

v0.1.0

Mar 27, 2026

Changes in this version

+ const CategoryAction

+ const CategoryDataSource

+ const CategoryEphemeral

+ const CategoryFunction

+ const CategoryList

+ const CategoryProvider

+ const CategoryResource

+ func DescriptionCtxOf[T BothDescriptionCtxProvider](ctx context.Context, d T) string

+ func DescriptionOf[T BothDescriptionProvider](d T) string

+ func MapOrNil[T any, U any](input T, f func(T) U) *U

+ func MapOrZero[T any, U any](input T, f func(T) U) U

+ func MapSliceSome[T any, U any](input []T, f func(T) *U) []U

+ func MapSlice[T any, U any](input []T, f func(T) U) []U

+ func MaybeDescriptionCtxOf(ctx context.Context, d any) *string

+ func MaybeDescriptionOf(d any) *string

+ func PointerTo[T any](ptr *T) T

+ func Sentencefy(s string) string

+ type ActionMetadata struct

+ RenderOption *ActionRenderOption

+ Schema ActionSchema

+ type ActionMetadatas map[string]ActionMetadata

+ type ActionRender struct

+ Description string

+ Example string

+ Header string

+ Import string

+ Schema string

+ Template *template.Template

+ func (render ActionRender) Execute(w io.Writer) error

+ type ActionRenderOption struct

+ Examples []Example

+ Subcategory string

+ Template *template.Template

+ type ActionSchema struct

+ Deprecation string

+ Description string

+ Fields Fields

+ Nested NestedFields

+ func NewActionSchema(ctx context.Context, sch schema.Schema) (schema ActionSchema, diags diag.Diagnostics)

+ type ActionWithRenderOption interface

+ RenderOption func() ActionRenderOption

+ type BothDescriptionCtxProvider interface

+ type BothDescriptionProvider interface

+ type Categorizer interface

+ Category func() Category

+ type Category string

+ type DataSourceMetadata struct

+ RenderOption *DataSourceRenderOption

+ Schema DataSourceSchema

+ type DataSourceMetadatas map[string]DataSourceMetadata

+ type DataSourceRender struct

+ Description string

+ Example string

+ Header string

+ Schema string

+ Template *template.Template

+ func (render DataSourceRender) Execute(w io.Writer) error

+ type DataSourceRenderOption struct

+ Examples []Example

+ Subcategory string

+ Template *template.Template

+ type DataSourceSchema struct

+ Deprecation string

+ Description string

+ Fields Fields

+ Nested NestedFields

+ func NewDataSourceSchema(ctx context.Context, sch schema.Schema) (schema DataSourceSchema, diags diag.Diagnostics)

+ type DataSourceWithRenderOption interface

+ RenderOption func() DataSourceRenderOption

+ type DataType struct

+ func (dt DataType) String() string

+ type DescriptionCtxProvider interface

+ Description func(context.Context) string

+ type DescriptionProvider interface

+ GetDescription func() string

+ type EphemeralMetadata struct

+ RenderOption *EphemeralRenderOption

+ Schema EphemeralSchema

+ type EphemeralMetadatas map[string]EphemeralMetadata

+ type EphemeralRender struct

+ Description string

+ Example string

+ Header string

+ Schema string

+ Template *template.Template

+ func (render EphemeralRender) Execute(w io.Writer) error

+ type EphemeralRenderOption struct

+ Examples []Example

+ Subcategory string

+ Template *template.Template

+ type EphemeralResourceWithRenderOption interface

+ RenderOption func() EphemeralRenderOption

+ type EphemeralSchema struct

+ Deprecation string

+ Description string

+ Fields Fields

+ Nested NestedFields

+ func NewEphemeralSchema(ctx context.Context, sch schema.Schema) (schema EphemeralSchema, diags diag.Diagnostics)

+ type Example struct

+ Description string

+ HCL string

+ Header string

+ type Field struct

+ func (field Field) NestedLink() string

+ func (field Field) Traits() string

+ func (r Field) Computed() bool

+ func (r Field) CustomTypeDescription() string

+ func (r Field) DataType() DataType

+ func (r Field) Default() string

+ func (r Field) Deprecation() string

+ func (r Field) Description() string

+ func (r Field) Name() string

+ func (r Field) Optional() bool

+ func (r Field) Parents() []string

+ func (r Field) PlanModifiers() []string

+ func (r Field) Required() bool

+ func (r Field) Sensitive() bool

+ func (r Field) Validators() []string

+ func (r Field) WriteOnly() bool

+ type Fields map[string]Field

+ func (fields Fields) ComputedFields() []Field

+ func (fields Fields) OptionalFields() []Field

+ func (fields Fields) RequiredFields() []Field

+ type FunctionField struct

+ func (field FunctionField) NestedLink() string

+ func (field FunctionField) Traits() string

+ func (r FunctionField) AllowNull() bool

+ func (r FunctionField) AllowUnknown() bool

+ func (r FunctionField) CustomTypeDescription() string

+ func (r FunctionField) DataType() DataType

+ func (r FunctionField) Description() string

+ func (r FunctionField) Name() string

+ func (r FunctionField) Parents() []string

+ func (r FunctionField) Validators() []string

+ type FunctionFields []FunctionField

+ type FunctionMetadata struct

+ RenderOption *FunctionRenderOption

+ Schema FunctionSchema

+ type FunctionMetadatas map[string]FunctionMetadata

+ type FunctionObject struct

+ func (r FunctionObject) CustomTypeDescription() string

+ type FunctionObjects map[string]FunctionObject

+ type FunctionRender struct

+ Arguments string

+ Description string

+ Example string

+ Header string

+ Return string

+ Signature string

+ Template *template.Template

+ func (render FunctionRender) Execute(w io.Writer) error

+ type FunctionRenderOption struct

+ Examples []Example

+ ReturnDescription *string

+ Subcategory string

+ Template *template.Template

+ type FunctionSchema struct

+ Deprecation string

+ Description string

+ Objects FunctionObjects

+ Parameters FunctionFields

+ Return FunctionField

+ ReturnObjects FunctionObjects

+ Summary string

+ func NewFunctionSchema(ctx context.Context, sch function.Definition) (schema FunctionSchema, diags diag.Diagnostics)

+ type FunctionWithRenderOption interface

+ RenderOption func() FunctionRenderOption

+ type ImportId struct

+ ExampleBlk string

+ ExampleId string

+ Format string

+ type ListMetadata struct

+ RenderOption *ListRenderOption

+ Schema ListSchema

+ type ListMetadatas map[string]ListMetadata

+ type ListRender struct

+ Description string

+ Example string

+ Header string

+ Schema string

+ Template *template.Template

+ func (render ListRender) Execute(w io.Writer) error

+ type ListRenderOption struct

+ Examples []Example

+ Subcategory string

+ Template *template.Template

+ type ListResourceWithRenderOption interface

+ RenderOption func() ListRenderOption

+ type ListSchema struct

+ Deprecation string

+ Description string

+ Fields Fields

+ Nested NestedFields

+ func NewListSchema(ctx context.Context, sch schema.Schema) (schema ListSchema, diags diag.Diagnostics)

+ type MarkdownDescriptionCtxProvider interface

+ MarkdownDescription func(context.Context) string

+ type MarkdownDescriptionProvider interface

+ GetMarkdownDescription func() string

+ type Metadata struct

+ Actions ActionMetadatas

+ DataSources DataSourceMetadatas

+ Ephemerals EphemeralMetadatas

+ Functions FunctionMetadatas

+ Lists ListMetadatas

+ Provider ProviderMetadata

+ ProviderName string

+ Resources ResourceMetadatas

+ func GetMetadata(ctx context.Context, p provider.Provider) (metadata Metadata, diags diag.Diagnostics)

+ func (metadata Metadata) NewActionRender(actionType string, opt *ActionRenderOption) (*ActionRender, error)

+ func (metadata Metadata) NewDataSourceRender(dataSourceType string, opt *DataSourceRenderOption) (*DataSourceRender, error)

+ func (metadata Metadata) NewEphemeralRender(ephemeralType string, opt *EphemeralRenderOption) (*EphemeralRender, error)

+ func (metadata Metadata) NewFunctionRender(functionName string, opt *FunctionRenderOption) (*FunctionRender, error)

+ func (metadata Metadata) NewListRender(listType string, opt *ListRenderOption) (*ListRender, error)

+ func (metadata Metadata) NewProviderRender(opt *ProviderRenderOption) (*ProviderRender, error)

+ func (metadata Metadata) NewResourceRender(resourceType string, opt *ResourceRenderOption) (*ResourceRender, error)

+ type NestedField struct

+ func (r NestedField) Fields() Fields

+ func (r NestedField) PlanModifiers() []string

+ func (r NestedField) Validators() []string

+ type NestedFields map[string]NestedField

+ type Object struct

+ type ObjectField struct

+ func (obj ObjectField) ToField(rootField Field) Field

+ func (obj ObjectField) ToFunctionField() FunctionField

+ type Objects map[string]Object

+ func (objs Objects) ToFunctionObjects() FunctionObjects

+ func (objs Objects) ToNestedFields(rootField Field) NestedFields

+ type ProviderMetadata struct

+ RenderOption *ProviderRenderOption

+ Schema ProviderSchema

+ type ProviderRender struct

+ Description string

+ Example string

+ Header string

+ Schema string

+ Template *template.Template

+ func (render ProviderRender) Execute(w io.Writer) error

+ type ProviderRenderOption struct

+ Examples []Example

+ Template *template.Template

+ type ProviderSchema struct

+ Deprecation string

+ Description string

+ Fields Fields

+ Nested NestedFields

+ func NewProviderSchema(ctx context.Context, sch schema.Schema) (schema ProviderSchema, diags diag.Diagnostics)

+ type ProviderWithRenderOption interface

+ RenderOption func() ProviderRenderOption

+ type ResourceIdentityField struct

+ DataType DataType

+ Description string

+ Name string

+ Optional bool

+ Required bool

+ func (field ResourceIdentityField) CustomTypeDescription() string

+ func (field ResourceIdentityField) Traits() string

+ type ResourceIdentityFields map[string]ResourceIdentityField

+ func (fields ResourceIdentityFields) OptionalFields() []ResourceIdentityField

+ func (fields ResourceIdentityFields) RequiredFields() []ResourceIdentityField

+ type ResourceIdentitySchema struct

+ Fields ResourceIdentityFields

+ func NewResourceIdentitySchema(ctx context.Context, sch identityschema.Schema) (schema ResourceIdentitySchema, diags diag.Diagnostics)

+ type ResourceMetadata struct

+ Identity *ResourceIdentitySchema

+ RenderOption *ResourceRenderOption

+ Schema ResourceSchema

+ type ResourceMetadatas map[string]ResourceMetadata

+ type ResourceRender struct

+ Description string

+ Example string

+ Header string

+ Import string

+ Schema string

+ Template *template.Template

+ func (render ResourceRender) Execute(w io.Writer) error

+ type ResourceRenderOption struct

+ Examples []Example

+ IdentityExamples []Example

+ ImportId *ImportId

+ Subcategory string

+ Template *template.Template

+ type ResourceSchema struct

+ Deprecation string

+ Description string

+ Fields Fields

+ Nested NestedFields

+ func NewResourceSchema(ctx context.Context, sch schema.Schema) (schema ResourceSchema, diags diag.Diagnostics)

+ type ResourceWithRenderOption interface

+ RenderOption func() ResourceRenderOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL