errors

type ConfigError interface {
	error
	Coordinates() coordinate.Coordinate
}

type ConfigLoaderError struct {
	// Path of the config.yaml that could not be loaded
	Path string `json:"path"`
	// Err is the underlying error that occurred while loading
	Err error `json:"error" jsonschema:"type=object"`
}

type ConfigWriterError struct {
	// Path of the file that failed to be written
	Path string `json:"path"`
	// Err is the underlying error that occurred
	Err error `json:"error" jsonschema:"type=object"`
}

type DefinitionParserError struct {
	// Location (coordinate) of the configuration that could not be parsed
	Location coordinate.Coordinate `json:"location"`
	// Path of the config.yaml that could not be parsed
	Path string `json:"path"`
	// Reason describing why parsing failed
	Reason string `json:"reason"`
}

type DetailedConfigError interface {
	ConfigError
	LocationDetails() EnvironmentDetails
}

type DetailedConfigWriterError struct {
	// Location (coordinate) of the config.Config that failed to be written to file
	Location coordinate.Coordinate `json:"location"`
	// Path of the file that failed to be written
	Path string `json:"path"`
	// Err is the underlying error that occurred
	Err error `json:"error" jsonschema:"type=object"`
}

type DetailedDefinitionParserError struct {
	DefinitionParserError
	// EnvironmentDetails of the environment the parsing of a configuration failed for
	EnvironmentDetails EnvironmentDetails `json:"environmentDetails"`
}

type EnvironmentDetails struct {
	Group       string `json:"group"`
	Environment string `json:"environment"`
}

type InvalidJsonError struct {
	// Location (coordinate) of the configuration whose template is invalid JSON
	Location coordinate.Coordinate `json:"location"`
	// EnvironmentDetails of the environment the template was rendered for
	EnvironmentDetails EnvironmentDetails `json:"environmentDetails"`
	// TemplateFilePath points to the file containing invalid JSON
	TemplateFilePath string `json:"templateFilePath"`
	// Err is the underlying JSON rendering error
	Err error `json:"error"`
}

type ParameterDefinitionParserError struct {
	DetailedDefinitionParserError
	// ParameterName of the YAML parameter that failed to be parsed
	ParameterName string `json:"parameterName"`
}