Object

com.snowplowanalytics.iglu.schemaddl.jsonschema

SanityLinter

Related Doc: package jsonschema

Permalink

object SanityLinter

Contains Schema validation logic for JSON AST to find nonsense (impossible) JSON Schemas, ie. Schemas which cannot validate ANY value, yet syntactically correct. This doesn't have logic to validate accordance to JSON Schema specs such as non-empty required or numeric maximum. Separate validator should be used for that.

See also

https://github.com/snowplow/iglu/issues/164

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SanityLinter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type LintProperty = Validation[String, Unit]

    Permalink

    Check of single property

  2. type LintSchema = Validation[NonEmptyList[String], Unit]

    Permalink

    Aggregated property lints

  3. type Linter = (Schema) ⇒ LintProperty

    Permalink

    Function able to lint Schema AST

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allLinters: Map[String, Linter]

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. def lint(schema: Schema, height: Int, linters: List[Linter]): LintSchema

    Permalink

    Main working function, traversing JSON Schema It lints all properties on current level, then tries to extract all subschemas from properties like items, additionalItems etc and recursively lint them as well

    Main working function, traversing JSON Schema It lints all properties on current level, then tries to extract all subschemas from properties like items, additionalItems etc and recursively lint them as well

    schema

    parsed JSON AST

    height

    depth of linting

    linters

    of linters to be used

    returns

    non-empty list of summed failures (all, including nested) or unit in case of success

  14. val lintArrayProperties: Linter

    Permalink

    Check that Schema with non-object type doesn't contain object properties

  15. val lintDescriptionPresent: Linter

    Permalink

    Check that each 'field' contains a description property

  16. val lintMaxLength: Linter

    Permalink

    Check that schema with type string contains maxLength property or has other possibility to extract length

  17. val lintMaxLengthRange: Linter

    Permalink

    Check that string's maxLength property isn't greater than Redshift VARCHAR(max), 65535 See http://docs.aws.amazon.com/redshift/latest/dg/r_Character_types.html

  18. val lintMinMaxItems: Linter

    Permalink

    Check that array's minItems property isn't greater than maxItems

  19. val lintMinMaxLength: Linter

    Permalink

    Check that string's minLength property isn't greater than maxLength

  20. val lintMinMaxPresent: Linter

    Permalink

    Check that schema with type number or integer contains both minimum and maximum properties

  21. val lintMinimumMaximum: Linter

    Permalink

    Check that number's minimum property isn't greater than maximum

  22. val lintNumberProperties: Linter

    Permalink

    Check that Schema with non-numeric type doesn't contain numeric properties

  23. val lintObjectProperties: Linter

    Permalink

    Check that Schema with non-object type doesn't contain object properties

  24. val lintOptionalFields: Linter

    Permalink

    Check that non-required properties have type null

  25. val lintPossibleKeys: Linter

    Permalink

    Check that all required keys listed in properties

    Check that all required keys listed in properties

    To do

    take patternProperties in account

  26. val lintRootType: Linter

    Permalink

    Placeholder linter to be understood through --skip-checks, SanityLinter.lint() contains its logic

  27. val lintStringProperties: Linter

    Permalink

    Check that Schema with non-string type doesn't contain string properties

  28. val lintUnknownFormats: Linter

    Permalink

    Check that schema contains known formats

  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. val propertySuccess: Validation[String, Unit]

    Permalink

    Some property was processed successfully

  33. val schemaSuccess: ValidationNel[String, Unit]

    Permalink

    Whole subschema was processed successfully

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped