https://github.com/vercel/schemas

All schemas used for validation that are shared between our projects
https://github.com/vercel/schemas

ajv json schemas validation

Last synced: 10 days ago
JSON representation

All schemas used for validation that are shared between our projects

• Host: GitHub
• URL: https://github.com/vercel/schemas
• Owner: vercel
• License: mit
• Created: 2018-05-16T10:03:45.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T20:30:07.000Z (3 months ago)
• Last Synced: 2024-11-21T02:16:20.061Z (23 days ago)
• Topics: ajv, json, schemas, validation
• Language: JavaScript
• Homepage: https://npmjs.com/@zeit/schemas
• Size: 145 KB
• Stars: 83
• Watchers: 51
• Forks: 27
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

```js

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

```

Next, set up [AJV](https://github.com/epoberezkin/ajv) (the validator) and run the schema through it:

```js

const AJV = require('ajv');

const ajv = new AJV({ allErrors: true });

const isValid = ajv.validate(schema, );

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.