schema

Documentation

Index

• type AttributeRepresentation
• type BlockRepresentation
  • func (btr BlockRepresentation) ListLeafNodes() map[string]AttributeRepresentation
• type BlockTypeRepresentation
• type ProviderSchema
• type ProvidersSchema
• type SchemaRepresentation

Types

type AttributeRepresentation

type AttributeRepresentation struct {
	// Type is a representation of a type specification that the attribute's value must conform to.
	// This can be string or array. Inconsistencies have been observed
	Type interface{} `json:"type,omitempty"`

	// Description is an English-language description of the purpose and usage of the attribute.
	Description string `json:"description,omitempty"`

	// Required, if set to true, specifies that an omitted or null value is not permitted.
	Required bool `json:"required,omitempty"`

	// Optional, if set to true, specifies that an omitted or null value is permitted.
	Optional bool `json:"optional,omitempty"`

	// Computed, if set to true, indicates that the value comes from the provider rather than the configuration.
	Computed bool `json:"computed,omitempty"`

	// Sensitive, if set to true, indicates that the attribute may contain sensitive information.
	Sensitive bool `json:"sensitive,omitempty"`
}

AttributeRepresentation represents the schema definition for a Terraform provider attribute.

type BlockRepresentation

type BlockRepresentation struct {
	// Attributes describes any attributes that appear directly inside the block. Keys in this map are the attribute names.
	Attributes map[string]AttributeRepresentation `json:"attributes"`

	// BlockTypes describes any nested blocks that appear directly inside the block. Keys in this map are the names of the block_type.
	BlockTypes map[string]BlockTypeRepresentation `json:"block_types,omitempty"`
}

BlockRepresentation represents the schema definition for a Terraform provider block.

func (BlockRepresentation) ListLeafNodes

func (btr BlockRepresentation) ListLeafNodes() map[string]AttributeRepresentation

ListLeafNodes returns a map of leaf nodes in the BlockRepresentation. Leaf nodes are the attributes directly present in the block and attributes within nested blocks. The keys of the map are the attribute paths, and the values are the corresponding AttributeRepresentation.

Example:

Input: { a: string, b: {c: string, d: string}}
Output: { a: string, b: map, "b.c": string, "b.d": string }

type BlockTypeRepresentation

type BlockTypeRepresentation struct {
	// NestingMode describes the nesting mode for the child block, and can be one of the following:
	//    single
	//    list
	//    set
	//    map
	NestingMode string `json:"nesting_mode,omitempty"`

	// Block is a BlockRepresentation that represents the nested block.
	Block BlockRepresentation `json:"block,omitempty"`

	// MinItems and MaxItems set lower and upper limits on the number of child blocks allowed for the list and set modes. These are omitted for other modes.
	MinItems int `json:"min_items,omitempty"`
	MaxItems int `json:"max_items,omitempty"`
}

BlockTypeRepresentation represents the schema definition for a Terraform provider nested block type.

type ProviderSchema

type ProviderSchema struct {
	// Provider is the schema for the provider configuration.
	Provider SchemaRepresentation `json:"provider"`

	// ResourceSchemas maps the resource type name to the resource's schema.
	ResourceSchemas map[string]SchemaRepresentation `json:"resource_schemas,omitempty"`

	// DataSourceSchemas maps the data source type name to the data source's schema.
	DataSourceSchemas map[string]SchemaRepresentation `json:"data_source_schemas,omitempty"`
}

ProviderSchema describes the schema for a Terraform provider.

type ProvidersSchema

type ProvidersSchema struct {
	// FormatVersion is the version of the schema format.
	FormatVersion string `json:"format_version"`

	// ProviderSchemas describes the provider schemas for all providers throughout the configuration tree.
	// Keys in this map are the provider type, such as "random".
	ProviderSchemas map[string]ProviderSchema `json:"provider_schemas"`
}

ProvidersSchema is the schema representation for the Providers Schema Representation.

type SchemaRepresentation

type SchemaRepresentation struct {
	// Version is the schema version, not the provider version.
	Version int64 `json:"version"`

	// Block contains the block representation of the schema.
	Block BlockRepresentation `json:"block"`
}

SchemaRepresentation represents a provider or resource schema paired with that schema's version.