jsonfunction

Documentation

Index

• Constants
• func Marshal(f map[string]function.Function) ([]byte, tfdiags.Diagnostics)
• type FunctionSignature

Constants

const FormatVersion = "1.0"

FormatVersion represents the version of the json format and will be incremented for any change to this format that requires changes to a consuming parser.

Functions

func Marshal

func Marshal(f map[string]function.Function) ([]byte, tfdiags.Diagnostics)

Types

type FunctionSignature

type FunctionSignature struct {
	// Description is an optional human-readable description
	// of the function
	Description string `json:"description,omitempty"`

	// ReturnTypes is the ctyjson representation of the function's
	// return types based on supplying all parameters using
	// dynamic types. Functions can have dynamic return types.
	ReturnType cty.Type `json:"return_type"`

	// Parameters describes the function's fixed positional parameters.
	Parameters []*parameter `json:"parameters,omitempty"`

	// VariadicParameter describes the function's variadic
	// parameters, if any are supported.
	VariadicParameter *parameter `json:"variadic_parameter,omitempty"`
}

FunctionSignature represents a function signature.