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. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  12. def lint(schema: Schema): 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

    returns

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

  13. val lintArrayProperties: Linter

    Permalink

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

  14. val lintMinMaxItems: Linter

    Permalink

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

  15. val lintMinMaxLength: Linter

    Permalink

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

  16. val lintMinimumMaximum: Linter

    Permalink

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

  17. val lintNumberProperties: Linter

    Permalink

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

  18. val lintObjectProperties: Linter

    Permalink

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

  19. 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

  20. val lintStringProperties: Linter

    Permalink

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

  21. val linters: List[(Schema) ⇒ Validation[String, Unit]]

    Permalink

    List of all available linters

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

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

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

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

    Permalink

    Some property was processed successfully

  26. val schemaSuccess: ValidationNel[String, Unit]

    Permalink

    Whole subschema was processed successfully

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped