@zeit/schemas

Vercel Schemas

Schemas used across many Vercel packages to validating config files, requests to APIs, and more.

Why?

• Keep schemas used across Vercel projects in sync
• We use .js instead of .json because parsing JSON takes longer

Usage

To get started, pick one of the schemas in this repository and load it:

const schema = require('@zeit/schemas/deployment/config');

Next, set up AJV (the validator) and run the schema through it:

const AJV = require('ajv');

const ajv = new AJV({ allErrors: true });
const isValid = ajv.validate(schema, <object-to-validate>);

if (!isValid) {
	console.error(`The following entries are wrong: ${JSON.stringify(ajv.errors)}`);
}

That is all! :tada:

Contributing

We are currently not accepting external contributions for this repository.

Similar packages

Other packages similar to @zeit/schemas

ajv

Ajv is a JSON schema validator that is widely used for validating JSON objects against JSON schemas. While @zeit/schemas provides specific schemas for ZEIT configurations, Ajv is a more general-purpose tool that can be used with any JSON schema, including those from @zeit/schemas.

jsonschema

jsonschema is another library for validating JSON objects against schemas. It is similar to Ajv but offers a different API and set of features. Like Ajv, it can be used to validate configurations against the schemas provided by @zeit/schemas.