jsonschema

Namespace

jsonschema

Description:
  • Validation of data against JSON schemas
Source:

Classes

JsonSchema
JsonSchemaModule
Keywords

Type Definitions

ApplyPatchProperties

Source:
Properties:
Name Type Description
extendAnnotations Object Whether annotation properties should be overwitten by the patch
strict Object Restricts patches to only merge/patch schemas
overwriteProperties Object Whether existing properties should be overwritten by the patch schema
Type:
  • Object

LoadSchemaOptions

Source:
Properties:
Name Type Description
applyExtensions Boolean Whether extension schemas are applied
extensionFilter function Function to selectively apply schema extensions. Function should return a boolean to signify whether the extension should be applied
useCache Boolean Whether cached should be returned
Type:
  • Object

RegisterSchemaOptions

Source:
Properties:
Name Type Description
replace Boolean Will replace the existing schema if one exists
Type:
  • Object

SanitiseOptions

Source:
Properties:
Name Type Description
isInternal Boolean Whether internal attributes should be filtered
isReadOnly Boolean Whether read-only attributes should be filtered
sanitiseHtml Boolean Whether HTML text should be filtered
strict Boolean Whether to throw errors
Type:
  • Object

ValidateOptions

Source:
Properties:
Name Type Description
useDefaults Boolean Whether to apply defaults
ignoreRequired Boolean Whether to ignore missing required fields
Type:
  • Object