Module `Jsonschema`Source

JSON Schema validator supporting drafts 4, 6, 7, 2019-09, and 2020-12

Core Types

Sourcetype draft =

| Draft4
| Draft6
| Draft7
| Draft2019_09
| Draft2020_12

Supported draft versions

Sourcetype schema

A compiled JSON schema

Sourcetype instance_token =

| Prop of string
| Item of int

Instance location token

Sourcetype instance_location = {

tokens : instance_token list;

}

Instance location in the validated document

Sourcetype type_set

Set of JSON types

Sourcetype error_kind =

| Group
| Schema of {
1. url : string;
}
| Content_schema
| Property_name of {
1. prop : string;
}
| Reference of {
1. kw : string;
2. url : string;
}
| Ref_cycle of {
1. url : string;
2. kw_loc1 : string;
3. kw_loc2 : string;
}
| False_schema
| Type of {
1. got : Yojson.Basic.t;
2. want : type_set;
}
| Enum of {
1. want : Yojson.Basic.t list;
}
| Const of {
1. want : Yojson.Basic.t;
}
| Format of {
1. got : Yojson.Basic.t;
2. want : string;
3. err : exn;
}
| Min_properties of {
1. got : int;
2. want : int;
}
| Max_properties of {
1. got : int;
2. want : int;
}
| Additional_properties of {
1. got : string list;
}
| Unevaluated_properties of {
1. got : string list;
}
| Unevaluated_items of {
1. got : int;
}
| Required of {
1. want : string list;
}
| Dependency of {
1. prop : string;
2. missing : string list;
}
| Dependent_required of {
1. prop : string;
2. missing : string list;
}
| Min_items of {
1. got : int;
2. want : int;
}
| Max_items of {
1. got : int;
2. want : int;
}
| Contains
| Min_contains of {
1. got : int list;
2. want : int;
}
| Max_contains of {
1. got : int list;
2. want : int;
}
| Unique_items of {
1. got : int * int;
}
| Additional_items of {
1. got : int;
}
| Min_length of {
1. got : int;
2. want : int;
}
| Max_length of {
1. got : int;
2. want : int;
}
| Pattern of {
1. got : string;
2. want : string;
}
| Content_encoding of {
1. want : string;
2. err : exn;
}
| Content_media_type of {
1. got : bytes;
2. want : string;
3. err : exn;
}
| Minimum of {
1. got : float;
2. want : float;
}
| Maximum of {
1. got : float;
2. want : float;
}
| Exclusive_minimum of {
1. got : float;
2. want : float;
}
| Exclusive_maximum of {
1. got : float;
2. want : float;
}
| Multiple_of of {
1. got : float;
2. want : float;
}
| Not
| All_of
| Any_of
| One_of of (int * int) option

Validation error kinds

Sourcetype validation_error = {

schema_url : string;
instance_location : instance_location;
kind : error_kind;
causes : validation_error list;

}

Validation error

Sourcetype compile_error =

| Parse_url_error of {
1. url : string;
2. src : exn;
}
| Load_url_error of {
1. url : string;
2. src : exn;
}
| Unsupported_url_scheme of {
1. url : string;
}
| Invalid_meta_schema_url of {
1. url : string;
2. src : exn;
}
| Unsupported_draft of {
1. url : string;
}
| MetaSchema_cycle of {
1. url : string;
}
| Validation_error of {
1. url : string;
2. src : validation_error;
}
| Parse_id_error of {
1. loc : string;
}
| Parse_anchor_error of {
1. loc : string;
}
| Duplicate_id of {
1. url : string;
2. id : string;
3. ptr1 : string;
4. ptr2 : string;
}
| Duplicate_anchor of {
1. anchor : string;
2. url : string;
3. ptr1 : string;
4. ptr2 : string;
}
| Invalid_json_pointer of string
| Json_pointer_not_found of string
| Anchor_not_found of {
1. url : string;
2. reference : string;
}
| Unsupported_vocabulary of {
1. url : string;
2. vocabulary : string;
}
| Invalid_regex of {
1. url : string;
2. regex : string;
3. src : exn;
}
| Bug of exn

Compilation errors

Sourcetype json_pointer

JSON pointer for navigating JSON documents

High-Level API

Sourcetype validator

A reusable validator

Source

val validate_file : 
  ?draft:draft ->
  schema:string ->
  Yojson.Basic.t ->
  (unit, validation_error) result

Validate JSON against a schema from a file/URL

Source

val validate_strings : 
  ?draft:draft ->
  schema:string ->
  json:string ->
  unit ->
  (unit, validation_error) result

Validate JSON string against schema string

Source

val create_validator : 
  ?draft:draft ->
  ?enable_format_assertions:bool ->
  ?enable_content_assertions:bool ->
  string ->
  (validator, compile_error) result

Create a reusable validator for efficiency

Sourceval validate : validator -> Yojson.Basic.t -> (unit, validation_error) result

Validate using a pre-compiled validator

Source

val create_validator_with_loader : 
  ?draft:draft ->
  ?enable_format_assertions:bool ->
  ?enable_content_assertions:bool ->
  url_loader:Loader.url_loader ->
  schema:Yojson.Basic.t ->
  unit ->
  (validator, compile_error) result

Create a validator with a custom URL loader for remote refs

Source

val create_validator_from_json : 
  ?draft:draft ->
  ?enable_format_assertions:bool ->
  ?enable_content_assertions:bool ->
  schema:Yojson.Basic.t ->
  unit ->
  (validator, compile_error) result

Create a validator from JSON schema (for testing)

Sourceval draft4_validator : validator

Pre-compiled validators for meta-schemas

Sourceval draft6_validator : validator

Sourceval draft7_validator : validator

Sourceval draft2019_09_validator : validator

Sourceval draft2020_12_validator : validator

Low-Level API

Compilation

Sourcemodule Compiler : sig ... end

Schema Operations

Sourcemodule Schema : sig ... end

Types

Sourcemodule Types : sig ... end

Output Formats

Sourcemodule Output : sig ... end

Format Validation

Sourcemodule Format : sig ... end

Content Validation

Sourcemodule Content : sig ... end

URL Loading

Sourcemodule Loader : sig ... end

Utilities

Sourcemodule Draft : sig ... end

Sourcemodule Json_pointer : sig ... end

Sourcemodule Validation_error : sig ... end

Pretty Printing

Sourceval pp_compile_error : Format.formatter -> compile_error -> unit

Sourceval pp_validation_error : Format.formatter -> validation_error -> unit

Sourceval pp_validation_error_verbose : Format.formatter -> validation_error -> unit

package jsonschema

Module JsonschemaSource

Core Types

High-Level API

Low-Level API

Compilation

Schema Operations

Types

Output Formats

Format Validation

Content Validation

URL Loading

Utilities

Pretty Printing

Module `Jsonschema`Source