schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
chutzpah.json
SkipIfUnchanged
Skips the execution if all files Chutzpah knows about are older than all of the output files. This is defaulted to true but if you hit issues since it is possible Chutzpah might not know about all the files your compilation is using then you can turn this off. Ideally you should tell Chutzpah about these files using the references and tests settings since this setting helps Chutzpah not need to even invoke the executable if it figures out it's not needed.
{"type": "boolean", "default": true}
chutzpah.json
Mode
Determines how this compile setting is used. By default it is in Executable mode where it will require you provide an executable which Chutzpah will run if it sees it finds missing .js for input file. If you set this to External then Chutzpah will ignore the Executable, Arguments settings and assume you have some external process which is compiling. In this case Chutzpah will use the SourceDirectory and OutDirectory options to try to find your .js files for the input files. If it can't find them it will trace an error but still attempt to proceed.
{"type": "string", "enum": ["Executable", "External"], "default": "External"}
chutzpah.json
UseSourceMaps
Configures whether .map files should be loaded (if available) to convert under-test JS line numbers to those of their original source files.
{"type": "boolean", "default": false}
chutzpah.json
IgnoreMissingFiles
Should Chutzpah ignore files it expects to find compiled. If set to true Chutzpah will log an error otherwise it will throw
{"type": "boolean", "default": false}
chutzpah.json
Framework
Determines what testing framework to use. This will override the other detection methods.
{"type": "string", "enum": ["qunit", "jasmine", "mocha"]}
chutzpah.json
FrameworkVersion
Tells Chutzpah if it should use a different version of on of the test frameworks than the default one. Currently, the only framework this works for is Jasmine. As of the 3.1.0 release Chutzpah default to Jasmine 2.0 but if you want to use the 1.0 line for Jasmine still pass '1' for FrameworkVersion.
{"type": "string"}
chutzpah.json
References
The references setting allows you to specify which files/folders to use/scan to find references. This is useful since it replaces the need to the ///<reference comments.
{"type": "array", "items": {}}
chutzpah.json
Tests
The references setting allows you to specify which files/folders to use/scan to find references. This is useful since it replaces the need to the ///<reference comments.
{"type": "array", "items": {}}
chutzpah.json
Engine
The browser engine to use to run the tests. Default is Phantom but JSDOM and Chrome are available. If you choose Chrome you must have an instance of Chrome or Chromium on the machine that Chutzpah can find.
{"type": "string", "enum": ["Phantom", "JSDom", "Chrome"]}
chutzpah.json
Transforms
List of transformers to run after testing to generate output files
{"type": "array", "items": {}}
chutzpah.json
TestFileTimeout
The time to wait for tests in a file to finish in milliseconds.
{"type": "integer"}
chutzpah.json
TestHarnessLocationMode
Determines where to place the generated html test harness files. The default mode is TestFileAdjacent which means the harness is placed in the same directory as the test file. SettingsFileAdjacent means it is placed in the same directory as the chutzpah.json file. Custom mode lets you specify a custom path to the directory.
{"type": "string", "enum": ["TestFileAdjacent", "SettingsFileAdjacent", "Custom"]}
chutzpah.json
TestHarnessDirectory
When TestHarnessLocationMode is set to Custom this is either the relative or absolute path to the directory where to place the test harness.
{"type": "string"}
chutzpah.json
RootReferencePathMode
This property determines what directory a rooted reference path refers to.
{"type": "string", "enum": ["DriveRoot", "SettingsFileDirectory"], "default": "DriveRoot"}
chutzpah.json
CodeCoverageTimeout
The timeout in milliseconds for how long to wait to instrument each file for code coverage. Defaults to 5000ms.
{"type": "integer", "default": 5000}
chutzpah.json
CodeCoverageExecutionMode
If Always, forces code coverage to run always. If Manual/null/not set, allows code coverage to run if invoked using test adapter, command line or context menu options (default). If Never, forces code coverage to never run.
{"type": "string", "enum": ["Manual", "Always", "Never"]}
chutzpah.json
CodeCoverageSuccessPercentage
The percentage of lines needing to be covered to show the coverage output as success or failure. By default this is 60.
{"type": "number"}
chutzpah.json
CodeCoverageIncludes
The collection code coverage file patterns to include in coverage. These are in glob format. If you specify none all files are included.
{"type": "array", "items": {"type": "string"}}
chutzpah.json
CodeCoverageExcludes
The collection code coverage file patterns to exclude in coverage. These are in glob format. If you specify none no files are excluded.
{"type": "array", "items": {"type": "string"}}
chutzpah.json
CustomTestHarnessPath
The CustomTestHarnessPath setting allows you to override the default template Chutzpah uses for the HTML test harness. This is an advanced feature which should only be used as a last resort.
{"type": "string"}
chutzpah.json
MochaInterface
The name of the Mocha interface to use. Overrides the default detection mechanism.
{"type": "string", "enum": ["bdd", "tdd", "qunit"]}
chutzpah.json
AMDBaseUrl
Set the baseurl for Chutzpah to use when generating the test harness. Defaults to the test harness directory if not set.
{"type": "string"}
chutzpah.json
AMDAppDirectory
Sets the root directory for your AMD paths. This is only needed if your baseUrl is a different location than your source directory. This is common if you are compiling from another language to JavaScript and copying those compiled files to a different folder. For example if you have all your .ts files in /src and you compile them to a /out directory then your AMDBaseUrl is /out and AMDAppDirectory is /src. Defaults to the test harness directory if not set.
{"type": "string"}
chutzpah.json
UserAgent
The user agent to use when making web requests
{"type": "string"}
chutzpah.json
TestPattern
When Chutzpah reports test results it also tells you what line they are on. The way this is accomplished is by having a regex for each testing framework which describes where to find the names of your tests.
{"type": "string", "format": "regex"}
chutzpah.json
EnableTestFileBatching
Determines if batch all test files for this chutzpah.json file should be batched into one test harness. This will often make your test run much faster.
{"type": "boolean"}
chutzpah.json
InheritFromParent
Determines if this settings file should inherit and merge with the settings of its parent settings file. The parent is found by recursively walking up the tree.
{"type": "boolean"}
chutzpah.json
IgnoreResourceLoadingErrors
Suppress errors that are reported when a script request to load a url (e.g. xhr/script/image) fails.
{"type": "boolean"}
chutzpah.json
EnableTracing
Logs tracing information to a log file.
{"type": "boolean"}
chutzpah.json
TraceFilePath
The path to write the trace file to. Defaults tp %temp%/chutzpah.log.
{"type": "string"}
chutzpah.json
Parallelism
Max degree of parallelism for running tests. Defaults to number of CPUs
{"type": "number"}
chutzpah.json
BrowserArguments
The dictionary of browser name (keys) to corresponding browser arguments (values), i.e.; { 'chrome': '--allow-file-access-from-files' }.
{"type": "object"}
repository-configuration-schema.json
The OSS-Review-Toolkit (ORT) provides a possibility to configure exclusions, resolutions and more in a file called `.ort.yml`. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-ort-yml.md.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"analyzer": {}, "excludes": {"type": "object", "properties": {"paths": {"type": "array", "items": {"type": "object", "properties": {"pattern": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["pattern", "reason"]}}, "scopes": {"type": "array", "items": {"type": "object", "properties": {"pattern": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["pattern", "reason"]}}}}, "resolutions": {}, "curations": {"type": "object", "properties": {"license_findings": {"type": "array", "items": {}}, "packages": {}}, "anyOf": [{"required": ["license_findings"]}, {"required": ["packages"]}]}, "package_configurations": {"type": "array", "items": {}}, "license_choices": {"type": "object", "properties": {"package_license_choices": {"type": "array", "items": {"type": "object", "properties": {"package_id": {"type": "string"}, "license_choices": {"type": "array", "items": {"type": "object", "properties": {"given": {"type": "string"}, "choice": {"type": "string"}}, "required": ["choice"]}}}, "required": ["package_id", "license_choices"]}}, "repository_license_choices": {"type": "array", "items": {"given": {"type": "string"}, "choice": {"type": "string"}}}}}}, "definitions": {"licenseFindingCurations": {"type": "object", "properties": {"path": {"type": "string"}, "start_lines": {"type": ["integer", "string"]}, "line_count": {"type": "integer"}, "detected_license": {"type": "string"}, "concluded_license": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["path", "concluded_license", "reason"]}, "pathExcludeReason": {"enum": ["BUILD_TOOL_OF", "DATA_FILE_OF", "DOCUMENTATION_OF", "EXAMPLE_OF", "OPTIONAL_COMPONENT_OF", "OTHER", "PROVIDED_BY", "TEST_OF", "TEST_TOOL_OF"]}, "scopeExcludeReason": {"enum": ["BUILD_DEPENDENCY_OF", "DEV_DEPENDENCY_OF", "PROVIDED_DEPENDENCY_OF", "TEST_DEPENDENCY_OF", "RUNTIME_DEPENDENCY_OF"]}, "licenseFindingCurationReason": {"enum": ["CODE", "DATA_OF", "DOCUMENTATION_OF", "INCORRECT", "NOT_DETECTED", "REFERENCE"]}}}
repository-configuration-schema.json
excludes
Defines which parts of a repository should be excluded.
{"type": "object", "properties": {"paths": {"type": "array", "items": {"type": "object", "properties": {"pattern": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["pattern", "reason"]}}, "scopes": {"type": "array", "items": {"type": "object", "properties": {"pattern": {"type": "string"}, "reason": {}, "comment": {"type": "string"}}, "required": ["pattern", "reason"]}}}}
repository-configuration-schema.json
pattern
A glob to match the path of the project definition file, relative to the root of the repository.
{"type": "string"}
repository-configuration-schema.json
curations
Curations for artifacts in a repository.
{"type": "object", "properties": {"license_findings": {"type": "array", "items": {}}, "packages": {}}, "anyOf": [{"required": ["license_findings"]}, {"required": ["packages"]}]}
repository-configuration-schema.json
package_configurations
A configuration for a specific package and provenance.
{"type": "array", "items": {}}
repository-configuration-schema.json
license_choices
A configuration to select a license from a multi-licensed package.
{"type": "object", "properties": {"package_license_choices": {"type": "array", "items": {"type": "object", "properties": {"package_id": {"type": "string"}, "license_choices": {"type": "array", "items": {"type": "object", "properties": {"given": {"type": "string"}, "choice": {"type": "string"}}, "required": ["choice"]}}}, "required": ["package_id", "license_choices"]}}, "repository_license_choices": {"type": "array", "items": {"given": {"type": "string"}, "choice": {"type": "string"}}}}}
vercel.json
$schema
Ignored. Can be set to get completions, validations and documentation in some editors.
{"example": ["https://openapi.vercel.sh/vercel.json"], "type": "string"}
vercel.json
alias
Aliases that will get assigned when the deployment is `READY` and the target is `production`. The client needs to make a `GET` request to its API to ensure the assignment
{"example": ["example.vercel.app"], "oneOf": [{"private": true, "type": "string"}, {"items": {"maxLength": 253, "type": "string"}, "maxItems": 50, "maxLength": 253, "type": "array"}]}
vercel.json
build
An object containing another object with information to be passed to the Build Process
{"additionalProperties": false, "deprecated": true, "properties": {"env": {"additionalProperties": false, "example": {"A_SECRET": "@a-secret"}, "deprecated": true, "maxProperties": 100, "minProperties": 0, "patternProperties": {".+": {"maxLength": 65536, "minLength": 0, "type": "string"}}, "type": "object"}}, "type": "object"}
vercel.json
env
An object containing the deployment's environment variable names and values to be passed to Builds. Secrets can be referenced by prefixing the value with `@`
{"additionalProperties": false, "example": {"A_SECRET": "@a-secret"}, "deprecated": true, "maxProperties": 100, "minProperties": 0, "patternProperties": {".+": {"maxLength": 65536, "minLength": 0, "type": "string"}}, "type": "object"}
vercel.json
builds
A list of build descriptions whose src references valid source files.
{"deprecated": true, "items": {"additionalProperties": false, "properties": {"config": {"type": "object"}, "src": {"maxLength": 4096, "minLength": 1, "type": "string"}, "use": {"maxLength": 256, "minLength": 3, "type": "string"}}, "required": ["use"], "type": "object"}, "maxItems": 128, "minItems": 0, "type": "array"}
vercel.json
config
Optionally, an object including arbitrary metadata to be passed to the Builder
{"type": "object"}
vercel.json
src
A glob expression or pathname. If more than one file is resolved, one build will be created per matched file. It can include `*` and `**`
{"maxLength": 4096, "minLength": 1, "type": "string"}
vercel.json
use
An npm module to be installed by the build process. It can include a semver compatible version (e.g.: `@org/proj@1`)
{"maxLength": 256, "minLength": 3, "type": "string"}
vercel.json
cleanUrls
When set to `true`, all HTML files and Serverless Functions will have their extension removed. When visiting a path that ends with the extension, a 308 response will redirect the client to the extensionless path.
{"type": "boolean"}
vercel.json
env
An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@`
{"additionalProperties": false, "example": {"A_SECRET": "@a-secret"}, "deprecated": true, "maxProperties": 100, "minProperties": 0, "patternProperties": {".+": {"maxLength": 65536, "minLength": 0, "type": "string"}}, "type": "object"}
vercel.json
functions
An object describing custom options for your Serverless Functions. Each key must be glob pattern that matches the paths of the Serverless Functions you would like to customize (like `api/*.js` or `api/test.js`).
{"additionalProperties": false, "example": {"src/pages/**": {"maxDuration": 6, "memory": 1024}}, "maxProperties": 50, "minProperties": 1, "patternProperties": {"^.{1,256}$": {"additionalProperties": false, "properties": {"excludeFiles": {"maxLength": 256, "type": "string"}, "includeFiles": {"maxLength": 256, "type": "string"}, "maxDuration": {"maximum": 900, "minimum": 1, "type": "number"}, "memory": {"maximum": 3008, "minimum": 128, "type": "number"}, "runtime": {"maxLength": 256, "type": "string"}}, "type": "object"}}, "type": "object"}
vercel.json
excludeFiles
A glob pattern to match files that should be excluded from your Serverless Function. If you’re using a Community Runtime, the behavior might vary.
{"maxLength": 256, "type": "string"}
vercel.json
includeFiles
A glob pattern to match files that should be included in your Serverless Function. If you’re using a Community Runtime, the behavior might vary.
{"maxLength": 256, "type": "string"}
vercel.json
maxDuration
An integer defining how long your Serverless Function should be allowed to run on every request in seconds (between 1 and the maximum limit of your plan).
{"maximum": 900, "minimum": 1, "type": "number"}
vercel.json
memory
An integer defining the memory your Serverless Function should be provided with (between 128 and 3008).
{"maximum": 3008, "minimum": 128, "type": "number"}
vercel.json
runtime
The npm package name of a Runtime, including its version
{"maxLength": 256, "type": "string"}
vercel.json
deploymentEnabled
Specifies the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is `true` by default.
{"example": {"main": false}, "oneOf": [{"type": "boolean"}, {"type": "object", "additionalProperties": {"type": "boolean"}}]}
vercel.json
autoAlias
When set to `false`, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.
{"type": "boolean"}
vercel.json
autoJobCancelation
When set to `false`, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.
{"type": "boolean"}
vercel.json
enabled
When set to false, Vercel for GitHub will not apply the alias upon merge.
{"type": "boolean"}
vercel.json
silent
When set to `true`, Vercel for GitHub will stop commenting on pull requests and commits.
{"type": "boolean"}
vercel.json
headers
A list of header definitions.
{"type": "array", "maxItems": 1024, "items": {"type": "object", "additionalProperties": false, "required": ["source", "headers"], "properties": {"source": {"type": "string", "maxLength": 4096}, "headers": {"type": "array", "maxItems": 1024, "items": {"type": "object", "additionalProperties": false, "required": ["key", "value"], "properties": {"key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}}, "has": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}, "missing": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}}}}
vercel.json
source
A pattern that matches each incoming pathname (excluding querystring)
{"type": "string", "maxLength": 4096}
vercel.json
headers
An array of key/value pairs representing each response header.
{"type": "array", "maxItems": 1024, "items": {"type": "object", "additionalProperties": false, "required": ["key", "value"], "properties": {"key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}}
vercel.json
has
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
missing
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
name
A name for the deployment
{"type": "string"}
vercel.json
public
Whether a deployment's source and logs are available publicly
{"type": "boolean"}
vercel.json
redirects
A list of redirect definitions.
{"type": "array", "maxItems": 1024, "items": {"type": "object", "additionalProperties": false, "required": ["source", "destination"], "properties": {"source": {"type": "string", "maxLength": 4096}, "destination": {"type": "string", "maxLength": 4096}, "permanent": {"type": "boolean"}, "statusCode": {"private": true, "type": "integer", "minimum": 100, "maximum": 999}, "has": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}, "missing": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}}}}
vercel.json
source
A pattern that matches each incoming pathname (excluding querystring).
{"type": "string", "maxLength": 4096}
vercel.json
destination
A location destination defined as an absolute pathname or external URL.
{"type": "string", "maxLength": 4096}
vercel.json
permanent
A boolean to toggle between permanent and temporary redirect. When `true`, the status code is `308`. When `false` the status code is `307`.
{"type": "boolean"}
vercel.json
has
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
missing
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
regions
An array of the regions the deployment's Serverless Functions should be deployed to
{"example": ["sfo", "bru"], "items": {"maxLength": 256, "type": "string"}, "maxItems": 1000, "minItems": 1, "type": "array"}
vercel.json
rewrites
A list of rewrite definitions.
{"type": "array", "maxItems": 1024, "items": {"type": "object", "additionalProperties": false, "required": ["source", "destination"], "properties": {"source": {"type": "string", "maxLength": 4096}, "destination": {"type": "string", "maxLength": 4096}, "has": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}, "missing": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}}}}
vercel.json
source
A pattern that matches each incoming pathname (excluding querystring).
{"type": "string", "maxLength": 4096}
vercel.json
destination
An absolute pathname to an existing resource or an external URL.
{"type": "string", "maxLength": 4096}
vercel.json
has
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}