Documentation
¶
Index ¶
- type Error
- type ErrorKind
- type ExtensionsValidator
- type ExtensionsValidatorHandler
- type OpenAPISchema
- type OpenAPISchemaVersion
- type PreValidator
- type SchemaIndex
- type SchemaWithIndex
- type ValidateOption
- type ValidationError
- type Validator
- func (v *Validator) AddExtensionsValidators(validators ...*ExtensionsValidator) *Validator
- func (v *Validator) AddPreValidator(index SchemaIndex, validator PreValidator) *Validator
- func (v *Validator) AddSchema(index SchemaIndex, schema *spec.Schema) *Validator
- func (v *Validator) AddTransformers(index SchemaIndex, t ...transformer.SchemaTransformer) *Validator
- func (v *Validator) AddVersionFallback(failVersion, fallback string) *Validator
- func (v *Validator) Get(index *SchemaIndex) *spec.Schema
- func (v *Validator) LoadSchemas(reader io.Reader) error
- func (v *Validator) SetDefaultTransformers(transformers ...transformer.SchemaTransformer) *Validator
- func (v *Validator) SetLogger(loggerProvider log.LoggerProvider) *Validator
- func (v *Validator) Validate(doc *[]byte, opts ...ValidateOption) (*SchemaIndex, error)
- func (v *Validator) ValidateWithIndex(index *SchemaIndex, doc *[]byte, opts ...ValidateOption) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ExtensionsValidator ¶
type ExtensionsValidator struct {
// contains filtered or unexported fields
}
func NewExtensionsValidator ¶
func NewExtensionsValidator(extensionName string, validators map[string]ExtensionsValidatorHandler) *ExtensionsValidator
func NewXRulesExtensionsValidator ¶
func NewXRulesExtensionsValidator(validators map[string]ExtensionsValidatorHandler) *ExtensionsValidator
func (*ExtensionsValidator) ExtensionName ¶
func (v *ExtensionsValidator) ExtensionName() string
func (*ExtensionsValidator) Validate ¶
func (v *ExtensionsValidator) Validate(data json.RawMessage, schema spec.Schema) error
type ExtensionsValidatorHandler ¶
type ExtensionsValidatorHandler func(oldValue json.RawMessage) error
type OpenAPISchema ¶
type OpenAPISchema struct {
Kind string `json:"kind"`
Versions []OpenAPISchemaVersion `json:"apiVersions"`
}
type OpenAPISchemaVersion ¶
type OpenAPISchemaVersion struct {
Version string `json:"apiVersion"`
Schema interface{} `json:"openAPISpec"`
}
type PreValidator ¶
type SchemaIndex ¶
func (*SchemaIndex) IsValid ¶
func (i *SchemaIndex) IsValid() bool
func (*SchemaIndex) String ¶
func (i *SchemaIndex) String() string
type SchemaWithIndex ¶
type SchemaWithIndex struct {
Schema *spec.Schema
Index SchemaIndex
}
func LoadSchemas ¶
func LoadSchemas(reader io.Reader) ([]*SchemaWithIndex, error)
type ValidateOption ¶
type ValidateOption func(o *validateOptions)
func ValidateWithNoPrettyError ¶
func ValidateWithNoPrettyError(v bool) ValidateOption
func ValidateWithOmitDocInError ¶
func ValidateWithOmitDocInError(v bool) ValidateOption
func ValidateWithStrictUnmarshal ¶
func ValidateWithStrictUnmarshal(v bool) ValidateOption
type ValidationError ¶
func (*ValidationError) Append ¶
func (v *ValidationError) Append(kind ErrorKind, e Error)
func (*ValidationError) Error ¶
func (v *ValidationError) Error() string
func (*ValidationError) ErrorOrNil ¶
func (v *ValidationError) ErrorOrNil() error
type Validator ¶
type Validator struct {
// contains filtered or unexported fields
}
func NewValidator ¶
func NewValidator(schemas map[SchemaIndex]*spec.Schema) *Validator
func NewValidatorWithLogger ¶
func NewValidatorWithLogger(schemas map[SchemaIndex]*spec.Schema, loggerProvider log.LoggerProvider) *Validator
func (*Validator) AddExtensionsValidators ¶
func (v *Validator) AddExtensionsValidators(validators ...*ExtensionsValidator) *Validator
func (*Validator) AddPreValidator ¶
func (v *Validator) AddPreValidator(index SchemaIndex, validator PreValidator) *Validator
func (*Validator) AddSchema ¶
func (v *Validator) AddSchema(index SchemaIndex, schema *spec.Schema) *Validator
func (*Validator) AddTransformers ¶
func (v *Validator) AddTransformers(index SchemaIndex, t ...transformer.SchemaTransformer) *Validator
func (*Validator) AddVersionFallback ¶
func (*Validator) SetDefaultTransformers ¶
func (v *Validator) SetDefaultTransformers(transformers ...transformer.SchemaTransformer) *Validator
func (*Validator) SetLogger ¶
func (v *Validator) SetLogger(loggerProvider log.LoggerProvider) *Validator
func (*Validator) Validate ¶
func (v *Validator) Validate(doc *[]byte, opts ...ValidateOption) (*SchemaIndex, error)
func (*Validator) ValidateWithIndex ¶
func (v *Validator) ValidateWithIndex(index *SchemaIndex, doc *[]byte, opts ...ValidateOption) error
ValidateWithIndex validate one document with schema if schema not fount then return ErrSchemaNotFound
Click to show internal directories.
Click to hide internal directories.