Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 6.64 KB

README.md

File metadata and controls

98 lines (64 loc) · 6.64 KB
Raw

Welcome to JSON Schema

Contributor Covenant Project Status: Active – The project has reached a stable, usable state and is being actively developed. Financial Contributors on Open Collective

JSON Schema is a vocabulary that allows you to validate, annotate, and manipulate JSON documents.

This repository contains the sources for the work in progress of the next set of JSON Schema IETF Internet Draft (I-D) documents. For the latest released I-Ds, please see the Specification page on the website.

Call for contributions and feedback

Reviews, comments and suggestions are most welcome! Please read our guidelines for contributing.

Status

For the current status of issues and pull requests, please see the following labels

Available In Progress Review Needed

Critical High Medium Low

Labels are assigned based on Sensible Github Labels.

Contents

  • Makefile - scripts to build the Internet-Draft txt/html
  • Internet-Draft sources
    • jsonschema-core.xml - source for JSON Schema's "core" I-D
    • jsonschema-validation.xml - source for the validation vocabulary I-D
    • relative-json-pointer.xml - source for the Relative JSON Pointer I-D
  • meta-schemas and recommended output formats
    • schema.json - JSON Schema "core" and Validation meta-schema

The Makefile will create the necessary Python venv for you as part of the regular make target.

make clean will remove all output including the venv. To clean just the spec output and keep the venv, use make spec-clean.

If you want to run xml2rfc manually after running make for the first time, you will need to activate the virtual environment:

source .venv/bin/activate

The version of "xml2rfc" that this project uses is updated by modifying requirements.in and running pip-compile requirements.in.

Descriptions of the xml2rfc, I-D documents, and RFC processes:

Test suites

Conformance tests for JSON Schema and its vocabularies may be found in their own repository.

The website

The JSON Schema web site is at http://json-schema.org/

The source for the website is maintained in a separate repository.

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Sponsors

Here are our top sponsors. You could be next! [Become a sponsor]

Individuals

License

The contents of this repository are licensed under either the BSD 3-clause license or the Academic Free License v3.0.