metadata

type ActionMetadata struct {
	Schema ActionSchema

	RenderOption *ActionRenderOption
}

type ActionMetadatas map[string]ActionMetadata

type ActionRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Schema      string
	Import      string
}

type ActionRenderOption struct {
	// The subcategory of the document.
	Subcategory string
	Examples    []Example

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Schema }}
	Template *template.Template
}

type ActionSchema struct {
	Description string
	Deprecation string

	Fields Fields

	// Including nested attribute object or block object.
	Nested NestedFields
}

type ActionWithRenderOption interface {
	action.Action
	RenderOption() ActionRenderOption
}

type BothDescriptionCtxProvider interface {
	DescriptionCtxProvider
	MarkdownDescriptionCtxProvider
}

type BothDescriptionProvider interface {
	DescriptionProvider
	MarkdownDescriptionProvider
}

type Categorizer interface {
	Category() Category
}

type Category string

type DataSourceMetadata struct {
	Schema DataSourceSchema

	RenderOption *DataSourceRenderOption
}

type DataSourceMetadatas map[string]DataSourceMetadata

type DataSourceRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Schema      string
}

type DataSourceRenderOption struct {
	// The subcategory of the document.
	Subcategory string
	Examples    []Example

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Schema }}
	Template *template.Template
}

type DataSourceSchema struct {
	Description string
	Deprecation string

	Fields Fields

	// Including nested attribute object or block object.
	Nested NestedFields
}

type DataSourceWithRenderOption interface {
	datasource.DataSource
	RenderOption() DataSourceRenderOption
}

type DataType struct {
	// contains filtered or unexported fields
}

type DescriptionCtxProvider interface {
	Description(context.Context) string
}

type DescriptionProvider interface {
	GetDescription() string
}

type EphemeralMetadata struct {
	Schema EphemeralSchema

	RenderOption *EphemeralRenderOption
}

type EphemeralMetadatas map[string]EphemeralMetadata

type EphemeralRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Schema      string
}

type EphemeralRenderOption struct {
	// The subcategory of the document.
	Subcategory string
	Examples    []Example

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Schema }}
	Template *template.Template
}

type EphemeralResourceWithRenderOption interface {
	ephemeral.EphemeralResource
	RenderOption() EphemeralRenderOption
}

type EphemeralSchema struct {
	Description string
	Deprecation string

	Fields Fields

	// Including nested attribute object or block object.
	Nested NestedFields
}

type Example struct {
	// The section header.
	Header string
	// The description of the example.
	Description string
	// The HCL code of the example.
	HCL string
}

type Field struct {
	// contains filtered or unexported fields
}

type Fields map[string]Field

type FunctionField struct {
	// contains filtered or unexported fields
}

type FunctionFields []FunctionField

type FunctionMetadata struct {
	Schema FunctionSchema

	RenderOption *FunctionRenderOption
}

type FunctionMetadatas map[string]FunctionMetadata

type FunctionObject struct {
	// contains filtered or unexported fields
}

type FunctionObjects map[string]FunctionObject

type FunctionRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Signature   string
	Arguments   string
	Return      string
}

type FunctionRenderOption struct {
	// The subcategory of the document.
	Subcategory string
	Examples    []Example

	// Description of the return value.
	ReturnDescription *string

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Signature }}
	// {{- with .Arguments }}
	// {{ . }}
	// {{- end }}
	// {{- with .Return }}
	// {{ . }}
	// {{- end }}
	Template *template.Template
}

type FunctionSchema struct {
	Description string
	Summary     string
	Deprecation string

	Parameters FunctionFields
	Objects    FunctionObjects

	Return        FunctionField
	ReturnObjects FunctionObjects
}

type FunctionWithRenderOption interface {
	function.Function
	RenderOption() FunctionRenderOption
}

type ImportId struct {
	// The Id format.
	Format string

	// The example id that will be displayed in an example `terraform import` command.
	// Note that the id is double quoted, ensure to escape any double quote included in the id.
	ExampleId string

	// The complete import by id block. If not specified, it will fill in the block with the `ExampleId`.
	ExampleBlk string
}

type ListMetadata struct {
	Schema ListSchema

	RenderOption *ListRenderOption
}

type ListMetadatas map[string]ListMetadata

type ListRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Schema      string
}

type ListRenderOption struct {
	// The subcategory of the document.
	Subcategory string
	Examples    []Example

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Schema }}
	Template *template.Template
}

type ListResourceWithRenderOption interface {
	list.ListResource
	RenderOption() ListRenderOption
}

type ListSchema struct {
	Description string
	Deprecation string

	Fields Fields

	// Including nested attribute object or block object.
	Nested NestedFields
}

type MarkdownDescriptionCtxProvider interface {
	MarkdownDescription(context.Context) string
}

type MarkdownDescriptionProvider interface {
	GetMarkdownDescription() string
}

type Metadata struct {
	ProviderName string
	Provider     ProviderMetadata
	Resources    ResourceMetadatas
	DataSources  DataSourceMetadatas
	Ephemerals   EphemeralMetadatas
	Actions      ActionMetadatas
	Lists        ListMetadatas
	Functions    FunctionMetadatas
}

type NestedField struct {
	// contains filtered or unexported fields
}

type NestedFields map[string]NestedField

type Object struct {
	// contains filtered or unexported fields
}

type ObjectField struct {
	// contains filtered or unexported fields
}

type Objects map[string]Object

type ProviderMetadata struct {
	Schema ProviderSchema

	RenderOption *ProviderRenderOption
}

type ProviderRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Schema      string
}

type ProviderRenderOption struct {
	Examples []Example

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Schema }}
	Template *template.Template
}

type ProviderSchema struct {
	Description string
	Deprecation string

	Fields Fields

	// Including nested attribute object or block object.
	Nested NestedFields
}

type ProviderWithRenderOption interface {
	provider.Provider
	RenderOption() ProviderRenderOption
}

type ResourceIdentityField struct {
	Name     string
	DataType DataType

	Required bool
	Optional bool

	Description string
	// contains filtered or unexported fields
}

type ResourceIdentityFields map[string]ResourceIdentityField

type ResourceIdentitySchema struct {
	Fields ResourceIdentityFields
}

type ResourceMetadata struct {
	Schema   ResourceSchema
	Identity *ResourceIdentitySchema

	RenderOption *ResourceRenderOption
}

type ResourceMetadatas map[string]ResourceMetadata

type ResourceRender struct {
	Template    *template.Template
	Header      string
	Description string
	Example     string
	Schema      string
	Import      string
}

type ResourceRenderOption struct {
	// The subcategory of the document.
	Subcategory string
	Examples    []Example

	// The information about import by id (including via command and via import block).
	ImportId *ImportId
	// The examples for importing by identity via import block.
	IdentityExamples []Example

	// A custom template that overrides the default template:
	//
	// {{ .Header }}
	// {{ .Description }}
	// {{- with .Example }}
	// {{ . }}
	// {{- end }}
	// {{ .Schema }}
	// {{- with .Import }}
	// {{ . }}
	// {{- end }}
	Template *template.Template
}

type ResourceSchema struct {
	Description string
	Deprecation string

	Fields Fields

	// Including nested attribute object or block object.
	Nested NestedFields
}

type ResourceWithRenderOption interface {
	resource.Resource
	RenderOption() ResourceRenderOption
}