[![](https://i.imgur.com/ViMJuSr.jpg)](https://altar.host)

[![](https://img.shields.io/badge/dynamic/json?color=5865F2&label=discord&query=approximate_member_count&suffix=%20members&url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvite%2FpcPc5VRDXn%3Fwith_counts%3Dtrue)](https://discord.gg/pcPc5VRDXn) [![](https://badgen.net/github/status/altarhost/schemas) ![](https://badgen.net/github/open-issues/altarhost/schemas) ![](https://badgen.net/github/commits/altarhost/schemas) ![](https://badgen.net/github/last-commit/altarhost/schemas) ![](https://badgen.net/github/license/altarhost/schemas)](https://github.com/altarhost/schemas) [![](https://badgen.net/npm/v/@altarhost/schemas) ![](https://badgen.net/npm/dm/@altarhost/schemas) ![](https://badgen.net/packagephobia/install/@altarhost/schemas)](https://www.npmjs.com/package/@altarhost/schemas)

# @altarhost/schemas
**JSON Schema** is a vocabulary that allows you to annotate and validate JSON documents. We use this technology to define the various structures of documents and the expected communication structures.

## table of contents
- [@altarhost/schemas](#altarhostschemas)
  - [table of contents](#table-of-contents)
  - [benefits](#benefits)
  - [references](#references)

## benefits
- describes your existing data format(s).
- provides clear human- and machine- readable documentation.
  - validates data which is useful for:
  - automated testing.
- ensuring quality of client submitted data.

## references
- [website](https://altar.host), [api documentation](https://altar.host/docs/api).
- @altarhost/schemas: [docs](https://altarhost.github.io/schemas), [npm](https://www.npmjs.com/package/@altarhost/schemas), [github](https://github.com/altarhost/schemas).
- @altarhost/eslint-config: [npm](https://www.npmjs.com/package/@altarhost/eslint-config), [github](https://github.com/altarhost/eslint-config).
- json schema: [website](https://json-schema.org/), [spec](https://json-schema.org/specification.html), [github](https://github.com/json-schema-org).