Schema registry

now

ZEIT Now project configuration file

now.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your now.json and it validates in your browser — nothing is uploaded.

Validate a now.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`name`	`string`	name for the deployment
`version`	`enum`	the Now Platform version that the deployment should use and is known to work with default: `2` one of: `1, 2`
`alias`	`oneOf`	—
`scope`	`string`	an ID or slug for teams, or an email address, username, or ID for users
`env`	`object`	environment keys and values
`build`	`object`	—
`build.env`	`object`	environment keys and values
`builds`	`array<object>`	a list of build descriptions whose src references valid source files
`routes`	`array<object>`	a list of route definitions
`regions`	`array<string>`	the deployment regions of the Serverless Functions that get created as a result of the build steps
`public`	`boolean`	When set to true, both the source view and logs view will be publicly accessible (when the user is authenticated with ZEIT).
`github`	`object`	Git integration options
`github.enabled`	`boolean`	When set to false, Now for GitHub will not deploy the given project regardless of the GitHub app being installed. default: `true`
`github.autoAlias`	`boolean`	When set to false, Now for GitHub will not apply the alias upon merge. default: `true`
`github.silent`	`boolean`	When set to true, Now for GitHub will stop commenting on pull requests and commits. default: `false`
`github.autoJobCancelation`	`boolean`	When set to false, Now for GitHub will always build pushes in sequence without cancelling a build for the most recent commit. default: `true`

Audit

What we found in this schema

Declared draft: draft-04
Validates cleanly against its own meta-schema.
26 properties, 88% carrying a description, max nesting depth 7.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`maxItems`	JSON Schema Validation, draft 2020-12	§6.4.1 — "maxItems"
`maxLength`	JSON Schema Validation, draft 2020-12	§6.3.1 — "maxLength"
`maximum`	JSON Schema Validation, draft 2020-12	§6.2.2 — "maximum"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas