Hackage :: [Package]

hjsonschema: JSON Schema library

[ data, deprecated, library, mit ] [ Propose Tags ] [ Report a vulnerability ]
Deprecated
Versions [RSS] 0.1.0.0, 0.1.1.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.5.0.0, 0.5.1.0, 0.5.1.1, 0.5.1.2, 0.5.1.3, 0.5.2.0, 0.5.2.1, 0.5.2.2, 0.5.3.0, 0.5.3.1, 0.5.3.2, 0.6.0.0, 0.6.0.1, 0.6.0.2, 0.7.0.0, 0.7.1.0, 0.8.0.0, 0.8.0.1, 0.9.0.0, 0.10.0.0, 0.10.0.1, 0.10.0.2, 0.10.0.3, 1.0.0.0, 1.1.0.0, 1.1.0.1, 1.2.0.0, 1.2.0.1, 1.2.0.2, 1.3.0.0, 1.3.0.1, 1.4.0.0, 1.5.0.0, 1.5.0.1, 1.6.0, 1.6.1, 1.6.2, 1.6.3, 1.7.0, 1.7.1, 1.7.2, 1.8.0, 1.9.0, 1.10.0 (info)
Change log changelog.txt
Dependencies aeson (>=0.11 && <1.2), base (>=4.7 && <4.10), bytestring (>=0.10 && <0.11), containers (>=0.5 && <0.6), file-embed (>=0.0.8 && <0.1), filepath (>=1.3 && <1.5), hashable (>=1.2 && <1.3), hjsonpointer (>=1.1 && <1.2), http-client (>=0.4.30 && <0.6), http-types (>=0.8 && <0.10), pcre-heavy (>=1.0 && <1.1), profunctors (>=5.0 && <5.3), protolude (>=0.1.10 && <1.2), QuickCheck (>=2.8 && <2.10), scientific (>=0.3 && <0.4), semigroups (>=0.18 && <0.19), text (>=1.1 && <1.3), unordered-containers (>=0.2 && <0.3), vector (>=0.10 && <0.12) [details]
License MIT
Author Ian Grant Jeffries
Maintainer ian@housejeffries.com
Category Data
Home page https://github.com/seagreen/hjsonschema
Source repo head: git clone git://github.com/seagreen/hjsonschema.git
Uploaded by seagreen at 2017-01-07T00:20:40Z
Distributions
Reverse Dependencies 6 direct, 1 indirect [details]
Downloads 32993 total (63 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-01-07 [all 1 reports]

Readme for hjsonschema-1.3.0.0

[back to package description]

hjsonschema logo

A Haskell implementation of the most commonly used JSON Schema specification (Draft 4).

Hackage / GitHub / Travis CI

Notes

  • As of 2017 json-schema-org has begun releasing new drafts of the standard. Once this work stabilizes hjsonschema will add coverage for the latest draft.

  • Requires pcre (pkgs.pcre in Nixpkgs).

  • Schemas with circular references can cause infinite loops. hjsonschema does loop detection but it may not be solid yet -- please open an issue if you find a situation where it fails.

Example

See here.

Tests

Run all tests:

stack test

Run only local tests:

stack test hjsonschema:local

Run remote tests (makes GETs to json-schema.org, also temporarily starts an HTTP server on port 1234):

stack test hjsonschema:remote

Details

Goals

  • Be a correct and fast implementation of the spec.

  • Be a useful reference for implementers in other languages. Haskell's high level nature, expressive type system and referential transparency suit this purpose well.

Good Parts

  • Passes all the required tests in the language agnostic test suite.

  • Very modular, which should make it easy to support future versions of the specification.

Bad Parts

  • Uses the pcre-heavy regular expression library for the "pattern" validator. It should use a library based on the ECMA 262 regex dialect, which the spec requires.

  • Currently doesn't support the optional "format" validators.

Vendoring

  • JSON-Schema-Test-Suite is vendored from commit # aabcb3427745ade7a0b4d49ff016ad7eda8b898b here.

  • src/draft4.json is from commit # f3d5aeb5ffbe9d9a5a0ceb761dc47c7c4c2efa68 here.

Credits

TJ Weigel created the logo.

Tim Baumann wrote aeson-schema, on which hjsonschema's test code and its implementation of SchemaGraph were based.

Julian Berman maintains the fantastic language agnostic test suite.