errors

package
v0.38.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2026 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType added in v0.33.0

type ActionType string

ActionType constants for programmatic identification

const (
	ActionTypeInstallProvider                ActionType = "install_provider"
	ActionTypeUpdateProvider                 ActionType = "update_provider"
	ActionTypeCheckConfiguration             ActionType = "check_configuration"
	ActionTypeCheckFunctionName              ActionType = "check_function_name"
	ActionTypeCheckResourceType              ActionType = "check_resource_type"
	ActionTypeCheckDataSourceType            ActionType = "check_data_source_type"
	ActionTypeProvideValue                   ActionType = "provide_value"
	ActionTypeAddDefaultValue                ActionType = "add_default_value"
	ActionTypeFixVariableType                ActionType = "fix_variable_type"
	ActionTypeCheckVariableType              ActionType = "check_variable_type"
	ActionTypeContactVariableTypeDeveloper   ActionType = "contact_variable_type_developer"
	ActionTypeAddVariableType                ActionType = "add_variable_type"
	ActionTypeCheckCustomVariableOptions     ActionType = "check_custom_variable_options"
	ActionTypeAddResourceType                ActionType = "add_resource_type"
	ActionTypeContactResourceTypeDeveloper   ActionType = "contact_resource_type_developer"
	ActionTypeCheckAbstractResourceType      ActionType = "check_abstract_resource_type"
	ActionTypeInstallTransformers            ActionType = "install_transformers"
	ActionTypeInstallTransformer             ActionType = "install_transformer"
	ActionTypeCheckTransformers              ActionType = "check_transformers"
	ActionTypeCheckResourceTypeSchema        ActionType = "check_resource_type_schema"
	ActionTypeAddDataSourceFilter            ActionType = "add_data_source_filter"
	ActionTypeAddDataSourceExport            ActionType = "add_data_source_export"
	ActionTypeContactDataSourceTypeDeveloper ActionType = "contact_data_source_type_developer"
	ActionTypeCheckDataSourceFilterFields    ActionType = "check_data_source_filter_fields"
	ActionTypeAddDataSourceType              ActionType = "add_data_source_type"
)

type ErrorCategory added in v0.33.0

type ErrorCategory string
const (
	ErrorCategoryProvider       ErrorCategory = "provider"
	ErrorCategoryTransformer    ErrorCategory = "transformer"
	ErrorCategoryFunction       ErrorCategory = "function"
	ErrorCategoryResourceType   ErrorCategory = "resource_type"
	ErrorCategoryVariableType   ErrorCategory = "variable_type"
	ErrorCategoryDataSourceType ErrorCategory = "data_source_type"
	ErrorCategoryExport         ErrorCategory = "export"
)

type ErrorContext added in v0.33.0

type ErrorContext struct {
	// Category helps clients group and handle errors
	Category ErrorCategory `json:"category,omitempty"`
	// Reason code from the parent error for programmatic identification
	ReasonCode ErrorReasonCode `json:"reasonCode,omitempty"`
	// Suggested actions the user can take
	SuggestedActions []SuggestedAction `json:"suggestedActions,omitempty"`
	// Additional metadata for context
	Metadata map[string]any `json:"metadata,omitempty"`
}

ErrorContext provides structured information for error resolution

type ErrorReasonCode

type ErrorReasonCode string

type ExpandedSerialiseError

type ExpandedSerialiseError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
}

func (*ExpandedSerialiseError) Error

func (e *ExpandedSerialiseError) Error() string

type LoadError

type LoadError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
	Line        *int
	Column      *int
	Context     *ErrorContext `json:"context,omitempty"`
}

func (*LoadError) Error

func (e *LoadError) Error() string

type RunError

type RunError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
	// ChildBlueprintPath is the path to the child blueprint that caused the error.
	// This should be in the following format:
	// "include.<childName>::include.<grandChildName>::..."
	// Rendered as "include.<childName> -> include.<grandChildName> -> ..."
	//
	// This is useful for distinguishing between errors that occur in the parent blueprint
	// and errors that occur in a child blueprint.
	ChildBlueprintPath string
	Context            *ErrorContext `json:"context,omitempty"`
}

func (*RunError) Error

func (e *RunError) Error() string

type SerialiseError

type SerialiseError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
}

func (*SerialiseError) Error

func (e *SerialiseError) Error() string

type SuggestedAction added in v0.33.0

type SuggestedAction struct {
	Type        string `json:"type"`
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	Priority    int    `json:"priority,omitempty"` // 1=highest, 5=lowest
}

Jump to

Keyboard shortcuts

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