validation

type ValidationParams struct {
	// This is the name of the model to validate (used for documentation and error reporting purposes) (required)
	ModelType string `json:"model-type,omitempty" yaml:"model-type,omitempty"`
	// This is the reference of the model to validate (does not have to be a url, used for documentation and error reporting purposes) (optional)
	ModelPath string `json:"model-path,omitempty" yaml:"model-path,omitempty"`
	// This is the version of the model to validate against (for example, 1.0.0) (optional)
	ModelVersion string `json:"model-version,omitempty" yaml:"model-version,omitempty"`
	// Must be a json map (map[string]interface{}) (required)
	ModelData map[string]interface{} `json:"model-data,omitempty" yaml:"model-data,omitempty"`
	// This is the reference of the schema to validate against (does not have to be a url, used for documentation and error reporting purposes) (required)
	SchemaPath string `json:"schema-path,omitempty" yaml:"schema-path,omitempty"`
	// Must be a json map (map[string]interface{}) (required)
	SchemaData map[string]interface{} `json:"schema-data,omitempty" yaml:"schema-data,omitempty"`
	// This is the version of the schema to validate against (for example, 1.0.0) (optional)
	SchemaVersion string `json:"schema-version,omitempty" yaml:"schema-version,omitempty"`
}

type ValidationResponse struct {
	Validator Validator
	// Parsed validation result
	Result ValidationResult
	// Non-failing go-oscal warnings (ie: deprecated fields, newer schema versions, etc)
	Warnings []string
	// Unparsed Failing validation errors from the jsonschema library
	JsonSchemaError *jsonschema.ValidationError
}

type ValidationResult struct {
	// Valid is true if the validation result is valid
	Valid bool `json:"valid" yaml:"valid"`
	// TimeStamp is the time the validation result was created
	TimeStamp time.Time `json:"timeStamp" yaml:"timeStamp"`
	// Errors is a slice of ValidatorErrors
	Errors []ValidatorError `json:"errors,omitempty" yaml:"errors,omitempty"`
	// Metadata is the metadata of the validation result
	Metadata ValidationResultMetadata `json:"metadata" yaml:"metadata"`
}

type ValidationResultMetadata struct {
	// DocumentPath is the path to the document
	DocumentPath string `json:"documentPath,omitempty" yaml:"documentPath,omitempty"`
	// DocumentType is the type of the document
	DocumentType string `json:"documentType,omitempty" yaml:"documentType,omitempty"`
	// DocumentVersion is the version of the document
	DocumentVersion string `json:"documentVersion,omitempty" yaml:"documentVersion,omitempty"`
	// SchemaVersion is the version of the schema
	SchemaVersion string `json:"schemaVersion,omitempty" yaml:"schemaVersion,omitempty"`
}

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

type ValidatorError struct {
	// KeywordLocation is the location of the keyword in the schema for failing value
	KeywordLocation string `json:"keywordLocation" yaml:"keywordLocation"`
	// AbsoluteKeywordLocation is the absolute location of the keyword in the schema for failing value
	AbsoluteKeywordLocation string `json:"absoluteKeywordLocation" yaml:"absoluteKeywordLocation"`
	// InstanceLocation is the location of the instance in the document
	InstanceLocation string `json:"instanceLocation" yaml:"instanceLocation"`
	// Error is the error message
	Error string `json:"error" yaml:"error"`
	// FailedValue is the value of the key that failed validation
	FailedValue interface{} `json:"failedValue,omitempty" yaml:"failedValue,omitempty"`
}