Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search Sign up Reseting focus

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

The JSON Schema specification

License

Notifications You must be signed in to change notification settings

json-schema-org/json-schema-spec

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Go to file

Folders and files

Last commit message Last commit date

Latest commit

History

View all files

Repository files navigation

Welcome to JSON Schema

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 Labels are assigned based on Sensible Github Labels.

Authoring and Building

Specification

To build the spec files to HTML from the Markdown sources, run npm run build-all . You can also build each individually with npm run build -- filename.md (Example: npm run build -- jsonschema-core.md ). You can also use wildcards to build multiple specs at the same time: npm run build -- jsonschema-*.md . The spec is built using Remark, a markdown engine with good support for plugins and lots of existing plugins we can use.

Plugins

remark-lint -- Enforce markdown styles guide.
remark-validate-links -- Check for broken links.
remark-gfm -- Adds support for Github Flavored Markdown specific markdown features such as autolink literals, footnotes, strikethrough, tables, and tasklists.
remark-heading-id -- Adds support for syntax to add an id to an element so it can be referenced using URI fragment syntax.
remark-headings -- A collection of enhancements for headings.
- Adds hierarchical section numbers to headings.
  - Use the [Appendix] prefix on headings that should be numbered as an appendix.
  - Example: #section-2-13
  - Example: #appendix-a
  - Example:
```
## Foo ## Bar This is covered in > // --> Renders to "This is covered in [Section 2.3](#foo)" - Link text will use "Section" or "Appendix" as needed
```
```
\`\`\`jsonschema "My Fun Title" < "type": "string" >\`\`\`
```
  Internet-Drafts
  
  To build components that are being maintained as IETF Internet-Drafts, run make . 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:
  - https://xml2rfc.tools.ietf.org/authoring/draft-mrose-writing-rfcs.html
  - https://www.ietf.org/tao.html
  - https://www.ietf.org/ietf-ftp/1id-guidelines.html
  - https://www.rfc-editor.org/rfc/rfc7322.txt
  Test suites
  
  Conformance tests for JSON Schema and its vocabularies may be found in their own repository.