Skip to content
A documenter for JSON schemas
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
docs
font
include
lib
schemas
LICENSE
README.md
app.css
index.html
loaderFactory.js
myTour.js
myapp.js

README.md

JSON schema documenter

The JSON schema documeter is an AngularJS web application that supports the visualization of JSON schemas (draft-4).

A live version of the JSONSchema-documenter is available at: https://fairsharing.github.io/JSONschema-documenter/. By default, it will load the DAta Tag Suite (DATS) study schema.

To customize the application to visualize other schemas, you can use two parameters:

  • schema_url is the URL to the main JSON schema of a network of schemas (this is required, by default, we use the DATS.study schema)
  • context_mapping_url is the URL to a file that maps each schema to a context file (this is optional)
  • Note: make sure that all mapping URLs in the mapping file points to https endpoints or the page will trigger an error

These parameters are set in the web application URL, for example:

https://fairsharing.github.io/JSONschema-documenter/index.html?schema_url=https://w3id.org/dats/schema/study_schema.json

If you have a mapping file of your JSON-LD context files, you can also pass it as a parameter. For example:

https://fairsharing.github.io/JSONschema-documenter/index.html?schema_url=https://w3id.org/dats/schema/study_schema.json&context_mapping_url=schemas/dats_mapping.json

For an example of a mapping file, check https://fairsharing.github.io/JSONschema-documenter/schemas/dats_mapping.json

License

This code is provided under BSD 3-Clause License

Contact

You can’t perform that action at this time.