parameterValidator

Documentation

Index

• type ParameterDefinition
  • func ConvertDefinitions(rawDefinitions []interface{}) ([]ParameterDefinition, error)
• type ValidationResult
• type Validator
  • func New() (*Validator, error)
  • func (v *Validator) ValidateParameter(def ParameterDefinition, value string) (validationResult *ValidationResult, errorResult error)
  • func (v *Validator) ValidateParameters(definitions []ParameterDefinition, params extensionAPI.ParameterValues) (failedValidations []ValidationResult, err error)

Types

type ParameterDefinition

type ParameterDefinition struct {
	Id            string
	Name          string
	RawDefinition map[string]interface{}
}

func ConvertDefinitions

func ConvertDefinitions(rawDefinitions []interface{}) ([]ParameterDefinition, error)

type ValidationResult

type ValidationResult struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
}

type Validator

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

func New

func New() (*Validator, error)

New creates a new reusable validator.

[impl -> dsn~reuse-parameter-validation-rules~1]
[impl -> dsn~parameter-validation-rules-simple~1].

func (*Validator) ValidateParameter

func (v *Validator) ValidateParameter(def ParameterDefinition, value string) (validationResult *ValidationResult, errorResult error)

ValidateParameters uses the given parameter definition to validate a single value.

func (*Validator) ValidateParameters

func (v *Validator) ValidateParameters(definitions []ParameterDefinition, params extensionAPI.ParameterValues) (failedValidations []ValidationResult, err error)

ValidateParameters validates parameter values against the parameter definition and returns a list of failed validations. If all parameters are valid, this returns an empty slice.

[impl -> dsn~validate-parameters~1]
[impl -> dsn~parameter-definitions~1].