name
stringlengths 7
62
| content
stringlengths 200
6.79M
|
|---|---|
scenario_schema.json | {"title":"CrowdSec Scenario","$schema":"https://json-schema.org/draft-04/schema","$id":"http://schemas.crowdsec.net/schemas/scenario.yaml","oneOf":[{"$ref":"#/$defs/leaky"},{"$ref":"#/$defs/counter"},{"$ref":"#/$defs/trigger"},{"$ref":"#/$defs/conditional"}],"$defs":{"leaky":{"required":["type","name","leakspeed","description"],"additionalProperties":"","type":"object","properties":{"distinct":{"description":"An expr expression that must return a string. The event will be\npoured only if the string is not already present in the bucket.\n","type":"string"},"capacity":{"type":"integer","description":"Only applies to leaky buckets. A positive integer\nrepresenting the bucket capacity. If there are more than\ncapacity item in the bucket, it will overflow.\n"},"cache_size":{"type":"number","description":"By default, a bucket holds capacity events \"in memory\". However,\nfor a number of cases, you don't want this, as it might lead to\nexcessive memory consumption. By setting cache_size to a\npositive integer, we can control the maximum in-memory cache\nsize of the bucket, without changing its capacity and such. It\nis useful when buckets are likely to stay alive for a long time\nor ingest a lot of events to avoid storing a lot of events in\nmemory.\n"},"overflow_filter":{"description":"overflow_filter is an expression that is run when the bucket\noverflows. If this expression is present and returns false, the\noverflow will be discarded.\n","type":"string"},"filter":{"type":"string","description":"filter must be a valid expr expression that will be evaluated\nagainst the event. If filter evaluation returns true or is\nabsent, event will be pour in the bucket. If filter returns\nfalse or a non-boolean, the event will be skipped for this\nbucket.\n"},"type":{"enum":["leaky"],"type":"string","description":"Defines the type of the bucket. Currently three types are\nsupported : leaky : a leaky bucket that must be configured\nwith a capacity and a leakspeed trigger : a bucket that\noverflows as soon as an event is poured (it is like a leaky\nbucket is a capacity of 0) counter : a bucket that only\noverflows every duration. It is especially useful to count\nthings.\n"},"reprocess":{"description":"If set to true, the resulting overflow will be sent again in the\nscenario/parsing pipeline. It is useful when you want to have\nfurther scenarios that will rely on past-overflows to take\ndecision\n","type":"boolean"},"name":{"description":"\"github_account_name/my_scenario_name\" or name:\n\"my_author_name/my_scenario_name\" name is mandatory\n","type":"string"},"description":{"description":"The description is mandatory. It is a short description,\nprobably one sentence, describing what it detects.\n","type":"string"},"leakspeed":{"description":"Only applies to leaky buckets. A duration that represent how\noften an event will be leaking from the bucket.\n","pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$","type":"string"},"cancel_on":{"type":"string","description":"cancel_on is an expression that runs on each event poured to the\nbucket. If the cancel_on expression returns true, the bucket is\nimmediately destroyed (and doesn't overflow).\n"},"format":{"minimum":"1.0","description":"CrowdSec has a notion of format support for parsers and\nscenarios for compatibility management. Running cscli version\nwill show you such compatibility matrix :\n","type":"number"},"debug":{"description":"If set to to true, enabled scenario level debugging. It is meant\nto help understanding scenario behavior by providing contextual\n","type":"boolean"},"data":{"$ref":"#/$defs/data"},"scope":{"type":"object","properties":{"type":{"type":"string"},"expression":{"type":"string"}},"description":"While most scenarios might focus on IP addresses, CrowdSec and Bouncers can work with any scope. The scope directive allows you to override the default scope :\n type is a string representing the scope name\n expression is an expr expression that will be evaluated to fetch the value\n","additionalProperties":""},"groupby":{"type":"string","description":"An expr expression that must return a string. This string will\nbe used as a partition for the buckets.\n"},"labels":{"$ref":"#/$defs/labels"},"references":{"description":"Reference to external paper or documentation\n","anyOf":[{"type":"string"},{"type":"array"}]},"blackhole":{"pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$","type":"string","description":"A duration for which a bucket will be \"silenced\" after\noverflowing. This is intended to limit / avoid spam of buckets\nthat might be very rapidly triggered. The blackhole only\napplies to the individual bucket rather than the whole\nscenario. Must be compatible with golang ParseDuration format.\n"}}},"conditional":{"properties":{"reprocess":{"type":"boolean","description":"If set to true, the resulting overflow will be sent again in the\nscenario/parsing pipeline. It is useful when you want to have\nfurther scenarios that will rely on past-overflows to take\ndecision\n"},"type":{"type":"string","enum":["conditional"],"description":"Defines the type of the bucket. Currently three types are\nsupported : leaky : a leaky bucket that must be configured\nwith a capacity and a leakspeed trigger : a bucket that\noverflows as soon as an event is poured (it is like a leaky\nbucket is a capacity of 0) counter : a bucket that only\noverflows every duration. It is especially useful to count\nthings.\n"},"description":{"description":"The description is mandatory. It is a short description,\nprobably one sentence, describing what it detects.\n","type":"string"},"name":{"type":"string","description":"\"github_account_name/my_scenario_name\" or name:\n\"my_author_name/my_scenario_name\" name is mandatory\n"},"distinct":{"description":"An expr expression that must return a string. The event will be\npoured only if the string is not already present in the bucket.\n","type":"string"},"overflow_filter":{"type":"string","description":"overflow_filter is an expression that is run when the bucket\noverflows. If this expression is present and returns false, the\noverflow will be discarded.\n"},"condition":{"type":"string","description":"Make the bucket overflow when it returns true. The expression is evaluated each time an event is poured to the bucket.\n"},"filter":{"description":"filter must be a valid expr expression that will be evaluated\nagainst the event. If filter evaluation returns true or is\nabsent, event will be pour in the bucket. If filter returns\nfalse or a non-boolean, the event will be skipped for this\nbucket.\n","type":"string"},"capacity":{"type":"integer","description":"Only applies to leaky buckets. A positive integer\nrepresenting the bucket capacity. If there are more than\ncapacity item in the bucket, it will overflow.\n"},"cache_size":{"description":"By default, a bucket holds capacity events \"in memory\". However,\nfor a number of cases, you don't want this, as it might lead to\nexcessive memory consumption. By setting cache_size to a\npositive integer, we can control the maximum in-memory cache\nsize of the bucket, without changing its capacity and such. It\nis useful when buckets are likely to stay alive for a long time\nor ingest a lot of events to avoid storing a lot of events in\nmemory.\n","type":"number"},"labels":{"$ref":"#/$defs/labels"},"scope":{"properties":{"expression":{"type":"string"},"type":{"type":"string"}},"type":"object","additionalProperties":"","description":"While most scenarios might focus on IP addresses, CrowdSec and Bouncers can work with any scope. The scope directive allows you to override the default scope :\n type is a string representing the scope name\n expression is an expr expression that will be evaluated to fetch the value\n"},"groupby":{"description":"An expr expression that must return a string. This string will\nbe used as a partition for the buckets.\n","type":"string"},"blackhole":{"description":"A duration for which a bucket will be \"silenced\" after\noverflowing. This is intended to limit / avoid spam of buckets\nthat might be very rapidly triggered. The blackhole only\napplies to the individual bucket rather than the whole\nscenario. Must be compatible with golang ParseDuration format.\n","type":"string","pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$"},"references":{"description":"Reference to external paper or documentation\n","anyOf":[{"type":"string"},{"type":"array"}]},"debug":{"description":"If set to to true, enabled scenario level debugging. It is meant\nto help understanding scenario behavior by providing contextual\n","type":"boolean"},"leakspeed":{"type":"string","pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$","description":"Only applies to leaky buckets. A duration that represent how\noften an event will be leaking from the bucket.\n"},"cancel_on":{"description":"cancel_on is an expression that runs on each event poured to the\nbucket. If the cancel_on expression returns true, the bucket is\nimmediately destroyed (and doesn't overflow).\n","type":"string"},"format":{"minimum":"1.0","description":"CrowdSec has a notion of format support for parsers and\nscenarios for compatibility management. Running cscli version\nwill show you such compatibility matrix :\n","type":"number"},"data":{"$ref":"#/$defs/data"}},"type":"object","additionalProperties":"","required":["type","name","leakspeed","description","condition"]},"labels":{"description":"Labels is a list of label: values that provide context to an\noverflow. The labels are (currently) not stored in the database,\nnor they are sent to the API. Special labels : The remediation\nlabel, if set to true indicate the the originating IP should be\nbanned.\n","patternProperties":{"^.*$":{"type":["string","boolean","array","integer"]}},"type":"object"},"trigger":{"properties":{"references":{"description":"Reference to external paper or documentation\n","anyOf":[{"type":"string"},{"type":"array"}]},"blackhole":{"type":"string","pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$","description":"A duration for which a bucket will be \"silenced\" after\noverflowing. This is intended to limit / avoid spam of buckets\nthat might be very rapidly triggered. The blackhole only\napplies to the individual bucket rather than the whole\nscenario. Must be compatible with golang ParseDuration format.\n"},"groupby":{"description":"An expr expression that must return a string. This string will\nbe used as a partition for the buckets.\n","type":"string"},"scope":{"additionalProperties":"","description":"While most scenarios might focus on IP addresses, CrowdSec\nand Bouncers can work with any scope. The scope directive\nallows you to override the default scope : type is a string\nrepresenting the scope name expression is an expr expression\nthat will be evaluated to fetch the value\n","properties":{"expression":{"type":"string"},"type":{"type":"string"}},"type":"object"},"labels":{"$ref":"#/$defs/labels"},"data":{"$ref":"#/$defs/data"},"cancel_on":{"type":"string","description":"cancel_on is an expression that runs on each event poured to the\nbucket. If the cancel_on expression returns true, the bucket is\nimmediately destroyed (and doesn't overflow).\n"},"format":{"description":"CrowdSec has a notion of format support for parsers and\nscenarios for compatibility management. Running cscli version\nwill show you such compatibility matrix :\n","minimum":"1.0","type":"number"},"debug":{"description":"If set to to true, enabled scenario level debugging. It is meant\nto help understanding scenario behavior by providing contextual\n","type":"boolean"},"name":{"description":"\"github_account_name/my_scenario_name\" or name:\n \"my_author_name/my_scenario_name\" name is mandatory\n","type":"string"},"description":{"description":"The description is mandatory. It is a short description,\nprobably one sentence, describing what it detects.\n","type":"string"},"reprocess":{"description":"If set to true, the resulting overflow will be sent again in the\nscenario/parsing pipeline. It is useful when you want to have\nfurther scenarios that will rely on past-overflows to take\ndecision\n","type":"boolean"},"type":{"description":"Defines the type of the bucket. Currently three types are\nsupported : leaky : a leaky bucket that must be configured\nwith a capacity and a leakspeed trigger : a bucket that\noverflows as soon as an event is poured (it is like a leaky\nbucket is a capacity of 0) counter : a bucket that only\noverflows every duration. It is especially useful to count\nthings.\n","type":"string","enum":["trigger"]},"cache_size":{"type":"number","description":"By default, a bucket holds capacity events \"in memory\". However,\nfor a number of cases, you don't want this, as it might lead to\nexcessive memory consumption. By setting cache_size to a\npositive integer, we can control the maximum in-memory cache\nsize of the bucket, without changing its capacity and such. It\nis useful when buckets are likely to stay alive for a long time\nor ingest a lot of events to avoid storing a lot of events in\nmemory.\n"},"overflow_filter":{"type":"string","description":"overflow_filter is an expression that is run when the bucket\noverflows. If this expression is present and returns false, the\noverflow will be discarded.\n"},"filter":{"description":"filter must be a valid expr expression that will be evaluated\nagainst the event. If filter evaluation returns true or is\nabsent, event will be pour in the bucket. If filter returns\nfalse or a non-boolean, the event will be skipped for this\nbucket.\n","type":"string"},"distinct":{"description":"An expr expression that must return a string. The event will be\npoured only if the string is not already present in the bucket.\n","type":"string"}},"type":"object","additionalProperties":"","required":["type","name","description"]},"counter":{"type":"object","properties":{"cancel_on":{"type":"string","description":"cancel_on is an expression that runs on each event poured to the\nbucket. If the cancel_on expression returns true, the bucket is\nimmediately destroyed (and doesn't overflow).\n"},"format":{"type":"number","description":"CrowdSec has a notion of format support for parsers and\nscenarios for compatibility management. Running cscli version\nwill show you such compatibility matrix :\n","minimum":"1.0"},"debug":{"type":"boolean","description":"If set to to true, enabled scenario level debugging. It is meant\nto help understanding scenario behavior by providing contextual\n"},"data":{"$ref":"#/$defs/data"},"groupby":{"type":"string","description":"An expr expression that must return a string. This string will\nbe used as a partition for the buckets.\n"},"scope":{"additionalProperties":"","description":"While most scenarios might focus on IP addresses, CrowdSec and Bouncers can work with any scope. The scope directive allows you to override the default scope :\n type is a string representing the scope name\n expression is an expr expression that will be evaluated to fetch the value\n","properties":{"type":{"type":"string"},"expression":{"type":"string"}},"type":"object"},"labels":{"$ref":"#/$defs/labels"},"references":{"anyOf":[{"type":"string"},{"type":"array"}],"description":"Reference to external paper or documentation\n"},"blackhole":{"description":"A duration for which a bucket will be \"silenced\" after\noverflowing. This is intended to limit / avoid spam of buckets\nthat might be very rapidly triggered. The blackhole only\napplies to the individual bucket rather than the whole\nscenario. Must be compatible with golang ParseDuration format.\n","pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$","type":"string"},"distinct":{"description":"An expr expression that must return a string. The event will be\npoured only if the string is not already present in the bucket.\n","type":"string"},"cache_size":{"description":"By default, a bucket holds capacity events \"in memory\". However,\nfor a number of cases, you don't want this, as it might lead to\nexcessive memory consumption. By setting cache_size to a\npositive integer, we can control the maximum in-memory cache\nsize of the bucket, without changing its capacity and such. It\nis useful when buckets are likely to stay alive for a long time\nor ingest a lot of events to avoid storing a lot of events in\nmemory.\n","type":"number"},"overflow_filter":{"description":"overflow_filter is an expression that is run when the bucket\noverflows. If this expression is present and returns false, the\noverflow will be discarded.\n","type":"string"},"filter":{"type":"string","description":"filter must be a valid expr expression that will be evaluated\nagainst the event. If filter evaluation returns true or is\nabsent, event will be pour in the bucket. If filter returns\nfalse or a non-boolean, the event will be skipped for this\nbucket.\n"},"duration":{"description":"Only applies to leaky buckets.\nA duration that represent how often an event will be leaking from the bucket.\n","pattern":"^([0-9]+(\\.[0-9]+)*d)?([0-9]+(\\.[0-9]+)*h)?([0-9]+(\\.[0-9]+)*m)?([0-9]+(\\.[0-9]+)*s)?([0-9]+(\\.[0-9]+)*ms)?([0-9]+(\\.[0-9]+)*(us|µs))?([0-9]+(\\.[0-9]+)*ns)?$","type":"string"},"type":{"description":"Defines the type of the bucket. Currently three types are\nsupported : leaky : a leaky bucket that must be configured\nwith a capacity and a leakspeed trigger : a bucket that\noverflows as soon as an event is poured (it is like a leaky\nbucket is a capacity of 0) counter : a bucket that only\noverflows every duration. It is especially useful to count\nthings.\n","enum":["counter"],"type":"string"},"reprocess":{"type":"boolean","description":"If set to true, the resulting overflow will be sent again in the\nscenario/parsing pipeline. It is useful when you want to have\nfurther scenarios that will rely on past-overflows to take\ndecision\n"},"name":{"description":"\"github_account_name/my_scenario_name\" or name:\n \"my_author_name/my_scenario_name\" name is mandatory\n","type":"string"},"description":{"description":"The description is mandatory. It is a short description,\nprobably one sentence, describing what it detects.\n","type":"string"}},"required":["type","name","duration","description"],"additionalProperties":""},"data":{"additionalProperties":"","description":"data allows user to specify an external source of data. This\nsection is only relevant when cscli is used to install parser\nfrom hub, as it will download the source_url and store it to\ndest_file. When the parser is not installed from the hub,\nCrowdSec won't download the URL, but the file must exist for the\nparser to be loaded correctly.\n","required":["type","dest_file"],"type":"array","items":{"type":"object","properties":{"type":{"type":"string","pattern":"^(string|regexp)$","description":"The type is mandatory if you want to evaluate the data in\nthe file, and should be regex for valid (re2) regular\nexpression per line or string for string per line. The\nregexps will be compiled, the strings will be loaded into\na list and both will be kept in memory. Without specifying\na type, the file will be downloaded and stored as file and\nnot in memory.\n","additionalProperties":""},"source_url":{"description":"url to download file from\n","type":"string"},"dest_file":{"type":"string","description":"destination to store the downloaded file to\n"}}}}}} |
hayson-json-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/j2inn/hayson/master/hayson-json-schema.json",
"anyOf": [
{
"$ref": "#/definitions/hval"
}
],
"definitions": {
"grid": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"meta"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"grid"
]
},
"meta": {
"$ref": "#/definitions/gridMeta"
},
"cols": {
"type": "array",
"items": {
"$ref": "#/definitions/gridColumn"
}
},
"rows": {
"type": "array",
"items": {
"$ref": "#/definitions/dict"
}
}
}
},
"gridMeta": {
"allOf": [
{
"$ref": "#/definitions/dict"
}
],
"type": "object",
"required": [
"ver"
],
"properties": {
"ver": {
"type": "string",
"enum": [
"3.0"
]
}
}
},
"gridColumn": {
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/dict"
}
}
},
"dict": {
"type": "object",
"properties": {
"_kind": {
"type": "string",
"enum": [
"dict"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[a-z][0-9a-zA-Z_]*": {
"$ref": "#/definitions/hval"
}
}
},
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/hval"
}
},
"hval": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"$ref": "#/definitions/marker"
},
{
"$ref": "#/definitions/remove"
},
{
"$ref": "#/definitions/na"
},
{
"$ref": "#/definitions/number"
},
{
"$ref": "#/definitions/numberSpecial"
},
{
"$ref": "#/definitions/symbol"
},
{
"$ref": "#/definitions/ref"
},
{
"$ref": "#/definitions/uri"
},
{
"$ref": "#/definitions/date"
},
{
"$ref": "#/definitions/time"
},
{
"$ref": "#/definitions/dateTime"
},
{
"$ref": "#/definitions/dict"
},
{
"$ref": "#/definitions/list"
},
{
"$ref": "#/definitions/grid"
},
{
"$ref": "#/definitions/coord"
},
{
"$ref": "#/definitions/xstr"
}
]
},
"marker": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"marker"
]
}
}
},
"remove": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"remove"
]
}
}
},
"na": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"na"
]
}
}
},
"number": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"number"
]
},
"val": {
"type": "number"
},
"unit": {
"type": "string",
"pattern": "^([a-zA-Z%_/$]|[\\x80-\\xFFFF])+$"
}
}
},
"numberSpecial": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"number"
]
},
"val": {
"type": "string",
"enum": [
"INF",
"-INF",
"NaN"
]
}
}
},
"uri": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"uri"
]
},
"val": {
"type": "string"
}
}
},
"ref": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"ref"
]
},
"val": {
"type": "string",
"pattern": "^[0-9a-zA-Z_:\\-.~]+$"
},
"dis": {
"type": "string"
}
}
},
"symbol": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"symbol"
]
},
"val": {
"type": "string",
"pattern": "^[0-9a-zA-Z_:\\-.~]+$"
}
}
},
"date": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"date"
]
},
"val": {
"type": "string",
"format": "date"
}
}
},
"time": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"time"
]
},
"val": {
"type": "string",
"pattern": "^(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?$"
}
}
},
"dateTime": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"dateTime"
]
},
"val": {
"type": "string",
"pattern": "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[-+](2[0-3]|[01][0-9]):[0-5][0-9])?$"
},
"tz": {
"type": "string",
"minLength": 1
}
}
},
"coord": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"lat",
"lng"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"coord"
]
},
"lat": {
"type": "number"
},
"lng": {
"type": "number"
}
}
},
"xstr": {
"type": "object",
"additionalProperties": false,
"required": [
"_kind",
"type",
"val"
],
"properties": {
"_kind": {
"type": "string",
"enum": [
"xstr"
]
},
"type": {
"type": "string",
"pattern": "^[A-Z][a-zA-Z0-9_]*$"
},
"val": {
"type": "string"
}
}
}
}
} |
chutzpah.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"engineOptions": {
"type": "object",
"description": "The options to configure the chosen browser engine for Chutzpah to use.",
"properties": {
"ChromeBrowserPath": {
"description": "The path to the chrome/chromium executable on the machine",
"type": "string"
}
}
},
"serverSettings": {
"description": "Server settings let you enable to configure Chutzpah web server mode.",
"type": "object",
"properties": {
"Enabled": {
"description": "Determines if the web server mode is enabled.",
"type": "boolean",
"default": false
},
"DefaultPort": {
"description": "The default port to use. If this port is taken Chutzpah will try incrementing until it finds an available one.",
"type": "number"
},
"RootPath": {
"description": "The root path of the server. All file paths are relative to this and should be in a directory below or equal to this. Defaults to drive root.",
"type": "string"
}
}
},
"templateOptions": {
"properties": {
"Mode": {
"description": "The way the template is injected into the HTML page.",
"enum": ["Raw", "Script"],
"default": "Raw"
},
"Id": {
"description": "If in script mode what Id to place on the script tag.",
"type": "string"
},
"Type": {
"description": "If in script mode what Type to place on script tag",
"type": "string"
}
}
},
"referenceSettings": {
"properties": {
"Path": {
"description": "The path to either a file or a folder. If given a folder, it will be scanned recursively. This path can be relative to the location of the chutzpah.json file.",
"type": "string"
},
"Includes": {
"description": "This is an optional array of include glob patterns. Only files matching the Include pattern will be added.",
"type": "array",
"items": {
"type": "string"
}
},
"Excludes": {
"description": "This is an optional array of exclude glob patterns. Only files not matching the Exclude patterns will be added.",
"type": "array",
"items": {
"type": "string"
}
},
"IncludeInTestHarness": {
"description": "This determines if the reference should be injected into the test harness. When referencing files like .d.ts or files that you plan to load using require.js you should set this to false. Defaults to true.",
"type": "boolean",
"default": true
},
"IsTestFrameworkFile": {
"description": "Indicated that this references should be placed directly after the test framework files in the test harness. This ensures that this file is injected into the test harness before almost all other files. Defaults to false.",
"type": "boolean",
"default": false
},
"TemplateOptions": {
"$ref": "#/definitions/templateOptions"
}
}
},
"compilePathMap": {
"properties": {
"SourcePath": {
"description": "The source file/directory",
"type": "string"
},
"OutputPath": {
"description": "The file/directory that source file/directory is mapped to. Specifying a file OutputPath and a directory for SourcePath indicated the files are being concatenated into one large file",
"type": "string"
},
"OutputPathType": {
"description": "The type (file or folder) that the output path refers to. If not specified Chutzpah will try to take a best guess by assuming it is a file if it has a .js extension",
"type": "string",
"enum": ["File", "Folder"],
"default": "Folder"
}
}
},
"testSettings": {
"properties": {
"Path": {
"description": "The path to either a file or a folder. If given a folder, it will be scanned recursively. This path can be relative to the location of the chutzpah.json file.",
"type": "string"
},
"Includes": {
"description": "This is an optional array of include glob patterns. Only files matching the Include pattern will be added.",
"type": "array",
"items": {
"type": "string"
}
},
"Excludes": {
"description": "This is an optional array of exclude glob patterns. Only files not matching the Exclude patterns will be added.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"transformConfig": {
"properties": {
"Name": {
"description": "The name of the transform to execute",
"type": "string"
},
"Path": {
"description": "The file for the transform to save its output to.",
"type": "string"
}
}
},
"compileSettings": {
"description": "This setting lets you describe in the Chutzpah.json file how to execute a command which can compile your source files to .js files. You tell Chutzpah what to execute and some information about what your executable does (like where to find the generated .js files). Then after running the executable Chutzpah can associate each source file with each output file to still give the nice behavior of mapping tests back to their original files.",
"type": "object",
"properties": {
"Extensions": {
"description": "The extensions of the files which are getting compiled (e.g. .ts).",
"type": "array",
"items": {
"type": "string"
}
},
"ExtensionsWithNoOutput": {
"description": "The extensions of files which take part in compile but have no build output. This is used for cases like TypeScript declaration files which share a .ts extension. They have .d.ts extension and are part of compilation but have no output. You must tell Chutzpah about these if you want the SkipIfUnchanged setting to work. Otherwise Chutzpah will think these are missing output.",
"type": "array",
"items": {
"type": "string"
}
},
"Paths": {
"description": " The collection of path mapping from source directory/file to output directory/file.",
"type": "array",
"items": {
"$ref": "#/definitions/compilePathMap"
}
},
"WorkingDirectory": {
"description": "This is the working directory of the process which executes the command.",
"type": "string"
},
"Executable": {
"description": "The path to an executable which Chutzpah executes to perform the batch compilation. Chutzpah will try to resolve the path relative to the settings directory. But if can't find the file there you must give it a full path.",
"type": ["string", "null"],
"default": null
},
"Arguments": {
"description": "The arguments to pass to the command.",
"type": ["string", "null"],
"default": null
},
"Timeout": {
"description": "How long to wait for compile to finish in milliseconds?",
"type": "integer",
"default": 30000
},
"SkipIfUnchanged": {
"description": "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
},
"Mode": {
"description": "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"
},
"UseSourceMaps": {
"description": "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
},
"IgnoreMissingFiles": {
"description": "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
}
}
}
},
"id": "https://json.schemastore.org/chutzpah.json",
"properties": {
"Framework": {
"description": "Determines what testing framework to use. This will override the other detection methods.",
"type": "string",
"enum": ["qunit", "jasmine", "mocha"]
},
"FrameworkVersion": {
"description": "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"
},
"References": {
"description": "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": {
"$ref": "#/definitions/referenceSettings"
}
},
"Tests": {
"description": "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": {
"$ref": "#/definitions/testSettings"
}
},
"Engine": {
"description": "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"]
},
"EngineOptions": {
"$ref": "#/definitions/engineOptions"
},
"Server": {
"$ref": "#/definitions/serverSettings"
},
"Transforms": {
"description": "List of transformers to run after testing to generate output files",
"type": "array",
"items": {
"$ref": "#/definitions/transformConfig"
}
},
"Compile": {
"$ref": "#/definitions/compileSettings"
},
"TestFileTimeout": {
"description": "The time to wait for tests in a file to finish in milliseconds.",
"type": "integer"
},
"TestHarnessLocationMode": {
"description": "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"]
},
"TestHarnessReferenceMode": {
"type": "string",
"enum": ["Normal", "AMD"]
},
"TestHarnessDirectory": {
"description": "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"
},
"RootReferencePathMode": {
"description": "This property determines what directory a rooted reference path refers to.",
"type": "string",
"enum": ["DriveRoot", "SettingsFileDirectory"],
"default": "DriveRoot"
},
"CodeCoverageTimeout": {
"description": "The timeout in milliseconds for how long to wait to instrument each file for code coverage. Defaults to 5000ms.",
"type": "integer",
"default": 5000
},
"CodeCoverageExecutionMode": {
"description": "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"]
},
"CodeCoverageSuccessPercentage": {
"description": "The percentage of lines needing to be covered to show the coverage output as success or failure. By default this is 60.",
"type": "number"
},
"CodeCoverageIncludes": {
"description": "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"
}
},
"CodeCoverageExcludes": {
"description": "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"
}
},
"CustomTestHarnessPath": {
"description": "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"
},
"MochaInterface": {
"description": "The name of the Mocha interface to use. Overrides the default detection mechanism.",
"type": "string",
"enum": ["bdd", "tdd", "qunit"]
},
"AMDBaseUrl": {
"description": "Set the baseurl for Chutzpah to use when generating the test harness. Defaults to the test harness directory if not set.",
"type": "string"
},
"AMDAppDirectory": {
"description": "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"
},
"UserAgent": {
"description": "The user agent to use when making web requests",
"type": "string"
},
"TestPattern": {
"description": "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"
},
"EnableTestFileBatching": {
"description": "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"
},
"InheritFromParent": {
"description": "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"
},
"IgnoreResourceLoadingErrors": {
"description": "Suppress errors that are reported when a script request to load a url (e.g. xhr/script/image) fails.",
"type": "boolean"
},
"EnableTracing": {
"description": "Logs tracing information to a log file.",
"type": "boolean"
},
"TraceFilePath": {
"description": "The path to write the trace file to. Defaults tp %temp%/chutzpah.log.",
"type": "string"
},
"Parallelism": {
"description": "Max degree of parallelism for running tests. Defaults to number of CPUs",
"type": "number"
},
"BrowserArguments": {
"description": "The dictionary of browser name (keys) to corresponding browser arguments (values), i.e.; { 'chrome': '--allow-file-access-from-files' }.",
"type": "object"
}
},
"title": "JSON schema for Chutzpah test runner settings files",
"type": "object"
}
|
repository-configuration-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://oss-review-toolkit.org/.ort.yml",
"title": "ORT repository configuration",
"description": "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.",
"type": "object",
"properties": {
"analyzer": {
"$ref": "https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/analyzer-configuration-schema.json"
},
"excludes": {
"type": "object",
"description": "Defines which parts of a repository should be excluded.",
"properties": {
"paths": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"description": "A glob to match the path of the project definition file, relative to the root of the repository.",
"type": "string"
},
"reason": {
"$ref": "#/definitions/pathExcludeReason"
},
"comment": {
"type": "string"
}
},
"required": [
"pattern",
"reason"
]
}
},
"scopes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"reason": {
"$ref": "#/definitions/scopeExcludeReason"
},
"comment": {
"type": "string"
}
},
"required": [
"pattern",
"reason"
]
}
}
}
},
"resolutions": {
"$ref": "https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/resolutions-schema.json"
},
"curations": {
"type": "object",
"description": "Curations for artifacts in a repository.",
"properties": {
"license_findings": {
"type": "array",
"items": {
"$ref": "#/definitions/licenseFindingCurations"
}
},
"packages": {
"$ref": "https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/curations-schema.json"
}
},
"anyOf": [
{
"required": [
"license_findings"
]
},
{
"required": [
"packages"
]
}
]
},
"package_configurations": {
"type": "array",
"description": "A configuration for a specific package and provenance.",
"items": {
"$ref": "https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/package-configuration-schema.json"
}
},
"license_choices": {
"type": "object",
"description": "A configuration to select a license from a multi-licensed package.",
"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": {
"$ref": "#/definitions/licenseFindingCurationReason"
},
"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"
]
}
}
}
|
vercel.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"$schema": {
"description": "Ignored. Can be set to get completions, validations and documentation in some editors.",
"example": [
"https://openapi.vercel.sh/vercel.json"
],
"type": "string"
},
"alias": {
"description": "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"
}
]
},
"build": {
"additionalProperties": false,
"description": "An object containing another object with information to be passed to the Build Process",
"deprecated": true,
"properties": {
"env": {
"additionalProperties": false,
"description": "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 `@`",
"example": {
"A_SECRET": "@a-secret"
},
"deprecated": true,
"maxProperties": 100,
"minProperties": 0,
"patternProperties": {
".+": {
"maxLength": 65536,
"minLength": 0,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"builds": {
"description": "A list of build descriptions whose src references valid source files.",
"deprecated": true,
"items": {
"additionalProperties": false,
"properties": {
"config": {
"description": "Optionally, an object including arbitrary metadata to be passed to the Builder",
"type": "object"
},
"src": {
"description": "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"
},
"use": {
"description": "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"
}
},
"required": [
"use"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"cleanUrls": {
"description": "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"
},
"env": {
"additionalProperties": false,
"description": "An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@`",
"example": {
"A_SECRET": "@a-secret"
},
"deprecated": true,
"maxProperties": 100,
"minProperties": 0,
"patternProperties": {
".+": {
"maxLength": 65536,
"minLength": 0,
"type": "string"
}
},
"type": "object"
},
"functions": {
"additionalProperties": false,
"description": "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`).",
"example": {
"src/pages/**": {
"maxDuration": 6,
"memory": 1024
}
},
"maxProperties": 50,
"minProperties": 1,
"patternProperties": {
"^.{1,256}$": {
"additionalProperties": false,
"properties": {
"excludeFiles": {
"description": "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"
},
"includeFiles": {
"description": "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"
},
"maxDuration": {
"description": "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"
},
"memory": {
"description": "An integer defining the memory your Serverless Function should be provided with (between 128 and 3008).",
"maximum": 3008,
"minimum": 128,
"type": "number"
},
"runtime": {
"description": "The npm package name of a Runtime, including its version",
"maxLength": 256,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"git": {
"type": "object",
"properties": {
"deploymentEnabled": {
"description": "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"
}
}
]
}
}
},
"github": {
"private": true,
"type": "object",
"properties": {
"autoAlias": {
"description": "When set to `false`, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.",
"type": "boolean"
},
"autoJobCancelation": {
"description": "When set to `false`, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.",
"type": "boolean"
},
"enabled": {
"description": "When set to false, Vercel for GitHub will not apply the alias upon merge.",
"type": "boolean"
},
"silent": {
"description": "When set to `true`, Vercel for GitHub will stop commenting on pull requests and commits.",
"type": "boolean"
}
}
},
"headers": {
"type": "array",
"maxItems": 1024,
"description": "A list of header definitions.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"headers"
],
"properties": {
"source": {
"description": "A pattern that matches each incoming pathname (excluding querystring)",
"type": "string",
"maxLength": 4096
},
"headers": {
"description": "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
}
}
}
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
}
},
"images": {
"type": "object",
"additionalProperties": false,
"required": [
"sizes"
],
"properties": {
"contentDispositionType": {
"enum": [
"inline",
"attachment"
]
},
"contentSecurityPolicy": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"dangerouslyAllowSVG": {
"type": "boolean"
},
"domains": {
"type": "array",
"minItems": 0,
"maxItems": 50,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"formats": {
"type": "array",
"minItems": 1,
"maxItems": 4,
"items": {
"enum": [
"image/avif",
"image/webp",
"image/jpeg",
"image/png"
]
}
},
"minimumCacheTTL": {
"type": "integer",
"minimum": 1,
"maximum": 315360000
},
"remotePatterns": {
"type": "array",
"minItems": 0,
"maxItems": 50,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"hostname"
],
"properties": {
"protocol": {
"enum": [
"http",
"https"
]
},
"hostname": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"port": {
"type": "string",
"minLength": 1,
"maxLength": 5
},
"pathname": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"sizes": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "number"
}
}
}
},
"name": {
"description": "A name for the deployment",
"type": "string"
},
"public": {
"description": "Whether a deployment's source and logs are available publicly",
"type": "boolean"
},
"redirects": {
"title": "Redirects",
"type": "array",
"maxItems": 1024,
"description": "A list of redirect definitions.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"destination"
],
"properties": {
"source": {
"description": "A pattern that matches each incoming pathname (excluding querystring).",
"type": "string",
"maxLength": 4096
},
"destination": {
"description": "A location destination defined as an absolute pathname or external URL.",
"type": "string",
"maxLength": 4096
},
"permanent": {
"description": "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"
},
"statusCode": {
"private": true,
"type": "integer",
"minimum": 100,
"maximum": 999
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
}
},
"regions": {
"description": "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"
},
"rewrites": {
"type": "array",
"maxItems": 1024,
"description": "A list of rewrite definitions.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"destination"
],
"properties": {
"source": {
"description": "A pattern that matches each incoming pathname (excluding querystring).",
"type": "string",
"maxLength": 4096
},
"destination": {
"description": "An absolute pathname to an existing resource or an external URL.",
"type": "string",
"maxLength": 4096
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
}
},
"routes": {
"type": "array",
"maxItems": 1024,
"deprecated": true,
"description": "A list of routes objects used to rewrite paths to point towards other internal or external paths",
"example": [
{
"dest": "https://docs.example.com",
"src": "/docs"
}
],
"items": {
"anyOf": [
{
"type": "object",
"required": [
"src"
],
"additionalProperties": false,
"properties": {
"src": {
"type": "string",
"maxLength": 4096
},
"dest": {
"type": "string",
"maxLength": 4096
},
"headers": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 100,
"patternProperties": {
"^.{1,256}$": {
"type": "string",
"maxLength": 4096
}
}
},
"methods": {
"type": "array",
"maxItems": 10,
"items": {
"type": "string",
"maxLength": 32
}
},
"caseSensitive": {
"type": "boolean"
},
"important": {
"type": "boolean"
},
"user": {
"type": "boolean"
},
"continue": {
"type": "boolean"
},
"override": {
"type": "boolean"
},
"check": {
"type": "boolean"
},
"isInternal": {
"type": "boolean"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 999
},
"locale": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"redirect": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 100,
"patternProperties": {
"^.{1,256}$": {
"type": "string",
"maxLength": 4096
}
}
},
"value": {
"type": "string",
"maxLength": 4096
},
"path": {
"type": "string",
"maxLength": 4096
},
"cookie": {
"type": "string",
"maxLength": 4096
},
"default": {
"type": "string",
"maxLength": 4096
}
}
},
"middleware": {
"type": "number"
},
"middlewarePath": {
"type": "string"
},
"middlewareRawSrc": {
"type": "array",
"items": {
"type": "string"
}
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
},
{
"type": "object",
"required": [
"handle"
],
"additionalProperties": false,
"properties": {
"handle": {
"type": "string",
"maxLength": 32,
"enum": [
"error",
"filesystem",
"hit",
"miss",
"resource",
"rewrite"
]
}
}
}
]
}
},
"scope": {
"description": "This property determines the scope (user or team) under which the project will be deployed by Vercel CLI.",
"type": "string",
"private": true
},
"trailingSlash": {
"description": "When `false`, visiting a path that ends with a forward slash will respond with a `308` status code and redirect to the path without the trailing slash.",
"type": "boolean"
},
"version": {
"maximum": 2,
"minimum": 2,
"private": true,
"type": "integer"
},
"wildcard": {
"private": true,
"items": {
"additionalProperties": false,
"properties": {
"domain": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"value": {
"maxLength": 1024,
"minLength": 0,
"type": "string"
}
},
"required": [
"domain",
"value"
],
"type": "object"
},
"maxItems": 25,
"minItems": 1,
"type": "array"
},
"buildCommand": {
"description": "The build command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"ignoreCommand": {
"maxLength": 256,
"type": [
"string",
"null"
]
},
"devCommand": {
"description": "The dev command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"framework": {
"description": "The framework that is being used for this project. When `null` is used no framework is selected",
"type": [
"null",
"string"
],
"enum": [
"blitzjs",
"nextjs",
"gatsby",
"remix",
"astro",
"hexo",
"eleventy",
"docusaurus-2",
"docusaurus",
"preact",
"solidstart",
"dojo",
"ember",
"vue",
"scully",
"ionic-angular",
"angular",
"polymer",
"svelte",
"sveltekit",
"sveltekit-1",
"ionic-react",
"create-react-app",
"gridsome",
"umijs",
"sapper",
"saber",
"stencil",
"nuxtjs",
"redwoodjs",
"hugo",
"jekyll",
"brunch",
"middleman",
"zola",
"hydrogen",
"vite",
"vitepress",
"vuepress",
"parcel",
"sanity",
"storybook",
null
]
},
"installCommand": {
"description": "The install command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"outputDirectory": {
"description": "The output directory of the project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"crons": {
"description": "An array of cron jobs that should be created for production Deployments.",
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"required": [
"schedule",
"path"
],
"properties": {
"schedule": {
"type": "string",
"minLength": 9,
"maxLength": 256
},
"path": {
"type": "string",
"maxLength": 512,
"pattern": "^/.*"
}
}
}
}
}
}
|
workflows.json | {
"$id": "https://json.schemastore.org/workflows.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"subworkflow": {
"type": "object",
"description": "A subworkflow.",
"additionalProperties": false,
"properties": {
"params": {
"description": "The name of the parameter variable.",
"type": "array",
"minItems": 0,
"maxItems": 10,
"uniqueItems": true
},
"steps": {
"description": "An array of objects with a single step.",
"$ref": "#/definitions/stepArray"
}
}
},
"stepArray": {
"type": "array",
"description": "An array of objects with a single step.",
"minItems": 1,
"maxItems": 100000,
"items": {
"type": "object",
"description": "An object with a single step.",
"minProperties": 1,
"maxProperties": 1,
"additionalProperties": false,
"patternProperties": {
"^.*$": {
"description": "A single workflow step.",
"$ref": "#/definitions/step"
}
}
}
},
"step": {
"type": "object",
"description": "A single workflow step.",
"additionalProperties": false,
"dependencies": {
"args": ["call"],
"result": ["call"],
"except": ["try"],
"retry": ["try"]
},
"properties": {
"assign": {
"$ref": "#/definitions/assign"
},
"call": {
"$ref": "#/definitions/call"
},
"args": {
"$ref": "#/definitions/args"
},
"result": {
"$ref": "#/definitions/result"
},
"next": {
"$ref": "#/definitions/next"
},
"switch": {
"$ref": "#/definitions/switch"
},
"for": {
"$ref": "#/definitions/for"
},
"parallel": {
"$ref": "#/definitions/parallel"
},
"raise": {
"$ref": "#/definitions/raise"
},
"try": {
"$ref": "#/definitions/try"
},
"retry": {
"$ref": "#/definitions/retry"
},
"except": {
"$ref": "#/definitions/except"
},
"return": {
"$ref": "#/definitions/return"
},
"steps": {
"$ref": "#/definitions/stepArray"
}
}
},
"assign": {
"description": "A list of variable assignment maps.",
"type": "array",
"items": {
"type": "object",
"description": "A single variable assignment.",
"minProperties": 1,
"maxProperties": 1
},
"minItems": 1,
"maxItems": 50
},
"call": {
"description": "Run a function and return a result.",
"anyOf": [
{
"description": "Standard library module for HTTP/S request support.",
"type": "string",
"enum": [
"http.get",
"http.post",
"http.put",
"http.patch",
"http.delete",
"http.request"
]
},
{
"description": "Standard library module for common system interface.",
"type": "string",
"enum": ["sys.sleep", "sys.sleep_until", "sys.log"]
},
{
"description": "Standard library module for event support.",
"type": "string",
"enum": ["events.await_callback", "events.create_callback_endpoint"]
},
{
"description": "A subworkflow.",
"type": "string"
},
{
"description": "A Google Cloud API connector.",
"type": "string",
"pattern": "^googleapis(\\.[a-zA-Z1-9]+)+"
}
]
},
"args": {
"type": "object",
"description": "Pass arguments and their values when calling a function that accepts parameters.",
"additionalProperties": true,
"properties": {
"url": {
"anyOf": [
{
"description": "URL where the request is sent. Required if using call type http.request.",
"type": "string",
"format": "uri"
},
{
"description": "An expression that results to a URL where the request is sent. Required if using call type http.request.",
"type": "string",
"pattern": "^\\$\\{.+\\}$"
}
]
},
"method": {
"description": "The type of HTTP request method to use. Required if using call type http.request.",
"type": "string",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
"PATCH"
]
},
"headers": {
"description": "Header fields to supply input to the API.",
"type": "object",
"minProperties": 1
},
"body": {
"description": "Body fields to supply input to the API.",
"anyOf": [
{
"type": "object"
},
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string",
"pattern": "^\\$\\{.+\\}$"
}
]
},
"query": {
"description": "Query fields to supply input to the API.",
"anyOf": [
{
"type": "object"
},
{
"type": "string",
"pattern": "^\\$\\{.+\\}$"
}
]
},
"auth": {
"description": "Required if the API being called requires authentication.",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "The type of authentication.",
"enum": ["OIDC", "OAuth2"]
},
"scope": {
"description": "Specify token scope to limit an application's access to a user's account.",
"anyOf": [
{
"description": "List of scope strings.",
"type": "array",
"contains": {
"type": "string"
}
},
{
"description": "Scope string.",
"type": "string"
}
]
},
"scopes": {
"description": "Specify token scope to limit an application's access to a user's account.",
"$ref": "#/definitions/scopes"
},
"audience": {
"description": "Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"pattern": "^\\$\\{.+\\}$"
}
]
}
}
},
"timeout": {
"description": "Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.",
"type": "number"
},
"connector_params": {
"description": "Connector-specific parameters.",
"type": "object",
"properties": {
"timeout": {
"description": "Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.",
"type": "integer",
"default": 1800,
"maximum": 31536000
},
"polling_policy": {
"description": "Polling policy.",
"type": "object",
"properties": {
"initial_delay": {
"description": "Time in seconds. Only applies to long-running operation calls.",
"type": "number",
"default": 1.0
},
"multiplier": {
"description": "Time in seconds. Only applies to long-running operation calls.",
"type": "number",
"default": 1.25
},
"max_delay": {
"description": "Time in seconds. Only applies to long-running operation calls.",
"type": "number",
"default": 60.0
}
}
},
"skip_polling": {
"description": "If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds",
"type": "boolean",
"default": false
},
"scopes": {
"description": "OAuth2 scopes to pass to the Google API.",
"$ref": "#/definitions/scopes"
}
}
}
}
},
"result": {
"description": "Assign the result from a call to this variable."
},
"next": {
"description": "Define what step Workflows should execute next.",
"anyOf": [
{
"description": "The step name.",
"type": "string"
},
{
"description": "Stop a workflow's execution without returning a value.",
"type": "string",
"const": "end"
},
{
"description": "Terminate the current iteration of a for loop and continue with the next iteration.",
"type": "string",
"const": "continue"
},
{
"description": "Terminate iteration of a for loop.",
"type": "string",
"const": "break"
}
]
},
"return": {
"description": "Stop a workflow's execution and return a value, variable, or expression."
},
"for": {
"description": "Iterates over a sequence of numbers or through a collection of data, such as a list or map.",
"type": "object",
"additionalProperties": false,
"required": ["value", "steps"],
"properties": {
"value": {
"description": "A loop variable name. Contains the value of the currently iterated element.",
"type": "string"
},
"index": {
"description": "An index variable name. Contains the value to the current offset of the iteration. ",
"type": "string"
},
"in": {
"description": "An expression that evaluates into a list or a list definition. Required, if not using 'range'.",
"anyOf": [
{
"description": "A list.",
"type": "array"
},
{
"description": "An expression that evaluates into a list.",
"type": "string",
"pattern": "^\\$\\{.+\\}$"
}
]
},
"range": {
"description": "A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.",
"anyOf": [
{
"description": "Array specifying the beginning and end of the range, both inclusive.",
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
},
{
"description": "The expressions must evaluate into incrementable values; that is, integer or double. Make sure that you do not use multiple expressions inside a list like this: [${rangeStart}, ${rangeEnd}]).",
"type": "string",
"pattern": "^\\$\\{\\[.+\\]\\}$"
}
]
},
"steps": {
"description": "Each iteration the steps will be executed.",
"$ref": "#/definitions/stepArray"
}
},
"oneOf": [
{
"required": ["in"]
},
{
"required": ["range"]
}
]
},
"parallel": {
"type": "object",
"description": "Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.",
"additionalProperties": false,
"properties": {
"exception_policy": {
"description": "The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.",
"type": "string",
"const": "continueAll"
},
"shared": {
"description": "A list of writable variables with parent scope that allow assignments within the 'parallel' step.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"concurrency_limit": {
"description": "The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.",
"type": "integer"
},
"branches": {
"description": "Branches that can run concurrently. Required, if not using 'for'.",
"$ref": "#/definitions/branches"
},
"for": {
"description": "A loop where iterations can run concurrently. Required, if not using 'branches'.",
"$ref": "#/definitions/for"
}
},
"oneOf": [
{
"required": ["for"]
},
{
"required": ["branches"]
}
]
},
"branches": {
"description": "Execute parallel branches concurrently and the steps in each branch sequentially.",
"type": "array",
"minItems": 2,
"maxItems": 10,
"$ref": "#/definitions/stepArray"
},
"switch": {
"description": "A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.",
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"$ref": "#/definitions/condition"
}
},
"condition": {
"type": "object",
"description": "Define conditional expressions for a switch block.",
"required": ["condition"],
"properties": {
"condition": {
"description": "An expression to switch on.",
"anyOf": [
{
"type": "string",
"pattern": "^\\$\\{.+\\}$"
},
{
"type": "boolean"
}
]
},
"steps": {
"$ref": "#/definitions/stepArray"
},
"assign": {
"$ref": "#/definitions/assign"
},
"call": {
"$ref": "#/definitions/call"
},
"args": {
"$ref": "#/definitions/args"
},
"result": {
"$ref": "#/definitions/result"
},
"next": {
"$ref": "#/definitions/next"
},
"switch": {
"$ref": "#/definitions/switch"
},
"for": {
"$ref": "#/definitions/for"
},
"parallel": {
"$ref": "#/definitions/parallel"
},
"raise": {
"$ref": "#/definitions/raise"
},
"try": {
"$ref": "#/definitions/try"
},
"retry": {
"$ref": "#/definitions/retry"
},
"except": {
"$ref": "#/definitions/except"
},
"return": {
"$ref": "#/definitions/return"
}
}
},
"raise": {
"description": "Raise an exception.",
"anyOf": [
{
"description": "Error message string.",
"type": "string"
},
{
"description": "Error message map.",
"type": "object",
"properties": {
"code": {
"description": "Error code.",
"type": "integer"
},
"message": {
"description": "Error message string.",
"type": "string"
}
}
}
]
},
"try": {
"description": "A try/except structure for error handling.",
"anyOf": [
{
"description": "A step.",
"$ref": "#/definitions/step"
},
{
"description": "A list of steps.",
"$ref": "#/definitions/stepArray"
}
]
},
"except": {
"description": "A try/except structure for error handling.",
"type": "object",
"additionalProperties": false,
"properties": {
"as": {
"description": "The name of a map variable that contains the error message.",
"type": "string"
},
"steps": {
"description": "A list of steps.",
"$ref": "#/definitions/stepArray"
}
}
},
"retry": {
"description": "Define a retry policy to retry steps that return a specific error code.",
"oneOf": [
{
"type": "object",
"description": "Retry block. Optional, if using a default retry policy.",
"additionalProperties": false,
"properties": {
"predicate": {
"type": "string",
"description": "Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow."
},
"max_retries": {
"type": "integer",
"description": "Maximum number of times a step will be retried, not counting the initial step execution attempt."
},
"backoff": {
"type": "object",
"description": "Block that controls how retries occur.",
"additionalProperties": false,
"properties": {
"initial_delay": {
"type": "integer",
"description": "Delay in seconds between the initial failure and the first retry."
},
"max_delay": {
"type": "integer",
"description": "Maximum delay in seconds between retries."
},
"multiplier": {
"type": "integer",
"description": "Multiplier applied to the previous delay to calculate the delay for the subsequent retry."
}
}
}
}
},
{
"description": "Default retry policy. Optional, if using retry block. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}.",
"type": "string",
"pattern": "^\\$\\{.+\\}$"
}
]
},
"scopes": {
"description": "Specify token scope to limit an application's access to a user's account.",
"anyOf": [
{
"description": "List of scope strings.",
"type": "array",
"contains": {
"type": "string"
}
},
{
"description": "Scope string.",
"type": "string"
},
{
"description": "Space and comma-separated strings",
"type": "string"
}
]
}
},
"description": "Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.",
"oneOf": [
{
"type": "object",
"description": "The main workflow.",
"required": ["main"],
"properties": {
"main": {
"type": "object",
"additionalProperties": false,
"properties": {
"params": {
"description": "The name of the parameter variable.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"maxItems": 1,
"uniqueItems": true
},
"steps": {
"description": "An array of objects with a single step.",
"$ref": "#/definitions/stepArray"
}
}
}
},
"additionalProperties": {
"$ref": "#/definitions/subworkflow"
}
},
{
"description": "A list of steps.",
"$ref": "#/definitions/stepArray"
}
],
"title": "Google Cloud Workflows"
}
|
openweather.current.json | {
"$id": "https://json.schemastore.org/openweather.current",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "API responses from the OpenWeather Current Weather Data API from https://openweathermap.org/current",
"properties": {
"coord": {
"type": "object",
"additionalProperties": false,
"required": ["lat", "lon"],
"properties": {
"lat": {
"type": "number"
},
"lon": {
"type": "number"
}
}
},
"weather": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "main", "description", "icon"],
"properties": {
"id": {
"type": "integer"
},
"main": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
}
}
}
},
"base": {
"type": "string"
},
"main": {
"type": "object",
"additionalProperties": false,
"properties": {
"temp": {
"type": "number"
},
"feels_like": {
"type": "number"
},
"temp_min": {
"type": "number"
},
"temp_max": {
"type": "number"
},
"pressure": {
"type": "number"
},
"humidity": {
"type": "number"
},
"sea_level": {
"type": "number"
},
"grnd_level": {
"type": "number"
}
}
},
"visibility": {
"type": "integer"
},
"wind": {
"type": "object",
"additionalProperties": false,
"required": ["speed", "deg"],
"properties": {
"speed": {
"type": "number"
},
"deg": {
"type": "number"
}
}
},
"clouds": {
"type": "object",
"additionalProperties": false,
"required": ["all"],
"properties": {
"all": {
"type": "number",
"minimum": 0
}
}
},
"dt": {
"type": "number"
},
"sys": {
"type": "object",
"additionalProperties": false,
"required": ["type", "id", "message", "country", "sunrise", "sunset"],
"properties": {
"type": {
"type": "integer"
},
"id": {
"type": "integer"
},
"message": {
"type": "number"
},
"country": {
"type": "string"
},
"sunrise": {
"type": "integer"
},
"sunset": {
"type": "integer"
}
}
},
"timezone": {
"type": "integer"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"cod": {
"type": "integer"
}
},
"required": [
"coord",
"weather",
"base",
"main",
"visibility",
"wind",
"clouds",
"dt",
"sys",
"timezone",
"id",
"name",
"cod"
],
"title": "OpenWeather Current Weather Data API",
"type": "object"
}
|
sarif-2.1.0-rtm.2.json | {
"$id": "https://json.schemastore.org/sarif-2.1.0-rtm.2.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"address": {
"description": "A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).",
"additionalProperties": false,
"type": "object",
"properties": {
"absoluteAddress": {
"description": "The address expressed as a byte offset from the start of the addressable region.",
"type": "integer",
"minimum": -1,
"default": -1
},
"relativeAddress": {
"description": "The address expressed as a byte offset from the absolute address of the top-most parent object.",
"type": "integer"
},
"length": {
"description": "The number of bytes in this range of addresses.",
"type": "integer"
},
"kind": {
"description": "An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.",
"type": "string"
},
"name": {
"description": "A name that is associated with the address, e.g., '.text'.",
"type": "string"
},
"fullyQualifiedName": {
"description": "A human-readable fully qualified name that is associated with the address.",
"type": "string"
},
"offsetFromParent": {
"description": "The byte offset of this address from the absolute or relative address of the parent object.",
"type": "integer"
},
"index": {
"description": "The index within run.addresses of the cached object for this address.",
"type": "integer",
"default": -1,
"minimum": -1
},
"parentIndex": {
"description": "The index within run.addresses of the parent object.",
"type": "integer",
"default": -1,
"minimum": -1
},
"properties": {
"description": "Key/value pairs that provide additional information about the address.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifact": {
"description": "A single artifact. In some cases, this artifact might be nested within another artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A short description of the artifact.",
"$ref": "#/definitions/message"
},
"location": {
"description": "The location of the artifact.",
"$ref": "#/definitions/artifactLocation"
},
"parentIndex": {
"description": "Identifies the index of the immediate parent of the artifact, if this artifact is nested.",
"type": "integer",
"default": -1,
"minimum": -1
},
"offset": {
"description": "The offset in bytes of the artifact within its containing artifact.",
"type": "integer",
"minimum": 0
},
"length": {
"description": "The length of the artifact in bytes.",
"type": "integer",
"default": -1,
"minimum": -1
},
"roles": {
"description": "The role or roles played by the artifact in the analysis.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"enum": [
"analysisTarget",
"attachment",
"responseFile",
"resultFile",
"standardStream",
"tracedFile",
"unmodified",
"modified",
"added",
"deleted",
"renamed",
"uncontrolled",
"driver",
"extension",
"translation",
"taxonomy",
"policy",
"referencedOnCommandLine",
"memoryContents",
"directory",
"userSpecifiedConfiguration",
"toolSpecifiedConfiguration",
"debugOutputFile"
]
}
},
"mimeType": {
"description": "The MIME type (RFC 2045) of the artifact.",
"type": "string",
"pattern": "[^/]+/.+"
},
"contents": {
"description": "The contents of the artifact.",
"$ref": "#/definitions/artifactContent"
},
"encoding": {
"description": "Specifies the encoding for an artifact object that refers to a text file.",
"type": "string"
},
"sourceLanguage": {
"description": "Specifies the source language for any artifact object that refers to a text file that contains source code.",
"type": "string"
},
"hashes": {
"description": "A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"lastModifiedTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifactChange": {
"description": "A change to a single artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"artifactLocation": {
"description": "The location of the artifact to change.",
"$ref": "#/definitions/artifactLocation"
},
"replacements": {
"description": "An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/replacement"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the change.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactLocation", "replacements"]
},
"artifactContent": {
"description": "Represents the contents of an artifact.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "UTF-8-encoded content from a text artifact.",
"type": "string"
},
"binary": {
"description": "MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.",
"type": "string"
},
"rendered": {
"description": "An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).",
"$ref": "#/definitions/multiformatMessageString"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact content.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifactLocation": {
"description": "Specifies the location of an artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"uri": {
"description": "A string containing a valid relative or absolute URI.",
"type": "string",
"format": "uri-reference"
},
"uriBaseId": {
"description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.",
"type": "string"
},
"index": {
"description": "The index within the run artifacts array of the artifact object associated with the artifact location.",
"type": "integer",
"default": -1,
"minimum": -1
},
"description": {
"description": "A short description of the artifact location.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"attachment": {
"description": "An artifact relevant to a result.",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A message describing the role played by the attachment.",
"$ref": "#/definitions/message"
},
"artifactLocation": {
"description": "The location of the attachment.",
"$ref": "#/definitions/artifactLocation"
},
"regions": {
"description": "An array of regions of interest within the attachment.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/region"
}
},
"rectangles": {
"description": "An array of rectangles specifying areas of interest within the image.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/rectangle"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the attachment.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactLocation"]
},
"codeFlow": {
"description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to the code flow.",
"$ref": "#/definitions/message"
},
"threadFlows": {
"description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/threadFlow"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the code flow.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["threadFlows"]
},
"configurationOverride": {
"description": "Information about how a specific rule or notification was reconfigured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"configuration": {
"description": "Specifies how the rule or notification was configured during the scan.",
"$ref": "#/definitions/reportingConfiguration"
},
"descriptor": {
"description": "A reference used to locate the descriptor whose configuration was overridden.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the configuration override.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["configuration", "descriptor"]
},
"conversion": {
"description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "A tool object that describes the converter.",
"$ref": "#/definitions/tool"
},
"invocation": {
"description": "An invocation object that describes the invocation of the converter.",
"$ref": "#/definitions/invocation"
},
"analysisToolLogFiles": {
"description": "The locations of the analysis tool's per-run log files.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the conversion.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["tool"]
},
"edge": {
"description": "Represents a directed edge in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the edge within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the edge.",
"$ref": "#/definitions/message"
},
"sourceNodeId": {
"description": "Identifies the source node (the node at which the edge starts).",
"type": "string"
},
"targetNodeId": {
"description": "Identifies the target node (the node at which the edge ends).",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id", "sourceNodeId", "targetNodeId"]
},
"edgeTraversal": {
"description": "Represents the traversal of a single edge during a graph traversal.",
"type": "object",
"additionalProperties": false,
"properties": {
"edgeId": {
"description": "Identifies the edge being traversed.",
"type": "string"
},
"message": {
"description": "A message to display to the user as the edge is traversed.",
"$ref": "#/definitions/message"
},
"finalState": {
"description": "The values of relevant expressions after the edge has been traversed.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"stepOverEdgeCount": {
"description": "The number of edge traversals necessary to return from a nested graph.",
"type": "integer",
"minimum": 0
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge traversal.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["edgeId"]
},
"exception": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal."
},
"message": {
"description": "A message that describes the exception.",
"type": "string"
},
"stack": {
"description": "The sequence of function calls leading to the exception.",
"$ref": "#/definitions/stack"
},
"innerExceptions": {
"description": "An array of exception objects each of which is considered a cause of this exception.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/exception"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the exception.",
"$ref": "#/definitions/propertyBag"
}
}
},
"externalProperties": {
"type": "object",
"properties": {
"schema": {
"description": "The URI of the JSON schema corresponding to the version of the external property file format.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this external properties object.",
"enum": ["2.1.0"]
},
"guid": {
"description": "A stable, unique identifier for this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"runGuid": {
"description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"conversion": {
"description": "A conversion object that will be merged with a separate run.",
"$ref": "#/definitions/conversion"
},
"graphs": {
"description": "An array of graph objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/graph"
}
},
"externalizedProperties": {
"description": "Key/value pairs that provide additional information that will be merged with a separate run.",
"$ref": "#/definitions/propertyBag"
},
"artifacts": {
"description": "An array of artifact objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifact"
}
},
"invocations": {
"description": "Describes the invocation of the analysis tool that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/invocation"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"results": {
"description": "An array of result objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/result"
}
},
"taxonomies": {
"description": "Tool taxonomies that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"driver": {
"description": "The analysis tool object that will be merged with a separate run.",
"$ref": "#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"policies": {
"description": "Tool policies that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"translations": {
"description": "Tool translations that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/address"
}
},
"webRequests": {
"description": "Requests that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webRequest"
}
},
"webResponses": {
"description": "Responses that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webResponse"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external properties.",
"$ref": "#/definitions/propertyBag"
}
}
},
"externalPropertyFileReference": {
"type": "object",
"properties": {
"location": {
"description": "The location of the external property file.",
"$ref": "#/definitions/artifactLocation"
},
"guid": {
"description": "A stable, unique identifier for the external property file in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"itemCount": {
"description": "A non-negative integer specifying the number of items contained in the external property file.",
"type": "integer",
"default": -1,
"minimum": -1
},
"properties": {
"description": "Key/value pairs that provide additional information about the external property file.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["location"]
},
{
"required": ["guid"]
}
]
},
"externalPropertyFileReferences": {
"description": "References to external property files that should be inlined with the content of a root log file.",
"additionalProperties": false,
"type": "object",
"properties": {
"conversion": {
"description": "An external property file containing a run.conversion object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"graphs": {
"description": "An array of external property files containing a run.graphs object to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"externalizedProperties": {
"description": "An external property file containing a run.properties object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"artifacts": {
"description": "An array of external property files containing run.artifacts arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"invocations": {
"description": "An array of external property files containing run.invocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"logicalLocations": {
"description": "An array of external property files containing run.logicalLocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"threadFlowLocations": {
"description": "An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"results": {
"description": "An array of external property files containing run.results arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"taxonomies": {
"description": "An array of external property files containing run.taxonomies arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"addresses": {
"description": "An array of external property files containing run.addresses arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"driver": {
"description": "An external property file containing a run.driver object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"extensions": {
"description": "An array of external property files containing run.extensions arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"policies": {
"description": "An array of external property files containing run.policies arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"translations": {
"description": "An array of external property files containing run.translations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"webRequests": {
"description": "An array of external property files containing run.requests arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"webResponses": {
"description": "An array of external property files containing run.responses arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external property files.",
"$ref": "#/definitions/propertyBag"
}
}
},
"fix": {
"description": "A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.",
"$ref": "#/definitions/message"
},
"artifactChanges": {
"description": "One or more artifact changes that comprise a fix for a result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifactChange"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the fix.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactChanges"]
},
"graph": {
"description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the graph.",
"$ref": "#/definitions/message"
},
"nodes": {
"description": "An array of node objects representing the nodes of the graph.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/node"
}
},
"edges": {
"description": "An array of edge objects representing the edges of the graph.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/edge"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph.",
"$ref": "#/definitions/propertyBag"
}
}
},
"graphTraversal": {
"description": "Represents a path through a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"runGraphIndex": {
"description": "The index within the run.graphs to be associated with the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"resultGraphIndex": {
"description": "The index within the result.graphs to be associated with the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"description": {
"description": "A description of this graph traversal.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the graph traversal that may change during graph traversal.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"immutableState": {
"description": "Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"edgeTraversals": {
"description": "The sequences of edges traversed by this graph traversal.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/edgeTraversal"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph traversal.",
"$ref": "#/definitions/propertyBag"
}
},
"oneOf": [
{
"required": ["runGraphIndex"]
},
{
"required": ["resultGraphIndex"]
}
]
},
"invocation": {
"description": "The runtime environment of the analysis tool run.",
"additionalProperties": false,
"type": "object",
"properties": {
"commandLine": {
"description": "The command line used to invoke the tool.",
"type": "string"
},
"arguments": {
"description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"type": "string"
}
},
"responseFiles": {
"description": "The locations of any response files specified on the tool's command line.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"startTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the run started. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"endTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the run ended. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"exitCode": {
"description": "The process exit code.",
"type": "integer"
},
"ruleConfigurationOverrides": {
"description": "An array of configurationOverride objects that describe rules related runtime overrides.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/configurationOverride"
}
},
"notificationConfigurationOverrides": {
"description": "An array of configurationOverride objects that describe notifications related runtime overrides.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/configurationOverride"
}
},
"toolExecutionNotifications": {
"description": "A list of runtime conditions detected by the tool during the analysis.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/notification"
}
},
"toolConfigurationNotifications": {
"description": "A list of conditions detected by the tool that are relevant to the tool's configuration.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/notification"
}
},
"exitCodeDescription": {
"description": "The reason for the process exit.",
"type": "string"
},
"exitSignalName": {
"description": "The name of the signal that caused the process to exit.",
"type": "string"
},
"exitSignalNumber": {
"description": "The numeric value of the signal that caused the process to exit.",
"type": "integer"
},
"processStartFailureMessage": {
"description": "The reason given by the operating system that the process failed to start.",
"type": "string"
},
"executionSuccessful": {
"description": "Specifies whether the tool's execution completed successfully.",
"type": "boolean"
},
"machine": {
"description": "The machine that hosted the analysis tool run.",
"type": "string"
},
"account": {
"description": "The account that ran the analysis tool.",
"type": "string"
},
"processId": {
"description": "The process id for the analysis tool run.",
"type": "integer"
},
"executableLocation": {
"description": "An absolute URI specifying the location of the analysis tool's executable.",
"$ref": "#/definitions/artifactLocation"
},
"workingDirectory": {
"description": "The working directory for the analysis tool run.",
"$ref": "#/definitions/artifactLocation"
},
"environmentVariables": {
"description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stdin": {
"description": "A file containing the standard input stream to the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stdout": {
"description": "A file containing the standard output stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stderr": {
"description": "A file containing the standard error stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stdoutStderr": {
"description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the invocation.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["executionSuccessful"]
},
"location": {
"description": "A location within a programming artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Value that distinguishes this location from all other locations within a single result object.",
"type": "integer",
"minimum": -1,
"default": -1
},
"physicalLocation": {
"description": "Identifies the artifact and region.",
"$ref": "#/definitions/physicalLocation"
},
"logicalLocations": {
"description": "The logical locations associated with the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"message": {
"description": "A message relevant to the location.",
"$ref": "#/definitions/message"
},
"annotations": {
"description": "A set of regions relevant to the location.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/region"
}
},
"relationships": {
"description": "An array of objects that describe relationships between this location and others.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/locationRelationship"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"locationRelationship": {
"description": "Information about the relation of one location to another.",
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"description": "A reference to the related location.",
"type": "integer",
"minimum": 0
},
"kinds": {
"description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.",
"type": "array",
"default": ["relevant"],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"description": {
"description": "A description of the location relationship.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the location relationship.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["target"]
},
"logicalLocation": {
"description": "A logical location of a construct that produced a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"name": {
"description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.",
"type": "string"
},
"index": {
"description": "The index within the logical locations array.",
"type": "integer",
"default": -1,
"minimum": -1
},
"fullyQualifiedName": {
"description": "The human-readable fully qualified name of the logical location.",
"type": "string"
},
"decoratedName": {
"description": "The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.",
"type": "string"
},
"parentIndex": {
"description": "Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.",
"type": "integer",
"default": -1,
"minimum": -1
},
"kind": {
"description": "The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the logical location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"message": {
"description": "Encapsulates a message intended to be read by the end user.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string.",
"type": "string"
},
"markdown": {
"description": "A Markdown message string.",
"type": "string"
},
"id": {
"description": "The identifier for this message.",
"type": "string"
},
"arguments": {
"description": "An array of strings to substitute into the message string.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"type": "string"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the message.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["text"]
},
{
"required": ["id"]
}
]
},
"multiformatMessageString": {
"description": "A message string or message format string rendered in multiple formats.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string or format string.",
"type": "string"
},
"markdown": {
"description": "A Markdown message string or format string.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the message.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["text"]
},
"node": {
"description": "Represents a node in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the node within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the node.",
"$ref": "#/definitions/message"
},
"location": {
"description": "A code location associated with the node.",
"$ref": "#/definitions/location"
},
"children": {
"description": "Array of child nodes.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/node"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the node.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id"]
},
"notification": {
"description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.",
"type": "object",
"additionalProperties": false,
"properties": {
"locations": {
"description": "The locations relevant to this notification.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"message": {
"description": "A message that describes the condition that was encountered.",
"$ref": "#/definitions/message"
},
"level": {
"description": "A value specifying the severity level of the notification.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"threadId": {
"description": "The thread identifier of the code that generated the notification.",
"type": "integer"
},
"timeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.",
"type": "string",
"format": "date-time"
},
"exception": {
"description": "The runtime exception, if any, relevant to this notification.",
"$ref": "#/definitions/exception"
},
"descriptor": {
"description": "A reference used to locate the descriptor relevant to this notification.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"associatedRule": {
"description": "A reference used to locate the rule descriptor associated with this notification.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the notification.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["message"]
},
"physicalLocation": {
"description": "A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"address": {
"description": "The address of the location.",
"$ref": "#/definitions/address"
},
"artifactLocation": {
"description": "The location of the artifact.",
"$ref": "#/definitions/artifactLocation"
},
"region": {
"description": "Specifies a portion of the artifact.",
"$ref": "#/definitions/region"
},
"contextRegion": {
"description": "Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.",
"$ref": "#/definitions/region"
},
"properties": {
"description": "Key/value pairs that provide additional information about the physical location.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["address"]
},
{
"required": ["artifactLocation"]
}
]
},
"propertyBag": {
"description": "Key/value pairs that provide additional information about the object.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
},
"rectangle": {
"description": "An area within an image.",
"additionalProperties": false,
"type": "object",
"properties": {
"top": {
"description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"left": {
"description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"bottom": {
"description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"right": {
"description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"message": {
"description": "A message relevant to the rectangle.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the rectangle.",
"$ref": "#/definitions/propertyBag"
}
}
},
"region": {
"description": "A region within an artifact where a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"startLine": {
"description": "The line number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"startColumn": {
"description": "The column number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"endLine": {
"description": "The line number of the last character in the region.",
"type": "integer",
"minimum": 1
},
"endColumn": {
"description": "The column number of the character following the end of the region.",
"type": "integer",
"minimum": 1
},
"charOffset": {
"description": "The zero-based offset from the beginning of the artifact of the first character in the region.",
"type": "integer",
"default": -1,
"minimum": -1
},
"charLength": {
"description": "The length of the region in characters.",
"type": "integer",
"minimum": 0
},
"byteOffset": {
"description": "The zero-based offset from the beginning of the artifact of the first byte in the region.",
"type": "integer",
"default": -1,
"minimum": -1
},
"byteLength": {
"description": "The length of the region in bytes.",
"type": "integer",
"minimum": 0
},
"snippet": {
"description": "The portion of the artifact contents within the specified region.",
"$ref": "#/definitions/artifactContent"
},
"message": {
"description": "A message relevant to the region.",
"$ref": "#/definitions/message"
},
"sourceLanguage": {
"description": "Specifies the source language, if any, of the portion of the artifact specified by the region object.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the region.",
"$ref": "#/definitions/propertyBag"
}
}
},
"replacement": {
"description": "The replacement of a single region of an artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"deletedRegion": {
"description": "The region of the artifact to delete.",
"$ref": "#/definitions/region"
},
"insertedContent": {
"description": "The content to insert at the location specified by the 'deletedRegion' property.",
"$ref": "#/definitions/artifactContent"
},
"properties": {
"description": "Key/value pairs that provide additional information about the replacement.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["deletedRegion"]
},
"reportingDescriptor": {
"description": "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "A stable, opaque identifier for the report.",
"type": "string"
},
"deprecatedIds": {
"description": "An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"guid": {
"description": "A unique identifier for the reporting descriptor in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"deprecatedGuids": {
"description": "An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"name": {
"description": "A report identifier that is understandable to an end user.",
"type": "string"
},
"deprecatedNames": {
"description": "An array of readable identifiers by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"shortDescription": {
"description": "A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
"$ref": "#/definitions/multiformatMessageString"
},
"messageStrings": {
"description": "A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"defaultConfiguration": {
"description": "Default reporting configuration information.",
"$ref": "#/definitions/reportingConfiguration"
},
"helpUri": {
"description": "A URI where the primary documentation for the report can be found.",
"type": "string",
"format": "uri"
},
"help": {
"description": "Provides the primary documentation for the report, useful when there is no online documentation.",
"$ref": "#/definitions/multiformatMessageString"
},
"relationships": {
"description": "An array of objects that describe relationships between this reporting descriptor and others.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorRelationship"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the report.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id"]
},
"reportingConfiguration": {
"description": "Information about a rule or notification that can be configured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Specifies whether the report may be produced during the scan.",
"type": "boolean",
"default": true
},
"level": {
"description": "Specifies the failure level for the report.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"rank": {
"description": "Specifies the relative priority of the report. Used for analysis output only.",
"type": "number",
"default": -1,
"minimum": -1,
"maximum": 100
},
"parameters": {
"description": "Contains configuration information specific to a report.",
"$ref": "#/definitions/propertyBag"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting configuration.",
"$ref": "#/definitions/propertyBag"
}
}
},
"reportingDescriptorReference": {
"description": "Information about how to locate a relevant reporting descriptor.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The id of the descriptor.",
"type": "string"
},
"index": {
"description": "The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.",
"type": "integer",
"default": -1,
"minimum": -1
},
"guid": {
"description": "A guid that uniquely identifies the descriptor.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"toolComponent": {
"description": "A reference used to locate the toolComponent associated with the descriptor.",
"$ref": "#/definitions/toolComponentReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["index"]
},
{
"required": ["guid"]
},
{
"required": ["id"]
}
]
},
"reportingDescriptorRelationship": {
"description": "Information about the relation of one reporting descriptor to another.",
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"description": "A reference to the related reporting descriptor.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"kinds": {
"description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.",
"type": "array",
"default": ["relevant"],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"description": {
"description": "A description of the reporting descriptor relationship.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["target"]
},
"result": {
"description": "A result produced by an analysis tool.",
"additionalProperties": false,
"type": "object",
"properties": {
"ruleId": {
"description": "The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
"type": "string"
},
"ruleIndex": {
"description": "The index within the tool component rules array of the rule object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"rule": {
"description": "A reference used to locate the rule descriptor relevant to this result.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"kind": {
"description": "A value that categorizes results by evaluation state.",
"default": "fail",
"enum": [
"notApplicable",
"pass",
"fail",
"review",
"open",
"informational"
]
},
"level": {
"description": "A value specifying the severity level of the result.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"message": {
"description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.",
"$ref": "#/definitions/message"
},
"analysisTarget": {
"description": "Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.",
"$ref": "#/definitions/artifactLocation"
},
"locations": {
"description": "The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"guid": {
"description": "A stable, unique identifier for the result in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"occurrenceCount": {
"description": "A positive integer specifying the number of times this logically unique result was observed in this run.",
"type": "integer",
"minimum": 1
},
"partialFingerprints": {
"description": "A set of strings that contribute to the stable, unique identity of the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fingerprints": {
"description": "A set of strings each of which individually defines a stable, unique identity for the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stacks": {
"description": "An array of 'stack' objects relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/stack"
}
},
"codeFlows": {
"description": "An array of 'codeFlow' objects relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/codeFlow"
}
},
"graphs": {
"description": "An array of zero or more unique graph objects associated with the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graph"
}
},
"graphTraversals": {
"description": "An array of one or more unique 'graphTraversal' objects.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graphTraversal"
}
},
"relatedLocations": {
"description": "A set of locations relevant to this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"suppressions": {
"description": "A set of suppressions relevant to this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/suppression"
}
},
"baselineState": {
"description": "The state of a result relative to a baseline of a previous run.",
"enum": ["new", "unchanged", "updated", "absent"]
},
"rank": {
"description": "A number representing the priority or importance of the result.",
"type": "number",
"default": -1,
"minimum": -1,
"maximum": 100
},
"attachments": {
"description": "A set of artifacts relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/attachment"
}
},
"hostedViewerUri": {
"description": "An absolute URI at which the result can be viewed.",
"type": "string",
"format": "uri"
},
"workItemUris": {
"description": "The URIs of the work items associated with this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"format": "uri"
}
},
"provenance": {
"description": "Information about how and when the result was detected.",
"$ref": "#/definitions/resultProvenance"
},
"fixes": {
"description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/fix"
}
},
"taxa": {
"description": "An array of references to taxonomy reporting descriptors that are applicable to the result.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorReference"
}
},
"webRequest": {
"description": "A web request associated with this result.",
"$ref": "#/definitions/webRequest"
},
"webResponse": {
"description": "A web response associated with this result.",
"$ref": "#/definitions/webResponse"
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["message"]
},
"resultProvenance": {
"description": "Contains information about how and when a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"firstDetectionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the result was first detected. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"lastDetectionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"firstDetectionRunGuid": {
"description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"lastDetectionRunGuid": {
"description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"invocationIndex": {
"description": "The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"conversionSources": {
"description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/physicalLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"$ref": "#/definitions/propertyBag"
}
}
},
"run": {
"description": "Describes a single run of an analysis tool, and contains the reported output of that run.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.",
"$ref": "#/definitions/tool"
},
"invocations": {
"description": "Describes the invocation of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/invocation"
}
},
"conversion": {
"description": "A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.",
"$ref": "#/definitions/conversion"
},
"language": {
"description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
"type": "string",
"default": "en-US",
"pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"
},
"versionControlProvenance": {
"description": "Specifies the revision in version control of the artifacts that were scanned.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/versionControlDetails"
}
},
"originalUriBaseIds": {
"description": "The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactLocation"
}
},
"artifacts": {
"description": "An array of artifact objects relevant to the run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifact"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"graphs": {
"description": "An array of zero or more unique graph objects associated with the run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graph"
}
},
"results": {
"description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/result"
}
},
"automationDetails": {
"description": "Automation details that describe this run.",
"$ref": "#/definitions/runAutomationDetails"
},
"runAggregates": {
"description": "Automation details that describe the aggregate of runs to which this run belongs.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/runAutomationDetails"
}
},
"baselineGuid": {
"description": "The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"redactionTokens": {
"description": "An array of strings used to replace sensitive information in a redaction-aware property.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
},
"defaultEncoding": {
"description": "Specifies the default encoding for any artifact object that refers to a text file.",
"type": "string"
},
"defaultSourceLanguage": {
"description": "Specifies the default source language for any artifact object that refers to a text file that contains source code.",
"type": "string"
},
"newlineSequences": {
"description": "An ordered list of character sequences that were treated as line breaks when computing region information for the run.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"default": ["\r\n", "\n"],
"items": {
"type": "string"
}
},
"columnKind": {
"description": "Specifies the unit in which the tool measures columns.",
"enum": ["utf16CodeUnits", "unicodeCodePoints"]
},
"externalPropertyFileReferences": {
"description": "References to external property files that should be inlined with the content of a root log file.",
"$ref": "#/definitions/externalPropertyFileReferences"
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"taxonomies": {
"description": "An array of toolComponent objects relevant to a taxonomy in which results are categorized.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses associated with this run instance, if any.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/address"
}
},
"translations": {
"description": "The set of available translations of the localized data provided by the tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"policies": {
"description": "Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"webRequests": {
"description": "An array of request objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webRequest"
}
},
"webResponses": {
"description": "An array of response objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webResponse"
}
},
"specialLocations": {
"description": "A specialLocations object that defines locations of special significance to SARIF consumers.",
"$ref": "#/definitions/specialLocations"
},
"properties": {
"description": "Key/value pairs that provide additional information about the run.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["tool"]
},
"runAutomationDetails": {
"description": "Information that describes a run's identity and role within an engineering system process.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A description of the identity and role played within the engineering system by this object's containing run object.",
"$ref": "#/definitions/message"
},
"id": {
"description": "A hierarchical string that uniquely identifies this object's containing run object.",
"type": "string"
},
"guid": {
"description": "A stable, unique identifier for this object's containing run object in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"properties": {
"description": "Key/value pairs that provide additional information about the run automation details.",
"$ref": "#/definitions/propertyBag"
}
}
},
"specialLocations": {
"description": "Defines locations of special significance to SARIF consumers.",
"type": "object",
"properties": {
"displayBase": {
"description": "Provides a suggestion to SARIF consumers to display file paths relative to the specified location.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the special locations.",
"$ref": "#/definitions/propertyBag"
}
}
},
"stack": {
"description": "A call stack that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to this call stack.",
"$ref": "#/definitions/message"
},
"frames": {
"description": "An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/stackFrame"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["frames"]
},
"stackFrame": {
"description": "A function call within a stack trace.",
"additionalProperties": false,
"type": "object",
"properties": {
"location": {
"description": "The location to which this stack frame refers.",
"$ref": "#/definitions/location"
},
"module": {
"description": "The name of the module that contains the code of this stack frame.",
"type": "string"
},
"threadId": {
"description": "The thread identifier of the stack frame.",
"type": "integer"
},
"parameters": {
"description": "The parameters of the call that is executing.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"type": "string",
"default": []
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack frame.",
"$ref": "#/definitions/propertyBag"
}
}
},
"suppression": {
"description": "A suppression that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"guid": {
"description": "A stable, unique identifier for the suppression in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"kind": {
"description": "A string that indicates where the suppression is persisted.",
"enum": ["inSource", "external"]
},
"state": {
"description": "A string that indicates the state of the suppression.",
"enum": ["accepted", "underReview", "rejected"]
},
"justification": {
"description": "A string representing the justification for the suppression.",
"type": "string"
},
"location": {
"description": "Identifies the location associated with the suppression.",
"$ref": "#/definitions/location"
},
"properties": {
"description": "Key/value pairs that provide additional information about the suppression.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["kind"]
},
"threadFlow": {
"type": "object",
"properties": {
"id": {
"description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.",
"type": "string"
},
"message": {
"description": "A message relevant to the thread flow.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the thread flow that may change during thread flow execution.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"immutableState": {
"description": "Values of relevant expressions at the start of the thread flow that remain constant.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"locations": {
"description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the thread flow.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["locations"]
},
"threadFlowLocation": {
"description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.",
"additionalProperties": false,
"type": "object",
"properties": {
"index": {
"description": "The index within the run threadFlowLocations array.",
"type": "integer",
"default": -1,
"minimum": -1
},
"location": {
"description": "The code location.",
"$ref": "#/definitions/location"
},
"stack": {
"description": "The call stack leading to this location.",
"$ref": "#/definitions/stack"
},
"kinds": {
"description": "A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
},
"taxa": {
"description": "An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorReference"
}
},
"module": {
"description": "The name of the module that contains the code that is executing.",
"type": "string"
},
"state": {
"description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"nestingLevel": {
"description": "An integer representing a containment hierarchy within the thread flow.",
"type": "integer",
"minimum": 0
},
"executionOrder": {
"description": "An integer representing the temporal order in which execution reached this location.",
"type": "integer",
"default": -1,
"minimum": -1
},
"executionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which this location was executed.",
"type": "string",
"format": "date-time"
},
"importance": {
"description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".",
"enum": ["important", "essential", "unimportant"],
"default": "important"
},
"webRequest": {
"description": "A web request associated with this thread flow location.",
"$ref": "#/definitions/webRequest"
},
"webResponse": {
"description": "A web response associated with this thread flow location.",
"$ref": "#/definitions/webResponse"
},
"properties": {
"description": "Key/value pairs that provide additional information about the threadflow location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"tool": {
"description": "The analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"driver": {
"description": "The analysis tool that was run.",
"$ref": "#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that contributed to or reconfigured the analysis tool that was run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["driver"]
},
"toolComponent": {
"description": "A component, such as a plug-in or the driver, of the analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"guid": {
"description": "A unique identifier for the tool component in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"name": {
"description": "The name of the tool component.",
"type": "string"
},
"organization": {
"description": "The organization or company that produced the tool component.",
"type": "string"
},
"product": {
"description": "A product suite to which the tool component belongs.",
"type": "string"
},
"productSuite": {
"description": "A localizable string containing the name of the suite of products to which the tool component belongs.",
"type": "string"
},
"shortDescription": {
"description": "A brief description of the tool component.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A comprehensive description of the tool component.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullName": {
"description": "The name of the tool component along with its version and any other useful identifying information, such as its locale.",
"type": "string"
},
"version": {
"description": "The tool component version, in whatever format the component natively provides.",
"type": "string"
},
"semanticVersion": {
"description": "The tool component version in the format specified by Semantic Versioning 2.0.",
"type": "string"
},
"dottedQuadFileVersion": {
"description": "The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).",
"type": "string",
"pattern": "[0-9]+(\\.[0-9]+){3}"
},
"releaseDateUtc": {
"description": "A string specifying the UTC date (and optionally, the time) of the component's release.",
"type": "string"
},
"downloadUri": {
"description": "The absolute URI from which the tool component can be downloaded.",
"type": "string",
"format": "uri"
},
"informationUri": {
"description": "The absolute URI at which information about this version of the tool component can be found.",
"type": "string",
"format": "uri"
},
"globalMessageStrings": {
"description": "A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"notifications": {
"description": "An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"rules": {
"description": "An array of reportingDescriptor objects relevant to the analysis performed by the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"taxa": {
"description": "An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"locations": {
"description": "An array of the artifactLocation objects associated with the tool component.",
"type": "array",
"minItems": 0,
"default": [],
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"language": {
"description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
"type": "string",
"default": "en-US",
"pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"
},
"contents": {
"description": "The kinds of data contained in this object.",
"type": "array",
"uniqueItems": true,
"default": ["localizedData", "nonLocalizedData"],
"items": {
"enum": ["localizedData", "nonLocalizedData"]
}
},
"isComprehensive": {
"description": "Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.",
"type": "boolean",
"default": false
},
"localizedDataSemanticVersion": {
"description": "The semantic version of the localized strings defined in this component; maintained by components that provide translations.",
"type": "string"
},
"minimumRequiredLocalizedDataSemanticVersion": {
"description": "The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.",
"type": "string"
},
"associatedComponent": {
"description": "The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.",
"$ref": "#/definitions/toolComponentReference"
},
"translationMetadata": {
"description": "Translation metadata, required for a translation, not populated by other component types.",
"$ref": "#/definitions/translationMetadata"
},
"supportedTaxonomies": {
"description": "An array of toolComponentReference objects to declare the taxonomies supported by the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponentReference"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool component.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["name"]
},
"toolComponentReference": {
"description": "",
"type": "object",
"properties": {
"name": {
"description": "The 'name' property of the referenced toolComponent.",
"type": "string"
},
"index": {
"description": "An index into the referenced toolComponent in tool.extensions.",
"type": "integer",
"default": -1,
"minimum": -1
},
"guid": {
"description": "The 'guid' property of the referenced toolComponent.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"properties": {
"description": "Key/value pairs that provide additional information about the toolComponentReference.",
"$ref": "#/definitions/propertyBag"
}
}
},
"translationMetadata": {
"description": "Provides additional metadata related to translation.",
"type": "object",
"properties": {
"name": {
"description": "The name associated with the translation metadata.",
"type": "string"
},
"fullName": {
"description": "The full name associated with the translation metadata.",
"type": "string"
},
"shortDescription": {
"description": "A brief description of the translation metadata.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A comprehensive description of the translation metadata.",
"$ref": "#/definitions/multiformatMessageString"
},
"downloadUri": {
"description": "The absolute URI from which the translation metadata can be downloaded.",
"type": "string",
"format": "uri"
},
"informationUri": {
"description": "The absolute URI from which information related to the translation metadata can be downloaded.",
"type": "string",
"format": "uri"
},
"properties": {
"description": "Key/value pairs that provide additional information about the translation metadata.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["name"]
},
"versionControlDetails": {
"description": "Specifies the information necessary to retrieve a desired revision from a version control system.",
"type": "object",
"additionalProperties": false,
"properties": {
"repositoryUri": {
"description": "The absolute URI of the repository.",
"type": "string",
"format": "uri"
},
"revisionId": {
"description": "A string that uniquely and permanently identifies the revision within the repository.",
"type": "string"
},
"branch": {
"description": "The name of a branch containing the revision.",
"type": "string"
},
"revisionTag": {
"description": "A tag that has been applied to the revision.",
"type": "string"
},
"asOfTimeUtc": {
"description": "A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.",
"type": "string",
"format": "date-time"
},
"mappedTo": {
"description": "The location in the local file system to which the root of the repository was mapped at the time of the analysis.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the version control details.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["repositoryUri"]
},
"webRequest": {
"description": "A web request object.",
"type": "object",
"properties": {
"index": {
"description": "The index within the run.webRequests array of the request object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"protocol": {
"description": "The request protocol. Example: 'http'.",
"type": "string"
},
"version": {
"description": "The request version. Example: '1.1'.",
"type": "string"
},
"target": {
"description": "The target of the request.",
"type": "string"
},
"method": {
"description": "The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.",
"type": "string"
},
"headers": {
"description": "The request headers.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"parameters": {
"description": "The request parameters.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"description": "The body of the request.",
"$ref": "#/definitions/artifactContent"
},
"properties": {
"description": "Key/value pairs that provide additional information about the request.",
"$ref": "#/definitions/propertyBag"
}
}
},
"webResponse": {
"description": "A web response object.",
"type": "object",
"properties": {
"index": {
"description": "The index within the run.webResponses array of the response object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"protocol": {
"description": "The response protocol. Example: 'http'.",
"type": "string"
},
"version": {
"description": "The response version. Example: '1.1'.",
"type": "string"
},
"statusCode": {
"description": "The response status code. Example: 451.",
"type": "integer"
},
"reasonPhrase": {
"description": "The response reason. Example: 'Not found'.",
"type": "string"
},
"headers": {
"description": "The response headers.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"description": "The body of the response.",
"$ref": "#/definitions/artifactContent"
},
"noResponseReceived": {
"description": "Specifies whether a response was received from the server.",
"type": "boolean",
"default": false
},
"properties": {
"description": "Key/value pairs that provide additional information about the response.",
"$ref": "#/definitions/propertyBag"
}
}
}
},
"description": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.2 JSON Schema: a standard format for the output of static analysis tools.",
"properties": {
"$schema": {
"description": "The URI of the JSON schema corresponding to the version.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this log file.",
"enum": ["2.1.0"]
},
"runs": {
"description": "The set of runs contained in this log file.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/run"
}
},
"inlineExternalProperties": {
"description": "References to external property files that share data between runs.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/externalProperties"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the log file.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["version", "runs"],
"title": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.2 JSON Schema",
"type": "object"
}
|
electron-builder.json | {
"$id": "https://json.schemastore.org/electron-builder.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"AppImageOptions": {
"additionalProperties": false,
"properties": {
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"category": {
"description": "The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).",
"type": ["null", "string"]
},
"description": {
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
"type": ["null", "string"]
},
"desktop": {
"description": "The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."
},
"license": {
"description": "The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). Only plain text is supported.",
"type": ["null", "string"]
},
"mimeTypes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"synopsis": {
"description": "The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).",
"type": ["null", "string"]
},
"systemIntegration": {
"default": "ask",
"description": "The system integration installation.",
"enum": ["ask", "doNotAsk"],
"type": "string"
}
},
"title": "AppImageOptions",
"type": "object"
},
"AppXOptions": {
"additionalProperties": false,
"properties": {
"addAutoLaunchExtension": {
"description": "Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.",
"type": "boolean"
},
"applicationId": {
"description": "The application id. Defaults to `identityName`. Can't start with numbers.",
"type": "string"
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"backgroundColor": {
"default": "#464646",
"description": "The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).",
"type": ["null", "string"]
},
"displayName": {
"description": "A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).\nDefaults to the application product name.",
"type": ["null", "string"]
},
"electronUpdaterAware": {
"default": false,
"type": "boolean"
},
"identityName": {
"description": "The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).",
"type": ["null", "string"]
},
"languages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.\nThe first entry (index 0) will be the default language.\nDefaults to en-US if omitted."
},
"makeappxArgs": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"publisher": {
"description": "The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.",
"type": ["null", "string"]
},
"publisherDisplayName": {
"description": "A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).\nDefaults to company name from the application metadata.",
"type": ["null", "string"]
},
"showNameOnTiles": {
"description": "Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.",
"type": "boolean"
},
"setBuildNumber": {
"description": "Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875",
"type": "boolean"
}
},
"title": "AppXOptions",
"type": "object"
},
"AsarOptions": {
"additionalProperties": false,
"properties": {
"externalAllowed": {
"default": false,
"description": "Allows external asar files.",
"type": "boolean"
},
"ordering": {
"type": ["null", "string"]
},
"smartUnpack": {
"default": true,
"description": "Whether to automatically unpack executables files.",
"type": "boolean"
}
},
"title": "AsarOptions",
"type": "object"
},
"BintrayOptions": {
"additionalProperties": false,
"description": "[Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page (\"Edit Your Profile\" -> API Key).\nDefine `BT_TOKEN` environment variable.",
"properties": {
"component": {
"description": "The Bintray component (Debian only).",
"type": ["null", "string"]
},
"distribution": {
"default": "stable",
"description": "The Bintray distribution (Debian only).",
"type": ["null", "string"]
},
"owner": {
"description": "The owner.",
"type": ["null", "string"]
},
"package": {
"description": "The Bintray package name.",
"type": ["null", "string"]
},
"provider": {
"description": "The provider. Must be `bintray`.",
"enum": ["bintray"],
"type": "string"
},
"publishAutoUpdate": {
"default": true,
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
"type": "boolean"
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"repo": {
"default": "generic",
"description": "The Bintray repository name.",
"type": ["null", "string"]
},
"token": {
"type": ["null", "string"]
},
"updaterCacheDirName": {
"type": ["null", "string"]
},
"user": {
"description": "The Bintray user account. Used in cases where the owner is an organization.",
"type": ["null", "string"]
}
},
"required": ["provider"],
"title": "BintrayOptions",
"type": "object"
},
"CustomPublishOptions": {
"additionalProperties": {},
"properties": {
"provider": {
"$ref": "#/definitions/PublishProvider",
"description": "The provider."
},
"publishAutoUpdate": {
"default": true,
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
"type": "boolean"
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"updaterCacheDirName": {
"type": ["null", "string"]
}
},
"required": ["provider"],
"title": "CustomPublishOptions",
"type": "object"
},
"DebOptions": {
"additionalProperties": false,
"properties": {
"afterInstall": {
"type": ["null", "string"]
},
"afterRemove": {
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"category": {
"description": "The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["bzip2", "gz", "xz"],
"type": "string"
},
{
"type": "null"
}
],
"default": "xz",
"description": "The compression type."
},
"depends": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Package dependencies. Defaults to `[\"gconf2\", \"gconf-service\", \"libnotify4\", \"libappindicator1\", \"libxtst6\", \"libnss3\"]`."
},
"description": {
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
"type": ["null", "string"]
},
"desktop": {
"description": "The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."
},
"fpm": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.\n\nExample: `[\"--before-install=build/deb-preinstall.sh\", \"--after-upgrade=build/deb-postinstall.sh\"]`"
},
"icon": {
"type": "string"
},
"maintainer": {
"type": ["null", "string"]
},
"mimeTypes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."
},
"packageCategory": {
"description": "The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section).",
"type": ["null", "string"]
},
"priority": {
"description": "The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute.",
"type": ["null", "string"]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"synopsis": {
"description": "The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).",
"type": ["null", "string"]
},
"vendor": {
"type": ["null", "string"]
}
},
"title": "DebOptions",
"type": "object"
},
"DmgContent": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the file within the DMG. Defaults to basename of `path`.",
"type": "string"
},
"path": {
"description": "The path of the file within the DMG.",
"type": "string"
},
"type": {
"enum": ["dir", "file", "link"],
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": ["x", "y"],
"title": "DmgContent",
"type": "object"
},
"DmgOptions": {
"additionalProperties": false,
"properties": {
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"background": {
"description": "The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.\nIf background is not specified, use `window.size`. Default locations expected background size to be 540x380.",
"type": ["null", "string"]
},
"backgroundColor": {
"description": "The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.",
"type": ["null", "string"]
},
"contents": {
"description": "The content — to customize icon locations.",
"items": {
"$ref": "#/definitions/DmgContent"
},
"type": "array"
},
"format": {
"default": "UDZO",
"description": "The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).",
"enum": ["UDBZ", "UDCO", "UDRO", "UDRW", "UDZO", "ULFO"],
"type": "string"
},
"icon": {
"description": "The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to the application icon (`build/icon.icns`).",
"type": ["null", "string"]
},
"iconSize": {
"default": 80,
"description": "The size of all the icons inside the DMG.",
"type": ["null", "number"]
},
"iconTextSize": {
"default": 12,
"description": "The size of all the icon texts inside the DMG.",
"type": ["null", "number"]
},
"internetEnabled": {
"default": false,
"description": "Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).",
"type": "boolean"
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"title": {
"default": "${productName} ${version}",
"description": "The title of the produced DMG, which will be shown when mounted (volume name).\n\nMacro `${productName}`, `${version}` and `${name}` are supported.",
"type": ["null", "string"]
},
"window": {
"$ref": "#/definitions/DmgWindow",
"description": "The DMG windows position and size."
}
},
"title": "DmgOptions",
"type": "object"
},
"DmgWindow": {
"additionalProperties": false,
"properties": {
"height": {
"description": "The height. Defaults to background image height or 380.",
"type": "number"
},
"width": {
"description": "The width. Defaults to background image width or 540.",
"type": "number"
},
"x": {
"default": 400,
"description": "The X position relative to left of the screen.",
"type": "number"
},
"y": {
"default": 100,
"description": "The Y position relative to top of the screen.",
"type": "number"
}
},
"title": "DmgWindow",
"type": "object"
},
"ElectronDownloadOptions": {
"additionalProperties": false,
"properties": {
"arch": {
"type": "string"
},
"cache": {
"description": "The [cache location](https://github.com/electron-userland/electron-download#cache-location).",
"type": ["null", "string"]
},
"customDir": {
"type": ["null", "string"]
},
"customFilename": {
"type": ["null", "string"]
},
"isVerifyChecksum": {
"type": "boolean"
},
"mirror": {
"description": "The mirror.",
"type": ["null", "string"]
},
"platform": {
"enum": ["darwin", "linux", "mas", "win32"],
"type": "string"
},
"strictSSL": {
"type": "boolean"
},
"version": {
"type": "string"
}
},
"title": "ElectronDownloadOptions",
"type": "object"
},
"FileAssociation": {
"additionalProperties": false,
"description": "File associations.\n\nmacOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.\n\nOn Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`.",
"properties": {
"description": {
"description": "*windows-only.* The description.",
"type": ["null", "string"]
},
"ext": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The extension (minus the leading period). e.g. `png`."
},
"icon": {
"description": "The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.\n\nNot supported on Linux, file issue if need (default icon will be `x-office-document`).",
"type": ["null", "string"]
},
"isPackage": {
"description": "*macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.",
"type": "boolean"
},
"mimeType": {
"description": "*linux-only.* The mime-type.",
"type": ["null", "string"]
},
"name": {
"description": "The name. e.g. `PNG`. Defaults to `ext`.",
"type": ["null", "string"]
},
"role": {
"default": "Editor",
"description": "*macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.",
"type": "string"
}
},
"required": ["ext"],
"title": "FileAssociation",
"type": "object"
},
"FileSet": {
"additionalProperties": false,
"properties": {
"filter": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The [glob patterns](/file-patterns)."
},
"from": {
"description": "The source path relative to the project directory.",
"type": "string"
},
"to": {
"description": "The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`.",
"type": "string"
}
},
"title": "FileSet",
"type": "object"
},
"GenericServerOptions": {
"additionalProperties": false,
"description": "Generic (any HTTP(S) server) options.\nIn all publish options [File Macros](/file-patterns#file-macros) are supported.",
"properties": {
"channel": {
"default": "latest",
"description": "The channel.",
"type": ["null", "string"]
},
"provider": {
"description": "The provider. Must be `generic`.",
"enum": ["generic"],
"type": "string"
},
"publishAutoUpdate": {
"default": true,
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
"type": "boolean"
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"updaterCacheDirName": {
"type": ["null", "string"]
},
"url": {
"description": "The base url. e.g. `https://bucket_name.s3.amazonaws.com`.",
"type": "string"
},
"useMultipleRangeRequest": {
"description": "Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.",
"type": "boolean"
}
},
"required": ["provider", "url"],
"title": "GenericServerOptions",
"type": "object"
},
"GithubOptions": {
"additionalProperties": false,
"description": "[GitHub](https://help.github.com/articles/about-releases/) options.\n\nGitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.\nDefine `GH_TOKEN` environment variable.",
"properties": {
"host": {
"default": "github.com",
"description": "The host (including the port if need).",
"type": ["null", "string"]
},
"owner": {
"description": "The owner.",
"type": ["null", "string"]
},
"private": {
"description": "Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo).",
"type": ["null", "boolean"]
},
"protocol": {
"anyOf": [
{
"enum": ["http", "https"],
"type": "string"
},
{
"type": "null"
}
],
"default": "https",
"description": "The protocol. GitHub Publisher supports only `https`."
},
"provider": {
"description": "The provider. Must be `github`.",
"enum": ["github"],
"type": "string"
},
"publishAutoUpdate": {
"default": true,
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
"type": "boolean"
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"releaseType": {
"anyOf": [
{
"enum": ["draft", "prerelease", "release"],
"type": "string"
},
{
"type": "null"
}
],
"default": "draft",
"description": "The type of release. By default `draft` release will be created.\n\nAlso you can set release type using environment variable. If `EP_DRAFT`is set to `true` — `draft`, if `EP_PRE_RELEASE`is set to `true` — `prerelease`."
},
"repo": {
"description": "The repository name. [Detected automatically](#github-repository-and-bintray-package).",
"type": ["null", "string"]
},
"token": {
"description": "The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions).",
"type": ["null", "string"]
},
"updaterCacheDirName": {
"type": ["null", "string"]
},
"vPrefixedTagName": {
"default": true,
"description": "Whether to use `v`-prefixed tag name.",
"type": "boolean"
}
},
"required": ["provider"],
"title": "GithubOptions",
"type": "object"
},
"LinuxConfiguration": {
"additionalProperties": false,
"properties": {
"appId": {
"default": "com.electron.${name}",
"description": "The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.",
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).",
"type": ["null", "string"]
},
"asar": {
"anyOf": [
{
"$ref": "#/definitions/AsarOptions"
},
{
"type": ["null", "boolean"]
}
],
"default": true,
"description": "Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."
},
"asarUnpack": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."
},
"category": {
"description": "The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["maximum", "normal", "store"],
"type": "string"
},
{
"type": "null"
}
],
"default": "normal",
"description": "The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."
},
"cscKeyPassword": {
"type": ["null", "string"]
},
"cscLink": {
"type": ["null", "string"]
},
"depends": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"description": {
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
"type": ["null", "string"]
},
"desktop": {
"description": "The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."
},
"detectUpdateChannel": {
"default": true,
"description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
"type": "boolean"
},
"electronUpdaterCompatibility": {
"description": "The [electron-updater compatibility](/auto-update#compatibility) semver range.",
"type": ["null", "string"]
},
"executableName": {
"description": "The executable name. Defaults to `productName`.\nCannot be specified per target, allowed only in the `linux`.",
"type": ["null", "string"]
},
"extraFiles": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"extraResources": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"fileAssociations": {
"anyOf": [
{
"$ref": "#/definitions/FileAssociation"
},
{
"items": {
"$ref": "#/definitions/FileAssociation"
},
"type": "array"
}
],
"description": "The file associations."
},
"files": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"forceCodeSigning": {
"description": "Whether to fail if app will be not code signed.",
"type": "boolean"
},
"generateUpdatesFilesForAllChannels": {
"default": false,
"description": "Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).",
"type": "boolean"
},
"icon": {
"description": "The path to icon set directory or one png file, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.\nBy default will be generated automatically based on the macOS icns file.",
"type": "string"
},
"maintainer": {
"description": "The maintainer. Defaults to [author](/configuration/configuration#Metadata-author).",
"type": ["null", "string"]
},
"mimeTypes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."
},
"packageCategory": {
"description": "backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place",
"type": ["null", "string"]
},
"protocols": {
"anyOf": [
{
"$ref": "#/definitions/Protocol"
},
{
"items": {
"$ref": "#/definitions/Protocol"
},
"type": "array"
}
],
"description": "The URL protocol schemes."
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"releaseInfo": {
"$ref": "#/definitions/ReleaseInfo",
"description": "The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"
},
"synopsis": {
"description": "The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).",
"type": ["null", "string"]
},
"target": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"default": "AppImage",
"description": "Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\n\nelectron-builder [docker image](/multi-platform-build#docker) can be used to build Linux targets on any platform.\n\nPlease [do not put an AppImage into another archive](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) like a .zip or .tar.gz."
},
"vendor": {
"description": "The vendor. Defaults to [author](/configuration/configuration#Metadata-author).",
"type": ["null", "string"]
}
},
"title": "LinuxConfiguration",
"type": "object"
},
"LinuxTargetSpecificOptions": {
"additionalProperties": false,
"properties": {
"afterInstall": {
"type": ["null", "string"]
},
"afterRemove": {
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"category": {
"description": "The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["bzip2", "gz", "xz"],
"type": "string"
},
{
"type": "null"
}
],
"default": "xz",
"description": "The compression type."
},
"depends": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Package dependencies."
},
"description": {
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
"type": ["null", "string"]
},
"desktop": {
"description": "The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."
},
"fpm": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.\n\nExample: `[\"--before-install=build/deb-preinstall.sh\", \"--after-upgrade=build/deb-postinstall.sh\"]`"
},
"icon": {
"type": "string"
},
"maintainer": {
"type": ["null", "string"]
},
"mimeTypes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."
},
"packageCategory": {
"description": "The package category.",
"type": ["null", "string"]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"synopsis": {
"description": "The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).",
"type": ["null", "string"]
},
"vendor": {
"type": ["null", "string"]
}
},
"title": "LinuxTargetSpecificOptions",
"type": "object"
},
"MacConfiguration": {
"additionalProperties": false,
"properties": {
"appId": {
"default": "com.electron.${name}",
"description": "The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.",
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).",
"type": ["null", "string"]
},
"asar": {
"anyOf": [
{
"$ref": "#/definitions/AsarOptions"
},
{
"type": ["null", "boolean"]
}
],
"default": true,
"description": "Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."
},
"asarUnpack": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."
},
"binaries": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Paths of any extra binaries that need to be signed."
},
"bundleShortVersion": {
"description": "The `CFBundleShortVersionString`. Do not use it unless you need to.",
"type": ["null", "string"]
},
"bundleVersion": {
"description": "The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).",
"type": ["null", "string"]
},
"category": {
"description": "The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\n\nFor example, `\"category\": \"public.app-category.developer-tools\"` will set the application category to *Developer Tools*.\n\nValid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["maximum", "normal", "store"],
"type": "string"
},
{
"type": "null"
}
],
"default": "normal",
"description": "The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."
},
"cscInstallerKeyPassword": {
"type": ["null", "string"]
},
"cscInstallerLink": {
"type": ["null", "string"]
},
"cscKeyPassword": {
"type": ["null", "string"]
},
"cscLink": {
"type": ["null", "string"]
},
"darkModeSupport": {
"default": false,
"description": "Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.",
"type": "boolean"
},
"hardenedRuntime": {
"default": false,
"description": "Whether your app has to be signed with hardened runtime.",
"type": "boolean"
},
"gatekeeperAssess": {
"default": false,
"description": "Whether to let electron-osx-sign validate the signing or not.",
"type": "boolean"
},
"detectUpdateChannel": {
"default": true,
"description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
"type": "boolean"
},
"electronLanguages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The electron locales. By default Electron locales used as is."
},
"electronUpdaterCompatibility": {
"description": "The [electron-updater compatibility](/auto-update#compatibility) semver range.",
"type": ["null", "string"]
},
"entitlements": {
"description": "The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).\nMAS entitlements is specified in the [mas](/configuration/mas).",
"type": ["null", "string"]
},
"entitlementsInherit": {
"description": "The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).\n\nThis option only applies when signing with `entitlements` provided.",
"type": ["null", "string"]
},
"extendInfo": {
"description": "The extra entries for `Info.plist`."
},
"extraDistFiles": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "Extra files to put in archive. Not applicable for `tar.*`."
},
"extraFiles": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"extraResources": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"fileAssociations": {
"anyOf": [
{
"$ref": "#/definitions/FileAssociation"
},
{
"items": {
"$ref": "#/definitions/FileAssociation"
},
"type": "array"
}
],
"description": "The file associations."
},
"files": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"forceCodeSigning": {
"description": "Whether to fail if app will be not code signed.",
"type": "boolean"
},
"generateUpdatesFilesForAllChannels": {
"default": false,
"description": "Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).",
"type": "boolean"
},
"helperBundleId": {
"default": "${appBundleIdentifier}.helper",
"description": "The bundle identifier to use in the application helper's plist.",
"type": ["null", "string"]
},
"icon": {
"default": "build/icon.icns",
"description": "The path to application icon.",
"type": ["null", "string"]
},
"identity": {
"description": "The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\nMAS installer identity is specified in the [mas](/configuration/mas).",
"type": ["null", "string"]
},
"minimumSystemVersion": {
"description": "The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.",
"type": ["null", "string"]
},
"protocols": {
"anyOf": [
{
"$ref": "#/definitions/Protocol"
},
{
"items": {
"$ref": "#/definitions/Protocol"
},
"type": "array"
}
],
"description": "The URL protocol schemes."
},
"provisioningProfile": {
"description": "The path to the provisioning profile to use when signing, absolute or relative to the app root.",
"type": ["null", "string"]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"releaseInfo": {
"$ref": "#/definitions/ReleaseInfo",
"description": "The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"
},
"requirements": {
"description": "Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.",
"type": ["null", "string"]
},
"target": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"enum": [
"7z",
"default",
"dir",
"dmg",
"mas",
"mas-dev",
"pkg",
"tar.bz2",
"tar.gz",
"tar.lz",
"tar.xz",
"zip"
],
"type": "string"
}
]
},
"type": "array"
},
{
"enum": [
"7z",
"default",
"dir",
"dmg",
"mas",
"mas-dev",
"pkg",
"tar.bz2",
"tar.gz",
"tar.lz",
"tar.xz",
"zip"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac)."
},
"type": {
"anyOf": [
{
"enum": ["development", "distribution"],
"type": "string"
},
{
"type": "null"
}
],
"default": "distribution",
"description": "Whether to sign app for development or for distribution."
}
},
"title": "MacConfiguration",
"type": "object"
},
"MasConfiguration": {
"additionalProperties": false,
"properties": {
"appId": {
"default": "com.electron.${name}",
"description": "The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.",
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).",
"type": ["null", "string"]
},
"asar": {
"anyOf": [
{
"$ref": "#/definitions/AsarOptions"
},
{
"type": ["null", "boolean"]
}
],
"default": true,
"description": "Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."
},
"asarUnpack": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."
},
"binaries": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Paths of any extra binaries that need to be signed."
},
"bundleShortVersion": {
"description": "The `CFBundleShortVersionString`. Do not use it unless you need to.",
"type": ["null", "string"]
},
"bundleVersion": {
"description": "The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).",
"type": ["null", "string"]
},
"category": {
"description": "The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\n\nFor example, `\"category\": \"public.app-category.developer-tools\"` will set the application category to *Developer Tools*.\n\nValid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["maximum", "normal", "store"],
"type": "string"
},
{
"type": "null"
}
],
"default": "normal",
"description": "The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."
},
"cscInstallerKeyPassword": {
"type": ["null", "string"]
},
"cscInstallerLink": {
"type": ["null", "string"]
},
"cscKeyPassword": {
"type": ["null", "string"]
},
"cscLink": {
"type": ["null", "string"]
},
"darkModeSupport": {
"default": false,
"description": "Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.",
"type": "boolean"
},
"hardenedRuntime": {
"default": false,
"description": "Whether your app has to be signed with hardened runtime.",
"type": "boolean"
},
"detectUpdateChannel": {
"default": true,
"description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
"type": "boolean"
},
"electronLanguages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The electron locales. By default Electron locales used as is."
},
"electronUpdaterCompatibility": {
"description": "The [electron-updater compatibility](/auto-update#compatibility) semver range.",
"type": ["null", "string"]
},
"entitlements": {
"description": "The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).",
"type": ["null", "string"]
},
"entitlementsInherit": {
"description": "The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).",
"type": ["null", "string"]
},
"extendInfo": {
"description": "The extra entries for `Info.plist`."
},
"extraDistFiles": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "Extra files to put in archive. Not applicable for `tar.*`."
},
"extraFiles": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"extraResources": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"fileAssociations": {
"anyOf": [
{
"$ref": "#/definitions/FileAssociation"
},
{
"items": {
"$ref": "#/definitions/FileAssociation"
},
"type": "array"
}
],
"description": "The file associations."
},
"files": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"forceCodeSigning": {
"description": "Whether to fail if app will be not code signed.",
"type": "boolean"
},
"generateUpdatesFilesForAllChannels": {
"default": false,
"description": "Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).",
"type": "boolean"
},
"helperBundleId": {
"default": "${appBundleIdentifier}.helper",
"description": "The bundle identifier to use in the application helper's plist.",
"type": ["null", "string"]
},
"icon": {
"default": "build/icon.icns",
"description": "The path to application icon.",
"type": ["null", "string"]
},
"identity": {
"description": "The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\nMAS installer identity is specified in the [mas](/configuration/mas).",
"type": ["null", "string"]
},
"minimumSystemVersion": {
"description": "The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.",
"type": ["null", "string"]
},
"protocols": {
"anyOf": [
{
"$ref": "#/definitions/Protocol"
},
{
"items": {
"$ref": "#/definitions/Protocol"
},
"type": "array"
}
],
"description": "The URL protocol schemes."
},
"provisioningProfile": {
"description": "The path to the provisioning profile to use when signing, absolute or relative to the app root.",
"type": ["null", "string"]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"releaseInfo": {
"$ref": "#/definitions/ReleaseInfo",
"description": "The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"
},
"requirements": {
"description": "Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.",
"type": ["null", "string"]
},
"target": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"enum": [
"7z",
"default",
"dir",
"dmg",
"mas",
"mas-dev",
"pkg",
"tar.bz2",
"tar.gz",
"tar.lz",
"tar.xz",
"zip"
],
"type": "string"
}
]
},
"type": "array"
},
{
"enum": [
"7z",
"default",
"dir",
"dmg",
"mas",
"mas-dev",
"pkg",
"tar.bz2",
"tar.gz",
"tar.lz",
"tar.xz",
"zip"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac)."
},
"type": {
"anyOf": [
{
"enum": ["development", "distribution"],
"type": "string"
},
{
"type": "null"
}
],
"default": "distribution",
"description": "Whether to sign app for development or for distribution."
}
},
"title": "MasConfiguration",
"type": "object"
},
"MetadataDirectories": {
"additionalProperties": false,
"properties": {
"app": {
"description": "The application directory (containing the application package.json), defaults to `app`, `www` or working directory.",
"type": ["null", "string"]
},
"buildResources": {
"default": "build",
"description": "The path to build resources.\n\nPlease note — build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `\"files\": [\"**\\/*\", \"build/icon.*\"]`",
"type": ["null", "string"]
},
"output": {
"default": "dist",
"description": "The output directory. [File macros](/file-patterns#file-macros) are supported.",
"type": ["null", "string"]
}
},
"title": "MetadataDirectories",
"type": "object"
},
"MsiOptions": {
"additionalProperties": false,
"properties": {
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"createDesktopShortcut": {
"default": true,
"description": "Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).",
"enum": ["always", false, true]
},
"createStartMenuShortcut": {
"default": true,
"description": "Whether to create start menu shortcut.",
"type": "boolean"
},
"menuCategory": {
"default": false,
"description": "Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.",
"type": ["string", "boolean"]
},
"oneClick": {
"default": true,
"description": "One-click installation.",
"type": "boolean"
},
"perMachine": {
"default": false,
"description": "Whether to install per all users (per-machine).",
"type": "boolean"
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"runAfterFinish": {
"default": true,
"description": "Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.",
"type": "boolean"
},
"shortcutName": {
"description": "The name that will be used for all shortcuts. Defaults to the application name.",
"type": ["null", "string"]
},
"upgradeCode": {
"description": "The [upgrade code](https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx). Optional, by default generated using app id.",
"type": ["null", "string"]
},
"warningsAsErrors": {
"default": true,
"description": "If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.",
"type": "boolean"
}
},
"title": "MsiOptions",
"type": "object"
},
"NsisOptions": {
"additionalProperties": false,
"properties": {
"allowElevation": {
"default": true,
"description": "*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.",
"type": "boolean"
},
"allowToChangeInstallationDirectory": {
"default": false,
"description": "*assisted installer only.* Whether to allow user to change installation directory.",
"type": "boolean"
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.",
"type": ["null", "string"]
},
"createDesktopShortcut": {
"default": true,
"description": "Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).",
"enum": ["always", false, true]
},
"createStartMenuShortcut": {
"default": true,
"description": "Whether to create start menu shortcut.",
"type": "boolean"
},
"deleteAppDataOnUninstall": {
"default": false,
"description": "*one-click installer only.* Whether to delete app data on uninstall.",
"type": "boolean"
},
"differentialPackage": {
"description": "Defaults to `true` for web installer (`nsis-web`)",
"type": "boolean"
},
"displayLanguageSelector": {
"default": false,
"description": "Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).",
"type": "boolean"
},
"guid": {
"description": "See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).",
"type": ["null", "string"]
},
"include": {
"description": "The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).",
"type": ["null", "string"]
},
"installerHeader": {
"default": "build/installerHeader.bmp",
"description": "*assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.",
"type": ["null", "string"]
},
"installerHeaderIcon": {
"description": "*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerHeaderIcon.ico` or application icon.",
"type": ["null", "string"]
},
"installerIcon": {
"description": "The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerIcon.ico` or application icon.",
"type": ["null", "string"]
},
"installerLanguages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what."
},
"installerSidebar": {
"description": "*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`. Image size 164 × 314 pixels.",
"type": ["null", "string"]
},
"language": {
"description": "[LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).",
"type": ["null", "string"]
},
"license": {
"description": "The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\"_blank\"` for links).\n\nMultiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.\nIf OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).\n\nAppropriate license file will be selected by user OS language.",
"type": ["null", "string"]
},
"menuCategory": {
"default": false,
"description": "Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.",
"type": ["string", "boolean"]
},
"multiLanguageInstaller": {
"description": "Whether to create multi-language installer. Defaults to `unicode` option value.",
"type": "boolean"
},
"oneClick": {
"default": true,
"description": "Whether to create one-click installer or assisted.",
"type": "boolean"
},
"packElevateHelper": {
"default": true,
"description": "Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.",
"type": "boolean"
},
"perMachine": {
"default": false,
"description": "Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).\n\nIf `oneClick` is `true` (default): Whether to install per all users (per-machine).\n\nIf `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.\n\nIf `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.",
"type": "boolean"
},
"preCompressedFileExtensions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"default": [
".avi",
".mov",
".m4v",
".mp4",
".m4p",
".qt",
".mkv",
".webm",
".vmdk"
],
"description": "The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files."
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"runAfterFinish": {
"default": true,
"description": "Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.",
"type": "boolean"
},
"script": {
"description": "The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).",
"type": ["null", "string"]
},
"shortcutName": {
"description": "The name that will be used for all shortcuts. Defaults to the application name.",
"type": ["null", "string"]
},
"unicode": {
"default": true,
"description": "Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).",
"type": "boolean"
},
"uninstallDisplayName": {
"default": "${productName} ${version}",
"description": "The uninstaller display name in the control panel.",
"type": "string"
},
"uninstallerIcon": {
"description": "The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/uninstallerIcon.ico` or application icon.",
"type": ["null", "string"]
},
"uninstallerSidebar": {
"description": "*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`",
"type": ["null", "string"]
},
"useZip": {
"default": false,
"type": "boolean"
},
"warningsAsErrors": {
"default": true,
"description": "If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.",
"type": "boolean"
}
},
"title": "NsisOptions",
"type": "object"
},
"NsisWebOptions": {
"additionalProperties": false,
"description": "Web Installer options.",
"properties": {
"allowElevation": {
"default": true,
"description": "*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.",
"type": "boolean"
},
"allowToChangeInstallationDirectory": {
"default": false,
"description": "*assisted installer only.* Whether to allow user to change installation directory.",
"type": "boolean"
},
"appPackageUrl": {
"description": "The application package download URL. Optional — by default computed using publish configuration.\n\nURL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package).\nPlease note — it is [full URL](https://github.com/electron-userland/electron-builder/issues/1810#issuecomment-317650878).\n\nCustom `X-Arch` http header is set to `32` or `64`.",
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Web Setup ${version}.${ext}`.",
"type": ["null", "string"]
},
"createDesktopShortcut": {
"default": true,
"description": "Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).",
"enum": ["always", false, true]
},
"createStartMenuShortcut": {
"default": true,
"description": "Whether to create start menu shortcut.",
"type": "boolean"
},
"deleteAppDataOnUninstall": {
"default": false,
"description": "*one-click installer only.* Whether to delete app data on uninstall.",
"type": "boolean"
},
"differentialPackage": {
"description": "Defaults to `true` for web installer (`nsis-web`)",
"type": "boolean"
},
"displayLanguageSelector": {
"default": false,
"description": "Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).",
"type": "boolean"
},
"guid": {
"description": "See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).",
"type": ["null", "string"]
},
"include": {
"description": "The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).",
"type": ["null", "string"]
},
"installerHeader": {
"default": "build/installerHeader.bmp",
"description": "*assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.",
"type": ["null", "string"]
},
"installerHeaderIcon": {
"description": "*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerHeaderIcon.ico` or application icon.",
"type": ["null", "string"]
},
"installerIcon": {
"description": "The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerIcon.ico` or application icon.",
"type": ["null", "string"]
},
"installerLanguages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what."
},
"installerSidebar": {
"description": "*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`. Image size 164 × 314 pixels.",
"type": ["null", "string"]
},
"language": {
"description": "[LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).",
"type": ["null", "string"]
},
"license": {
"description": "The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\"_blank\"` for links).\n\nMultiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.\nIf OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).\n\nAppropriate license file will be selected by user OS language.",
"type": ["null", "string"]
},
"menuCategory": {
"default": false,
"description": "Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.",
"type": ["string", "boolean"]
},
"multiLanguageInstaller": {
"description": "Whether to create multi-language installer. Defaults to `unicode` option value.",
"type": "boolean"
},
"oneClick": {
"default": true,
"description": "Whether to create one-click installer or assisted.",
"type": "boolean"
},
"packElevateHelper": {
"default": true,
"description": "Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.",
"type": "boolean"
},
"perMachine": {
"default": false,
"description": "Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).\n\nIf `oneClick` is `true` (default): Whether to install per all users (per-machine).\n\nIf `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.\n\nIf `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.",
"type": "boolean"
},
"preCompressedFileExtensions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"default": [
".avi",
".mov",
".m4v",
".mp4",
".m4p",
".qt",
".mkv",
".webm",
".vmdk"
],
"description": "The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files."
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"runAfterFinish": {
"default": true,
"description": "Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.",
"type": "boolean"
},
"script": {
"description": "The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).",
"type": ["null", "string"]
},
"shortcutName": {
"description": "The name that will be used for all shortcuts. Defaults to the application name.",
"type": ["null", "string"]
},
"unicode": {
"default": true,
"description": "Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).",
"type": "boolean"
},
"uninstallDisplayName": {
"default": "${productName} ${version}",
"description": "The uninstaller display name in the control panel.",
"type": "string"
},
"uninstallerIcon": {
"description": "The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/uninstallerIcon.ico` or application icon.",
"type": ["null", "string"]
},
"uninstallerSidebar": {
"description": "*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`",
"type": ["null", "string"]
},
"useZip": {
"default": false,
"type": "boolean"
},
"warningsAsErrors": {
"default": true,
"description": "If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.",
"type": "boolean"
}
},
"title": "NsisWebOptions",
"type": "object"
},
"PkgBackgroundOptions": {
"additionalProperties": false,
"description": "Options for the background image in a PKG installer",
"properties": {
"alignment": {
"anyOf": [
{
"enum": [
"bottom",
"bottomleft",
"bottomright",
"center",
"left",
"right",
"top",
"topleft",
"topright"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "center",
"description": "Alignment of the background image.\nOptions are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright"
},
"file": {
"description": "Path to the image to use as an installer background.",
"type": "string"
},
"scaling": {
"anyOf": [
{
"enum": ["none", "proportional", "tofit"],
"type": "string"
},
{
"type": "null"
}
],
"default": "tofit",
"description": "Scaling of the background image.\nOptions are: tofit, none, proportional"
}
},
"title": "PkgBackgroundOptions",
"type": "object"
},
"PkgOptions": {
"additionalProperties": false,
"description": "macOS product archive options.",
"properties": {
"allowAnywhere": {
"default": true,
"description": "Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.\n\nCorresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).",
"type": ["null", "boolean"]
},
"allowCurrentUserHome": {
"default": true,
"description": "Whether can be installed into the current user's home directory.\nA home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.\nIf the product cannot be installed in the user's home directory and be not completely functional from user's home directory.\n\nCorresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).",
"type": ["null", "boolean"]
},
"allowRootDirectory": {
"default": true,
"description": "Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user's home directory.\n\nCorresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).",
"type": ["null", "boolean"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"background": {
"anyOf": [
{
"$ref": "#/definitions/PkgBackgroundOptions"
},
{
"type": "null"
}
],
"description": "Options for the background image for the installer."
},
"conclusion": {
"description": "The path to the conclusion file. This may be used to customize the text on the final \"Summary\" page of the installer.",
"type": ["null", "string"]
},
"hasStrictIdentifier": {
"default": true,
"description": "Require identical bundle identifiers at install path?",
"type": ["null", "boolean"]
},
"identity": {
"description": "The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.",
"type": ["null", "string"]
},
"installLocation": {
"default": "/Applications",
"description": "The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.\nMostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen.",
"type": ["null", "string"]
},
"isRelocatable": {
"default": true,
"description": "Install bundle over previous version if moved by user?",
"type": ["null", "boolean"]
},
"isVersionChecked": {
"default": true,
"description": "Don't install bundle if newer version on disk?",
"type": ["null", "boolean"]
},
"license": {
"description": "The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\"_blank\"` for links).",
"type": ["null", "string"]
},
"overwriteAction": {
"anyOf": [
{
"enum": ["update", "upgrade"],
"type": "string"
},
{
"type": "null"
}
],
"default": "upgrade",
"description": "Specifies how an existing version of the bundle on disk should be handled when the version in\nthe package is installed.\n\nIf you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;\nthis has the effect of deleting old paths that no longer exist in the new version of\nthe bundle.\n\nIf you specify update, the bundle in the package overwrites the version on disk, and any files\nnot contained in the package will be left intact; this is appropriate when you are delivering\nan update-only package.\n\nAnother effect of update is that the package bundle will not be installed at all if there is\nnot already a version on disk; this allows a package to deliver an update for an app that\nthe user might have deleted."
},
"productbuild": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "should be not documented, only to experiment"
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"scripts": {
"default": "build/pkg-scripts",
"description": "The scripts directory, relative to `build` (build resources directory).\nThe scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.\nScripts are required to be executable (`chmod +x file`).",
"type": ["null", "string"]
},
"welcome": {
"description": "The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.",
"type": ["null", "string"]
}
},
"title": "PkgOptions",
"type": "object"
},
"PlugDescriptor": {
"additionalProperties": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "null"
}
]
},
"title": "PlugDescriptor",
"type": "object"
},
"PortableOptions": {
"additionalProperties": false,
"description": "Portable options.",
"properties": {
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"guid": {
"description": "See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).",
"type": ["null", "string"]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"requestExecutionLevel": {
"default": "user",
"description": "The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows.",
"enum": ["admin", "highest", "user"],
"type": "string"
},
"unicode": {
"default": true,
"description": "Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).",
"type": "boolean"
},
"useZip": {
"default": false,
"type": "boolean"
},
"warningsAsErrors": {
"default": true,
"description": "If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.",
"type": "boolean"
},
"unpackDirName": {
"description": "The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.\n\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).",
"type": "string"
}
},
"title": "PortableOptions",
"type": "object"
},
"Protocol": {
"additionalProperties": false,
"description": "URL Protocol Schemes. Protocols to associate the app with. macOS only.\n\nPlease note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).",
"properties": {
"name": {
"description": "The name. e.g. `IRC server URL`.",
"type": "string"
},
"role": {
"default": "Editor",
"description": "*macOS-only* The app's role with respect to the type.",
"enum": ["Editor", "None", "Shell", "Viewer"],
"type": "string"
},
"schemes": {
"description": "The schemes. e.g. `[\"irc\", \"ircs\"]`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": ["name", "schemes"],
"title": "Protocol",
"type": "object"
},
"PublishProvider": {
"enum": ["bintray", "custom", "generic", "github", "s3", "spaces"],
"title": "PublishProvider",
"type": "string"
},
"ReleaseInfo": {
"additionalProperties": false,
"properties": {
"releaseDate": {
"description": "The release date.",
"type": "string"
},
"releaseName": {
"description": "The release name.",
"type": ["null", "string"]
},
"releaseNotes": {
"description": "The release notes.",
"type": ["null", "string"]
},
"releaseNotesFile": {
"description": "The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).",
"type": ["null", "string"]
}
},
"title": "ReleaseInfo",
"type": "object"
},
"S3Options": {
"additionalProperties": false,
"properties": {
"acl": {
"anyOf": [
{
"enum": ["private", "public-read"],
"type": "string"
},
{
"type": "null"
}
],
"default": "public-read",
"description": "The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).\n\nPlease see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128)."
},
"bucket": {
"description": "The bucket name.",
"type": "string"
},
"channel": {
"default": "latest",
"description": "The update channel.",
"type": ["null", "string"]
},
"encryption": {
"anyOf": [
{
"enum": ["AES256", "aws:kms"],
"type": "string"
},
{
"type": "null"
}
],
"description": "Server-side encryption algorithm to use for the object."
},
"endpoint": {
"description": "The endpoint URI to send requests to. The default endpoint is built from the configured region.\nThe endpoint should be a string like `https://{service}.{region}.amazonaws.com`.",
"type": ["null", "string"]
},
"path": {
"default": "/",
"description": "The directory path.",
"type": ["null", "string"]
},
"provider": {
"description": "The provider. Must be `s3`.",
"enum": ["s3"],
"type": "string"
},
"publishAutoUpdate": {
"default": true,
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
"type": "boolean"
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"region": {
"description": "The region. Is determined and set automatically when publishing.",
"type": ["null", "string"]
},
"storageClass": {
"anyOf": [
{
"enum": ["REDUCED_REDUNDANCY", "STANDARD", "STANDARD_IA"],
"type": "string"
},
{
"type": "null"
}
],
"default": "STANDARD",
"description": "The type of storage to use for the object."
},
"updaterCacheDirName": {
"type": ["null", "string"]
}
},
"required": ["bucket", "provider"],
"title": "S3Options",
"type": "object"
},
"SnapOptions": {
"additionalProperties": false,
"properties": {
"after": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.\nDefaults to `[\"desktop-gtk2\"\"]`.\n\nIf list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom parts `foo` in addition to defaults."
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"assumes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "The list of features that must be supported by the core in order for this snap to install."
},
"buildPackages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The list of debian packages needs to be installed for building this snap."
},
"category": {
"description": "The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).",
"type": ["null", "string"]
},
"confinement": {
"anyOf": [
{
"enum": ["classic", "devmode", "strict"],
"type": "string"
},
{
"type": "null"
}
],
"default": "strict",
"description": "The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap."
},
"description": {
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
"type": ["null", "string"]
},
"desktop": {
"description": "The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."
},
"environment": {
"anyOf": [
{},
{
"type": "null"
}
],
"description": "The custom environment. Defaults to `{\"TMPDIR: \"$XDG_RUNTIME_DIR\"}`. If you set custom, it will be merged with default."
},
"grade": {
"anyOf": [
{
"enum": ["devel", "stable"],
"type": "string"
},
{
"type": "null"
}
],
"default": "stable",
"description": "The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the \"stable\" or \"candidate\" channels) or \"stable\" (i.e. a stable release or release candidate, which can be released to all channels)."
},
"hooks": {
"default": "build/snap-hooks",
"description": "The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).",
"type": ["null", "string"]
},
"mimeTypes": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."
},
"plugs": {
"anyOf": [
{
"$ref": "#/definitions/PlugDescriptor"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/PlugDescriptor"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The list of [plugs](https://snapcraft.io/docs/reference/interfaces).\nDefaults to `[\"desktop\", \"desktop-legacy\", \"home\", \"x11\", \"unity7\", \"browser-support\", \"network\", \"gsettings\", \"pulseaudio\", \"opengl\"]`.\n\nIf list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom plug `foo` in addition to defaults.\n\nAdditional attributes can be specified using object instead of just name of plug:\n```\n[\n {\n \"browser-sandbox\": {\n \"interface\": \"browser-support\",\n \"allow-sandbox\": true\n },\n },\n \"another-simple-plug-name\"\n]\n```"
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"stagePackages": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.\nDefaults to `[\"libasound2\", \"libgconf2-4\", \"libnotify4\", \"libnspr4\", \"libnss3\", \"libpcre3\", \"libpulse0\", \"libxss1\", \"libxtst6\"]`.\n\nIf list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom package `foo` in addition to defaults."
},
"summary": {
"description": "The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).",
"type": ["null", "string"]
},
"synopsis": {
"description": "The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).",
"type": ["null", "string"]
},
"useTemplateApp": {
"description": "Whether to use template snap. Defaults to `true` if `stagePackages` not specified.",
"type": "boolean"
}
},
"title": "SnapOptions",
"type": "object"
},
"SpacesOptions": {
"additionalProperties": false,
"description": "[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options.\nAccess key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.",
"properties": {
"acl": {
"anyOf": [
{
"enum": ["private", "public-read"],
"type": "string"
},
{
"type": "null"
}
],
"default": "public-read",
"description": "The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822)."
},
"channel": {
"default": "latest",
"description": "The update channel.",
"type": ["null", "string"]
},
"name": {
"description": "The space name.",
"type": "string"
},
"path": {
"default": "/",
"description": "The directory path.",
"type": ["null", "string"]
},
"provider": {
"description": "The provider. Must be `spaces`.",
"enum": ["spaces"],
"type": "string"
},
"publishAutoUpdate": {
"default": true,
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
"type": "boolean"
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"region": {
"description": "The region (e.g. `nyc3`).",
"type": "string"
},
"updaterCacheDirName": {
"type": ["null", "string"]
}
},
"required": ["name", "provider", "region"],
"title": "SpacesOptions",
"type": "object"
},
"SquirrelWindowsOptions": {
"additionalProperties": false,
"properties": {
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
"type": ["null", "string"]
},
"iconUrl": {
"description": "A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.\n\nPlease note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.\n\nIf you don't plan to build windows installer, you can omit it.\nIf your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.",
"type": ["null", "string"]
},
"loadingGif": {
"description": "The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set)\n(otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).",
"type": ["null", "string"]
},
"msi": {
"description": "Whether to create an MSI installer. Defaults to `false` (MSI is not created).",
"type": "boolean"
},
"name": {
"description": "https://github.com/electron-userland/electron-builder/issues/1743",
"type": "string"
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"remoteReleases": {
"description": "A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.",
"type": ["null", "string", "boolean"]
},
"remoteToken": {
"description": "Authentication token for remote updates",
"type": ["null", "string"]
},
"useAppIdAsId": {
"description": "Use `appId` to identify package instead of `name`.",
"type": "boolean"
}
},
"title": "SquirrelWindowsOptions",
"type": "object"
},
"TargetConfiguration": {
"additionalProperties": false,
"properties": {
"arch": {
"anyOf": [
{
"items": {
"enum": ["arm64", "armv7l", "ia32", "x64"],
"type": "string"
},
"type": "array"
},
{
"enum": ["arm64", "armv7l", "ia32", "x64"],
"type": "string"
}
],
"description": "The arch or list of archs."
},
"target": {
"description": "The target name. e.g. `snap`.",
"type": "string"
}
},
"required": ["target"],
"title": "TargetConfiguration",
"type": "object"
},
"WindowsConfiguration": {
"additionalProperties": false,
"properties": {
"additionalCertificateFile": {
"description": "The path to an additional certificate file you want to add to the signature block.",
"type": ["null", "string"]
},
"appId": {
"default": "com.electron.${name}",
"description": "The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.",
"type": ["null", "string"]
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).",
"type": ["null", "string"]
},
"asar": {
"anyOf": [
{
"$ref": "#/definitions/AsarOptions"
},
{
"type": ["null", "boolean"]
}
],
"default": true,
"description": "Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."
},
"asarUnpack": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."
},
"certificateFile": {
"description": "The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.\nPlease see [Code Signing](/code-signing).",
"type": ["null", "string"]
},
"certificatePassword": {
"description": "The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.\nPlease see [Code Signing](/code-signing).",
"type": ["null", "string"]
},
"certificateSha1": {
"description": "The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).",
"type": ["null", "string"]
},
"certificateSubjectName": {
"description": "The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["maximum", "normal", "store"],
"type": "string"
},
{
"type": "null"
}
],
"default": "normal",
"description": "The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."
},
"cscKeyPassword": {
"type": ["null", "string"]
},
"cscLink": {
"type": ["null", "string"]
},
"detectUpdateChannel": {
"default": true,
"description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
"type": "boolean"
},
"electronUpdaterCompatibility": {
"description": "The [electron-updater compatibility](/auto-update#compatibility) semver range.",
"type": ["null", "string"]
},
"extraFiles": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"extraResources": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"fileAssociations": {
"anyOf": [
{
"$ref": "#/definitions/FileAssociation"
},
{
"items": {
"$ref": "#/definitions/FileAssociation"
},
"type": "array"
}
],
"description": "The file associations."
},
"files": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"forceCodeSigning": {
"description": "Whether to fail if app will be not code signed.",
"type": "boolean"
},
"generateUpdatesFilesForAllChannels": {
"default": false,
"description": "Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).",
"type": "boolean"
},
"icon": {
"default": "build/icon.ico",
"description": "The path to application icon.",
"type": ["null", "string"]
},
"legalTrademarks": {
"description": "The trademarks and registered trademarks.",
"type": ["null", "string"]
},
"protocols": {
"anyOf": [
{
"$ref": "#/definitions/Protocol"
},
{
"items": {
"$ref": "#/definitions/Protocol"
},
"type": "array"
}
],
"description": "The URL protocol schemes."
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"publisherName": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.\nDefaults to common name from your code signing certificate."
},
"releaseInfo": {
"$ref": "#/definitions/ReleaseInfo",
"description": "The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"
},
"requestedExecutionLevel": {
"anyOf": [
{
"enum": ["asInvoker", "highestAvailable", "requireAdministrator"],
"type": "string"
},
{
"type": "null"
}
],
"default": "asInvoker",
"description": "The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed.\nCannot be specified per target, allowed only in the `win`."
},
"rfc3161TimeStampServer": {
"default": "http://timestamp.comodoca.com/rfc3161",
"description": "The URL of the RFC 3161 time stamp server.",
"type": ["null", "string"]
},
"sign": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The custom function (or path to file or module id) to sign Windows executable."
},
"signAndEditExecutable": {
"default": true,
"description": "Whether to sign and add metadata to executable. Advanced option.",
"type": "boolean"
},
"signDlls": {
"default": false,
"description": "Whether to sign DLL files. Advanced option.",
"type": "boolean"
},
"signingHashAlgorithms": {
"anyOf": [
{
"items": {
"enum": ["sha1", "sha256"],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": "['sha1', 'sha256']",
"description": "Array of signing algorithms used. For AppX `sha256` is always used."
},
"target": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"default": "nsis",
"description": "The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\nAppX package can be built only on Windows 10.\n\nTo use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency."
},
"timeStampServer": {
"default": "http://timestamp.verisign.com/scripts/timstamp.dll",
"description": "The URL of the time stamp server.",
"type": ["null", "string"]
},
"verifyUpdateCodeSignature": {
"default": true,
"description": "Whether to verify the signature of an available update before installation.\nThe [publisher name](#publisherName) will be used for the signature verification.",
"type": "boolean"
}
},
"title": "WindowsConfiguration",
"type": "object"
}
},
"description": "Configuration Options",
"properties": {
"$schema": {
"description": "JSON Schema for this document.",
"type": ["null", "string"]
},
"afterAllArtifactBuild": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild)."
},
"afterPack": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign)."
},
"afterSign": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format)."
},
"apk": {
"anyOf": [
{
"$ref": "#/definitions/LinuxTargetSpecificOptions"
},
{
"type": "null"
}
]
},
"appId": {
"default": "com.electron.${name}",
"description": "The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.",
"type": ["null", "string"]
},
"appImage": {
"anyOf": [
{
"$ref": "#/definitions/AppImageOptions"
},
{
"type": "null"
}
],
"description": "AppImage options."
},
"appx": {
"anyOf": [
{
"$ref": "#/definitions/AppXOptions"
},
{
"type": "null"
}
]
},
"artifactBuildCompleted": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be run on artifact build completed."
},
"artifactBuildStarted": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be run on artifact build start."
},
"artifactName": {
"description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).",
"type": ["null", "string"]
},
"asar": {
"anyOf": [
{
"$ref": "#/definitions/AsarOptions"
},
{
"type": ["null", "boolean"]
}
],
"default": true,
"description": "Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."
},
"asarUnpack": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."
},
"beforeBuild": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.\n\nIf provided and `node_modules` are missing, it will not invoke production dependencies check."
},
"buildDependenciesFromSource": {
"default": false,
"description": "Whether to build the application native dependencies from source.",
"type": "boolean"
},
"buildVersion": {
"description": "The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\nIf `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).",
"type": ["null", "string"]
},
"compression": {
"anyOf": [
{
"enum": ["maximum", "normal", "store"],
"type": "string"
},
{
"type": "null"
}
],
"default": "normal",
"description": "The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."
},
"copyright": {
"default": "Copyright © year ${author}",
"description": "The human-readable copyright line for the app.",
"type": ["null", "string"]
},
"cscKeyPassword": {
"type": ["null", "string"]
},
"cscLink": {
"type": ["null", "string"]
},
"deb": {
"anyOf": [
{
"$ref": "#/definitions/DebOptions"
},
{
"type": "null"
}
],
"description": "Debian package options."
},
"detectUpdateChannel": {
"default": true,
"description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
"type": "boolean"
},
"directories": {
"anyOf": [
{
"$ref": "#/definitions/MetadataDirectories"
},
{
"type": "null"
}
]
},
"dmg": {
"anyOf": [
{
"$ref": "#/definitions/DmgOptions"
},
{
"type": "null"
}
],
"description": "macOS DMG options."
},
"electronCompile": {
"description": "Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.",
"type": "boolean"
},
"electronDist": {
"description": "The path to custom Electron build (e.g. `~/electron/out/R`).",
"type": "string"
},
"electronDownload": {
"$ref": "#/definitions/ElectronDownloadOptions",
"description": "The [electron-download](https://github.com/electron-userland/electron-download#usage) options."
},
"electronUpdaterCompatibility": {
"description": "The [electron-updater compatibility](/auto-update#compatibility) semver range.",
"type": ["null", "string"]
},
"electronVersion": {
"description": "The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.",
"type": ["null", "string"]
},
"extends": {
"description": "The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported.\n\nIf `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.",
"type": ["null", "string"]
},
"extraFiles": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"extraMetadata": {
"description": "Inject properties to `package.json`."
},
"extraResources": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"fileAssociations": {
"anyOf": [
{
"$ref": "#/definitions/FileAssociation"
},
{
"items": {
"$ref": "#/definitions/FileAssociation"
},
"type": "array"
}
],
"description": "The file associations."
},
"files": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/FileSet"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"forceCodeSigning": {
"description": "Whether to fail if app will be not code signed.",
"type": "boolean"
},
"framework": {
"description": "The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.",
"type": ["null", "string"]
},
"freebsd": {
"anyOf": [
{
"$ref": "#/definitions/LinuxTargetSpecificOptions"
},
{
"type": "null"
}
]
},
"generateUpdatesFilesForAllChannels": {
"default": false,
"description": "Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).",
"type": "boolean"
},
"icon": {
"type": ["null", "string"]
},
"includePdb": {
"default": false,
"description": "Whether to include PDB files.",
"type": "boolean"
},
"launchUiVersion": {
"description": "*libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.",
"type": ["null", "string", "boolean"]
},
"linux": {
"anyOf": [
{
"$ref": "#/definitions/LinuxConfiguration"
},
{
"type": "null"
}
],
"description": "Options related to how build Linux targets."
},
"mac": {
"anyOf": [
{
"$ref": "#/definitions/MacConfiguration"
},
{
"type": "null"
}
],
"description": "Options related to how build macOS targets."
},
"mas": {
"anyOf": [
{
"$ref": "#/definitions/MasConfiguration"
},
{
"type": "null"
}
],
"description": "MAS (Mac Application Store) options."
},
"msi": {
"anyOf": [
{
"$ref": "#/definitions/MsiOptions"
},
{
"type": "null"
}
]
},
"muonVersion": {
"description": "The version of muon you are packaging for.",
"type": ["null", "string"]
},
"nodeGypRebuild": {
"default": false,
"description": "Whether to execute `node-gyp rebuild` before starting to package the app.\n\nDon't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.",
"type": "boolean"
},
"nodeVersion": {
"description": "*libui-based frameworks only* The version of NodeJS you are packaging for.\nYou can set it to `current` to set the Node.js version that you use to run.",
"type": ["null", "string"]
},
"npmArgs": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": ["null", "string"]
}
],
"description": "Additional command line arguments to use when installing app native deps."
},
"npmRebuild": {
"default": true,
"description": "Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.",
"type": "boolean"
},
"npmSkipBuildFromSource": {
"type": "boolean"
},
"nsis": {
"anyOf": [
{
"$ref": "#/definitions/NsisOptions"
},
{
"type": "null"
}
]
},
"nsisWeb": {
"anyOf": [
{
"$ref": "#/definitions/NsisWebOptions"
},
{
"type": "null"
}
]
},
"onNodeModuleFile": {
"anyOf": [
{
"typeof": "function"
},
{
"type": ["null", "string"]
}
],
"description": "The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file."
},
"p5p": {
"anyOf": [
{
"$ref": "#/definitions/LinuxTargetSpecificOptions"
},
{
"type": "null"
}
]
},
"pacman": {
"anyOf": [
{
"$ref": "#/definitions/LinuxTargetSpecificOptions"
},
{
"type": "null"
}
]
},
"pkg": {
"anyOf": [
{
"$ref": "#/definitions/PkgOptions"
},
{
"type": "null"
}
],
"description": "macOS PKG options."
},
"portable": {
"anyOf": [
{
"$ref": "#/definitions/PortableOptions"
},
{
"type": "null"
}
]
},
"productName": {
"description": "As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).",
"type": ["null", "string"]
},
"protocols": {
"anyOf": [
{
"$ref": "#/definitions/Protocol"
},
{
"items": {
"$ref": "#/definitions/Protocol"
},
"type": "array"
}
],
"description": "The URL protocol schemes."
},
"protonNodeVersion": {
"type": ["null", "string"]
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/GithubOptions"
},
{
"$ref": "#/definitions/S3Options"
},
{
"$ref": "#/definitions/SpacesOptions"
},
{
"$ref": "#/definitions/GenericServerOptions"
},
{
"$ref": "#/definitions/BintrayOptions"
},
{
"$ref": "#/definitions/CustomPublishOptions"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"readonly": {
"default": false,
"description": "Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).",
"type": "boolean"
},
"releaseInfo": {
"$ref": "#/definitions/ReleaseInfo",
"description": "The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"
},
"remoteBuild": {
"default": true,
"description": "Whether to build using Electron Build Service if target not supported on current OS.",
"type": "boolean"
},
"removePackageScripts": {
"default": true,
"description": "Whether to remove `scripts` field from `package.json` files.",
"type": "boolean"
},
"rpm": {
"anyOf": [
{
"$ref": "#/definitions/LinuxTargetSpecificOptions"
},
{
"type": "null"
}
]
},
"snap": {
"anyOf": [
{
"$ref": "#/definitions/SnapOptions"
},
{
"type": "null"
}
],
"description": "Snap options."
},
"squirrelWindows": {
"anyOf": [
{
"$ref": "#/definitions/SquirrelWindowsOptions"
},
{
"type": "null"
}
]
},
"target": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"items": {
"anyOf": [
{
"$ref": "#/definitions/TargetConfiguration"
},
{
"type": "string"
}
]
},
"type": "array"
},
{
"type": ["null", "string"]
}
]
},
"win": {
"anyOf": [
{
"$ref": "#/definitions/WindowsConfiguration"
},
{
"type": "null"
}
],
"description": "Options related to how build Windows targets."
}
},
"type": "object"
}
|
grunt-cssmin-task.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": {
"allOf": [
{
"$ref": "https://json.schemastore.org/grunt-task#/additionalProperties"
},
{
"type": "object",
"properties": {
"options": {
"$ref": "#/definitions/options"
}
}
}
]
},
"definitions": {
"options": {
"description": "Set the options for cssmin",
"type": "object",
"properties": {
"banner": {
"description": "Prefix the compressed source with the given banner, with a linebreak in between.",
"type": ["null", "string"],
"default": null
},
"keepSpecialComments": {
"description": "To keep or remove special comments, exposing the underlying option from 'clean-css'.",
"type": ["number", "string"],
"enum": ["*", 1, 2],
"default": "*"
},
"report": {
"description": "Either report only minification result or report minification and gzip results. This is useful to see exactly how well clean-css is performing but using 'gzip' will make the task take 5-10x longer to complete.",
"type": "string",
"enum": ["min", "gzip"],
"default": "min"
}
}
}
},
"id": "https://json.schemastore.org/grunt-cssmin-task.json",
"properties": {
"options": {
"$ref": "#/definitions/options"
}
},
"title": "JSON schema for the Grunt cssmin task",
"type": "object"
}
|
grunt-jshint-task.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": {
"anyOf": [
{
"$ref": "https://json.schemastore.org/grunt-task#/definitions/fileFormat"
},
{
"$ref": "https://json.schemastore.org/grunt-task#/definitions/dynamic"
},
{
"type": "object",
"properties": {
"options": {
"$ref": "#/definitions/options"
}
}
}
]
},
"definitions": {
"options": {
"description": "Set the options for JSHint",
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"jshintrc": {
"description": "Either a boolean value or a string containing the file name of the jshintrc file.",
"type": ["boolean", "string"],
"enum": [true]
}
}
},
{
"$ref": "https://json.schemastore.org/jshintrc#"
}
]
}
},
"id": "https://json.schemastore.org/grunt-jshint-task.json",
"properties": {
"options": {
"$ref": "#/definitions/options"
}
},
"title": "JSON schema for the Grunt JSHint task",
"type": "object"
}
|
cargo-make.json | {
"$id": "https://github.com/sagiegurari/cargo-make",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"semver": {
"title": "Semantic Version",
"type": "string",
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"extend": {
"title": "External Makefile",
"description": "A potentially optional external makefile to extend",
"type": "object",
"x-taplo": {
"initKeys": ["optional"]
},
"required": ["path"],
"additionalProperties": false,
"properties": {
"path": {
"title": "File Path",
"description": "The path of the external makefile, relative to this file",
"type": "string",
"default": "path/to/Makefile.toml"
},
"optional": {
"description": "If true, the external makefile is optional and does not need to exist",
"type": "boolean",
"default": true
}
}
},
"script": {
"title": "Script",
"oneOf": [
{
"title": "Script Line",
"type": "string"
},
{
"title": "Script Lines",
"type": "array",
"items": {
"type": "string"
}
},
{
"title": "Script File",
"type": "object",
"examples": [
{
"file": "path/to/script"
},
{
"file": "path/to/script",
"absolute_path": true
}
],
"required": ["file"],
"additionalProperties": false,
"properties": {
"file": {
"title": "File Path",
"description": "Scipt file name",
"type": "string",
"default": "path/to/script"
},
"absolute_path": {
"description": "If true, the `file` value is an absolute path",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Split Script",
"description": "Script content split to parts to enable a more fine tuned extension capability",
"type": "object",
"x-taplo": {
"initKeys": ["pre", "main", "post"]
},
"additionalProperties": false,
"properties": {
"pre": {
"title": "Pre-Main Script",
"description": "Pre-main script section",
"type": "string"
},
"main": {
"title": "Main Script",
"description": "Main script section",
"type": "string"
},
"post": {
"title": "Post-Main Script",
"description": "Post-main script section",
"type": "string"
}
}
}
]
},
"env_files": {
"title": "List of Env Files",
"description": "Load environment files",
"type": "array",
"default": [],
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-env-file"
}
},
"items": {
"$ref": "#/definitions/envfile"
},
"uniqueItems": true
},
"envfile": {
"title": "Env File",
"description": "File containing environment variables and their values",
"examples": [
"path/to/env.env",
{
"path": "path/to/env.env",
"profile": "development"
}
],
"oneOf": [
{
"title": "File Path",
"description": "The path to the env file",
"type": "string",
"default": "path/to/env.env"
},
{
"description": "The env file path and attributes",
"type": "object",
"x-taplo": {
"initKeys": ["profile"]
},
"required": ["path"],
"additionalProperties": false,
"properties": {
"path": {
"title": "File Path",
"description": "The path to the env file",
"type": "string",
"default": "path/to/env.env"
},
"base_path": {
"title": "Directory Path",
"description": "The path base directory (relative paths are from this base path)",
"type": "string",
"default": "path/to/dir"
},
"profile": {
"title": "Profile",
"description": "The profile name this file is relevant to",
"type": "string",
"default": "development",
"examples": ["development", "production"]
}
}
}
]
},
"env": {
"title": "Env Vars",
"description": "Setup environment variables",
"type": "object",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-env-config"
}
},
"additionalProperties": {
"$ref": "#/definitions/env_value"
}
},
"env_value": {
"title": "Env Value",
"description": "An environment variable value",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-env"
}
},
"anyOf": [
{
"title": "Boolean",
"type": "boolean"
},
{
"title": "Integer",
"type": "integer"
},
{
"title": "String",
"type": "string"
},
{
"title": "Separator List",
"description": "An array which will be joined with the `;` separator ",
"type": "array",
"items": {
"type": "string"
}
},
{
"$ref": "#/definitions/env_value_unset"
},
{
"$ref": "#/definitions/env_value_script"
},
{
"$ref": "#/definitions/env_value_decode"
},
{
"$ref": "#/definitions/env_value_conditioned"
},
{
"$ref": "#/definitions/env_value_path_glob"
},
{
"title": "Profile Env Vars",
"description": "Profile dependent environment variables",
"$ref": "#/definitions/env"
}
]
},
"env_value_unset": {
"title": "Unset",
"description": "Unsets environment variable",
"type": "object",
"required": ["unset"],
"additionalProperties": false,
"properties": {
"unset": {
"description": "If true, the env variable will be unset, else ignored",
"default": true,
"type": "boolean"
}
}
},
"env_value_script": {
"title": "Env Value Script",
"description": "Provide environment variable via script",
"type": "object",
"required": ["script"],
"additionalProperties": false,
"properties": {
"script": {
"title": "Script Lines",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"multi_line": {
"description": "Enable multi-line values",
"default": true,
"type": "boolean"
}
}
},
"env_value_decode": {
"title": "Env Value Mapping",
"description": "Environment variable value provided by decoding other values",
"type": "object",
"x-taplo": {
"initKeys": ["default_value"]
},
"required": ["source", "mapping"],
"additionalProperties": false,
"properties": {
"source": {
"title": "Env Var",
"description": "The source environment variable (can be an env expression)",
"type": "string"
},
"default_value": {
"title": "Env Value",
"description": "The default value in case no decode mapping was found, if not provided it will default to the source value",
"type": "string"
},
"mapping": {
"title": "Value Mapping",
"description": "The decoding mapping from one value to another value",
"type": "object",
"default": {},
"additionalProperties": {
"title": "Env Value",
"type": "string"
}
}
}
},
"env_value_conditioned": {
"title": "Conditional Env Value",
"description": "Environment variable value set if condition is met",
"type": "object",
"x-taplo": {
"initKeys": ["condition"]
},
"required": ["value"],
"additionalProperties": false,
"properties": {
"value": {
"title": "Env Value",
"description": "The value to set (can be an env expression)",
"type": "string"
},
"condition": {
"description": "Condition to evaluate to see whether to set the environment value or not",
"$ref": "#/definitions/task_condition"
}
}
},
"env_value_path_glob": {
"title": "Env Value Glob",
"description": "Environment value holding a list of paths based on given glob definitions",
"type": "object",
"required": ["glob"],
"additionalProperties": false,
"properties": {
"glob": {
"title": "Glob Pattern",
"description": "The glob used to fetch all paths",
"type": "string"
},
"include_files": {
"description": "If true, include files in glob",
"default": true,
"type": "boolean"
},
"include_dirs": {
"description": "If true, include directories in glob",
"default": true,
"type": "boolean"
},
"ignore_type": {
"title": "Ignore Source",
"description": "An ignore source that enables respecting ignore files from that source",
"enum": ["git"],
"type": "string",
"default": "git"
}
}
},
"task_condition": {
"title": "Condition",
"description": "Conditions allow you to evaluate at runtime if to run a specific task or not",
"type": "object",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-conditions"
}
},
"additionalProperties": false,
"properties": {
"fail_message": {
"title": "Message",
"description": "Message to display when the condition fails",
"type": "string"
},
"profiles": {
"title": "List of Profiles",
"description": "Profile names to match for the condition",
"type": "array",
"default": [],
"items": {
"title": "Profile",
"description": "Profile name",
"type": "string",
"default": "development"
}
},
"platforms": {
"title": "List of Platforms",
"description": "Platform names to match for the condition",
"type": "array",
"items": {
"title": "Platform",
"description": "Platform name",
"enum": ["linux", "windows", "mac"],
"type": "string"
}
},
"channels": {
"title": "List of Channels",
"description": "Rust channels to match for the condition",
"type": "array",
"items": {
"title": "Channel",
"description": "Rust channel",
"enum": ["stable", "beta", "nightly"],
"type": "string",
"default": "stable"
}
},
"env_set": {
"title": "List of Env Vars",
"description": "List of environment variables which must be defined",
"type": "array",
"items": {
"title": "Env Var",
"description": "Environment variable",
"type": "string"
}
},
"env_not_set": {
"title": "List of Env Vars",
"description": "List of environment variables which must not be defined",
"type": "array",
"items": {
"title": "Env Var",
"description": "Environment variable",
"type": "string"
}
},
"env_true": {
"title": "List of Env Vars",
"description": "List of environment variables which must be defined and must not be set to any of the following (case insensitive): `false`, `no`, `0`, or empty",
"type": "array",
"items": {
"title": "Env Var",
"description": "Environment variable",
"type": "string"
}
},
"env_false": {
"title": "List of Env Vars",
"description": "List of environment variables which must be defined and must be set to any of the following (case insensitive): `false`, `no`, `0`, or empty",
"type": "array",
"items": {
"title": "Env Var",
"description": "Environment variable",
"type": "string"
}
},
"env": {
"title": "Env Vars",
"description": "Map of environment variables that must be defined and equal to the provided values",
"type": "object",
"additionalProperties": {
"title": "Env Value",
"description": "Environment value",
"type": "string"
}
},
"env_contains": {
"title": "Env Vars",
"description": "Map of environment variables that must be defined and contain (case insensitive) the provided values",
"type": "object",
"additionalProperties": {
"title": "Env Value",
"description": "Environment value",
"type": "string"
}
},
"rust_version": {
"title": "Rust Version Criteria",
"description": "A definition of min, max and/or specific rust version",
"type": "object",
"x-taplo": {
"initKeys": ["min"]
},
"additionalProperties": false,
"properties": {
"min": {
"description": "Minimum Rust version",
"$ref": "#/definitions/semver"
},
"max": {
"description": "Maximum Rust version",
"$ref": "#/definitions/semver"
},
"equal": {
"description": "Exact Rust version",
"$ref": "#/definitions/semver"
}
}
},
"files_exist": {
"title": "List of Files",
"description": "List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths",
"type": "array",
"items": {
"title": "File Path",
"description": "File path",
"type": "string"
}
},
"files_not_exist": {
"title": "List of Files",
"description": "List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths",
"type": "array",
"items": {
"title": "File Path",
"description": "File path",
"type": "string"
}
},
"files_modified": {
"title": "Lists input and output globs",
"description": "If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths",
"type": "object",
"additionalProperties": false,
"properties": {
"input": {
"description": "List of input globs",
"type": "array",
"items": {
"description": "glob",
"type": "string"
}
},
"output": {
"description": "List of output globs",
"type": "array",
"items": {
"description": "glob",
"type": "string"
}
}
}
}
}
},
"task": {
"title": "Task",
"description": "A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.",
"type": "object",
"additionalProperties": false,
"properties": {
"clear": {
"description": "If true, it should ignore all data in the base task",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"
}
}
},
"description": {
"title": "Description",
"description": "A description used to document the task",
"type": "string"
},
"category": {
"title": "Category",
"description": "Category name used to document the task",
"type": "string"
},
"disabled": {
"description": "If true, the command/script of this task will not be invoked, but dependencies will be",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-default-tasks"
}
}
},
"private": {
"description": "If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-private-tasks"
}
}
},
"deprecated": {
"description": "If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.",
"default": true,
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-deprecated-tasks"
}
},
"oneOf": [
{
"type": "boolean"
},
{
"title": "Deprecation Message",
"type": "string"
}
]
},
"extend": {
"title": "Task Name",
"description": "Extends the specified task as a base task",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-extend-attribute"
}
}
},
"workspace": {
"description": "Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)",
"default": false,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-disabling-workspace-support"
}
}
},
"watch": {
"description": "Watch for file changes and invoke the task operation",
"default": true,
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-watch"
}
},
"oneOf": [
{
"type": "boolean"
},
{
"title": "Watch Options",
"type": "object",
"x-taplo": {
"initKeys": ["watch"]
},
"additionalProperties": false,
"properties": {
"version": {
"description": "Version of cargo-watch to install if it's not already installed",
"$ref": "#/definitions/semver"
},
"postpone": {
"description": "Postpone first run until a file changes",
"default": true,
"type": "boolean"
},
"ignore_pattern": {
"title": "Glob Pattern",
"description": "Ignore a glob/gitignore-style pattern while watching",
"type": "string"
},
"no_git_ignore": {
"description": "Do not use .gitignore files while watching",
"default": true,
"type": "boolean"
},
"watch": {
"title": "List of Paths",
"description": "List of files and folders to watch",
"type": "array",
"items": {
"title": "Path",
"description": "File or folder to watch",
"type": "string"
}
}
}
}
]
},
"condition": {
"description": "If provided all condition values must be met in order for the task to be invoked (will not stop dependencies)",
"$ref": "#/definitions/task_condition"
},
"condition_script": {
"title": "Script",
"description": "If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be",
"type": "array",
"items": {
"type": "string"
},
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-conditions-script"
}
}
},
"ignore_errors": {
"description": "If true, any error while executing the task will be printed but will not break the build",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-ignoring-errors"
}
}
},
"force": {
"description": "DEPRECATED, replaced with `ignore_errors`",
"default": true,
"type": "boolean",
"deprecated": true,
"x-taplo": {
"hidden": true
}
},
"env_files": {
"description": "The env files to setup before running the task commands",
"$ref": "#/definitions/env_files"
},
"env": {
"description": "The env vars to setup before running the task commands",
"$ref": "#/definitions/env"
},
"cwd": {
"title": "Directory Path",
"description": "The working directory for the task to execute its command/script",
"type": "string",
"default": "path/to/dir"
},
"alias": {
"title": "Task Name",
"description": "If defined, task points to another task and all other properties are ignored",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"
}
}
},
"linux_alias": {
"title": "Task Name",
"description": "If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over `alias` on Linux)",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"
}
}
},
"windows_alias": {
"title": "Task Name",
"description": "If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over `alias` on Windows)",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"
}
}
},
"mac_alias": {
"title": "Task Name",
"description": "If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over `alias` on Mac)",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"
}
}
},
"install_crate": {
"description": "Indicates the provided crate needs to be installed (if needed) before running the task",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-installing-crates"
}
},
"oneOf": [
{
"description": "If set to false, will disable crate installation from the base task",
"default": false,
"type": "boolean"
},
{
"title": "Crate Name",
"description": "Name of the crate to install",
"type": "string"
},
{
"title": "Crate Install Options",
"description": "Instructions on how to install a crate",
"type": "object",
"required": ["crate_name", "binary", "test_arg"],
"additionalProperties": false,
"properties": {
"crate_name": {
"title": "Crate Name",
"description": "Name of the crate to install",
"type": "string"
},
"rustup_component_name": {
"title": "Component Name",
"description": "The component to install via rustup",
"type": "string"
},
"binary": {
"title": "File Name",
"description": "The binary file name to be used to test if the crate is already installed",
"type": "string"
},
"test_arg": {
"title": "Args",
"description": "Arguments used to check whether a crate or rustup component is installed.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"min_version": {
"description": "Minimum version of installed crate before it needs to be reinstalled",
"$ref": "#/definitions/semver"
},
"version": {
"description": "Exact version of installed crate",
"$ref": "#/definitions/semver"
},
"install_command": {
"title": "Install Command",
"description": "The alternative cargo install command to install the crate",
"type": "string"
}
}
},
{
"title": "Component Install Options",
"description": "Instructions on how to install a rustup component",
"type": "object",
"required": ["rustup_component_name"],
"additionalProperties": false,
"properties": {
"rustup_component_name": {
"title": "Component Name",
"description": "The component to install via rustup",
"type": "string"
},
"binary": {
"title": "File Name",
"description": "The binary file name to be used to test if the crate is already installed",
"type": "string"
},
"test_arg": {
"title": "Args",
"description": "Arguments used to check whether a crate or rustup component is installed.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
{
"title": "Plugin Install Options",
"description": "Instructions on how to install a cargo plugin",
"type": "object",
"required": ["crate_name", "min_version"],
"additionalProperties": false,
"properties": {
"crate_name": {
"title": "Crate Name",
"description": "Name of the crate to install",
"type": "string"
},
"min_version": {
"description": "Minimum version of installed crate before it needs to be reinstalled",
"$ref": "#/definitions/semver"
}
}
}
]
},
"install_crate_args": {
"title": "Args",
"description": "Additional cargo install args",
"type": "array",
"items": {
"type": "string"
}
},
"install_script": {
"description": "Provided script will be executed before running the task",
"$ref": "#/definitions/script"
},
"command": {
"title": "File Name",
"description": "The command to execute for this task",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplecommand"
}
}
},
"args": {
"title": "Args",
"description": "The args for the executed command",
"type": "array",
"items": {
"type": "string"
},
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplecommand"
}
}
},
"script": {
"description": "If `command` is not defined, but `script` is defined, the provided script will be executed",
"$ref": "#/definitions/script",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplescript"
}
}
},
"script_runner": {
"title": "Script Runner",
"description": "The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.",
"type": "string",
"examples": [
"@rust",
"@duckscript",
"@shell",
"python",
"perl",
"node",
"php",
"powershell"
],
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task"
}
}
},
"script_runner_args": {
"title": "Args",
"description": "The script runner arguments before the script file path",
"type": "string",
"examples": ["-f"],
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplegeneric"
}
}
},
"script_extension": {
"title": "File Extension",
"description": "The file extension to use for the script",
"type": "string",
"examples": ["py", "pl", "js", "php", "ps1"]
},
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplegeneric"
}
},
"run_task": {
"description": "Run a task as a sub-task at the end of executing this task",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
},
"oneOf": [
{
"title": "Task Name",
"description": "Name of the sub-task to execute",
"type": "string"
},
{
"type": "object",
"required": ["name"],
"additionalProperties": false,
"properties": {
"name": {
"title": "Task Name",
"description": "Name(s) of the sub-task to execute",
"oneOf": [
{
"type": "string"
},
{
"title": "List of Task Names",
"type": "array",
"items": {
"title": "Task Name",
"type": "string"
}
}
]
},
"fork": {
"description": "Fork the sub-task into a a new subprocess",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
}
},
"parallel": {
"description": "Run tasks in parallel",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
}
},
"cleanup_task": {
"title": "Task Name",
"description": "A task to run after all specified sub-tasks have completed",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
}
}
}
},
{
"title": "Conditional Tasks",
"description": "Conditional sub-task selector",
"type": "array",
"items": {
"description": "Sub-task routing information",
"type": "object",
"required": ["name"],
"additionalProperties": false,
"properties": {
"name": {
"title": "Task Name",
"description": "Name(s) of the sub-task to execute",
"oneOf": [
{
"type": "string"
},
{
"title": "List of Task Names",
"type": "array",
"items": {
"title": "Task Name",
"type": "string"
}
}
]
},
"fork": {
"description": "Fork the sub-task into a a new subprocess",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
}
},
"parallel": {
"description": "Run tasks in parallel",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
}
},
"cleanup_task": {
"title": "Task Name",
"description": "A task to run after all specified sub-tasks have completed",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-command-script-task-examplesubtask"
}
}
},
"condition": {
"description": "If provided all condition values must be met in order for the task to be invoked",
"$ref": "#/definitions/task_condition"
},
"condition_script": {
"title": "Script",
"description": "If script exit code is not 0, the sub tasks will not be invoked",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
"dependencies": {
"title": "List of Tasks",
"description": "A list of tasks to execute before this task",
"type": "array",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-task-dependencies-alias"
}
},
"items": {
"oneOf": [
{
"title": "Task Name",
"description": "The name of a task in this file",
"type": "string"
},
{
"title": "External Task",
"description": "A task dependency potentially in another file",
"type": "object",
"x-taplo": {
"initKeys": ["path"]
},
"required": ["name"],
"additionalProperties": false,
"properties": {
"name": {
"title": "Task Name",
"description": "The task name to execute",
"type": "string"
},
"path": {
"title": "File Path",
"description": "The path to the makefile the task resides in",
"type": "string",
"default": "path/to/makefile"
}
}
}
]
}
},
"toolchain": {
"title": "Toolchain",
"description": "The rust toolchain used to invoke the command or install the needed crates/components",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-toolchain"
}
}
},
"linux": {
"description": "Override task if runtime OS is Linux (takes precedence over alias)",
"$ref": "#/definitions/task"
},
"windows": {
"description": "Override task if runtime OS is Windows (takes precedence over alias)",
"$ref": "#/definitions/task"
},
"mac": {
"description": "Override task if runtime OS is Mac (takes precedence over alias)",
"$ref": "#/definitions/task"
}
}
}
},
"description": "A schema for cargo-make makefiles",
"properties": {
"extend": {
"title": "Extend External Makefile",
"description": "Extend an external makefile by importing its tasks and properties to this file. Paths are relative to this makefile",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-extending-external-makefile"
}
},
"default": "path/to/Makefile.toml",
"examples": [
"path/to/Makefile.toml",
{
"path": "path/to/Makefile.toml",
"optional": true
},
[
{
"path": "path/to/Makefile.toml",
"optional": true
}
]
],
"oneOf": [
{
"title": "File Path",
"description": "File path to external makefile relative to this file",
"type": "string",
"examples": ["path/to/Makefile.toml"]
},
{
"$ref": "#/definitions/extend"
},
{
"title": "External Makefile List",
"description": "List of external makefiles to extend",
"type": "array",
"items": {
"$ref": "#/definitions/extend"
},
"uniqueItems": true
}
]
},
"config": {
"title": "Config",
"description": "Configuration options for this makefile",
"type": "object",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/api/cli/types/struct.ConfigSection.html"
},
"initKeys": ["min_version"]
},
"additionalProperties": false,
"properties": {
"skip_core_tasks": {
"description": "If true, the default core tasks will not be loaded",
"default": false,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-predefined-flows-disable"
}
}
},
"skip_git_env_info": {
"description": "If true, the Git related environment variables will not be loaded",
"default": false,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://github.com/sagiegurari/cargo-make#performance-tuning"
}
}
},
"skip_rust_env_info": {
"description": "If true, the rust related environment variables will not be loaded",
"default": false,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://github.com/sagiegurari/cargo-make#performance-tuning"
}
}
},
"skip_crate_env_info": {
"description": "If true, the current crate related environment variables will not be loaded",
"default": false,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://github.com/sagiegurari/cargo-make#performance-tuning"
}
}
},
"modify_core_tasks": {
"description": "Options to modify all the core tasks",
"type": "object",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-predefined-flows-modify"
}
},
"examples": [
{
"private": true
},
{
"namespace": "default"
},
{
"private": true,
"namespace": "default"
}
],
"additionalProperties": false,
"properties": {
"private": {
"description": "If true, all core tasks will be set to private (default false)",
"default": true,
"type": "boolean"
},
"namespace": {
"title": "Namespace",
"description": "If set to some value, all core tasks are modified to: `namespace::name`",
"type": "string",
"default": "default"
}
}
},
"init_task": {
"title": "Task Name",
"description": "Init task name which will be invoked at the start of every run",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-init-end-tasks"
}
},
"default": "init"
},
"end_task": {
"title": "Task Name",
"description": "End task name which will be invoked at the end of every run",
"default": "end",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-init-end-tasks"
}
}
},
"on_error_task": {
"title": "Task Name",
"description": "The name of the task to run in case of any error during the invocation of the flow",
"type": "string",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-catching-errors"
}
},
"default": "catch"
},
"legacy_migration_task": {
"title": "Task Name",
"description": "The name of the task which runs legacy migration flows",
"default": "legacy-migration",
"type": "string",
"x-taplo": {
"hidden": true
}
},
"additional_profiles": {
"title": "List of Profiles",
"description": "Additional profile names to load",
"default": [],
"type": "array",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-profiles"
}
},
"examples": [["additional_profile"]],
"items": {
"title": "Profile",
"description": "Additional profile name to load",
"type": "string",
"default": "additional_profile"
},
"uniqueItems": true
},
"min_version": {
"description": "Minimum cargo-make/makers version",
"$ref": "#/definitions/semver",
"default": "0.35.0",
"examples": ["0.35.0", "0.34.0", "0.33.0"],
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-min-version"
}
}
},
"default_to_workspace": {
"description": "The default value for the `workspace` value of tasks in this makefile",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-workspace-disabling-workspace-support"
}
}
},
"reduce_output": {
"description": "Set to true to reduce console output for non CI execution",
"default": true,
"type": "boolean"
},
"time_summary": {
"description": "Set to true to print time summary at the end of the flow",
"default": true,
"type": "boolean"
},
"load_cargo_aliases": {
"description": "Automatically load cargo aliases as cargo-make tasks",
"default": true,
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-cargo-alias-tasks"
}
}
},
"main_project_member": {
"title": "Crate",
"description": "The project information member (used by workspaces)",
"type": "string",
"default": "main-crate"
},
"load_script": {
"description": "Invoked while loading the descriptor file but before loading any extended descriptor",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"
}
},
"$ref": "#/definitions/script"
},
"linux_load_script": {
"description": "Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Linux.",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"
}
},
"$ref": "#/definitions/script"
},
"windows_load_script": {
"description": "Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Windows.",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"
}
},
"$ref": "#/definitions/script"
},
"mac_load_script": {
"description": "Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Mac.",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-load-scripts"
}
},
"$ref": "#/definitions/script"
}
}
},
"env_files": {
"description": "The environment files to setup before running any tasks",
"$ref": "#/definitions/env_files"
},
"env_scripts": {
"title": "List of Env Scripts",
"description": "The environment scripts to execute after environment files and the env block. These scripts can be used to run anything needed before starting up the flow.",
"type": "array",
"x-taplo": {
"links": {
"key": "https://sagiegurari.github.io/cargo-make/#usage-env-file"
}
},
"default": [],
"items": {
"description": "Env script",
"type": "string",
"$ref": "#/definitions/script"
}
},
"env": {
"description": "The environment variables to setup before running any tasks",
"$ref": "#/definitions/env"
},
"tasks": {
"description": "Task definitions",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/task"
}
}
},
"title": "Makefile.toml",
"type": "object",
"x-taplo-info": {
"authors": ["Kathryn Long (https://github.com/starkat99)"],
"version": "0.35.0",
"patterns": ["^(.*(/|\\\\)Makefile\\.toml|Makefile\\.toml)$"]
}
}
|
jreleaser-1.7.0.json | {
"$id": "https://json.schemastore.org/jreleaser-1.7.0.json",
"$ref": "#/definitions/JReleaserModel",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"Active": {
"type": "string",
"enum": [
"ALWAYS",
"NEVER",
"RELEASE",
"PRERELEASE",
"RELEASE_PRERELEASE",
"SNAPSHOT"
]
},
"Algorithm": {
"type": "string",
"enum": [
"MD2",
"MD5",
"RMD160",
"SHA_1",
"SHA_256",
"SHA_384",
"SHA_512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
},
"Announce": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"article": {
"$ref": "#/definitions/ArticleAnnouncer"
},
"bluesky": {
"$ref": "#/definitions/BlueskyAnnouncer"
},
"configuredHttp": {
"$ref": "#/definitions/HttpAnnouncers"
},
"configuredWebhooks": {
"$ref": "#/definitions/WebhooksAnnouncer"
},
"discord": {
"allOf": [
{
"$ref": "#/definitions/DiscordAnnouncer"
},
{
"description": "announce.discord is deprecated since 1.4.0 and will be removed in 2.0.0"
}
]
},
"discourse": {
"$ref": "#/definitions/DiscourseAnnouncer"
},
"discussions": {
"$ref": "#/definitions/DiscussionsAnnouncer"
},
"gitter": {
"allOf": [
{
"$ref": "#/definitions/GitterAnnouncer"
},
{
"description": "announce.gitter is deprecated since 1.4.0 and will be removed in 2.0.0"
}
]
},
"googleChat": {
"allOf": [
{
"$ref": "#/definitions/GoogleChatAnnouncer"
},
{
"description": "announce.googleChat is deprecated since 1.4.0 and will be removed in 2.0.0"
}
]
},
"http": {
"allOf": [
{
"$ref": "#/definitions/HttpAnnouncerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/HttpAnnouncer"
},
"type": ["object", "null"]
}
]
},
"linkedin": {
"$ref": "#/definitions/LinkedinAnnouncer"
},
"mail": {
"allOf": [
{
"$ref": "#/definitions/SmtpAnnouncer"
},
{
"description": "announce.mail is deprecated since 1.4.0 and will be removed in 2.0.0"
}
]
},
"mastodon": {
"$ref": "#/definitions/MastodonAnnouncer"
},
"mattermost": {
"allOf": [
{
"$ref": "#/definitions/MattermostAnnouncer"
},
{
"description": "announce.mattermost is deprecated since 1.4.0 and will be removed in 2.0.0"
}
]
},
"openCollective": {
"$ref": "#/definitions/OpenCollectiveAnnouncer"
},
"sdkman": {
"$ref": "#/definitions/SdkmanAnnouncer"
},
"slack": {
"$ref": "#/definitions/SlackAnnouncer"
},
"smtp": {
"$ref": "#/definitions/SmtpAnnouncer"
},
"teams": {
"allOf": [
{
"$ref": "#/definitions/TeamsAnnouncer"
},
{
"description": "announce.teams is deprecated since 1.4.0 and will be removed in 2.0.0"
}
]
},
"telegram": {
"$ref": "#/definitions/TelegramAnnouncer"
},
"twitter": {
"$ref": "#/definitions/TwitterAnnouncer"
},
"webhooks": {
"allOf": [
{
"$ref": "#/definitions/WebhookAnnouncerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/WebhookAnnouncer"
},
"type": ["object", "null"]
}
]
},
"zulip": {
"$ref": "#/definitions/ZulipAnnouncer"
}
},
"additionalProperties": false
},
"AppImagePackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"componentId": {
"type": "string"
},
"continueOnError": {
"type": "boolean"
},
"developerName": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"icons": {
"type": "array",
"items": {
"$ref": "#/definitions/Icon"
}
},
"repository": {
"$ref": "#/definitions/AppImageRepository"
},
"requiresTerminal": {
"type": "boolean"
},
"screenshots": {
"type": "array",
"items": {
"$ref": "#/definitions/Screenshot"
}
},
"skipReleases": {
"type": "array",
"items": {
"type": "string"
}
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"AppImageRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Append": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"contentTemplate": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"target": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
},
"ApplicationPackage": {
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"appVersion": {
"type": "string"
},
"copyright": {
"type": "string"
},
"fileAssociations": {
"type": "array",
"items": {
"type": "string"
}
},
"licenseFile": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"additionalProperties": false
},
"Apply": {
"type": "string",
"enum": ["NEVER", "ALWAYS", "WARN", "FORCE"]
},
"Architecture": {
"type": "object",
"properties": {
"buildOn": {
"type": "array",
"items": {
"type": "string"
}
},
"ignoreError": {
"type": "boolean"
},
"runOn": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"ArchiveAssembler": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"archiveName": {
"type": "string"
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"attachPlatform": {
"type": "boolean"
},
"distributionType": {
"$ref": "#/definitions/DistributionType"
},
"exported": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fileSets": {
"type": "array",
"items": {
"$ref": "#/definitions/FileSet"
}
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"formats": {
"type": "array",
"items": {
"$ref": "#/definitions/Format-1"
}
},
"options": {
"$ref": "#/definitions/ArchiveOptions"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"ArchiveAssemblerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArchiveAssembler"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/ArchiveAssembler"
}
}
},
"ArchiveOptions": {
"type": "object",
"properties": {
"bigNumberMode": {
"$ref": "#/definitions/TarMode"
},
"longFileMode": {
"$ref": "#/definitions/TarMode"
},
"timestamp": {
"type": "string"
}
},
"additionalProperties": false
},
"ArticleAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"readTimeout": {
"type": "integer"
},
"repository": {
"$ref": "#/definitions/Repository"
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"Artifact": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"path": {
"type": "string"
},
"platform": {
"type": "string"
},
"transform": {
"type": "string"
}
},
"additionalProperties": false
},
"ArtifactOverride": {
"type": "object",
"properties": {
"artifactId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"javadocJar": {
"type": "boolean"
},
"sourceJar": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ArtifactoryMavenDeployer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applyMavenCentralRules": {
"type": "boolean"
},
"artifactOverrides": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactOverride"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"javadocJar": {
"type": "boolean"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"sign": {
"type": "boolean"
},
"sourceJar": {
"type": "boolean"
},
"stagingRepositories": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"username": {
"type": "string"
},
"verifyPom": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ArtifactoryMavenDeployerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArtifactoryMavenDeployer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/ArtifactoryMavenDeployer"
}
}
},
"ArtifactoryRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"fileTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/FileType"
}
},
"path": {
"type": "string"
}
},
"additionalProperties": false
},
"ArtifactoryUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"headers": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactoryRepository"
}
},
"signatures": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"ArtifactoryUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ArtifactoryUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/ArtifactoryUploader"
}
}
},
"AsdfPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"repository": {
"$ref": "#/definitions/AsdfRepository"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
},
"toolCheck": {
"type": "string"
}
},
"additionalProperties": false
},
"AsdfRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Assemble": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"archive": {
"allOf": [
{
"$ref": "#/definitions/ArchiveAssemblerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/ArchiveAssembler"
},
"type": ["object", "null"]
}
]
},
"javaArchive": {
"allOf": [
{
"$ref": "#/definitions/JavaArchiveAssemblerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/JavaArchiveAssembler"
},
"type": ["object", "null"]
}
]
},
"jlink": {
"allOf": [
{
"$ref": "#/definitions/JlinkAssemblerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/JlinkAssembler"
},
"type": ["object", "null"]
}
]
},
"jpackage": {
"allOf": [
{
"$ref": "#/definitions/JpackageAssemblerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/JpackageAssembler"
},
"type": ["object", "null"]
}
]
},
"nativeImage": {
"allOf": [
{
"$ref": "#/definitions/NativeImageAssemblerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/NativeImageAssembler"
},
"type": ["object", "null"]
}
]
}
},
"additionalProperties": false
},
"Asset": {
"type": "object",
"properties": {
"input": {
"type": "string"
},
"output": {
"type": "string"
},
"unpack": {
"$ref": "#/definitions/Unpack"
}
},
"additionalProperties": false
},
"Authorization": {
"type": "string",
"enum": ["NONE", "BASIC", "BEARER"]
},
"AzureMavenDeployer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applyMavenCentralRules": {
"type": "boolean"
},
"artifactOverrides": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactOverride"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"javadocJar": {
"type": "boolean"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"sign": {
"type": "boolean"
},
"sourceJar": {
"type": "boolean"
},
"stagingRepositories": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"username": {
"type": "string"
},
"verifyPom": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AzureMavenDeployerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AzureMavenDeployer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/AzureMavenDeployer"
}
}
},
"BlueskyAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"handle": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"status": {
"type": "string"
},
"statusTemplate": {
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"BrewPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"cask": {
"$ref": "#/definitions/Cask"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/Dependency"
}
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"formulaName": {
"type": "string"
},
"livecheck": {
"type": "array",
"items": {
"type": "string"
}
},
"multiPlatform": {
"type": "boolean"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"tap": {
"$ref": "#/definitions/HomebrewTap"
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"Buildx": {
"type": "object",
"properties": {
"createBuilder": {
"type": "boolean"
},
"createBuilderFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"type": "boolean"
},
"platforms": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Cask": {
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"appcast": {
"type": "string"
},
"displayName": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pkgName": {
"type": "string"
},
"uninstall": {
"type": "array",
"items": {
"$ref": "#/definitions/CaskItem"
}
},
"zap": {
"type": "array",
"items": {
"$ref": "#/definitions/CaskItem"
}
}
},
"additionalProperties": false
},
"CaskItem": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"Catalog": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"sbom": {
"$ref": "#/definitions/Sbom"
},
"slsa": {
"$ref": "#/definitions/SlsaCataloger"
}
},
"additionalProperties": false
},
"Category": {
"type": "object",
"properties": {
"format": {
"type": "string"
},
"key": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"order": {
"type": "integer"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
},
"Changelog": {
"type": "object",
"properties": {
"append": {
"$ref": "#/definitions/Append"
},
"categories": {
"type": "array",
"items": {
"$ref": "#/definitions/Category"
}
},
"categoryTitleFormat": {
"type": "string"
},
"content": {
"type": "string"
},
"contentTemplate": {
"type": "string"
},
"contributors": {
"$ref": "#/definitions/Contributors"
},
"contributorsTitleFormat": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"excludeLabels": {
"type": "array",
"items": {
"type": "string"
}
},
"external": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"format": {
"type": "string"
},
"formatted": {
"$ref": "#/definitions/Active"
},
"hide": {
"$ref": "#/definitions/Hide"
},
"includeLabels": {
"type": "array",
"items": {
"type": "string"
}
},
"labelers": {
"type": "array",
"items": {
"$ref": "#/definitions/Labeler"
}
},
"links": {
"type": "boolean"
},
"preset": {
"type": "string"
},
"replacers": {
"type": "array",
"items": {
"$ref": "#/definitions/Replacer"
}
},
"skipMergeCommits": {
"type": "boolean"
},
"sort": {
"$ref": "#/definitions/Sort"
}
},
"additionalProperties": false
},
"Checksum": {
"type": "object",
"properties": {
"algorithms": {
"type": "array",
"items": {
"$ref": "#/definitions/Algorithm"
}
},
"artifacts": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"individual": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"ChocolateyPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"apiKey": {
"type": "string"
},
"bucket": {
"$ref": "#/definitions/ChocolateyRepository"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"iconUrl": {
"type": "string"
},
"packageName": {
"type": "string"
},
"packageVersion": {
"type": "string"
},
"remoteBuild": {
"type": "boolean"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"type": "string"
},
"templateDirectory": {
"type": "string"
},
"title": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"ChocolateyRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"CodebergReleaser": {
"type": "object",
"properties": {
"apiEndpoint": {
"type": "string"
},
"artifacts": {
"type": "boolean"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"catalogs": {
"type": "boolean"
},
"changelog": {
"$ref": "#/definitions/Changelog"
},
"checksums": {
"type": "boolean"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"commitUrl": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"issueTrackerUrl": {
"type": "string"
},
"issues": {
"$ref": "#/definitions/Issues"
},
"latestReleaseUrl": {
"type": "string"
},
"milestone": {
"$ref": "#/definitions/Milestone"
},
"name": {
"type": "string"
},
"overwrite": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"prerelease": {
"$ref": "#/definitions/Prerelease"
},
"previousTagName": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"releaseName": {
"type": "string"
},
"releaseNotesUrl": {
"type": "string"
},
"repoCloneUrl": {
"type": "string"
},
"repoUrl": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"signatures": {
"type": "boolean"
},
"skipRelease": {
"type": "boolean"
},
"skipTag": {
"type": "boolean"
},
"srcUrl": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"update": {
"$ref": "#/definitions/Update"
},
"uploadAssets": {
"$ref": "#/definitions/Active"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Command-1": {
"type": "string",
"enum": ["MAJOR", "MINOR"]
},
"Command-2": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"defaultKeyring": {
"type": "boolean"
},
"executable": {
"type": "string"
},
"homeDir": {
"type": "string"
},
"keyName": {
"type": "string"
},
"publicKeyring": {
"type": "string"
}
},
"additionalProperties": false
},
"CommandHook": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"cmd": {
"type": "string"
},
"condition": {
"type": "string"
},
"continueOnError": {
"type": "boolean"
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"filter": {
"$ref": "#/definitions/Filter"
},
"platforms": {
"type": "array",
"items": {
"type": "string"
}
},
"verbose": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CommandHooks": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"before": {
"type": "array",
"items": {
"$ref": "#/definitions/CommandHook"
}
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"failure": {
"type": "array",
"items": {
"$ref": "#/definitions/CommandHook"
}
},
"success": {
"type": "array",
"items": {
"$ref": "#/definitions/CommandHook"
}
}
},
"additionalProperties": false
},
"CommitAuthor": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"Contributors": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"format": {
"type": "string"
}
},
"additionalProperties": false
},
"Cosign": {
"type": "object",
"properties": {
"privateKeyFile": {
"type": "string"
},
"publicKeyFile": {
"type": "string"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"CyclonedxSbomCataloger": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"distributions": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"formats": {
"type": "array",
"items": {
"$ref": "#/definitions/Format-2"
}
},
"pack": {
"$ref": "#/definitions/Pack"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"Dependency": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
},
"Deploy": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"maven": {
"$ref": "#/definitions/Maven"
}
},
"additionalProperties": false
},
"DiscordAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"DiscourseAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"apiKey": {
"type": "string"
},
"categoryName": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"host": {
"type": "string"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"title": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"DiscussionsAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"organization": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"team": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
},
"Distribution": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"appImage": {
"$ref": "#/definitions/AppImagePackager"
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"asdf": {
"$ref": "#/definitions/AsdfPackager"
},
"brew": {
"$ref": "#/definitions/BrewPackager"
},
"chocolatey": {
"$ref": "#/definitions/ChocolateyPackager"
},
"docker": {
"$ref": "#/definitions/DockerPackager"
},
"executable": {
"$ref": "#/definitions/Executable"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"flatpak": {
"$ref": "#/definitions/FlatpakPackager"
},
"gofish": {
"$ref": "#/definitions/GofishPackager"
},
"java": {
"$ref": "#/definitions/Java-2"
},
"jbang": {
"$ref": "#/definitions/JbangPackager"
},
"jib": {
"$ref": "#/definitions/JibPackager"
},
"macports": {
"$ref": "#/definitions/MacportsPackager"
},
"name": {
"type": "string"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"scoop": {
"$ref": "#/definitions/ScoopPackager"
},
"sdkman": {
"$ref": "#/definitions/SdkmanPackager"
},
"snap": {
"$ref": "#/definitions/SnapPackager"
},
"spec": {
"$ref": "#/definitions/SpecPackager"
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"$ref": "#/definitions/DistributionType"
},
"winget": {
"$ref": "#/definitions/WingetPackager"
}
},
"additionalProperties": false
},
"DistributionMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Distribution"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/Distribution"
}
}
},
"DistributionType": {
"type": "string",
"enum": [
"BINARY",
"FLAT_BINARY",
"JAVA_BINARY",
"JLINK",
"SINGLE_JAR",
"NATIVE_IMAGE",
"NATIVE_PACKAGE"
]
},
"DockerPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"baseImage": {
"type": "string"
},
"buildArgs": {
"type": "array",
"items": {
"type": "string"
}
},
"buildx": {
"$ref": "#/definitions/Buildx"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"imageNames": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"postCommands": {
"type": "array",
"items": {
"type": "string"
}
},
"preCommands": {
"type": "array",
"items": {
"type": "string"
}
},
"registries": {
"type": "array",
"items": {
"$ref": "#/definitions/Registry-1"
}
},
"repository": {
"$ref": "#/definitions/DockerRepository"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"specs": {
"allOf": [
{
"$ref": "#/definitions/DockerSpecMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/DockerSpec"
},
"type": ["object", "null"]
}
]
},
"templateDirectory": {
"type": "string"
},
"useLocalArtifact": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DockerRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
},
"versionedSubfolders": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DockerSpec": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifact": {
"$ref": "#/definitions/Artifact"
},
"baseImage": {
"type": "string"
},
"buildArgs": {
"type": "array",
"items": {
"type": "string"
}
},
"buildx": {
"$ref": "#/definitions/Buildx"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"imageNames": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"matchers": {
"$ref": "#/definitions/Properties"
},
"name": {
"type": "string"
},
"postCommands": {
"type": "array",
"items": {
"type": "string"
}
},
"preCommands": {
"type": "array",
"items": {
"type": "string"
}
},
"registries": {
"type": "array",
"items": {
"$ref": "#/definitions/Registry-1"
}
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
},
"useLocalArtifact": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DockerSpecMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DockerSpec"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/DockerSpec"
}
}
},
"Download": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"ftp": {
"allOf": [
{
"$ref": "#/definitions/FtpDownloaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/FtpDownloader"
},
"type": ["object", "null"]
}
]
},
"http": {
"allOf": [
{
"$ref": "#/definitions/HttpDownloaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/HttpDownloader"
},
"type": ["object", "null"]
}
]
},
"scp": {
"allOf": [
{
"$ref": "#/definitions/ScpDownloaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/ScpDownloader"
},
"type": ["object", "null"]
}
]
},
"sftp": {
"allOf": [
{
"$ref": "#/definitions/SftpDownloaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/SftpDownloader"
},
"type": ["object", "null"]
}
]
}
},
"additionalProperties": false
},
"Environment": {
"type": "object",
"properties": {
"properties": {
"$ref": "#/definitions/Properties"
},
"variables": {
"type": "string"
}
},
"additionalProperties": false
},
"Executable": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"unixExtension": {
"type": "string"
},
"windowsExtension": {
"type": "string"
}
},
"additionalProperties": false
},
"Extension": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"gav": {
"type": "string"
},
"name": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"$ref": "#/definitions/Provider"
}
}
},
"additionalProperties": false
},
"ExtensionMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Extension"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/Extension"
}
}
},
"FileSet": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"excludes": {
"type": "array",
"items": {
"type": "string"
}
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"failOnMissingInput": {
"type": "boolean"
},
"includes": {
"type": "array",
"items": {
"type": "string"
}
},
"input": {
"type": "string"
},
"output": {
"type": "string"
},
"platform": {
"type": "string"
}
},
"additionalProperties": false
},
"FileType": {
"type": "string",
"enum": [
"ASC",
"BAT",
"CMD",
"DEB",
"DMG",
"EXE",
"JAR",
"MSI",
"NUGET",
"PKG",
"PS1",
"RPM",
"SH",
"SIG",
"TAR",
"TAR_BZ2",
"TAR_GZ",
"TAR_XZ",
"TAR_ZST",
"TBZ2",
"TGZ",
"TXZ",
"ZIP",
"ZST"
]
},
"Files": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"globs": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
}
},
"additionalProperties": false
},
"Filter": {
"type": "object",
"properties": {
"excludes": {
"type": "array",
"items": {
"type": "string"
}
},
"includes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"FlatpakPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"componentId": {
"type": "string"
},
"continueOnError": {
"type": "boolean"
},
"developerName": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"finishArgs": {
"type": "array",
"items": {
"type": "string"
}
},
"icons": {
"type": "array",
"items": {
"$ref": "#/definitions/Icon"
}
},
"repository": {
"$ref": "#/definitions/FlatpakRepository"
},
"runtime": {
"$ref": "#/definitions/Runtime"
},
"runtimeVersion": {
"type": "string"
},
"screenshots": {
"type": "array",
"items": {
"$ref": "#/definitions/Screenshot"
}
},
"sdkExtensions": {
"type": "array",
"items": {
"type": "string"
}
},
"skipReleases": {
"type": "array",
"items": {
"type": "string"
}
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"FlatpakRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Format-1": {
"type": "string",
"enum": [
"ZIP",
"TAR",
"TAR_BZ2",
"TAR_GZ",
"TAR_XZ",
"TAR_ZST",
"TBZ2",
"TGZ",
"TXZ"
]
},
"Format-2": {
"type": "string",
"enum": ["JSON", "XML", "PROTOBUF"]
},
"Format-3": {
"type": "string",
"enum": [
"SYFT_JSON",
"CYCLONEDX_XML",
"CYCLONEDX_JSON",
"GITHUB_JSON",
"SPDX_JSON",
"TABLE",
"TEXT"
]
},
"Format-4": {
"type": "string",
"enum": ["DOCKER", "OCI"]
},
"FtpDownloader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/Asset"
}
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"readTimeout": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"FtpDownloaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FtpDownloader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/FtpDownloader"
}
}
},
"FtpUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"password": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"readTimeout": {
"type": "integer"
},
"signatures": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"FtpUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/FtpUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/FtpUploader"
}
}
},
"GenericGitReleaser": {
"type": "object",
"properties": {
"apiEndpoint": {
"type": "string"
},
"artifacts": {
"type": "boolean"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"catalogs": {
"type": "boolean"
},
"changelog": {
"$ref": "#/definitions/Changelog"
},
"checksums": {
"type": "boolean"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"commitUrl": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"issueTrackerUrl": {
"type": "string"
},
"issues": {
"$ref": "#/definitions/Issues"
},
"latestReleaseUrl": {
"type": "string"
},
"milestone": {
"$ref": "#/definitions/Milestone"
},
"name": {
"type": "string"
},
"overwrite": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"prerelease": {
"$ref": "#/definitions/Prerelease"
},
"previousTagName": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"releaseName": {
"type": "string"
},
"releaseNotesUrl": {
"type": "string"
},
"repoCloneUrl": {
"type": "string"
},
"repoUrl": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"signatures": {
"type": "boolean"
},
"skipRelease": {
"type": "boolean"
},
"skipTag": {
"type": "boolean"
},
"srcUrl": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"update": {
"$ref": "#/definitions/Update"
},
"uploadAssets": {
"$ref": "#/definitions/Active"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"GiteaMavenDeployer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applyMavenCentralRules": {
"type": "boolean"
},
"artifactOverrides": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactOverride"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"javadocJar": {
"type": "boolean"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"sign": {
"type": "boolean"
},
"sourceJar": {
"type": "boolean"
},
"stagingRepositories": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"username": {
"type": "string"
},
"verifyPom": {
"type": "boolean"
}
},
"additionalProperties": false
},
"GiteaMavenDeployerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/GiteaMavenDeployer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/GiteaMavenDeployer"
}
}
},
"GiteaReleaser": {
"type": "object",
"properties": {
"apiEndpoint": {
"type": "string"
},
"artifacts": {
"type": "boolean"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"catalogs": {
"type": "boolean"
},
"changelog": {
"$ref": "#/definitions/Changelog"
},
"checksums": {
"type": "boolean"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"commitUrl": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"issueTrackerUrl": {
"type": "string"
},
"issues": {
"$ref": "#/definitions/Issues"
},
"latestReleaseUrl": {
"type": "string"
},
"milestone": {
"$ref": "#/definitions/Milestone"
},
"name": {
"type": "string"
},
"overwrite": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"prerelease": {
"$ref": "#/definitions/Prerelease"
},
"previousTagName": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"releaseName": {
"type": "string"
},
"releaseNotesUrl": {
"type": "string"
},
"repoCloneUrl": {
"type": "string"
},
"repoUrl": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"signatures": {
"type": "boolean"
},
"skipRelease": {
"type": "boolean"
},
"skipTag": {
"type": "boolean"
},
"srcUrl": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"update": {
"$ref": "#/definitions/Update"
},
"uploadAssets": {
"$ref": "#/definitions/Active"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"GiteaUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"owner": {
"type": "string"
},
"packageName": {
"type": "string"
},
"packageVersion": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"signatures": {
"type": "boolean"
},
"token": {
"type": "string"
}
},
"additionalProperties": false
},
"GiteaUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/GiteaUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/GiteaUploader"
}
}
},
"GithubMavenDeployer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applyMavenCentralRules": {
"type": "boolean"
},
"artifactOverrides": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactOverride"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"javadocJar": {
"type": "boolean"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"repository": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"sourceJar": {
"type": "boolean"
},
"stagingRepositories": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"username": {
"type": "string"
},
"verifyPom": {
"type": "boolean"
}
},
"additionalProperties": false
},
"GithubMavenDeployerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/GithubMavenDeployer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/GithubMavenDeployer"
}
}
},
"GithubReleaser": {
"type": "object",
"properties": {
"apiEndpoint": {
"type": "string"
},
"artifacts": {
"type": "boolean"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"catalogs": {
"type": "boolean"
},
"changelog": {
"$ref": "#/definitions/Changelog"
},
"checksums": {
"type": "boolean"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"commitUrl": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"discussionCategoryName": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"issueTrackerUrl": {
"type": "string"
},
"issues": {
"$ref": "#/definitions/Issues"
},
"latestReleaseUrl": {
"type": "string"
},
"milestone": {
"$ref": "#/definitions/Milestone"
},
"name": {
"type": "string"
},
"overwrite": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"prerelease": {
"$ref": "#/definitions/Prerelease"
},
"previousTagName": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"releaseName": {
"type": "string"
},
"releaseNotes": {
"$ref": "#/definitions/ReleaseNotes"
},
"releaseNotesUrl": {
"type": "string"
},
"repoCloneUrl": {
"type": "string"
},
"repoUrl": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"signatures": {
"type": "boolean"
},
"skipRelease": {
"type": "boolean"
},
"skipTag": {
"type": "boolean"
},
"srcUrl": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"update": {
"$ref": "#/definitions/Update"
},
"uploadAssets": {
"$ref": "#/definitions/Active"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"GitlabMavenDeployer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applyMavenCentralRules": {
"type": "boolean"
},
"artifactOverrides": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactOverride"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"javadocJar": {
"type": "boolean"
},
"password": {
"type": "string"
},
"projectIdentifier": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"sign": {
"type": "boolean"
},
"sourceJar": {
"type": "boolean"
},
"stagingRepositories": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"username": {
"type": "string"
},
"verifyPom": {
"type": "boolean"
}
},
"additionalProperties": false
},
"GitlabMavenDeployerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/GitlabMavenDeployer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/GitlabMavenDeployer"
}
}
},
"GitlabReleaser": {
"type": "object",
"properties": {
"apiEndpoint": {
"type": "string"
},
"artifacts": {
"type": "boolean"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"catalogs": {
"type": "boolean"
},
"changelog": {
"$ref": "#/definitions/Changelog"
},
"checksums": {
"type": "boolean"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"commitUrl": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"issueTrackerUrl": {
"type": "string"
},
"issues": {
"$ref": "#/definitions/Issues"
},
"latestReleaseUrl": {
"type": "string"
},
"milestone": {
"$ref": "#/definitions/Milestone"
},
"name": {
"type": "string"
},
"overwrite": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"prerelease": {
"$ref": "#/definitions/Prerelease"
},
"previousTagName": {
"type": "string"
},
"projectIdentifier": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"releaseName": {
"type": "string"
},
"releaseNotesUrl": {
"type": "string"
},
"repoCloneUrl": {
"type": "string"
},
"repoUrl": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"signatures": {
"type": "boolean"
},
"skipRelease": {
"type": "boolean"
},
"skipTag": {
"type": "boolean"
},
"srcUrl": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"update": {
"$ref": "#/definitions/Update"
},
"uploadAssets": {
"$ref": "#/definitions/Active"
},
"uploadLinks": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"GitlabUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"host": {
"type": "string"
},
"packageName": {
"type": "string"
},
"packageVersion": {
"type": "string"
},
"projectIdentifier": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"signatures": {
"type": "boolean"
},
"token": {
"type": "string"
}
},
"additionalProperties": false
},
"GitlabUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/GitlabUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/GitlabUploader"
}
}
},
"GitterAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"Glob": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"directory": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"pattern": {
"type": "string"
},
"platform": {
"type": "string"
}
},
"additionalProperties": false
},
"GofishPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"repository": {
"$ref": "#/definitions/GofishRepository"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"GofishRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"GoogleChatAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"Hide": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"contributors": {
"type": "array",
"items": {
"type": "string"
}
},
"uncategorized": {
"type": "boolean"
}
},
"additionalProperties": false
},
"HomebrewTap": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Hooks": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"command": {
"$ref": "#/definitions/CommandHooks"
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"script": {
"$ref": "#/definitions/ScriptHooks"
}
},
"additionalProperties": false
},
"HttpAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"bearerKeyword": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"headers": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"method": {
"$ref": "#/definitions/Method"
},
"password": {
"type": "string"
},
"payload": {
"type": "string"
},
"payloadTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"url": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"HttpAnnouncerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/HttpAnnouncer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/HttpAnnouncer"
}
}
},
"HttpAnnouncers": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"http": {
"allOf": [
{
"$ref": "#/definitions/HttpAnnouncerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/HttpAnnouncer"
},
"type": ["object", "null"]
}
]
},
"readTimeout": {
"type": "integer"
}
},
"additionalProperties": false
},
"HttpDownloader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/Asset"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"headers": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"HttpDownloaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/HttpDownloader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/HttpDownloader"
}
}
},
"HttpUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"headers": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"method": {
"$ref": "#/definitions/Method"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"signatures": {
"type": "boolean"
},
"uploadUrl": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"HttpUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/HttpUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/HttpUploader"
}
}
},
"Icon": {
"type": "object",
"properties": {
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"height": {
"type": "integer"
},
"primary": {
"type": "boolean"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
}
},
"additionalProperties": false
},
"Installer": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"modes": {
"type": "array",
"items": {
"$ref": "#/definitions/Mode-1"
}
},
"scope": {
"$ref": "#/definitions/Scope"
},
"type": {
"$ref": "#/definitions/Type-2"
},
"upgradeBehavior": {
"$ref": "#/definitions/UpgradeBehavior"
}
},
"additionalProperties": false
},
"Issues": {
"type": "object",
"properties": {
"applyMilestone": {
"$ref": "#/definitions/Apply"
},
"comment": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"label": {
"$ref": "#/definitions/Label"
}
},
"additionalProperties": false
},
"JReleaserModel": {
"type": "object",
"properties": {
"announce": {
"$ref": "#/definitions/Announce"
},
"assemble": {
"$ref": "#/definitions/Assemble"
},
"catalog": {
"$ref": "#/definitions/Catalog"
},
"checksum": {
"$ref": "#/definitions/Checksum"
},
"deploy": {
"$ref": "#/definitions/Deploy"
},
"distributions": {
"allOf": [
{
"$ref": "#/definitions/DistributionMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/Distribution"
},
"type": ["object", "null"]
}
]
},
"download": {
"$ref": "#/definitions/Download"
},
"environment": {
"$ref": "#/definitions/Environment"
},
"extensions": {
"allOf": [
{
"$ref": "#/definitions/ExtensionMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/Extension"
},
"type": ["object", "null"]
}
]
},
"files": {
"$ref": "#/definitions/Files"
},
"hooks": {
"$ref": "#/definitions/Hooks"
},
"packagers": {
"$ref": "#/definitions/Packagers"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"project": {
"$ref": "#/definitions/Project"
},
"release": {
"$ref": "#/definitions/Release"
},
"signing": {
"$ref": "#/definitions/Signing"
},
"upload": {
"$ref": "#/definitions/Upload"
}
},
"description": "JReleaser 1.7.0",
"additionalProperties": false
},
"Java-1": {
"type": "object",
"properties": {
"mainClass": {
"type": "string"
},
"mainModule": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Java-2": {
"type": "object",
"properties": {
"artifactId": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"groupId": {
"type": "string"
},
"mainClass": {
"type": "string"
},
"mainModule": {
"type": "string"
},
"multiProject": {
"type": "boolean"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"JavaArchive": {
"type": "object",
"properties": {
"libDirectoryName": {
"type": "string"
},
"mainJarName": {
"type": "string"
},
"path": {
"type": "string"
}
},
"additionalProperties": false
},
"JavaArchiveAssembler": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"archiveName": {
"type": "string"
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"executable": {
"$ref": "#/definitions/Executable"
},
"exported": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fileSets": {
"type": "array",
"items": {
"$ref": "#/definitions/FileSet"
}
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"formats": {
"type": "array",
"items": {
"$ref": "#/definitions/Format-1"
}
},
"jars": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"java": {
"$ref": "#/definitions/Java-1"
},
"mainJar": {
"$ref": "#/definitions/Artifact"
},
"options": {
"$ref": "#/definitions/ArchiveOptions"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"JavaArchiveAssemblerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/JavaArchiveAssembler"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/JavaArchiveAssembler"
}
}
},
"JbangPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"alias": {
"type": "string"
},
"catalog": {
"$ref": "#/definitions/JbangRepository"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"JbangRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Jdeps": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"ignoreMissingDeps": {
"type": "boolean"
},
"multiRelease": {
"type": "string"
},
"targets": {
"type": "array",
"items": {
"type": "string"
}
},
"useWildcardInPath": {
"type": "boolean"
}
},
"additionalProperties": false
},
"JibPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"baseImage": {
"type": "string"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"creationTime": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"exposedPorts": {
"type": "array",
"items": {
"type": "string"
}
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"format": {
"$ref": "#/definitions/Format-4"
},
"imageNames": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"registries": {
"type": "array",
"items": {
"$ref": "#/definitions/Registry-2"
}
},
"repository": {
"$ref": "#/definitions/JibRepository"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"specs": {
"allOf": [
{
"$ref": "#/definitions/JibSpecMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/JibSpec"
},
"type": ["object", "null"]
}
]
},
"templateDirectory": {
"type": "string"
},
"user": {
"type": "string"
},
"version": {
"type": "string"
},
"volumes": {
"type": "array",
"items": {
"type": "string"
}
},
"workingDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"JibRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
},
"versionedSubfolders": {
"type": "boolean"
}
},
"additionalProperties": false
},
"JibSpec": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifact": {
"$ref": "#/definitions/Artifact"
},
"baseImage": {
"type": "string"
},
"creationTime": {
"type": "string"
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"exposedPorts": {
"type": "array",
"items": {
"type": "string"
}
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"format": {
"$ref": "#/definitions/Format-4"
},
"imageNames": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"matchers": {
"$ref": "#/definitions/Properties"
},
"name": {
"type": "string"
},
"registries": {
"type": "array",
"items": {
"$ref": "#/definitions/Registry-2"
}
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
},
"user": {
"type": "string"
},
"volumes": {
"type": "array",
"items": {
"type": "string"
}
},
"workingDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"JibSpecMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/JibSpec"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/JibSpec"
}
}
},
"JlinkAssembler": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"additionalModuleNames": {
"type": "array",
"items": {
"type": "string"
}
},
"archiveFormat": {
"$ref": "#/definitions/Format-1"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"copyJars": {
"type": "boolean"
},
"executable": {
"type": "string"
},
"exported": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fileSets": {
"type": "array",
"items": {
"$ref": "#/definitions/FileSet"
}
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"imageName": {
"type": "string"
},
"imageNameTransform": {
"type": "string"
},
"jars": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"java": {
"$ref": "#/definitions/Java-2"
},
"javaArchive": {
"$ref": "#/definitions/JavaArchive"
},
"jdeps": {
"$ref": "#/definitions/Jdeps"
},
"jdk": {
"$ref": "#/definitions/Artifact"
},
"mainJar": {
"$ref": "#/definitions/Artifact"
},
"moduleNames": {
"type": "array",
"items": {
"type": "string"
}
},
"options": {
"$ref": "#/definitions/ArchiveOptions"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"targetJdks": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"JlinkAssemblerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/JlinkAssembler"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/JlinkAssembler"
}
}
},
"JpackageAssembler": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applicationPackage": {
"$ref": "#/definitions/ApplicationPackage"
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"attachPlatform": {
"type": "boolean"
},
"executable": {
"type": "string"
},
"exported": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fileSets": {
"type": "array",
"items": {
"$ref": "#/definitions/FileSet"
}
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"jars": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"java": {
"$ref": "#/definitions/Java-2"
},
"jlink": {
"type": "string"
},
"launcher": {
"$ref": "#/definitions/Launcher"
},
"linux": {
"$ref": "#/definitions/Linux-1"
},
"mainJar": {
"$ref": "#/definitions/Artifact"
},
"osx": {
"$ref": "#/definitions/Osx-1"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"runtimeImages": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"templateDirectory": {
"type": "string"
},
"verbose": {
"type": "boolean"
},
"windows": {
"$ref": "#/definitions/Windows-1"
}
},
"additionalProperties": false
},
"JpackageAssemblerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/JpackageAssembler"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/JpackageAssembler"
}
}
},
"Label": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"Labeler": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"label": {
"type": "string"
},
"order": {
"type": "integer"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
},
"Launcher": {
"type": "object",
"properties": {
"arguments": {
"type": "array",
"items": {
"type": "string"
}
},
"javaOptions": {
"type": "array",
"items": {
"type": "string"
}
},
"launchers": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"LinkedinAnnouncer": {
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"owner": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
},
"Links": {
"type": "object",
"properties": {
"bugTracker": {
"type": "string"
},
"contact": {
"type": "string"
},
"contribute": {
"type": "string"
},
"documentation": {
"type": "string"
},
"donation": {
"type": "string"
},
"faq": {
"type": "string"
},
"help": {
"type": "string"
},
"homepage": {
"type": "string"
},
"license": {
"type": "string"
},
"translate": {
"type": "string"
},
"vcsBrowser": {
"type": "string"
}
},
"additionalProperties": false
},
"Linux-1": {
"type": "object",
"properties": {
"appCategory": {
"type": "string"
},
"appName": {
"type": "string"
},
"appRelease": {
"type": "string"
},
"icon": {
"type": "string"
},
"installDir": {
"type": "string"
},
"jdk": {
"$ref": "#/definitions/Artifact"
},
"license": {
"type": "string"
},
"maintainer": {
"type": "string"
},
"menuGroup": {
"type": "string"
},
"packageDeps": {
"type": "array",
"items": {
"type": "string"
}
},
"packageName": {
"type": "string"
},
"platform": {
"type": "string"
},
"resourceDir": {
"type": "string"
},
"shortcut": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"validTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Linux-2": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"platform": {
"type": "string"
}
},
"additionalProperties": false
},
"MacportsPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"maintainers": {
"type": "array",
"items": {
"type": "string"
}
},
"packageName": {
"type": "string"
},
"repository": {
"$ref": "#/definitions/MacportsRepository"
},
"revision": {
"type": "integer"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"MacportsRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"MastodonAnnouncer": {
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"host": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"status": {
"type": "string"
},
"statusTemplate": {
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"MattermostAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"structuredMessage": {
"type": "boolean"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"Maven": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifactory": {
"allOf": [
{
"$ref": "#/definitions/ArtifactoryMavenDeployerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/ArtifactoryMavenDeployer"
},
"type": ["object", "null"]
}
]
},
"azure": {
"allOf": [
{
"$ref": "#/definitions/AzureMavenDeployerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/AzureMavenDeployer"
},
"type": ["object", "null"]
}
]
},
"gitea": {
"allOf": [
{
"$ref": "#/definitions/GiteaMavenDeployerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/GiteaMavenDeployer"
},
"type": ["object", "null"]
}
]
},
"github": {
"allOf": [
{
"$ref": "#/definitions/GithubMavenDeployerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/GithubMavenDeployer"
},
"type": ["object", "null"]
}
]
},
"gitlab": {
"allOf": [
{
"$ref": "#/definitions/GitlabMavenDeployerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/GitlabMavenDeployer"
},
"type": ["object", "null"]
}
]
},
"nexus2": {
"allOf": [
{
"$ref": "#/definitions/Nexus2MavenDeployerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/Nexus2MavenDeployer"
},
"type": ["object", "null"]
}
]
},
"pomchecker": {
"$ref": "#/definitions/Pomchecker"
}
},
"additionalProperties": false
},
"Method": {
"type": "string",
"enum": ["PUT", "POST"]
},
"Milestone": {
"type": "object",
"properties": {
"close": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"MimeType": {
"type": "string",
"enum": ["TEXT", "HTML"]
},
"Mode-1": {
"type": "string",
"enum": ["INTERACTIVE", "SILENT", "SILENT_WITH_PROGRESS"]
},
"Mode-2": {
"type": "string",
"enum": ["MEMORY", "FILE", "COMMAND", "COSIGN"]
},
"NativeImageAssembler": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"archiveFormat": {
"$ref": "#/definitions/Format-1"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"components": {
"type": "array",
"items": {
"type": "string"
}
},
"executable": {
"type": "string"
},
"exported": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fileSets": {
"type": "array",
"items": {
"$ref": "#/definitions/FileSet"
}
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"graal": {
"$ref": "#/definitions/Artifact"
},
"graalJdks": {
"type": "array",
"items": {
"$ref": "#/definitions/Artifact"
}
},
"imageName": {
"type": "string"
},
"imageNameTransform": {
"type": "string"
},
"jars": {
"type": "array",
"items": {
"$ref": "#/definitions/Glob"
}
},
"java": {
"$ref": "#/definitions/Java-2"
},
"linux": {
"$ref": "#/definitions/Linux-2"
},
"mainJar": {
"$ref": "#/definitions/Artifact"
},
"options": {
"$ref": "#/definitions/ArchiveOptions"
},
"osx": {
"$ref": "#/definitions/Osx-2"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"templateDirectory": {
"type": "string"
},
"upx": {
"$ref": "#/definitions/Upx"
},
"windows": {
"$ref": "#/definitions/Windows-2"
}
},
"additionalProperties": false
},
"NativeImageAssemblerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/NativeImageAssembler"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/NativeImageAssembler"
}
}
},
"Nexus2MavenDeployer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"applyMavenCentralRules": {
"type": "boolean"
},
"artifactOverrides": {
"type": "array",
"items": {
"$ref": "#/definitions/ArtifactOverride"
}
},
"authorization": {
"$ref": "#/definitions/Authorization"
},
"checksums": {
"type": "boolean"
},
"closeRepository": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"javadocJar": {
"type": "boolean"
},
"password": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"releaseRepository": {
"type": "boolean"
},
"sign": {
"type": "boolean"
},
"snapshotUrl": {
"type": "string"
},
"sourceJar": {
"type": "boolean"
},
"stagingRepositories": {
"type": "array",
"items": {
"type": "string"
}
},
"transitionDelay": {
"type": "integer"
},
"transitionMaxRetries": {
"type": "integer"
},
"url": {
"type": "string"
},
"username": {
"type": "string"
},
"verifyPom": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Nexus2MavenDeployerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Nexus2MavenDeployer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/Nexus2MavenDeployer"
}
}
},
"OpenCollectiveAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"host": {
"type": "string"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"token": {
"type": "string"
}
},
"additionalProperties": false
},
"Osx-1": {
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"icon": {
"type": "string"
},
"installDir": {
"type": "string"
},
"jdk": {
"$ref": "#/definitions/Artifact"
},
"packageIdentifier": {
"type": "string"
},
"packageName": {
"type": "string"
},
"packageSigningPrefix": {
"type": "string"
},
"platform": {
"type": "string"
},
"resourceDir": {
"type": "string"
},
"sign": {
"type": "boolean"
},
"signingKeyUsername": {
"type": "string"
},
"signingKeychain": {
"type": "string"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"validTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Osx-2": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"platform": {
"type": "string"
}
},
"additionalProperties": false
},
"Pack": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"Package": {
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"Packagers": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"appImage": {
"$ref": "#/definitions/AppImagePackager"
},
"asdf": {
"$ref": "#/definitions/AsdfPackager"
},
"brew": {
"$ref": "#/definitions/BrewPackager"
},
"chocolatey": {
"$ref": "#/definitions/ChocolateyPackager"
},
"docker": {
"$ref": "#/definitions/DockerPackager"
},
"flatpak": {
"$ref": "#/definitions/FlatpakPackager"
},
"gofish": {
"$ref": "#/definitions/GofishPackager"
},
"jbang": {
"$ref": "#/definitions/JbangPackager"
},
"jib": {
"$ref": "#/definitions/JibPackager"
},
"macports": {
"$ref": "#/definitions/MacportsPackager"
},
"scoop": {
"$ref": "#/definitions/ScoopPackager"
},
"sdkman": {
"$ref": "#/definitions/SdkmanPackager"
},
"snap": {
"$ref": "#/definitions/SnapPackager"
},
"spec": {
"$ref": "#/definitions/SpecPackager"
},
"winget": {
"$ref": "#/definitions/WingetPackager"
}
},
"additionalProperties": false
},
"Platform": {
"type": "object",
"properties": {
"replacements": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
}
},
"additionalProperties": false
},
"Plug": {
"type": "object",
"properties": {
"attributes": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"name": {
"type": "string"
},
"reads": {
"type": "array",
"items": {
"type": "string"
}
},
"writes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Pomchecker": {
"type": "object",
"properties": {
"failOnError": {
"type": "boolean"
},
"failOnWarning": {
"type": "boolean"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"Prerelease": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"pattern": {
"type": "string"
}
},
"additionalProperties": false
},
"Project": {
"type": "object",
"properties": {
"authors": {
"type": "array",
"items": {
"type": "string"
}
},
"copyright": {
"type": "string"
},
"description": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"icons": {
"type": "array",
"items": {
"$ref": "#/definitions/Icon"
}
},
"inceptionYear": {
"type": "string"
},
"java": {
"$ref": "#/definitions/Java-2"
},
"license": {
"type": "string"
},
"links": {
"$ref": "#/definitions/Links"
},
"longDescription": {
"type": "string"
},
"maintainers": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"screenshots": {
"type": "array",
"items": {
"$ref": "#/definitions/Screenshot"
}
},
"snapshot": {
"$ref": "#/definitions/Snapshot"
},
"stereotype": {
"$ref": "#/definitions/Stereotype"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"vendor": {
"type": "string"
},
"version": {
"type": "string"
},
"versionPattern": {
"$ref": "#/definitions/VersionPattern"
}
},
"additionalProperties": false
},
"Properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"Provider": {
"type": "object",
"properties": {
"properties": {
"$ref": "#/definitions/Properties"
},
"type": {
"type": "string"
}
},
"additionalProperties": false
},
"Publisher": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"Registry-1": {
"type": "object",
"properties": {
"externalLogin": {
"type": "boolean"
},
"password": {
"type": "string"
},
"repositoryName": {
"type": "string"
},
"server": {
"type": "string"
},
"serverName": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Registry-2": {
"type": "object",
"properties": {
"fromPassword": {
"type": "string"
},
"fromUsername": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"server": {
"type": "string"
},
"toPassword": {
"type": "string"
},
"toUsername": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Release": {
"type": "object",
"properties": {
"codeberg": {
"$ref": "#/definitions/CodebergReleaser"
},
"generic": {
"$ref": "#/definitions/GenericGitReleaser"
},
"gitea": {
"$ref": "#/definitions/GiteaReleaser"
},
"github": {
"$ref": "#/definitions/GithubReleaser"
},
"gitlab": {
"$ref": "#/definitions/GitlabReleaser"
}
},
"additionalProperties": false
},
"ReleaseNotes": {
"type": "object",
"properties": {
"configurationFile": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Replacer": {
"type": "object",
"properties": {
"replace": {
"type": "string"
},
"search": {
"type": "string"
}
},
"additionalProperties": false
},
"Repository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Runtime": {
"type": "string",
"enum": ["FREEDESKTOP", "GNOME", "KDE", "ELEMENTARY"]
},
"S3Uploader": {
"type": "object",
"properties": {
"accessKeyId": {
"type": "string"
},
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"bucket": {
"type": "string"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"headers": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"path": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"region": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"sessionToken": {
"type": "string"
},
"signatures": {
"type": "boolean"
}
},
"additionalProperties": false
},
"S3UploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/S3Uploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/S3Uploader"
}
}
},
"Sbom": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"cyclonedx": {
"$ref": "#/definitions/CyclonedxSbomCataloger"
},
"syft": {
"$ref": "#/definitions/SyftSbomCataloger"
}
},
"additionalProperties": false
},
"ScoopPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"autoupdateUrl": {
"type": "string"
},
"bucket": {
"$ref": "#/definitions/ScoopRepository"
},
"checkverUrl": {
"type": "string"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"packageName": {
"type": "string"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"ScoopRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Scope": {
"type": "string",
"enum": ["USER", "MACHINE"]
},
"ScpDownloader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/Asset"
}
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fingerprint": {
"type": "string"
},
"host": {
"type": "string"
},
"knownHostsFile": {
"type": "string"
},
"passphrase": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"privateKey": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"ScpDownloaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ScpDownloader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/ScpDownloader"
}
}
},
"ScpUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"fingerprint": {
"type": "string"
},
"host": {
"type": "string"
},
"knownHostsFile": {
"type": "string"
},
"passphrase": {
"type": "string"
},
"password": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"privateKey": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"signatures": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"ScpUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ScpUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/ScpUploader"
}
}
},
"Screenshot": {
"type": "object",
"properties": {
"caption": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"height": {
"type": "integer"
},
"primary": {
"type": "boolean"
},
"type": {
"$ref": "#/definitions/Type-1"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
}
},
"additionalProperties": false
},
"ScriptHook": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"condition": {
"type": "string"
},
"continueOnError": {
"type": "boolean"
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"filter": {
"$ref": "#/definitions/Filter"
},
"platforms": {
"type": "array",
"items": {
"type": "string"
}
},
"run": {
"type": "string"
},
"shell": {
"$ref": "#/definitions/Shell"
},
"verbose": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ScriptHooks": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"before": {
"type": "array",
"items": {
"$ref": "#/definitions/ScriptHook"
}
},
"environment": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"failure": {
"type": "array",
"items": {
"$ref": "#/definitions/ScriptHook"
}
},
"success": {
"type": "array",
"items": {
"$ref": "#/definitions/ScriptHook"
}
}
},
"additionalProperties": false
},
"SdkmanAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"candidate": {
"type": "string"
},
"command": {
"$ref": "#/definitions/Command-1"
},
"connectTimeout": {
"type": "integer"
},
"consumerKey": {
"type": "string"
},
"consumerToken": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"readTimeout": {
"type": "integer"
},
"releaseNotesUrl": {
"type": "string"
}
},
"additionalProperties": false
},
"SdkmanPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"candidate": {
"type": "string"
},
"command": {
"$ref": "#/definitions/Command-1"
},
"connectTimeout": {
"type": "integer"
},
"consumerKey": {
"type": "string"
},
"consumerToken": {
"type": "string"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"readTimeout": {
"type": "integer"
},
"releaseNotesUrl": {
"type": "string"
}
},
"additionalProperties": false
},
"SftpDownloader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/Asset"
}
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"fingerprint": {
"type": "string"
},
"host": {
"type": "string"
},
"knownHostsFile": {
"type": "string"
},
"passphrase": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"privateKey": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"SftpDownloaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/SftpDownloader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/SftpDownloader"
}
}
},
"SftpUploader": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"connectTimeout": {
"type": "integer"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"fingerprint": {
"type": "string"
},
"host": {
"type": "string"
},
"knownHostsFile": {
"type": "string"
},
"passphrase": {
"type": "string"
},
"password": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"privateKey": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"signatures": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"SftpUploaderMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/SftpUploader"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/SftpUploader"
}
}
},
"Shell": {
"type": "string",
"enum": ["BASH", "SH", "CMD", "PWSH", "POWERSHELL"]
},
"Signing": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"armored": {
"type": "boolean"
},
"artifacts": {
"type": "boolean"
},
"catalogs": {
"type": "boolean"
},
"checksums": {
"type": "boolean"
},
"command": {
"$ref": "#/definitions/Command-2"
},
"cosign": {
"$ref": "#/definitions/Cosign"
},
"files": {
"type": "boolean"
},
"mode": {
"$ref": "#/definitions/Mode-2"
},
"passphrase": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"verify": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SlackAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"channel": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"token": {
"type": "string"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"Slot": {
"type": "object",
"properties": {
"attributes": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"name": {
"type": "string"
},
"reads": {
"type": "array",
"items": {
"type": "string"
}
},
"writes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"SlsaCataloger": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifacts": {
"type": "boolean"
},
"attestationName": {
"type": "string"
},
"deployables": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SmtpAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"auth": {
"type": "boolean"
},
"bcc": {
"type": "string"
},
"cc": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"from": {
"type": "string"
},
"host": {
"type": "string"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"mimeType": {
"$ref": "#/definitions/MimeType"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"properties": {
"allOf": [
{
"$ref": "#/definitions/StringProperties"
},
{
"additionalProperties": {
"type": "string"
},
"type": ["object", "null"]
}
]
},
"readTimeout": {
"type": "integer"
},
"subject": {
"type": "string"
},
"to": {
"type": "string"
},
"transport": {
"$ref": "#/definitions/Transport"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"SnapPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"architectures": {
"type": "array",
"items": {
"$ref": "#/definitions/Architecture"
}
},
"base": {
"type": "string"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"confinement": {
"type": "string"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"exportedLogin": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"grade": {
"type": "string"
},
"localPlugs": {
"type": "array",
"items": {
"type": "string"
}
},
"localSlots": {
"type": "array",
"items": {
"type": "string"
}
},
"packageName": {
"type": "string"
},
"plugs": {
"type": "array",
"items": {
"$ref": "#/definitions/Plug"
}
},
"remoteBuild": {
"type": "boolean"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"slots": {
"type": "array",
"items": {
"$ref": "#/definitions/Slot"
}
},
"snap": {
"$ref": "#/definitions/SnapRepository"
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"SnapRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Snapshot": {
"type": "object",
"properties": {
"fullChangelog": {
"type": "boolean"
},
"label": {
"type": "string"
},
"pattern": {
"type": "string"
}
},
"additionalProperties": false
},
"Sort": {
"type": "string",
"enum": ["ASC", "DESC"]
},
"SpecPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"packageName": {
"type": "string"
},
"release": {
"type": "string"
},
"repository": {
"$ref": "#/definitions/SpecRepository"
},
"requires": {
"type": "array",
"items": {
"type": "string"
}
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"SpecRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"Stereotype": {
"type": "string",
"enum": ["NONE", "CLI", "DESKTOP", "WEB", "MOBILE"]
},
"StringProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"SyftSbomCataloger": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"distributions": {
"type": "boolean"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"files": {
"type": "boolean"
},
"formats": {
"type": "array",
"items": {
"$ref": "#/definitions/Format-3"
}
},
"pack": {
"$ref": "#/definitions/Pack"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"TarMode": {
"type": "string",
"enum": ["GNU", "POSIX", "ERROR", "TRUNCATE"]
},
"TeamsAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"TelegramAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"chatId": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"token": {
"type": "string"
}
},
"additionalProperties": false
},
"Transport": {
"type": "string",
"enum": ["SMTP", "SMTPS"]
},
"TwitterAnnouncer": {
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"accessTokenSecret": {
"type": "string"
},
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"consumerKey": {
"type": "string"
},
"consumerSecret": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"readTimeout": {
"type": "integer"
},
"status": {
"type": "string"
},
"statusTemplate": {
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Type-1": {
"type": "string",
"enum": ["SOURCE", "THUMBNAIL"]
},
"Type-2": {
"type": "string",
"enum": [
"MSIX",
"MSI",
"APPX",
"EXE",
"ZIP",
"INNO",
"NULLSOFT",
"WIX",
"BURN",
"PWA"
]
},
"Type-3": {
"type": "string",
"enum": [
"SEMVER",
"CALVER",
"CHRONVER",
"JAVA_RUNTIME",
"JAVA_MODULE",
"CUSTOM"
]
},
"Unpack": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"skipRootEntry": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Update": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"sections": {
"type": "array",
"items": {
"$ref": "#/definitions/UpdateSection"
}
}
},
"additionalProperties": false
},
"UpdateSection": {
"type": "string",
"enum": ["TITLE", "BODY", "ASSETS"]
},
"UpgradeBehavior": {
"type": "string",
"enum": ["INSTALL", "UNINSTALL_PREVIOUS"]
},
"Upload": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"artifactory": {
"allOf": [
{
"$ref": "#/definitions/ArtifactoryUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/ArtifactoryUploader"
},
"type": ["object", "null"]
}
]
},
"ftp": {
"allOf": [
{
"$ref": "#/definitions/FtpUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/FtpUploader"
},
"type": ["object", "null"]
}
]
},
"gitea": {
"allOf": [
{
"$ref": "#/definitions/GiteaUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/GiteaUploader"
},
"type": ["object", "null"]
}
]
},
"gitlab": {
"allOf": [
{
"$ref": "#/definitions/GitlabUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/GitlabUploader"
},
"type": ["object", "null"]
}
]
},
"http": {
"allOf": [
{
"$ref": "#/definitions/HttpUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/HttpUploader"
},
"type": ["object", "null"]
}
]
},
"s3": {
"allOf": [
{
"$ref": "#/definitions/S3UploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/S3Uploader"
},
"type": ["object", "null"]
}
]
},
"scp": {
"allOf": [
{
"$ref": "#/definitions/ScpUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/ScpUploader"
},
"type": ["object", "null"]
}
]
},
"sftp": {
"allOf": [
{
"$ref": "#/definitions/SftpUploaderMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/SftpUploader"
},
"type": ["object", "null"]
}
]
}
},
"additionalProperties": false
},
"Upx": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"VersionPattern": {
"type": "object",
"properties": {
"format": {
"type": "string"
},
"type": {
"$ref": "#/definitions/Type-3"
}
},
"additionalProperties": false
},
"WebhookAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageProperty": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"structuredMessage": {
"type": "boolean"
},
"webhook": {
"type": "string"
}
},
"additionalProperties": false
},
"WebhookAnnouncerMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/WebhookAnnouncer"
},
"patternProperties": {
"^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]?$": {
"$ref": "#/definitions/WebhookAnnouncer"
}
}
},
"WebhooksAnnouncer": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"readTimeout": {
"type": "integer"
},
"webhooks": {
"allOf": [
{
"$ref": "#/definitions/WebhookAnnouncerMap"
},
{
"additionalProperties": {
"$ref": "#/definitions/WebhookAnnouncer"
},
"type": ["object", "null"]
}
]
}
},
"additionalProperties": false
},
"Windows-1": {
"type": "object",
"properties": {
"appName": {
"type": "string"
},
"console": {
"type": "boolean"
},
"dirChooser": {
"type": "boolean"
},
"icon": {
"type": "string"
},
"installDir": {
"type": "string"
},
"jdk": {
"$ref": "#/definitions/Artifact"
},
"menu": {
"type": "boolean"
},
"menuGroup": {
"type": "string"
},
"perUserInstall": {
"type": "boolean"
},
"platform": {
"type": "string"
},
"resourceDir": {
"type": "string"
},
"shortcut": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"upgradeUuid": {
"type": "string"
},
"validTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"Windows-2": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"platform": {
"type": "string"
}
},
"additionalProperties": false
},
"WingetPackager": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"author": {
"type": "string"
},
"commitAuthor": {
"$ref": "#/definitions/CommitAuthor"
},
"continueOnError": {
"type": "boolean"
},
"defaultLocale": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"installer": {
"$ref": "#/definitions/Installer"
},
"minimumOsVersion": {
"type": "string"
},
"moniker": {
"type": "string"
},
"package": {
"$ref": "#/definitions/Package"
},
"productCode": {
"type": "string"
},
"publisher": {
"$ref": "#/definitions/Publisher"
},
"repository": {
"$ref": "#/definitions/WingetRepository"
},
"skipTemplates": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"templateDirectory": {
"type": "string"
}
},
"additionalProperties": false
},
"WingetRepository": {
"type": "object",
"properties": {
"active": {
"$ref": "#/definitions/Active"
},
"branch": {
"type": "string"
},
"branchPush": {
"type": "string"
},
"commitMessage": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"tagName": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"ZulipAnnouncer": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"active": {
"$ref": "#/definitions/Active"
},
"apiHost": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"channel": {
"type": "string"
},
"connectTimeout": {
"type": "integer"
},
"extraProperties": {
"$ref": "#/definitions/Properties"
},
"message": {
"type": "string"
},
"messageTemplate": {
"type": "string"
},
"readTimeout": {
"type": "integer"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
|
lazygit.json | {
"$comment": "This schema should be ported to https://github.com/jesseduffield/lazygit repository and be autogenerated",
"$id": "https://json.schemastore.org/lazygit.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"color": {
"type": "string",
"oneOf": [
{
"enum": [
"black",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"bold",
"default",
"reverse",
"underline",
"strikethrough"
]
},
{
"pattern": "^#[0-9a-fA-F]{6}$",
"examples": ["#ff00ff"]
}
]
},
"keybinding": {
"type": ["string", "null"],
"examples": ["<enter>", "<c-b>", "g"]
},
"custom-commands-prompts-type-property": {
"title": "type",
"description": "A type\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields",
"type": "string",
"enum": ["input", "confirm", "menu", "menuFromCommand"]
},
"custom-commands-prompts-title-property": {
"title": "title",
"description": "A title\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields",
"type": "string",
"examples": ["Remote branch:"]
},
"custom-commands-prompts-key-property": {
"title": "key",
"description": "A key\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields",
"type": "string",
"examples": ["Branch"]
}
},
"description": "UI settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"properties": {
"gui": {
"title": "gui",
"description": "Settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"windowSize": {
"title": "window size",
"description": "A window size\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["normal", "half", "full"],
"default": "normal"
},
"scrollHeight": {
"title": "scroll height",
"description": "A scroll height\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "integer",
"minimum": 1,
"default": 2
},
"scrollPastBottom": {
"title": "scroll past bottom",
"description": "Whether to allow scrolling past bottom of the current window\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"sidePanelWidth": {
"title": "side panel width",
"description": "A width of the current side panel\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 0.3333
},
"expandFocusedSidePanel": {
"title": "expand focused side panel",
"description": "Whether to expand focused side panel\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"mainPanelSplitMode": {
"title": "main panel split mode",
"description": "A split mode of the current main panel\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["horizontal", "flexible", "vertical"],
"default": "flexible"
},
"language": {
"title": "language",
"description": "A language\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": [
"auto",
"en",
"zh-CN",
"zh-TW",
"pl",
"nl",
"ja",
"ko",
"ru"
],
"default": "auto"
},
"timeFormat": {
"title": "time format",
"description": "A time format\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": "02 Jan 06"
},
"shortTimeFormat": {
"title": "short time format",
"description": "A short time format\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": "3:04PM"
},
"theme": {
"title": "theme",
"description": "Settings of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"activeBorderColor": {
"title": "active border color",
"description": "Active border colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "An active border color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"inactiveBorderColor": {
"title": "inactive border color",
"description": "Inactive border colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "An inactive border color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"searchingActiveBorderColor": {
"title": "searching active border color",
"description": "Searching active border colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A searching active border color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"optionsTextColor": {
"title": "options text color",
"description": "Option text colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "An option text color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"selectedLineBgColor": {
"title": "selected line bg color",
"description": "Selected line background colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A selected line background color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"selectedRangeBgColor": {
"title": "selected range bg color",
"description": "Selected range background colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A selected range background color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"cherryPickedCommitBgColor": {
"title": "cherry picked commit bg color",
"description": "Cherry picked commit background colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A cherry picked commit background color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"cherryPickedCommitFgColor": {
"title": "cherry picked commit fg color",
"description": "Cherry picked commit foreground colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A cherry picked commit foreground color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"unstagedChangesColor": {
"title": "unstaged changes color",
"description": "Unstaged changes colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "An unstaged changes color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
},
"defaultFgColor": {
"title": "default fg color",
"description": "Default foreground colors of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A default foreground color of the current theme\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
}
},
"additionalProperties": false
},
"commitLength": {
"title": "commit length",
"description": "Settings of the current commit length\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"show": {
"title": "show",
"description": "Whether to show the current commit length\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"mouseEvents": {
"title": "mouse events",
"description": "Whether to enable mouse events\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"skipDiscardChangeWarning": {
"title": "skip discard change warning",
"description": "Whether to disable change warning\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"skipStashWarning": {
"title": "skip stash warning",
"description": "Whether to disable stash warning\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"showFileTree": {
"title": "show file tree",
"description": "Whether to render render files in a tree format\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"showListFooter": {
"title": "show list footer",
"description": "Whether to show list footer\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"showRandomTip": {
"title": "show random tip",
"description": "Whether to show a random tip\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"showBranchCommitHash": {
"title": "show branch commit hash",
"description": "Whether to show a branch commit hash\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"showBottomLine": {
"title": "show bottom line",
"description": "Whether to show a bottom line unless there is an important information\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"showCommandLog": {
"title": "show command log",
"description": "Whether to show command log\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"nerdFontsVersion": {
"title": "nerd fonts version",
"description": "A nerd font version\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["2", "3", ""],
"default": ""
},
"commandLogSize": {
"title": "command log size",
"description": "A command log size\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "integer",
"minimum": 0,
"default": 8
},
"splitDiff": {
"title": "split diff",
"description": "Whether to skip diff\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["auto", "always"],
"default": "auto"
},
"skipRewordInEditorWarning": {
"title": "skip reword in editor warning",
"description": "Whether to skip a confirmation before launching a reword editor\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"border": {
"title": "border",
"description": "A border style\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["single", "double", "rounded", "hidden"],
"default": "single"
},
"animateExplosion": {
"title": "animate explosion",
"description": "Whether to show explosion animation while nuking working tree\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"authorColors": {
"title": "author colors",
"description": "Author colors\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"type": "object",
"patternProperties": {
".": {
"title": "author color",
"description": "An author color\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color",
"$ref": "#/definitions/color"
}
},
"additionalProperties": false
},
"branchColors": {
"title": "branch colors",
"description": "Branch colors\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"type": "object",
"patternProperties": {
".": {
"title": "branch color",
"description": "A branch color\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color",
"$ref": "#/definitions/color"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"git": {
"title": "git",
"description": "Git settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"paging": {
"title": "paging",
"description": "Pager settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"type": "object",
"properties": {
"colorArg": {
"title": "color argument",
"description": "A pager color argument\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"type": "string",
"enum": ["always", "never"],
"default": "always"
},
"useConfig": {
"title": "use config",
"description": "Whether to use a config\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"type": "boolean",
"default": false
},
"pager": {
"title": "pager",
"description": "A pager\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
"type": "string",
"minLength": 1,
"examples": [
"delta --dark --paging=never",
"diff-so-fancy",
"ydiff -p cat -s --wrap --width={{columnWidth}}"
]
}
},
"additionalProperties": false
},
"commit": {
"title": "commit",
"description": "Commit settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"signOff": {
"title": "sign off",
"description": "Whether to sign commits off\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"merging": {
"title": "merging",
"description": "Merging settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"manualCommit": {
"title": "manual commit",
"description": "Whether to use manual commits\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"args": {
"title": "arguments",
"description": "Additional CLI arguments for 'git merge'\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": "",
"examples": ["--no-ff"]
}
},
"additionalProperties": false
},
"log": {
"title": "log",
"description": "Log settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"order": {
"title": "order",
"description": "A commit order\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": [
"date-order",
"author-date-order",
"topo-order",
"default"
],
"default": "topo-order"
},
"showGraph": {
"title": "show graph",
"description": "Whether to show a graph\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["always", "never", "when-maximised"],
"default": "when-maximised"
},
"showWholeGraph": {
"title": "show whole graph",
"description": "Whether to show the whole graph\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"skipHookPrefix": {
"title": "skip hook prefix",
"description": "A prefix to skip\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": "WIP"
},
"mainBranches": {
"title": "main branches",
"description": "Main branches\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"items": {
"description": "A main branch\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"minLength": 1,
"examples": ["main", "master"]
},
"default": ["main", "master"]
},
"autoFetch": {
"title": "auto fetch",
"description": "Whether to automatically fetch\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"autoRefresh": {
"title": "auto refresh",
"description": "Whether to automatically refresh\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"fetchAll": {
"title": "fetch all",
"description": "Whether to fetch everything\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"branchLogCmd": {
"title": "branch log cmd",
"description": "A log command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --"
},
"allBranchesLogCmd": {
"title": "all branches log cmd",
"description": "A log command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium"
},
"overrideGpg": {
"title": "override gpg",
"description": "Whether not to spawn a separate process while using GPG\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"disableForcePushing": {
"title": "disable force pushing",
"description": "Whether to disable force pushing\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"parseEmoji": {
"title": "parse emoji",
"description": "Whether to parse emoji\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"diffContextSize": {
"title": "diff context size",
"description": "how many lines of context are shown around a change in diffs\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "integer",
"default": 3
},
"commitPrefixes": {
"title": "commit prefixes",
"description": "Commit prefixes\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object",
"patternProperties": {
".": {
"title": "repository path",
"description": "A repository path\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "object",
"required": ["pattern", "replace"],
"properties": {
"pattern": {
"title": "pattern",
"description": "A pattern\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "string",
"minLength": 1,
"examples": ["^\\w+\\/(\\w+-\\w+).*"]
},
"replace": {
"title": "replace",
"description": "A replacement\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix",
"type": "string",
"minLength": 1,
"examples": ["[$1] "]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"os": {
"title": "os",
"description": "OS settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "object",
"properties": {
"copyToClipboardCmd": {
"title": "copy to clipboard cmd",
"description": "A copy to clipboard command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "string",
"default": "",
"examples": [
"printf \"\\033]52;c;$(printf {{text}} | base64)\\a\" > /dev/tty"
]
},
"editPreset": {
"title": "edit preset",
"description": "An edit preset\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "string",
"oneOf": [
{
"enum": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"bbedit",
"kakoune",
"helix",
"xcode"
]
},
{
"const": ""
}
],
"default": ""
},
"edit": {
"title": "edit",
"description": "An editor command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "string",
"default": "",
"examples": [
"vim",
"nvim",
"emacs",
"nano",
"vscode",
"sublime",
"bbedit",
"kakoune",
"helix",
"xcode"
]
},
"editAtLine": {
"title": "edit at line",
"description": "An editor command to open at specific line\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "string",
"default": "",
"examples": [
"vim +{{line}} {{filename}}",
"nvim +{{line}} {{filename}}",
"emacs +{{line}} {{filename}}",
"nano +{{line}} {{filename}}",
"vscode -g {{filename}}:{{line}}",
"vscode --goto {{filename}}:{{line}}",
"sublime {{filename}}:{{line}}"
]
},
"editAtLineAndWait": {
"title": "edit at line and wait",
"description": "An editor command to open at specific line and wait\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "string",
"default": "",
"examples": [
"vim +{{line}} {{filename}}",
"nvim +{{line}} {{filename}}",
"emacs +{{line}} {{filename}}",
"nano +{{line}} {{filename}}",
"vscode -g {{filename}}:{{line}} -w",
"vscode --goto {{filename}}:{{line}} --wait",
"sublime {{filename}}:{{line}} -w",
"sublime {{filename}}:{{line}} --wait"
]
},
"open": {
"title": "open",
"description": "An editor command for non-text files\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#configuring-file-editing",
"type": "string",
"default": ""
},
"openLink": {
"title": "open link",
"description": "An open link\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"default": ""
}
},
"additionalProperties": false
},
"refresher": {
"title": "refresher",
"description": "Refresh settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"refreshInterval": {
"title": "refresh interval",
"description": "A file/submodule refresh interval in seconds\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "integer",
"minimum": 0,
"default": 10
},
"fetchInterval": {
"title": "fetch interval",
"description": "A re-fetch interval in seconds\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "integer",
"minimum": 0,
"default": 60
}
},
"additionalProperties": false
},
"update": {
"title": "update",
"description": "Update settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"method": {
"title": "method",
"description": "A method\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["prompt", "background", "never"],
"default": "prompt"
},
"days": {
"title": "days",
"description": "A day count\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "integer",
"minimum": 0,
"default": 14
}
},
"additionalProperties": false
},
"confirmOnQuit": {
"title": "confirm on quit",
"description": "Whether to confirm on on quit\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"quitOnTopLevelReturn": {
"title": "quit on top level return",
"description": "Whether to quit on 'esc' press while there is nothing to cancel/close\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"disableStartupPopups": {
"title": "disable startup popups",
"description": "Whether to disable startup popups\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"notARepository": {
"title": "not a repository",
"description": "An action for non-repositories\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["prompt", "create", "skip", "quit"],
"default": "prompt"
},
"promptToReturnFromSubprocess": {
"title": "prompt to return from subprocess",
"description": "Whether to show confirmation on subprocess termination\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"keybinding": {
"title": "keybinding",
"description": "Keybinding settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"universal": {
"title": "universal",
"description": "Universal keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"quit": {
"title": "quit",
"description": "A quit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "q"
},
"quit-alt1": {
"title": "quit-alt1",
"description": "A quit-alt1 keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-c>"
},
"return": {
"title": "return",
"description": "A return keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<esc>"
},
"quitWithoutChangingDirectory": {
"title": "quit without changing directory",
"description": "A quit without changing directory keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "Q"
},
"togglePanel": {
"title": "toggle panel",
"description": "A toggle panel keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<tab>"
},
"prevItem": {
"title": "prev item",
"description": "A previous item keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<up>"
},
"nextItem": {
"title": "next item",
"description": "A next item keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<down>"
},
"prevItem-alt": {
"title": "prev item-alt",
"description": "A previous item-alt keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "k"
},
"nextItem-alt": {
"title": "next item-alt",
"description": "A next item-alt keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "j"
},
"prevPage": {
"title": "prev page",
"description": "A previous page keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": ","
},
"nextPage": {
"title": "next page",
"description": "A next page keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "."
},
"gotoTop": {
"title": "goto top",
"description": "A goto top keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<"
},
"gotoBottom": {
"title": "goto bottom",
"description": "A goto bottom keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": ">"
},
"scrollLeft": {
"title": "scroll left",
"description": "A scroll left keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "H"
},
"scrollRight": {
"title": "scroll right",
"description": "A scroll right keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "L"
},
"prevBlock": {
"title": "prev block",
"description": "A previous block keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<left>"
},
"nextBlock": {
"title": "next block",
"description": "A next block keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<right>"
},
"prevBlock-alt": {
"title": "prev block-alt",
"description": "A previous block-alt keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "h"
},
"nextBlock-alt": {
"title": "next block-alt",
"description": "A next block-alt keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "l"
},
"jumpToBlock": {
"title": "jump to block",
"description": "A jump to block keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "array",
"default": ["1", "2", "3", "4", "5"]
},
"nextMatch": {
"title": "next match",
"description": "A next match keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "n"
},
"prevMatch": {
"title": "prev match",
"description": "A previous match keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "N"
},
"optionMenu": {
"title": "option menu",
"description": "An option menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "null",
"default": null
},
"optionMenu-alt1": {
"title": "option menu-alt1",
"description": "An option menu-alt1 keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "?"
},
"select": {
"title": "select",
"description": "A select keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<space>"
},
"goInto": {
"title": "go into",
"description": "A go into keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<enter>"
},
"openRecentRepos": {
"title": "open recent repos",
"description": "An open recent repos keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-r>"
},
"confirm": {
"title": "confirm",
"description": "A confirm keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<enter>"
},
"remove": {
"title": "remove",
"description": "A remove keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "d"
},
"new": {
"title": "new",
"description": "A new keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "n"
},
"edit": {
"title": "edit",
"description": "A edit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "e"
},
"openFile": {
"title": "open file",
"description": "An open file keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "o"
},
"scrollUpMain": {
"title": "scroll up main",
"description": "A scroll up main keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<pgup>"
},
"scrollDownMain": {
"title": "scroll down main",
"description": "A scroll down main keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<pgdown>"
},
"scrollUpMain-alt1": {
"title": "scroll up main-alt1",
"description": "A scroll up main-alt1 keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "K"
},
"scrollDownMain-alt1": {
"title": "scroll down main-alt1",
"description": "A scroll down main-alt1 keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "J"
},
"scrollUpMain-alt2": {
"title": "scroll up main-alt2",
"description": "A scroll up main-alt2 keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-u>"
},
"scrollDownMain-alt2": {
"title": "scroll down main-alt2",
"description": "A scroll down main-alt2 keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-d>"
},
"executeCustomCommand": {
"title": "execute custom command",
"description": "A execute custom command keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": ":"
},
"createRebaseOptionsMenu": {
"title": "create rebase options menu",
"description": "A create rebase options menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "m"
},
"pushFiles": {
"title": "push files",
"description": "A push files keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "P"
},
"pullFiles": {
"title": "pull files",
"description": "A pull files keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "p"
},
"refresh": {
"title": "refresh",
"description": "A refresh keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "R"
},
"createPatchOptionsMenu": {
"title": "create patch options menu",
"description": "A create patch options menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-p>"
},
"nextTab": {
"title": "next tab",
"description": "A next tab keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "]"
},
"prevTab": {
"title": "prev tab",
"description": "A previous tab keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "["
},
"nextScreenMode": {
"title": "next screen mode",
"description": "A next screen mode keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "+"
},
"prevScreenMode": {
"title": "prev screen mode",
"description": "A previous screen mode keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "_"
},
"undo": {
"title": "undo",
"description": "An undo keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "z"
},
"redo": {
"title": "redo",
"description": "A redo keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-z>"
},
"filteringMenu": {
"title": "filtering menu",
"description": "A filtering menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-s>"
},
"diffingMenu": {
"title": "diffing menu",
"description": "A diffing menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "W"
},
"diffingMenu-alt": {
"title": "diffing menu-alt",
"description": "A diffing menu-alt keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-e>"
},
"copyToClipboard": {
"title": "copy to clipboard",
"description": "A copy to clipboard keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-o>"
},
"submitEditorText": {
"title": "submit editor text",
"description": "A submit editor text keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<enter>"
},
"extrasMenu": {
"title": "extras menu",
"description": "A extras menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "@"
},
"toggleWhitespaceInDiffView": {
"title": "toggle whitespace in diff view",
"description": "A toggle whitespace in diff view keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-w>"
},
"increaseContextInDiffView": {
"title": "increase context in diff view",
"description": "A increase context in diff view keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "}"
},
"decreaseContextInDiffView": {
"title": "decrease context in diff view",
"description": "A decrease context in diff view keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "{"
}
},
"additionalProperties": false
},
"status": {
"title": "status",
"description": "Status keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"checkForUpdate": {
"title": "check for update",
"description": "A check for update keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "u"
},
"recentRepos": {
"title": "recent repos",
"description": "A recent repos keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<enter>"
}
},
"additionalProperties": false
},
"files": {
"title": "files",
"description": "File keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"commitChanges": {
"title": "commit changes",
"description": "A commit changes keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "c"
},
"commitChangesWithoutHook": {
"title": "commit changes without hook",
"description": "A commit changes without hook keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "w"
},
"amendLastCommit": {
"title": "amend last commit",
"description": "A amend last commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "A"
},
"commitChangesWithEditor": {
"title": "commit changes with editor",
"description": "A commit changes with editor keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "C"
},
"ignoreFile": {
"title": "ignore file",
"description": "A ignore file keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "i"
},
"refreshFiles": {
"title": "refresh files",
"description": "A refresh files keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "r"
},
"stashAllChanges": {
"title": "stash all changes",
"description": "A stash all changes keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "s"
},
"viewStashOptions": {
"title": "view stash options",
"description": "A view stash options keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "S"
},
"toggleStagedAll": {
"title": "toggle staged all",
"description": "A toggle staged all keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "a"
},
"viewResetOptions": {
"title": "view reset options",
"description": "A view reset options keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "D"
},
"fetch": {
"title": "fetch",
"description": "A fetch keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "f"
},
"toggleTreeView": {
"title": "toggle tree view",
"description": "A toggle tree view keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "`"
},
"openMergeTool": {
"title": "open merge tool",
"description": "A open merge tool keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "M"
},
"openStatusFilter": {
"title": "open status filter",
"description": "A open status filter keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-b>"
}
},
"additionalProperties": false
},
"branches": {
"title": "branches",
"description": "Branch keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"createPullRequest": {
"title": "create pull request",
"description": "A create pull request keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "o"
},
"viewPullRequestOptions": {
"title": "view pull request options",
"description": "A view pull request options keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "O"
},
"checkoutBranchByName": {
"title": "checkout branch by name",
"description": "A checkout branch by name keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "c"
},
"forceCheckoutBranch": {
"title": "force checkout branch",
"description": "A force checkout branch keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "F"
},
"rebaseBranch": {
"title": "rebase branch",
"description": "A rebase branch keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "r"
},
"renameBranch": {
"title": "rename branch",
"description": "A rename branch keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "R"
},
"mergeIntoCurrentBranch": {
"title": "merge into current branch",
"description": "A merge into current branch keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "M"
},
"viewGitFlowOptions": {
"title": "view git flow options",
"description": "A view git flow options keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "i"
},
"fastForward": {
"title": "fast forward",
"description": "A fast forward keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "f"
},
"createTag": {
"title": "create tag",
"description": "A create tag keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "T"
},
"pushTag": {
"title": "push tag",
"description": "A push tag keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "P"
},
"setUpstream": {
"title": "set upstream",
"description": "A set upstream keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "u"
},
"fetchRemote": {
"title": "fetch remote",
"description": "A fetch remote keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "f"
}
},
"additionalProperties": false
},
"commits": {
"title": "commits",
"description": "Commit keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"squashDown": {
"title": "squash down",
"description": "A squash down keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "s"
},
"renameCommit": {
"title": "rename commit",
"description": "A rename commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "r"
},
"renameCommitWithEditor": {
"title": "rename commit with editor",
"description": "A rename commit with editor keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "R"
},
"viewResetOptions": {
"title": "view reset options",
"description": "A view reset options keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "g"
},
"markCommitAsFixup": {
"title": "mark commit as fixup",
"description": "A mark commit as fixup keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "f"
},
"createFixupCommit": {
"title": "create fixup commit",
"description": "A create fixup commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "F"
},
"squashAboveCommits": {
"title": "squash above commits",
"description": "A squash above commits keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "S"
},
"moveDownCommit": {
"title": "move down commit",
"description": "A move down commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-j>"
},
"moveUpCommit": {
"title": "move up commit",
"description": "A move up commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-k>"
},
"amendToCommit": {
"title": "amend to commit",
"description": "A amend to commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "A"
},
"pickCommit": {
"title": "pick commit",
"description": "A pick commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "p"
},
"revertCommit": {
"title": "revert commit",
"description": "A revert commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "t"
},
"cherryPickCopy": {
"title": "cherry pick copy",
"description": "A cherry pick copy keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "c"
},
"cherryPickCopyRange": {
"title": "cherry pick copy range",
"description": "A cherry pick copy range keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "C"
},
"pasteCommits": {
"title": "paste commits",
"description": "A paste commits keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "v"
},
"tagCommit": {
"title": "tag commit",
"description": "A tag commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "T"
},
"checkoutCommit": {
"title": "checkout commit",
"description": "A checkout commit keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<space>"
},
"resetCherryPick": {
"title": "reset cherry pick",
"description": "A reset cherry pick keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-R>"
},
"copyCommitMessageToClipboard": {
"title": "copy commit message to clipboard",
"description": "A copy commit message to clipboard keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-y>"
},
"openLogMenu": {
"title": "open log menu",
"description": "A open log menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "<c-l>"
},
"viewBisectOptions": {
"title": "view bisect options",
"description": "A view bisect options keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "b"
}
},
"additionalProperties": false
},
"stash": {
"title": "stash",
"description": "Stash keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"popStash": {
"title": "pop stash",
"description": "A pop stash keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "g"
},
"renameStash": {
"title": "rename stash",
"description": "A rename stash keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "r"
}
},
"additionalProperties": false
},
"commitFiles": {
"title": "commit files",
"description": "Commit file keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"checkoutCommitFile": {
"title": "checkout commit file",
"description": "A checkout commit file keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "c"
}
},
"additionalProperties": false
},
"main": {
"title": "main",
"description": "Main keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"toggleDragSelect": {
"title": "toggle drag select",
"description": "A toggle drag select keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "v"
},
"toggleDragSelect-alt": {
"title": "toggle drag select-alt",
"description": "A toggle drag select-alt keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "V"
},
"toggleSelectHunk": {
"title": "toggle select hunk",
"description": "A toggle select hunk keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "a"
},
"pickBothHunks": {
"title": "pick both hunks",
"description": "A pick both hunks keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "b"
}
},
"additionalProperties": false
},
"submodules": {
"title": "submodules",
"description": "Submodules keybindings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"init": {
"title": "init",
"description": "An init keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "i"
},
"update": {
"title": "update",
"description": "An update keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "u"
},
"bulkMenu": {
"title": "bulk menu",
"description": "A bulk menu keybinding\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#default",
"$ref": "#/definitions/keybinding",
"default": "b"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"services": {
"title": "services",
"description": "Service settings\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "object",
"patternProperties": {
".": {
"title": "service",
"description": "A service\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls",
"type": "string",
"pattern": "^[^:]+:[^:]+$"
}
},
"additionalProperties": false
},
"customCommands": {
"title": "custom commands",
"description": "Custom commands\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "array",
"uniqueItems": true,
"items": {
"description": "A custom command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "object",
"required": ["key", "command", "context"],
"properties": {
"key": {
"title": "key",
"description": "A command trigger\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"$ref": "#/definitions/keybinding"
},
"command": {
"title": "command",
"description": "A command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "string",
"default": "",
"examples": [
"git fetch {{.Form.Remote}} {{.Form.Branch}} && git checkout FETCH_HEAD"
]
},
"context": {
"title": "context",
"description": "A context\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "string",
"enum": [
"status",
"files",
"worktrees",
"localBranches",
"remotes",
"remoteBranches",
"tags",
"commits",
"reflogCommits",
"subCommits",
"commitFiles",
"stash",
"global"
]
},
"subprocess": {
"title": "subprocess",
"description": "Whether to run command in subprocess\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "boolean",
"default": false
},
"prompts": {
"title": "prompts",
"description": "Prompts before running a command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "array",
"items": {
"description": "A prompt before running a command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "object",
"required": ["type", "title", "key"],
"properties": {
"type": {
"$ref": "#/definitions/custom-commands-prompts-type-property"
},
"title": {
"$ref": "#/definitions/custom-commands-prompts-title-property"
},
"key": {
"$ref": "#/definitions/custom-commands-prompts-key-property"
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "input"
}
}
},
"then": {
"properties": {
"type": {
"$ref": "#/definitions/custom-commands-prompts-type-property"
},
"title": {
"$ref": "#/definitions/custom-commands-prompts-title-property"
},
"key": {
"$ref": "#/definitions/custom-commands-prompts-key-property"
},
"initialValue": {
"title": "initial value",
"description": "An initial value\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input",
"type": "string"
},
"suggestions": {
"title": "suggestions",
"description": "Whether to show suggestions as the input is entered\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input",
"type": "object",
"oneOf": [
{
"properties": {
"preset": {
"title": "preset",
"description": "A preset\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input",
"type": "string",
"enum": [
"authors",
"branches",
"files",
"refs",
"remotes",
"remoteBranches",
"tags"
]
}
},
"additionalProperties": false
},
{
"properties": {
"command": {
"title": "command",
"description": "A command where each line in the output is suggestion\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#input",
"type": "string",
"default": "",
"examples": [
"git branch --format='%(refname:short)'"
]
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
},
{
"if": {
"properties": {
"type": {
"const": "confirm"
}
}
},
"then": {
"properties": {
"type": {
"$ref": "#/definitions/custom-commands-prompts-type-property"
},
"title": {
"$ref": "#/definitions/custom-commands-prompts-title-property"
},
"key": {
"$ref": "#/definitions/custom-commands-prompts-key-property"
},
"body": {
"title": "body",
"description": "A body\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#confirm",
"type": "string",
"examples": [
"Are you sure you want to push to the remote?"
]
}
},
"additionalProperties": false
}
},
{
"if": {
"properties": {
"type": {
"const": "menu"
}
}
},
"then": {
"required": ["options"],
"properties": {
"type": {
"$ref": "#/definitions/custom-commands-prompts-type-property"
},
"title": {
"$ref": "#/definitions/custom-commands-prompts-title-property"
},
"key": {
"$ref": "#/definitions/custom-commands-prompts-key-property"
},
"options": {
"title": "options",
"description": "Options\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu",
"type": "array",
"uniqueItems": true,
"items": {
"description": "An option",
"type": "object",
"required": ["value"],
"properties": {
"name": {
"title": "name",
"description": "A first label part\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu",
"type": "string",
"default": ""
},
"description": {
"title": "description",
"description": "A second label part\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu",
"type": "string",
"default": ""
},
"value": {
"title": "value",
"description": "the value that will be used in the command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu",
"type": "string",
"minLength": 1,
"examples": ["feature"]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
{
"if": {
"properties": {
"type": {
"const": "menuFromCommand"
}
}
},
"then": {
"required": ["command"],
"properties": {
"type": {
"$ref": "#/definitions/custom-commands-prompts-type-property"
},
"title": {
"$ref": "#/definitions/custom-commands-prompts-title-property"
},
"key": {
"$ref": "#/definitions/custom-commands-prompts-key-property"
},
"command": {
"title": "command",
"description": "A command to generate options\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command",
"type": "string",
"default": "",
"examples": [
"git branch -r --list {{.SelectedRemote.Name }}/*"
]
},
"filter": {
"title": "filter",
"description": "A regex specifying groups which kept from command output\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command",
"type": "string",
"default": "",
"examples": [
".*{{.SelectedRemote.Name }}/(?P<branch>.*)"
]
},
"valueFormat": {
"title": "valueFormat",
"description": "A value format\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command",
"type": "string",
"default": "",
"examples": ["{{ .branch }}"]
},
"labelFormat": {
"title": "labelFormat",
"description": "A label format\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#menu-from-command",
"type": "string",
"default": "",
"examples": ["{{ .branch | green }}"]
}
},
"additionalProperties": false
}
}
]
}
},
"loadingText": {
"title": "loading text",
"description": "Text to display while waiting for command to finish\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "string",
"default": "",
"examples": ["Loading..."]
},
"description": {
"title": "description",
"description": "A description\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "string",
"default": "",
"examples": ["Checkout a remote branch as FETCH_HEAD"]
},
"stream": {
"title": "stream",
"description": "Whether to stream command output to Command Log panel\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "boolean",
"default": false
},
"showOutput": {
"title": "show output",
"description": "Whether to show the command output in popup\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "boolean",
"default": false
},
"after": {
"title": "after",
"description": "Actions to take after the command has completed\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "object",
"properties": {
"checkForConflicts": {
"title": "check for conflicts",
"description": "Whether to check for conflicts before running command\nhttps://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#custom-command-keybindings",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"title": "ui settings",
"type": "object"
}
|
goss-json-schema.json | {"type":"object","definitions":{"gossfileTest":{"properties":{"meta":{"$ref":"#/definitions/meta"},"skip":{"default":"","type":"boolean"},"title":{"$ref":"#/definitions/title"},"file":{"default":"myapp_gossfile.yaml","type":"string"}}},"packageTest":{"required":["installed"],"properties":{"versions":{"oneOf":[{"type":"object"},{"type":"array","default":["2.2.15"],"items":{"type":"string"}}]},"installed":{"default":"1","type":"boolean"},"skip":{"type":"boolean","default":""},"meta":{"$ref":"#/definitions/meta"},"title":{"$ref":"#/definitions/title"}}},"commandTest":{"type":"object","required":["exit-status"],"properties":{"meta":{"$ref":"#/definitions/meta"},"timeout":{"type":"integer","description":"in milliseconds"},"stdout":{"type":"array","description":"can be a string or pattern, see https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns","items":{"type":"string"}},"stderr":{"type":"array","description":"can be a string or pattern, see https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns","items":{"type":"string"}},"skip":{"default":"","type":"boolean"},"exit-status":{"type":"integer","description":"Validates the exit-status and output of a command"},"title":{"$ref":"#/definitions/title"},"exec":{"description":"command to execute, defaults to the hash key","type":"string"}}},"mountTest":{"properties":{"meta":{"$ref":"#/definitions/meta"},"filesystem":{"default":"xfs","type":"string"},"opts":{"default":["rw","relatime"],"items":{"type":"string"},"type":"array"},"exists":{"default":"1","type":"boolean"},"title":{"$ref":"#/definitions/title"},"source":{"type":"string","default":"/dev/mapper/fedora-home"},"usage":{"type":"object","properties":{"lt":{"default":"95","type":"integer"}},"description":"% of blocks used in this mountpoint\n"}},"required":["exists"]},"portTest":{"required":["listening"],"properties":{"listening":{"default":"1","type":"boolean"},"skip":{"type":"boolean","default":""},"meta":{"$ref":"#/definitions/meta"},"title":{"$ref":"#/definitions/title"},"ip":{"description":"what IP(s) is it listening on","type":"array","default":["0.0.0.0"],"items":{"type":"string"}}}},"interfaceTest":{"properties":{"addrs":{"items":{"type":"string"},"default":["172.17.0.2/16","fe80::42:acff:fe11:2/64"],"type":"array"},"meta":{"$ref":"#/definitions/meta"},"mtu":{"type":"integer","default":"1500"},"title":{"$ref":"#/definitions/title"},"exists":{"default":"1","type":"boolean"}},"required":["exists"]},"processTest":{"required":["running","skip"],"properties":{"title":{"$ref":"#/definitions/title"},"skip":{"default":"","type":"boolean"},"meta":{"$ref":"#/definitions/meta"},"running":{"default":"1","type":"boolean"}}},"kernelParamTest":{"description":"To see the full list of current values, run sysctl -a.\n","properties":{"meta":{"$ref":"#/definitions/meta"},"value":{"default":"Linux","type":"string"},"title":{"$ref":"#/definitions/title"}},"required":["value"]},"groupTest":{"required":["exists"],"properties":{"gid":{"type":"integer","default":"65534"},"skip":{"type":"boolean","default":""},"title":{"$ref":"#/definitions/title"},"groups":{"type":"object"},"exists":{"default":"1","type":"boolean"},"uid":{"type":"integer","default":"65534"},"meta":{"$ref":"#/definitions/meta"}}},"serviceTest":{"required":["enabled","running","skip"],"properties":{"running":{"type":"boolean","default":"1"},"enabled":{"type":"boolean","default":"1"},"skip":{"default":"","type":"boolean"},"meta":{"$ref":"#/definitions/meta"},"title":{"$ref":"#/definitions/title"}}},"dnsTest":{"required":["resolvable"],"properties":{"title":{"$ref":"#/definitions/title"},"addrs":{"type":"array","description":"list of addresses e.g. [\"127.0.0.1\", \"::1\"]\n","items":{"type":"string"},"default":["127.0.0.1","::1"]},"timeout":{"type":"integer","description":"in milliseconds (Only used when server attribute is provided)","default":"500"},"meta":{"$ref":"#/definitions/meta"},"server":{"default":"8.8.8.8","description":"Eg 8.8.8.8. Also supports server:port ","type":"string"},"resolvable":{"default":"1","type":"boolean"}}},"fileTest":{"required":["exists"],"properties":{"exists":{"default":"1","type":"boolean"},"filetype":{"enum":["file","symlink","directory"],"default":"file","type":"string"},"sha512":{"default":"cb71b1940dc879a3688bd502846bff6316dd537bbe917484964fe0f098e9245d80958258dc3bd6297bf42d5bd978cbe2c03d077d4ed45b2b1ed9cd831ceb1bd0","type":"string","description":"A stronger checksum alternatives to md5 (recommended)"},"md5":{"default":"7c9bb14b3bf178e82c00c2a4398c93cd","description":"md5 checksum of file","type":"string"},"mode":{"default":"0644","type":"string"},"size":{"description":"in bytes","type":"integer","default":"2118"},"sha256":{"type":"string","description":"A stronger checksum alternatives to md5 (recommended)","default":"7f78ce27859049f725936f7b52c6e25d774012947d915e7b394402cfceb70c4c"},"owner":{"type":"string","default":"root"},"skip":{"default":"","type":"boolean"},"group":{"type":"string","default":"root"},"meta":{"$ref":"#/definitions/meta"},"linked-to":{"default":"/usr/sbin/sendmail.sendmail","type":"string"},"title":{"$ref":"#/definitions/title"},"contains":{"items":{"type":"string","description":"string or patterns"},"type":"array","description":"Check file content for these patterns. can be a string or a pattern"}}},"userTest":{"required":["exists"],"properties":{"shell":{"default":"/sbin/nologin","type":"string"},"gid":{"anyOf":[{"$ref":"#/definitions/matchingTest"},{"type":"integer","default":"65534"}]},"groups":{"anyOf":[{"$ref":"#/definitions/matchingTest"},{"default":["nfsnobody"],"items":{"type":"string"},"type":"array"}]},"title":{"$ref":"#/definitions/title"},"skip":{"type":"boolean","default":""},"home":{"anyOf":[{"$ref":"#/definitions/matchingTest"},{"type":"string","default":"/var/lib/nfs"}]},"exists":{"default":"1","type":"boolean"},"uid":{"anyOf":[{"$ref":"#/definitions/matchingTest"},{"default":"65534","type":"integer"}]},"meta":{"$ref":"#/definitions/meta"}}},"addrTest":{"properties":{"local-address":{"type":"string","default":"127.0.0.1"},"reachable":{"default":"1","type":"boolean"},"timeout":{"default":"500","examples":["500"],"type":"integer"},"meta":{"$ref":"#/definitions/meta"},"title":{"$ref":"#/definitions/title"}},"required":["reachable","timeout"]},"meta":{"description":"meta (arbitrary data) attributes are persisted when adding other resources with goss add","type":"object"},"matchingTest":{"properties":{"meta":{"$ref":"#/definitions/meta"},"title":{"$ref":"#/definitions/title"},"matches":{"anyOf":[{"type":"integer"},{"type":"object"},{"type":"array"}]},"content":{"anyOf":[{"default":"some string","type":"string"},{"type":"array","default":["2"]},{"type":"object","default":{"baz":"ring","foo":"bar"}}]}}},"httpTest":{"properties":{"request-headers":{"description":"Set request header values, e.g. [ \"Content-Type: text/html\" ]\n","type":"array","default":["Content-Type: text/html"],"items":{"type":"string"}},"headers":{"description":"Check http response headers for these patterns (e.g. \"Content-Type: text/html\")\nNOTE: only the first Host header will be used to set the Request.Host value if multiple are provided.\n","type":"array","default":[],"items":{"type":"string"}},"skip":{"default":"","type":"boolean"},"allow-insecure":{"default":"","type":"boolean"},"body":{"description":"Check http response content for these patterns","type":"array"},"cert-file":{"default":"","type":"string","description":"certificate file to use for authentication (used with key-file)\n"},"request-body":{"type":"object","description":"request body","default":"{\"key\": \"value\"}"},"no-follow-redirects":{"default":"","type":"boolean","description":"Setting this to true will NOT follow redirects"},"timeout":{"default":"1000","type":"integer"},"status":{"type":"integer","default":"200"},"proxy":{"default":"","type":"string","description":"proxy server to proxy traffic through. Proxy can also be set with environment variables http_proxy.\n"},"title":{"$ref":"#/definitions/title"},"method":{"default":"PUT","enum":["GET","PUT","HEAD","POST","DELETE","PATCH","CONNECT","OPTIONS","TRACE"],"description":"http method","type":"string"},"key-file":{"type":"string","description":"private-key file to use for authentication (used with cert-file)\n","default":""},"ca-file":{"default":"","description":"CA root certs pem file, ex: /etc/ssl/cert.pem\n","type":"string"},"username":{"type":"string","description":"username for basic auth","default":""},"meta":{"$ref":"#/definitions/meta"},"password":{"default":"","type":"string","description":"password for basic auth"}},"required":["status"]},"title":{"description":"title attribute is persisted when adding other resources with goss add","type":"string","default":"UID must be between 50-100, GID doesn't matter. home is flexible"}},"title":"Goss-file-schema","$id":"https://github.com/goss-org/goss/master/docs/goss-json-schema.yaml","properties":{"mount":{"type":"object","description":"Validates mount point attributes.","additionalProperties":{"$ref":"#/definitions/mountTest"}},"service":{"additionalProperties":{"$ref":"#/definitions/serviceTest"},"type":"object","description":"Validates the state of a service."},"user":{"additionalProperties":{"$ref":"#/definitions/userTest"},"type":"object","description":"Validates the state of a user\"\nNOTE: This check is inspecting the contents of local passwd file /etc/passwd, this does not validate remote users (e.g. LDAP).\n"},"addr":{"description":"Validates if a remote address:port are accessible.","type":"object","examples":[{"tcp://ip-address-or-domain-name:80":{"reachable":"1","timeout":"500","local-address":"127.0.0.1"}}],"additionalProperties":{"$ref":"#/definitions/addrTest"}},"file":{"type":"object","description":"Validates the state of a file, directory, or symbolic link","additionalProperties":{"$ref":"#/definitions/fileTest"}},"group":{"additionalProperties":{"$ref":"#/definitions/groupTest"},"type":"object","description":"Validates the state of a group"},"gossfile":{"description":"Import other gossfiles from this one. This is the best way to maintain a large number of tests, and/or create profiles. See render for more examples. Glob patterns can be also be used to specify matching gossfiles.\nYou can specify the gossfile(s) either as the resource key, or using the 'file' attribute.\n\nIf the 'skip' attribute is true, then the file is not processed. If the filename is a glob pattern, then none of the matching files are processed. Note that this is not the same as skipping the contained resources; any overrides in the referenced gossfile will not be processed, and the resource count will not be incremented. Skipping a gossfile include is the same as omitting the gossfile resource entirely.\n","x-intellij-html-description":"Import other gossfiles from this one. This is the best way to maintain a large number of tests, and/or create profiles. See <a href=\"#render-r---render-gossfile-after-importing-all-referenced-gossfiles\">render</a> for more examples. Glob patterns can be also be used to specify matching gossfiles.</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">gossfile</span>:\n <span class=\"pl-ent\">myapplication</span>:\n <span class=\"pl-ent\">file</span>: <span class=\"pl-s\">myapp_gossfile.yaml</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">false</span>\n <span class=\"pl-s\">*.yaml:</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">goss_httpd.yaml</span>: <span class=\"pl-s\">{}</span>\n <span class=\"pl-ent\">/etc/goss.d/*.yaml</span>: <span class=\"pl-s\">{}</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"gossfile:\n myapplication:\n file: myapp_gossfile.yaml\n skip: false\n *.yaml:\n skip: true\n goss_httpd.yaml: {}\n /etc/goss.d/*.yaml: {}\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">You can specify the gossfile(s) either as the resource key, or using the 'file' attribute.</p>\n<p dir=\"auto\">If the 'skip' attribute is true, then the file is not processed. If the filename is a glob pattern, then none of the matching files are processed. Note that this is not the same as skipping the contained resources; any overrides in the referenced gossfile will not be processed, and the resource count will not be incremented. Skipping a gossfile include is the same as omitting the gossfile resource entirely.</p>\n","type":"object","additionalProperties":{"$ref":"#/definitions/gossfileTest"}},"process":{"additionalProperties":{"$ref":"#/definitions/processTest"},"description":"Validates if a process is running.","type":"object"},"http":{"additionalProperties":{"$ref":"#/definitions/httpTest"},"type":"object","description":"description: Validates network interface values"},"command":{"type":"object","description":"test executing a command","additionalProperties":{"$ref":"#/definitions/commandTest"}},"package":{"type":"object","description":"Validates the state of a package\"\nNOTE: this check uses the --package <format> parameter passed on the command line.\n","additionalProperties":{"$ref":"#/definitions/packageTest"}},"kernel-param":{"description":"test ","type":"object","additionalProperties":{"$ref":"#/definitions/kernelParamTest"}},"interface":{"additionalProperties":{"$ref":"#/definitions/interfaceTest"},"type":"object","description":"test "},"matching":{"type":"object","x-intellij-html-description":"<p dir=\"auto\">Validates specified content against a matcher. Best used with <a href=\"#templates\">Templates</a>.</p>\n<h4 dir=\"auto\"><a id=\"user-content-with-templates\" class=\"anchor\" aria-hidden=\"true\" href=\"#with-templates\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>With <a href=\"#templates\">Templates</a>:</h4>\n<p dir=\"auto\">Let's say we have a <code>data.json</code> file that gets generated as part of some testing pipeline:</p>\n<div class=\"highlight highlight-source-json notranslate position-relative overflow-auto\" dir=\"auto\"><pre>{\n <span class=\"pl-ent\">\"instance_count\"</span>: <span class=\"pl-c1\">14</span>,\n <span class=\"pl-ent\">\"failures\"</span>: <span class=\"pl-c1\">3</span>,\n <span class=\"pl-ent\">\"status\"</span>: <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>FAIL<span class=\"pl-pds\">\"</span></span>\n}</pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"{\n "instance_count": 14,\n "failures": 3,\n "status": "FAIL"\n}\" tabindex=\"0\" role=\"button\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">This could then be passed into goss: <code>goss --vars data.json validate</code></p>\n<p dir=\"auto\">And then validated against:</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">matching</span>:\n <span class=\"pl-ent\">check_instance_count</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> Make sure there is at least one instance</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.instance_count }}</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">gt</span>: <span class=\"pl-c1\">0</span>\n\n <span class=\"pl-ent\">check_failure_count_from_all_instance</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> expect no failures</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.failures }}</span>\n <span class=\"pl-ent\">matches</span>: <span class=\"pl-c1\">0</span>\n\n <span class=\"pl-ent\">check_status</span>:\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">{{ .Vars.status }}</span>\n <span class=\"pl-ent\">matches</span>:\n - <span class=\"pl-ent\">not</span>: <span class=\"pl-s\">FAIL</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"matching:\n check_instance_count: # Make sure there is at least one instance\n content: {{ .Vars.instance_count }}\n matches:\n gt: 0\n\n check_failure_count_from_all_instance: # expect no failures\n content: {{ .Vars.failures }}\n matches: 0\n\n check_status:\n content: {{ .Vars.status }}\n matches:\n - not: FAIL\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<h4 dir=\"auto\"><a id=\"user-content-without-templates\" class=\"anchor\" aria-hidden=\"true\" href=\"#without-templates\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Without <a href=\"#templates\">Templates</a>:</h4>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">matching</span>:\n <span class=\"pl-ent\">has_substr</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> friendly test name</span>\n <span class=\"pl-ent\">content</span>: <span class=\"pl-s\">some string</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">match-regexp</span>: <span class=\"pl-s\">some str</span>\n <span class=\"pl-ent\">has_2</span>:\n <span class=\"pl-ent\">content</span>:\n - <span class=\"pl-c1\">2</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">contain-element</span>: <span class=\"pl-c1\">2</span>\n <span class=\"pl-ent\">has_foo_bar_and_baz</span>:\n <span class=\"pl-ent\">content</span>:\n <span class=\"pl-ent\">foo</span>: <span class=\"pl-s\">bar</span>\n <span class=\"pl-ent\">baz</span>: <span class=\"pl-s\">bing</span>\n <span class=\"pl-ent\">matches</span>:\n <span class=\"pl-ent\">and</span>:\n - <span class=\"pl-ent\">have-key-with-value</span>:\n <span class=\"pl-ent\">foo</span>: <span class=\"pl-s\">bar</span>\n - <span class=\"pl-ent\">have-key</span>: <span class=\"pl-s\">baz</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"matching:\n has_substr: # friendly test name\n content: some string\n matches:\n match-regexp: some str\n has_2:\n content:\n - 2\n matches:\n contain-element: 2\n has_foo_bar_and_baz:\n content:\n foo: bar\n baz: bing\n matches:\n and:\n - have-key-with-value:\n foo: bar\n - have-key: baz\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n\nadditionalProperties:\n$ref: \"#/definitions/matchTest\"\n","description":"Validates specified content against a matcher. Best used with Templates."},"dns":{"description":"Validates that the provided address is resolvable and the addrs it resolves to.","x-intellij-html-description":"<p dir=\"auto\">Validates that the provided address is resolvable and the addrs it resolves to.</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-ent\">localhost</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> required attributes</span>\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> optional attributes</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\">127.0.0.1</span>\n - <span class=\"pl-s\">::1</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">8.8.8.8 </span><span class=\"pl-c\"><span class=\"pl-c\">#</span> Also supports server:port</span>\n <span class=\"pl-ent\">timeout</span>: <span class=\"pl-c1\">500</span> <span class=\"pl-c\"><span class=\"pl-c\">#</span> in milliseconds (Only used when server attribute is provided)</span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"dns:\n localhost:\n # required attributes\n resolvable: true\n # optional attributes\n addrs:\n - 127.0.0.1\n - ::1\n server: 8.8.8.8 # Also supports server:port\n timeout: 500 # in milliseconds (Only used when server attribute is provided)\" tabindex=\"0\" role=\"button\" style=\"display: none;\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">It is possible to validate the following types of DNS records, but requires the <code>server</code> attribute be set:</p>\n<ul dir=\"auto\">\n<li>A</li>\n<li>AAAA</li>\n<li>CAA</li>\n<li>CNAME</li>\n<li>MX</li>\n<li>NS</li>\n<li>PTR</li>\n<li>SRV</li>\n<li>TXT</li>\n</ul>\n<p dir=\"auto\">To validate specific DNS address types, prepend the hostname with the type and a colon, a few examples:</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate a CNAME record</span>\n <span class=\"pl-ent\">CNAME:c.dnstest.io</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">208.67.222.222</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>a.dnstest.io.<span class=\"pl-pds\">\"</span></span>\n\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate a PTR record</span>\n <span class=\"pl-ent\">PTR:8.8.8.8</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">8.8.8.8</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>dns.google.<span class=\"pl-pds\">\"</span></span>\n\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> Validate and SRV record</span>\n <span class=\"pl-ent\">SRV:_https._tcp.dnstest.io</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">server</span>: <span class=\"pl-s\">208.67.222.222</span>\n <span class=\"pl-ent\">addrs</span>:\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>0 5 443 a.dnstest.io.<span class=\"pl-pds\">\"</span></span>\n - <span class=\"pl-s\"><span class=\"pl-pds\">\"</span>10 10 443 b.dnstest.io.<span class=\"pl-pds\">\"</span></span></pre><div class=\"zeroclipboard-container position-absolute right-0 top-0\">\n <clipboard-copy aria-label=\"Copy\" class=\"ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay\" data-copy-feedback=\"Copied!\" data-tooltip-direction=\"w\" value=\"dns:\n # Validate a CNAME record\n CNAME:c.dnstest.io:\n resolvable: true\n server: 208.67.222.222\n addrs:\n - "a.dnstest.io."\n\n # Validate a PTR record\n PTR:8.8.8.8:\n resolvable: true\n server: 8.8.8.8\n addrs:\n - "dns.google."\n\n # Validate and SRV record\n SRV:_https._tcp.dnstest.io:\n resolvable: true\n server: 208.67.222.222\n addrs:\n - "0 5 443 a.dnstest.io."\n - "10 10 443 b.dnstest.io."\" tabindex=\"0\" role=\"button\">\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-copy js-clipboard-copy-icon m-2\">\n <path fill-rule=\"evenodd\" d=\"M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z\"></path><path fill-rule=\"evenodd\" d=\"M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z\"></path>\n</svg>\n <svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" data-view-component=\"true\" class=\"octicon octicon-check js-clipboard-check-icon color-fg-success d-none m-2\">\n <path fill-rule=\"evenodd\" d=\"M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z\"></path>\n</svg>\n </clipboard-copy>\n </div></div>\n<p dir=\"auto\">Please note that if you want <code>localhost</code> to <strong>only</strong> resolve <code>127.0.0.1</code> you'll need to use <a href=\"#advanced-matchers\">Advanced Matchers</a></p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">dns</span>:\n <span class=\"pl-ent\">localhost</span>:\n <span class=\"pl-ent\">resolvable</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-ent\">addrs</span>:\n <span class=\"pl-ent\">consist-of</span>: <span class=\"pl-s\">[127.0.0.1]</span>\n <span class=\"pl-ent\">timeout</span>: <span class=\"pl-c1\">500</span> <span class=\"pl-c\"><span class=\"pl-c\">#</span> in milliseconds</span>\n","type":"object","additionalProperties":{"$ref":"#/definitions/dnsTest"}},"port":{"x-intellij-html-description":"<p dir=\"auto\">Validates the state of a local port.</p>\n<p dir=\"auto\"><strong>Note:</strong> Goss might consider your port to be listening on <code>tcp6</code> rather than <code>tcp</code>, try running <code>goss add port ..</code> to see how goss detects it. (<a href=\"https://github.com/goss-org/goss/issues/149\" data-hovercard-type=\"issue\" data-hovercard-url=\"/goss-org/goss/issues/149/hovercard\">explanation</a>)</p>\n<div class=\"highlight highlight-source-yaml notranslate position-relative overflow-auto\" dir=\"auto\"><pre><span class=\"pl-ent\">port</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> {tcp,tcp6,udp,udp6}:port_num</span>\n <span class=\"pl-ent\">tcp:22</span>:\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> required attributes</span>\n <span class=\"pl-ent\">listening</span>: <span class=\"pl-c1\">true</span>\n <span class=\"pl-c\"><span class=\"pl-c\">#</span> optional attributes</span>\n <span class=\"pl-ent\">ip</span>: <span class=\"pl-c\"><span class=\"pl-c\">#</span> what IP(s) is it listening on</span>\n - <span class=\"pl-s\">0.0.0.0</span>\n <span class=\"pl-ent\">skip</span>: <span class=\"pl-c1\">false</span>\n","description":"Validates the state of a local port.\n\nNote: Goss might consider your port to be listening on tcp6 rather than tcp, try running goss add port .. to see how goss detects it. (explanation)\n","type":"object","additionalProperties":{"$ref":"#/definitions/portTest"}}},"description":"A file describing a series of tests","$schema":"http://json-schema.org/draft-07/schema#"} |
sarif-external-property-file-2.1.0.json | {
"$id": "https://json.schemastore.org/sarif-external-property-file-2.1.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"$schema": {
"description": "The URI of the JSON schema corresponding to the version of the external property file format.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this external properties object.",
"enum": ["2.1.0"]
},
"guid": {
"description": "A stable, unique identifer for this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"runGuid": {
"description": "A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"conversion": {
"description": "A conversion object that will be merged with an external run.",
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/conversion"
},
"graphs": {
"description": "An array of graph objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/graph"
}
},
"externalizedProperties": {
"description": "Key/value pairs that provide additional information that will be merged with an external run.",
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/propertyBag"
},
"artifacts": {
"description": "An array of artifact objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/artifact"
}
},
"invocations": {
"description": "Describes the invocation of the analysis tool that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/invocation"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/logicalLocation"
}
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/threadFlowLocation"
}
},
"results": {
"description": "An array of result objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/result"
}
},
"taxonomies": {
"description": "Tool taxonomies that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/toolComponent"
}
},
"driver": {
"description": "The analysis tool object that will be merged with an external run.",
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/toolComponent"
}
},
"policies": {
"description": "Tool policies that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/toolComponent"
}
},
"translations": {
"description": "Tool translations that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses that will be merged with with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/address"
}
},
"webRequests": {
"description": "Requests that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/webRequest"
}
},
"webResponses": {
"description": "Responses that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/webResponse"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external properties.",
"$ref": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json#/definitions/propertyBag"
}
},
"required": ["version"],
"title": "SARIF External Property File Schema Version 2.1.0 JSON Schema",
"type": "object"
}
|
putout.json | {
"$id": "https://json.schemastore.org/putout.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"rule": {
"oneOf": [
{
"description": "🐊Putout rule\n\n\"off\" means rule is off\n\"on\" means it is a on\n",
"enum": ["on", "off"]
},
{
"type": "array",
"items": [
{
"enum": ["on", "off"]
},
{
"type": "object"
}
],
"minItems": 2,
"additionalItems": false
},
{
"type": "array",
"items": [
{
"enum": ["on", "off"]
},
{
"type": "string"
},
{
"type": "object"
}
],
"minItems": 3,
"additionalItems": false
},
{
"type": "array",
"items": [
{
"enum": ["on", "off"]
},
{
"type": "string"
}
],
"minItems": 2,
"additionalItems": false
}
]
},
"rules": {
"description": "🐊Putout comes with a large number of rules. You can modify which rules your project uses.",
"type": "object",
"properties": {
"add-return-await": {
"$ref": "#/definitions/rule"
},
"apply-at": {
"$ref": "#/definitions/rule"
},
"apply-await-import": {
"$ref": "#/definitions/rule"
},
"apply-destructuring": {
"$ref": "#/definitions/rule"
},
"apply-early-return": {
"$ref": "#/definitions/rule"
},
"apply-montag": {
"$ref": "#/definitions/rule"
},
"apply-nullish-coalescing": {
"$ref": "#/definitions/rule"
},
"apply-numeric-separators": {
"$ref": "#/definitions/rule"
},
"apply-optional-chaining": {
"$ref": "#/definitions/rule"
},
"apply-shorthand-properties": {
"$ref": "#/definitions/rule"
},
"apply-try-catch": {
"$ref": "#/definitions/rule"
},
"apply-utility-types": {
"$ref": "#/definitions/rule"
},
"browserlist": {
"$ref": "#/definitions/rule"
},
"cloudcmd": {
"$ref": "#/definitions/rule"
},
"conditions": {
"$ref": "#/definitions/rule"
},
"conditions/apply-comparison-order": {
"$ref": "#/definitions/rule"
},
"conditions/apply-if": {
"$ref": "#/definitions/rule"
},
"conditions/convert-comparison-to-boolean": {
"$ref": "#/definitions/rule"
},
"conditions/convert-equal-to-strict-equal": {
"$ref": "#/definitions/rule"
},
"conditions/evaluate": {
"$ref": "#/definitions/rule"
},
"conditions/simplify": {
"$ref": "#/definitions/rule"
},
"conditions/remove-constant": {
"$ref": "#/definitions/rule"
},
"conditions/remove-boolean": {
"$ref": "#/definitions/rule"
},
"convert-apply-to-spread": {
"$ref": "#/definitions/rule"
},
"convert-arguments-to-rest": {
"$ref": "#/definitions/rule"
},
"convert-array-copy-to-slice": {
"$ref": "#/definitions/rule"
},
"convert-assignment-to-arrow-function": {
"$ref": "#/definitions/rule"
},
"convert-assignment-to-comparison": {
"$ref": "#/definitions/rule"
},
"convert-bitwise-to-logical": {
"$ref": "#/definitions/rule"
},
"convert-commonjs-to-esm": {
"$ref": "#/definitions/rule"
},
"convert-concat-to-flat": {
"$ref": "#/definitions/rule"
},
"convert-esm-to-commonjs": {
"$ref": "#/definitions/rule"
},
"convert-index-of-to-includes": {
"$ref": "#/definitions/rule"
},
"convert-is-nan-to-number-is-nan": {
"$ref": "#/definitions/rule"
},
"convert-math-pow": {
"$ref": "#/definitions/rule"
},
"convert-mock-require-to-mock-import": {
"$ref": "#/definitions/rule"
},
"convert-object-assign-to-merge-spread": {
"$ref": "#/definitions/rule"
},
"convert-quotes-to-backticks": {
"$ref": "#/definitions/rule"
},
"convert-spread-to-array-from": {
"$ref": "#/definitions/rule"
},
"convert-template-to-string": {
"$ref": "#/definitions/rule"
},
"convert-throw": {
"$ref": "#/definitions/rule"
},
"convert-to-arrow-function": {
"$ref": "#/definitions/rule"
},
"declare": {
"$ref": "#/definitions/rule"
},
"eslint": {
"$ref": "#/definitions/rule"
},
"extract-object-properties": {
"$ref": "#/definitions/rule"
},
"extract-sequence-expressions": {
"$ref": "#/definitions/rule"
},
"for-of/for": {
"$ref": "#/definitions/rule"
},
"for-of/for-each": {
"$ref": "#/definitions/rule"
},
"for-of/for-in": {
"$ref": "#/definitions/rule"
},
"for-of/map": {
"$ref": "#/definitions/rule"
},
"for-of/remove-useless": {
"$ref": "#/definitions/rule"
},
"for-of/remove-unused-variables": {
"$ref": "#/definitions/rule"
},
"for-of/remove-useless-array-from": {
"$ref": "#/definitions/rule"
},
"github": {
"$ref": "#/definitions/rule"
},
"gitignore": {
"$ref": "#/definitions/rule"
},
"jest": {
"$ref": "#/definitions/rule"
},
"madrun": {
"$ref": "#/definitions/rule"
},
"maybe": {
"$ref": "#/definitions/rule"
},
"merge-destructuring-properties": {
"$ref": "#/definitions/rule"
},
"merge-duplicate-imports": {
"$ref": "#/definitions/rule"
},
"merge-if-statements": {
"$ref": "#/definitions/rule"
},
"nodejs": {
"$ref": "#/definitions/rule"
},
"nodejs/convert-dirname-to-url": {
"$ref": "#/definitions/rule"
},
"nodejs/convert-fs-promises": {
"$ref": "#/definitions/rule"
},
"nodejs/convert-promisify-to-fs-promises": {
"$ref": "#/definitions/rule"
},
"nodejs/convert-top-level-return": {
"$ref": "#/definitions/rule"
},
"nodejs/remove-process-exit": {
"$ref": "#/definitions/rule"
},
"npmignore": {
"$ref": "#/definitions/rule"
},
"package-json": {
"$ref": "#/definitions/rule"
},
"postcss": {
"$ref": "#/definitions/rule"
},
"promises": {
"$ref": "#/definitions/rule"
},
"promises/add-missing-await": {
"$ref": "#/definitions/rule"
},
"promises/apply-top-level-await": {
"$ref": "#/definitions/rule"
},
"promises/convert-new-promise-to-async": {
"$ref": "#/definitions/rule"
},
"promises/convert-reject-to-throw": {
"$ref": "#/definitions/rule"
},
"promises/remove-useless-async": {
"$ref": "#/definitions/rule"
},
"promises/remove-useless-await": {
"$ref": "#/definitions/rule"
},
"promises/remove-useless-resolve": {
"$ref": "#/definitions/rule"
},
"putout": {
"$ref": "#/definitions/rule"
},
"putout-config": {
"$ref": "#/definitions/rule"
},
"react-hooks": {
"$ref": "#/definitions/rule"
},
"regexp": {
"$ref": "#/definitions/rule"
},
"remove-boolean-from-assertions": {
"$ref": "#/definitions/rule"
},
"remove-boolean-from-logical-expressions": {
"$ref": "#/definitions/rule"
},
"remove-console": {
"$ref": "#/definitions/rule"
},
"remove-debugger": {
"$ref": "#/definitions/rule"
},
"remove-duplicate-case": {
"$ref": "#/definitions/rule"
},
"remove-duplicate-interface-keys": {
"$ref": "#/definitions/rule"
},
"remove-duplicate-keys": {
"$ref": "#/definitions/rule"
},
"remove-duplicates-from-logical-expressions": {
"$ref": "#/definitions/rule"
},
"remove-duplicates-from-union": {
"$ref": "#/definitions/rule"
},
"remove-empty": {
"$ref": "#/definitions/rule"
},
"remove-empty/argument": {
"$ref": "#/definitions/rule"
},
"remove-empty/block": {
"$ref": "#/definitions/rule"
},
"remove-empty/export": {
"$ref": "#/definitions/rule"
},
"remove-empty/import": {
"$ref": "#/definitions/rule"
},
"remove-empty/pattern": {
"$ref": "#/definitions/rule"
},
"remove-iife": {
"$ref": "#/definitions/rule"
},
"remove-nested-blocks": {
"$ref": "#/definitions/rule"
},
"remove-unreachable-code": {
"$ref": "#/definitions/rule"
},
"remove-unreferenced-variables": {
"$ref": "#/definitions/rule"
},
"remove-unused-expressions": {
"$ref": "#/definitions/rule"
},
"remove-unused-private-fields": {
"$ref": "#/definitions/rule"
},
"remove-unused-types": {
"$ref": "#/definitions/rule"
},
"remove-unused-variables": {
"$ref": "#/definitions/rule"
},
"remove-useless-arguments": {
"$ref": "#/definitions/rule"
},
"remove-useless-array-constructor": {
"$ref": "#/definitions/rule"
},
"remove-useless-array-entries": {
"$ref": "#/definitions/rule"
},
"remove-useless-constructor": {
"$ref": "#/definitions/rule"
},
"remove-useless-continue": {
"$ref": "#/definitions/rule"
},
"remove-useless-escape": {
"$ref": "#/definitions/rule"
},
"remove-useless-functions": {
"$ref": "#/definitions/rule"
},
"remove-useless-map": {
"$ref": "#/definitions/rule"
},
"remove-useless-new": {
"$ref": "#/definitions/rule"
},
"remove-useless-operand": {
"$ref": "#/definitions/rule"
},
"remove-useless-return": {
"$ref": "#/definitions/rule"
},
"remove-useless-spread": {
"$ref": "#/definitions/rule"
},
"remove-useless-template-expressions": {
"$ref": "#/definitions/rule"
},
"remove-useless-templates": {
"$ref": "#/definitions/rule"
},
"remove-useless-type-conversion": {
"$ref": "#/definitions/rule"
},
"remove-useless-types-from-constants": {
"$ref": "#/definitions/rule"
},
"remove-useless-variables": {
"$ref": "#/definitions/rule"
},
"reuse-duplicate-init": {
"$ref": "#/definitions/rule"
},
"simplify-assignment": {
"$ref": "#/definitions/rule"
},
"simplify-logical-expressions": {
"$ref": "#/definitions/rule"
},
"simplify-ternary": {
"$ref": "#/definitions/rule"
},
"split-nested-destructuring": {
"$ref": "#/definitions/rule"
},
"split-variable-declarations": {
"$ref": "#/definitions/rule"
},
"strict-mode": {
"$ref": "#/definitions/rule"
},
"tape": {
"$ref": "#/definitions/rule"
},
"tape/remove-only": {
"$ref": "#/definitions/rule"
},
"tape/remove-skip": {
"$ref": "#/definitions/rule"
},
"travis": {
"$ref": "#/definitions/rule"
},
"types": {
"$ref": "#/definitions/rule"
},
"types/convert-typeof-to-is-type": {
"$ref": "#/definitions/rule"
},
"types/remove-useless-conversion": {
"$ref": "#/definitions/rule"
},
"types/remove-double-negations": {
"$ref": "#/definitions/rule"
},
"types/remove-useless-typeof": {
"$ref": "#/definitions/rule"
},
"types/apply-is-array": {
"$ref": "#/definitions/rule"
},
"typescript": {
"$ref": "#/definitions/rule"
},
"typescript/apply-as-type-assertion": {
"$ref": "#/definitions/rule"
},
"typescript/apply-utility-types": {
"$ref": "#/definitions/rule"
},
"typescript/convert-generic-to-shorthand": {
"$ref": "#/definitions/rule"
},
"typescript/remove-duplicate-interface-keys": {
"$ref": "#/definitions/rule"
},
"typescript/remove-duplicates-from-union": {
"$ref": "#/definitions/rule"
},
"typescript/remove-unused-types": {
"$ref": "#/definitions/rule"
},
"typescript/remove-useless-mapped-types": {
"$ref": "#/definitions/rule"
},
"typescript/remove-useless-mapping-modifiers": {
"$ref": "#/definitions/rule"
},
"typescript/remove-useless-types": {
"$ref": "#/definitions/rule"
},
"typescript/remove-useless-types-from-constants": {
"$ref": "#/definitions/rule"
},
"webpack": {
"$ref": "#/definitions/rule"
}
}
}
},
"properties": {
"printer": {
"description": "Tell 🐊Putout which printer to use",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"type": "string"
},
{
"type": "object"
}
]
}
]
},
"parser": {
"description": "Tell 🐊Putout which parser to use",
"type": "string"
},
"formatter": {
"description": "Choose the way to show information about errors found",
"type": ["string", "array"]
},
"processors": {
"description": "Tell 🐊Putout which processors to use to support file types other then JavaScript",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"ignore": {
"description": "Tell 🐊Putout to ignore specific files and directories.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"match": {
"description": "Allows to match rules for files and folders, specified by glob patterns.",
"type": "object",
"patternProperties": {
"^.*$": {
"$ref": "#/definitions/rules"
},
"additionalProperties": false
}
},
"plugins": {
"description": "Tell 🐊Putout which plugins to load",
"type": "array",
"uniqueItems": true
},
"rules": {
"$ref": "#/definitions/rules"
}
},
"type": "object"
}
|
sarif-2.0.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"attachment": {
"description": "A file relevant to a tool invocation or to a result.",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A message describing the role played by the attachment.",
"$ref": "#/definitions/message"
},
"fileLocation": {
"description": "The location of the attachment.",
"$ref": "#/definitions/fileLocation"
},
"regions": {
"description": "An array of regions of interest within the attachment.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/region"
}
},
"rectangles": {
"description": "An array of rectangles specifying areas of interest within the image.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/rectangle"
}
}
},
"required": ["fileLocation"]
},
"codeFlow": {
"description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to the code flow.",
"$ref": "#/definitions/message"
},
"threadFlows": {
"description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/threadFlow"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the code flow.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["threadFlows"]
},
"conversion": {
"description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "A tool object that describes the converter.",
"$ref": "#/definitions/tool"
},
"invocation": {
"description": "An invocation object that describes the invocation of the converter.",
"$ref": "#/definitions/invocation"
},
"analysisToolLogFiles": {
"description": "The locations of the analysis tool's per-run log files.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/fileLocation"
}
}
},
"required": ["tool"]
},
"edge": {
"description": "Represents a directed edge in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the edge within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the edge.",
"$ref": "#/definitions/message"
},
"sourceNodeId": {
"description": "Identifies the source node (the node at which the edge starts).",
"type": "string"
},
"targetNodeId": {
"description": "Identifies the target node (the node at which the edge ends).",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["id", "sourceNodeId", "targetNodeId"]
},
"edgeTraversal": {
"description": "Represents the traversal of a single edge during a graph traversal.",
"type": "object",
"additionalProperties": false,
"properties": {
"edgeId": {
"description": "Identifies the edge being traversed.",
"type": "string"
},
"message": {
"description": "A message to display to the user as the edge is traversed.",
"$ref": "#/definitions/message"
},
"finalState": {
"description": "The values of relevant expressions after the edge has been traversed.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stepOverEdgeCount": {
"description": "The number of edge traversals necessary to return from a nested graph.",
"type": "integer"
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge traversal.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["edgeId"]
},
"exception": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal."
},
"message": {
"type": "string",
"description": "A plain text message that describes the exception."
},
"stack": {
"description": "The sequence of function calls leading to the exception.",
"$ref": "#/definitions/stack"
},
"innerExceptions": {
"type": "array",
"description": "An array of exception objects each of which is considered a cause of this exception.",
"items": {
"$ref": "#/definitions/exception"
}
}
}
},
"externalFiles": {
"description": "References to external files that should be inlined with the content of a root log file.",
"additionalProperties": false,
"type": "object",
"properties": {
"conversion": {
"description": "The location of a file containing a run.conversion object to be merged with the root log file.",
"$ref": "#/definitions/fileLocation"
},
"files": {
"description": "The location of a file containing a run.files object to be merged with the root log file.",
"$ref": "#/definitions/fileLocation"
},
"graphs": {
"description": "The location of a file containing a run.graphs object to be merged with the root log file.",
"$ref": "#/definitions/fileLocation"
},
"invocations": {
"description": "An array of locations of files containing arrays of run.invocation objects to be merged with the root log file.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/fileLocation"
}
},
"logicalLocations": {
"description": "The location of a file containing a run.logicalLocations object to be merged with the root log file.",
"$ref": "#/definitions/fileLocation"
},
"resources": {
"description": "The location of a file containing a run.resources object to be merged with the root log file.",
"$ref": "#/definitions/fileLocation"
},
"results": {
"description": "An array of locations of files containing arrays of run.result objects to be merged with the root log file.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/fileLocation"
}
}
}
},
"file": {
"description": "A single file. In some cases, this file might be nested within another file.",
"additionalProperties": false,
"type": "object",
"properties": {
"fileLocation": {
"description": "The location of the file.",
"$ref": "#/definitions/fileLocation"
},
"parentKey": {
"description": "Identifies the key of the immediate parent of the file, if this file is nested.",
"type": "string"
},
"offset": {
"description": "The offset in bytes of the file within its containing file.",
"type": "integer"
},
"length": {
"description": "The length of the file in bytes.",
"type": "integer"
},
"roles": {
"description": "The role or roles played by the file in the analysis.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"enum": [
"analysisTarget",
"attachment",
"responseFile",
"resultFile",
"standardStream",
"traceFile",
"unmodifiedFile",
"modifiedFile",
"addedFile",
"deletedFile",
"renamedFile",
"uncontrolledFile"
]
}
},
"mimeType": {
"description": "The MIME type (RFC 2045) of the file.",
"type": "string",
"pattern": "[^/]+/.+"
},
"contents": {
"description": "The contents of the file.",
"$ref": "#/definitions/fileContent"
},
"encoding": {
"description": "Specifies the encoding for a file object that refers to a text file.",
"type": "string"
},
"hashes": {
"description": "An array of hash objects, each of which specifies a hashed value for the file, along with the name of the hash function used to compute the hash.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/hash"
}
},
"lastModifiedTime": {
"description": "The date and time at which the file was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"properties": {
"description": "Key/value pairs that provide additional information about the file.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"fileChange": {
"description": "A change to a single file.",
"additionalProperties": false,
"type": "object",
"properties": {
"fileLocation": {
"description": "The location of the file to change.",
"$ref": "#/definitions/fileLocation"
},
"replacements": {
"description": "An array of replacement objects, each of which represents the replacement of a single region in a single file specified by 'fileLocation'.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/replacement"
}
}
},
"required": ["fileLocation", "replacements"]
},
"fileContent": {
"description": "Represents content from an external file.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "UTF-8-encoded content from a text file.",
"type": "string"
},
"binary": {
"description": "MIME Base64-encoded content from a binary file, or from a text file in its original encoding.",
"type": "string"
}
}
},
"fileLocation": {
"description": "Specifies the location of a file.",
"additionalProperties": false,
"type": "object",
"properties": {
"uri": {
"description": "A string containing a valid relative or absolute URI.",
"type": "string",
"format": "uri-reference"
},
"uriBaseId": {
"description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.",
"type": "string"
}
},
"required": ["uri"]
},
"fix": {
"description": "A proposed fix for the problem represented by a result object. A fix specifies a set of file to modify. For each file, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.",
"$ref": "#/definitions/message"
},
"fileChanges": {
"description": "One or more file changes that comprise a fix for a result.",
"type": "array",
"items": {
"$ref": "#/definitions/fileChange"
}
}
},
"required": ["fileChanges"]
},
"graph": {
"description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the graph within a run.graphs or result.graphs array.",
"type": "string"
},
"description": {
"description": "A description of the graph.",
"$ref": "#/definitions/message"
},
"nodes": {
"description": "An array of node objects representing the nodes of the graph.",
"type": "array",
"items": {
"$ref": "#/definitions/node"
}
},
"edges": {
"description": "An array of edge objects representing the edges of the graph.",
"type": "array",
"items": {
"$ref": "#/definitions/edge"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["id", "nodes", "edges"]
},
"graphTraversal": {
"description": "Represents a path through a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"graphId": {
"description": "A string that uniquely identifies that graph being traversed.",
"type": "string"
},
"description": {
"description": "A description of this graph traversal.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the graph traversal.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"edgeTraversals": {
"description": "The sequences of edges traversed by this graph traversal.",
"type": "array",
"items": {
"$ref": "#/definitions/edgeTraversal"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph traversal.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["graphId", "edgeTraversals"]
},
"hash": {
"description": "A hash value of some file or collection of files, together with the hash function used to compute the hash.",
"additionalProperties": false,
"type": "object",
"properties": {
"value": {
"description": "The hash value of some file or collection of files, computed by the hash function named in the 'algorithm' property.",
"type": "string"
},
"algorithm": {
"description": "The name of the hash function used to compute the hash value specified in the 'value' property.",
"type": "string"
}
},
"required": ["value", "algorithm"]
},
"invocation": {
"description": "The runtime environment of the analysis tool run.",
"additionalProperties": false,
"type": "object",
"properties": {
"commandLine": {
"description": "The command line used to invoke the tool.",
"type": "string"
},
"arguments": {
"description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.",
"type": "array",
"items": {
"type": "string"
}
},
"responseFiles": {
"description": "The locations of any response files specified on the tool's command line.",
"type": "array",
"items": {
"$ref": "#/definitions/fileLocation"
}
},
"attachments": {
"description": "A set of files relevant to the invocation of the tool.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/attachment"
}
},
"startTime": {
"description": "The date and time at which the run started. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"endTime": {
"description": "The date and time at which the run ended. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"exitCode": {
"description": "The process exit code.",
"type": "integer"
},
"toolNotifications": {
"description": "A list of runtime conditions detected by the tool during the analysis.",
"type": "array",
"items": {
"$ref": "#/definitions/notification"
}
},
"configurationNotifications": {
"description": "A list of conditions detected by the tool that are relevant to the tool's configuration.",
"type": "array",
"items": {
"$ref": "#/definitions/notification"
}
},
"exitCodeDescription": {
"description": "The reason for the process exit.",
"type": "string"
},
"exitSignalName": {
"description": "The name of the signal that caused the process to exit.",
"type": "string"
},
"exitSignalNumber": {
"description": "The numeric value of the signal that caused the process to exit.",
"type": "integer"
},
"processStartFailureMessage": {
"description": "The reason given by the operating system that the process failed to start.",
"type": "string"
},
"toolExecutionSuccessful": {
"description": "A value indicating whether the tool's execution completed successfully.",
"type": "boolean"
},
"machine": {
"description": "The machine that hosted the analysis tool run.",
"type": "string"
},
"account": {
"description": "The account that ran the analysis tool.",
"type": "string"
},
"processId": {
"description": "The process id for the analysis tool run.",
"type": "integer"
},
"executableLocation": {
"description": "An absolute URI specifying the location of the analysis tool's executable.",
"$ref": "#/definitions/fileLocation"
},
"workingDirectory": {
"description": "The working directory for the analysis tool run.",
"$ref": "#/definitions/fileLocation"
},
"environmentVariables": {
"description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.",
"type": "object",
"additionalProperties": true,
"default": {}
},
"stdin": {
"description": "A file containing the standard input stream to the process that was invoked.",
"$ref": "#/definitions/fileLocation"
},
"stdout": {
"description": "A file containing the standard output stream from the process that was invoked.",
"$ref": "#/definitions/fileLocation"
},
"stderr": {
"description": "A file containing the standard error stream from the process that was invoked.",
"$ref": "#/definitions/fileLocation"
},
"stdoutStderr": {
"description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.",
"$ref": "#/definitions/fileLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the invocation.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"location": {
"description": "A location within a programming artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"physicalLocation": {
"description": "Identifies the file and region.",
"$ref": "#/definitions/physicalLocation"
},
"fullyQualifiedLogicalName": {
"description": "The human-readable fully qualified name of the logical location. If run.logicalLocations is present, this value matches a property name within that object, from which further information about the logical location can be obtained.",
"type": "string"
},
"message": {
"description": "A message relevant to the location.",
"$ref": "#/definitions/message"
},
"annotations": {
"description": "A set of regions relevant to the location.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/region"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the location.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"logicalLocation": {
"description": "A logical location of a construct that produced a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"name": {
"description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.",
"type": "string"
},
"fullyQualifiedName": {
"description": "The human-readable fully qualified name of the logical location.",
"type": "string"
},
"decoratedName": {
"description": "The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.",
"type": "string"
},
"parentKey": {
"description": "Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.",
"type": "string"
},
"kind": {
"description": "The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'parameter', 'resource', 'returnType', 'type', or 'variable', if any of those accurately describe the construct.",
"type": "string"
}
}
},
"message": {
"description": "Encapsulates a message intended to be read by the end user.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string.",
"type": "string"
},
"messageId": {
"description": "The resource id for a plain text message string.",
"type": "string"
},
"richText": {
"description": "A rich text message string.",
"type": "string"
},
"richMessageId": {
"description": "The resource id for a rich text message string.",
"type": "string"
},
"arguments": {
"description": "An array of strings to substitute into the message string.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"node": {
"description": "Represents a node in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the node within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the node.",
"$ref": "#/definitions/message"
},
"location": {
"description": "A code location associated with the node.",
"$ref": "#/definitions/location"
},
"children": {
"description": "Array of child nodes.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/definitions/node"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the node.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["id"]
},
"notification": {
"description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "An identifier for the condition that was encountered.",
"type": "string"
},
"ruleId": {
"description": "The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
"type": "string"
},
"physicalLocation": {
"description": "The file and region relevant to this notification.",
"$ref": "#/definitions/physicalLocation"
},
"message": {
"description": "A message that describes the condition that was encountered.",
"$ref": "#/definitions/message"
},
"level": {
"description": "A value specifying the severity level of the notification.",
"default": "warning",
"enum": ["note", "warning", "error"]
},
"threadId": {
"description": "The thread identifier of the code that generated the notification.",
"type": "integer"
},
"time": {
"description": "The date and time at which the analysis tool generated the notification.",
"type": "string",
"format": "date-time"
},
"exception": {
"description": "The runtime exception, if any, relevant to this notification.",
"$ref": "#/definitions/exception"
},
"properties": {
"description": "Key/value pairs that provide additional information about the notification.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["message"]
},
"physicalLocation": {
"description": "A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Value that distinguishes this physical location from all other physical locations in this run object.",
"type": "integer"
},
"fileLocation": {
"description": "The location of the file.",
"$ref": "#/definitions/fileLocation"
},
"region": {
"description": "Specifies a portion of the file.",
"$ref": "#/definitions/region"
},
"contextRegion": {
"description": "Specifies a portion of the file that encloses the region. Allows a viewer to display additional context around the region.",
"$ref": "#/definitions/region"
}
},
"required": ["fileLocation"]
},
"rectangle": {
"description": "An area within an image.",
"additionalProperties": false,
"type": "object",
"properties": {
"top": {
"description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"left": {
"description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"bottom": {
"description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"right": {
"description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"message": {
"description": "A message relevant to the rectangle.",
"$ref": "#/definitions/message"
}
}
},
"region": {
"description": "A region within a file where a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"startLine": {
"description": "The line number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"startColumn": {
"description": "The column number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"endLine": {
"description": "The line number of the last character in the region.",
"type": "integer",
"minimum": 1
},
"endColumn": {
"description": "The column number of the character following the end of the region.",
"type": "integer",
"minimum": 1
},
"charOffset": {
"description": "The zero-based offset from the beginning of the file of the first character in the region.",
"type": "integer",
"minimum": 0
},
"charLength": {
"description": "The length of the region in characters.",
"type": "integer",
"minimum": 0
},
"byteOffset": {
"description": "The zero-based offset from the beginning of the file of the first byte in the region.",
"type": "integer",
"minimum": 0
},
"byteLength": {
"description": "The length of the region in bytes.",
"type": "integer",
"minimum": 0
},
"snippet": {
"description": "The portion of the file contents within the specified region.",
"$ref": "#/definitions/fileContent"
},
"message": {
"description": "A message relevant to the region.",
"$ref": "#/definitions/message"
}
}
},
"replacement": {
"description": "The replacement of a single region of a file.",
"additionalProperties": false,
"type": "object",
"properties": {
"deletedRegion": {
"description": "The region of the file to delete.",
"$ref": "#/definitions/region"
},
"insertedContent": {
"description": "The content to insert at the location specified by the 'deletedRegion' property.",
"$ref": "#/definitions/fileContent"
}
},
"required": ["deletedRegion"]
},
"resources": {
"description": "Container for items that require localization.",
"type": "object",
"properties": {
"messageStrings": {
"description": "A dictionary, each of whose keys is a resource identifier and each of whose values is a localized string.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"rules": {
"description": "A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/rule"
}
}
}
},
"result": {
"description": "A result produced by an analysis tool.",
"additionalProperties": false,
"type": "object",
"properties": {
"ruleId": {
"description": "The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
"type": "string"
},
"level": {
"description": "A value specifying the severity level of the result.",
"enum": ["notApplicable", "pass", "note", "warning", "error", "open"]
},
"message": {
"description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.",
"$ref": "#/definitions/message"
},
"analysisTarget": {
"description": "Identifies the file that the analysis tool was instructed to scan. This need not be the same as the file where the result actually occurred.",
"$ref": "#/definitions/fileLocation"
},
"locations": {
"description": "One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/location"
}
},
"instanceGuid": {
"description": "A stable, unique identifier for the result in the form of a GUID.",
"type": "string"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.",
"type": "string"
},
"partialFingerprints": {
"description": "A set of strings that contribute to the stable, unique identity of the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fingerprints": {
"description": "A set of strings each of which individually defines a stable, unique identity for the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stacks": {
"description": "An array of 'stack' objects relevant to the result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/stack"
}
},
"codeFlows": {
"description": "An array of 'codeFlow' objects relevant to the result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/codeFlow"
}
},
"graphs": {
"description": "An array of one or more unique 'graph' objects.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/graph"
}
},
"graphTraversals": {
"description": "An array of one or more unique 'graphTraversal' objects.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/graphTraversal"
}
},
"relatedLocations": {
"description": "A set of locations relevant to this result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/location"
}
},
"suppressionStates": {
"description": "A set of flags indicating one or more suppression conditions.",
"type": "array",
"items": {
"enum": ["suppressedInSource", "suppressedExternally"]
}
},
"baselineState": {
"description": "The state of a result relative to a baseline of a previous run.",
"enum": ["new", "existing", "absent"]
},
"attachments": {
"description": "A set of files relevant to the result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/attachment"
}
},
"workItemUris": {
"description": "The URIs of the work items associated with this result",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"format": "uri"
}
},
"conversionProvenance": {
"description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result object.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/physicalLocation"
}
},
"fixes": {
"description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/fix"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"rule": {
"description": "Describes an analysis rule.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "A stable, opaque identifier for the rule.",
"type": "string"
},
"name": {
"description": "A rule identifier that is understandable to an end user.",
"$ref": "#/definitions/message"
},
"shortDescription": {
"description": "A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text.",
"$ref": "#/definitions/message"
},
"fullDescription": {
"description": "A description of the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
"$ref": "#/definitions/message"
},
"messageStrings": {
"description": "A set of name/value pairs with arbitrary names. The value within each name/value pair consists of plain text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"richMessageStrings": {
"description": "A set of name/value pairs with arbitrary names. The value within each name/value pair consists of rich text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"configuration": {
"description": "Information about the rule that can be configured at runtime.",
"$ref": "#/definitions/ruleConfiguration"
},
"helpUri": {
"description": "A URI where the primary documentation for the rule can be found.",
"type": "string",
"format": "uri"
},
"help": {
"description": "Provides the primary documentation for the rule, useful when there is no online documentation.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the rule.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["id"]
},
"ruleConfiguration": {
"description": "Information about a rule that can be configured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Specifies whether the rule will be evaluated during the scan.",
"type": "boolean"
},
"defaultLevel": {
"description": "Specifies the default severity level of the result.",
"default": "warning",
"enum": ["note", "warning", "error", "open"]
},
"parameters": {
"description": "Contains configuration information specific to this rule.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional configuration information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"run": {
"description": "Describes a single run of an analysis tool, and contains the output of that run.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.",
"$ref": "#/definitions/tool"
},
"invocations": {
"description": "Describes the invocation of the analysis tool.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/invocation"
}
},
"conversion": {
"description": "A conversion object that describes how a converter transformed an analysis tool's native output format into the SARIF format.",
"$ref": "#/definitions/conversion"
},
"versionControlProvenance": {
"description": "Specifies the revision in version control of the files that were scanned.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/versionControlDetails"
}
},
"originalUriBaseIds": {
"description": "The absolute URI specified by each uriBaseId symbol on the machine where the tool originally ran.",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uri"
}
},
"files": {
"description": "A dictionary, each of whose keys is a URI and each of whose values is a file object.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/file"
}
},
"logicalLocations": {
"description": "A dictionary, each of whose keys specifies a logical location such as a namespace, type or function.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/logicalLocation"
}
},
"graphs": {
"description": "An array of one or more unique 'graph' objects.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/graph"
}
},
"results": {
"description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/result"
}
},
"resources": {
"description": "Items that can be localized, such as message strings and rule metadata.",
"$ref": "#/definitions/resources"
},
"instanceGuid": {
"description": "A stable, unique identifier for the run, in the form of a GUID.",
"type": "string"
},
"correlationGuid": {
"description": "A stable, unique identifier for the class of related runs to which this run belongs, in the form of a GUID.",
"type": "string"
},
"logicalId": {
"description": "A logical identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same logical id.",
"type": "string"
},
"description": {
"description": "A description of the run.",
"$ref": "#/definitions/message"
},
"automationLogicalId": {
"description": "A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.",
"type": "string"
},
"baselineInstanceGuid": {
"description": "The 'instanceGuid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.",
"type": "string"
},
"architecture": {
"description": "The hardware architecture for which the run was targeted.",
"type": "string"
},
"richMessageMimeType": {
"description": "The MIME type of all rich text message properties in the run. Default: \"text/markdown;variant=GFM\"",
"type": "string",
"default": "text/markdown;variant=GFM"
},
"redactionToken": {
"description": "The string used to replace sensitive information in a redaction-aware property.",
"type": "string"
},
"defaultFileEncoding": {
"description": "Specifies the default encoding for any file object that refers to a text file.",
"type": "string"
},
"columnKind": {
"description": "Specifies the unit in which the tool measures columns.",
"enum": ["utf16CodeUnits", "unicodeCodePoints"]
},
"properties": {
"description": "Key/value pairs that provide additional information about the run.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information about the run.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["tool"]
},
"stack": {
"description": "A call stack that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to this call stack.",
"$ref": "#/definitions/message"
},
"frames": {
"description": "An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/stackFrame"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["frames"]
},
"stackFrame": {
"description": "A function call within a stack trace.",
"additionalProperties": false,
"type": "object",
"properties": {
"location": {
"description": "The location to which this stack frame refers.",
"$ref": "#/definitions/location"
},
"module": {
"description": "The name of the module that contains the code of this stack frame.",
"type": "string"
},
"threadId": {
"description": "The thread identifier of the stack frame.",
"type": "integer"
},
"address": {
"description": "The address of the method or function that is executing.",
"type": "integer"
},
"offset": {
"description": "The offset from the method or function that is executing.",
"type": "integer"
},
"parameters": {
"description": "The parameters of the call that is executing.",
"type": "array",
"items": {
"type": "string",
"default": []
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack frame.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"threadFlow": {
"type": "object",
"properties": {
"id": {
"description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.",
"type": "string"
},
"message": {
"description": "A message relevant to the thread flow.",
"$ref": "#/definitions/message"
},
"locations": {
"description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the thread flow.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["locations"]
},
"threadFlowLocation": {
"description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.",
"additionalProperties": false,
"type": "object",
"properties": {
"step": {
"description": "The 0-based sequence number of the location in the code flow within which it occurs.",
"type": "integer",
"minimum": 0
},
"location": {
"description": "The code location.",
"$ref": "#/definitions/location"
},
"stack": {
"description": "The call stack leading to this location.",
"$ref": "#/definitions/stack"
},
"kind": {
"description": "A string describing the type of this location.",
"type": "string"
},
"module": {
"description": "The name of the module that contains the code that is executing.",
"type": "string"
},
"state": {
"description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.",
"type": "object"
},
"nestingLevel": {
"description": "An integer representing a containment hierarchy within the thread flow",
"type": "integer"
},
"executionOrder": {
"description": "An integer representing the temporal order in which execution reached this location.",
"type": "integer"
},
"timestamp": {
"description": "The time at which this location was executed.",
"type": "string",
"format": "date-time"
},
"importance": {
"description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".",
"enum": ["important", "essential", "unimportant"]
},
"properties": {
"description": "Key/value pairs that provide additional information about the code location.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"tool": {
"description": "The analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"name": {
"description": "The name of the tool.",
"type": "string"
},
"fullName": {
"description": "The name of the tool along with its version and any other useful identifying information, such as its locale.",
"type": "string"
},
"version": {
"description": "The tool version, in whatever format the tool natively provides.",
"type": "string"
},
"semanticVersion": {
"description": "The tool version in the format specified by Semantic Versioning 2.0.",
"type": "string"
},
"fileVersion": {
"description": "The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).",
"type": "string",
"pattern": "[0-9]+(\\.[0-9]+){3}"
},
"downloadUri": {
"description": "The absolute URI from which the tool can be downloaded.",
"type": "string",
"format": "uri"
},
"sarifLoggerVersion": {
"description": "A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.",
"type": "string"
},
"language": {
"description": "The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).",
"type": "string",
"default": "en-US"
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["name"]
},
"versionControlDetails": {
"description": "Specifies the information necessary to retrieve a desired revision from a version control system.",
"type": "object",
"additionalProperties": false,
"properties": {
"uri": {
"description": "The absolute URI of the repository.",
"type": "string",
"format": "uri"
},
"revisionId": {
"description": "A string that uniquely and permanently identifies the revision within the repository.",
"type": "string"
},
"branch": {
"description": "The name of a branch containing the revision.",
"type": "string"
},
"tag": {
"description": "A tag that has been applied to the revision.",
"type": "string"
},
"timestamp": {
"description": "The date and time at which the revision was created.",
"type": "string",
"format": "date-time"
},
"properties": {
"description": "Key/value pairs that provide additional information about the revision.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
},
"required": ["uri"]
}
},
"description": "Static Analysis Results Format (SARIF) Version 2.0.0 JSON Schema: a standard format for the output of static analysis tools.",
"id": "https://json.schemastore.org/sarif-2.0.0.json",
"properties": {
"$schema": {
"description": "The URI of the JSON schema corresponding to the version.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this log file.",
"enum": ["2.0.0"]
},
"runs": {
"description": "The set of runs contained in this log file.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/run"
}
}
},
"required": ["version", "runs"],
"title": "Static Analysis Results Format (SARIF) Version 2.0.0 JSON Schema",
"type": "object"
}
|
sarif-external-property-file-2.1.0-rtm.4.json | {
"$id": "https://json.schemastore.org/sarif-external-property-file-2.1.0-rtm.4.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"$schema": {
"description": "The URI of the JSON schema corresponding to the version of the external property file format.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this external properties object.",
"enum": ["2.1.0"]
},
"guid": {
"description": "A stable, unique identifier for this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"runGuid": {
"description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"conversion": {
"description": "A conversion object that will be merged with an external run.",
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/conversion"
},
"graphs": {
"description": "An array of graph objects that will merged with an external run.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/graph"
}
},
"externalizedProperties": {
"description": "Key/value pairs that provide additional information that will be merged with an external run.",
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/propertyBag"
},
"artifacts": {
"description": "An array of artifact objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/artifact"
}
},
"invocations": {
"description": "Describes the invocation of the analysis tool that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/invocation"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/logicalLocation"
}
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/threadFlowLocation"
}
},
"results": {
"description": "An array of result objects that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/result"
}
},
"taxonomies": {
"description": "Tool taxonomies that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/toolComponent"
}
},
"driver": {
"description": "The analysis tool object that will be merged with an external run.",
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/toolComponent"
}
},
"policies": {
"description": "Tool policies that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/toolComponent"
}
},
"translations": {
"description": "Tool translations that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses that will be merged with with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/address"
}
},
"webRequests": {
"description": "Requests that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/webRequest"
}
},
"webResponses": {
"description": "Responses that will be merged with an external run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/webResponse"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external properties.",
"$ref": "sarif-2.1.0-rtm.4.json#/definitions/propertyBag"
}
},
"required": ["version"],
"title": "SARIF External Property File Schema Version 2.1.0-rtm.4 JSON Schema",
"type": "object"
}
|
minecraft-dimension-type.json | {
"$comment": "https://minecraft.fandom.com/wiki/Custom_dimension#Dimension_type",
"$id": "https://json.schemastore.org/minecraft-dimension-type.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Configuration file defining a dimension type for a data pack for Minecraft.",
"properties": {
"name": {
"title": "Name",
"description": "The resource location used for the dimension type.",
"type": "string"
},
"ultrawarm": {
"title": "Ultrawarm",
"description": "Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also lets stalactites drip lava and causes lava to spread faster and thinner.",
"type": "boolean"
},
"natural": {
"title": "Natural",
"description": "When true, nether portals can spawn zombified piglins. When false, compasses spin randomly, and using a bed to set the respawn point or sleep, is disabled.",
"type": "boolean"
},
"coordinate_scale": {
"title": "Coordinate Scale",
"description": "The multiplier applied to coordinates when traveling to the dimension.",
"type": "number"
},
"has_skylight": {
"title": "Has Skylight",
"description": "Whether the dimension has skylight access or not.",
"type": "boolean"
},
"has_ceiling": {
"title": "Has Ceiling",
"description": "Whether the dimension has a bedrock ceiling or not.",
"type": "boolean"
},
"ambient_light": {
"title": "Ambient Light",
"description": "How much light the dimension has.",
"type": "number",
"default": 0.5
},
"fixed_time": {
"title": "Fixed Time",
"description": "If this is set to a number, the time of the day is the specified value.",
"anyOf": [
{
"type": "boolean",
"default": false
},
{
"type": "integer",
"minimum": 0,
"maximum": 24000
}
]
},
"piglin_safe": {
"title": "Piglin Safe",
"description": "Whether piglins shake and transform to zombified piglins.",
"type": "boolean"
},
"bed_works": {
"title": "Bed Words",
"description": "When false, the bed blows up when trying to sleep.",
"type": "boolean"
},
"respawn_anchor_works": {
"title": "Respawn Anchor Works",
"description": "Whether players can charge and use respawn anchors.",
"type": "boolean"
},
"has_raids": {
"title": "Has Raids",
"description": "Whether players with the Bad Omen effect can cause a raid.",
"type": "boolean"
},
"logical_height": {
"title": "Logical Height",
"description": "The maximum height to which chorus fruits and nether portals can bring players within this dimension. This excludes portals that were already built above the limit as they still connect normally.",
"type": "integer"
},
"min_y": {
"title": "Minimum Y",
"description": "The minimum height in which blocks can exist within this dimension.",
"type": "integer",
"minimum": -2032,
"maximum": 2031,
"multipleOf": 16
},
"height": {
"title": "Height",
"description": "The total height in which blocks can exist within this dimension.",
"type": "integer",
"minimum": 0,
"maximum": 4096,
"multipleOf": 16
},
"infiniburn": {
"title": "Infiniburn",
"description": "A resource location defining what block tag to use for infiniburn.",
"type": "string"
},
"effects": {
"title": "Effects",
"description": "Determines the dimension effect used for this dimension.",
"type": "string",
"enum": [
"minecraft:overworld",
"minecraft:the_nether",
"minecraft:the_end"
],
"default": "minecraft:overworld"
}
},
"title": "Minecraft Data Pack Dimension Type",
"type": "object"
}
|
azure-iot-edgeagent-deployment-1.1.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"moduleType": {
"enum": ["docker"]
},
"status": {
"enum": ["running", "stopped"]
},
"restartPolicy": {
"enum": ["never", "on-failure", "on-unhealthy", "always"]
},
"imagePullPolicy": {
"enum": ["never", "on-create"]
},
"startupOrder": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"moduleSettings": {
"type": "object",
"required": ["image"],
"properties": {
"image": {
"type": "string",
"examples": ["mcr.microsoft.com/azureiotedge-agent:1.0"]
}
},
"patternProperties": {
"^(createoptions|createOptions)[0-9]*$": {
"$ref": "#/definitions/createOptions"
}
},
"additionalProperties": false
},
"env": {
"type": "object",
"patternProperties": {
"^[^\\+#$\\s\\.]+$": {
"type": "object",
"required": ["value"],
"properties": {
"value": {
"type": ["number", "string", "boolean"]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"createOptions": {
"type": "string",
"contentMediaType": "application/json"
}
},
"id": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json",
"properties": {
"$edgeAgent": {
"type": "object",
"title": "Configuration for the edgeAgent module",
"required": ["properties.desired"],
"properties": {
"properties.desired": {
"type": "object",
"required": ["schemaVersion", "runtime", "systemModules", "modules"],
"properties": {
"schemaVersion": {
"type": "string",
"pattern": "1.1"
},
"runtime": {
"type": "object",
"required": ["type", "settings"],
"properties": {
"type": {
"$ref": "#/definitions/moduleType"
},
"settings": {
"type": "object",
"properties": {
"minDockerVersion": {
"type": "string",
"examples": ["v1.25"]
},
"loggingOptions": {
"type": "string"
},
"registryCredentials": {
"type": "object",
"patternProperties": {
"^[^\\.\\$# ]+$": {
"type": "object",
"required": ["username", "password", "address"],
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"address": {
"type": "string",
"pattern": "^[^\\s]+$"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"systemModules": {
"type": "object",
"required": ["edgeAgent", "edgeHub"],
"properties": {
"edgeAgent": {
"type": "object",
"required": ["type", "settings"],
"properties": {
"type": {
"$ref": "#/definitions/moduleType"
},
"settings": {
"$ref": "#/definitions/moduleSettings"
},
"env": {
"$ref": "#/definitions/env"
},
"imagePullPolicy": {
"$ref": "#/definitions/imagePullPolicy"
}
},
"additionalProperties": false
},
"edgeHub": {
"type": "object",
"title": "The Edgehub Schema",
"required": ["type", "settings", "status", "restartPolicy"],
"properties": {
"type": {
"$ref": "#/definitions/moduleType"
},
"settings": {
"$ref": "#/definitions/moduleSettings"
},
"env": {
"$ref": "#/definitions/env"
},
"status": {
"$ref": "#/definitions/status"
},
"restartPolicy": {
"$ref": "#/definitions/restartPolicy"
},
"imagePullPolicy": {
"$ref": "#/definitions/imagePullPolicy"
},
"startupOrder": {
"$ref": "#/definitions/startupOrder"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"modules": {
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["type", "status", "restartPolicy", "settings"],
"properties": {
"version": {
"type": "string",
"examples": ["1.0"]
},
"type": {
"$ref": "#/definitions/moduleType"
},
"status": {
"$ref": "#/definitions/status"
},
"restartPolicy": {
"$ref": "#/definitions/restartPolicy"
},
"env": {
"$ref": "#/definitions/env"
},
"settings": {
"$ref": "#/definitions/moduleSettings"
},
"imagePullPolicy": {
"$ref": "#/definitions/imagePullPolicy"
},
"startupOrder": {
"$ref": "#/definitions/startupOrder"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": ["$edgeAgent"],
"title": "JSON schema for Azure IoT EdgeAgent Deployment version 1.1",
"type": "object"
}
|
chart-lock.json | {
"$id": "https://json.schemastore.org/chart-lock.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"generated": {
"description": "Generated is the date the lock file was last generated.",
"type": "string",
"format": "date-time"
},
"digest": {
"description": "Digest is a hash of the dependencies in Chart.yaml.",
"type": "string"
},
"dependencies": {
"type": "array",
"description": "In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually.\nThe charts required by the current chart are defined as a list in the dependencies field.",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["name", "version", "repository"],
"properties": {
"name": {
"description": "The name of the chart",
"type": "string"
},
"version": {
"description": "The version of the chart",
"type": "string"
},
"repository": {
"description": "The repository URL or alias",
"type": "string",
"format": "uri"
}
}
}
}
},
"required": ["generated", "digest", "dependencies"],
"title": "Helm Chart.lock",
"type": "object"
}
|
stylelintrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"allRules": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/atRule"
},
{
"$ref": "#/definitions/block"
},
{
"$ref": "#/definitions/color"
},
{
"$ref": "#/definitions/comment"
},
{
"$ref": "#/definitions/customMedia"
},
{
"$ref": "#/definitions/customProperty"
},
{
"$ref": "#/definitions/declaration"
},
{
"$ref": "#/definitions/declarationBlock"
},
{
"$ref": "#/definitions/font"
},
{
"$ref": "#/definitions/function"
},
{
"$ref": "#/definitions/generalSheet"
},
{
"$ref": "#/definitions/keyframeDeclaration"
},
{
"$ref": "#/definitions/length"
},
{
"$ref": "#/definitions/mediaFeature"
},
{
"$ref": "#/definitions/mediaQueryList"
},
{
"$ref": "#/definitions/number"
},
{
"$ref": "#/definitions/property"
},
{
"$ref": "#/definitions/rootRule"
},
{
"$ref": "#/definitions/rule"
},
{
"$ref": "#/definitions/selector"
},
{
"$ref": "#/definitions/selectorList"
},
{
"$ref": "#/definitions/shorthandProperty"
},
{
"$ref": "#/definitions/string"
},
{
"$ref": "#/definitions/stylelintDisableComment"
},
{
"$ref": "#/definitions/time"
},
{
"$ref": "#/definitions/unit"
},
{
"$ref": "#/definitions/value"
},
{
"$ref": "#/definitions/valueList"
}
]
},
"alwaysMultiLineRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "always-multi-line", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "always-multi-line", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"alwaysNeverRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "never", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"arrayStringRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": ["null", "string"]
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": ["string", "array", "object"],
"anyOf": [
{
"type": "string",
"enum": [[], {}]
},
{
"$ref": "#/definitions/simpleArrayStringRule"
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"booleanRule": {
"default": true,
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"coreRule": {
"properties": {
"disableFix": {
"type": "boolean"
},
"message": {
"description": "Custom message that will be used in errors and warnings",
"type": "string"
},
"reportDisables": {
"type": "boolean"
},
"severity": {
"description": "Message status",
"type": "string",
"enum": ["warning", "error"]
}
}
},
"integerRule": {
"type": ["null", "integer", "array"],
"oneOf": [
{
"type": ["null", "integer"]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["integer", "object"],
"anyOf": [
{
"type": "integer",
"enum": [{}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"lowerUpperRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["lower", "upper", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["lower", "upper", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"newlineRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "always-multi-line", "never-multi-line", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "always-multi-line", "never-multi-line", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"newlineSpaceRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always",
"never",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
{}
]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"newlineSpaceWithIgnoreRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always",
"never",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
{}
]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreAtRules": {
"$ref": "#/definitions/simpleStringOrArrayStringRule"
}
}
}
]
}
}
]
},
"objectRule": {
"type": ["null", "object", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"patternProperties": {
".*": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["object"],
"anyOf": [
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"patternProperties": {
"^((?!message|severity).)*$": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"simpleArrayStringRule": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"simpleStringOrArrayStringRule": {
"type": ["string", "array"],
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/simpleArrayStringRule"
}
]
},
"singleDoubleRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["single", "double", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["single", "double", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"spaceRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always",
"never",
"always-single-line",
"never-single-line",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never",
"always-single-line",
"never-single-line",
{}
]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"stringRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": ["null", "string"]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [{}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"unitRule": {
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"em",
"ex",
"px",
"%",
"rem",
"vw",
"vh",
"vm",
"vmin",
"vmax",
"ch",
"in",
"cm",
"mm",
"q",
"pt",
"pc",
"deg",
"grad",
"rad",
"turn",
"ms",
"s",
"Hz",
"kHz",
"dpi",
"dpcm",
"dppx",
"fr",
[]
]
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": ["string", "array", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"em",
"ex",
"px",
"%",
"rem",
"vw",
"vh",
"vm",
"vmin",
"vmax",
"ch",
"in",
"cm",
"mm",
"q",
"pt",
"pc",
"deg",
"grad",
"rad",
"turn",
"ms",
"s",
"Hz",
"kHz",
"dpi",
"dpcm",
"dppx",
"fr",
[],
{}
]
},
{
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"em",
"ex",
"px",
"%",
"rem",
"vw",
"vh",
"vm",
"vmin",
"vmax",
"ch",
"in",
"cm",
"mm",
"q",
"pt",
"pc",
"deg",
"grad",
"rad",
"turn",
"ms",
"s",
"Hz",
"kHz",
"dpi",
"dpcm",
"dppx",
"fr"
]
}
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreProperties": {
"description": "Ignore units in the values of declarations with the specified properties",
"type": "object",
"patternProperties": {
"(em|ex|ch|vw|vh|cm|mm|in|pt|pc|px|rem|vmin|vmax|%)": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
}
}
]
}
}
]
},
"atRule": {
"properties": {
"at-rule-blacklist": {
"description": "Specify a blacklist of disallowed at-rules",
"$ref": "#/definitions/arrayStringRule"
},
"at-rule-empty-line-before": {
"description": "Require or disallow an empty line before at-rules",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "never", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"except": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"after-same-name",
"inside-block",
"blockless-after-same-name-blockless",
"blockless-after-blockless",
"first-nested"
]
}
},
"ignore": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"after-comment",
"first-nested",
"inside-block",
"blockless-after-same-name-blockless",
"blockless-after-blockless"
]
}
},
"ignoreAtRules": {
"$ref": "#/definitions/simpleStringOrArrayStringRule"
}
}
}
]
}
}
]
},
"at-rule-name-case": {
"description": "Specify lowercase or uppercase for at-rules names",
"$ref": "#/definitions/lowerUpperRule"
},
"at-rule-name-newline-after": {
"description": "Require a newline after at-rule names",
"$ref": "#/definitions/alwaysMultiLineRule"
},
"at-rule-name-space-after": {
"description": "Require a single space after at-rule names",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "always-single-line", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "always-single-line", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"at-rule-no-unknown": {
"description": "Disallow unknown at-rules",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreAtRules": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"at-rule-no-vendor-prefix": {
"description": "Disallow vendor prefixes for at-rules",
"$ref": "#/definitions/booleanRule"
},
"at-rule-semicolon-newline-after": {
"description": "Require a newline after the semicolon of at-rules",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"at-rule-whitelist": {
"description": "Specify a whitelist of allowed at-rules",
"$ref": "#/definitions/arrayStringRule"
}
}
},
"block": {
"properties": {
"block-closing-brace-empty-line-before": {
"description": "Require or disallow an empty line before the closing brace of blocks",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always-multi-line", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always-multi-line", "never", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"block-closing-brace-newline-after": {
"description": "Require a newline or disallow whitespace after the closing brace of blocks",
"$ref": "#/definitions/newlineSpaceWithIgnoreRule"
},
"block-closing-brace-newline-before": {
"description": "Require a newline or disallow whitespace before the closing brace of blocks",
"$ref": "#/definitions/newlineRule"
},
"block-closing-brace-space-after": {
"description": "Require a single space or disallow whitespace after the closing brace of blocks",
"$ref": "#/definitions/newlineSpaceRule"
},
"block-closing-brace-space-before": {
"description": "Require a single space or disallow whitespace before the closing brace of blocks",
"$ref": "#/definitions/newlineSpaceRule"
},
"block-no-empty": {
"description": "Disallow empty blocks",
"$ref": "#/definitions/booleanRule"
},
"block-no-single-line": {
"description": "Disallow single-line blocks",
"$ref": "#/definitions/booleanRule"
},
"block-opening-brace-newline-after": {
"description": "Require a newline after the opening brace of blocks",
"$ref": "#/definitions/newlineRule"
},
"block-opening-brace-newline-before": {
"description": "Require a newline or disallow whitespace before the opening brace of blocks",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
{}
]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"block-opening-brace-space-after": {
"description": "Require a single space or disallow whitespace after the opening brace of blocks",
"$ref": "#/definitions/newlineSpaceRule"
},
"block-opening-brace-space-before": {
"description": "Require a single space or disallow whitespace before the opening brace of blocks",
"$ref": "#/definitions/newlineSpaceWithIgnoreRule"
}
}
},
"color": {
"properties": {
"color-hex-case": {
"description": "Specify lowercase or uppercase for hex colors",
"$ref": "#/definitions/lowerUpperRule"
},
"color-hex-length": {
"description": "Specify short or long notation for hex colors",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["short", "long", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["short", "long", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"color-named": {
"description": "Require (where possible) or disallow named colors",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always-where-possible", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always-where-possible", "never", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"color-no-hex": {
"description": "Disallow hex colors",
"$ref": "#/definitions/booleanRule"
},
"color-no-invalid-hex": {
"description": "Disallow invalid hex colors",
"$ref": "#/definitions/booleanRule"
}
}
},
"comment": {
"properties": {
"comment-empty-line-before": {
"description": "Require or disallow an empty line before comments",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "never", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"except": {
"description": "Reverse the primary option for comments that are nested and the first child of their parent node",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["first-nested"]
}
},
"ignore": {
"description": "Don't require an empty line between comments",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"between-comments",
"after-comment",
"stylelint-commands"
]
}
}
}
}
]
}
}
]
},
"comment-no-empty": {
"description": "Disallow empty comments",
"$ref": "#/definitions/booleanRule"
},
"comment-whitespace-inside": {
"description": "Require or disallow whitespace on the inside of comment markers",
"$ref": "#/definitions/alwaysNeverRule"
},
"comment-word-blacklist": {
"description": "Specify a blacklist of disallowed words within comments",
"$ref": "#/definitions/arrayStringRule"
}
}
},
"customMedia": {
"properties": {
"custom-media-pattern": {
"description": "Specify a pattern for custom media query names",
"$ref": "#/definitions/stringRule"
}
}
},
"customProperty": {
"properties": {
"custom-property-empty-line-before": {
"description": "Require or disallow an empty line before custom properties",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "never", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"except": {
"description": "Reverse the primary option for custom properties that come after a comment, custom property or first child of their parent node",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"after-comment",
"after-custom-property",
"first-nested"
]
}
},
"ignore": {
"description": "Ignore custom properties that are preceded by comments or inside single-line blocks",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["after-comment", "inside-single-line-block"]
}
}
}
}
]
}
}
]
},
"custom-property-no-outside-root": {
"description": "Disallow custom properties outside of `:root` rules",
"$ref": "#/definitions/booleanRule"
},
"custom-property-pattern": {
"description": "Specify a pattern for custom properties",
"$ref": "#/definitions/stringRule"
}
}
},
"declaration": {
"properties": {
"declaration-bang-space-after": {
"description": "Require a single space or disallow whitespace after the bang of declarations",
"$ref": "#/definitions/alwaysNeverRule"
},
"declaration-bang-space-before": {
"description": "Require a single space or disallow whitespace before the bang of declarations",
"$ref": "#/definitions/alwaysNeverRule"
},
"declaration-colon-newline-after": {
"description": "Require a newline or disallow whitespace after the colon of declarations",
"$ref": "#/definitions/alwaysMultiLineRule"
},
"declaration-colon-space-after": {
"description": "Require a single space or disallow whitespace after the colon of declarations",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "never", "always-single-line", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "never", "always-single-line", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"declaration-colon-space-before": {
"description": "Require a single space or disallow whitespace before the colon of declarations",
"$ref": "#/definitions/alwaysNeverRule"
},
"declaration-empty-line-before": {
"description": "Require or disallow an empty line before declarations",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always", "never", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always", "never", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"except": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"after-comment",
"after-declaration",
"first-nested"
]
}
},
"ignore": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"after-comment",
"after-declaration",
"inside-single-line-block"
]
}
}
}
}
]
}
}
]
},
"declaration-no-important": {
"description": "Disallow `!important` within declarations",
"$ref": "#/definitions/booleanRule"
},
"declaration-property-unit-blacklist": {
"description": "Specify a blacklist of disallowed property and unit pairs within declarations",
"$ref": "#/definitions/objectRule"
},
"declaration-property-unit-whitelist": {
"description": "Specify a whitelist of allowed property and unit pairs within declarations",
"$ref": "#/definitions/objectRule"
},
"declaration-property-value-blacklist": {
"description": "Specify a blacklist of disallowed property and value pairs within declarations",
"$ref": "#/definitions/objectRule"
},
"declaration-property-value-whitelist": {
"description": "Specify a whitelist of allowed property and value pairs within declarations",
"$ref": "#/definitions/objectRule"
}
}
},
"declarationBlock": {
"properties": {
"declaration-block-no-duplicate-properties": {
"description": "Disallow duplicate properties within declaration blocks",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"consecutive-duplicates",
"consecutive-duplicates-with-different-values",
"consecutive-duplicates-with-different-syntaxes",
"consecutive-duplicates-with-same-prefixless-values"
]
}
},
"ignoreProperties": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"declaration-block-no-ignored-properties": {
"description": "Disallow property values that are ignored due to another property value in the same rule",
"$ref": "#/definitions/booleanRule"
},
"declaration-block-no-redundant-longhand-properties": {
"description": "Disallow longhand properties that can be combined into one shorthand property",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreShorthands": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"declaration-block-no-shorthand-property-overrides": {
"description": "Disallow shorthand properties that override related longhand properties",
"$ref": "#/definitions/booleanRule"
},
"declaration-block-properties-order": {
"description": "Specify the order of properties within declaration blocks",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["alphabetical", []]
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": ["string", "array", "object"],
"anyOf": [
{
"type": "string",
"enum": ["alphabetical", [], {}]
},
{
"type": "string"
},
{
"$ref": "#/definitions/simpleArrayStringRule"
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"dependencies": {
"order": ["properties"],
"properties": ["order"]
},
"properties": {
"unspecified": {
"description": "These options only apply if you've defined your own array of properties",
"type": "string",
"enum": [
"top",
"bottom",
"bottomAlphabetical",
"ignore"
]
},
"order": {
"type": "string",
"enum": ["strict", "flexible"]
},
"properties": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"declaration-block-semicolon-newline-after": {
"description": "Require a newline or disallow whitespace after the semicolons of declaration blocks",
"$ref": "#/definitions/newlineRule"
},
"declaration-block-semicolon-newline-before": {
"description": "Require a newline or disallow whitespace before the semicolons of declaration blocks",
"$ref": "#/definitions/newlineRule"
},
"declaration-block-semicolon-space-after": {
"description": "Require a single space or disallow whitespace after the semicolons of declaration blocks",
"$ref": "#/definitions/spaceRule"
},
"declaration-block-semicolon-space-before": {
"description": "Require a single space or disallow whitespace before the semicolons of declaration blocks",
"$ref": "#/definitions/spaceRule"
},
"declaration-block-single-line-max-declarations": {
"description": "Limit the number of declaration within a single line declaration block",
"$ref": "#/definitions/integerRule"
},
"declaration-block-trailing-semicolon": {
"description": "Require or disallow a trailing semicolon within declaration blocks",
"$ref": "#/definitions/alwaysNeverRule"
}
}
},
"font": {
"properties": {
"font-family-name-quotes": {
"description": "Specify whether or not quotation marks should be used around font family names",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always-where-required",
"always-where-recommended",
"always-unless-keyword",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always-where-required",
"always-where-recommended",
"always-unless-keyword",
{}
]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
},
"font-weight-notation": {
"description": "Require numeric or named (where possible) `font-weight` values. Also, when named values are expected, require only valid names",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["numeric", "named-where-possible", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["numeric", "named-where-possible", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["relative"]
}
}
}
}
]
}
}
]
}
}
},
"function": {
"properties": {
"function-blacklist": {
"description": "Specify a blacklist of disallowed functions",
"$ref": "#/definitions/arrayStringRule"
},
"function-calc-no-unspaced-operator": {
"description": "Disallow an unspaced operator within `calc` functions",
"$ref": "#/definitions/booleanRule"
},
"function-comma-newline-after": {
"description": "Require a newline or disallow whitespace after the commas of functions",
"$ref": "#/definitions/newlineRule"
},
"function-comma-newline-before": {
"description": "Require a newline or disallow whitespace before the commas of functions",
"$ref": "#/definitions/newlineRule"
},
"function-comma-space-after": {
"description": "Require a single space or disallow whitespace after the commas of functions",
"$ref": "#/definitions/spaceRule"
},
"function-comma-space-before": {
"description": "Require a single space or disallow whitespace before the commas of functions",
"$ref": "#/definitions/spaceRule"
},
"function-linear-gradient-no-nonstandard-direction": {
"description": "Disallow direction values in `linear-gradient()` calls that are not valid according to the standard syntax",
"$ref": "#/definitions/booleanRule"
},
"function-max-empty-lines": {
"description": "Limit the number of adjacent empty lines within functions",
"$ref": "#/definitions/integerRule"
},
"function-name-case": {
"description": "Specify lowercase or uppercase for function names",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["lower", "upper", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["lower", "upper", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"description": "Ignore case of function names",
"properties": {
"ignoreFunctions": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"function-parentheses-newline-inside": {
"description": "Require a newline or disallow whitespace on the inside of the parentheses of functions",
"$ref": "#/definitions/newlineRule"
},
"function-parentheses-space-inside": {
"description": "Require a single space or disallow whitespace on the inside of the parentheses of functions",
"$ref": "#/definitions/spaceRule"
},
"function-url-data-uris": {
"description": "Require or disallow data URIs for urls",
"$ref": "#/definitions/alwaysNeverRule"
},
"function-url-no-scheme-relative": {
"description": "Disallow scheme-relative urls",
"$ref": "#/definitions/booleanRule"
},
"function-url-quotes": {
"description": "Require or disallow quotes for urls",
"$ref": "#/definitions/alwaysNeverRule"
},
"function-url-scheme-whitelist": {
"description": "Specify a whitelist of allowed url schemes",
"$ref": "#/definitions/arrayStringRule"
},
"function-whitelist": {
"description": "Specify a whitelist of allowed functions",
"$ref": "#/definitions/arrayStringRule"
},
"function-whitespace-after": {
"description": "Require or disallow whitespace after functions",
"$ref": "#/definitions/alwaysNeverRule"
}
}
},
"generalSheet": {
"properties": {
"indentation": {
"description": "Specify indentation",
"type": ["null", "integer", "string", "array"],
"oneOf": [
{
"type": ["null", "integer"]
},
{
"type": "string",
"enum": ["tab", []]
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "integer"
}
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["integer", "string", "object"],
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": ["tab", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"indentInsideParens": {
"description": "If `true`, the closing brace of a block (rule or at-rule) will be expected at the same indentation level as the block's inner nodes",
"type": "string",
"enum": ["twice", "once-at-root-twice-in-block"]
},
"except": {
"description": "Do not indent for these things",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["block", "param", "value"]
}
},
"ignore": {
"description": "Ignore the indentation inside parentheses",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["inside-parens", "param", "value"]
}
}
}
}
]
}
}
]
},
"max-empty-lines": {
"description": "Limit the number of adjacent empty lines",
"$ref": "#/definitions/integerRule"
},
"max-line-length": {
"description": "Limit the length of a line",
"type": ["null", "integer", "array"],
"oneOf": [
{
"type": ["null", "integer"]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["integer", "object"],
"anyOf": [
{
"type": "integer"
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": ["string", "array"],
"anyOf": [
{
"type": "string",
"enum": ["non-comments", "comments"]
},
{
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["non-comments", "comments"]
}
}
]
}
}
}
]
}
}
]
},
"max-nesting-depth": {
"description": "Limit the allowed nesting depth",
"type": ["null", "integer", "array"],
"oneOf": [
{
"type": ["null", "integer"]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["integer", "object"],
"anyOf": [
{
"type": "integer"
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["blockless-at-rules", "pseudo-classes"]
}
},
"ignoreAtRules": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"no-browser-hacks": {
"description": "Disallow browser hacks that are irrelevant to the browsers you are targeting",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"browsers": {
"$ref": "#/definitions/simpleStringOrArrayStringRule"
}
}
}
]
}
}
]
},
"no-descending-specificity": {
"description": "Disallow selectors of lower specificity from coming after overriding selectors of higher specificity",
"$ref": "#/definitions/booleanRule"
},
"no-duplicate-selectors": {
"description": "Disallow duplicate selectors within a stylesheet",
"$ref": "#/definitions/booleanRule"
},
"no-empty-source": {
"description": "Disallow empty sources",
"$ref": "#/definitions/booleanRule"
},
"no-eol-whitespace": {
"description": "Disallow end-of-line whitespace",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["empty-lines"]
}
}
}
}
]
}
}
]
},
"no-extra-semicolons": {
"description": "Disallow extra semicolons",
"$ref": "#/definitions/booleanRule"
},
"no-indistinguishable-colors": {
"description": "Disallow colors that are suspiciously close to being identical",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"threshold": {
"type": "integer",
"default": 3,
"minimum": 0,
"maximum": 100
},
"ignore": {
"$ref": "#/definitions/simpleArrayStringRule"
},
"whitelist": {
"description": "An array of color pairs to ignore. Each pair is an array with two items",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
}
]
}
}
]
},
"no-invalid-double-slash-comments": {
"description": "Disallow double-slash comments `(//...)` which are not supported by CSS and could lead to unexpected results",
"$ref": "#/definitions/booleanRule"
},
"no-missing-end-of-source-newline": {
"description": "Disallow missing end-of-source newlines",
"$ref": "#/definitions/booleanRule"
},
"no-unknown-animations": {
"description": "Disallow animation names that do not correspond to a `@keyframes` declaration",
"$ref": "#/definitions/booleanRule"
},
"unicode-bom": {
"description": "Require or disallow Unicode BOM",
"$ref": "#/definitions/alwaysNeverRule"
},
"no-unsupported-browser-features": {
"description": "Disallow features that are unsupported by the browsers that you are targeting",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"browsers": {
"type": "string"
},
"ignore": {
"$ref": "#/definitions/simpleStringOrArrayStringRule"
}
}
}
]
}
}
]
}
}
},
"keyframeDeclaration": {
"properties": {
"keyframe-declaration-no-important": {
"description": "Disallow !important within keyframe declarations",
"$ref": "#/definitions/booleanRule"
}
}
},
"length": {
"properties": {
"length-zero-no-unit": {
"description": "Disallow units for zero lengths",
"$ref": "#/definitions/booleanRule"
}
}
},
"mediaFeature": {
"properties": {
"media-feature-colon-space-after": {
"description": "Require a single space or disallow whitespace after the colon in media features",
"$ref": "#/definitions/alwaysNeverRule"
},
"media-feature-colon-space-before": {
"description": "Require a single space or disallow whitespace before the colon in media features",
"$ref": "#/definitions/alwaysNeverRule"
},
"media-feature-name-case": {
"description": "Specify lowercase or uppercase for media feature names",
"$ref": "#/definitions/lowerUpperRule"
},
"media-feature-name-no-unknown": {
"description": "Disallow unknown media feature names",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreMediaFeatureNames": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"media-feature-name-no-vendor-prefix": {
"description": "Disallow vendor prefixes for media feature names",
"$ref": "#/definitions/booleanRule"
},
"media-feature-no-missing-punctuation": {
"description": "Disallow missing punctuation for non-boolean media features",
"$ref": "#/definitions/booleanRule"
},
"media-feature-parentheses-space-inside": {
"description": "Require a single space or disallow whitespace on the inside of the parentheses within media features",
"$ref": "#/definitions/alwaysNeverRule"
},
"media-feature-range-operator-space-after": {
"description": "Require a single space or disallow whitespace after the range operator in media features",
"$ref": "#/definitions/alwaysNeverRule"
},
"media-feature-range-operator-space-before": {
"description": "Require a single space or disallow whitespace before the range operator in media features",
"$ref": "#/definitions/alwaysNeverRule"
}
}
},
"mediaQueryList": {
"properties": {
"media-query-list-comma-newline-after": {
"description": "Require a newline or disallow whitespace after the commas of media query lists",
"$ref": "#/definitions/newlineRule"
},
"media-query-list-comma-newline-before": {
"description": "Require a newline or disallow whitespace before the commas of media query lists",
"$ref": "#/definitions/newlineRule"
},
"media-query-list-comma-space-after": {
"description": "Require a single space or disallow whitespace after the commas of media query lists",
"$ref": "#/definitions/spaceRule"
},
"media-query-list-comma-space-before": {
"description": "Require a single space or disallow whitespace before the commas of media query lists",
"$ref": "#/definitions/spaceRule"
}
}
},
"number": {
"properties": {
"number-leading-zero": {
"description": "Require or disallow a leading zero for fractional numbers less than 1",
"$ref": "#/definitions/alwaysNeverRule"
},
"number-max-precision": {
"description": "Limit the number of decimal places allowed in numbers",
"$ref": "#/definitions/integerRule"
},
"number-no-trailing-zeros": {
"description": "Disallow trailing zeros in numbers",
"$ref": "#/definitions/booleanRule"
}
}
},
"property": {
"properties": {
"property-blacklist": {
"description": "Specify a blacklist of disallowed properties",
"$ref": "#/definitions/arrayStringRule"
},
"property-case": {
"description": "Specify lowercase or uppercase for properties",
"$ref": "#/definitions/lowerUpperRule"
},
"property-no-unknown": {
"description": "Disallow unknown properties",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreProperties": {
"$ref": "#/definitions/simpleArrayStringRule"
},
"checkPrefixed": {
"description": "If `true`, this rule will check vendor-prefixed properties",
"type": "boolean"
}
}
}
]
}
}
]
},
"property-no-vendor-prefix": {
"description": "Disallow vendor prefixes for properties",
"$ref": "#/definitions/booleanRule"
},
"property-whitelist": {
"description": "Specify a whitelist of allowed properties",
"$ref": "#/definitions/arrayStringRule"
}
}
},
"rootRule": {
"properties": {
"root-no-standard-properties": {
"description": "Disallow standard properties inside `:root` rules",
"$ref": "#/definitions/booleanRule"
}
}
},
"rule": {
"properties": {
"rule-nested-empty-line-before": {
"description": "Require or disallow an empty line before nested rules",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always",
"never",
"always-multi-line",
"never-multi-line",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never",
"always-multi-line",
"never-multi-line",
{}
]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"except": {
"description": "Reverse the primary option if the rule is the first in a block",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["first-nested"]
}
},
"ignore": {
"description": "Ignore rules that come after a comment",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["after-comment"]
}
}
}
}
]
}
}
]
},
"rule-non-nested-empty-line-before": {
"description": "Require or disallow an empty line before non-nested rules",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"always",
"never",
"always-multi-line",
"never-multi-line",
[]
]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never",
"always-multi-line",
"never-multi-line",
{}
]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"except": {
"description": "Reverse the primary option if the rule is the first in a block",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["after-single-line-comment"]
}
},
"ignore": {
"description": "Ignore rules that come after a comment",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["after-comment"]
}
}
}
}
]
}
}
]
}
}
},
"selector": {
"properties": {
"selector-attribute-brackets-space-inside": {
"description": "Require a single space or disallow whitespace on the inside of the brackets within attribute selector",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-attribute-operator-blacklist": {
"description": "Specify a blacklist of disallowed attribute operators",
"$ref": "#/definitions/arrayStringRule"
},
"selector-attribute-operator-space-after": {
"description": "Require a single space or disallow whitespace after operators within attribute selectors",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-attribute-operator-space-before": {
"description": "Require a single space or disallow whitespace before operators within attribute selectors",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-attribute-operator-whitelist": {
"description": "Specify a whitelist of allowed attribute operators",
"$ref": "#/definitions/arrayStringRule"
},
"selector-attribute-quotes": {
"description": "Require or disallow quotes for attribute values",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-class-pattern": {
"description": "Specify a pattern for class selectors",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": ["null", "string"]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"resolveNestedSelectors": {
"description": "This option will resolve nested selectors with `&` interpolation",
"type": "boolean",
"default": false
}
}
}
]
}
}
]
},
"selector-combinator-space-after": {
"description": "Require a single space or disallow whitespace after the combinators of selectors",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-combinator-space-before": {
"description": "Require a single space or disallow whitespace before the combinators of selectors",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-descendant-combinator-no-non-space": {
"description": "Disallow non-space characters for descendant combinators of selectors",
"$ref": "#/definitions/booleanRule"
},
"selector-id-pattern": {
"description": "Specify a pattern for id selectors",
"$ref": "#/definitions/stringRule"
},
"selector-max-compound-selectors": {
"description": "Limit the number of compound selectors in a selector",
"$ref": "#/definitions/integerRule"
},
"selector-max-specificity": {
"description": "Limit the specificity of selectors",
"$ref": "#/definitions/stringRule"
},
"selector-nested-pattern": {
"description": "Specify a pattern for the selectors of rules nested within rules",
"$ref": "#/definitions/stringRule"
},
"selector-no-attribute": {
"description": "Disallow attribute selectors",
"$ref": "#/definitions/booleanRule"
},
"selector-no-combinator": {
"description": "Disallow combinators in selectors",
"$ref": "#/definitions/booleanRule"
},
"selector-no-id": {
"description": "Disallow id selectors",
"$ref": "#/definitions/booleanRule"
},
"selector-no-qualifying-type": {
"description": "Disallow qualifying a selector by type",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["attribute", "class", "id"]
}
}
}
}
]
}
}
]
},
"selector-no-type": {
"description": "Disallow type selectors",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignore": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": ["compounded", "descendant"]
}
},
"ignoreTypes": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"selector-no-universal": {
"description": "Disallow the universal selector",
"$ref": "#/definitions/booleanRule"
},
"selector-no-vendor-prefix": {
"description": "Disallow vendor prefixes for selectors",
"$ref": "#/definitions/booleanRule"
},
"selector-pseudo-class-case": {
"description": "Specify lowercase or uppercase for pseudo-class selectors",
"$ref": "#/definitions/lowerUpperRule"
},
"selector-pseudo-class-no-unknown": {
"description": "Disallow unknown pseudo-class selectors",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignorePseudoClasses": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"selector-pseudo-class-parentheses-space-inside": {
"description": "Require a single space or disallow whitespace on the inside of the parentheses within pseudo-class selectors",
"$ref": "#/definitions/alwaysNeverRule"
},
"selector-pseudo-class-whitelist": {
"description": "Specify a whitelist of allowed pseudo-class selectors",
"$ref": "#/definitions/arrayStringRule"
},
"selector-pseudo-element-case": {
"description": "Specify lowercase or uppercase for pseudo-element selectors",
"$ref": "#/definitions/lowerUpperRule"
},
"selector-pseudo-element-colon-notation": {
"description": "Specify single or double colon notation for applicable pseudo-elements",
"$ref": "#/definitions/singleDoubleRule"
},
"selector-pseudo-element-no-unknown": {
"description": "Disallow unknown pseudo-element selectors",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignorePseudoElements": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"selector-root-no-composition": {
"description": "Disallow the composition of :root in selectors",
"$ref": "#/definitions/booleanRule"
},
"selector-type-case": {
"description": "Specify lowercase or uppercase for type selectors",
"$ref": "#/definitions/lowerUpperRule"
},
"selector-type-no-unknown": {
"description": "Disallow unknown type selectors",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreTypes": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"selector-max-empty-lines": {
"description": "Limit the number of adjacent empty lines within selectors",
"$ref": "#/definitions/integerRule"
}
}
},
"selectorList": {
"properties": {
"selector-list-comma-newline-after": {
"description": "Require a newline or disallow whitespace after the commas of selector lists",
"$ref": "#/definitions/newlineRule"
},
"selector-list-comma-newline-before": {
"description": "Require a newline or disallow whitespace before the commas of selector lists",
"$ref": "#/definitions/newlineRule"
},
"selector-list-comma-space-after": {
"description": "Require a single space or disallow whitespace after the commas of selector lists",
"$ref": "#/definitions/spaceRule"
},
"selector-list-comma-space-before": {
"description": "Require a single space or disallow whitespace before the commas of selector lists",
"$ref": "#/definitions/spaceRule"
}
}
},
"shorthandProperty": {
"properties": {
"shorthand-property-no-redundant-values": {
"description": "Disallow redundant values in shorthand properties",
"$ref": "#/definitions/booleanRule"
}
}
},
"string": {
"properties": {
"string-no-newline": {
"description": "Disallow (unescaped) newlines in strings",
"$ref": "#/definitions/booleanRule"
},
"string-quotes": {
"description": "Specify single or double quotes around strings",
"$ref": "#/definitions/singleDoubleRule"
}
}
},
"stylelintDisableComment": {
"properties": {
"stylelint-disable-reason": {
"description": "Require a reason comment before or after `stylelint-disable` comments",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["always-before", "always-after", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["always-before", "always-after", {}]
},
{
"$ref": "#/definitions/coreRule"
}
]
}
}
]
}
}
},
"time": {
"properties": {
"time-no-imperceptible": {
"description": "Disallow `animation` and `transition` less than or equal to 100ms",
"$ref": "#/definitions/booleanRule"
}
}
},
"unit": {
"properties": {
"unit-blacklist": {
"description": "Specify a blacklist of disallowed units",
"$ref": "#/definitions/unitRule"
},
"unit-case": {
"description": "Specify lowercase or uppercase for units",
"$ref": "#/definitions/lowerUpperRule"
},
"unit-no-unknown": {
"description": "Disallow unknown units",
"type": ["null", "boolean", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "boolean",
"enum": [true, []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["boolean", "object"],
"anyOf": [
{
"type": "boolean",
"enum": [true, {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreUnits": {
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"unit-whitelist": {
"description": "Specify a whitelist of allowed units",
"$ref": "#/definitions/unitRule"
}
}
},
"value": {
"properties": {
"value-keyword-case": {
"description": "Specify lowercase or uppercase for keywords values",
"type": ["null", "string", "array"],
"oneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": ["lower", "upper", []]
},
{
"type": "array",
"minItems": 2,
"maxItems": 2,
"uniqueItems": true,
"items": {
"type": ["string", "object"],
"anyOf": [
{
"type": "string",
"enum": ["lower", "upper", {}]
},
{
"type": "object",
"allOf": [
{
"$ref": "#/definitions/coreRule"
}
],
"properties": {
"ignoreKeywords": {
"description": "Ignore case of keywords values",
"$ref": "#/definitions/simpleArrayStringRule"
}
}
}
]
}
}
]
},
"value-no-vendor-prefix": {
"description": "Disallow vendor prefixes for values",
"$ref": "#/definitions/booleanRule"
}
}
},
"valueList": {
"properties": {
"value-list-comma-newline-after": {
"description": "Require a newline or disallow whitespace after the commas of value lists",
"$ref": "#/definitions/newlineRule"
},
"value-list-comma-newline-before": {
"description": "Require a newline or disallow whitespace before the commas of value lists",
"$ref": "#/definitions/newlineRule"
},
"value-list-comma-space-after": {
"description": "Require a single space or disallow whitespace after the commas of value lists",
"$ref": "#/definitions/spaceRule"
},
"value-list-comma-space-before": {
"description": "Require a single space or disallow whitespace before the commas of value lists",
"$ref": "#/definitions/spaceRule"
},
"value-list-max-empty-lines": {
"description": "Limit the number of adjacent empty lines within value lists",
"$ref": "#/definitions/integerRule"
}
}
}
},
"id": "https://json.schemastore.org/stylelintrc.json",
"properties": {
"extends": {
"description": "Your configuration can extend an existing configuration(s) (whether your own or a third-party config)",
"$ref": "#/definitions/simpleStringOrArrayStringRule"
},
"plugins": {
"description": "Plugins are rules or sets of rules built by the community that support methodologies, toolsets, non-standard CSS features, or very specific use cases",
"$ref": "#/definitions/simpleArrayStringRule"
},
"customSyntax": {
"description": "Specify a custom syntax to use on your code.",
"type": "string"
},
"overrides": {
"description": "Provide rule and behavior overrides for files that match particular glob patterns.",
"type": "array",
"items": {
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "string"
}
},
"customSyntax": {
"type": "string"
},
"rules": {
"$ref": "#/definitions/allRules"
}
}
}
},
"processors": {
"description": "Processors are functions that hook into stylelint's pipeline, modifying code on its way into stylelint and modifying results on their way out",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": [
{
"type": "string"
}
],
"additionalItems": {
"type": "object"
}
}
]
}
},
"ignoreDisables": {
"description": "Ignore stylelint-disable (e.g. /* stylelint-disable block-no-empty */) comments.",
"type": "boolean"
},
"ignoreFiles": {
"description": "Provide a glob or array of globs to ignore specific files",
"$ref": "#/definitions/simpleStringOrArrayStringRule"
},
"defaultSeverity": {
"description": "The default severity level for all rules that do not have a severity specified in their secondary options",
"type": "string",
"enum": ["warning", "error"]
},
"reportDescriptionlessDisables": {
"description": "Report stylelint-disable comments without a description.",
"$ref": "#/definitions/booleanRule"
},
"reportInvalidScopeDisables": {
"description": "Report stylelint-disable comments that don't match rules that are specified in the configuration object.",
"$ref": "#/definitions/booleanRule"
},
"reportNeedlessDisables": {
"description": "Report stylelint-disable comments that don't actually match any lints that need to be disabled",
"$ref": "#/definitions/booleanRule"
},
"rules": {
"$ref": "#/definitions/allRules"
}
},
"title": "JSON schema for the Stylelint configuration files",
"type": "object"
}
|
bootstraprc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"allOf": [
{
"$ref": "#/definitions/coreProperties"
},
{
"anyOf": [
{
"properties": {
"env": {
"description": "Sets the extractStyles property based on the value of NODE_ENV",
"type": "object",
"properties": {
"development": {
"$ref": "#/definitions/extractStyling"
},
"production": {
"$ref": "#/definitions/extractStyling"
}
}
}
},
"not": {
"properties": {
"extractStyles": {}
},
"required": ["extractStyles"]
}
},
{
"properties": {
"extractStyles": {
"$ref": "#/definitions/extractStyling/properties/extractStyles"
}
},
"not": {
"properties": {
"env": {}
},
"required": ["env"]
}
}
]
},
{
"required": ["bootstrapVersion", "styleLoaders"]
}
],
"definitions": {
"extractStyling": {
"type": "object",
"properties": {
"extractStyles": {
"default": false,
"description": "Enables/disables extraction of styles to a standalone CSS file using extract-text-webpack-plugin",
"type": "boolean"
}
}
},
"coreProperties": {
"type": "object",
"properties": {
"appStyles": {
"description": "Import your custom styles here. Usually this endpoint file contains a list of @imports of your application styles.",
"type": "string"
},
"bootstrapCustomizations": {
"description": "The .scss file path to be loaded after Bootstrap's _variables.scss file",
"type": "string"
},
"bootstrapVersion": {
"default": 3,
"description": "The major version of Bootstrap being used",
"enum": [3, 4],
"type": "integer"
},
"loglevel": {
"description": "The verbosity of logging. Exclude this property to disable.",
"enum": ["debug"],
"type": "string"
},
"preBootstrapCustomizations": {
"description": "The .scss file path to be loaded before Bootstrap's _variables.scss file",
"type": "string"
},
"scripts": {
"description": "Excludes/includes Bootstrap's JavaScript modules",
"type": ["boolean", "object"]
},
"styleLoaders": {
"default": ["style", "css", "sass"],
"description": "An array of Webpack loader names. Order matters, and sass-loader is required.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"styles": {
"description": "Excludes/includes Bootstrap's CSS modules",
"type": ["boolean", "object"]
},
"useCustomIconFontPath": {
"default": false,
"description": "Set to true if using a custom icon font and you need to specify its path in your Sass files",
"type": "boolean"
},
"useFlexbox": {
"default": true,
"description": "Enables/disables the flexbox model available in Bootstrap 4",
"type": "boolean"
}
}
}
},
"id": "https://json.schemastore.org/bootstraprc.json",
"title": "JSON schema for Webpack's bootstrap-loader configuration file",
"type": "object"
}
|
ubuntu-server-autoinstall.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Settings file for Ubuntu Autoinstall",
"id": "https://json.schemastore.org/ubuntu-server-autoinstall.json",
"properties": {
"autoinstall": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1
},
"early-commands": {
"type": "array",
"items": {
"type": ["string", "array"],
"items": {
"type": "string"
}
}
},
"reporting": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": ["type"],
"additionalProperties": true
}
},
"error-commands": {
"type": "array",
"items": {
"type": ["string", "array"],
"items": {
"type": "string"
}
}
},
"user-data": {
"type": "object"
},
"packages": {
"type": "array",
"items": {
"type": "string"
}
},
"debconf-selections": {
"type": "string"
},
"locale": {
"type": "string"
},
"refresh-installer": {
"type": "object",
"properties": {
"update": {
"type": "boolean"
},
"channel": {
"type": "string"
}
},
"additionalProperties": false
},
"keyboard": {
"type": "object",
"properties": {
"layout": {
"type": "string"
},
"variant": {
"type": "string"
},
"toggle": {
"type": ["string", "null"]
}
},
"required": ["layout"],
"additionalProperties": false
},
"network": {
"oneOf": [
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 2,
"maximum": 2
},
"ethernets": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"macaddress": {
"type": "string"
},
"driver": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"wifis": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"macaddress": {
"type": "string"
},
"driver": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"bridges": {
"type": "object"
},
"bonds": {
"type": "object"
},
"tunnels": {
"type": "object"
},
"vlans": {
"type": "object"
}
},
"required": ["version"]
},
{
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 2,
"maximum": 2
},
"ethernets": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"macaddress": {
"type": "string"
},
"driver": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"wifis": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"macaddress": {
"type": "string"
},
"driver": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"bridges": {
"type": "object"
},
"bonds": {
"type": "object"
},
"tunnels": {
"type": "object"
},
"vlans": {
"type": "object"
}
},
"required": ["version"]
}
},
"required": ["network"]
}
]
},
"proxy": {
"type": ["string", "null"],
"format": "uri"
},
"apt": {
"type": "object",
"properties": {
"preserve_sources_list": {
"type": "boolean"
},
"primary": {
"type": "array"
},
"geoip": {
"type": "boolean"
},
"sources": {
"type": "object"
}
}
},
"storage": {
"type": "object"
},
"identity": {
"type": "object",
"properties": {
"realname": {
"type": "string"
},
"username": {
"type": "string"
},
"hostname": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": ["username", "hostname", "password"],
"additionalProperties": false
},
"ssh": {
"type": "object",
"properties": {
"install-server": {
"type": "boolean"
},
"authorized-keys": {
"type": "array",
"items": {
"type": "string"
}
},
"allow-pw": {
"type": "boolean"
}
}
},
"snaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"channel": {
"type": "string"
},
"classic": {
"type": "boolean"
}
},
"required": ["name"],
"additionalProperties": false
}
},
"late-commands": {
"type": "array",
"items": {
"type": ["string", "array"],
"items": {
"type": "string"
}
}
}
},
"required": ["version"],
"additionalProperties": true
}
},
"title": "Ubuntu Server Autoinstall",
"type": "object"
}
|
versions.schema.cloud-config.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://raw.githubusercontent.com/canonical/cloud-init/main/cloudinit/config/schemas/versions.schema.cloud-config.json",
"oneOf": [
{
"allOf": [
{
"properties": {
"version": {
"enum": [
"v1"
]
}
}
},
{
"$ref": "https://raw.githubusercontent.com/canonical/cloud-init/main/cloudinit/config/schemas/schema-cloud-config-v1.json"
}
]
}
]
}
|
swcrc.json | {
"$id": "https://json.schemastore.org/swcrc.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/entryPoint"
}
},
{
"$ref": "#/definitions/entryPoint"
}
],
"definitions": {
"fileMatcher": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/fileMatcher"
}
}
]
},
"stringStringMap": {
"type": "object",
"patternProperties": {
"": {
"type": "string"
}
}
},
"featureOrModule": {
"anyOf": [
{
"type": "string",
"description": "CoreJS Module"
},
{
"type": "string",
"description": "Feature",
"enum": [
"transform-template-literals",
"transform-literals",
"transform-function-name",
"transform-arrow-functions",
"transform-block-scoped-functions",
"transform-classes",
"transform-object-super",
"transform-shorthand-properties",
"transform-duplicate-keys",
"transform-computed-properties",
"transform-for-of",
"transform-sticky-regex",
"transform-dotall-regex",
"transform-unicode-regex",
"transform-spread",
"transform-parameters",
"transform-destructuring",
"transform-block-scoping",
"transform-typeof-symbol",
"transform-new-target",
"transform-regenerator",
"transform-exponentiation-operator",
"transform-async-to-generator",
"proposal-async-generator-functions",
"proposal-object-rest-spread",
"proposal-unicode-property-regex",
"proposal-json-strings",
"proposal-optional-catch-binding",
"transform-named-capturing-groups-regex",
"transform-member-expression-literals",
"transform-property-literals",
"transform-reserved-words",
"proposal-nullish-coalescing-operator",
"proposal-optional-chaining",
"proposal-class-properties",
"proposal-numeric-separator",
"proposal-private-methods",
"transform-unicode-escapes"
]
}
]
},
"envVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"envVersions": {
"type": "object",
"propertyNames": {
"enum": [
"chrome",
"ie",
"edge",
"firefox",
"safari",
"node",
"ios",
"samsung",
"opera",
"android",
"electron",
"phantom",
"operaMobile"
]
},
"patternProperties": {
"": {
"$ref": "#/definitions/envVersion"
}
}
},
"envQuery": {
"description": "Query",
"oneOf": [
{
"description": "single query",
"type": "string"
},
{
"description": "multiple queries",
"type": "array",
"items": {
"type": "string"
}
}
]
},
"envQueryOrVersion": {
"description": "QueryOrVersion",
"oneOf": [
{
"$ref": "#/definitions/envQuery"
},
{
"$ref": "#/definitions/envVersion"
}
]
},
"entryPoint": {
"type": "object",
"description": "Defines an entry point",
"properties": {
"env": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": ["usage", "entry"]
},
"debug": {
"type": "boolean"
},
"dynamicImport": {
"type": "boolean"
},
"loose": {
"type": "boolean"
},
"skip": {
"type": "array",
"items": {
"type": "string"
},
"description": "Skipped es-features. e.g.: 'core-js/modules/foo'"
},
"include": {
"type": "array",
"items": {
"$ref": "#/definitions/featureOrModule"
}
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/definitions/featureOrModule"
}
},
"coreJs": {
"type": "string"
},
"targets": {
"oneOf": [
{
"$ref": "#/definitions/envQuery"
},
{
"description": "EsModules",
"type": "object",
"properties": {
"esmodules": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"description": "Versions",
"$ref": "#/definitions/envVersions"
},
{
"description": "HashMap",
"type": "object",
"patternProperties": {
"": {
"$ref": "#/definitions/envQueryOrVersion"
}
}
}
]
},
"shippedProposals": {
"type": "boolean"
},
"forceAllTransforms": {
"type": "boolean"
},
"bugfixes": {
"type": "boolean"
}
},
"additionalProperties": false
},
"test": {
"$ref": "#/definitions/fileMatcher",
"description": "Matches the files to include"
},
"exclude": {
"$ref": "#/definitions/fileMatcher",
"description": "Matches the files to exclude"
},
"minify": {
"type": "boolean",
"description": "If true, swc will minify the output"
},
"module": {
"type": "object",
"description": "Describes how swc will transpile the input",
"properties": {
"type": {
"type": "string",
"enum": ["commonjs", "amd", "umd", "es6"]
},
"strict": {
"type": "boolean",
"description": "If true, the __esModule property won't be added to the export",
"default": false
},
"strictMode": {
"type": "boolean",
"description": "If true, swc emits the 'use strict' directive",
"default": true
},
"lazy": {
"anyOf": [
{
"type": "boolean",
"description": "If true, lazy-initialize non local imports (not starting with ./)"
},
{
"type": "array",
"items": {
"type": "string",
"description": "RegEx matching file(s)"
},
"description": "Lazy-initialize all imports matching one of the given strings"
}
],
"default": false
},
"noInterop": {
"type": "boolean",
"description": "Disable the use of interopRequireDefault"
},
"moduleId": {
"type": "string",
"description": "If emitting amd-modules and specified, swc emits a named amd module"
},
"globals": {
"$ref": "#/definitions/stringStringMap"
}
},
"required": ["type"],
"additionalProperties": false
},
"$schema": {
"type": "string"
},
"jsc": {
"type": "object",
"description": "Main Jsc configuration",
"properties": {
"parser": {
"description": "Configures the parser",
"type": "object",
"oneOf": [
{
"properties": {
"syntax": {
"enum": ["ecmascript"]
},
"jsx": {
"type": "boolean",
"description": "If true, transform jsx"
},
"numericSeparator": {
"type": "boolean",
"description": "Support numeric separator proposal (Stage 3)"
},
"classPrivateProperty": {
"type": "boolean",
"description": "Support private class properties"
},
"privateMethod": {
"type": "boolean",
"description": "Support private class methods"
},
"classProperty": {
"type": "boolean",
"description": "Support class properties"
},
"functionBind": {
"type": "boolean",
"description": "Support function bind expression"
},
"decorators": {
"type": "boolean",
"description": "Enable decorators"
},
"decoratorsBeforeExport": {
"type": "boolean"
},
"exportDefaultFrom": {
"type": "boolean"
},
"exportNamespaceFrom": {
"type": "boolean"
},
"dynamicImport": {
"type": "boolean"
},
"nullishCoalescing": {
"type": "boolean"
},
"optionalChaining": {
"type": "boolean"
},
"importMeta": {
"type": "boolean"
},
"topLevelAwait": {
"type": "boolean"
},
"importAssertions": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"properties": {
"syntax": {
"enum": ["typescript"]
},
"tsx": {
"type": "boolean",
"description": "If true, transform tsx"
},
"decorators": {
"type": "boolean",
"description": "If true, transform decorators"
},
"dynamicImport": {
"type": "boolean"
},
"dts": {
"type": "boolean",
"description": "[DISABLED] If true, emit .d.ts files. This flag is currently skipped by serde."
},
"noEarlyErrors": {
"type": "boolean",
"description": "[DISABLED] This flag is currently skipped by serde."
},
"importAssertions": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"transform": {
"type": "object",
"properties": {
"react": {
"type": "object",
"properties": {
"development": {
"type": "boolean"
},
"pragma": {
"type": "string",
"default": "React.createElement"
},
"pragmaFrag": {
"type": "string",
"default": "React.Fragment"
},
"refresh": {
"type": "boolean",
"default": false
},
"runtime": {
"type": "string",
"enum": ["automatic", "classic"],
"default": "classic"
},
"throwIfNamespace": {
"type": "boolean",
"default": true
},
"useBuiltins": {
"type": "boolean"
}
},
"additionalProperties": false
},
"constModules": {
"type": "object",
"properties": {
"globals": {
"type": "object",
"patternProperties": {
"": {
"$ref": "#/definitions/stringStringMap"
}
}
}
},
"additionalProperties": false
},
"optimizer": {
"type": "object",
"properties": {
"globals": {
"type": "object",
"properties": {
"vars": {
"$ref": "#/definitions/stringStringMap"
},
"envs": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"jsonify": {
"type": "object",
"properties": {
"minCost": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"legacyDecorator": {
"type": "boolean"
},
"decoratorMetadata": {
"type": "boolean",
"description": "If true, decorator metadata is emitted. Make sure \"Reflect\" is present."
},
"useDefineForClassFields": {
"type": "boolean",
"description": "If false, the old behaviour is used and _defineProperty is not generated for class properties.\nhttps://swc.rs/docs/configuration/compilation#jsctransformusedefineforclassfields",
"$comment": "Requires [email protected]"
},
"hidden": {
"type": "object",
"properties": {
"jest": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"externalHelpers": {
"type": "boolean",
"description": "If true, this option will reduce the filesize by importing from an external module"
},
"preserveAllComments": {
"type": "boolean",
"description": "If true, all comments will be preserved during compilation"
},
"target": {
"type": "string",
"description": "Specifies the target environment",
"enum": [
"es3",
"es5",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020",
"es2021",
"es2022",
"esnext"
]
},
"loose": {
"type": "boolean",
"description": "If true, swc generates more efficient code"
},
"keepClassNames": {
"type": "boolean",
"$comment": "Requires [email protected] and target es2016 or higher",
"description": "Preserve original class names\nhttps://swc.rs/docs/configuration/compilation#jsckeepclassnames"
},
"paths": {
"type": "object",
"$comment": "Requires [email protected] and jsc.baseUrl",
"description": "Should reflect \"paths\" property in project's tsconfig.json . See https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping"
},
"baseUrl": {
"type": "string",
"$comment": "Requires [email protected]",
"description": "Should reflect \"baseUrl\" property in project's tsconfig.json . See https://www.typescriptlang.org/docs/handbook/module-resolution.html#base-url"
},
"minify": {
"title": "minification options",
"type": "object",
"$comment": "Requires [email protected]",
"description": "Minification options\nhttps://swc.rs/docs/configuration/minification"
},
"experimental": {
"title": "experimental options",
"type": "object",
"description": "Experimental options\nhttps://swc.rs/docs/configuration/compilation#jscexperimental",
"minProperties": 1,
"properties": {
"keepImportAssertions": {
"type": "boolean",
"description": "Preserve import assertions if true. This is experimental because import assertions are not covered by ecmascript specifications yet."
},
"plugins": {
"type": "array",
"description": "A list of plugins to load",
"minItems": 1,
"items": {
"type": "array",
"description": "A tuple with a plugin name and its options",
"minItems": 2,
"maxItems": 2,
"items": [
{
"type": "string",
"description": "Plugin name",
"minLength": 1
},
{
"type": "object",
"description": "Plugin options",
"additionalProperties": true
}
]
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"skipHelperInjection": {
"type": "boolean"
},
"disableHygiene": {
"type": "boolean"
},
"disableFixer": {
"type": "boolean"
},
"cwd": {
"type": "string"
},
"filename": {
"type": "string"
},
"root": {
"type": "string"
},
"swcrc": {
"type": "boolean"
},
"envName": {
"type": "string"
},
"sourceFileName": {
"type": "string"
},
"sourceRoot": {
"type": "string"
},
"isModule": {
"type": "boolean"
},
"globalMark": {
"type": "number"
},
"callerOptions": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"configFile": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"rootMode": {
"enum": ["root", "upward", "upward-optional"]
},
"inputSourceMap": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"sourceMaps": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"description": "Schema for the swc configuration file",
"title": "swc configuration schema"
}
|
tsconfig.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"allOf": [
{
"$ref": "#/definitions/compilerOptionsDefinition"
},
{
"$ref": "#/definitions/compileOnSaveDefinition"
},
{
"$ref": "#/definitions/typeAcquisitionDefinition"
},
{
"$ref": "#/definitions/extendsDefinition"
},
{
"$ref": "#/definitions/watchOptionsDefinition"
},
{
"$ref": "#/definitions/buildOptionsDefinition"
},
{
"$ref": "#/definitions/tsNodeDefinition"
},
{
"anyOf": [
{
"$ref": "#/definitions/filesDefinition"
},
{
"$ref": "#/definitions/excludeDefinition"
},
{
"$ref": "#/definitions/includeDefinition"
},
{
"$ref": "#/definitions/referencesDefinition"
}
]
}
],
"definitions": {
"//": {
"explainer": "https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#overview",
"reference": "https://www.typescriptlang.org/tsconfig",
"reference metadata": "https://github.com/microsoft/TypeScript-Website/blob/v2/packages/tsconfig-reference/scripts/tsconfigRules.ts"
},
"filesDefinition": {
"properties": {
"files": {
"description": "If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. When a 'files' property is specified, only those files and those specified by 'include' are included.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
}
},
"excludeDefinition": {
"properties": {
"exclude": {
"description": "Specifies a list of files to be excluded from compilation. The 'exclude' property only affects the files included via the 'include' property and not the 'files' property. Glob patterns require TypeScript version 2.0 or later.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
}
},
"includeDefinition": {
"properties": {
"include": {
"description": "Specifies a list of glob patterns that match files to be included in compilation. If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. Requires TypeScript version 2.0 or later.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
}
},
"compileOnSaveDefinition": {
"properties": {
"compileOnSave": {
"description": "Enable Compile-on-Save for this project.",
"type": "boolean"
}
}
},
"extendsDefinition": {
"properties": {
"extends": {
"description": "Path to base configuration file to inherit from (requires TypeScript version 2.1 or later), or array of base files, with the rightmost files having the greater priority (requires TypeScript version 5.0 or later).",
"oneOf": [
{
"default": "",
"type": "string"
},
{
"default": [],
"items": {
"type": "string"
},
"type": "array"
}
]
}
}
},
"buildOptionsDefinition": {
"properties": {
"buildOptions": {
"properties": {
"dry": {
"description": "~",
"type": "boolean",
"default": false
},
"force": {
"description": "Build all projects, including those that appear to be up to date",
"type": "boolean",
"default": false,
"markdownDescription": "Build all projects, including those that appear to be up to date\n\nSee more: https://www.typescriptlang.org/tsconfig#force"
},
"verbose": {
"description": "Enable verbose logging",
"type": "boolean",
"default": false,
"markdownDescription": "Enable verbose logging\n\nSee more: https://www.typescriptlang.org/tsconfig#verbose"
},
"incremental": {
"description": "Save .tsbuildinfo files to allow for incremental compilation of projects.",
"type": "boolean",
"default": false,
"markdownDescription": "Save .tsbuildinfo files to allow for incremental compilation of projects.\n\nSee more: https://www.typescriptlang.org/tsconfig#incremental"
},
"assumeChangesOnlyAffectDirectDependencies": {
"description": "Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.",
"type": "boolean",
"default": false,
"markdownDescription": "Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.\n\nSee more: https://www.typescriptlang.org/tsconfig#assumeChangesOnlyAffectDirectDependencies"
},
"traceResolution": {
"description": "Log paths used during the `moduleResolution` process.",
"type": "boolean",
"default": false,
"markdownDescription": "Log paths used during the `moduleResolution` process.\n\nSee more: https://www.typescriptlang.org/tsconfig#traceResolution"
}
}
}
}
},
"watchOptionsDefinition": {
"properties": {
"watchOptions": {
"type": "object",
"description": "Settings for the watch mode in TypeScript.",
"properties": {
"force": {
"description": "~",
"type": "string"
},
"watchFile": {
"description": "Specify how the TypeScript watch mode works.",
"type": "string",
"markdownDescription": "Specify how the TypeScript watch mode works.\n\nSee more: https://www.typescriptlang.org/tsconfig#watchFile"
},
"watchDirectory": {
"description": "Specify how directories are watched on systems that lack recursive file-watching functionality.",
"type": "string",
"markdownDescription": "Specify how directories are watched on systems that lack recursive file-watching functionality.\n\nSee more: https://www.typescriptlang.org/tsconfig#watchDirectory"
},
"fallbackPolling": {
"description": "Specify what approach the watcher should use if the system runs out of native file watchers.",
"type": "string",
"markdownDescription": "Specify what approach the watcher should use if the system runs out of native file watchers.\n\nSee more: https://www.typescriptlang.org/tsconfig#fallbackPolling"
},
"synchronousWatchDirectory": {
"description": "Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.",
"type": "boolean",
"markdownDescription": "Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.\n\nSee more: https://www.typescriptlang.org/tsconfig#synchronousWatchDirectory"
},
"excludeFiles": {
"description": "Remove a list of files from the watch mode's processing.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"markdownDescription": "Remove a list of files from the watch mode's processing.\n\nSee more: https://www.typescriptlang.org/tsconfig#excludeFiles"
},
"excludeDirectories": {
"description": "Remove a list of directories from the watch process.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"markdownDescription": "Remove a list of directories from the watch process.\n\nSee more: https://www.typescriptlang.org/tsconfig#excludeDirectories"
}
}
}
}
},
"compilerOptionsDefinition": {
"properties": {
"compilerOptions": {
"type": "object",
"description": "Instructs the TypeScript compiler how to compile .ts files.",
"properties": {
"allowArbitraryExtensions": {
"description": "Enable importing files with any extension, provided a declaration file is present.",
"type": "boolean",
"markdownDescription": "Enable importing files with any extension, provided a declaration file is present.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions"
},
"allowImportingTsExtensions": {
"description": "Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.",
"type": "boolean",
"markdownDescription": "Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions"
},
"charset": {
"description": "No longer supported. In early versions, manually set the text encoding for reading files.",
"type": "string",
"markdownDescription": "No longer supported. In early versions, manually set the text encoding for reading files.\n\nSee more: https://www.typescriptlang.org/tsconfig#charset"
},
"composite": {
"description": "Enable constraints that allow a TypeScript project to be used with project references.",
"type": "boolean",
"default": true,
"markdownDescription": "Enable constraints that allow a TypeScript project to be used with project references.\n\nSee more: https://www.typescriptlang.org/tsconfig#composite"
},
"customConditions": {
"description": "Conditions to set in addition to the resolver-specific defaults when resolving imports.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"markdownDescription": "Conditions to set in addition to the resolver-specific defaults when resolving imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#customConditions"
},
"declaration": {
"description": "Generate .d.ts files from TypeScript and JavaScript files in your project.",
"type": "boolean",
"default": false,
"markdownDescription": "Generate .d.ts files from TypeScript and JavaScript files in your project.\n\nSee more: https://www.typescriptlang.org/tsconfig#declaration"
},
"declarationDir": {
"description": "Specify the output directory for generated declaration files.",
"type": ["string", "null"],
"markdownDescription": "Specify the output directory for generated declaration files.\n\nSee more: https://www.typescriptlang.org/tsconfig#declarationDir"
},
"diagnostics": {
"description": "Output compiler performance information after building.",
"type": "boolean",
"markdownDescription": "Output compiler performance information after building.\n\nSee more: https://www.typescriptlang.org/tsconfig#diagnostics"
},
"disableReferencedProjectLoad": {
"description": "Reduce the number of projects loaded automatically by TypeScript.",
"type": "boolean",
"markdownDescription": "Reduce the number of projects loaded automatically by TypeScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#disableReferencedProjectLoad"
},
"noPropertyAccessFromIndexSignature": {
"description": "Enforces using indexed accessors for keys declared using an indexed type",
"type": "boolean",
"markdownDescription": "Enforces using indexed accessors for keys declared using an indexed type\n\nSee more: https://www.typescriptlang.org/tsconfig#noPropertyAccessFromIndexSignature"
},
"emitBOM": {
"description": "Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.",
"type": "boolean",
"default": false,
"markdownDescription": "Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.\n\nSee more: https://www.typescriptlang.org/tsconfig#emitBOM"
},
"emitDeclarationOnly": {
"description": "Only output d.ts files and not JavaScript files.",
"type": "boolean",
"default": false,
"markdownDescription": "Only output d.ts files and not JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#emitDeclarationOnly"
},
"exactOptionalPropertyTypes": {
"description": "Differentiate between undefined and not present when type checking",
"type": "boolean",
"default": false,
"markdownDescription": "Differentiate between undefined and not present when type checking\n\nSee more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes"
},
"incremental": {
"description": "Enable incremental compilation. Requires TypeScript version 3.4 or later.",
"type": "boolean"
},
"tsBuildInfoFile": {
"description": "Specify the folder for .tsbuildinfo incremental compilation files.",
"default": ".tsbuildinfo",
"type": "string",
"markdownDescription": "Specify the folder for .tsbuildinfo incremental compilation files.\n\nSee more: https://www.typescriptlang.org/tsconfig#tsBuildInfoFile"
},
"inlineSourceMap": {
"description": "Include sourcemap files inside the emitted JavaScript.",
"type": "boolean",
"default": false,
"markdownDescription": "Include sourcemap files inside the emitted JavaScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#inlineSourceMap"
},
"inlineSources": {
"description": "Include source code in the sourcemaps inside the emitted JavaScript.",
"type": "boolean",
"default": false,
"markdownDescription": "Include source code in the sourcemaps inside the emitted JavaScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#inlineSources"
},
"jsx": {
"description": "Specify what JSX code is generated.",
"enum": [
"preserve",
"react",
"react-jsx",
"react-jsxdev",
"react-native"
]
},
"reactNamespace": {
"description": "Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.",
"type": "string",
"default": "React",
"markdownDescription": "Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.\n\nSee more: https://www.typescriptlang.org/tsconfig#reactNamespace"
},
"jsxFactory": {
"description": "Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'",
"type": "string",
"default": "React.createElement",
"markdownDescription": "Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'\n\nSee more: https://www.typescriptlang.org/tsconfig#jsxFactory"
},
"jsxFragmentFactory": {
"description": "Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.",
"type": "string",
"default": "React.Fragment",
"markdownDescription": "Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.\n\nSee more: https://www.typescriptlang.org/tsconfig#jsxFragmentFactory"
},
"jsxImportSource": {
"description": "Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.",
"type": "string",
"default": "react",
"markdownDescription": "Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.\n\nSee more: https://www.typescriptlang.org/tsconfig#jsxImportSource"
},
"listFiles": {
"description": "Print all of the files read during the compilation.",
"type": "boolean",
"default": false,
"markdownDescription": "Print all of the files read during the compilation.\n\nSee more: https://www.typescriptlang.org/tsconfig#listFiles"
},
"mapRoot": {
"description": "Specify the location where debugger should locate map files instead of generated locations.",
"type": "string",
"markdownDescription": "Specify the location where debugger should locate map files instead of generated locations.\n\nSee more: https://www.typescriptlang.org/tsconfig#mapRoot"
},
"module": {
"description": "Specify what module code is generated.",
"type": "string",
"anyOf": [
{
"enum": [
"CommonJS",
"AMD",
"System",
"UMD",
"ES6",
"ES2015",
"ES2020",
"ESNext",
"None",
"ES2022",
"Node16",
"NodeNext"
]
},
{
"pattern": "^([Cc][Oo][Mm][Mm][Oo][Nn][Jj][Ss]|[AaUu][Mm][Dd]|[Ss][Yy][Ss][Tt][Ee][Mm]|[Ee][Ss]([356]|20(1[567]|2[02])|[Nn][Ee][Xx][Tt])|[Nn][Oo][dD][Ee]16|[Nn][Oo][Dd][Ee][Nn][Ee][Xx][Tt]|[Nn][Oo][Nn][Ee])$"
}
],
"markdownDescription": "Specify what module code is generated.\n\nSee more: https://www.typescriptlang.org/tsconfig#module"
},
"moduleResolution": {
"description": "Specify how TypeScript looks up a file from a given module specifier.",
"type": "string",
"anyOf": [
{
"enum": ["Classic", "Node", "Node16", "NodeNext", "Bundler"]
},
{
"pattern": "^(([Nn]ode)|([Nn]ode16)|([Nn]ode[Nn]ext)|([Cc]lassic)|([Bb]undler))$"
}
],
"default": "classic",
"markdownDescription": "Specify how TypeScript looks up a file from a given module specifier.\n\nSee more: https://www.typescriptlang.org/tsconfig#moduleResolution"
},
"newLine": {
"description": "Set the newline character for emitting files.",
"type": "string",
"anyOf": [
{
"enum": ["crlf", "lf"]
},
{
"pattern": "^(CRLF|LF|crlf|lf)$"
}
],
"markdownDescription": "Set the newline character for emitting files.\n\nSee more: https://www.typescriptlang.org/tsconfig#newLine"
},
"noEmit": {
"description": "Disable emitting file from a compilation.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable emitting file from a compilation.\n\nSee more: https://www.typescriptlang.org/tsconfig#noEmit"
},
"noEmitHelpers": {
"description": "Disable generating custom helper functions like `__extends` in compiled output.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable generating custom helper functions like `__extends` in compiled output.\n\nSee more: https://www.typescriptlang.org/tsconfig#noEmitHelpers"
},
"noEmitOnError": {
"description": "Disable emitting files if any type checking errors are reported.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable emitting files if any type checking errors are reported.\n\nSee more: https://www.typescriptlang.org/tsconfig#noEmitOnError"
},
"noImplicitAny": {
"description": "Enable error reporting for expressions and declarations with an implied `any` type..",
"type": "boolean",
"markdownDescription": "Enable error reporting for expressions and declarations with an implied `any` type..\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitAny"
},
"noImplicitThis": {
"description": "Enable error reporting when `this` is given the type `any`.",
"type": "boolean",
"markdownDescription": "Enable error reporting when `this` is given the type `any`.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitThis"
},
"noUnusedLocals": {
"description": "Enable error reporting when a local variables aren't read.",
"type": "boolean",
"default": false,
"markdownDescription": "Enable error reporting when a local variables aren't read.\n\nSee more: https://www.typescriptlang.org/tsconfig#noUnusedLocals"
},
"noUnusedParameters": {
"description": "Raise an error when a function parameter isn't read",
"type": "boolean",
"default": false,
"markdownDescription": "Raise an error when a function parameter isn't read\n\nSee more: https://www.typescriptlang.org/tsconfig#noUnusedParameters"
},
"noLib": {
"description": "Disable including any library files, including the default lib.d.ts.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable including any library files, including the default lib.d.ts.\n\nSee more: https://www.typescriptlang.org/tsconfig#noLib"
},
"noResolve": {
"description": "Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.",
"type": "boolean",
"default": false,
"markdownDescription": "Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.\n\nSee more: https://www.typescriptlang.org/tsconfig#noResolve"
},
"noStrictGenericChecks": {
"description": "Disable strict checking of generic signatures in function types.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable strict checking of generic signatures in function types.\n\nSee more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks"
},
"skipDefaultLibCheck": {
"description": "Skip type checking .d.ts files that are included with TypeScript.",
"type": "boolean",
"default": false,
"markdownDescription": "Skip type checking .d.ts files that are included with TypeScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#skipDefaultLibCheck"
},
"skipLibCheck": {
"description": "Skip type checking all .d.ts files.",
"type": "boolean",
"default": false,
"markdownDescription": "Skip type checking all .d.ts files.\n\nSee more: https://www.typescriptlang.org/tsconfig#skipLibCheck"
},
"outFile": {
"description": "Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.",
"type": "string",
"markdownDescription": "Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.\n\nSee more: https://www.typescriptlang.org/tsconfig#outFile"
},
"outDir": {
"description": "Specify an output folder for all emitted files.",
"type": "string",
"markdownDescription": "Specify an output folder for all emitted files.\n\nSee more: https://www.typescriptlang.org/tsconfig#outDir"
},
"preserveConstEnums": {
"description": "Disable erasing `const enum` declarations in generated code.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable erasing `const enum` declarations in generated code.\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveConstEnums"
},
"preserveSymlinks": {
"description": "Disable resolving symlinks to their realpath. This correlates to the same flag in node.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable resolving symlinks to their realpath. This correlates to the same flag in node.\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveSymlinks"
},
"preserveValueImports": {
"description": "Preserve unused imported values in the JavaScript output that would otherwise be removed",
"type": "boolean",
"default": false,
"markdownDescription": "Preserve unused imported values in the JavaScript output that would otherwise be removed\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveValueImports"
},
"preserveWatchOutput": {
"description": "Disable wiping the console in watch mode",
"type": "boolean",
"markdownDescription": "Disable wiping the console in watch mode\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveWatchOutput"
},
"pretty": {
"description": "Enable color and formatting in output to make compiler errors easier to read",
"type": "boolean",
"default": true,
"markdownDescription": "Enable color and formatting in output to make compiler errors easier to read\n\nSee more: https://www.typescriptlang.org/tsconfig#pretty"
},
"removeComments": {
"description": "Disable emitting comments.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable emitting comments.\n\nSee more: https://www.typescriptlang.org/tsconfig#removeComments"
},
"rootDir": {
"description": "Specify the root folder within your source files.",
"type": "string",
"markdownDescription": "Specify the root folder within your source files.\n\nSee more: https://www.typescriptlang.org/tsconfig#rootDir"
},
"isolatedModules": {
"description": "Ensure that each file can be safely transpiled without relying on other imports.",
"type": "boolean",
"default": false,
"markdownDescription": "Ensure that each file can be safely transpiled without relying on other imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#isolatedModules"
},
"sourceMap": {
"description": "Create source map files for emitted JavaScript files.",
"type": "boolean",
"default": false,
"markdownDescription": "Create source map files for emitted JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#sourceMap"
},
"sourceRoot": {
"description": "Specify the root path for debuggers to find the reference source code.",
"type": "string",
"markdownDescription": "Specify the root path for debuggers to find the reference source code.\n\nSee more: https://www.typescriptlang.org/tsconfig#sourceRoot"
},
"suppressExcessPropertyErrors": {
"description": "Disable reporting of excess property errors during the creation of object literals.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable reporting of excess property errors during the creation of object literals.\n\nSee more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors"
},
"suppressImplicitAnyIndexErrors": {
"description": "Suppress `noImplicitAny` errors when indexing objects that lack index signatures.",
"type": "boolean",
"default": false,
"markdownDescription": "Suppress `noImplicitAny` errors when indexing objects that lack index signatures.\n\nSee more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors"
},
"stripInternal": {
"description": "Disable emitting declarations that have `@internal` in their JSDoc comments.",
"type": "boolean",
"markdownDescription": "Disable emitting declarations that have `@internal` in their JSDoc comments.\n\nSee more: https://www.typescriptlang.org/tsconfig#stripInternal"
},
"target": {
"description": "Set the JavaScript language version for emitted JavaScript and include compatible library declarations.",
"type": "string",
"default": "ES3",
"anyOf": [
{
"enum": [
"ES3",
"ES5",
"ES6",
"ES2015",
"ES2016",
"ES2017",
"ES2018",
"ES2019",
"ES2020",
"ES2021",
"ES2022",
"ES2023",
"ESNext"
]
},
{
"pattern": "^([Ee][Ss]([356]|(20(1[56789]|2[0123]))|[Nn][Ee][Xx][Tt]))$"
}
],
"markdownDescription": "Set the JavaScript language version for emitted JavaScript and include compatible library declarations.\n\nSee more: https://www.typescriptlang.org/tsconfig#target"
},
"useUnknownInCatchVariables": {
"description": "Default catch clause variables as `unknown` instead of `any`.",
"type": "boolean",
"default": false,
"markdownDescription": "Default catch clause variables as `unknown` instead of `any`.\n\nSee more: https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables"
},
"watch": {
"description": "Watch input files.",
"type": "boolean"
},
"fallbackPolling": {
"description": "Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.",
"enum": [
"fixedPollingInterval",
"priorityPollingInterval",
"dynamicPriorityPolling",
"fixedInterval",
"priorityInterval",
"dynamicPriority",
"fixedChunkSize"
]
},
"watchDirectory": {
"description": "Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.",
"enum": [
"useFsEvents",
"fixedPollingInterval",
"dynamicPriorityPolling",
"fixedChunkSizePolling"
],
"default": "useFsEvents"
},
"watchFile": {
"description": "Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.",
"enum": [
"fixedPollingInterval",
"priorityPollingInterval",
"dynamicPriorityPolling",
"useFsEvents",
"useFsEventsOnParentDirectory",
"fixedChunkSizePolling"
],
"default": "useFsEvents"
},
"experimentalDecorators": {
"description": "Enable experimental support for TC39 stage 2 draft decorators.",
"type": "boolean",
"markdownDescription": "Enable experimental support for TC39 stage 2 draft decorators.\n\nSee more: https://www.typescriptlang.org/tsconfig#experimentalDecorators"
},
"emitDecoratorMetadata": {
"description": "Emit design-type metadata for decorated declarations in source files.",
"type": "boolean",
"markdownDescription": "Emit design-type metadata for decorated declarations in source files.\n\nSee more: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata"
},
"allowUnusedLabels": {
"description": "Disable error reporting for unused labels.",
"type": "boolean",
"markdownDescription": "Disable error reporting for unused labels.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels"
},
"noImplicitReturns": {
"description": "Enable error reporting for codepaths that do not explicitly return in a function.",
"type": "boolean",
"default": false,
"markdownDescription": "Enable error reporting for codepaths that do not explicitly return in a function.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitReturns"
},
"noUncheckedIndexedAccess": {
"description": "Add `undefined` to a type when accessed using an index.",
"type": "boolean",
"markdownDescription": "Add `undefined` to a type when accessed using an index.\n\nSee more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess"
},
"noFallthroughCasesInSwitch": {
"description": "Enable error reporting for fallthrough cases in switch statements.",
"type": "boolean",
"default": false,
"markdownDescription": "Enable error reporting for fallthrough cases in switch statements.\n\nSee more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch"
},
"noImplicitOverride": {
"description": "Ensure overriding members in derived classes are marked with an override modifier.",
"type": "boolean",
"default": false,
"markdownDescription": "Ensure overriding members in derived classes are marked with an override modifier.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitOverride"
},
"allowUnreachableCode": {
"description": "Disable error reporting for unreachable code.",
"type": "boolean",
"markdownDescription": "Disable error reporting for unreachable code.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode"
},
"forceConsistentCasingInFileNames": {
"description": "Ensure that casing is correct in imports.",
"type": "boolean",
"default": false,
"markdownDescription": "Ensure that casing is correct in imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#forceConsistentCasingInFileNames"
},
"generateCpuProfile": {
"description": "Emit a v8 CPU profile of the compiler run for debugging.",
"type": "string",
"default": "profile.cpuprofile",
"markdownDescription": "Emit a v8 CPU profile of the compiler run for debugging.\n\nSee more: https://www.typescriptlang.org/tsconfig#generateCpuProfile"
},
"baseUrl": {
"description": "Specify the base directory to resolve non-relative module names.",
"type": "string",
"markdownDescription": "Specify the base directory to resolve non-relative module names.\n\nSee more: https://www.typescriptlang.org/tsconfig#baseUrl"
},
"paths": {
"description": "Specify a set of entries that re-map imports to additional lookup locations.",
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"description": "Path mapping to be computed relative to baseUrl option."
}
},
"markdownDescription": "Specify a set of entries that re-map imports to additional lookup locations.\n\nSee more: https://www.typescriptlang.org/tsconfig#paths"
},
"plugins": {
"description": "Specify a list of language service plugins to include.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Plugin name.",
"type": "string"
}
}
},
"markdownDescription": "Specify a list of language service plugins to include.\n\nSee more: https://www.typescriptlang.org/tsconfig#plugins"
},
"rootDirs": {
"description": "Allow multiple folders to be treated as one when resolving modules.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"markdownDescription": "Allow multiple folders to be treated as one when resolving modules.\n\nSee more: https://www.typescriptlang.org/tsconfig#rootDirs"
},
"typeRoots": {
"description": "Specify multiple folders that act like `./node_modules/@types`.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"markdownDescription": "Specify multiple folders that act like `./node_modules/@types`.\n\nSee more: https://www.typescriptlang.org/tsconfig#typeRoots"
},
"types": {
"description": "Specify type package names to be included without being referenced in a source file.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"markdownDescription": "Specify type package names to be included without being referenced in a source file.\n\nSee more: https://www.typescriptlang.org/tsconfig#types"
},
"traceResolution": {
"description": "Enable tracing of the name resolution process. Requires TypeScript version 2.0 or later.",
"type": "boolean",
"default": false
},
"allowJs": {
"description": "Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.",
"type": "boolean",
"default": false,
"markdownDescription": "Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowJs"
},
"noErrorTruncation": {
"description": "Disable truncating types in error messages.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable truncating types in error messages.\n\nSee more: https://www.typescriptlang.org/tsconfig#noErrorTruncation"
},
"allowSyntheticDefaultImports": {
"description": "Allow 'import x from y' when a module doesn't have a default export.",
"type": "boolean",
"markdownDescription": "Allow 'import x from y' when a module doesn't have a default export.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowSyntheticDefaultImports"
},
"noImplicitUseStrict": {
"description": "Disable adding 'use strict' directives in emitted JavaScript files.",
"type": "boolean",
"default": false,
"markdownDescription": "Disable adding 'use strict' directives in emitted JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict"
},
"listEmittedFiles": {
"description": "Print the names of emitted files after a compilation.",
"type": "boolean",
"default": false,
"markdownDescription": "Print the names of emitted files after a compilation.\n\nSee more: https://www.typescriptlang.org/tsconfig#listEmittedFiles"
},
"disableSizeLimit": {
"description": "Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.",
"type": "boolean",
"default": false,
"markdownDescription": "Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.\n\nSee more: https://www.typescriptlang.org/tsconfig#disableSizeLimit"
},
"lib": {
"description": "Specify a set of bundled library declaration files that describe the target runtime environment.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"anyOf": [
{
"enum": [
"ES5",
"ES6",
"ES2015",
"ES2015.Collection",
"ES2015.Core",
"ES2015.Generator",
"ES2015.Iterable",
"ES2015.Promise",
"ES2015.Proxy",
"ES2015.Reflect",
"ES2015.Symbol.WellKnown",
"ES2015.Symbol",
"ES2016",
"ES2016.Array.Include",
"ES2017",
"ES2017.Intl",
"ES2017.Object",
"ES2017.SharedMemory",
"ES2017.String",
"ES2017.TypedArrays",
"ES2018",
"ES2018.AsyncGenerator",
"ES2018.AsyncIterable",
"ES2018.Intl",
"ES2018.Promise",
"ES2018.Regexp",
"ES2019",
"ES2019.Array",
"ES2019.Intl",
"ES2019.Object",
"ES2019.String",
"ES2019.Symbol",
"ES2020",
"ES2020.BigInt",
"ES2020.Promise",
"ES2020.String",
"ES2020.Symbol.WellKnown",
"ESNext",
"ESNext.Array",
"ESNext.AsyncIterable",
"ESNext.BigInt",
"ESNext.Intl",
"ESNext.Promise",
"ESNext.String",
"ESNext.Symbol",
"DOM",
"DOM.Iterable",
"ScriptHost",
"WebWorker",
"WebWorker.ImportScripts",
"Webworker.Iterable",
"ES7",
"ES2021",
"ES2020.SharedMemory",
"ES2020.Intl",
"ES2020.Date",
"ES2020.Number",
"ES2021.Promise",
"ES2021.String",
"ES2021.WeakRef",
"ESNext.WeakRef",
"ES2021.Intl",
"ES2022",
"ES2022.Array",
"ES2022.Error",
"ES2022.Intl",
"ES2022.Object",
"ES2022.String",
"ES2022.SharedMemory",
"ES2022.RegExp",
"ES2023",
"ES2023.Array"
]
},
{
"pattern": "^[Ee][Ss]5|[Ee][Ss]6|[Ee][Ss]7$"
},
{
"pattern": "^[Ee][Ss]2015(\\.([Cc][Oo][Ll][Ll][Ee][Cc][Tt][Ii][Oo][Nn]|[Cc][Oo][Rr][Ee]|[Gg][Ee][Nn][Ee][Rr][Aa][Tt][Oo][Rr]|[Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Pp][Rr][Oo][Xx][Yy]|[Rr][Ee][Ff][Ll][Ee][Cc][Tt]|[Ss][Yy][Mm][Bb][Oo][Ll].[Ww][Ee][Ll][Ll][Kk][Nn][Oo][Ww][Nn]|[Ss][Yy][Mm][Bb][Oo][Ll]))?$"
},
{
"pattern": "^[Ee][Ss]2016(\\.[Aa][Rr][Rr][Aa][Yy].[Ii][Nn][Cc][Ll][Uu][Dd][Ee])?$"
},
{
"pattern": "^[Ee][Ss]2017(\\.([Ii][Nn][Tt][Ll]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Hh][Aa][Rr][Ee][Dd][Mm][Ee][Mm][Oo][Rr][Yy]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Tt][Yy][Pp][Ee][Dd][Aa][Rr][Rr][Aa][Yy][Ss]))?$"
},
{
"pattern": "^[Ee][Ss]2018(\\.([Aa][Ss][Yy][Nn][Cc][Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Rr][Ee][Gg][Ee][Xx][Pp]))?$"
},
{
"pattern": "^[Ee][Ss]2019(\\.([Aa][Rr][Rr][Aa][Yy]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll]))?$"
},
{
"pattern": "^[Ee][Ss]2020(\\.([Bb][Ii][Gg][Ii][Nn][Tt]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll].[Ww][Ee][Ll][Ll][Kk][Nn][Oo][Ww][Nn]|[Dd][Aa][Tt][Ee]|[Nn][Uu][Mm][Bb][Ee][Rr]))?$"
},
{
"pattern": "^[Ee][Ss]2021(\\.([Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ww][Ee][Aa][Kk][Rr][Ee][Ff]))?$"
},
{
"pattern": "^[Ee][Ss]2022(\\.([Aa][Rr][Rr][Aa][Yy]|[Ee][Rr][Rr][Oo][Rr]|[Ii][Nn][Tt][Ll]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Hh][Aa][Rr][Ee][Dd][Mm][Ee][Mm][Oo][Rr][Yy]|[Rr][Ee][Gg][Ee][Xx][Pp]))?$"
},
{
"pattern": "^[Ee][Ss]2023(\\.([Aa][Rr][Rr][Aa][Yy]))?$"
},
{
"pattern": "^[Ee][Ss][Nn][Ee][Xx][Tt](\\.([Aa][Rr][Rr][Aa][Yy]|[Aa][Ss][Yy][Nn][Cc][Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Bb][Ii][Gg][Ii][Nn][Tt]|[Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll]|[Ww][Ee][Aa][Kk][Rr][Ee][Ff]))?$"
},
{
"pattern": "^[Dd][Oo][Mm](\\.[Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee])?$"
},
{
"pattern": "^[Ss][Cc][Rr][Ii][Pp][Tt][Hh][Oo][Ss][Tt]$"
},
{
"pattern": "^[Ww][Ee][Bb][Ww][Oo][Rr][Kk][Ee][Rr](\\.[Ii][Mm][Pp][Oo][Rr][Tt][Ss][Cc][Rr][Ii][Pp][Tt][Ss])?$"
}
]
},
"markdownDescription": "Specify a set of bundled library declaration files that describe the target runtime environment.\n\nSee more: https://www.typescriptlang.org/tsconfig#lib"
},
"moduleDetection": {
"description": "Specify how TypeScript determine a file as module.",
"enum": ["auto", "legacy", "force"]
},
"strictNullChecks": {
"description": "When type checking, take into account `null` and `undefined`.",
"type": "boolean",
"default": false,
"markdownDescription": "When type checking, take into account `null` and `undefined`.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictNullChecks"
},
"maxNodeModuleJsDepth": {
"description": "Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.",
"type": "number",
"default": 0,
"markdownDescription": "Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.\n\nSee more: https://www.typescriptlang.org/tsconfig#maxNodeModuleJsDepth"
},
"importHelpers": {
"description": "Allow importing helper functions from tslib once per project, instead of including them per-file.",
"type": "boolean",
"default": false,
"markdownDescription": "Allow importing helper functions from tslib once per project, instead of including them per-file.\n\nSee more: https://www.typescriptlang.org/tsconfig#importHelpers"
},
"importsNotUsedAsValues": {
"description": "Specify emit/checking behavior for imports that are only used for types.",
"default": "remove",
"enum": ["remove", "preserve", "error"]
},
"alwaysStrict": {
"description": "Ensure 'use strict' is always emitted.",
"type": "boolean",
"markdownDescription": "Ensure 'use strict' is always emitted.\n\nSee more: https://www.typescriptlang.org/tsconfig#alwaysStrict"
},
"strict": {
"description": "Enable all strict type checking options.",
"type": "boolean",
"default": false,
"markdownDescription": "Enable all strict type checking options.\n\nSee more: https://www.typescriptlang.org/tsconfig#strict"
},
"strictBindCallApply": {
"description": "Check that the arguments for `bind`, `call`, and `apply` methods match the original function.",
"type": "boolean",
"default": false,
"markdownDescription": "Check that the arguments for `bind`, `call`, and `apply` methods match the original function.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictBindCallApply"
},
"downlevelIteration": {
"description": "Emit more compliant, but verbose and less performant JavaScript for iteration.",
"type": "boolean",
"default": false,
"markdownDescription": "Emit more compliant, but verbose and less performant JavaScript for iteration.\n\nSee more: https://www.typescriptlang.org/tsconfig#downlevelIteration"
},
"checkJs": {
"description": "Enable error reporting in type-checked JavaScript files.",
"type": "boolean",
"default": false,
"markdownDescription": "Enable error reporting in type-checked JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#checkJs"
},
"strictFunctionTypes": {
"description": "When assigning functions, check to ensure parameters and the return values are subtype-compatible.",
"type": "boolean",
"default": false,
"markdownDescription": "When assigning functions, check to ensure parameters and the return values are subtype-compatible.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes"
},
"strictPropertyInitialization": {
"description": "Check for class properties that are declared but not set in the constructor.",
"type": "boolean",
"default": false,
"markdownDescription": "Check for class properties that are declared but not set in the constructor.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization"
},
"esModuleInterop": {
"description": "Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.",
"type": "boolean",
"default": false,
"markdownDescription": "Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.\n\nSee more: https://www.typescriptlang.org/tsconfig#esModuleInterop"
},
"allowUmdGlobalAccess": {
"description": "Allow accessing UMD globals from modules.",
"type": "boolean",
"default": false,
"markdownDescription": "Allow accessing UMD globals from modules.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowUmdGlobalAccess"
},
"keyofStringsOnly": {
"description": "Make keyof only return strings instead of string, numbers or symbols. Legacy option.",
"type": "boolean",
"default": false,
"markdownDescription": "Make keyof only return strings instead of string, numbers or symbols. Legacy option.\n\nSee more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly"
},
"useDefineForClassFields": {
"description": "Emit ECMAScript-standard-compliant class fields.",
"type": "boolean",
"default": false,
"markdownDescription": "Emit ECMAScript-standard-compliant class fields.\n\nSee more: https://www.typescriptlang.org/tsconfig#useDefineForClassFields"
},
"declarationMap": {
"description": "Create sourcemaps for d.ts files.",
"type": "boolean",
"default": false,
"markdownDescription": "Create sourcemaps for d.ts files.\n\nSee more: https://www.typescriptlang.org/tsconfig#declarationMap"
},
"resolveJsonModule": {
"description": "Enable importing .json files",
"type": "boolean",
"default": false,
"markdownDescription": "Enable importing .json files\n\nSee more: https://www.typescriptlang.org/tsconfig#resolveJsonModule"
},
"resolvePackageJsonExports": {
"description": "Use the package.json 'exports' field when resolving package imports.",
"type": "boolean",
"default": false,
"markdownDescription": "Use the package.json 'exports' field when resolving package imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonExports"
},
"resolvePackageJsonImports": {
"description": "Use the package.json 'imports' field when resolving imports.",
"type": "boolean",
"default": false,
"markdownDescription": "Use the package.json 'imports' field when resolving imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonImports"
},
"assumeChangesOnlyAffectDirectDependencies": {
"description": "Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.",
"type": "boolean"
},
"extendedDiagnostics": {
"description": "Output more detailed compiler performance information after building.",
"type": "boolean",
"default": false,
"markdownDescription": "Output more detailed compiler performance information after building.\n\nSee more: https://www.typescriptlang.org/tsconfig#extendedDiagnostics"
},
"listFilesOnly": {
"description": "Print names of files that are part of the compilation and then stop processing.",
"type": "boolean"
},
"disableSourceOfProjectReferenceRedirect": {
"description": "Disable preferring source files instead of declaration files when referencing composite projects",
"type": "boolean",
"markdownDescription": "Disable preferring source files instead of declaration files when referencing composite projects\n\nSee more: https://www.typescriptlang.org/tsconfig#disableSourceOfProjectReferenceRedirect"
},
"disableSolutionSearching": {
"description": "Opt a project out of multi-project reference checking when editing.",
"type": "boolean",
"markdownDescription": "Opt a project out of multi-project reference checking when editing.\n\nSee more: https://www.typescriptlang.org/tsconfig#disableSolutionSearching"
},
"verbatimModuleSyntax": {
"description": "Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.",
"type": "boolean",
"markdownDescription": "Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.\n\nSee more: https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax"
}
}
}
}
},
"typeAcquisitionDefinition": {
"properties": {
"typeAcquisition": {
"type": "object",
"description": "Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.",
"properties": {
"enable": {
"description": "Enable auto type acquisition",
"type": "boolean",
"default": false
},
"include": {
"description": "Specifies a list of type declarations to be included in auto type acquisition. Ex. [\"jquery\", \"lodash\"]",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"exclude": {
"description": "Specifies a list of type declarations to be excluded from auto type acquisition. Ex. [\"jquery\", \"lodash\"]",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
}
}
}
},
"referencesDefinition": {
"properties": {
"references": {
"type": "array",
"uniqueItems": true,
"description": "Referenced projects. Requires TypeScript version 3.0 or later.",
"items": {
"type": "object",
"description": "Project reference.",
"properties": {
"path": {
"type": "string",
"description": "Path to referenced tsconfig or to folder containing tsconfig."
}
}
}
}
}
},
"tsNodeModuleTypes": {
"type": "object"
},
"tsNodeDefinition": {
"properties": {
"ts-node": {
"description": "ts-node options. See also: https://typestrong.org/ts-node/docs/configuration\n\nts-node offers TypeScript execution and REPL for node.js, with source map support.",
"properties": {
"compiler": {
"default": "typescript",
"description": "Specify a custom TypeScript compiler.",
"type": "string"
},
"compilerHost": {
"default": false,
"description": "Use TypeScript's compiler host API instead of the language service API.",
"type": "boolean"
},
"compilerOptions": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/definitions/compilerOptionsDefinition/properties/compilerOptions"
}
],
"description": "JSON object to merge with TypeScript `compilerOptions`.",
"properties": {},
"type": "object"
},
"emit": {
"default": false,
"description": "Emit output files into `.ts-node` directory.",
"type": "boolean"
},
"esm": {
"description": "Enable native ESM support.\n\nFor details, see https://typestrong.org/ts-node/docs/imports#native-ecmascript-modules",
"type": "boolean"
},
"experimentalReplAwait": {
"description": "Allows the usage of top level await in REPL.\n\nUses node's implementation which accomplishes this with an AST syntax transformation.\n\nEnabled by default when tsconfig target is es2018 or above. Set to false to disable.\n\n**Note**: setting to `true` when tsconfig target is too low will throw an Error. Leave as `undefined`\nto get default, automatic behavior.",
"type": "boolean"
},
"experimentalResolver": {
"description": "Enable experimental features that re-map imports and require calls to support:\n`baseUrl`, `paths`, `rootDirs`, `.js` to `.ts` file extension mappings,\n`outDir` to `rootDir` mappings for composite projects and monorepos.\n\nFor details, see https://github.com/TypeStrong/ts-node/issues/1514",
"type": "boolean"
},
"experimentalSpecifierResolution": {
"description": "Like node's `--experimental-specifier-resolution`, , but can also be set in your `tsconfig.json` for convenience.\n\nFor details, see https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm",
"enum": ["explicit", "node"],
"type": "string"
},
"files": {
"default": false,
"description": "Load \"files\" and \"include\" from `tsconfig.json` on startup.\n\nDefault is to override `tsconfig.json` \"files\" and \"include\" to only include the entrypoint script.",
"type": "boolean"
},
"ignore": {
"default": ["(?:^|/)node_modules/"],
"description": "Paths which should not be compiled.\n\nEach string in the array is converted to a regular expression via `new RegExp()` and tested against source paths prior to compilation.\n\nSource paths are normalized to posix-style separators, relative to the directory containing `tsconfig.json` or to cwd if no `tsconfig.json` is loaded.\n\nDefault is to ignore all node_modules subdirectories.",
"items": {
"type": "string"
},
"type": "array"
},
"ignoreDiagnostics": {
"description": "Ignore TypeScript warnings by diagnostic code.",
"items": {
"type": ["string", "number"]
},
"type": "array"
},
"logError": {
"default": false,
"description": "Logs TypeScript errors to stderr instead of throwing exceptions.",
"type": "boolean"
},
"moduleTypes": {
"$ref": "#/definitions/tsNodeModuleTypes",
"description": "Override certain paths to be compiled and executed as CommonJS or ECMAScript modules.\nWhen overridden, the tsconfig \"module\" and package.json \"type\" fields are overridden, and\nthe file extension is ignored.\nThis is useful if you cannot use .mts, .cts, .mjs, or .cjs file extensions;\nit achieves the same effect.\n\nEach key is a glob pattern following the same rules as tsconfig's \"include\" array.\nWhen multiple patterns match the same file, the last pattern takes precedence.\n\n`cjs` overrides matches files to compile and execute as CommonJS.\n`esm` overrides matches files to compile and execute as native ECMAScript modules.\n`package` overrides either of the above to default behavior, which obeys package.json \"type\" and\ntsconfig.json \"module\" options."
},
"preferTsExts": {
"default": false,
"description": "Re-order file extensions so that TypeScript imports are preferred.\n\nFor example, when both `index.js` and `index.ts` exist, enabling this option causes `require('./index')` to resolve to `index.ts` instead of `index.js`",
"type": "boolean"
},
"pretty": {
"default": false,
"description": "Use pretty diagnostic formatter.",
"type": "boolean"
},
"require": {
"description": "Modules to require, like node's `--require` flag.\n\nIf specified in `tsconfig.json`, the modules will be resolved relative to the `tsconfig.json` file.\n\nIf specified programmatically, each input string should be pre-resolved to an absolute path for\nbest results.",
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"default": false,
"description": "Scope compiler to files within `scopeDir`.",
"type": "boolean"
},
"scopeDir": {
"default": "First of: `tsconfig.json` \"rootDir\" if specified, directory containing `tsconfig.json`, or cwd if no `tsconfig.json` is loaded.",
"type": "string"
},
"skipIgnore": {
"default": false,
"description": "Skip ignore check, so that compilation will be attempted for all files with matching extensions.",
"type": "boolean"
},
"swc": {
"description": "Transpile with swc instead of the TypeScript compiler, and skip typechecking.\n\nEquivalent to setting both `transpileOnly: true` and `transpiler: 'ts-node/transpilers/swc'`\n\nFor complete instructions: https://typestrong.org/ts-node/docs/transpilers",
"type": "boolean"
},
"transpileOnly": {
"default": false,
"description": "Use TypeScript's faster `transpileModule`.",
"type": "boolean"
},
"transpiler": {
"anyOf": [
{
"items": [
{
"type": "string"
},
{
"additionalProperties": true,
"properties": {},
"type": "object"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"type": "string"
}
],
"description": "Specify a custom transpiler for use with transpileOnly"
},
"typeCheck": {
"default": true,
"description": "**DEPRECATED** Specify type-check is enabled (e.g. `transpileOnly == false`).",
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"id": "https://json.schemastore.org/tsconfig",
"title": "JSON schema for the TypeScript compiler's configuration file",
"type": "object"
}
|
nuclei-jsonschema.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/templates.Template",
"definitions": {
"model.Classification": {
"properties": {
"cve-id": {
"$ref": "#/definitions/stringslice.StringSlice",
"title": "cve ids for the template",
"description": "CVE IDs for the template"
},
"cwe-id": {
"$ref": "#/definitions/stringslice.StringSlice",
"title": "cwe ids for the template",
"description": "CWE IDs for the template"
},
"cvss-metrics": {
"type": "string",
"title": "cvss metrics for the template",
"description": "CVSS Metrics for the template",
"examples": [
"3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H"
]
},
"cvss-score": {
"type": "number",
"title": "cvss score for the template",
"description": "CVSS Score for the template"
},
"epss-score": {
"type": "number",
"title": "epss score for the template",
"description": "EPSS Score for the template"
},
"epss-percentile": {
"type": "number",
"title": "epss percentile for the template",
"description": "EPSS Percentile for the template"
},
"cpe": {
"type": "string",
"title": "cpe for the template",
"description": "CPE for the template",
"examples": [
"cpe:/a:vendor:product:version"
]
}
},
"additionalProperties": false,
"type": "object"
},
"model.Info": {
"properties": {
"name": {
"type": "string",
"title": "name of the template",
"description": "Name is a short summary of what the template does",
"examples": [
"Nagios Default Credentials Check"
]
},
"author": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/stringslice.StringSlice",
"title": "author of the template",
"description": "Author is the author of the template"
},
"tags": {
"$ref": "#/definitions/stringslice.StringSlice",
"title": "tags of the template",
"description": "Any tags for the template"
},
"description": {
"type": "string",
"title": "description of the template",
"description": "In-depth explanation on what the template does",
"examples": [
"Bower is a package manager which stores package information in the bower.json file"
]
},
"reference": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/stringslice.RawStringSlice",
"title": "references for the template",
"description": "Links relevant to the template"
},
"severity": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/severity.Holder"
},
"metadata": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "additional metadata for the template",
"description": "Additional metadata fields for the template"
},
"classification": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/model.Classification",
"title": "classification info for the template",
"description": "Classification information for the template"
},
"remediation": {
"type": "string",
"title": "remediation steps for the template",
"description": "In-depth explanation on how to fix the issues found by the template",
"examples": [
"Change the default administrative username and password of Apache ActiveMQ by editing the file jetty-realm.properties"
]
}
},
"additionalProperties": false,
"type": "object"
},
"severity.Holder": {
"enum": [
"info",
"low",
"medium",
"high",
"critical",
"unknown"
],
"type": "string",
"title": "severity of the template",
"description": "Seriousness of the implications of the template"
},
"stringslice.RawStringSlice": {
"oneOf": [
{
"type": "string"
},
{
"type": "array"
}
]
},
"stringslice.StringSlice": {
"oneOf": [
{
"type": "string"
},
{
"type": "array"
}
]
},
"userAgent.UserAgentHolder": {
"enum": [
"off",
"default",
"custom"
],
"type": "string",
"title": "userAgent for the headless",
"description": "userAgent for the headless http request"
},
"extractors.Extractor": {
"required": [
"type"
],
"properties": {
"name": {
"type": "string",
"title": "name of the extractor",
"description": "Name of the extractor"
},
"type": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/extractors.ExtractorTypeHolder"
},
"regex": {
"items": {
"type": "string"
},
"type": "array",
"title": "regex to extract from part",
"description": "Regex to extract from part"
},
"group": {
"type": "integer",
"title": "group to extract from regex",
"description": "Group to extract from regex"
},
"kval": {
"items": {
"type": "string"
},
"type": "array",
"title": "kval pairs to extract from response",
"description": "Kval pairs to extract from response"
},
"json": {
"items": {
"type": "string"
},
"type": "array",
"title": "json jq expressions to extract data",
"description": "JSON JQ expressions to evaluate from response part"
},
"xpath": {
"items": {
"type": "string"
},
"type": "array",
"title": "html xpath expressions to extract data",
"description": "XPath allows using xpath expressions to extract items from html response"
},
"attribute": {
"type": "string",
"title": "optional attribute to extract from xpath",
"description": "Optional attribute to extract from response XPath"
},
"dsl": {
"items": {
"type": "string"
},
"type": "array",
"title": "dsl expressions to extract",
"description": "Optional attribute to extract from response dsl"
},
"part": {
"type": "string",
"title": "part of response to extract data from",
"description": "Part of the request response to extract data from"
},
"internal": {
"type": "boolean",
"title": "mark extracted value for internal variable use",
"description": "Internal when set to true will allow using the value extracted in the next request for some protocols"
},
"case-insensitive": {
"type": "boolean",
"title": "use case insensitive extract",
"description": "use case insensitive extract"
},
"to": {
"type": "string",
"title": "save extracted values to file",
"description": "save extracted values to file"
}
},
"additionalProperties": false,
"type": "object"
},
"extractors.ExtractorTypeHolder": {
"enum": [
"regex",
"kval",
"xpath",
"json",
"dsl"
],
"type": "string",
"title": "type of the extractor",
"description": "Type of the extractor"
},
"matchers.Matcher": {
"required": [
"type"
],
"properties": {
"type": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/matchers.MatcherTypeHolder",
"title": "type of matcher",
"description": "Type of the matcher"
},
"condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between matcher variables",
"description": "Condition between the matcher variables"
},
"part": {
"type": "string",
"title": "part of response to match",
"description": "Part of response to match data from"
},
"negative": {
"type": "boolean",
"title": "negative specifies if match reversed",
"description": "Negative specifies if the match should be reversed. It will only match if the condition is not true"
},
"name": {
"type": "string",
"title": "name of the matcher",
"description": "Name of the matcher"
},
"status": {
"items": {
"type": "integer"
},
"type": "array",
"title": "status to match",
"description": "Status to match for the response"
},
"size": {
"items": {
"type": "integer"
},
"type": "array",
"title": "acceptable size for response",
"description": "Size is the acceptable size for the response"
},
"words": {
"items": {
"type": "string"
},
"type": "array",
"title": "words to match in response",
"description": " Words contains word patterns required to be present in the response part"
},
"regex": {
"items": {
"type": "string"
},
"type": "array",
"title": "regex to match in response",
"description": "Regex contains regex patterns required to be present in the response part"
},
"binary": {
"items": {
"type": "string"
},
"type": "array",
"title": "binary patterns to match in response",
"description": "Binary are the binary patterns required to be present in the response part"
},
"dsl": {
"items": {
"type": "string"
},
"type": "array",
"title": "dsl expressions to match in response",
"description": "DSL are the dsl expressions that will be evaluated as part of nuclei matching rules"
},
"encoding": {
"enum": [
"hex"
],
"type": "string",
"title": "encoding for word field",
"description": "Optional encoding for the word fields"
},
"case-insensitive": {
"type": "boolean",
"title": "use case insensitive match",
"description": "use case insensitive match"
},
"match-all": {
"type": "boolean",
"title": "match all values",
"description": "match all matcher values ignoring condition"
}
},
"additionalProperties": false,
"type": "object"
},
"matchers.MatcherTypeHolder": {
"enum": [
"word",
"regex",
"binary",
"status",
"size",
"dsl"
],
"type": "string",
"title": "type of the matcher",
"description": "Type of the matcher"
},
"fuzz.Rule": {
"properties": {
"type": {
"enum": [
"replace",
"prefix",
"postfix",
"infix"
],
"type": "string",
"title": "type of rule",
"description": "Type of fuzzing rule to perform"
},
"part": {
"enum": [
"query"
],
"type": "string",
"title": "part of rule",
"description": "Part of request rule to fuzz"
},
"mode": {
"enum": [
"single",
"multiple"
],
"type": "string",
"title": "mode of rule",
"description": "Mode of request rule to fuzz"
},
"keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "keys of parameters to fuzz",
"description": "Keys of parameters to fuzz"
},
"keys-regex": {
"items": {
"type": "string"
},
"type": "array",
"title": "keys regex to fuzz",
"description": "Regex of parameter keys to fuzz"
},
"values": {
"items": {
"type": "string"
},
"type": "array",
"title": "values regex to fuzz",
"description": "Regex of parameter values to fuzz"
},
"fuzz": {
"items": {
"type": "string"
},
"type": "array",
"title": "payloads of fuzz rule",
"description": "Payloads to perform fuzzing substitutions with"
}
},
"additionalProperties": false,
"type": "object"
},
"generators.AttackTypeHolder": {
"enum": [
"batteringram",
"pitchfork",
"clusterbomb"
],
"type": "string",
"title": "type of the attack",
"description": "Type of the attack"
},
"variables.Variable": {
"additionalProperties": true,
"type": "object",
"title": "variables for the request",
"description": "Additional variables for the request"
},
"dns.DNSRequestTypeHolder": {
"enum": [
"A",
"NS",
"DS",
"CNAME",
"SOA",
"PTR",
"MX",
"TXT",
"AAAA",
"CAA",
"TLSA",
"ANY"
],
"type": "string",
"title": "type of DNS request to make",
"description": "Type is the type of DNS request to make"
},
"dns.Request": {
"properties": {
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"id": {
"type": "string",
"title": "id of the dns request",
"description": "ID is the optional ID of the DNS Request"
},
"name": {
"type": "string",
"title": "hostname to make dns request for",
"description": "Name is the Hostname to make DNS request for"
},
"type": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/dns.DNSRequestTypeHolder",
"title": "type of dns request to make",
"description": "Type is the type of DNS request to make"
},
"class": {
"enum": [
"inet",
"csnet",
"chaos",
"hesiod",
"none",
"any"
],
"type": "string",
"title": "class of DNS request",
"description": "Class is the class of the DNS request"
},
"retries": {
"type": "integer",
"title": "retries for dns request",
"description": "Retries is the number of retries for the DNS request"
},
"trace": {
"type": "boolean",
"title": "trace operation",
"description": "Trace performs a trace operation for the target."
},
"trace-max-recursion": {
"type": "integer",
"title": "trace-max-recursion level for dns request",
"description": "TraceMaxRecursion is the number of max recursion allowed for trace operations"
},
"attack": {
"$ref": "#/definitions/generators.AttackTypeHolder",
"title": "attack is the payload combination",
"description": "Attack is the type of payload combinations to perform"
},
"payloads": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "payloads for the network request",
"description": "Payloads contains any payloads for the current request"
},
"recursion": {
"type": "boolean",
"title": "recurse all servers",
"description": "Recursion determines if resolver should recurse all records to get fresh results"
},
"resolvers": {
"items": {
"type": "string"
},
"type": "array",
"title": "Resolvers",
"description": "Define resolvers to use within the template"
}
},
"additionalProperties": false,
"type": "object"
},
"file.Request": {
"properties": {
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"extensions": {
"items": {
"type": "string"
},
"type": "array",
"title": "extensions to match",
"description": "List of extensions to perform matching on"
},
"denylist": {
"items": {
"type": "string"
},
"type": "array",
"title": "denylist",
"description": "List of files"
},
"id": {
"type": "string",
"title": "id of the request",
"description": "ID is the optional ID for the request"
},
"max-size": {
"type": "string",
"title": "max size data to run request on",
"description": "Maximum size of the file to run request on"
},
"archive": {
"type": "boolean",
"title": "enable archives",
"description": "Process compressed archives without unpacking"
},
"mime-type": {
"type": "boolean",
"title": "enable filtering by mime-type",
"description": "Filter files by mime-type"
},
"no-recursive": {
"type": "boolean",
"title": "do not perform recursion",
"description": "Specifies whether to not do recursive checks if folders are provided"
}
},
"additionalProperties": false,
"type": "object"
},
"headless.Request": {
"properties": {
"id": {
"type": "string",
"title": "id of the request",
"description": "Optional ID of the headless request"
},
"attack": {
"$ref": "#/definitions/generators.AttackTypeHolder",
"title": "attack is the payload combination",
"description": "Attack is the type of payload combinations to perform"
},
"payloads": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "payloads for the headless request",
"description": "Payloads contains any payloads for the current request"
},
"steps": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/engine.Action"
},
"type": "array",
"title": "list of actions for headless request",
"description": "List of actions to run for headless request"
},
"user_agent": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/userAgent.UserAgentHolder",
"title": "user agent for the headless request",
"description": "User agent for the headless request"
},
"custom_user_agent": {
"type": "string",
"title": "custom user agent for the headless request",
"description": "Custom user agent for the headless request"
},
"stop-at-first-match": {
"type": "boolean",
"title": "stop at first match",
"description": "Stop the execution after a match is found"
},
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"fuzzing": {
"items": {
"$ref": "#/definitions/fuzz.Rule"
},
"type": "array",
"title": "fuzzin rules for http fuzzing",
"description": "Fuzzing describes rule schema to fuzz headless requests"
},
"cookie-reuse": {
"type": "boolean",
"title": "optional cookie reuse enable",
"description": "Optional setting that enables cookie reuse"
}
},
"additionalProperties": false,
"type": "object"
},
"engine.Action": {
"required": [
"action"
],
"properties": {
"args": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"title": "arguments for headless action",
"description": "Args contain arguments for the headless action"
},
"name": {
"type": "string",
"title": "name for headless action",
"description": "Name is the name assigned to the headless action"
},
"description": {
"type": "string",
"title": "description for headless action",
"description": "Description of the headless action"
},
"action": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/engine.ActionTypeHolder",
"title": "action to perform",
"description": "Type of actions to perform"
}
},
"additionalProperties": false,
"type": "object"
},
"engine.ActionTypeHolder": {
"enum": [
"navigate",
"script",
"click",
"rightclick",
"text",
"screenshot",
"time",
"select",
"files",
"waitload",
"getresource",
"extract",
"setmethod",
"addheader",
"setheader",
"deleteheader",
"setbody",
"waitevent",
"keyboard",
"debug",
"sleep",
"waitvisible"
],
"type": "string",
"title": "action to perform",
"description": "Type of actions to perform"
},
"http.HTTPMethodTypeHolder": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
"PATCH",
"PURGE",
"DEBUG"
],
"type": "string",
"title": "method is the HTTP request method",
"description": "Method is the HTTP Request Method"
},
"http.Request": {
"properties": {
"matchers": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"path": {
"items": {
"type": "string"
},
"type": "array",
"title": "path(s) for the http request",
"description": "Path(s) to send http requests to"
},
"raw": {
"items": {
"type": "string"
},
"type": "array",
"description": "HTTP Requests in Raw Format"
},
"id": {
"type": "string",
"title": "id for the http request",
"description": "ID for the HTTP Request"
},
"name": {
"type": "string",
"title": "name for the http request",
"description": "Optional name for the HTTP Request"
},
"attack": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/generators.AttackTypeHolder",
"title": "attack is the payload combination",
"description": "Attack is the type of payload combinations to perform"
},
"method": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/http.HTTPMethodTypeHolder",
"title": "method is the http request method",
"description": "Method is the HTTP Request Method"
},
"body": {
"type": "string",
"title": "body is the http request body",
"description": "Body is an optional parameter which contains HTTP Request body"
},
"payloads": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "payloads for the http request",
"description": "Payloads contains any payloads for the current request"
},
"headers": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"title": "headers to send with the http request",
"description": "Headers contains HTTP Headers to send with the request"
},
"race_count": {
"type": "integer",
"title": "number of times to repeat request in race condition",
"description": "Number of times to send a request in Race Condition Attack"
},
"max-redirects": {
"type": "integer",
"title": "maximum number of redirects to follow",
"description": "Maximum number of redirects that should be followed"
},
"pipeline-concurrent-connections": {
"type": "integer",
"title": "number of pipelining connections",
"description": "Number of connections to create during pipelining"
},
"pipeline-requests-per-connection": {
"type": "integer",
"title": "number of requests to send per pipelining connections",
"description": "Number of requests to send per connection when pipelining"
},
"threads": {
"type": "integer",
"title": "threads for sending requests",
"description": "Threads specifies number of threads to use sending requests. This enables Connection Pooling"
},
"max-size": {
"type": "integer",
"title": "maximum http response body size",
"description": "Maximum size of http response body to read in bytes"
},
"fuzzing": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/fuzz.Rule"
},
"type": "array",
"title": "fuzzin rules for http fuzzing",
"description": "Fuzzing describes rule schema to fuzz http requests"
},
"signature": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/http.SignatureTypeHolder",
"title": "signature is the http request signature method",
"description": "Signature is the HTTP Request signature Method"
},
"cookie-reuse": {
"type": "boolean",
"title": "optional cookie reuse enable",
"description": "Optional setting that enables cookie reuse"
},
"read-all": {
"type": "boolean",
"title": "force read all body",
"description": "Enables force reading of entire unsafe http request body"
},
"redirects": {
"type": "boolean",
"title": "follow http redirects",
"description": "Specifies whether redirects should be followed by the HTTP Client"
},
"host-redirects": {
"type": "boolean",
"title": "follow same host http redirects",
"description": "Specifies whether redirects to the same host should be followed by the HTTP Client"
},
"pipeline": {
"type": "boolean",
"title": "perform HTTP 1.1 pipelining",
"description": "Pipeline defines if the attack should be performed with HTTP 1.1 Pipelining"
},
"unsafe": {
"type": "boolean",
"title": "use rawhttp non-strict-rfc client",
"description": "Unsafe specifies whether to use rawhttp engine for sending Non RFC-Compliant requests"
},
"race": {
"type": "boolean",
"title": "perform race-http request coordination attack",
"description": "Race determines if all the request have to be attempted at the same time (Race Condition)"
},
"req-condition": {
"type": "boolean",
"title": "preserve request history",
"description": "Automatically assigns numbers to requests and preserves their history"
},
"stop-at-first-match": {
"type": "boolean",
"title": "stop at first match",
"description": "Stop the execution after a match is found"
},
"skip-variables-check": {
"type": "boolean",
"title": "skip variable checks",
"description": "Skips the check for unresolved variables in request"
},
"iterate-all": {
"type": "boolean",
"title": "iterate all the values",
"description": "Iterates all the values extracted from internal extractors"
},
"digest-username": {
"type": "string",
"title": "specifies the username for digest authentication",
"description": "Optional parameter which specifies the username for digest auth"
},
"digest-password": {
"type": "string",
"title": "specifies the password for digest authentication",
"description": "Optional parameter which specifies the password for digest auth"
},
"disable-path-automerge": {
"type": "boolean",
"title": "disable auto merging of path",
"description": "Disable merging target url path with raw request path"
}
},
"additionalProperties": false,
"type": "object"
},
"http.SignatureTypeHolder": {
"enum": [
"AWS"
],
"type": "string",
"title": "type of the signature",
"description": "Type of the signature"
},
"network.Input": {
"properties": {
"data": {
"type": "string",
"title": "data to send as input",
"description": "Data is the data to send as the input"
},
"type": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/network.NetworkInputTypeHolder",
"title": "type is the type of input data",
"description": "Type of input specified in data field"
},
"read": {
"type": "integer",
"title": "bytes to read from socket",
"description": "Number of bytes to read from socket"
},
"name": {
"type": "string",
"title": "optional name for data read",
"description": "Optional name of the data read to provide matching on"
}
},
"additionalProperties": false,
"type": "object"
},
"network.NetworkInputTypeHolder": {
"enum": [
"hex",
"text"
],
"type": "string",
"title": "type is the type of input data",
"description": "description=Type of input specified in data field"
},
"network.Request": {
"properties": {
"id": {
"type": "string",
"title": "id of the request",
"description": "ID of the network request"
},
"host": {
"items": {
"type": "string"
},
"type": "array",
"title": "host to send requests to",
"description": "Host to send network requests to"
},
"attack": {
"$ref": "#/definitions/generators.AttackTypeHolder",
"title": "attack is the payload combination",
"description": "Attack is the type of payload combinations to perform"
},
"payloads": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "payloads for the network request",
"description": "Payloads contains any payloads for the current request"
},
"inputs": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/network.Input"
},
"type": "array",
"title": "inputs for the network request",
"description": "Inputs contains any input/output for the current request"
},
"read-size": {
"type": "integer",
"title": "size of network response to read",
"description": "Size of response to read at the end. Default is 1024 bytes"
},
"read-all": {
"type": "boolean",
"title": "read all response stream",
"description": "Read all response stream till the server stops sending"
},
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
}
},
"additionalProperties": false,
"type": "object"
},
"ssl.Request": {
"properties": {
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"address": {
"type": "string",
"title": "address for the ssl request",
"description": "Address contains address for the request"
},
"min_version": {
"enum": [
"sslv3",
"tls10",
"tls11",
"tls12",
"tls13"
],
"type": "string",
"title": "Min. TLS version",
"description": "Minimum tls version - automatic if not specified."
},
"max_version": {
"enum": [
"sslv3",
"tls10",
"tls11",
"tls12",
"tls13"
],
"type": "string",
"title": "Max. TLS version",
"description": "Max tls version - automatic if not specified."
},
"cipher_suites": {
"items": {
"type": "string"
},
"type": "array"
},
"scan_mode": {
"enum": [
"ctls",
"ztls",
"auto"
],
"type": "string",
"title": "Scan Mode",
"description": "Scan Mode - auto if not specified."
}
},
"additionalProperties": false,
"type": "object"
},
"websocket.Input": {
"properties": {
"data": {
"type": "string",
"title": "data to send as input",
"description": "Data is the data to send as the input"
},
"name": {
"type": "string",
"title": "optional name for data read",
"description": "Optional name of the data read to provide matching on"
}
},
"additionalProperties": false,
"type": "object"
},
"websocket.Request": {
"properties": {
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"address": {
"type": "string",
"title": "address for the websocket request",
"description": "Address contains address for the request"
},
"inputs": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/websocket.Input"
},
"type": "array",
"title": "inputs for the websocket request",
"description": "Inputs contains any input/output for the current request"
},
"headers": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"title": "headers contains the request headers",
"description": "Headers contains headers for the request"
},
"attack": {
"$ref": "#/definitions/generators.AttackTypeHolder",
"title": "attack is the payload combination",
"description": "Attack is the type of payload combinations to perform"
},
"payloads": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "payloads for the websocket request",
"description": "Payloads contains any payloads for the current request"
}
},
"additionalProperties": false,
"type": "object"
},
"whois.Request": {
"properties": {
"matchers": {
"items": {
"$ref": "#/definitions/matchers.Matcher"
},
"type": "array",
"title": "matchers to run on response",
"description": "Detection mechanism to identify whether the request was successful by doing pattern matching"
},
"extractors": {
"items": {
"$ref": "#/definitions/extractors.Extractor"
},
"type": "array",
"title": "extractors to run on response",
"description": "Extractors contains the extraction mechanism for the request to identify and extract parts of the response"
},
"matchers-condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between the matchers",
"description": "Conditions between the matchers"
},
"query": {
"type": "string",
"title": "query for the WHOIS request",
"description": "Query contains query for the request"
},
"server": {
"type": "string",
"title": "server url to execute the WHOIS request on",
"description": "Server contains the server url to execute the WHOIS request on"
}
},
"additionalProperties": false,
"type": "object"
},
"templates.Template": {
"required": [
"id",
"info"
],
"properties": {
"id": {
"pattern": "^([a-zA-Z0-9]+[-_])*[a-zA-Z0-9]+$",
"type": "string",
"title": "id of the template",
"description": "The Unique ID for the template",
"examples": [
"cve-2021-19520"
]
},
"info": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/model.Info",
"title": "info for the template",
"description": "Info contains metadata for the template"
},
"requests": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/http.Request"
},
"type": "array",
"title": "http requests to make",
"description": "HTTP requests to make for the template"
},
"http": {
"items": {
"$ref": "#/definitions/http.Request"
},
"type": "array",
"title": "http requests to make",
"description": "HTTP requests to make for the template"
},
"dns": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/dns.Request"
},
"type": "array",
"title": "dns requests to make",
"description": "DNS requests to make for the template"
},
"file": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/file.Request"
},
"type": "array",
"title": "file requests to make",
"description": "File requests to make for the template"
},
"network": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/network.Request"
},
"type": "array",
"title": "network requests to make",
"description": "Network requests to make for the template"
},
"tcp": {
"items": {
"$ref": "#/definitions/network.Request"
},
"type": "array",
"title": "network(tcp) requests to make",
"description": "Network requests to make for the template"
},
"headless": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/headless.Request"
},
"type": "array",
"title": "headless requests to make",
"description": "Headless requests to make for the template"
},
"ssl": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/ssl.Request"
},
"type": "array",
"title": "ssl requests to make",
"description": "SSL requests to make for the template"
},
"websocket": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/websocket.Request"
},
"type": "array",
"title": "websocket requests to make",
"description": "Websocket requests to make for the template"
},
"whois": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/whois.Request"
},
"type": "array",
"title": "whois requests to make",
"description": "WHOIS requests to make for the template"
},
"workflows": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/workflows.WorkflowTemplate"
},
"type": "array",
"title": "list of workflows to execute",
"description": "List of workflows to execute for template"
},
"self-contained": {
"type": "boolean",
"title": "mark requests as self-contained",
"description": "Mark Requests for the template as self-contained"
},
"stop-at-first-match": {
"type": "boolean",
"title": "stop at first match",
"description": "Stop at first match for the template"
},
"signature": {
"$ref": "#/definitions/http.SignatureTypeHolder",
"title": "signature is the http request signature method",
"description": "Signature is the HTTP Request signature Method"
},
"variables": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/variables.Variable",
"title": "variables for the http request",
"description": "Variables contains any variables for the current request"
},
"constants": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object",
"title": "constant for the template",
"description": "constants contains any constant for the template"
}
},
"additionalProperties": false,
"type": "object"
},
"workflows.Matcher": {
"properties": {
"name": {
"$ref": "#/definitions/stringslice.StringSlice",
"title": "name of items to match",
"description": "Name of items to match"
},
"condition": {
"enum": [
"and",
"or"
],
"type": "string",
"title": "condition between names",
"description": "Condition between the names"
},
"subtemplates": {
"items": {
"$ref": "#/definitions/workflows.WorkflowTemplate"
},
"type": "array",
"title": "templates to run after match",
"description": "Templates to run after match"
}
},
"additionalProperties": false,
"type": "object"
},
"workflows.WorkflowTemplate": {
"properties": {
"template": {
"type": "string",
"title": "template/directory to execute",
"description": "Template or directory to execute as part of workflow"
},
"tags": {
"$ref": "#/definitions/stringslice.StringSlice",
"title": "tags to execute",
"description": "Tags to run template based on"
},
"matchers": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/workflows.Matcher"
},
"type": "array",
"title": "name based template result matchers",
"description": "Matchers perform name based matching to run subtemplates for a workflow"
},
"subtemplates": {
"items": {
"$ref": "#/definitions/workflows.WorkflowTemplate"
},
"type": "array",
"title": "subtemplate based result matchers",
"description": "Subtemplates are ran if the template field Template matches"
}
},
"additionalProperties": false,
"type": "object"
}
}
}
|
petstore-v1.0.json | {
"$id": "https://json.schemastore.org/petstore-v1.0.json",
"$ref": "#/definitions/Welcome9",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"Welcome9": {
"type": "object",
"additionalProperties": true,
"properties": {
"config": {
"$ref": "#/definitions/Config"
},
"scenarios": {
"type": "array",
"items": {
"$ref": "#/definitions/Scenario"
}
}
},
"title": "Welcome9"
},
"Config": {
"type": "object",
"additionalProperties": false,
"properties": {
"http": {
"$ref": "#/definitions/HTTP"
},
"tls": {
"$ref": "#/definitions/TLS"
},
"plugins": {
"$ref": "#/definitions/Plugins"
},
"target": {
"type": "string"
},
"phases": {
"type": "array",
"items": {
"$ref": "#/definitions/ConfigPhase"
}
},
"environments": {
"$ref": "#/definitions/Environments"
},
"processor": {
"type": "string"
}
},
"required": [
"environments",
"http",
"phases",
"plugins",
"processor",
"target",
"tls"
],
"title": "Config"
},
"Environments": {
"type": "object",
"additionalProperties": false,
"properties": {
"dev": {
"$ref": "#/definitions/Dev"
},
"qa": {
"$ref": "#/definitions/Dev"
}
},
"required": ["dev", "qa"],
"title": "Environments"
},
"Dev": {
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"type": "string"
},
"phases": {
"type": "array",
"items": {
"$ref": "#/definitions/DevPhase"
}
}
},
"required": ["phases", "target"],
"title": "Dev"
},
"DevPhase": {
"type": "object",
"additionalProperties": false,
"properties": {
"duration": {
"type": "integer"
},
"arrivalRate": {
"type": "integer"
}
},
"required": ["arrivalRate", "duration"],
"title": "DevPhase"
},
"HTTP": {
"type": "object",
"additionalProperties": false,
"properties": {
"timeout": {
"type": "integer"
}
},
"required": ["timeout"],
"title": "HTTP"
},
"ConfigPhase": {
"type": "object",
"additionalProperties": false,
"properties": {
"duration": {
"type": "integer"
},
"arrivalRate": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": ["arrivalRate", "duration", "name"],
"title": "ConfigPhase"
},
"Plugins": {
"type": "object",
"additionalProperties": false,
"properties": {
"expect": {
"$ref": "#/definitions/PluginsExpect"
},
"publish-metrics": {
"type": "array",
"items": {
"$ref": "#/definitions/PublishMetric"
}
},
"metrics-by-endpoint": {
"$ref": "#/definitions/MetricsByEndpoint"
}
},
"required": ["expect", "metrics-by-endpoint", "publish-metrics"],
"title": "Plugins"
},
"PluginsExpect": {
"type": "object",
"additionalProperties": false,
"properties": {
"outputFormat": {
"type": "string"
}
},
"required": ["outputFormat"],
"title": "PluginsExpect"
},
"MetricsByEndpoint": {
"type": "object",
"additionalProperties": false,
"properties": {
"useOnlyRequestNames": {
"type": "boolean"
}
},
"required": ["useOnlyRequestNames"],
"title": "MetricsByEndpoint"
},
"PublishMetric": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "string"
},
"prefix": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"event": {
"$ref": "#/definitions/Event"
}
},
"required": ["event", "host", "port", "prefix", "tags", "type"],
"title": "PublishMetric"
},
"Event": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"send": {
"type": "boolean"
},
"status": {
"type": "string"
},
"priority": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["priority", "send", "status", "tags", "title"],
"title": "Event"
},
"TLS": {
"type": "object",
"additionalProperties": false,
"properties": {
"rejectUnauthorized": {
"type": "boolean"
}
},
"required": ["rejectUnauthorized"],
"title": "TLS"
},
"Scenario": {
"type": "object",
"additionalProperties": false,
"properties": {
"flow": {
"type": "array",
"items": {
"$ref": "#/definitions/Flow"
}
}
},
"required": ["flow"],
"title": "Scenario"
},
"Flow": {
"type": "object",
"additionalProperties": false,
"properties": {
"post": {
"$ref": "#/definitions/Post"
},
"get": {
"$ref": "#/definitions/Get"
},
"delete": {
"$ref": "#/definitions/Delete"
},
"function": {
"type": "string"
}
},
"required": [],
"title": "Flow"
},
"Delete": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"headers": {
"$ref": "#/definitions/DeleteHeaders"
},
"expect": {
"type": "array",
"items": {
"$ref": "#/definitions/ExpectElement"
}
}
},
"required": ["expect", "headers", "name", "url"],
"title": "Delete"
},
"ExpectElement": {
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
}
},
"required": ["statusCode"],
"title": "ExpectElement"
},
"DeleteHeaders": {
"type": "object",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string"
},
"accept": {
"type": "string"
},
"api_key": {
"type": "string"
}
},
"required": ["accept", "api_key", "contentType"],
"title": "DeleteHeaders"
},
"Get": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"headers": {
"$ref": "#/definitions/GetHeaders"
},
"expect": {
"type": "array",
"items": {
"$ref": "#/definitions/ExpectElement"
}
},
"qs": {
"$ref": "#/definitions/Qs"
}
},
"required": ["expect", "headers", "name", "url"],
"title": "Get"
},
"GetHeaders": {
"type": "object",
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string"
},
"accept": {
"type": "string"
}
},
"required": ["accept"],
"title": "GetHeaders"
},
"Qs": {
"type": "object",
"additionalProperties": false,
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": ["password", "username"],
"title": "Qs"
},
"Post": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"headers": {
"$ref": "#/definitions/PostHeaders"
},
"json": {
"$ref": "#/definitions/JSON"
},
"expect": {
"type": "array",
"items": {
"$ref": "#/definitions/ExpectElement"
}
},
"capture": {
"type": "array",
"items": {
"$ref": "#/definitions/Capture"
}
}
},
"required": ["expect", "headers", "json", "name", "url"],
"title": "Post"
},
"Capture": {
"type": "object",
"additionalProperties": false,
"properties": {
"as": {
"type": "string"
},
"json": {
"type": "string"
}
},
"required": ["as", "json"],
"title": "Capture"
},
"PostHeaders": {
"type": "object",
"additionalProperties": false,
"properties": {
"accept": {
"type": "string"
},
"Content-Type": {
"type": "string"
}
},
"required": ["Content-Type", "accept"],
"title": "PostHeaders"
},
"JSON": {
"type": "object",
"additionalProperties": false,
"properties": {
"photoUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"id": {
"type": "integer"
},
"category": {
"$ref": "#/definitions/Category"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Category"
}
},
"status": {
"type": "string"
},
"username": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"phone": {
"type": "string"
},
"userStatus": {
"type": "integer"
}
},
"required": ["id"],
"title": "JSON"
},
"Category": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "integer"
}
},
"required": ["id", "name"],
"title": "Category"
}
}
}
|
settings.json | {
"$schema": "http://json-schema.org/draft-07/schema",
"definitions": {
"color": {
"oneOf": [
{
"type": "string",
"examples": [
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"bold",
"underlined",
"red_bold",
"green_bold",
"yellow_bold",
"blue_bold",
"magenta_bold",
"cyan_bold",
"red_underlined",
"green_underlined",
"yellow_underlined",
"blue_underlined",
"magenta_underlined",
"cyan_underlined"
]
},
{
"type": "null"
}
]
}
},
"title": "settings",
"description": "Settings of the current application\nhttps://bashly.dannyb.co/usage/settings/#settings",
"type": "object",
"properties": {
"source_dir": {
"title": "source dir",
"description": "A directory with source files of the current script\nhttps://bashly.dannyb.co/usage/settings/#source_dir",
"type": "string",
"minLength": 1,
"default": "src"
},
"config_path": {
"title": "config path",
"description": "A path to bashly.yml of the current script\nhttps://bashly.dannyb.co/usage/settings/#config_path",
"type": "string",
"minLength": 1,
"default": "%{source_dir}/bashly.yml"
},
"target_dir": {
"title": "target dir",
"description": "A directory of the current script\nhttps://bashly.dannyb.co/usage/settings/#target_dir",
"type": "string",
"minLength": 1,
"default": "."
},
"lib_dir": {
"title": "lib dir",
"description": "A directory to common library files of the current script\nhttps://bashly.dannyb.co/usage/settings/#lib_dir",
"type": "string",
"minLength": 1,
"default": "lib"
},
"commands_dir": {
"title": "commands dir",
"description": "A directory to nested command files of the current script\nhttps://bashly.dannyb.co/usage/settings/#commands_dir",
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"strict": {
"title": "strict",
"description": "Bash initialiation options of the current script\nhttps://bashly.dannyb.co/usage/settings/#strict",
"oneOf": [
{
"type": "boolean"
},
{
"type": "string",
"examples": [
"set -o pipefail"
]
}
],
"default": false
},
"tab_indent": {
"title": "tab indent",
"description": "Whether to use tabs in the the current script\nhttps://bashly.dannyb.co/usage/settings/#tab_indent",
"type": "boolean",
"default": false
},
"compact_short_flags": {
"title": "compact short flags",
"description": "Whether to expand short flags of the current script\nhttps://bashly.dannyb.co/usage/settings/#compact_short_flags",
"type": "boolean",
"default": true
},
"env": {
"title": "env",
"description": "Whether to include development related comments in the current script\nhttps://bashly.dannyb.co/usage/settings/#env",
"type": "string",
"enum": [
"development",
"production"
],
"default": "development"
},
"partials_extension": {
"title": "partials extension",
"description": "A partial snippet extension of the current script\nhttps://bashly.dannyb.co/usage/settings/#partials_extension",
"type": "string",
"minLength": 1,
"default": "sh"
},
"usage_colors": {
"title": "usage colors",
"description": "Usage colors of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
"type": "object",
"properties": {
"caption": {
"title": "caption",
"description": "A caption color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
"$ref": "#/definitions/color"
},
"command": {
"title": "command",
"description": "A command color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
"$ref": "#/definitions/color"
},
"arg": {
"title": "arg",
"description": "An argument color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
"$ref": "#/definitions/color"
},
"flag": {
"title": "flag",
"description": "A flag color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
"$ref": "#/definitions/color"
},
"environment_variable": {
"title": "environment variable",
"description": "An environment variable color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
"$ref": "#/definitions/color"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
} |
mtaext.json | {
"$id": "http://example.com/MTA/.mtaext",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"hooks": {
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The name of the existing hook that will be modified by this extension.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"parameters": {
"description": "Configuration parameters that are used when executing the hook to the target runtime environment.",
"type": "object"
},
"requires": {
"description": "List of the existing required dependencies that will be modified by this extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The name of the existing required dependencies that will be modified.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"parameters": {
"description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string",
"type": "object"
}
}
}
}
}
}
}
},
"description": "MTA extension descriptor schema v3.3",
"properties": {
"_schema-version": {
"description": "Used to indicate to an MTA processing tool (e.g. a deployer), which schema version was taken as the base when authoring a descriptor.",
"type": "string",
"pattern": "^[1-9]\\d*(\\.\\d+){0,2}$",
"default": "3.3.0"
},
"ID": {
"description": "A globally unique ID of this MTA extension descriptor. Unlimited string of unicode characters.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"extends": {
"description": "A globally unique ID of the MTA or the MTA extension which shall be extended by this descriptor.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"description": {
"description": "A non-translatable description of this MTA extension. This is not a text for application users.",
"type": "string"
},
"provider": {
"description": "The provider or vendor.",
"type": "string"
},
"parameters": {
"description": "Global parameters that will be added to the application.",
"type": "object"
},
"hooks": {
"description": "A list of the existing hooks that will be modified by the extension.",
"$ref": "#/definitions/hooks"
},
"modules": {
"description": "List of the existing modules that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The module name which must match an existing module defined by the deployment descriptor.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"properties": {
"description": "A collection of key-value pairs that are available to the module at runtime.",
"type": "object"
},
"parameters": {
"description": "Configuration parameters that are used when deploying the module to the target runtime environment.",
"type": "object"
},
"hooks": {
"description": "A list of the existing hooks that will be modified by the extension.",
"$ref": "#/definitions/hooks"
},
"requires": {
"description": "List of the existing required dependencies that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The dependency name which must match an existing required dependency defined by the deployment descriptor.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"properties": {
"description": "Required properties can be mapped from provided properties. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string",
"type": "object"
},
"parameters": {
"description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string",
"type": "object"
}
}
}
},
"provides": {
"description": "List of the existing provided dependencies that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The dependency name which must match an existing provided dependency defined by the deployment descriptor.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"properties": {
"description": "Property names and values make up the configuration data which is to be provided to requiring modules at runtime",
"type": "object"
},
"parameters": {
"description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string",
"type": "object"
}
}
}
}
}
}
},
"resources": {
"description": "List of the existing resources that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The resource name which must match an existing resource defined by the deployment descriptor.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"active": {
"description": "If a resource is declared to be active, it is allocated and bound according to declared requirements. Default value is true.",
"type": "boolean"
},
"properties": {
"description": "Property names and values make up the configuration data which is to be provided to requiring modules at runtime.",
"type": "object"
},
"parameters": {
"description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to requiring modules at runtime. Untyped resources cannot have parameters.",
"type": "object"
},
"hooks": {
"description": "List of existing hooks that will be modified by the extension.",
"$ref": "#/definitions/hooks"
},
"requires": {
"description": "List of the existing required dependencies that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The name of the existing required dependency that will be modified.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"properties": {
"description": "Required properties can be mapped from provided properties. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string",
"type": "object"
},
"parameters": {
"description": "Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the resource at runtime. Provided property values can be accessed by \"~{<provided-property-name>}\". Such expressions can be part of an arbitrary string",
"type": "object"
}
}
}
}
}
}
},
"module-types": {
"description": "A list of existing module type definitions that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The name of the existing module type that will be modified.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"properties": {
"description": "A collection of key-value pairs that will be inherited by all modules of this type.",
"type": "object"
},
"parameters": {
"description": "Configuration parameters that will be inherited in all modules of this type.",
"type": "object"
}
}
}
},
"resource-types": {
"description": "A list of existing resource type definitions that will be modified by the extension.",
"type": "array",
"items": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "The name of the existing resource type that will be modified.",
"type": "string",
"pattern": "^[A-Za-z0-9_\\-\\.]+$"
},
"properties": {
"description": "A collection of key-value pairs that will be inherited by all modules of this type.",
"type": "object"
},
"parameters": {
"description": "Configuration parameters that will be inherited in all resources of this type.",
"type": "object"
}
}
}
}
},
"required": ["_schema-version", "ID", "extends"],
"title": ".mtaext v3.3",
"type": "object"
}
|
tikibase.schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Config",
"description": "Tikibase configuration data",
"type": "object",
"properties": {
"$schema": {
"description": "link to the JSON-Schema definition for this file",
"type": [
"string",
"null"
]
},
"bidiLinks": {
"description": "enables bi-directional links",
"type": [
"boolean",
"null"
]
},
"ignore": {
"description": "Names of filesystem entries to ignore in this directory.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"sections": {
"description": "the allowed section titles",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"standaloneDocs": {
"description": "whether documents without links are allowed",
"type": [
"boolean",
"null"
]
},
"titleRegEx": {
"description": "regex with a single capture group to extract a shorter title for links to notes",
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
|
schema-org-contact-point.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json"
}
],
"description": "This is a JSON schema representation of the schema.org Action schema: https://schema.org/ContactPoint",
"id": "https://json.schemastore.org/schema-org-contact-point.json",
"properties": {
"@context": {
"type": "string",
"format": "regex",
"pattern": "http://schema.org",
"description": "override the @context property to ensure the schema.org URI is used"
},
"@type": {
"description": "override the @type property to ensure ContactPoint is used",
"type": "string",
"format": "regex",
"pattern": "ContactPoint"
},
"areaServed": {
"description": "The geographic area where a service or offered item is provided. Supersedes serviceArea.",
"anyOf": [
{
"type": "array",
"items": {
"oneOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "AdministrativeArea"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "GeoShape"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Place"
},
{
"type": "string"
}
]
}
},
{
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "AdministrativeArea"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "GeoShape"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Place"
},
{
"type": "string"
}
]
}
]
},
"availableLanguage": {
"description": "A language someone may use with the item. Please use one of the language codes from the IETF BCP 47 standard. See also inLanguage",
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Language"
}
]
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Language"
}
]
}
}
]
},
"contactOption": {
"description": "An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers).",
"anyOf": [
{
"type": "array",
"items": {
"oneOf": [
{
"enum": ["HearingImpairedSupported", "TollFree"]
}
]
}
},
{
"enum": ["HearingImpairedSupported", "TollFree"]
}
]
},
"contactType": {
"description": "A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point.",
"type": "string"
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email"
},
"faxNumber": {
"description": "The fax number.",
"type": "string"
},
"hoursAvailable": {
"description": "The hours during which this service or contact is available. (OpeningHoursSpecification)",
"$ref": "https://json.schemastore.org/schema-org-thing.json"
},
"productSupported": {
"description": "The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. \"iPhone\") or a general category of products or services (e.g. \"smartphones\").",
"anyOf": [
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Product"
}
]
}
},
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Product"
}
]
}
]
},
"telephone": {
"description": "The telephone number.",
"type": "string"
}
},
"required": ["@type"],
"title": "JSON schema for schema.org / ContactPoint",
"type": "object"
}
|
pterodactyl.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://json.schemastore.org/pterodactyl.json",
"properties": {
"_comment": {
"type": "string",
"description": "A comment to ignore"
},
"meta": {
"type": "object"
},
"exported_at": {
"type": "string"
},
"name": {
"type": "string",
"description": "The egg's name"
},
"author": {
"type": "string",
"description": "The egg's author"
},
"description": {
"type": "string",
"description": "The egg's description"
},
"features": {
"type": "array",
"description": "A list of features to use",
"items": {
"type": "string"
}
},
"docker_images": {
"type": "object",
"description": "Object containing key-value pairs of a pretty Docker image name and its URL"
},
"file_denylist": {
"type": "array",
"items": {
"type": "string"
}
},
"startup": {
"type": "string",
"description": "Command to run on startup",
"x-intellij-language-injection": "Shell Script"
},
"config": {
"type": "object",
"description": "Object to store configuration"
},
"scripts": {
"type": "object",
"description": "A list of possible scripts to execute",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"type": "object",
"properties": {
"container": {
"type": "string",
"description": "Container to run script in"
},
"entrypoint": {
"type": "string",
"description": "Entrypoint of script"
}
}
}
}
},
"variables": {
"type": "array",
"description": "Object of variables that can be used to change the startup command",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the variable."
},
"description": {
"type": "string",
"description": "Description of the variable."
},
"env_variable": {
"type": "string",
"description": "The environment variable that corresponds to this variable. This can be referenced in the startup command."
},
"default_value": {
"type": "string",
"description": "Default value of the variable."
},
"user_viewable": {
"type": "boolean",
"description": "Setting to true allows a user to view the field on the front-end, as well as the assigned value of that variable. They will be able to see it replaced in their startup command."
},
"user_editable": {
"type": "boolean",
"description": "Set to true if the variable is editable by the user"
},
"rules": {
"type": "string",
"description": "Rules to validate the variable against."
},
"field_type": {
"type": "string"
}
}
}
}
},
"type": "object"
}
|
calqulus-pipeline.schema.json | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"line_endings": "unix",
"$id": "https://qualisys.com/schemas/calqulus-pipeline",
"title": "Qualisys Calqulus Pipeline",
"description": "A document describing calculations to be done on biomechanical data for presentation in a report.",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/Parameter Node"
},
{
"$ref": "#/$defs/Space Node"
},
{
"$ref": "#/$defs/Event Node"
},
{
"$ref": "#/$defs/Marker Node"
},
{
"$ref": "#/$defs/Segment Node"
}
]
},
"$defs": {
"parameter": {
"title": "Parameter node",
"description": "A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.",
"type": "string"
},
"space": {
"title": "Space node",
"description": "A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.",
"type": "string"
},
"event": {
"title": "Event node",
"description": "A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.",
"type": "string"
},
"marker": {
"title": "Marker node",
"description": "A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.",
"type": "string"
},
"segment": {
"title": "Marker node",
"description": "A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.",
"type": "string"
},
"steps": {
"title": "Node steps",
"description": "A step node takes an input and some options and outputs a value.\t\t\t\t\t",
"type": "array",
"additionalItems": false,
"items": {
"oneOf": [
{
"type": "object",
"title": "Step: angle",
"description": "The angle step performs slightly different operation depending on the type and number of inputs.\n\nNote: _For cases where multiple inputs are given of varying lengths, the returning array will be the maximum length and the last value will be repeated for the shorter inputs to fill the gap._\n\nOne input: `` Computes the euler angle of the specified segment, in degrees.\n\nTwo inputs: (, ) | (, ) Given two segments: Computes the relative (euler) angle between the specified segments, in degrees.\n\nGiven two vectors: Computes relative angle between the specified vectors, in radians.\n\nThree inputs: , , Computes the angle between the two vectors defined by the specified points (v0 -> v1, v1 -> v2), in radians. The points can be specified as arrays or with named vector signals (ie markers).\n\nGiven the inputs v1, v2 and v3, the resulting angle is given by:\n\nangleBetween(v1 - v0, v1 - v2)\n\nFour inputs: , , , Computes the angle between the two lines formed by (v0 -> v1, v2 -> v3), in radians. The points can be specified as arrays or with named vector signals (ie markers).",
"properties": {
"angle": {
"title": "angle step",
"description": "The angle step performs slightly different operation depending on the type and number of inputs.\n\nNote: _For cases where multiple inputs are given of varying lengths, the returning array will be the maximum length and the last value will be repeated for the shorter inputs to fill the gap._\n\nOne input: `` Computes the euler angle of the specified segment, in degrees.\n\nTwo inputs: (, ) | (, ) Given two segments: Computes the relative (euler) angle between the specified segments, in degrees.\n\nGiven two vectors: Computes relative angle between the specified vectors, in radians.\n\nThree inputs: , , Computes the angle between the two vectors defined by the specified points (v0 -> v1, v1 -> v2), in radians. The points can be specified as arrays or with named vector signals (ie markers).\n\nGiven the inputs v1, v2 and v3, the resulting angle is given by:\n\nangleBetween(v1 - v0, v1 - v2)\n\nFour inputs: , , , Computes the angle between the two lines formed by (v0 -> v1, v2 -> v3), in radians. The points can be specified as arrays or with named vector signals (ie markers).",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"project": {
"$ref": "#/$defs/categoryOption Angle project"
},
"rotationOrder": {
"$ref": "#/$defs/categoryOption Angle rotationOrder"
},
"unwrap": {
"$ref": "#/$defs/categoryOption Angle unwrap"
}
},
"required": [
"angle"
]
},
{
"type": "object",
"title": "Step: angularVelocity",
"description": "This step calculates the joint angular velocity based on the textbook Research Methods in Biomechanics (2nd Edition).\n\nYou can visit http://www.kwon3d.com/theory/euler/avel.html for more details.\n\nThis is different from calculating the first-order derivate of the joint angle because each axis of the joint angle are different from the axes of the segment coordinate systems.\n\n**Please consider which implementation would be correct to use in your instance**.",
"properties": {
"angularVelocity": {
"title": "angularVelocity step",
"description": "This step calculates the joint angular velocity based on the textbook Research Methods in Biomechanics (2nd Edition).\n\nYou can visit http://www.kwon3d.com/theory/euler/avel.html for more details.\n\nThis is different from calculating the first-order derivate of the joint angle because each axis of the joint angle are different from the axes of the segment coordinate systems.\n\n**Please consider which implementation would be correct to use in your instance**.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"useRotationOrder": {
"title": "angularVelocity > useRotationOrder",
"description": "If set to false it means that the angular velocity between the segment and refernce segment is transformed to be expressed into the resolution coordinate system.\n\nIf set to true it means that angular velocity between the segment and refernce segment is transformed to be expressed into the joint coordinate system using the Euler/Cardan sequence.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"project": {
"$ref": "#/$defs/categoryOption Angle project"
},
"rotationOrder": {
"$ref": "#/$defs/categoryOption Angle rotationOrder"
},
"unwrap": {
"$ref": "#/$defs/categoryOption Angle unwrap"
}
},
"required": [
"angularVelocity"
]
},
{
"type": "object",
"title": "Step: jointAngle",
"description": "Performs the same computation as angle, but does not handle three or four inputs.",
"properties": {
"jointAngle": {
"title": "jointAngle step",
"description": "Performs the same computation as angle, but does not handle three or four inputs.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"project": {
"$ref": "#/$defs/categoryOption Angle project"
},
"rotationOrder": {
"$ref": "#/$defs/categoryOption Angle rotationOrder"
},
"unwrap": {
"$ref": "#/$defs/categoryOption Angle unwrap"
}
},
"required": [
"jointAngle"
]
},
{
"type": "object",
"title": "Step: jointAngleVelocity",
"description": "Performs the same computation as angularVelocity.",
"properties": {
"jointAngleVelocity": {
"title": "jointAngleVelocity step",
"description": "Performs the same computation as angularVelocity.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"useRotationOrder": {
"title": "jointAngleVelocity > useRotationOrder",
"description": "If set to false it means that the angular velocity between the segment and refernce segment is transformed to be expressed into the resolution coordinate system.\n\nIf set to true it means that angular velocity between the segment and refernce segment is transformed to be expressed into the joint coordinate system using the Euler/Cardan sequence.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"project": {
"$ref": "#/$defs/categoryOption Angle project"
},
"rotationOrder": {
"$ref": "#/$defs/categoryOption Angle rotationOrder"
},
"unwrap": {
"$ref": "#/$defs/categoryOption Angle unwrap"
}
},
"required": [
"jointAngleVelocity"
]
},
{
"type": "object",
"title": "Step: count",
"description": "Counts the number of values in the input, i.e. the number of frames in a series, or the number of values in a scalar or event input.",
"properties": {
"count": {
"title": "count step",
"description": "Counts the number of values in the input, i.e. the number of frames in a series, or the number of values in a scalar or event input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"count"
]
},
{
"type": "object",
"title": "Step: max",
"description": "Outputs the max value of the input.",
"properties": {
"max": {
"title": "max step",
"description": "Outputs the max value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"frames": {
"title": "max > frames",
"description": "If set to true, this step returns the frame index for the maximum value of the input. If using cycles, it will return a frame per cycle.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"max"
]
},
{
"type": "object",
"title": "Step: mean",
"description": "Outputs the mean value of the input.",
"properties": {
"mean": {
"title": "mean step",
"description": "Outputs the mean value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"mean"
]
},
{
"type": "object",
"title": "Step: median",
"description": "Outputs the median value of the input.",
"properties": {
"median": {
"title": "median step",
"description": "Outputs the median value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"median"
]
},
{
"type": "object",
"title": "Step: min",
"description": "Outputs the minimum value of the input.",
"properties": {
"min": {
"title": "min step",
"description": "Outputs the minimum value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"frames": {
"title": "min > frames",
"description": "If set to true, this step returns the frame index for the minimum value of the input. If using cycles, it will return a frame per cycle.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"min"
]
},
{
"type": "object",
"title": "Step: range",
"description": "Outputs the range between the minimum and maximum value of the input.",
"properties": {
"range": {
"title": "range step",
"description": "Outputs the range between the minimum and maximum value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"range"
]
},
{
"type": "object",
"title": "Step: rms",
"description": "Outputs the Root Mean Square (root of the average squared deviations) between two arrays.",
"properties": {
"rms": {
"title": "rms step",
"description": "Outputs the Root Mean Square (root of the average squared deviations) between two arrays.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"rms"
]
},
{
"type": "object",
"title": "Step: standardDeviation",
"description": "Outputs the standard deviation value of the input.",
"properties": {
"standardDeviation": {
"title": "standardDeviation step",
"description": "Outputs the standard deviation value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"standardDeviation"
]
},
{
"type": "object",
"title": "Step: standardDeviation",
"description": "Outputs the standard deviation value of the input.",
"properties": {
"stdDev": {
"title": "stdDev step",
"description": "Outputs the standard deviation value of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"stdDev"
]
},
{
"type": "object",
"title": "Step: sum",
"description": "Outputs the sum of all values of the input.",
"properties": {
"sum": {
"title": "sum step",
"description": "Outputs the sum of all values of the input.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"useCycles": {
"$ref": "#/$defs/categoryOption Aggregation useCycles"
}
},
"required": [
"sum"
]
},
{
"type": "object",
"title": "Step: add",
"description": "Adds the input operands.",
"properties": {
"add": {
"title": "add step",
"description": "Adds the input operands.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"frameSequenceOrder": {
"$ref": "#/$defs/categoryOption Arithmetic frameSequenceOrder"
}
},
"required": [
"add"
]
},
{
"type": "object",
"title": "Step: divide",
"description": "Divides the input operands.",
"properties": {
"divide": {
"title": "divide step",
"description": "Divides the input operands.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"frameSequenceOrder": {
"$ref": "#/$defs/categoryOption Arithmetic frameSequenceOrder"
}
},
"required": [
"divide"
]
},
{
"type": "object",
"title": "Step: multiply",
"description": "Multiplies the input operands.",
"properties": {
"multiply": {
"title": "multiply step",
"description": "Multiplies the input operands.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"frameSequenceOrder": {
"$ref": "#/$defs/categoryOption Arithmetic frameSequenceOrder"
}
},
"required": [
"multiply"
]
},
{
"type": "object",
"title": "Step: subtract",
"description": "Subtracts the input operands.",
"properties": {
"subtract": {
"title": "subtract step",
"description": "Subtracts the input operands.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"frameSequenceOrder": {
"$ref": "#/$defs/categoryOption Arithmetic frameSequenceOrder"
}
},
"required": [
"subtract"
]
},
{
"type": "object",
"title": "Step: distance",
"description": "Accepts marker or segment sequences and calculates the distance between the points (Euclidian norm).\n\nIt assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.",
"properties": {
"distance": {
"title": "distance step",
"description": "Accepts marker or segment sequences and calculates the distance between the points (Euclidian norm).\n\nIt assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"distance"
]
},
{
"type": "object",
"title": "Step: magnitude",
"description": "Accepts a vector or a segment sequence and calculates the magnitude of it (Euclidian norm).",
"properties": {
"magnitude": {
"title": "magnitude step",
"description": "Accepts a vector or a segment sequence and calculates the magnitude of it (Euclidian norm).",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"magnitude"
]
},
{
"type": "object",
"title": "Step: plane",
"description": "Takes three marker or segment sequences and returns the plane which intersects all three points.\n\nIt assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.",
"properties": {
"plane": {
"title": "plane step",
"description": "Takes three marker or segment sequences and returns the plane which intersects all three points.\n\nIt assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"plane"
]
},
{
"type": "object",
"title": "Step: project",
"description": "Orthogonally projects a point onto a plane and returns the location of the projected point.\n\nNote: *The plane will remain in the space used when creating it, applying a space to the project step will apply the space to the vector / segment, but the plane will be left untouched.*",
"properties": {
"project": {
"title": "project step",
"description": "Orthogonally projects a point onto a plane and returns the location of the projected point.\n\nNote: *The plane will remain in the space used when creating it, applying a space to the project step will apply the space to the vector / segment, but the plane will be left untouched.*",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
},
"angle": {
"type": "null"
}
},
"required": [
"project"
]
},
{
"type": "object",
"title": "Step: unitVector",
"description": "Calculates the unit vector i.e. the new vector has the same direction of the input vector but its norm equals 1.",
"properties": {
"unitVector": {
"title": "unitVector step",
"description": "Calculates the unit vector i.e. the new vector has the same direction of the input vector but its norm equals 1.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"unitVector"
]
},
{
"type": "object",
"title": "Step: abs",
"description": "Outputs the absolute value for each value in the input signal.",
"properties": {
"abs": {
"title": "abs step",
"description": "Outputs the absolute value for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"abs"
]
},
{
"type": "object",
"title": "Step: convert",
"description": "For each value of the input, converts it according to the units defined in the from and to options.",
"properties": {
"convert": {
"title": "convert step",
"description": "For each value of the input, converts it according to the units defined in the from and to options.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"from": {
"title": "convert > from",
"description": "Defines the unit to convert from.",
"additionalProperties": false,
"type": [
"string"
]
},
"to": {
"title": "convert > to",
"description": "Defines the unit to convert to.",
"additionalProperties": false,
"type": [
"string"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"convert",
"from",
"to"
]
},
{
"type": "object",
"title": "Step: diff",
"description": "Outputs the difference between each value in the input. Since this compares value n with n+1, the output signal will be shorter by one item.",
"properties": {
"diff": {
"title": "diff step",
"description": "Outputs the difference between each value in the input. Since this compares value n with n+1, the output signal will be shorter by one item.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"diff"
]
},
{
"type": "object",
"title": "Step: dotProduct",
"description": "Calculates the dot product between two vectors.\n\nThe output length will be equal to the length of the first vector sequence.\n\nThe second vector sequence needs to be singular or equal to the first vector sequence in length.\n\nA lone vector in the second input will be used to calculate the dot product between itself and all vectors contained in the first vector sequence.",
"properties": {
"dotProduct": {
"title": "dotProduct step",
"description": "Calculates the dot product between two vectors.\n\nThe output length will be equal to the length of the first vector sequence.\n\nThe second vector sequence needs to be singular or equal to the first vector sequence in length.\n\nA lone vector in the second input will be used to calculate the dot product between itself and all vectors contained in the first vector sequence.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"dotProduct"
]
},
{
"type": "object",
"title": "Step: dotProduct",
"description": "Calculates the dot product between two vectors.\n\nThe output length will be equal to the length of the first vector sequence.\n\nThe second vector sequence needs to be singular or equal to the first vector sequence in length.\n\nA lone vector in the second input will be used to calculate the dot product between itself and all vectors contained in the first vector sequence.",
"properties": {
"dot": {
"title": "dot step",
"description": "Calculates the dot product between two vectors.\n\nThe output length will be equal to the length of the first vector sequence.\n\nThe second vector sequence needs to be singular or equal to the first vector sequence in length.\n\nA lone vector in the second input will be used to calculate the dot product between itself and all vectors contained in the first vector sequence.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"dot"
]
},
{
"type": "object",
"title": "Step: gapFill",
"description": "Outputs a resulting signal of the same type as the input signal where gaps are filled using interpolation.\n\nNote: *Gaps at the beginning or end of the signal will not be interpolated.*",
"properties": {
"gapFill": {
"title": "gapFill step",
"description": "Outputs a resulting signal of the same type as the input signal where gaps are filled using interpolation.\n\nNote: *Gaps at the beginning or end of the signal will not be interpolated.*",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"type": {
"title": "gapFill > type",
"description": "",
"additionalProperties": false,
"type": [
"string"
]
},
"maxGapLength": {
"title": "gapFill > maxGapLength",
"description": "",
"additionalProperties": false,
"type": [
"string"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"gapFill"
]
},
{
"type": "object",
"title": "Step: integral",
"description": "Returns the cumulative integral between neighboring frames in a data series, using the trapezoidal rule. It returns a series by default.",
"properties": {
"integral": {
"title": "integral step",
"description": "Returns the cumulative integral between neighboring frames in a data series, using the trapezoidal rule. It returns a series by default.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"scalar": {
"title": "integral > scalar",
"description": "Returns the integral as a single value scalar.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"useCycles": {
"title": "integral > useCycles",
"description": "If the signal has cycles defined, the integral step will be run separately over each signal, and a list of values are returned, one for each cycle.\n\nTo avoid this behaviour, set useCycles to false.\n\nFor information on how to set event cycles on a signal, see the eventMask step.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"integral"
]
},
{
"type": "object",
"title": "Step: negate",
"description": "Outputs the negated value for each value in the input signal.",
"properties": {
"negate": {
"title": "negate step",
"description": "Outputs the negated value for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"negate"
]
},
{
"type": "object",
"title": "Step: round",
"description": "Outputs a resulting signal of the same type as the input signal where every value is rounded to the specific precision.\n\nThe precision is specified as the number of decimal places to include in the result.",
"properties": {
"round": {
"title": "round step",
"description": "Outputs a resulting signal of the same type as the input signal where every value is rounded to the specific precision.\n\nThe precision is specified as the number of decimal places to include in the result.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"precision": {
"title": "round > precision",
"description": "",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"round"
]
},
{
"type": "object",
"title": "Step: acceleration",
"description": "Derives the input signal to the second order.\n\nNote: _Due to the temporal nature of this operation, the resulting first and last frames will be null._\n\nNote: _This operation will split the series on gaps and derive each \"slice\" individually. The first and last frame on each \"slice\" will be null._",
"properties": {
"acceleration": {
"title": "acceleration step",
"description": "Derives the input signal to the second order.\n\nNote: _Due to the temporal nature of this operation, the resulting first and last frames will be null._\n\nNote: _This operation will split the series on gaps and derive each \"slice\" individually. The first and last frame on each \"slice\" will be null._",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"acceleration"
]
},
{
"type": "object",
"title": "Step: derivative",
"description": "Derives the input signal to the order defined in input 2. If input 2 is not set, the signal is derived to order 1.\n\nOnly the first and second order is supported.\n\nNote: _Due to the temporal nature of this operation, the resulting first and last frames will be null._\n\nNote: _This operation will split the series on gaps and derive each \"slice\" individually. The first and last frame on each \"slice\" will be null._",
"properties": {
"derivative": {
"title": "derivative step",
"description": "Derives the input signal to the order defined in input 2. If input 2 is not set, the signal is derived to order 1.\n\nOnly the first and second order is supported.\n\nNote: _Due to the temporal nature of this operation, the resulting first and last frames will be null._\n\nNote: _This operation will split the series on gaps and derive each \"slice\" individually. The first and last frame on each \"slice\" will be null._",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"derivative"
]
},
{
"type": "object",
"title": "Step: velocity",
"description": "Derives the input signal to the first order.\n\nNote: _Due to the temporal nature of this operation, the resulting first and last frame will be null._\n\nNote: _This operation will split the series on gaps and derive each \"slice\" individually. The first and last frame on each \"slice\" will be null._",
"properties": {
"velocity": {
"title": "velocity step",
"description": "Derives the input signal to the first order.\n\nNote: _Due to the temporal nature of this operation, the resulting first and last frame will be null._\n\nNote: _This operation will split the series on gaps and derive each \"slice\" individually. The first and last frame on each \"slice\" will be null._",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"velocity"
]
},
{
"type": "object",
"title": "Step: highpass",
"description": "Runs a Butterworth IIR high-pass filter over the input data.",
"properties": {
"highpass": {
"title": "highpass step",
"description": "Runs a Butterworth IIR high-pass filter over the input data.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"extrapolate": {
"title": "highpass > extrapolate",
"description": "Extrapolation buffer. Defines how many frames to add on either side of the series, useful if the filter handles the edges of the series strangely.\n\nLeading and trailing NaN values are removed before extrapolation, i.e., extrapolation begins from the first and last real value. NaN values are then re-inserted in the original places for the output.\n\nExtrapolation is made by looking at the first and second values, and the last and second-to-last values, respectively. The buffer is then filled with values linearly extrapolated from these two points.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"iterations": {
"title": "highpass > iterations",
"description": "Defines how many times to apply the filter in sequence. If the iterations is set to anything other than 1, the filter will be applied multiple times, using the output of the previous iteration as the input for the next.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"cutoff": {
"title": "highpass > cutoff",
"description": "Defines around what frequency to limit the filter. The filter will attenuate frequencies below this value.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"order": {
"title": "highpass > order",
"description": "Defines the filter order. The higher the order, the steeper the attenuation slope will be.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"highpass"
]
},
{
"type": "object",
"title": "Step: lowpass",
"description": "Runs a Butterworth IIR low-pass filter over the input data.",
"properties": {
"lowpass": {
"title": "lowpass step",
"description": "Runs a Butterworth IIR low-pass filter over the input data.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"extrapolate": {
"title": "lowpass > extrapolate",
"description": "Extrapolation buffer. Defines how many frames to add on either side of the series, useful if the filter handles the edges of the series strangely.\n\nLeading and trailing NaN values are removed before extrapolation, i.e., extrapolation begins from the first and last real value. NaN values are then re-inserted in the original places for the output.\n\nExtrapolation is made by looking at the first and second values, and the last and second-to-last values, respectively. The buffer is then filled with values linearly extrapolated from these two points.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"iterations": {
"title": "lowpass > iterations",
"description": "Defines how many times to apply the filter in sequence. If the iterations is set to anything other than 1, the filter will be applied multiple times, using the output of the previous iteration as the input for the next.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"cutoff": {
"title": "lowpass > cutoff",
"description": "Defines around what frequency to limit the filter. The filter will attenuate frequencies above this value.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"order": {
"title": "lowpass > order",
"description": "Defines the filter order. The higher the order, the steeper the attenuation slope will be.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"lowpass"
]
},
{
"type": "object",
"title": "Step: acos",
"description": "Outputs the arc cosine (or inverse cosine) for each value in the input signal.",
"properties": {
"acos": {
"title": "acos step",
"description": "Outputs the arc cosine (or inverse cosine) for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"acos"
]
},
{
"type": "object",
"title": "Step: asin",
"description": "Outputs the arcsine (or inverse sine) for each value in the input signal.",
"properties": {
"asin": {
"title": "asin step",
"description": "Outputs the arcsine (or inverse sine) for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"asin"
]
},
{
"type": "object",
"title": "Step: atan",
"description": "Outputs the arctangent (or inverse sine) for each value in the input signal.",
"properties": {
"atan": {
"title": "atan step",
"description": "Outputs the arctangent (or inverse sine) for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"atan"
]
},
{
"type": "object",
"title": "Step: atan2",
"description": "Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.",
"properties": {
"atan2": {
"title": "atan2 step",
"description": "Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"atan2"
]
},
{
"type": "object",
"title": "Step: cos",
"description": "Outputs the cosine for each value in the input signal.",
"properties": {
"cos": {
"title": "cos step",
"description": "Outputs the cosine for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"cos"
]
},
{
"type": "object",
"title": "Step: cosh",
"description": "Outputs the hyperbolic cosine for each value in the input signal.",
"properties": {
"cosh": {
"title": "cosh step",
"description": "Outputs the hyperbolic cosine for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"cosh"
]
},
{
"type": "object",
"title": "Step: cotan",
"description": "Outputs the cotangent for each value in the input signal.",
"properties": {
"cotan": {
"title": "cotan step",
"description": "Outputs the cotangent for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"cotan"
]
},
{
"type": "object",
"title": "Step: sin",
"description": "Outputs the sine for each value in the input signal.",
"properties": {
"sin": {
"title": "sin step",
"description": "Outputs the sine for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"sin"
]
},
{
"type": "object",
"title": "Step: sinh",
"description": "Outputs the hyperbolic sine for each value in the input signal.",
"properties": {
"sinh": {
"title": "sinh step",
"description": "Outputs the hyperbolic sine for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"sinh"
]
},
{
"type": "object",
"title": "Step: tan",
"description": "Outputs the tangent for each value in the input signal.",
"properties": {
"tan": {
"title": "tan step",
"description": "Outputs the tangent for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"tan"
]
},
{
"type": "object",
"title": "Step: tanh",
"description": "Outputs the hyperbolic tangent for each value in the input signal.",
"properties": {
"tanh": {
"title": "tanh step",
"description": "Outputs the hyperbolic tangent for each value in the input signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"tanh"
]
},
{
"type": "object",
"title": "Step: if",
"description": "Runs a logical expression. The return value is determined by the result of the expression, and the then and else options.\n\nThe following operators are supported:\n\n >=\n\nParentheses can be used to influence the order of evaluation.\n\nOnly numbers and single-element arrays can be part of the expression.",
"properties": {
"if": {
"title": "if step",
"description": "Runs a logical expression. The return value is determined by the result of the expression, and the then and else options.\n\nThe following operators are supported:\n\n >=\n\nParentheses can be used to influence the order of evaluation.\n\nOnly numbers and single-element arrays can be part of the expression.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"then": {
"title": "if > then",
"description": "",
"additionalProperties": false
},
"else": {
"title": "if > else",
"description": "",
"additionalProperties": false
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"if",
"then",
"else"
]
},
{
"type": "object",
"title": "Step: event",
"description": "Imports an event by name.",
"properties": {
"event": {
"title": "event step",
"description": "Imports an event by name.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"event"
]
},
{
"type": "object",
"title": "Step: import",
"description": "Generic import of any input by name.",
"properties": {
"import": {
"title": "import step",
"description": "Generic import of any input by name.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"import"
]
},
{
"type": "object",
"title": "Step: marker",
"description": "Imports a marker series by name or creates a new signal with a custom origin.",
"properties": {
"marker": {
"title": "marker step",
"description": "Imports a marker series by name or creates a new signal with a custom origin.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"origin": {
"title": "marker > origin",
"description": "This option can be used to create a new marker signal, with a custom x, y and z coordinate.",
"additionalProperties": false,
"type": [
"string",
"array"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"marker"
]
},
{
"type": "object",
"title": "Step: segment",
"description": "Imports a segment series by name.",
"properties": {
"segment": {
"title": "segment step",
"description": "Imports a segment series by name.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"segment"
]
},
{
"type": "object",
"title": "Step: eventDuration",
"description": "This step takes 2 event inputs and outputs an array of durations (in seconds).\n\nInputs 1 and 2 will be combined into pairs - from values in input 1 to values in input 2.\n\nThe duration is calculated using the frame rate from either the \"from\", or \"to\" input event.",
"properties": {
"eventDuration": {
"title": "eventDuration step",
"description": "This step takes 2 event inputs and outputs an array of durations (in seconds).\n\nInputs 1 and 2 will be combined into pairs - from values in input 1 to values in input 2.\n\nThe duration is calculated using the frame rate from either the \"from\", or \"to\" input event.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"eventDuration"
]
},
{
"type": "object",
"title": "Step: eventMask",
"description": "This is a step which takes a signal and 2 event inputs and outputs a filtered signal with values only appearing in between the events.\n\nInputs 2 and 3 will be combined into pairs from values in input 2 to values in input 3.\n\nThese pairs can be used to filter the values in input 1.\n\nThese event pairs, or cycles are also stored on the resulting signal, which can be used in aggregations to aggregate over event cycles. The signal will keep the cycle information no matter if the signal was truncated or not.\n\nIf the signal input is an event, only event frames that is within the span of one of the event pairs will be returned.\n\nThe optional parameter replacement will, if set, replace masked values with the given value. If replacement is not set and truncate is true – the masked values will be removed. The replacement property has no effect when the signal input is an event.\n\nIf replacement is not set and truncate is false (default behavior), the output signal is untouched, except that the event cycles are annotated on the signal.",
"properties": {
"eventMask": {
"title": "eventMask step",
"description": "This is a step which takes a signal and 2 event inputs and outputs a filtered signal with values only appearing in between the events.\n\nInputs 2 and 3 will be combined into pairs from values in input 2 to values in input 3.\n\nThese pairs can be used to filter the values in input 1.\n\nThese event pairs, or cycles are also stored on the resulting signal, which can be used in aggregations to aggregate over event cycles. The signal will keep the cycle information no matter if the signal was truncated or not.\n\nIf the signal input is an event, only event frames that is within the span of one of the event pairs will be returned.\n\nThe optional parameter replacement will, if set, replace masked values with the given value. If replacement is not set and truncate is true – the masked values will be removed. The replacement property has no effect when the signal input is an event.\n\nIf replacement is not set and truncate is false (default behavior), the output signal is untouched, except that the event cycles are annotated on the signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"keep": {
"title": "eventMask > keep",
"description": "An index or an array of indices of events in each cycle to keep. This allows you to keep only a subset of event instances in each cycle.\n\nNegative numbers can be used to count from the end of the cycle, e.g. -1 is the last event in the cycle.\n\nNote: This only applies to event inputs.",
"additionalProperties": false,
"type": [
"string",
"number",
"array"
]
},
"replacement": {
"title": "eventMask > replacement",
"description": "Replacement value to use for masked values. If not set, masked values will be removed from the output signal.\n\nThe replacement property has no effect when the signal input is an event.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"truncate": {
"title": "eventMask > truncate",
"description": "Whether or not the signal should be truncated, i.e., if values that were not within an \"event pair\" should be removed or not.\n\nThis will only apply if replacement does not have a value.",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"eventMask"
]
},
{
"type": "object",
"title": "Step: eventTime",
"description": "This step takes an event input and converts each frame value to a time value (in seconds).\n\nThe time is calculated using the frame rate from the signal.",
"properties": {
"eventTime": {
"title": "eventTime step",
"description": "This step takes an event input and converts each frame value to a time value (in seconds).\n\nThe time is calculated using the frame rate from the signal.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"eventTime"
]
},
{
"type": "object",
"title": "Step: refineEvent",
"description": "This step allows you to easily pick out frames from an event only when they appear in a specific sequence of other events.\n\nThe main input of this step is the event you want to select frames from.\n\nThe required option sequence defines a sequence of events to happen in order. This option requires at least one instance of the main input event (otherwise, no event would be able to be picked from the sequence).\n\nMultiple instances of the main input event can be supplied to the sequence to enable more complex patterns of events.\n\nThe optional option exclude defines events that cannot occur in a sequence. If it does, the sequence is invalidated, meaning no events will be picked from this sequence.\n\nThe exclude option cannot contain any signals defined in the sequence option.\n\nThe optional option cyclic defines whether or not the sequence should be treated as cyclic, i.e., if the sequence starts and ends with the same events, those events are included in the next \"match-finding\" iteration of the sequence. This is useful for refining event cycles where the end event is the start event of the next cycle.\n\nThe cyclic option is true by default and has to be explicitly set to false to disable.",
"properties": {
"refineEvent": {
"title": "refineEvent step",
"description": "This step allows you to easily pick out frames from an event only when they appear in a specific sequence of other events.\n\nThe main input of this step is the event you want to select frames from.\n\nThe required option sequence defines a sequence of events to happen in order. This option requires at least one instance of the main input event (otherwise, no event would be able to be picked from the sequence).\n\nMultiple instances of the main input event can be supplied to the sequence to enable more complex patterns of events.\n\nThe optional option exclude defines events that cannot occur in a sequence. If it does, the sequence is invalidated, meaning no events will be picked from this sequence.\n\nThe exclude option cannot contain any signals defined in the sequence option.\n\nThe optional option cyclic defines whether or not the sequence should be treated as cyclic, i.e., if the sequence starts and ends with the same events, those events are included in the next \"match-finding\" iteration of the sequence. This is useful for refining event cycles where the end event is the start event of the next cycle.\n\nThe cyclic option is true by default and has to be explicitly set to false to disable.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"sequence": {
"title": "refineEvent > sequence",
"description": "A sequence of events. This must include at least one instance of the main input event.",
"additionalProperties": false,
"type": [
"string",
"array"
]
},
"exclude": {
"title": "refineEvent > exclude",
"description": "Event(s) that will invalidate an event sequence if found within it.",
"additionalProperties": false,
"type": [
"string",
"array"
]
},
"cyclic": {
"title": "refineEvent > cyclic",
"description": "Whether or not to treat sequences as cyclic (true as default).",
"additionalProperties": false,
"type": [
"string",
"boolean"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"refineEvent",
"sequence"
]
},
{
"type": "object",
"title": "Step: peakFinder",
"description": "Find peaks inside a signal based on peak properties.\n\nAt first, it will detect any peak-like features in the signal. If any of the options distance, height, prominence, or width is defined, it will use those properties to filter out peaks that match the criteria.\n\nAs a last step, if the sequence option is used, it will match the peaks against a sequence to return a subset of the peaks.\n\nAs a general rule, the peakFinder step is sensitive to noise in the data, so if noise is expected, first run the data through a low-pass filter.\n\nBased on the SciPy find_peaks function.",
"properties": {
"peakFinder": {
"title": "peakFinder step",
"description": "Find peaks inside a signal based on peak properties.\n\nAt first, it will detect any peak-like features in the signal. If any of the options distance, height, prominence, or width is defined, it will use those properties to filter out peaks that match the criteria.\n\nAs a last step, if the sequence option is used, it will match the peaks against a sequence to return a subset of the peaks.\n\nAs a general rule, the peakFinder step is sensitive to noise in the data, so if noise is expected, first run the data through a low-pass filter.\n\nBased on the SciPy find_peaks function.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"distance": {
"title": "peakFinder > distance",
"description": "Required minimal horizontal distance (>= 1) in samples between neighbouring peaks.\n\nSmaller peaks are removed first until the condition is fulfilled for all remaining peaks.",
"additionalProperties": false,
"type": [
"string",
"number",
"array"
]
},
"height": {
"title": "peakFinder > height",
"description": "Required height of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required height.",
"additionalProperties": false,
"type": [
"string",
"number",
"array"
]
},
"prominence": {
"title": "peakFinder > prominence",
"description": "Required prominence of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required prominence.",
"additionalProperties": false,
"type": [
"string",
"number",
"array"
]
},
"relHeight": {
"title": "peakFinder > relHeight",
"description": "Used for calculation of the peaks width, thus it is only used if width is given.\n\nChooses the relative height at which the peak width is measured as a percentage of its prominence. 1.0 calculates the width of the peak at its lowest contour line while 0.5 evaluates at half the prominence height. Must be at least 0.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"sequence": {
"title": "peakFinder > sequence",
"description": "Allows to classify peaks using a pattern and select peaks from the pattern to use as the output.\n\nSee below for further information.",
"additionalProperties": false,
"type": [
"object"
],
"properties": {
"ranges": {
"title": "peakFinder > sequence > ranges",
"description": "Classification of the peak heights. This option expects a string consisting of 1-character labels separated by a boundary value.\n\nThe boundary values represent a percentage between 0 – 100 which defined the end of the previous label's range and the beginning of the next label's range.\n\nThe entire range 0 – 100 represents the difference between the lowest peak and the highest peak. All peaks will be somewhere in this range, and the ranges option allows you to customize how the peaks are labelled.\n\nThe default ranges value is: L 50 H. This labels the peaks that end up in the bottom 50% of the peak heights as L, and the remaining top 50% as H.\n\nThe syntax, L 50 H, is equivalent to writing 0 L 50 H 100.\n\nThe outer boundaries 0 and 100 is assumed though and are not required.\n\nIf you would like to classify the peaks into three groups, the bottom 25% as L, the top 25% and H, and anything in between as M, you can supply the following string: L 25 M 75 H.\n\nThe labels used should each be 1 character long, but can be whatever you want as long as it corresponds to the pattern used in the pattern option.",
"additionalProperties": false,
"type": [
"string"
]
},
"pattern": {
"title": "peakFinder > sequence > pattern",
"description": "A pattern describing a sequence of classified peak heights using the labels defined in the ranges option.\n\nIf you have supplied the ranges string L 50 H, and you want to find the following sequence of peaks: \"a low peak followed by a low peak followed by a high peak, you can define the pattern as LLH.\n\nEach matching pattern sequence is stored and the pattern indices in keep determines which of the peaks that are returned.",
"additionalProperties": false,
"type": [
"string"
]
},
"keep": {
"title": "peakFinder > sequence > keep",
"description": "An array of indices from the pattern labels to keep in the output. The index is zero-based, i.e., the first item in the sequence pattern is 0, the last in the sequence is the (length of the pattern) - 1.\n\nIf the pattern was defined as LLH and we wanted to keep only the first (low) peak in each matching sequence, we would set keep to [0].\n\nConversely if we wanted to keep the last (high) peak in each sequence, the keep should be [2].\n\nTo keep both the first and last peaks in the sequence, the keep option should be set to [0, 2].\n\nPeaks in the sequence pattern not indexed by keep will be ignored in the output.",
"additionalProperties": false,
"type": [
"string",
"array"
]
}
}
},
"width": {
"title": "peakFinder > width",
"description": "Required width of peaks in samples. Either a number or a\n2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required width.",
"additionalProperties": false,
"type": [
"string",
"number",
"array"
]
},
"window": {
"title": "peakFinder > window",
"description": "Used for calculation of the peaks prominences, thus it is only used if one of the arguments prominence or width is given.\n\nA window length in samples that optionally limits the evaluated area for each peak to a subset of x. The peak is always placed in the middle of the window therefore the given length is rounded up to the next odd integer. This parameter can speed up the calculation.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"peakFinder"
]
},
{
"type": "object",
"title": "Step: threshold",
"description": "This step will register an event for every frame where the signal passes the specified threshold value.\n\nBy default, an event is registered when the signal crosses the threshold in either an ascending or descending direction.\n\nBy configuring the direction option, you can specify a certain direction that will trigger the event; up (ascending) or down (descending).",
"properties": {
"threshold": {
"title": "threshold step",
"description": "This step will register an event for every frame where the signal passes the specified threshold value.\n\nBy default, an event is registered when the signal crosses the threshold in either an ascending or descending direction.\n\nBy configuring the direction option, you can specify a certain direction that will trigger the event; up (ascending) or down (descending).",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"value": {
"title": "threshold > value",
"description": "The threshold value to use.",
"additionalProperties": false,
"type": [
"string",
"number"
]
},
"direction": {
"title": "threshold > direction",
"description": "The direction of crossing the threshold to record.",
"additionalProperties": false,
"type": [
"string"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"threshold"
]
},
{
"type": "object",
"title": "Step: concatenate",
"description": "The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.",
"properties": {
"concatenate": {
"title": "concatenate step",
"description": "The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"concatenate"
]
},
{
"type": "object",
"title": "Step: vector",
"description": "The vector step takes one or three inputs and outputs a vector sequence signal.\n\nIf given three numeric or 1-dimensional series inputs, each input will be assigned to the x, y, and z components, respectively.\n\nAlternatively, if only one input is given and it contains at least three components, the first three components will be used to construct the vector sequence.\n\nIf the inputs have different lengths, the output signal will be the length of the longest input and shorter inputs will be padded with NaN values.",
"properties": {
"vector": {
"title": "vector step",
"description": "The vector step takes one or three inputs and outputs a vector sequence signal.\n\nIf given three numeric or 1-dimensional series inputs, each input will be assigned to the x, y, and z components, respectively.\n\nAlternatively, if only one input is given and it contains at least three components, the first three components will be used to construct the vector sequence.\n\nIf the inputs have different lengths, the output signal will be the length of the longest input and shorter inputs will be padded with NaN values.",
"additionalProperties": false,
"type": [
"string",
"array",
"null"
]
},
"export": {
"$ref": "#/$defs/globalOption export"
},
"output": {
"$ref": "#/$defs/globalOption output"
},
"set": {
"$ref": "#/$defs/globalOption set"
},
"space": {
"$ref": "#/$defs/globalOption space"
}
},
"required": [
"vector"
]
}
]
}
},
"where": {
"title": "Measurement filtering",
"description": "When importing a signal or defining an output node, you can specify a measurement from which the signal should be imported – or for which measurement an output node should run.\n\nYou can filter measurements by name and by field values and you can use wildcard characters `*` to formulate patterns to match partial values. The matching of values is case-insensitive.\n\nWhen using a measurement filter, a list of matching measurements is created. By specifying the `index` option, you can define which of the matching measurements should apply.",
"type": "object",
"properties": {
"name": {
"title": "Name filter",
"description": "Target a measurement by name",
"type": "string"
},
"index": {
"title": "Index filter",
"description": "Out of a number of matching measurements, pick the nth match. Either a 1-based index, or the values `first` or `last` to select the first or last match, respectively.",
"type": [
"integer",
"string"
],
"if": {
"type": "string"
},
"then": {
"enum": [
"first",
"last"
]
}
},
"fields": {
"title": "Field filter",
"description": "Target a measurement by a field value.",
"type": "object",
"additionalProperties": {
"title": "Field to match against",
"type": "string"
}
}
},
"additionalProperties": false
},
"set": {
"title": "Output set",
"description": "Used to specify which _set_ the exported parameter will use. In most cases, this will be either `left` or `right`.\n\nIf not set, the JSON output will use set: null.",
"type": "string"
},
"spaceOrigin": {
"title": "Origin",
"description": "Sets the origin of a custom coordinate system.",
"type": [
"string",
"array"
]
},
"spacePrimaryAxis": {
"title": "Primary axis",
"description": "Sets the primary axis of a custom coordinate system. The primary axis of the custom coordinate system will always be a unit vector with the same direction as this vector.\n\t\t\t\t\nIf more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the primary axis.",
"type": [
"string",
"array"
]
},
"spaceSecondaryAxis": {
"title": "Secondary axis",
"description": "Sets the secondary axis of a custom coordinate system. The actual secondary axis of the custom coordinate system might differ from the vector specified, since the secondary axis must be a unit vector perpendicular to the primary axis.\n\t\t\t\t\nIf more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the secondary axis.",
"type": [
"string",
"array"
]
},
"spaceOrder": {
"title": "Order",
"description": "Defines what axis the primary and secondary axis corresponds to. The first letter defines the name of the primary axis, and the second letter defines the name of the secondary axis.\n\t\t\t\t\nPossible values:\nxy - Primary axis: x, secondary axis: y\nyx - Primary axis: y, secondary axis: x\nxz - Primary axis: x, secondary axis: z\nyz - Primary axis: y, secondary axis: z\nzy - Primary axis: z, secondary axis: y",
"type": "string",
"enum": [
"xy",
"yx",
"xz",
"yz",
"zy"
]
},
"spaceAlignWithSegment": {
"title": "Align with segment",
"description": "Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space.\n\nThe rotation is based on the average orientation of the segment during a measurement.",
"type": [
"object"
],
"properties": {
"segment": {
"title": "Segment to align to",
"description": "Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space.\n\nThe rotation is based on the average orientation of the segment during a measurement.",
"type": "string"
}
},
"required": [
"segment"
]
},
"Parameter Node": {
"title": "Parameter node",
"description": "A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.",
"type": "object",
"properties": {
"parameter": {
"$ref": "#/$defs/parameter"
},
"steps": {
"$ref": "#/$defs/steps"
},
"where": {
"$ref": "#/$defs/where"
},
"set": {
"$ref": "#/$defs/set"
}
},
"required": [
"parameter",
"steps"
],
"additionalProperties": false
},
"Space Node": {
"type": "object",
"properties": {
"space": {
"$ref": "#/$defs/space"
},
"origin": {
"$ref": "#/$defs/spaceOrigin"
},
"primaryAxis": {
"$ref": "#/$defs/spacePrimaryAxis"
},
"secondaryAxis": {
"$ref": "#/$defs/spaceSecondaryAxis"
},
"order": {
"$ref": "#/$defs/spaceOrder"
},
"alignWithSegment": {
"$ref": "#/$defs/spaceAlignWithSegment"
},
"steps": {
"$ref": "#/$defs/steps"
},
"where": {
"$ref": "#/$defs/where"
},
"set": {
"$ref": "#/$defs/set"
}
},
"oneOf": [
{
"required": [
"space",
"alignWithSegment"
]
},
{
"required": [
"space",
"primaryAxis",
"secondaryAxis"
]
}
],
"additionalProperties": false
},
"Event Node": {
"type": "object",
"properties": {
"event": {
"$ref": "#/$defs/event"
},
"steps": {
"$ref": "#/$defs/steps"
},
"where": {
"$ref": "#/$defs/where"
},
"set": {
"$ref": "#/$defs/set"
}
},
"required": [
"event",
"steps"
],
"additionalProperties": false
},
"Marker Node": {
"type": "object",
"properties": {
"marker": {
"$ref": "#/$defs/marker"
},
"steps": {
"$ref": "#/$defs/steps"
},
"where": {
"$ref": "#/$defs/where"
},
"set": {
"$ref": "#/$defs/set"
}
},
"required": [
"marker",
"steps"
],
"additionalProperties": false
},
"Segment Node": {
"type": "object",
"properties": {
"segment": {
"$ref": "#/$defs/segment"
},
"steps": {
"$ref": "#/$defs/steps"
},
"where": {
"$ref": "#/$defs/where"
},
"set": {
"$ref": "#/$defs/set"
}
},
"required": [
"segment",
"steps"
],
"additionalProperties": false
},
"globalOption export": {
"title": "export (global option)",
"description": "If this option is set, the result of this step will be exposed on the global scope, as well as being exported to the resulting JSON file.\n\nThe value of this option will be the name of the exported data and can be used to load the resulting data in other steps.",
"additionalProperties": false,
"type": [
"string"
],
"name": "export"
},
"globalOption output": {
"title": "output (global option)",
"description": "If this option is set, the result of this step will be exposed on the local scope.\n\nThe value of this option will be the name of the output data and can be used to load the resulting data in other steps within the same output node.\n\nYou can also use the short-form \"arrow syntax\" to define an output.",
"additionalProperties": false,
"type": [
"string"
],
"name": "output"
},
"globalOption set": {
"title": "set (global option)",
"description": "Used to specify which set the exported parameter will use. In most cases, this will be either left or right.\n\nThis option is only used in two cases; where there is also an export option set, or on the last step in a list. In the latter case, the step's set is used only if there's no set defined on the parent output node.\n\nIf this option is not set, the JSON output will use set: null.",
"additionalProperties": false,
"type": [
"string"
],
"name": "set"
},
"globalOption space": {
"title": "space (global option)",
"description": "This option lets you reference a space where you want the input data for the step to be translated into.\n\nAll named inputs will automatically be converted.\n\nNOTE: This is not yet implemented for segments.",
"additionalProperties": false,
"type": [
"string"
],
"name": "space"
},
"categoryOption Angle project": {
"title": "project (Angle category option)",
"description": "If set to a string, the angle will be calculated in two dimensions on the specified coordinate plane by ignoring the component of the input signals which is not part of the plane.\n\nUsing a PlaneSequence, projects the input vectors on the provided plane.\n\nNote: _The projection is only applied for vector-based angles and is ignored when calculating joint angles._",
"additionalProperties": false,
"type": [
"string"
],
"name": "project",
"category": "Angle"
},
"categoryOption Angle rotationOrder": {
"title": "rotationOrder (Angle category option)",
"description": "The rotation order to use for calculating the Euler angle. Possible rotation orders are:\n\nCardan sequence: XYZ YZX ZXY XZY YXZ ZYX\n\nEuler sequence: XYX XZX YXY YZY ZXZ ZYZ",
"additionalProperties": false,
"type": [
"string"
],
"name": "rotationOrder",
"category": "Angle"
},
"categoryOption Angle unwrap": {
"title": "unwrap (Angle category option)",
"description": "When set to true, an event, or a numeric value, the unwrap option shifts the angle phases in order to achieve a continuous curve, i.e., it tries to detect when an angle crosses over its available range (-PI to PI for radians, -180 to 180 degrees).\n\nThis allows for tracking angles on movements that goes outside of the typical angle range.\n\nTo do this, it looks for jumps between consecutive angles. If the jump is greater than a threshold of half the range (PI for radians, 180 for degrees), the angle is shifted by adding multiples of of the range until the jump no longer crosses the threshold.\n\nThe unwrap algorithm is run over all available components.\n\nIf set to true or 0, the algorithm aligns the unwrap to the start of the sequence. I.e., it assumes the first frame is correct in being within the original range and the following angles are moved to follow suit.\n\nIf set to an Event or a Number, the algorithm will assume that the corresponding frame is correct in being within the original range. All other angles will be shifted to follow suit. This enables tracking a rotational movement where the angle for a specific event is intended to be within the standard range (-PI to PI for radians, -180 to 180 degrees).\n\nIF a supplied event has more than one instance, the first instance is used.\n\nNote: _The unwrap algorithm is sensitive to noise, which may introduce unexpected artifacts. Please consider filtering the signal(s) before calculating its angle using unwrap._",
"additionalProperties": false,
"type": [
"string",
"boolean",
"number"
],
"name": "unwrap",
"category": "Angle"
},
"categoryOption Aggregation useCycles": {
"title": "useCycles (Aggregation category option)",
"description": "If the signal has cycles defined, the aggregation will be run separately over each signal, and a list of values are returned, one for each cycle.\n\nTo avoid this behaviour, set useCycles to false.\n\nFor information on how to set event cycles on a signal, see the eventMask step.",
"additionalProperties": false,
"type": [
"string",
"boolean"
],
"name": "useCycles",
"category": "Aggregation"
},
"categoryOption Arithmetic frameSequenceOrder": {
"title": "frameSequenceOrder (Arithmetic category option)",
"description": "If set to any value but none, the input signals will pass through a function which returns a list of signals where each value is from a frame greater than or equal to the frame of the corresponding value from the preceding Signal.\n\nIf set to forward, it will start from the first value of the first (leftmost) input signal (operand) and the algorithm will look at subsequent operands (to the right) one \"row\" at a time.\n\nConversely, if set to reverse, the event sequencing uses the reverse order of operands and goes from right to left.\n\nIf a full \"row\" of values could not be matched, it is not included in the result, i.e., all operands will be of the same length.\n\nThis is useful, for example, when calculating the distance between two signals at a certain event.\n\nThe function will only apply if all input signals have applied a Frames filter, otherwise the signals are left untouched.\n\nExample\n\nsubtract: [LeftFoot.y@LFS, RightFoot.y@RFS] frameSequenceOrder: reverse\n\n_Creates an event sequence from the inputs, starting from the second operand (RFS event) and creates event pairs RFS -> LFS out of the values. It then subtracts each frame from the RightFoot from the corresponding LeftFoot frame._\n\n_If frameSequenceOrder had been set to forward, it would have created pairs going from LFS -> RFS instead._\n\n_Using the frameSequenceOrder option ensures that the operands starts with the intended event and that both operands have the same length._",
"additionalProperties": false,
"type": [
"string"
],
"name": "frameSequenceOrder",
"category": "Arithmetic"
}
}
} |
dss-2.0.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dss2-SignRequestType": {
"$xsd-type": "SignRequestType",
"$xsd-full-type": "dss2:SignRequestType",
"type": "object",
"properties": {
"profile": {
"type": "array",
"items": {
"type": "string"
}
},
"reqID": {
"type": "string"
},
"inDocs": {
"$ref": "#/definitions/dss2-InputDocumentsType"
},
"optInp": {
"$ref": "#/definitions/dss2-OptionalInputsSignType"
}
}
},
"dss2-InputDocumentsType": {
"$xsd-type": "InputDocumentsType",
"$xsd-full-type": "dss2:InputDocumentsType",
"type": "object",
"properties": {
"doc": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentType"
}
},
"transformed": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-TransformedDataType"
}
},
"docHash": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentHashType"
}
}
}
},
"dss2-DocumentType": {
"$xsd-type": "DocumentType",
"$xsd-full-type": "dss2:DocumentType",
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"refURI": {
"type": "string"
},
"refType": {
"type": "string"
},
"schemaRefs": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentType"
}
},
"b64Data": {
"$ref": "#/definitions/dsb-Base64DataType"
}
},
"required": ["b64Data"]
},
"dsb-Base64DataType": {
"$xsd-type": "Base64DataType",
"$xsd-full-type": "dsb:Base64DataType",
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"val": {
"type": "string"
},
"attRef": {
"$ref": "#/definitions/dsb-AttachmentReferenceType"
},
"mimeType": {
"type": "string"
},
"idRef": {
"type": "string"
}
},
"minProperties": 0
},
"dsb-AttachmentReferenceType": {
"$xsd-type": "AttachmentReferenceType",
"$xsd-full-type": "dsb:AttachmentReferenceType",
"type": "object",
"properties": {
"di": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-DigestInfoType"
}
},
"attURI": {
"type": "string"
}
},
"required": ["attURI"]
},
"dsb-DigestInfoType": {
"$xsd-type": "DigestInfoType",
"$xsd-full-type": "dsb:DigestInfoType",
"type": "object",
"properties": {
"alg": {
"type": "string"
},
"val": {
"type": "string"
}
},
"required": ["alg", "val"]
},
"dss2-TransformedDataType": {
"$xsd-type": "TransformedDataType",
"$xsd-full-type": "dss2:TransformedDataType",
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"refURI": {
"type": "string"
},
"refType": {
"type": "string"
},
"schemaRefs": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentType"
}
},
"transforms": {
"$ref": "#/definitions/dsigrw-TransformsType"
},
"b64Data": {
"$ref": "#/definitions/dsb-Base64DataType"
},
"whichRef": {
"type": "integer"
}
},
"required": ["b64Data"]
},
"dsigrw-TransformsType": {
"$xsd-type": "TransformsType",
"$xsd-full-type": "ds-rw:TransformsType",
"type": "object",
"properties": {
"transform": {
"type": "array",
"items": {
"$ref": "#/definitions/dsigrw-TransformType"
}
}
},
"required": ["transform"]
},
"dsigrw-TransformType": {
"$xsd-type": "TransformType",
"$xsd-full-type": "ds-rw:TransformType",
"type": "object",
"properties": {
"xpath": {
"type": "array",
"items": {
"type": "string"
}
},
"val": {
"type": "string"
},
"b64Content": {
"type": "string"
},
"xPath": {
"type": "array",
"items": {
"type": "string"
}
},
"nsDecl": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-NsPrefixMappingType"
}
},
"alg": {
"type": "string"
}
},
"required": ["alg"]
},
"dsb-NsPrefixMappingType": {
"$xsd-type": "NsPrefixMappingType",
"$xsd-full-type": "dsb:NsPrefixMappingType",
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"pre": {
"type": "string"
}
},
"required": ["uri", "pre"]
},
"dss2-DocumentHashType": {
"$xsd-type": "DocumentHashType",
"$xsd-full-type": "dss2:DocumentHashType",
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"refURI": {
"type": "string"
},
"refType": {
"type": "string"
},
"schemaRefs": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentType"
}
},
"transforms": {
"$ref": "#/definitions/dsigrw-TransformsType"
},
"dis": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-DigestInfoType"
}
},
"whichRef": {
"type": "integer"
}
},
"required": ["dis"]
},
"dss2-OptionalInputsSignType": {
"$xsd-type": "OptionalInputsSignType",
"$xsd-full-type": "dss2:OptionalInputsSignType",
"type": "object",
"properties": {
"policy": {
"type": "array",
"items": {
"type": "string"
}
},
"lang": {
"type": "string"
},
"other": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-AnyType"
}
},
"claimedIdentity": {
"$ref": "#/definitions/dss2-ClaimedIdentityType"
},
"schemas": {
"$ref": "#/definitions/dss2-SchemasType"
},
"addTimestamp": {
"$ref": "#/definitions/dss2-AugmentSignatureInstructionType"
},
"sigType": {
"type": "string"
},
"aud": {
"$ref": "#/definitions/dss2-IntendedAudienceType"
},
"keySel": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-KeySelectorType"
}
},
"props": {
"$ref": "#/definitions/dss2-PropertiesHolderType"
},
"incObj": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-IncludeObjectType"
}
},
"incContent": {
"type": "boolean",
"default": "false"
},
"sigPlacement": {
"$ref": "#/definitions/dss2-SignaturePlacementType"
},
"signedRefs": {
"$ref": "#/definitions/dss2-SignedReferencesType"
},
"nonce": {
"type": "integer"
},
"sigAlgo": {
"type": "string"
},
"quality": {
"type": "string"
}
}
},
"dsb-AnyType": {
"$xsd-type": "AnyType",
"$xsd-full-type": "dsb:AnyType",
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"val": {
"type": "string"
},
"attRef": {
"$ref": "#/definitions/dsb-AttachmentReferenceType"
},
"mimeType": {
"type": "string"
},
"idRef": {
"type": "string"
}
}
},
"dss2-ClaimedIdentityType": {
"$xsd-type": "ClaimedIdentityType",
"$xsd-full-type": "dss2:ClaimedIdentityType",
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/saml2rw-NameIDType"
},
"suppInfo": {
"$ref": "#/definitions/dsb-AnyType"
}
},
"required": ["name"]
},
"saml2rw-NameIDType": {
"$xsd-type": "NameIDType",
"$xsd-full-type": "saml2-rw:NameIDType",
"type": "object",
"properties": {
"spprovidedID": {
"type": "string"
},
"spnameQualifier": {
"type": "string"
},
"value": {
"type": "string"
},
"format": {
"type": "string"
},
"provId": {
"type": "string"
},
"nameQual": {
"type": "string"
},
"spNameQual": {
"type": "string"
}
}
},
"dss2-SchemasType": {
"$xsd-type": "SchemasType",
"$xsd-full-type": "dss2:SchemasType",
"type": "object",
"properties": {
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentType"
}
}
},
"required": ["schema"]
},
"dss2-AugmentSignatureInstructionType": {
"$xsd-type": "AugmentSignatureInstructionType",
"$xsd-full-type": "dss2:AugmentSignatureInstructionType",
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri"
}
}
},
"dss2-IntendedAudienceType": {
"$xsd-type": "IntendedAudienceType",
"$xsd-full-type": "dss2:IntendedAudienceType",
"type": "object",
"properties": {
"recipient": {
"type": "array",
"items": {
"$ref": "#/definitions/saml2rw-NameIDType"
}
}
},
"required": ["recipient"]
},
"dss2-KeySelectorType": {
"$xsd-type": "KeySelectorType",
"$xsd-full-type": "dss2:KeySelectorType",
"type": "object",
"properties": {
"x509Digest": {
"$ref": "#/definitions/dss2-X509DigestType"
},
"sub": {
"type": "string"
},
"ski": {
"type": "string"
},
"cert": {
"type": "string"
},
"name": {
"type": "string"
}
},
"minProperties": 1,
"maxProperties": 1
},
"dss2-X509DigestType": {
"$xsd-type": "X509DigestType",
"$xsd-full-type": "dss2:X509DigestType",
"type": "object",
"properties": {
"value": {
"type": "string"
},
"alg": {
"type": "string"
}
},
"required": ["alg"]
},
"dss2-PropertiesHolderType": {
"$xsd-type": "PropertiesHolderType",
"$xsd-full-type": "dss2:PropertiesHolderType",
"type": "object",
"properties": {
"signedProps": {
"$ref": "#/definitions/dss2-PropertiesType"
},
"unsignedProps": {
"$ref": "#/definitions/dss2-PropertiesType"
}
}
},
"dss2-PropertiesType": {
"$xsd-type": "PropertiesType",
"$xsd-full-type": "dss2:PropertiesType",
"type": "object",
"properties": {
"prop": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-PropertyType"
}
}
},
"required": ["prop"]
},
"dss2-PropertyType": {
"$xsd-type": "PropertyType",
"$xsd-full-type": "dss2:PropertyType",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"val": {
"$ref": "#/definitions/dsb-AnyType"
}
},
"required": ["id"]
},
"dss2-IncludeObjectType": {
"$xsd-type": "IncludeObjectType",
"$xsd-full-type": "dss2:IncludeObjectType",
"type": "object",
"properties": {
"whichDoc": {
"$ref": "#/definitions/dss2-DocumentBaseType"
},
"hasObjectTagsAndAttributesSet": {
"type": "boolean",
"default": "false"
},
"objId": {
"type": "string"
},
"createRef": {
"type": "boolean",
"default": "true"
}
}
},
"dss2-DocumentBaseType": {
"$xsd-type": "DocumentBaseType",
"$xsd-full-type": "dss2:DocumentBaseType",
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"refURI": {
"type": "string"
},
"refType": {
"type": "string"
},
"schemaRefs": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentType"
}
}
}
},
"dss2-SignaturePlacementType": {
"$xsd-type": "SignaturePlacementType",
"$xsd-full-type": "dss2:SignaturePlacementType",
"type": "object",
"properties": {
"xpathAfter": {
"type": "string"
},
"xpathFirstChildOf": {
"type": "string"
},
"xPathAfter": {
"type": "string"
},
"xPathFirstChildOf": {
"type": "string"
},
"nsDecl": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-NsPrefixMappingType"
}
},
"whichDoc": {
"$ref": "#/definitions/dss2-DocumentBaseType"
},
"createEnvelopedSignature": {
"type": "boolean",
"default": "true"
}
}
},
"dss2-SignedReferencesType": {
"$xsd-type": "SignedReferencesType",
"$xsd-full-type": "dss2:SignedReferencesType",
"type": "object",
"properties": {
"signedRef": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-SignedReferenceType"
}
}
},
"required": ["signedRef"]
},
"dss2-SignedReferenceType": {
"$xsd-type": "SignedReferenceType",
"$xsd-full-type": "dss2:SignedReferenceType",
"type": "object",
"properties": {
"transforms": {
"$ref": "#/definitions/dsigrw-TransformsType"
},
"whichDoc": {
"$ref": "#/definitions/dss2-DocumentBaseType"
},
"refURI": {
"type": "string"
},
"refId": {
"type": "string"
}
},
"required": ["whichDoc"]
},
"dss2-SignResponseType": {
"$xsd-type": "SignResponseType",
"$xsd-full-type": "dss2:SignResponseType",
"type": "object",
"properties": {
"result": {
"$ref": "#/definitions/dsb-ResultType"
},
"profile": {
"type": "array",
"items": {
"type": "string"
}
},
"reqID": {
"type": "string"
},
"respID": {
"type": "string"
},
"optOutp": {
"$ref": "#/definitions/dss2-OptionalOutputsSignType"
},
"sigObj": {
"$ref": "#/definitions/dss2-SignatureObjectType"
}
}
},
"dsb-ResultType": {
"$xsd-type": "ResultType",
"$xsd-full-type": "dsb:ResultType",
"type": "object",
"properties": {
"maj": {
"type": "string",
"enum": [
"urn:oasis:names:tc:dss:1.0:resultmajor:Success",
"urn:oasis:names:tc:dss:1.0:resultmajor:RequesterError",
"urn:oasis:names:tc:dss:1.0:resultmajor:ResponderError",
"urn:oasis:names:tc:dss:1.0:resultmajor:InsufficientInformation",
"urn:oasis:names:tc:dss:1.0:profiles:asynchronousprocessing:resultmajor:Pending"
]
},
"min": {
"type": "string"
},
"msg": {
"$ref": "#/definitions/dsb-InternationalStringType"
},
"pRef": {
"type": "string"
}
},
"required": ["maj"]
},
"dsb-InternationalStringType": {
"$xsd-type": "InternationalStringType",
"$xsd-full-type": "dsb:InternationalStringType",
"type": "object",
"properties": {
"value": {
"type": "string"
},
"lang": {
"type": "string"
}
},
"required": ["lang"]
},
"dss2-OptionalOutputsSignType": {
"$xsd-type": "OptionalOutputsSignType",
"$xsd-full-type": "dss2:OptionalOutputsSignType",
"type": "object",
"properties": {
"policy": {
"type": "array",
"items": {
"type": "string"
}
},
"other": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-AnyType"
}
},
"transformed": {
"$ref": "#/definitions/dss2-TransformedDocumentType"
},
"schemas": {
"$ref": "#/definitions/dss2-SchemasType"
},
"docWithSignature": {
"$ref": "#/definitions/dss2-DocumentWithSignatureType"
}
}
},
"dss2-TransformedDocumentType": {
"$xsd-type": "TransformedDocumentType",
"$xsd-full-type": "dss2:TransformedDocumentType",
"type": "object",
"properties": {
"doc": {
"$ref": "#/definitions/dss2-DocumentType"
},
"whichRef": {
"type": "integer"
}
},
"required": ["doc", "whichRef"]
},
"dss2-DocumentWithSignatureType": {
"$xsd-type": "DocumentWithSignatureType",
"$xsd-full-type": "dss2:DocumentWithSignatureType",
"type": "object",
"properties": {
"doc": {
"$ref": "#/definitions/dss2-DocumentType"
}
},
"required": ["doc"]
},
"dss2-SignatureObjectType": {
"$xsd-type": "SignatureObjectType",
"$xsd-full-type": "dss2:SignatureObjectType",
"type": "object",
"properties": {
"b64Sig": {
"$ref": "#/definitions/dsb-Base64DataType"
},
"sigPtr": {
"$ref": "#/definitions/dss2-SignaturePtrType"
},
"schemaRefs": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DocumentBaseType"
}
}
},
"minProperties": 1
},
"dss2-SignaturePtrType": {
"$xsd-type": "SignaturePtrType",
"$xsd-full-type": "dss2:SignaturePtrType",
"type": "object",
"properties": {
"xpath": {
"type": "string"
},
"nsDecl": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-NsPrefixMappingType"
}
},
"whichDoc": {
"$ref": "#/definitions/dss2-DocumentBaseType"
},
"xPath": {
"type": "string"
}
},
"required": ["whichDoc"]
},
"dss2-VerifyRequestType": {
"$xsd-type": "VerifyRequestType",
"$xsd-full-type": "dss2:VerifyRequestType",
"type": "object",
"properties": {
"profile": {
"type": "array",
"items": {
"type": "string"
}
},
"reqID": {
"type": "string"
},
"inDocs": {
"$ref": "#/definitions/dss2-InputDocumentsType"
},
"optInp": {
"$ref": "#/definitions/dss2-OptionalInputsVerifyType"
},
"sigObj": {
"$ref": "#/definitions/dss2-SignatureObjectType"
}
}
},
"dss2-OptionalInputsVerifyType": {
"$xsd-type": "OptionalInputsVerifyType",
"$xsd-full-type": "dss2:OptionalInputsVerifyType",
"type": "object",
"properties": {
"policy": {
"type": "array",
"items": {
"type": "string"
}
},
"lang": {
"type": "string"
},
"other": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-AnyType"
}
},
"claimedIdentity": {
"$ref": "#/definitions/dss2-ClaimedIdentityType"
},
"schemas": {
"$ref": "#/definitions/dss2-SchemasType"
},
"addTimestamp": {
"$ref": "#/definitions/dss2-AugmentSignatureInstructionType"
},
"useVerificationTime": {
"$ref": "#/definitions/dss2-UseVerificationTimeType"
},
"returnVerificationTime": {
"type": "boolean",
"default": "false"
},
"addKeyInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-AdditionalKeyInfoType"
}
},
"returnProcDetails": {
"type": "boolean",
"default": "false"
},
"returnSigningTime": {
"type": "boolean",
"default": "false"
},
"returnSigner": {
"type": "boolean",
"default": "false"
},
"returnAugmented": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-AugmentSignatureInstructionType"
}
},
"returnTransformed": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-ReturnTransformedDocumentType"
}
},
"returnTimestamped": {
"$ref": "#/definitions/dss2-AugmentSignatureInstructionType"
},
"verifyManifests": {
"type": "boolean",
"default": "false"
}
}
},
"dss2-UseVerificationTimeType": {
"$xsd-type": "UseVerificationTimeType",
"$xsd-full-type": "dss2:UseVerificationTimeType",
"type": "object",
"properties": {
"currTime": {
"type": "boolean",
"default": "false"
},
"specTime": {
"type": "integer",
"format": "utc-millisec"
},
"b64Content": {
"type": "string"
}
},
"minProperties": 1,
"maxProperties": 1
},
"dss2-AdditionalKeyInfoType": {
"$xsd-type": "AdditionalKeyInfoType",
"$xsd-full-type": "dss2:AdditionalKeyInfoType",
"type": "object",
"properties": {
"ocspresponse": {
"$ref": "#/definitions/dsb-Base64DataType"
},
"x509Digest": {
"$ref": "#/definitions/dss2-X509DigestType"
},
"sub": {
"type": "string"
},
"ski": {
"type": "string"
},
"cert": {
"$ref": "#/definitions/dsb-Base64DataType"
},
"name": {
"type": "string"
},
"crl": {
"$ref": "#/definitions/dsb-Base64DataType"
},
"ocsp": {
"$ref": "#/definitions/dsb-Base64DataType"
},
"poe": {
"$ref": "#/definitions/dsb-Base64DataType"
}
},
"minProperties": 1,
"maxProperties": 1
},
"dss2-ReturnTransformedDocumentType": {
"$xsd-type": "ReturnTransformedDocumentType",
"$xsd-full-type": "dss2:ReturnTransformedDocumentType",
"type": "object",
"properties": {
"whichRef": {
"type": "integer"
}
},
"required": ["whichRef"]
},
"dss2-VerifyResponseType": {
"$xsd-type": "VerifyResponseType",
"$xsd-full-type": "dss2:VerifyResponseType",
"type": "object",
"properties": {
"result": {
"$ref": "#/definitions/dsb-ResultType"
},
"profile": {
"type": "array",
"items": {
"type": "string"
}
},
"reqID": {
"type": "string"
},
"respID": {
"type": "string"
},
"optOutp": {
"$ref": "#/definitions/dss2-OptionalOutputsVerifyType"
}
}
},
"dss2-OptionalOutputsVerifyType": {
"$xsd-type": "OptionalOutputsVerifyType",
"$xsd-full-type": "dss2:OptionalOutputsVerifyType",
"type": "object",
"properties": {
"policy": {
"type": "array",
"items": {
"type": "string"
}
},
"other": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-AnyType"
}
},
"transformed": {
"$ref": "#/definitions/dss2-TransformedDocumentType"
},
"schemas": {
"$ref": "#/definitions/dss2-SchemasType"
},
"docWithSignature": {
"$ref": "#/definitions/dss2-DocumentWithSignatureType"
},
"result": {
"$ref": "#/definitions/dss2-VerifyManifestResultsType"
},
"signingTimeInfo": {
"$ref": "#/definitions/dss2-SigningTimeInfoType"
},
"verificationTimeInfo": {
"$ref": "#/definitions/dss2-VerificationTimeInfoType"
},
"procDetails": {
"$ref": "#/definitions/dss2-ProcessingDetailsType"
},
"signerIdentity": {
"$ref": "#/definitions/saml2rw-NameIDType"
},
"augSig": {
"$ref": "#/definitions/dss2-AugmentedSignatureType"
},
"timestampedSig": {
"$ref": "#/definitions/dss2-AugmentedSignatureType"
}
}
},
"dss2-VerifyManifestResultsType": {
"$xsd-type": "VerifyManifestResultsType",
"$xsd-full-type": "dss2:VerifyManifestResultsType",
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-ManifestResultType"
}
}
},
"required": ["result"]
},
"dss2-ManifestResultType": {
"$xsd-type": "ManifestResultType",
"$xsd-full-type": "dss2:ManifestResultType",
"type": "object",
"properties": {
"xPath": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"urn:oasis:names:tc:dss:1.0:manifeststatus:Valid",
"urn:oasis:names:tc:dss:1.0:manifeststatus:Invalid"
]
},
"nsDecl": {
"type": "array",
"items": {
"$ref": "#/definitions/dsb-NsPrefixMappingType"
}
}
},
"required": ["xPath", "status"]
},
"dss2-SigningTimeInfoType": {
"$xsd-type": "SigningTimeInfoType",
"$xsd-full-type": "dss2:SigningTimeInfoType",
"type": "object",
"properties": {
"signingTime": {
"type": "integer",
"format": "utc-millisec"
},
"signingTimeBounds": {
"$ref": "#/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries"
}
},
"required": ["signingTime"]
},
"dss2-SigningTimeInfoType:SigningTimeBoundaries": {
"$xsd-type": "",
"$xsd-full-type": "",
"type": "object",
"properties": {
"lowerBound": {
"type": "integer",
"format": "utc-millisec"
},
"upperBound": {
"type": "integer",
"format": "utc-millisec"
}
}
},
"dss2-VerificationTimeInfoType": {
"$xsd-type": "VerificationTimeInfoType",
"$xsd-full-type": "dss2:VerificationTimeInfoType",
"type": "object",
"properties": {
"verificationTime": {
"type": "integer",
"format": "utc-millisec"
},
"additionalTimeInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-AdditionalTimeInfoType"
}
}
},
"required": ["verificationTime"]
},
"dss2-AdditionalTimeInfoType": {
"$xsd-type": "AdditionalTimeInfoType",
"$xsd-full-type": "dss2:AdditionalTimeInfoType",
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "utc-millisec"
},
"type": {
"type": "string",
"format": "uri"
},
"ref": {
"type": "string"
}
},
"required": ["type"]
},
"dss2-ProcessingDetailsType": {
"$xsd-type": "ProcessingDetailsType",
"$xsd-full-type": "dss2:ProcessingDetailsType",
"type": "object",
"properties": {
"valid": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DetailType"
}
},
"indeterminate": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DetailType"
}
},
"invalid": {
"type": "array",
"items": {
"$ref": "#/definitions/dss2-DetailType"
}
}
}
},
"dss2-DetailType": {
"$xsd-type": "DetailType",
"$xsd-full-type": "dss2:DetailType",
"type": "object",
"properties": {
"code": {
"type": "string"
},
"msg": {
"$ref": "#/definitions/dsb-InternationalStringType"
},
"b64Content": {
"type": "string"
},
"type": {
"type": "string",
"format": "uri"
}
},
"required": ["type"]
},
"dss2-AugmentedSignatureType": {
"$xsd-type": "AugmentedSignatureType",
"$xsd-full-type": "dss2:AugmentedSignatureType",
"type": "object",
"properties": {
"sigObj": {
"$ref": "#/definitions/dss2-SignatureObjectType"
},
"type": {
"type": "string",
"format": "uri"
}
},
"required": ["sigObj"]
},
"dss2-PendingRequestType": {
"$xsd-type": "PendingRequestType",
"$xsd-full-type": "dss2:PendingRequestType",
"type": "object",
"properties": {
"profile": {
"type": "array",
"items": {
"type": "string"
}
},
"reqID": {
"type": "string"
},
"claimedIdentity": {
"$ref": "#/definitions/dss2-ClaimedIdentityType"
}
}
},
"dsb-ResponseBaseType": {
"$xsd-type": "ResponseBaseType",
"$xsd-full-type": "dsb:ResponseBaseType",
"type": "object",
"properties": {
"result": {
"$ref": "#/definitions/dsb-ResultType"
},
"profile": {
"type": "array",
"items": {
"type": "string"
}
},
"reqID": {
"type": "string"
},
"respID": {
"type": "string"
}
},
"required": ["result"]
}
},
"id": "https://json.schemastore.org/dss-2.0.0.json",
"properties": {
"signReq": {
"$ref": "#/definitions/dss2-SignRequestType"
},
"signResp": {
"$ref": "#/definitions/dss2-SignResponseType"
},
"verifyReq": {
"$ref": "#/definitions/dss2-VerifyRequestType"
},
"verifyResp": {
"$ref": "#/definitions/dss2-VerifyResponseType"
},
"pendingReq": {
"$ref": "#/definitions/dss2-PendingRequestType"
},
"genericResp": {
"$ref": "#/definitions/dsb-ResponseBaseType"
}
},
"type": "object"
}
|
lazydocker.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"color": {
"type": "string",
"oneOf": [
{
"enum": [
"black",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"bold",
"default",
"reverse",
"underline",
"strikethrough"
]
},
{
"pattern": "^#[0-9a-fA-F]{6}$",
"examples": ["#ff00ff"]
}
]
}
},
"description": "Settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"properties": {
"gui": {
"title": "gui",
"description": "UI settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"scrollHeight": {
"title": "scroll height",
"description": "A scroll height\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "integer",
"minimum": 1,
"default": 2
},
"language": {
"title": "language",
"description": "A language\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["auto", "en", "pl", "nl", "de", "tr"],
"default": "auto"
},
"theme": {
"title": "theme",
"description": "Theme settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"activeBorderColor": {
"title": "active border color",
"description": "An active border color\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/definitions/color"
}
},
"inactiveBorderColor": {
"title": "inactive border color",
"description": "An inactive border color\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/definitions/color"
}
},
"selectedLineBgColor": {
"title": "selected line background color",
"description": "A selected line background color\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/definitions/color"
}
},
"optionsTextColor": {
"title": "options text color",
"description": "An option text color\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/definitions/color"
}
}
}
},
"returnImmediately": {
"title": "return immediately",
"description": "Whether to return immediately\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"wrapMainPanel": {
"title": "wrap main panel",
"description": "Whether to wrap main panel\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"sidePanelWidth": {
"title": "side panel width",
"description": "A side panel ratio of screen's width\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "number",
"minimum": 0,
"default": 0.333
},
"showBottomLine": {
"title": "show bottom line",
"description": "Whether to show bottom line\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "boolean",
"default": true
},
"expandFocusedSidePanel": {
"title": "expand focused side panel",
"description": "Whether to expand focused side panel\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"screenMode": {
"title": "screen mode",
"description": "A screen mode\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["normal", "half", "fullscreen"],
"default": "normal"
},
"containerStatusHealthStyle": {
"title": "container status health style",
"description": "A style of container status and it's health display\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"enum": ["long", "short", "icon"],
"default": "long"
}
}
},
"logs": {
"title": "logs",
"description": "Log settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"timestamps": {
"title": "timestamps",
"description": "Whether to show timestamps\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "boolean",
"default": false
},
"since": {
"title": "since",
"description": "A start time\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "60m"
},
"tail": {
"title": "tail",
"description": "A last line count\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"oneOf": [
{
"type": "string"
},
{
"type": "integer",
"minimum": 0,
"examples": [200]
}
],
"default": ""
}
}
},
"commandTemplates": {
"title": "command templates",
"description": "Command templates\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"dockerCompose": {
"title": "docker compose",
"description": "A docker compose command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "docker-compose"
},
"restartService": {
"title": "restart service",
"description": "A restart service command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} restart {{ .Service.Name }}"
},
"up": {
"title": "up",
"description": "An up command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} up -d"
},
"down": {
"title": "down",
"description": "A down command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} down"
},
"downWithVolumes": {
"title": "down with volumes",
"description": "A down with volumes command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} down --volumes"
},
"upService": {
"title": "up service",
"description": "An up service command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} up -d {{ .Service.Name }}"
},
"startService": {
"title": "start service",
"description": "A start service command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} start {{ .Service.Name }}"
},
"stopService": {
"title": "stop service",
"description": "A stop service command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} stop {{ .Service.Name }}"
},
"serviceLogs": {
"title": "service logs",
"description": "A service logs command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} logs --since=60m --follow {{ .Service.Name }}"
},
"viewServiceLogs": {
"title": "view service logs",
"description": "A view service logs command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} logs --follow {{ .Service.Name }}"
},
"rebuildService": {
"title": "rebuild service",
"description": "A rebuild service command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} up -d --build {{ .Service.Name }}"
},
"recreateService": {
"title": "recreate service",
"description": "A recreate service command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} up -d --force-recreate {{ .Service.Name }}"
},
"allLogs": {
"title": "all logs",
"description": "An all logs command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} logs --tail=300 --follow"
},
"viewAlLogs": {
"title": "view al logs",
"description": "A view al logs command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} logs"
},
"dockerComposeConfig": {
"title": "docker compose config",
"description": "A docker compose config command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} config"
},
"checkDockerComposeConfig": {
"title": "check docker compose config",
"description": "A check docker compose config command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} config --quiet"
},
"serviceTop": {
"title": "service top",
"description": "A service top command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "{{ .DockerCompose }} top {{ .Service.Name }}"
}
}
},
"os": {
"title": "os",
"description": "OS settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"openCommand": {
"title": "open command",
"description": "An open command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "open {{filename}}"
},
"openLinkCommand": {
"title": "open link command",
"description": "An open link command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"default": "open {{link}}"
}
}
},
"stats": {
"title": "stats",
"description": "Statistic settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"graphs": {
"title": "graphs",
"description": "Graph settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"items": {
"type": "object",
"properties": {
"caption": {
"title": "caption",
"description": "A caption\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"examples": ["CPU (%)"]
},
"statPath": {
"title": "stat path",
"description": "A path\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"examples": ["DerivedStats.CPUPercentage"]
},
"color": {
"title": "color",
"description": "A color\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"$ref": "#/definitions/color"
}
}
}
}
}
},
"customCommands": {
"title": "custom commands",
"description": "Custom commands\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"properties": {
"containers": {
"title": "containers",
"description": "Container settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"name": {
"title": "name",
"description": "A name\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"examples": ["bash"]
},
"attach": {
"title": "attach",
"description": "Whether to attach\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "boolean"
},
"command": {
"title": "command",
"description": "A command\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"examples": ["docker exec -it {{ .Container.ID }} bash"]
},
"serviceNames": {
"title": "service names",
"description": "Service names\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "array",
"uniqueItems": true,
"items": {
"description": "A service name\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string"
},
"default": []
}
}
}
}
}
},
"replacements": {
"title": "replacements",
"description": "Replacement settings\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"patternProperties": {
".": {
"title": "replacement group",
"description": "A replacement group\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "object",
"patternProperties": {
".": {
"title": "replacement",
"description": "A replacement\nhttps://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default",
"type": "string",
"examples": ["<dev>", "<prod>"]
}
}
}
}
}
},
"title": "ui settings",
"type": "object"
}
|
band-manifest.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"icon": {
"type": "string",
"pattern": "\\.png$"
},
"color": {
"description": "The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.",
"type": "string",
"pattern": "^[A-Fa-f0-9]{6}$"
},
"elementId": {
"description": "The numeric id of the icon layout element based on the predefined layout selected.",
"enum": ["1", "2", "3", "11", "12", "21", "22", "31", "32"]
},
"condition": {
"description": "If set, then must be set to 'true' for this release",
"enum": ["true"]
},
"resource": {
"type": "object",
"required": ["url", "style", "content"],
"properties": {
"url": {
"description": "The URL to be referenced. For resources that require authentication, the URL must be HTTPS.",
"type": "string",
"format": "uri"
},
"style": {
"description": "Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.",
"type": "string",
"pattern": "^([sS]imple|[fF]eed)$",
"default": "Simple"
},
"content": {
"description": "This member specifies how to extract content from the web response.",
"type": "object",
"minProperties": 1,
"additionalProperties": {
"type": "string"
}
}
}
},
"page": {
"required": ["layout"],
"properties": {
"layout": {
"description": "The name of the layout for the page. The layout name should refer to one of the predefined page layouts.",
"enum": [
"MSBand_ScrollingText",
"MSBand_NoScrollingText",
"MSBand_SingleMetric",
"MSBand_SingleMetricWithIcon",
"MSBand_MetricsWithIcons",
"MSBand_SingleMetricWithSecondary"
]
},
"condition": {
"$ref": "#/definitions/condition"
},
"iconBindings": {
"description": "Similar to textBindings, but used to select one of the web tile icons in icons list for each icon in the page. If there are no icon elements on the page, this member may be omitted.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/iconBinding"
}
},
"textBindings": {
"description": "An array of objects corresponding to each page element that contains string content. Each binding object provides the numeric id of the page element based on the predefined layout selected, and the string value that it should contain.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/textBinding"
}
}
}
},
"iconBinding": {
"required": ["conditions", "elementId"],
"type": "object",
"properties": {
"elementId": {
"$ref": "#/definitions/elementId"
},
"conditions": {
"description": "For this release, this must contain an array with a single 'condition' object whose 'condition' is true, and whose 'icon' member specifies the name of the icon to be used.",
"type": "array",
"items": {
"type": "object",
"properties": {
"condition": {
"$ref": "#/definitions/condition"
},
"icon": {
"description": "The name of the icon as specified in the 'icons' node.",
"type": "string"
}
}
}
}
}
},
"textBinding": {
"required": ["elementId", "value"],
"properties": {
"elementId": {
"$ref": "#/definitions/elementId"
},
"value": {
"type": "string"
}
}
},
"notification": {
"type": "object",
"required": ["condition", "title"],
"properties": {
"condition": {
"description": "The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax '<Operand1> <Operator> <Operand2>' or 'true'.",
"type": "string"
},
"title": {
"description": "The text to use for the notification title. If longer than 20 characters, it will be truncated.",
"type": "string"
},
"body": {
"description": "The text to use for the notification body. If longer than 20 characters, it will be truncated.",
"type": "string"
}
}
}
},
"id": "https://json.schemastore.org/band-manifest.json",
"properties": {
"manifestVersion": {
"description": "Defines the contract between the web tile developer and the Microsoft Health app. It must be set to 1 for the current release.",
"enum": [1]
},
"name": {
"description": "Defines the name of the web tile.",
"type": "string",
"maxLength": 21
},
"description": {
"description": "Provides description about the web tile.",
"type": "string",
"maxLength": 100
},
"version": {
"description": "Indicates the version number of the web tile which will not be shown to users.",
"type": "number"
},
"versionString": {
"description": "Indicates the web tile version as shown to users. If not provided, it displays the version.",
"type": "string",
"maxLength": 10
},
"author": {
"description": "Specifies the author of the web tile.",
"type": "string",
"maxLength": 50
},
"organization": {
"description": "Specifies the organization associated with the web tile.",
"type": "string",
"maxLength": 100
},
"contactEmail": {
"description": "Provides contact info of the web tile author. Used for administrative purposes and analytics by Microsoft Band team.",
"type": "string",
"format": "email",
"maxLength": 100
},
"tileIcon": {
"description": "Specifies the location of the large tile icon.",
"type": "object",
"required": ["46"],
"properties": {
"46": {
"$ref": "#/definitions/icon"
}
}
},
"badgeIcon": {
"description": "Specifies the location of the small tile icon. If not provided, the badging functionality is not enabled.",
"type": "object",
"required": ["24"],
"properties": {
"24": {
"$ref": "#/definitions/icon"
}
}
},
"tileTheme": {
"description": "Specifies the custom theme colors for the web tile.",
"type": "object",
"properties": {
"base": {
"$ref": "#/definitions/color"
},
"highlight": {
"$ref": "#/definitions/color"
},
"lowlight": {
"$ref": "#/definitions/color"
},
"secondary": {
"$ref": "#/definitions/color"
},
"highcontrast": {
"$ref": "#/definitions/color"
},
"muted": {
"$ref": "#/definitions/color"
}
}
},
"refreshIntervalMinutes": {
"description": "Specifies the desired data refresh interval, in minutes. Refresh intervals shorter than 15 will not be honored. If not provided, it defaults to 30.",
"type": "integer",
"default": 30,
"minimum": 15
},
"resources": {
"description": "Each web tile must refer to one or more web resources. Each resource object describes a web data from which content for the tile will be extracted.",
"type": "array",
"items": {
"$ref": "#/definitions/resource"
}
},
"icons": {
"description": "All PNG icons used by the tile within its pages must be provided here.",
"type": "object",
"maxProperties": 8,
"additionalProperties": {
"$ref": "#/definitions/icon"
}
},
"pages": {
"description": "Each tile consists of one or more pages, as described by the objects in this array. Each page object specifies the layout and content of the page.",
"type": "array",
"items": {
"$ref": "#/definitions/page"
}
},
"notifications": {
"description": "Creates notification that gets delivered when certain conditions are detected in the new web data.",
"type": "array",
"items": {
"$ref": "#/definitions/notification"
}
}
},
"required": ["manifestVersion", "name", "tileIcon", "resources", "pages"],
"title": "JSON schema for Microsoft Band manifests",
"type": "object"
}
|
openweather.roadrisk.json | {
"$id": "https://json.schemastore.org/openweather.roadrisk",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "API responses from the OpenWeather Road Risk API from https://openweathermap.org/api/road-risk",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["dt", "coord", "weather", "alerts"],
"properties": {
"dt": {
"type": "integer"
},
"coord": {
"type": "array",
"items": {
"type": "number"
}
},
"weather": {
"type": "object",
"additionalProperties": false,
"properties": {
"temp": {
"type": "number"
},
"wind_speed": {
"type": "number"
},
"wind_deg": {
"type": "number"
},
"precipitation_intensity": {
"type": "number"
},
"dew_point": {
"type": "number"
}
}
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["sender_name", "event", "event_level"],
"properties": {
"sender_name": {
"type": "string"
},
"event": {
"type": "string"
},
"event_level": {
"type": "integer"
}
}
}
}
}
},
"title": "OpenWeather Road Risk API",
"type": "array"
}
|
packer.json | {
"$id": "https://json.schemastore.org/packer.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"builder-type": {
"enum": [
"alicloud-ecs",
"amazon-ebs",
"azure-arm",
"azure-chroot",
"cloudstack",
"custom",
"digitalocean",
"docker",
"file",
"googlecompute",
"hcloud",
"hyperone",
"hyperv-iso",
"hyperv-vmcx",
"jdcloud",
"linode",
"lxc",
"lxd",
"ncloud",
"null",
"ocs-chroot",
"oneandone",
"openstack",
"oracle-classic",
"oracle-oci",
"osc-bsu",
"osc-bsusurrogate",
"parallels-iso",
"parallels-pvm",
"profitbricks",
"proxmox",
"qemu",
"scaleway",
"tencentcloud-cvm",
"triton",
"ucloud-uhost",
"vagrant",
"virtualbox-iso",
"virtualbox-ovf",
"virtualbox-vm",
"vmware-iso",
"vmware-vmx",
"vsphere-clone",
"vsphere-iso",
"yandex"
]
},
"builder-vagrant": {
"type": "object",
"properties": {
"type": {
"const": "vagrant"
},
"add_cacert": {
"type": "string"
},
"add_capath": {
"type": "string"
},
"add_clean": {
"type": "boolean"
},
"add_force": {
"type": "boolean"
},
"add_insecure": {
"type": "boolean"
},
"box_name": {
"type": "string"
},
"box_version": {
"type": "string"
},
"checksum": {
"type": "string"
},
"checksum_type": {
"type": "string"
},
"global_id": {
"type": "string"
},
"output_dir": {
"type": "string"
},
"output_vagrantfile": {
"type": "string"
},
"package_include": {
"type": "string"
},
"provider": {
"type": "string"
},
"skip_add": {
"type": "boolean"
},
"source_path": {
"type": "string"
},
"teardown_method": {
"type": "string"
},
"template": {
"type": "string"
}
}
},
"builder-virtualbox-iso": {
"type": "object",
"properties": {
"bundle_iso": {
"type": "boolean"
},
"communicator": {
"type": "string"
},
"disk_size": {
"type": "integer"
},
"export_opts": {
"type": "array",
"items": {
"type": "string"
}
},
"format": {
"type": "string"
},
"guest_additions_interface": {
"type": "string"
},
"guest_additions_mode": {
"type": "string"
},
"guest_additions_path": {
"type": "string"
},
"guest_additions_sha256": {
"type": "string"
},
"guest_additions_url": {
"type": "string"
},
"guest_os_type": {
"type": "string"
},
"hard_drive_interface": {
"type": "string"
},
"hard_drive_nonrotational": {
"type": "boolean"
},
"hard_driver_discard": {
"type": "boolean"
},
"headless": {
"type": "boolean"
},
"http_bind_address": {
"type": "integer"
},
"http_directory": {
"type": "string"
},
"http_port_max": {
"type": "integer"
},
"http_port_min": {
"type": "integer"
},
"iso_checksum": {
"type": "string"
},
"iso_interface": {
"type": "string"
},
"iso_target_extension": {
"type": "string"
},
"iso_target_path": {
"type": "string"
},
"iso_url": {
"type": "string"
},
"iso_urls": {
"type": "array",
"items": {
"type": "string"
}
},
"keep_registered": {
"type": "boolean"
},
"nvme_port_count": {
"type": "integer"
},
"output_directory": {
"type": "string"
},
"output_filename": {
"type": "string"
},
"sata_port_count": {
"type": "integer"
},
"shutdown_command": {
"type": "string"
},
"skip_export": {
"type": "boolean"
},
"type": {
"const": "virtualbox-iso"
},
"virtualbox_version_file": {
"type": "string"
},
"vm_name": {
"type": "string"
}
}
},
"provisioner-ansible-local": {
"type": "object",
"properties": {
"playbook_file": {
"type": "string"
}
},
"required": ["playbook_file"]
},
"provisioner-shell": {
"type": "object",
"properties": {
"inline": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"provisioner": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["shell", "ansible-local"]
}
},
"oneOf": [
{
"$ref": "#/definitions/provisioner-ansible-local"
},
{
"$ref": "#/definitions/provisioner-shell"
}
],
"required": ["type"]
},
"post-processor": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": ["compress", "upload"]
},
"endpoint": {
"type": "string"
},
"keep_input_artifact": {
"type": "boolean"
},
"only": {
"type": "array",
"items": {
"type": "string"
}
},
"format": {
"type": "string",
"enum": ["tar.gz"]
},
"compression_level": {
"type": "number"
}
}
}
},
"properties": {
"min_packer_version": {
"type": "string"
},
"description": {
"type": "string"
},
"variables": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9_-]": {
"type": "string"
}
}
},
"builders": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/builder-vagrant"
},
{
"$ref": "#/definitions/builder-virtualbox-iso"
}
]
}
},
"provisioners": {
"type": "array",
"items": {
"$ref": "#/definitions/provisioner"
}
},
"post-processors": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": ["vagrant", "compress"]
},
{
"$ref": "#/definitions/post-processor"
}
]
}
}
},
"required": ["builders"],
"type": "object"
}
|
chisel-slices.json | {
"$comment": "https://github.com/canonical/chisel/tree/main#slice-definitions",
"$id": "https://json.schemastore.org/chisel-slices.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "A slice definition for Ubuntu Chisel tool. For details, see https://github.com/canonical/chisel/tree/main#slice-definitions.",
"properties": {
"package": {
"type": "string",
"description": "The name of the package to use for the slice.",
"pattern": "^[a-z0-9][a-z0-9+\\-\\.]+$",
"examples": ["libgcc-s1", "libunwind-13"]
},
"archive": {
"type": "string",
"description": "The name of the archive to use for the slice. Archives are defined in the chisel.yaml file.",
"examples": ["ubuntu"]
},
"slices": {
"type": "object",
"description": "Slice definitions for this package.",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"description": "The name of the slice part.",
"type": "object",
"additionalProperties": false,
"properties": {
"essential": {
"type": "array",
"description": "The name of the dependency slice part. The slice part is formatted as '<slice_name>_<slice_part>'.",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9+\\-\\._]+$"
},
"examples": ["libgcc-s1_libs", "ca-certificates_data"]
},
"mutate": {
"type": "string",
"description": "A Starlark expression to modify the file contents.",
"examples": ["foo = content.read(\"/path/to/temporary/content\")"]
},
"contents": {
"type": "object",
"description": "Files to include in the slice. Supports glob patterns.",
"examples": [
{ "/lib*/ld*.so.*": {} },
{ "/usr/share/nodejs/cjs-module-lexer/**": {} },
{ "/path/to/moved/content": { "copy": "/bin/original" } },
{ "/path/to/link": { "symlink": "/bin/mybin" } },
{ "/path/to/new/dir": { "make": true } },
{ "/path/to/file/with/text": { "text": "Some text" } },
{
"/path/to/mutable/file/with/default/text": {
"text": "FIXME",
"mutable": true
}
},
{ "/path/to/temporary/content": { "until": "mutate" } }
],
"patternProperties": {
"^.+$": {
"description": "Path description.",
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"make": {
"type": "boolean",
"description": "Make this file or directory if it does not already exist.",
"default": true
},
"mode": {
"type": "integer",
"description": "File permissions to use.",
"examples": ["0o755"]
},
"copy": {
"type": "string",
"description": "Copy this file or directory from this location.",
"examples": ["/path/to/original/file.txt"]
},
"text": {
"type": "string",
"description": "The contents of the file.",
"examples": ["FIXME"]
},
"symlink": {
"type": "string",
"description": "Make a symlink to this file or directory.",
"examples": ["/path/to/source/file.txt"]
},
"mutable": {
"type": "boolean",
"description": "If true, the file is mutable.",
"default": true
},
"until": {
"type": "string",
"description": "Only keep this file until this stage.",
"examples": ["mutate"],
"default": "",
"$comment": "Valid values: 'mutate' and ''. But most editors will not accept an empty string.",
"enum": ["", "mutate"]
},
"arch": {
"type": "array",
"description": "Only include this file on specific architectures.",
"uniqueItems": true,
"examples": [["amd64", "arm64"]],
"items": {
"type": "string",
"examples": [
"amd64",
"i386",
"armhf",
"arm64",
"powerpc",
"ppc64el",
"s390x",
"riscv64"
]
}
}
}
}
}
}
}
}
}
}
},
"title": "Canonical Chisel Slice Definition",
"type": "object"
}
|
one-service-descriptor-schema-0.1.json | {
"$id": "https://json.schemastore.org/one-service-descriptor-schema-0.1.json",
"$ref": "#/definitions/ServiceDescriptor",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"ServiceDescriptor": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"requires": {
"type": "array",
"items": {
"$ref": "#/definitions/Require"
}
},
"events": {
"$ref": "#/definitions/Events"
}
},
"required": ["description", "requires", "events"],
"title": "ServiceDescriptor"
},
"Events": {
"type": "object",
"additionalProperties": false,
"properties": {
"produces": {
"$ref": "#/definitions/Consumes"
},
"consumes": {
"$ref": "#/definitions/Produces"
}
},
"required": ["consumes", "produces"],
"title": "Events"
},
"Consumes": {
"type": "array",
"items": {
"type": "string"
},
"title": "Consumes"
},
"Produces": {
"type": "array",
"items": {
"type": "string"
},
"title": "Produces"
},
"Require": {
"type": "object",
"additionalProperties": false,
"properties": {
"service": {
"type": "string"
},
"version": {
"type": "string"
},
"uses": {
"type": "array",
"items": {
"$ref": "#/definitions/Use"
}
}
},
"required": ["service", "uses", "version"],
"title": "Require"
},
"Use": {
"type": "object",
"additionalProperties": false,
"properties": {
"api": {
"type": "string",
"enum": ["internal", "external", "integration"]
},
"type": {
"type": "string",
"enum": ["REST", "library"]
}
},
"required": ["api", "type"],
"title": "Use"
}
}
}
|
ansible.json | {
"$defs": {
"ansible.builtin.import_playbook": {
"additionalProperties": false,
"oneOf": [
{
"not": {
"required": ["import_playbook"]
},
"required": ["ansible.builtin.import_playbook"]
},
{
"not": {
"required": ["ansible.builtin.import_playbook"]
},
"required": ["import_playbook"]
}
],
"patternProperties": {
"^(ansible\\.builtin\\.)?import_playbook$": {
"markdownDescription": "* Includes a file with a list of plays to be executed.\n * Files with a list of plays can only be included at the top level.\n * You cannot use this action inside a play.\n\nSee [import_playbook](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/import_playbook_module.html)",
"title": "Import Playbook",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/$defs/tags"
},
"vars": {
"title": "Vars",
"type": "object"
},
"when": {
"$ref": "#/$defs/complex_conditional",
"title": "When"
}
},
"type": "object"
},
"become_method": {
"anyOf": [
{
"enum": [
"ansible.builtin.sudo",
"ansible.builtin.su",
"community.general.pbrun",
"community.general.pfexec",
"ansible.builtin.runas",
"community.general.dzdo",
"community.general.ksu",
"community.general.doas",
"community.general.machinectl",
"community.general.pmrun",
"community.general.sesu",
"community.general.sudosu"
],
"type": "string"
},
{
"$ref": "#/$defs/full-jinja"
},
{
"pattern": "[A-Za-z0-9_\\.]+",
"type": "string"
}
],
"markdownDescription": "See [become](https://docs.ansible.com/ansible/latest/user_guide/become.html)",
"title": "Become Method"
},
"block": {
"properties": {
"always": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/task"
},
{
"$ref": "#/$defs/block"
}
]
},
"title": "Always",
"type": "array"
},
"any_errors_fatal": {
"$ref": "#/$defs/templated-boolean",
"title": "Any Errors Fatal"
},
"become": {
"$ref": "#/$defs/templated-boolean",
"title": "Become"
},
"become_exe": {
"title": "Become Exe",
"type": "string"
},
"become_flags": {
"title": "Become Flags",
"type": "string"
},
"become_method": {
"$ref": "#/$defs/become_method"
},
"become_user": {
"title": "Become User",
"type": "string"
},
"block": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/task"
},
{
"$ref": "#/$defs/block"
}
]
},
"markdownDescription": "Blocks create logical groups of tasks. Blocks also offer ways to handle task errors, similar to exception handling in many programming languages. See [blocks](https://docs.ansible.com/ansible/latest/user_guide/playbooks_blocks.html)",
"title": "Block",
"type": "array"
},
"check_mode": {
"$ref": "#/$defs/complex_conditional",
"title": "Check Mode"
},
"collections": {
"items": {
"type": "string"
},
"title": "Collections",
"type": "array"
},
"connection": {
"title": "Connection",
"type": "string"
},
"debugger": {
"title": "Debugger",
"type": "string"
},
"delegate_facts": {
"title": "Delegate Facts",
"type": "boolean"
},
"delegate_to": {
"title": "Delegate To",
"type": "string"
},
"diff": {
"$ref": "#/$defs/templated-boolean",
"title": "Diff"
},
"environment": {
"$ref": "#/$defs/environment"
},
"ignore_errors": {
"$ref": "#/$defs/ignore_errors"
},
"ignore_unreachable": {
"title": "Ignore Unreachable",
"type": "boolean"
},
"module_defaults": {
"title": "Module Defaults"
},
"name": {
"title": "Name",
"type": "string"
},
"no_log": {
"$ref": "#/$defs/templated-boolean"
},
"port": {
"$ref": "#/$defs/templated-integer"
},
"remote_user": {
"title": "Remote User",
"type": "string"
},
"rescue": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/task"
},
{
"$ref": "#/$defs/block"
}
]
},
"title": "Rescue",
"type": "array"
},
"run_once": {
"$ref": "#/$defs/templated-boolean",
"title": "Run Once"
},
"tags": {
"$ref": "#/$defs/tags",
"title": "Tags"
},
"throttle": {
"$ref": "#/$defs/templated-integer",
"title": "Throttle"
},
"timeout": {
"$ref": "#/$defs/templated-integer",
"title": "Timeout"
},
"vars": {
"title": "Vars",
"type": "object"
},
"when": {
"$ref": "#/$defs/complex_conditional",
"title": "When"
}
},
"required": ["block"],
"type": "object"
},
"complex_conditional": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
},
{
"items": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"type": "array"
}
]
},
"environment": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"$ref": "#/$defs/full-jinja"
}
],
"title": "Environment"
},
"full-jinja": {
"pattern": "^\\{[\\{%](.|[\r\n])*[\\}%]\\}$",
"type": "string"
},
"ignore_errors": {
"$ref": "#/$defs/templated-boolean",
"markdownDescription": "See [ignore_errors](https://docs.ansible.com/ansible/latest/user_guide/playbooks_error_handling.html#ignoring-failed-commands)",
"title": "Ignore Errors"
},
"no_log": {
"$ref": "#/$defs/templated-boolean",
"markdownDescription": "Use for protecting sensitive data. See [no_log](https://docs.ansible.com/ansible/latest/reference_appendices/logging.html)",
"title": "no_log"
},
"play": {
"additionalProperties": false,
"allOf": [
{
"not": {
"required": ["ansible.builtin.import_playbook"]
}
},
{
"not": {
"required": ["import_playbook"]
}
}
],
"properties": {
"any_errors_fatal": {
"$ref": "#/$defs/templated-boolean",
"title": "Any Errors Fatal"
},
"become": {
"$ref": "#/$defs/templated-boolean",
"title": "Become"
},
"become_exe": {
"title": "Become Exe",
"type": "string"
},
"become_flags": {
"title": "Become Flags",
"type": "string"
},
"become_method": {
"$ref": "#/$defs/become_method"
},
"become_user": {
"title": "Become User",
"type": "string"
},
"check_mode": {
"$ref": "#/$defs/complex_conditional",
"title": "Check Mode"
},
"collections": {
"items": {
"type": "string"
},
"title": "Collections",
"type": "array"
},
"connection": {
"title": "Connection",
"type": "string"
},
"debugger": {
"title": "Debugger",
"type": "string"
},
"diff": {
"$ref": "#/$defs/templated-boolean",
"title": "Diff"
},
"environment": {
"$ref": "#/$defs/environment"
},
"fact_path": {
"title": "Fact Path",
"type": "string"
},
"force_handlers": {
"title": "Force Handlers",
"type": "boolean"
},
"gather_facts": {
"$ref": "#/$defs/templated-boolean",
"title": "Gather Facts"
},
"gather_subset": {
"items": {
"anyOf": [
{
"enum": [
"all",
"min",
"all_ipv4_addresses",
"all_ipv6_addresses",
"apparmor",
"architecture",
"caps",
"chroot,cmdline",
"date_time",
"default_ipv4",
"default_ipv6",
"devices",
"distribution",
"distribution_major_version",
"distribution_release",
"distribution_version",
"dns",
"effective_group_ids",
"effective_user_id",
"env",
"facter",
"fips",
"hardware",
"interfaces",
"is_chroot",
"iscsi",
"kernel",
"local",
"lsb",
"machine",
"machine_id",
"mounts",
"network",
"ohai",
"os_family",
"pkg_mgr",
"platform",
"processor",
"processor_cores",
"processor_count",
"python",
"python_version",
"real_user_id",
"selinux",
"service_mgr",
"ssh_host_key_dsa_public",
"ssh_host_key_ecdsa_public",
"ssh_host_key_ed25519_public",
"ssh_host_key_rsa_public",
"ssh_host_pub_keys",
"ssh_pub_keys",
"system",
"system_capabilities",
"system_capabilities_enforced",
"user",
"user_dir",
"user_gecos",
"user_gid",
"user_id",
"user_shell",
"user_uid",
"virtual",
"virtualization_role",
"virtualization_type"
],
"type": "string"
},
{
"enum": [
"!all",
"!min",
"!all_ipv4_addresses",
"!all_ipv6_addresses",
"!apparmor",
"!architecture",
"!caps",
"!chroot,cmdline",
"!date_time",
"!default_ipv4",
"!default_ipv6",
"!devices",
"!distribution",
"!distribution_major_version",
"!distribution_release",
"!distribution_version",
"!dns",
"!effective_group_ids",
"!effective_user_id",
"!env",
"!facter",
"!fips",
"!hardware",
"!interfaces",
"!is_chroot",
"!iscsi",
"!kernel",
"!local",
"!lsb",
"!machine",
"!machine_id",
"!mounts",
"!network",
"!ohai",
"!os_family",
"!pkg_mgr",
"!platform",
"!processor",
"!processor_cores",
"!processor_count",
"!python",
"!python_version",
"!real_user_id",
"!selinux",
"!service_mgr",
"!ssh_host_key_dsa_public",
"!ssh_host_key_ecdsa_public",
"!ssh_host_key_ed25519_public",
"!ssh_host_key_rsa_public",
"!ssh_host_pub_keys",
"!ssh_pub_keys",
"!system",
"!system_capabilities",
"!system_capabilities_enforced",
"!user",
"!user_dir",
"!user_gecos",
"!user_gid",
"!user_id",
"!user_shell",
"!user_uid",
"!virtual",
"!virtualization_role",
"!virtualization_type"
],
"type": "string"
}
]
},
"title": "Gather Subset",
"type": "array"
},
"gather_timeout": {
"$ref": "#/$defs/templated-integer",
"title": "Gather Timeout"
},
"handlers": {
"$ref": "#/$defs/tasks"
},
"hosts": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Hosts"
},
"ignore_errors": {
"$ref": "#/$defs/ignore_errors"
},
"ignore_unreachable": {
"title": "Ignore Unreachable",
"type": "boolean"
},
"max_fail_percentage": {
"title": "Max Fail Percentage",
"type": "number"
},
"module_defaults": {
"title": "Module Defaults"
},
"name": {
"title": "Name",
"type": "string"
},
"no_log": {
"$ref": "#/$defs/templated-boolean"
},
"order": {
"enum": [
"default",
"sorted",
"reverse_sorted",
"reverse_inventory",
"shuffle"
],
"title": "Order",
"type": "string"
},
"port": {
"$ref": "#/$defs/templated-integer",
"title": "Port"
},
"post_tasks": {
"$ref": "#/$defs/tasks"
},
"pre_tasks": {
"$ref": "#/$defs/tasks"
},
"remote_user": {
"title": "Remote User",
"type": "string"
},
"roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/play-role"
},
{
"type": "string"
}
]
},
"markdownDescription": "Roles let you automatically load related vars, files, tasks, handlers, and other Ansible artifacts based on a known file structure. After you group your content in roles, you can easily reuse them and share them with other users.\n See [roles](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#roles)",
"title": "Roles",
"type": "array"
},
"run_once": {
"$ref": "#/$defs/templated-boolean",
"title": "Run Once"
},
"serial": {
"anyOf": [
{
"$ref": "#/$defs/templated-integer-or-percent"
},
{
"items": {
"$ref": "#/$defs/templated-integer-or-percent"
},
"type": "array"
}
],
"markdownDescription": "Integer, percentage or list of those. See [Setting the batch size with serial](https://docs.ansible.com/ansible/latest/user_guide/playbooks_strategies.html#setting-the-batch-size-with-serial)",
"title": "Batch size"
},
"strategy": {
"title": "Strategy",
"type": "string"
},
"tags": {
"$ref": "#/$defs/tags",
"title": "Tags"
},
"tasks": {
"$ref": "#/$defs/tasks"
},
"throttle": {
"$ref": "#/$defs/templated-integer",
"title": "Throttle"
},
"timeout": {
"$ref": "#/$defs/templated-integer",
"title": "Timeout"
},
"user": {
"title": "Remote User",
"type": "string"
},
"vars": {
"title": "Vars",
"type": "object"
},
"vars_files": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"title": "Vars Files",
"type": ["array", "string", "null"]
},
"vars_prompt": {
"items": {
"$ref": "#/$defs/vars_prompt"
},
"markdownDescription": "See [vars_prompt](https://docs.ansible.com/ansible/latest/user_guide/playbooks_prompts.html)",
"title": "vars_prompt",
"type": "array"
},
"when": {
"$ref": "#/$defs/complex_conditional",
"title": "When"
}
},
"required": ["hosts"],
"title": "play",
"type": "object"
},
"play-role": {
"markdownDescription": "See [roles](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#roles)",
"properties": {
"any_errors_fatal": {
"$ref": "#/$defs/templated-boolean",
"title": "Any Errors Fatal"
},
"become": {
"$ref": "#/$defs/templated-boolean",
"title": "Become"
},
"become_exe": {
"title": "Become Exe",
"type": "string"
},
"become_flags": {
"title": "Become Flags",
"type": "string"
},
"become_method": {
"$ref": "#/$defs/become_method"
},
"become_user": {
"title": "Become User",
"type": "string"
},
"check_mode": {
"$ref": "#/$defs/complex_conditional",
"title": "Check Mode"
},
"collections": {
"items": {
"type": "string"
},
"title": "Collections",
"type": "array"
},
"connection": {
"title": "Connection",
"type": "string"
},
"debugger": {
"title": "Debugger",
"type": "string"
},
"delegate_to": {
"title": "Delegate To",
"type": "string"
},
"diff": {
"$ref": "#/$defs/templated-boolean",
"title": "Diff"
},
"environment": {
"$ref": "#/$defs/environment"
},
"ignore_errors": {
"$ref": "#/$defs/ignore_errors"
},
"ignore_unreachable": {
"title": "Ignore Unreachable",
"type": "boolean"
},
"module_defaults": {
"title": "Module Defaults"
},
"name": {
"title": "Name",
"type": "string"
},
"no_log": {
"$ref": "#/$defs/templated-boolean"
},
"port": {
"$ref": "#/$defs/templated-integer",
"title": "Port"
},
"remote_user": {
"title": "Remote User",
"type": "string"
},
"role": {
"title": "Role",
"type": "string"
},
"run_once": {
"$ref": "#/$defs/templated-boolean",
"title": "Run Once"
},
"tags": {
"$ref": "#/$defs/tags",
"title": "Tags"
},
"throttle": {
"$ref": "#/$defs/templated-integer",
"title": "Throttle"
},
"timeout": {
"$ref": "#/$defs/templated-integer",
"title": "Timeout"
},
"vars": {
"title": "Vars",
"type": "object"
},
"when": {
"$ref": "#/$defs/complex_conditional",
"title": "When"
}
},
"required": ["role"],
"title": "play-role",
"type": "object"
},
"playbook": {
"examples": ["playbooks/*.yml", "playbooks/*.yaml"],
"items": {
"oneOf": [
{
"$ref": "#/$defs/ansible.builtin.import_playbook"
},
{
"$ref": "#/$defs/play"
}
]
},
"title": "Ansible Playbook",
"type": "array"
},
"tags": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Tags"
},
"task": {
"additionalProperties": true,
"allOf": [
{
"not": {
"required": ["hosts"]
}
},
{
"not": {
"required": ["tasks"]
}
},
{
"not": {
"required": ["import_playbook"]
}
},
{
"not": {
"required": ["block"]
}
}
],
"properties": {
"action": {
"title": "Action",
"type": "string"
},
"any_errors_fatal": {
"$ref": "#/$defs/templated-boolean",
"title": "Any Errors Fatal"
},
"args": {
"$ref": "#/$defs/templated-object",
"title": "Args"
},
"async": {
"$ref": "#/$defs/templated-integer",
"title": "Async"
},
"become": {
"$ref": "#/$defs/templated-boolean",
"title": "Become"
},
"become_exe": {
"title": "Become Exe",
"type": "string"
},
"become_flags": {
"title": "Become Flags",
"type": "string"
},
"become_method": {
"$ref": "#/$defs/become_method"
},
"become_user": {
"title": "Become User",
"type": "string"
},
"changed_when": {
"$ref": "#/$defs/complex_conditional",
"markdownDescription": "See [changed_when](https://docs.ansible.com/ansible/latest/user_guide/playbooks_error_handling.html#defining-changed)",
"title": "Changed When"
},
"check_mode": {
"$ref": "#/$defs/complex_conditional",
"title": "Check Mode"
},
"collections": {
"items": {
"type": "string"
},
"title": "Collections",
"type": "array"
},
"connection": {
"title": "Connection",
"type": "string"
},
"debugger": {
"title": "Debugger",
"type": "string"
},
"delay": {
"$ref": "#/$defs/templated-integer",
"title": "Delay"
},
"delegate_facts": {
"title": "Delegate Facts",
"type": "boolean"
},
"delegate_to": {
"title": "Delegate To",
"type": "string"
},
"diff": {
"$ref": "#/$defs/templated-boolean",
"title": "Diff"
},
"environment": {
"$ref": "#/$defs/environment"
},
"failed_when": {
"$ref": "#/$defs/complex_conditional",
"title": "Failed When"
},
"ignore_errors": {
"$ref": "#/$defs/ignore_errors"
},
"ignore_unreachable": {
"title": "Ignore Unreachable",
"type": "boolean"
},
"listen": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html)",
"title": "Listen"
},
"local_action": {
"title": "Local Action",
"type": ["string", "object"]
},
"loop": {
"title": "Loop",
"type": ["string", "array"]
},
"loop_control": {
"title": "Loop Control"
},
"module_defaults": {
"title": "Module Defaults"
},
"name": {
"title": "Name",
"type": "string"
},
"no_log": {
"$ref": "#/$defs/no_log"
},
"notify": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Notify"
},
"poll": {
"$ref": "#/$defs/templated-integer",
"title": "Poll"
},
"port": {
"$ref": "#/$defs/templated-integer",
"title": "Port"
},
"register": {
"title": "Register",
"type": "string"
},
"remote_user": {
"title": "Remote User",
"type": "string"
},
"retries": {
"$ref": "#/$defs/templated-integer",
"title": "Retries"
},
"run_once": {
"$ref": "#/$defs/templated-boolean",
"title": "Run Once"
},
"tags": {
"$ref": "#/$defs/tags",
"title": "Tags"
},
"throttle": {
"$ref": "#/$defs/templated-integer",
"title": "Throttle"
},
"timeout": {
"$ref": "#/$defs/templated-integer",
"title": "Timeout"
},
"until": {
"$ref": "#/$defs/complex_conditional",
"title": "Until"
},
"vars": {
"title": "Vars",
"type": "object"
},
"when": {
"$ref": "#/$defs/complex_conditional",
"title": "When"
},
"with_dict": {
"title": "With Dict"
},
"with_fileglob": {
"title": "With Fileglob"
},
"with_filetree": {
"title": "With Filetree"
},
"with_first_found": {
"title": "With First Found"
},
"with_indexed_items": {
"title": "With Indexed Items"
},
"with_ini": {
"title": "With Ini"
},
"with_inventory_hostnames": {
"title": "With Inventory Hostnames"
},
"with_items": {
"anyOf": [
{
"$ref": "#/$defs/full-jinja"
},
{
"type": "array"
}
],
"markdownDescription": "See [loops](https://docs.ansible.com/ansible/latest/user_guide/playbooks_loops.html#loops)",
"title": "With Items"
},
"with_lines": {
"title": "With Lines"
},
"with_random_choice": {
"title": "With Random Choice"
},
"with_sequence": {
"title": "With Sequence"
},
"with_subelements": {
"title": "With Subelements"
},
"with_together": {
"title": "With Together"
}
},
"title": "task",
"type": "object"
},
"tasks": {
"$schema": "http://json-schema.org/draft-07/schema",
"examples": ["tasks/*.yml", "handlers/*.yml"],
"items": {
"anyOf": [
{
"$ref": "#/$defs/block"
},
{
"$ref": "#/$defs/task"
}
]
},
"title": "Ansible Tasks Schema",
"type": ["array", "null"]
},
"templated-boolean": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/full-jinja",
"type": "string"
}
]
},
"templated-integer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/$defs/full-jinja",
"type": "string"
}
]
},
"templated-integer-or-percent": {
"oneOf": [
{
"type": "integer"
},
{
"pattern": "^\\d+\\.?\\d*%?$",
"type": "string"
},
{
"$ref": "#/$defs/full-jinja",
"type": "string"
}
]
},
"templated-object": {
"oneOf": [
{
"type": "object"
},
{
"$ref": "#/$defs/full-jinja",
"type": "string"
}
]
},
"vars_prompt": {
"additionalProperties": false,
"properties": {
"confirm": {
"title": "Confirm",
"type": "boolean"
},
"default": {
"title": "Default",
"type": "string"
},
"encrypt": {
"enum": [
"des_crypt",
"bsdi_crypt",
"bigcrypt",
"crypt16",
"md5_crypt",
"bcrypt",
"sha1_crypt",
"sun_md5_crypt",
"sha256_crypt",
"sha512_crypt",
"apr_md5_crypt",
"phpass",
"pbkdf2_digest",
"cta_pbkdf2_sha1",
"dlitz_pbkdf2_sha1",
"scram",
"bsd_nthash"
],
"title": "Encrypt",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"private": {
"default": true,
"title": "Private",
"type": "boolean"
},
"prompt": {
"title": "Prompt",
"type": "string"
},
"salt_size": {
"default": 8,
"title": "Salt Size",
"type": "integer"
},
"unsafe": {
"default": false,
"markdownDescription": "See [unsafe](https://docs.ansible.com/ansible/latest/user_guide/playbooks_prompts.html#allowing-special-characters-in-vars-prompt-values)",
"title": "Unsafe",
"type": "boolean"
}
},
"required": ["name", "prompt"],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": false,
"examples": [],
"title": "Ansible Schemas Bundle 22.4",
"type": ["array", "object"]
}
|
dart-build.json | {
"$id": "https://json.schemastore.org/dart-build",
"$ref": "#/definitions/buildConfig",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"_listOfGlobs": {
"type": "array",
"items": {
"type": "string"
}
},
"buildConfig": {
"type": "object",
"properties": {
"targets": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/buildTarget"
},
"propertyNames": {
"$ref": "#/definitions/targetKey"
}
},
"builders": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/builderDefinition"
},
"propertyNames": {
"$ref": "#/definitions/builderKey"
}
},
"post_process_builders": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/postProcessBuilderDefinition"
}
},
"global_options": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/globalBuilderOptions"
}
},
"additional_public_assets": {
"$ref": "#/definitions/_listOfGlobs"
}
},
"additionalProperties": false
},
"buildTarget": {
"type": "object",
"properties": {
"auto_apply_builders": {
"type": "boolean",
"default": true
},
"builders": {
"type": "object",
"propertyNames": {
"$ref": "#/definitions/builderKey"
},
"additionalProperties": {
"$ref": "#/definitions/targetBuilderConfig"
}
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/targetKey"
}
},
"sources": {
"$ref": "#/definitions/inputSet"
}
},
"additionalProperties": false
},
"builderDefinition": {
"type": "object",
"properties": {
"builder_factories": {
"type": "array",
"items": {
"type": "string"
}
},
"import": {
"type": "string"
},
"build_extensions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"auto_apply": {
"$ref": "#/definitions/autoApply",
"default": "none"
},
"required_inputs": {
"type": "array",
"items": {
"type": "string"
}
},
"runs_before": {
"$ref": "#/definitions/runsBefore"
},
"applies_builders": {
"type": "array",
"items": {
"$ref": "#/definitions/builderKey"
}
},
"is_optional": {
"type": "boolean",
"default": false
},
"build_to": {
"$ref": "#/definitions/buildTo",
"default": "cache"
},
"defaults": {
"$ref": "#/definitions/targetBuilderConfigDefaults"
},
"target": {
"type": "string",
"title": "The name of the dart_library target that contains the import",
"deprecated": true,
"deprecationMessage": "May be null or unreliable and should not be used."
}
},
"additionalProperties": false
},
"postProcessBuilderDefinition": {
"type": "object",
"properties": {
"builder_factory": {
"type": "string"
},
"import": {
"type": "string"
},
"input_extensions": {
"type": "array",
"items": {
"type": "string"
}
},
"defaults": {
"$ref": "#/definitions/targetBuilderConfigDefaults"
}
},
"additionalProperties": false
},
"inputSet": {
"oneOf": [
{
"type": "object",
"properties": {
"include": {
"$ref": "#/definitions/_listOfGlobs"
},
"exclude": {
"$ref": "#/definitions/_listOfGlobs"
}
},
"additionalProperties": false
},
{
"$comment": "Use List<String> directly, inferred to mean include.",
"$ref": "#/definitions/_listOfGlobs"
}
]
},
"targetBuilderConfig": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"generate_for": {
"$ref": "#/definitions/inputSet"
},
"options": {
"$ref": "#/definitions/builderOptions"
},
"dev_options": {
"$ref": "#/definitions/builderOptions"
},
"release_options": {
"$ref": "#/definitions/builderOptions"
}
},
"additionalProperties": false
},
"targetBuilderConfigDefaults": {
"type": "object",
"properties": {
"generate_for": {
"$ref": "#/definitions/inputSet"
},
"options": {
"$ref": "#/definitions/builderOptions"
},
"dev_options": {
"$ref": "#/definitions/builderOptions"
},
"release_options": {
"$ref": "#/definitions/builderOptions"
}
},
"additionalProperties": false
},
"globalBuilderOptions": {
"type": "object",
"properties": {
"options": {
"$ref": "#/definitions/builderOptions"
},
"dev_options": {
"$ref": "#/definitions/builderOptions"
},
"release_options": {
"$ref": "#/definitions/builderOptions"
},
"runs_before": {
"$ref": "#/definitions/runsBefore"
}
},
"additionalProperties": false
},
"builderOptions": {
"type": "object",
"title": "Options to apply to a builder",
"description": "An arbitrary Map<String, dynamic> of configuration options exposed by the individual builders. See the documentation for the builder you are configuring for guidance.",
"additionalProperties": true
},
"autoApply": {
"type": "string",
"description": "On which packages the builder is applied by default",
"enum": ["none", "dependents", "all_packages", "root_package"]
},
"buildTo": {
"type": "string",
"description": "Whether the outputs should be stored in a hidden cache or in the source directory.",
"enum": ["cache", "source"]
},
"targetKey": {
"type": "string",
"title": "An identifier for a target",
"description": "A target key has two parts, a package and a name. They are separated by a colon.",
"pattern": "^(?:\\w+:)?\\w+|\\$default$"
},
"builderKey": {
"type": "string",
"title": "An identifier for a builder",
"description": "To construct a key, you join the package name and the builder name with a colon.",
"pattern": "^(?:\\w*:)?\\w+$"
},
"runsBefore": {
"type": "array",
"items": {
"$ref": "#/definitions/builderKey"
}
}
},
"description": "Configuration for Dart's build system",
"title": "build.yaml files"
}
|
drupal-libraries.json | {
"$id": "https://json.schemastore.org/drupal-libraries.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"version": {
"title": "The library version",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"remote": {
"title": "The library repository URL",
"type": "string"
},
"license": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "The human-readable name of the license",
"type": "string"
},
"url": {
"title": "The URL of the license file/information for the version of the library used",
"type": "string"
},
"gpl-compatible": {
"title": "A boolean for whether this library is GPL compatible",
"type": "boolean"
}
}
},
"header": {
"title": "A boolean for whether the script must be included in the header",
"type": "boolean"
},
"drupalSettings": {
"title": "Settings that needs to be attached to drupalSettings object in JavaScript",
"type": "object"
},
"js": {
"title": "List of JavaScript files to load",
"type": "object",
"additionalProperties": {
"type": "object",
"$ref": "#/definitions/file",
"properties": {
"cache": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"css": {
"title": "List of CSS files to load",
"type": "object",
"properties": {
"base": {
"$ref": "#/definitions/cssFiles"
},
"layout": {
"$ref": "#/definitions/cssFiles"
},
"component": {
"$ref": "#/definitions/cssFiles"
},
"theme": {
"$ref": "#/definitions/cssFiles"
},
"state": {
"$ref": "#/definitions/cssFiles"
}
}
},
"dependencies": {
"title": "List libraries that should be loaded along with this library",
"type": "array",
"items": {
"type": "string",
"pattern": "^.+/.+$"
}
}
}
},
"definitions": {
"file": {
"type": "object",
"properties": {
"attributes": {
"title": "Optional attributes",
"type": "object"
},
"browsers": {
"title": "Load asset conditionally based on browser",
"type": "object"
},
"minified": {
"title": "Whether the asset is already minified",
"type": "boolean"
},
"external": {
"type": "boolean"
},
"type": {
"title": "The source of the asset",
"type": "string"
},
"preprocess": {
"title": "Whether the assets should be aggregated",
"type": "boolean"
},
"weight": {
"title": "The order relative to other assets",
"type": "integer"
}
}
},
"cssFiles": {
"type": "object",
"additionalProperties": {
"type": "object",
"$ref": "#/definitions/file",
"properties": {
"group": {
"title": "The SMACSS group in which the asset is placed",
"type": "integer"
},
"media": {
"title": "Media type",
"type": "string",
"enum": ["all", "screen", "print", "speech"]
}
},
"additionalProperties": false
}
}
},
"title": "JSON schema for Drupal libraries file",
"type": "object"
}
|
server.schema.json | {
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"trayOptionsItem": {
"title": "Tray Option",
"description": "An object that represents a single tray menu item",
"type": "object",
"properties": {
"label": {
"title": "Label",
"description": "Text of menu item",
"type": "string"
},
"action": {
"title": "Action",
"description": "Action to perform when user clicks this menu item. 'openfilesystem', 'openbrowser', or 'stopserver'",
"type": "string"
},
"url": {
"title": "URL",
"description": "Url to open for 'openbrowser' action",
"type": "string"
},
"disabled": {
"title": "Disabled",
"description": "Turn menu item grey and nothing happens when clicking on it",
"type": "boolean",
"default": false
},
"image": {
"title": "Image",
"description": "Path to PNG image to display on menu item next to the label",
"type": "string",
"default": ""
},
"hotkey": {
"title": "Hotkey",
"description": "Keyboard shortcut to choose this menu item",
"type": "string",
"default": ""
},
"path": {
"title": "Path",
"description": "Filesystem path to open for 'openfilesystem' action",
"type": "string",
"default": ""
},
"items": {
"title": "Items",
"description": "Nested menu items",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/trayOptionsItem"
},
"default": []
}
}
}
},
"title": "CommandBox Server",
"description": "Configuration file for a CommandBox server",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The name of the server",
"type": "string",
"default": ""
},
"openBrowser": {
"title": "Open Browser",
"description": "Controls whether browser opens by default when starting server",
"type": "boolean",
"default": true
},
"openBrowserURL": {
"title": "Open Browser URL",
"description": "Override the URL to open when starting the server",
"type": "string",
"default": ""
},
"startTimeout": {
"title": "Server start timeout",
"description": "The length of time in seconds to wait for the server to start",
"type": "number",
"default": 240
},
"stopsocket": {
"title": "Stop Socket",
"description": "The port the server listens on to receive a stop command",
"type": "number",
"default": 0
},
"debug": {
"title": "Debug",
"description": "Enable debug level logging for server",
"type": "boolean",
"default": false
},
"trace": {
"title": "Trace",
"description": "Enable trace level logging for server",
"type": "boolean",
"default": false
},
"console": {
"title": "Console",
"description": "Start the server in console mode instead of in the background",
"type": "boolean",
"default": false
},
"trayEnable": {
"title": "Tray Enable",
"description": "Control whether the server has an associated icon in the system tray",
"type": "boolean",
"default": true
},
"trayicon": {
"title": "Tray Icon",
"description": "Path to the server's tray icon",
"type": "string",
"default": ""
},
"trayOptions": {
"title": "Tray Options",
"description": "An array of custom menu items to be added to the server's tray menu",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/trayOptionsItem"
},
"default": []
},
"jvm": {
"title": "JVM",
"description": "JVM Options",
"type": "object",
"properties": {
"heapSize": {
"title": "Max Heap Size",
"description": "The max heap size of the server",
"type": [
"number",
"string"
],
"default": ""
},
"minHeapSize": {
"title": "Min Heap Size",
"description": "The starting heap size for the server",
"type": [
"number",
"string"
],
"default": ""
},
"args": {
"title": "JVM Arguments",
"description": "Ad-hoc JVM args for the server such as -X:name",
"type": "string",
"default": ""
},
"javaHome": {
"title": "Java Home Path",
"description": "Path to custom JRE. Default is the one that the CommandBox CLI is using",
"type": "string",
"default": ""
},
"javaVersion": {
"title": "Java Version",
"description": "A Java installation ID. In its entirety, it has the form <version>_<type>_<arch>_<os>_<jvm-implementation>_<release>",
"type": "string",
"default": ""
}
}
},
"web": {
"title": "Web",
"description": "Web Server Options",
"type": "object",
"properties": {
"host": {
"title": "Host",
"description": "The default host name of the server",
"type": "string",
"default": "127.0.0.1"
},
"webroot": {
"title": "Webroot",
"description": "Webroot directory",
"type": "string",
"default": ""
},
"directoryBrowsing": {
"title": "Directory Browsing",
"description": "Enables file listing for directories with no welcome file",
"type": "boolean",
"default": false
},
"accessLogEnable": {
"title": "Access Log Enable",
"description": "Enable web server access log",
"type": "boolean",
"default": true
},
"GZIPEnable": {
"title": "GZIP Enable",
"description": "Enable GZip compression in HTTP responses",
"type": "boolean",
"default": true
},
"welcomeFiles": {
"title": "Welcome Files",
"description": "A comma-delimited list of files that you would like CommandBox to look for when a user hits a directory",
"type": "string",
"default": ""
},
"aliases": {
"title": "Aliases",
"description": "Web aliases for the web server, similar to virtual directories",
"type": "object",
"patternProperties": {
"^(/[^/]+)+$": {
"title": "Alias",
"description": "The key is the web-accessible virtual path and the value is the relative or absolute path to the folder the alias points to",
"type": "string"
}
},
"additionalProperties": false,
"default": {}
},
"errorPages": {
"title": "Error Pages",
"description": "The error pages that CommandBox servers return. You can have a setting for each status code including a default error page to be used if no other setting applies",
"type": "object",
"properties": {
"default": {
"title": "Default",
"description": "Path to default error page",
"type": "string",
"default": ""
}
},
"patternProperties": {
"^[1-5][0-9]{2}$": {
"title": "Error Page",
"description": "The key is the status code integer and the value is a relative (to the web root) path to be loaded for that status code",
"type": "string"
}
},
"additionalProperties": false,
"default": {}
},
"HTTP": {
"title": "HTTP Settings",
"description": "Configure the HTTP listener on the server",
"type": "object",
"properties": {
"enable": {
"title": "Enable",
"description": "Enable HTTP for this serer",
"type": "boolean",
"default": true
},
"port": {
"title": "Port",
"description": "HTTP port to use",
"type": "number",
"default": 0
}
}
},
"SSL": {
"title": "SSL",
"description": "Configure the HTTPS listener on the server",
"type": "object",
"properties": {
"enable": {
"title": "Enable",
"description": "Enable HTTPS for this server",
"type": "boolean",
"default": false
},
"port": {
"title": "Port",
"description": "HTTPS port to use",
"type": "number",
"default": 1443
},
"certFile": {
"title": "Cert File",
"description": "Path to SSL cert file",
"type": "string",
"default": ""
},
"keyFile": {
"title": "Key File",
"description": "Path to SSL key file",
"type": "string",
"default": ""
},
"keyPass": {
"title": "Key Pass",
"description": "Password for SSL key file",
"type": "string",
"default": ""
}
}
},
"AJP": {
"title": "AJP",
"description": "Configure the AJP listener on the server",
"type": "object",
"properties": {
"enable": {
"title": "Enable",
"description": "Enable AJP for this server",
"type": "boolean",
"default": false
},
"port": {
"title": "Port",
"description": "AJP port to use",
"type": "number",
"default": 8009
}
}
},
"rewrites": {
"title": "Rewrites",
"description": "Configure URL Rewrites",
"type": "object",
"properties": {
"enable": {
"title": "Enable",
"description": "Enable URL Rewrites on this server",
"type": "boolean",
"default": false
},
"logEnable": {
"title": "Log Enable",
"description": "Enable Rewrite log file",
"type": "boolean",
"default": false
},
"config": {
"title": "Config",
"description": "Path to xml config file or .htaccess",
"type": "string",
"default": ""
},
"statusPath": {
"title": "Tuckey Status Path",
"description": "URL path to visit Tuckey status page like '/tuckey-status'",
"type": "string",
"default": "/tuckey-status"
},
"configReloadSeconds": {
"title": "Config Reload Seconds",
"description": "Number of seconds to check rewrite config file for changes",
"type": "number"
}
}
},
"basicAuth": {
"title": "Configure basic authentication",
"description": "",
"type": "object",
"properties": {
"enable": {
"title": "Enable",
"description": "Enable basic auth for this server",
"type": "boolean",
"default": true
},
"users": {
"title": "Users",
"description": "Users who can authenticate to basic auth",
"type": "object",
"additionalProperties": {
"title": "User",
"description": "The key is the user name and the value is the password.",
"type": "string"
},
"default": {}
}
}
}
}
},
"app": {
"title": "Application",
"description": "Application Server Options",
"type": "object",
"properties": {
"logDir": {
"title": "Log Directory",
"description": "The folder path where the servlet out, rewrite, and access log are written to",
"type": "string",
"default": ""
},
"libDirs": {
"title": "Jar lib Directories",
"description": "A comma-delimited list of directories from which CommandBox will load JARs",
"type": "string",
"default": ""
},
"webConfigDir": {
"title": "Web Context Directory",
"description": "Directory for Lucee/Railo web context",
"type": "string",
"default": ""
},
"serverConfigDir": {
"title": "Server Context Directory",
"description": "Directory for Lucee/Railo server context",
"type": "string",
"default": ""
},
"webXML": {
"title": "Web XML",
"description": "Path to web.xml file",
"type": "string",
"default": ""
},
"WARPath": {
"title": "WAR Path",
"description": "Path to a local WAR archive or exploded WAR folder. Mutually exclusive with cfengine.",
"type": "string",
"default": ""
},
"cfengine": {
"title": "CFML Engine",
"description": "An Endpoint ID that resolves to a CF engine such as 'adobe' or 'lucee'. Include version as 'adobe@2016'",
"type": "string",
"default": ""
},
"restMappings": {
"title": "REST Mappings",
"description": "Comma delimited list of paths to map to the CF engine's REST servlet such as '/rest/*,/api/*'",
"type": "string",
"default": ""
},
"serverHomeDirectory": {
"title": "Server Home Directory",
"description": "Path to folder where the server WAR will be expanded",
"type": "string",
"default": ""
},
"sessionCookieSecure": {
"title": "Session Cookie Secure",
"description": "Enable secure session cookies",
"type": "boolean",
"default": false
},
"sessionCookieHTTPOnly": {
"title": "Session Cookie HttpOnly",
"description": "Enable HTTP-only session cookies",
"type": "boolean",
"default": false
}
}
},
"runwar": {
"title": "Configure RunWar",
"description": "These settings apply to the underlying Runwar library that starts servers",
"type": "object",
"properties": {
"args": {
"title": "Arguments",
"description": "Ad-hoc options for the underlying Runwar library",
"type": "string",
"default": ""
}
}
}
}
} |
trivia.schema.json | {
"$id": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/V3/develop/schema/trivia.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Red-DiscordBot Trivia List file",
"type": "object",
"properties": {
"$schema": {
"type": "string",
"format": "uri"
},
"AUTHOR": {
"type": "string",
"description": "Author of the Trivia list."
},
"CONFIG": {
"type": "object",
"description": "The configuration for a trivia session.",
"properties": {
"bot_plays": {
"type": "boolean",
"description": "Whether or not the bot gains points during the session."
},
"delay": {
"type": "number",
"description": "The maximum number of seconds permitted to answer a question, must be a positive number greater than or equal to 4.0.",
"minimum": 4.0
},
"max_score": {
"type": "integer",
"description": "Number of points required in order to win the trivia, must be a positive integer.",
"exclusiveMinimum": 0
},
"payout_multiplier": {
"type": "number",
"description": "The payout multiplier, must be a positive number or zero.",
"minimum": 0
},
"reveal_answer": {
"type": "boolean",
"description": "Whether or not to reveal the answer when the question times out."
},
"timeout": {
"type": "number",
"description": "Number of seconds that need to pass until trivia stops due to no response, must be a positive number greater than 0.0.",
"exclusiveMinimum": 0
},
"use_spoilers": {
"type": "boolean",
"description": "Whether to hide the answers in spoilers when revealing the question's answers."
}
},
"additionalProperties": false
}
},
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
|
djlint.json | {
"$comment": "Source: https://www.djlint.com/docs/configuration",
"$id": "https://json.schemastore.org/djlint.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"default": {
"format_attribute_template_tags": false,
"profile": "html"
},
"definitions": {
"css-beautify": {
"type": "object"
},
"js-beautify": {
"type": "object"
}
},
"description": "JSON schema fcor djLint's configuration file",
"properties": {
"$schema": {
"type": "string"
},
"blank_line_after_tag": {
"type": "string"
},
"blank_line_before_tag": {
"type": "string"
},
"close_void_tags": {
"type": "boolean"
},
"css": {
"$ref": "#/definitions/css-beautify"
},
"custom_blocks": {
"type": "string"
},
"custom_html": {
"type": "string"
},
"exclude": {
"type": "string"
},
"extend_exclude": {
"type": "string"
},
"extension": {
"type": "string"
},
"files": {
"items": {
"type": "string"
},
"type": "array"
},
"format_attribute_template_tags": {
"type": "boolean"
},
"format_css": {
"type": "boolean"
},
"format_js": {
"type": "boolean"
},
"ignore": {
"type": "string"
},
"ignore_blocks": {
"type": "string"
},
"ignore_case": {
"type": "boolean"
},
"include": {
"type": "string"
},
"indent": {
"type": "number"
},
"js": {
"$ref": "#/definitions/js-beautify"
},
"line_break_after_multiline_tag": {
"type": "boolean"
},
"linter_output_format": {
"examples": ["{filename}:{line}: {code} {message} {match}"],
"type": "string"
},
"max_attribute_length": {
"type": "number"
},
"max_blank_lines": {
"type": "number"
},
"max_line_length": {
"type": "number"
},
"no_function_formatting": {
"type": "boolean"
},
"no_line_after_yaml": {
"type": "boolean"
},
"no_set_formatting": {
"type": "boolean"
},
"per-file-ignores": {
"type": "object"
},
"preserve_blank_lines": {
"type": "boolean"
},
"preserve_leading_space": {
"type": "boolean"
},
"profile": {
"enum": [
"html",
"django",
"jinja",
"nunjucks",
"handlebars",
"golang",
"angular"
]
},
"require_pragma": {
"type": "boolean"
},
"use_gitignore": {
"type": "boolean"
}
},
"title": "djlint schema",
"type": "object"
}
|
drupal-migration.json | {
"$id": "https://json.schemastore.org/drupal-migration.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"title": "The migration ID (machine name)",
"type": "string"
},
"label": {
"title": "The human-readable label for the migration",
"type": "string"
},
"audit": {
"title": "Whether the migration is auditable",
"type": "boolean"
},
"migration_tags": {
"title": "List of tags, used by the plugin manager for filtering",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"deriver": {
"title": "Deriver class",
"type": "string"
},
"source": {
"title": "The source plugin configuration",
"type": "object",
"properties": {
"plugin": {
"title": "Source plugin ID",
"type": "string"
}
},
"required": ["plugin"]
},
"process": {
"title": "The configuration describing the process plugins",
"type": "object"
},
"destination": {
"title": "The destination plugin configuration",
"type": ["object"],
"properties": {
"plugin": {
"title": "Destination plugin ID",
"type": ["string", "null"]
}
},
"required": ["plugin"]
},
"migration_dependencies": {
"title": "Migrations to run before this migration",
"type": "object",
"properties": {
"required": {
"title": "List of migration IDs that must be run before this migration",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"optional": {
"title": "List of migration IDs that, if they exist, must be run before",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
},
"dependencies": {
"title": "The migration's dependencies",
"type": "object",
"properties": {
"config": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"module": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"theme": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"content": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"enforced": {
"type": "object",
"properties": {
"config": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"module": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"theme": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"content": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"provider": {
"title": "List of plugin providers",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"class": {
"title": "Class for migration implementation",
"type": ["string", "null"]
}
},
"title": "JSON schema for Drupal migration files",
"type": "object"
}
|
host.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"aggregator": {
"description": "Configuration settings for the function result aggregator.",
"type": "object",
"properties": {
"batchSize": {
"description": "The maximum batch size for aggregations. If this value is reached before the 'flushTimeout', all values will be flushed.",
"type": "integer",
"default": 1000
},
"flushTimeout": {
"description": "The aggregation duration. The aggregator will flush periodically based on this value.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:00:30"
}
},
"additionalProperties": false
},
"functions": {
"description": "The list of functions the host should load.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"functionTimeout": {
"description": "Value indicating the timeout duration for all functions.",
"oneOf": [
{
"type": "string",
"pattern": "^(-1|(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d)$"
},
{
"enum": [null]
}
]
},
"watchDirectories": {
"description": "Set of shared code directories that should be monitored for changes to ensure that when code in these directories is changed, it is picked up by your functions",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
}
},
"singleton": {
"description": "Configuration settings for Singleton lock behavior.",
"type": "object",
"properties": {
"lockPeriod": {
"description": "The period that function level locks are taken for (they will auto renew).",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:00:15"
},
"listenerLockPeriod": {
"description": "The period that listener locks are taken for.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:01:00"
},
"listenerLockRecoveryPollingInterval": {
"description": "The time interval used for listener lock recovery if a listener lock couldn't be acquired on startup.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:01:00"
},
"lockAcquisitionTimeout": {
"description": "The maximum amount of time the runtime will try to acquire a lock.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:01:00"
},
"lockAcquisitionPollingInterval": {
"description": "The interval between lock acquisition attempts.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
}
},
"additionalProperties": false
},
"healthMonitor": {
"description": "Configuration settings for the Functions host health monitor",
"type": "object",
"properties": {
"enabled": {
"description": "Specifies whether the feature is enabled.",
"type": "boolean",
"default": true
},
"healthCheckInterval": {
"description": "The time interval between the periodic background health checks",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:00:10"
},
"healthCheckWindow": {
"description": "A sliding time window used in conjunction with the healthCheckThreshold setting.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:02:00"
},
"healthCheckThreshold": {
"description": "Maximum number of times the health check can fail before a host recycle is initiated.",
"type": "integer",
"default": 6
},
"counterThreshold": {
"description": "The threshold at which a performance counter will be considered unhealthy.",
"type": "number",
"default": 0.8
}
},
"additionalProperties": false
},
"http-extension": {
"type": "object",
"description": "Configuration settings for 'http' triggers.",
"required": ["routePrefix"],
"properties": {
"routePrefix": {
"description": "Defines the default route prefix that applies to all routes. Use an empty string to remove the prefix.",
"type": "string",
"default": "api"
},
"maxConcurrentRequests": {
"description": "Defines the the maximum number of http functions that will execute in parallel.",
"type": "integer",
"default": -1
},
"maxOutstandingRequests": {
"description": "Defines the maximum number of outstanding requests that will be held at any given time.",
"type": "integer",
"default": -1
},
"dynamicThrottlesEnabled": {
"description": "Indicates whether dynamic host counter checks should be enabled.",
"type": "boolean",
"default": false
},
"hsts": {
"description": "Configuration settings for Strict-Transport-Security",
"type": "object",
"properties": {
"isEnabled": {
"description": "Indicates whether the hsts configuration should be applied",
"type": "boolean"
},
"excludedHosts": {
"description": "Defines the list of host names that will not add the HSTS header.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"includeSubDomains": {
"description": "Indicates whether the includeSubDomain parameter of the Strict-Transport-Security header should be enabled.",
"type": "boolean"
},
"maxAge": {
"description": "Defines the max-age parameter of the Strict-Transport-Security header.",
"type": "string"
},
"preload": {
"description": "Indicates whether the preload parameter of the Strict-Transport-Security header should be enabled.",
"type": "boolean"
}
},
"additionalProperties": false
},
"customHeaders": {
"description": "Allows you to set custom headers in the HTTP response, ex. X-Content-Type-Options.",
"type": "object"
}
},
"additionalProperties": false
},
"queues-extension": {
"description": "Configuration settings for 'queue' triggers.",
"type": "object",
"properties": {
"maxPollingInterval": {
"description": "The maximum interval in milliseconds between queue polls.",
"type": "integer",
"default": 1000
},
"batchSize": {
"description": "The number of queue messages to retrieve and process in parallel (per job function).",
"type": "integer",
"maximum": 32,
"minimum": 1,
"default": 16
},
"maxDequeueCount": {
"description": "The number of times to try processing a message before moving it to the poison queue",
"type": "integer",
"default": 5
},
"newBatchThreshold": {
"description": "The threshold at which a new batch of messages will be fetched. The default is batchSize/2.",
"type": "integer"
},
"visibilityTimeout": {
"description": "The visibility timeout that will be applied to messages that fail processing.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:00:00"
}
},
"additionalProperties": false
},
"queues-extension-v2": {
"description": "Configuration settings for 'queue' triggers.",
"type": "object",
"properties": {
"maxPollingInterval": {
"type": "string",
"pattern": "^[0-9][0-9]:[0-9][0-9]:[0-9][0-9](?:\\.[0-9]+)?$",
"default": "00:00:02",
"description": "The maximum interval between queue polls. Minimum is 00:00:00.100 (100 ms)."
},
"visibilityTimeout": {
"type": "string",
"pattern": "^[0-9][0-9]:[0-9][0-9]:[0-9][0-9](?:\\.[0-9]+)?$",
"default": "00:00:00",
"description": "The time interval between retries when processing of a message fails."
},
"batchSize": {
"description": "The number of queue messages that the Functions runtime retrieves simultaneously and processes in parallel. When the number being processed gets down to the `newBatchThreshold`, the runtime gets another batch and starts processing those messages. So the maximum number of concurrent messages being processed per function is `batchSize` plus `newBatchThreshold`. This limit applies separately to each queue-triggered function. ",
"type": "integer",
"maximum": 32,
"minimum": 1,
"default": 16
},
"maxDequeueCount": {
"description": "The number of times to try processing a message before moving it to the poison queue",
"type": "integer",
"default": 5
},
"newBatchThreshold": {
"description": "The threshold at which a new batch of messages will be fetched. The default is batchSize/2.",
"type": "integer"
},
"messageEncoding": {
"description": "This setting is only available in extension version 5.0.0 and higher. It represents the encoding format for messages.",
"type": "string",
"enum": ["base64", "none"]
}
},
"additionalProperties": false
},
"durableTask-extension": {
"description": "Configuration settings for 'orchestration'/'activity' triggers.",
"type": "object",
"properties": {
"hubName": {
"description": "Alternate task hub names can be used to isolate multiple Durable Functions applications from each other, even if they're using the same storage backend.",
"type": "string",
"default": "DurableFunctionsHub"
},
"storageProvider": {
"type": "object",
"properties": {
"connectionStringName": {
"type": "string"
},
"controlQueueBatchSize": {
"description": "The number of messages to pull from the control queue at a time.",
"type": "integer",
"default": 32
},
"controlQueueBufferThreshold": {
"description": "The number of control queue messages that can be buffered in memory at a time, at which point the dispatcher will wait before dequeuing any additional messages.",
"type": "integer",
"default": 256
},
"controlQueueVisibilityTimeout": {
"description": "The visibility timeout of dequeued control queue messages.",
"type": "string",
"default": "00:05:00"
},
"maxQueuePollingInterval": {
"description": "The maximum control and work-item queue polling interval in the hh:mm:ss format. Higher values can result in higher message processing latencies. Lower values can result in higher storage costs because of increased storage transactions.",
"type": "string",
"default": "00:00:30"
},
"partitionCount": {
"description": "The partition count for the control queue. May be a positive integer between 1 and 16.",
"type": "integer",
"default": 4
},
"trackingStoreConnectionStringName": {
"description": "The name of a connection string to use for the History and Instances tables. If not specified, the azureStorageConnectionStringName connection is used.",
"type": "string"
},
"trackingStoreNamePrefix": {
"description": "The prefix to use for the History and Instances tables when trackingStoreConnectionStringName is specified. If not set, the default prefix value will be DurableTask. If trackingStoreConnectionStringName is not specified, then the History and Instances tables will use the hubName value as their prefix, and any setting for trackingStoreNamePrefix will be ignored.",
"type": "string"
},
"useLegacyPartitionManagement": {
"description": "When set to false, uses a partition management algorithm that reduces the possibility of duplicate function execution when scaling out.",
"type": "boolean",
"default": false
},
"workItemQueueVisibilityTimeout": {
"description": "The visibility timeout of dequeued work item queue messages.",
"type": "string",
"default": "00:05:00"
}
},
"additionalProperties": false
},
"tracing": {
"type": "object",
"properties": {
"traceInputsAndOutputs": {
"description": "A value indicating whether to trace the inputs and outputs of function calls. The default behavior when tracing function execution events is to include the number of bytes in the serialized inputs and outputs for function calls. This behavior provides minimal information about what the inputs and outputs look like without bloating the logs or inadvertently exposing sensitive information. Setting this property to true causes the default function logging to log the entire contents of function inputs and outputs.",
"type": "boolean",
"default": false
},
"traceReplayEvents": {
"description": "A value indicating whether to write orchestration replay events to Application Insights.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"notifications": {
"type": "object",
"properties": {
"eventGrid": {
"type": "object",
"properties": {
"topicEndpoint": {
"description": "The URL of an Azure Event Grid custom topic endpoint. When this property is set, orchestration life-cycle notification events are published to this endpoint. This property supports App Settings resolution.",
"type": "string"
},
"keySettingName": {
"description": "The name of the app setting containing the key used for authenticating with the Azure Event Grid custom topic at EventGridTopicEndpoint.",
"type": "string"
},
"publishRetryCount": {
"description": "The number of times to retry if publishing to the Event Grid Topic fails.",
"type": "integer",
"default": 0
},
"publishRetryInterval": {
"description": "The Event Grid publishes retry interval in the hh:mm:ss format.",
"type": "string",
"default": "00:05:00"
},
"publishEventTypes": {
"description": "A list of event types to publish to Event Grid. If not specified, all event types will be published.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Started",
"Pending",
"Completed",
"Failed",
"Terminated"
]
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxConcurrentActivityFunctions": {
"description": "The maximum number of activity functions that can be processed concurrently on a single host instance.",
"type": "integer",
"default": 10
},
"maxConcurrentOrchestratorFunctions": {
"description": "The maximum number of orchestrator functions that can be processed concurrently on a single host instance.",
"type": "integer",
"default": 10
},
"extendedSessionsEnabled": {
"type": "boolean"
},
"extendedSessionIdleTimeoutInSeconds": {
"type": "integer"
},
"useAppLease": {
"description": "When set to true, apps will require acquiring an app-level blob lease before processing task hub messages.",
"type": "boolean",
"default": true
},
"useGracefulShutdown": {
"description": "Enable gracefully shutting down to reduce the chance of host shutdowns failing in-process function executions.",
"type": "boolean",
"default": false
},
"maxEntityOperationBatchSize": {
"description": "The maximum number of entity operations that are processed as a batch. If set to 1, batching is disabled, and each operation message is processed by a separate function invocation.",
"type": "integer",
"default": 50
},
"useTablePartitionManagement": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"cosmosDB-extension": {
"description": "Configuration settings for Azure Cosmos DB bindings and triggers.",
"type": "object",
"properties": {
"connectionMode": {
"description": "ConnectionMode to be used on the DocumentClients.",
"enum": ["Gateway", "Direct"],
"default": "Gateway"
},
"protocol": {
"description": "Protocol to be used on the DocumentClients.",
"enum": ["Https", "Tcp"],
"default": "Https"
}
},
"additionalProperties": false
},
"cosmosDB-extension-v2": {
"description": "Configuration settings for Azure Cosmos DB bindings and triggers.",
"type": "object",
"properties": {
"connectionMode": {
"description": "ConnectionMode to be used on the DocumentClients.",
"enum": ["Gateway", "Direct"],
"default": "Gateway"
},
"protocol": {
"description": "Protocol to be used on the DocumentClients.",
"enum": ["Https", "Tcp"],
"default": "Https"
},
"leaseOptions": {
"type": "object",
"properties": {
"leasePrefix": {
"description": "Lease prefix to use across all functions in an app.",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"version-1": {
"type": "object",
"properties": {
"aggregator": {
"$ref": "#/definitions/aggregator"
},
"applicationInsights": {
"description": "Configuration settings for Application Insights logging.",
"type": "object",
"properties": {
"sampling": {
"description": "Configuration settings for Application Insights client-side adaptive sampling.",
"type": "object",
"properties": {
"isEnabled": {
"description": "If true, client-side adaptive sampling is enabled.",
"type": "boolean",
"default": true
},
"maxTelemetryItemsPerSecond": {
"description": "The target rate that the adaptive algorithm aims for on each instance",
"type": "integer",
"default": 5
}
}
}
},
"additionalProperties": false
},
"functions": {
"$ref": "#/definitions/functions"
},
"functionTimeout": {
"$ref": "#/definitions/functionTimeout"
},
"healthMonitor": {
"$ref": "#/definitions/healthMonitor"
},
"id": {
"description": "The unique ID for this job host. Can be a lower case GUID with dashes removed",
"type": "string",
"minLength": 1
},
"logger": {
"description": "Configuration settings for logging.",
"type": "object",
"properties": {
"defaultLevel": {
"description": "The default level for logging. If a category level is not specified, this value is used.",
"enum": [
"Critical",
"Debug",
"Error",
"Information",
"None",
"Trace",
"Warning"
],
"default": "Information"
},
"categoryLevels": {
"description": "Log levels for specific categories.",
"type": "object",
"additionalProperties": {
"enum": [
"Critical",
"Debug",
"Error",
"Information",
"None",
"Trace",
"Warning"
]
}
}
}
},
"singleton": {
"$ref": "#/definitions/singleton"
},
"watchDirectories": {
"$ref": "#/definitions/watchDirectories"
},
"tracing": {
"description": "Configuration settings for logging/tracing behavior.",
"type": "object",
"properties": {
"consoleLevel": {
"description": "The tracing level used for console logging.",
"enum": ["off", "error", "warning", "info", "verbose"],
"default": "verbose"
},
"fileLoggingMode": {
"description": "Value determining what level of file logging is enabled.",
"enum": ["never", "always", "debugOnly"],
"default": "debugOnly"
}
},
"additionalProperties": false
},
"http": {
"$ref": "#/definitions/http-extension"
},
"queues": {
"$ref": "#/definitions/queues-extension"
},
"serviceBus": {
"description": "Configuration settings for 'serviceBus' triggers.",
"type": "object",
"properties": {
"maxConcurrentCalls": {
"description": "The maximum number of concurrent calls to the callback the message pump should initiate.",
"type": "integer",
"default": 16
},
"prefetchCount": {
"description": "The default PrefetchCount that will be used by the underlying MessageReceiver.",
"type": "integer"
},
"autoRenewTimeout": {
"description": "The maximum duration within which the Service Bus message lock will be renewed automatically.",
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:05:00"
},
"autoComplete": {
"description": "Specifies whether messages should be automatically completed after successful processing.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"eventHub": {
"description": "Configuration settings for 'eventHub' triggers.",
"type": "object",
"properties": {
"maxBatchSize": {
"description": "The maximum event count received per receive loop.",
"type": "integer"
},
"prefetchCount": {
"description": "The default PrefetchCount that will be used by the underlying EventProcessorHost.",
"type": "integer"
},
"batchCheckpointFrequency": {
"description": "The number of batches to process before creating an EventHub cursor checkpoint",
"type": "integer",
"default": 1
}
},
"additionalProperties": false
},
"durableTask": {
"$ref": "#/definitions/durableTask-extension"
},
"documentDB": {
"$ref": "#/definitions/cosmosDB-extension"
}
},
"additionalProperties": false
},
"version-2": {
"type": "object",
"properties": {
"extensionBundle": {
"description": "Configuration settings for extension bundle",
"type": "object",
"properties": {
"id": {
"description": "The id of the extension bundle",
"type": "string",
"default": "Microsoft.Azure.Functions.ExtensionBundle"
},
"version": {
"description": "The version of the extension bundle.",
"type": "string",
"examples": ["[1.*, 2.0.0)", "[2.*, 3.0.0)"],
"default": "[2.*, 3.0.0)"
}
},
"examples": [
{
"id": "Microsoft.Azure.Functions.ExtensionBundle",
"version": "[2.*, 3.0.0)"
}
],
"additionalProperties": false
},
"aggregator": {
"$ref": "#/definitions/aggregator"
},
"functions": {
"$ref": "#/definitions/functions"
},
"functionTimeout": {
"$ref": "#/definitions/functionTimeout"
},
"healthMonitor": {
"$ref": "#/definitions/healthMonitor"
},
"languageWorker": {
"description": "Configuration settings for Language Workers.",
"type": "object",
"properties": {
"workersDirectory": {
"description": "Specifies full path of the directory for language workers",
"type": "string"
}
},
"additionalProperties": false
},
"logging": {
"description": "Configuration settings for logging.",
"type": "object",
"properties": {
"logLevel": {
"description": "Log levels for specific categories.",
"type": "object",
"properties": {
"default": {
"description": "The default level for logging. If a category level is not specified, this value is used.",
"enum": [
"Critical",
"Debug",
"Error",
"Information",
"None",
"Trace",
"Warning"
],
"default": "Information"
}
},
"additionalProperties": {
"enum": [
"Critical",
"Debug",
"Error",
"Information",
"None",
"Trace",
"Warning"
]
}
},
"applicationInsights": {
"description": "Configuration settings for Application Insights logging.",
"type": "object",
"properties": {
"samplingSettings": {
"description": "Configuration settings for Application Insights client-side adaptive sampling.",
"type": "object",
"properties": {
"isEnabled": {
"description": "If true, client-side adaptive sampling is enabled.",
"type": "boolean",
"default": true
},
"maxTelemetryItemsPerSecond": {
"description": "The target rate that the adaptive algorithm aims for on each instance",
"type": "integer",
"default": 20
},
"evaluationInterval": {
"description": "The interval at which the current rate of telemetry is reevaluated.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "01:00:00"
},
"initialSamplingPercentage": {
"description": "The initial sampling percentage applied at the start of the sampling process to dynamically vary the percentage.",
"type": "number",
"default": 100
},
"samplingPercentageIncreaseTimeout": {
"description": "When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to raise sampling percentage again to capture more data.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:00:01"
},
"samplingPercentageDecreaseTimeout": {
"description": "When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to lower sampling percentage again to capture less data.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:00:01"
},
"minSamplingPercentage": {
"description": "As sampling percentage varies, this property determines the minimum allowed sampling percentage.",
"type": "number",
"default": 0.1
},
"maxSamplingPercentage": {
"description": "As sampling percentage varies, this property determines the maximum allowed sampling percentage.",
"type": "number",
"default": 100
},
"movingAverageRatio": {
"description": "In the calculation of the moving average, the weight assigned to the most recent value. Use a value equal to or less than 1. Smaller values make the algorithm less reactive to sudden changes.",
"type": "number",
"default": 1
},
"excludedTypes": {
"description": "A semi-colon delimited list of types excluded from sampling. Recognized: Dependency, Event, Exception, PageView, Request, Trace.",
"type": "string",
"default": "Request"
},
"includedTypes": {
"description": "A semi-colon delimited list of types that you want to be sampled. Recognized: Dependency, Event, Exception, PageView, Request, and Trace.",
"type": "string",
"default": "Request"
}
}
},
"enableLiveMetrics": {
"description": "Enables live metrics collection.",
"type": "boolean",
"default": true
},
"enableLiveMetricsFilters": {
"description": "Enables live metrics filters.",
"type": "boolean",
"default": true
},
"enableDependencyTracking": {
"description": "Enables dependency tracking",
"type": "boolean",
"default": true
},
"enablePerformanceCountersCollection": {
"description": "Enables Kudu performance counters collection.",
"type": "boolean",
"default": true
},
"httpAutoCollectionOptions": {
"type": "object",
"properties": {
"enableHttpTriggerExtendedInfoCollection": {
"description": "Enables or disables extended HTTP request information for HTTP triggers.",
"type": "boolean",
"default": true
},
"enableW3CDistributedTracing": {
"description": "Enables or disables support of W3C distributed tracing protocol (and turns on legacy correlation schema). Enabled by default if enableHttpTriggerExtendedInfoCollection is true. If enableHttpTriggerExtendedInfoCollection is false, this flag applies to outgoing requests only, not incoming requests",
"type": "boolean",
"default": true
},
"enableResponseHeaderInjection": {
"description": "Enables or disables injection of multi-component correlation headers into responses. Enabling injection allows Application Insights to construct an Application Map to when several instrumentation keys are used.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"snapshotConfiguration": {
"type": "object",
"properties": {
"agentEndpoint": {
"description": "The endpoint used to connect to the Application Insights Snapshot Debugger service.",
"oneOf": [
{
"type": "string"
},
{
"enum": [null]
}
],
"default": null
},
"captureSnapshotMemoryWeight": {
"description": "The weight given to the current process memory size when checking if there's enough memory to take a snapshot.",
"type": "number",
"default": 0.5
},
"failedRequestLimit": {
"description": "The limit on the number of failed requests to request snapshots before the telemetry processor is disabled.",
"type": "integer",
"default": 3
},
"handleUntrackedExceptions": {
"description": "Enables or disables tracking of exceptions that aren't tracked by Application Insights telemetry.",
"type": "boolean",
"default": true
},
"isEnabled": {
"description": "Enables or disables snapshot collection.",
"type": "boolean",
"default": true
},
"isEnabledInDeveloperMode": {
"description": "Enables or disables snapshot collection is enabled in developer mode.",
"type": "boolean",
"default": false
},
"isEnabledWhenProfiling": {
"description": "Enables or disables snapshot creation even if the Application Insights Profiler is collecting a detailed profiling session.",
"type": "boolean",
"default": true
},
"isExceptionSnappointsEnabled": {
"description": "Enables or disables filtering of exceptions.",
"type": "boolean",
"default": false
},
"isLowPrioritySnapshotUploader": {
"description": "Determines whether to run the SnapshotUploader process at below normal priority.",
"type": "boolean",
"default": true
},
"maximumCollectionPlanSize": {
"description": "The maximum number of problems that we can track at any time.",
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 9999
},
"maximumSnapshotsRequired": {
"description": "The maximum number of snapshots collected for a single problem.",
"type": "integer",
"default": 3,
"minimum": 1,
"maximum": 999
},
"problemCounterResetInterval": {
"description": "How often to reset the problem counters in a range from one minute to seven days.",
"type": "string",
"pattern": "^(?:[01]\\d|2[0-4]):[0-5]\\d:[0-5]\\d$",
"default": "24:00:00"
},
"provideAnonymousTelemetry": {
"description": "Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger",
"type": "boolean",
"default": true
},
"reconnectInterval": {
"description": "How often we reconnect to the Snapshot Debugger endpoint. Allowable range is one minute to one day.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:15:00"
},
"shadowCopyFolder": {
"description": "Specifies the folder to use for shadow copying binaries. If not set, the folders specified by the following environment variables are tried in order: Fabric_Folder_App_Temp, LOCALAPPDATA, APPDATA, TEMP.",
"oneOf": [
{
"type": "string"
},
{
"enum": [null]
}
],
"default": null
},
"shareUploaderProcess": {
"description": "If true, only one instance of SnapshotUploader will collect and upload snapshots for multiple apps that share the InstrumentationKey. If set to false, the SnapshotUploader will be unique for each (ProcessName, InstrumentationKey) tuple.",
"type": "boolean",
"default": true
},
"snapshotInLowPriorityThread": {
"description": "Determines whether or not to process snapshots in a low IO priority thread.",
"type": "boolean",
"default": true
},
"snapshotsPerDayLimit": {
"description": "The maximum number of snapshots allowed in one day (24 hours). This limit is also enforced on the Application Insights service side.",
"type": "integer",
"default": 30
},
"snapshotsPerTenMinutesLimit": {
"description": "The maximum number of snapshots allowed in 10 minutes. Although there is no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application.",
"type": "integer",
"default": 1
},
"tempFolder": {
"description": "Specifies the folder to write minidumps and uploader log files. If not set, then %TEMP%\\Dumps is used.",
"oneOf": [
{
"type": "string"
},
{
"enum": [null]
}
],
"default": null
},
"thresholdForSnapshotting": {
"description": "How many times Application Insights needs to see an exception before it asks for snapshots.",
"type": "integer",
"default": 1
},
"uploaderProxy": {
"description": "Overrides the proxy server used in the Snapshot Uploader process. You may need to use this setting if your application connects to the internet via a proxy server. The Snapshot Collector runs within your application's process and will use the same proxy settings.",
"oneOf": [
{
"type": "string"
},
{
"enum": [null]
}
],
"default": null
}
},
"additionalProperties": false
}
},
"examples": [
{
"samplingSettings": {
"isEnabled": true,
"excludedTypes": "Request"
}
}
],
"additionalProperties": false
},
"fileLoggingMode": {
"description": "Value determining what level of file logging is enabled.",
"enum": ["never", "always", "debugOnly"],
"default": "debugOnly"
}
}
},
"managedDependency": {
"description": "Managed dependency is a feature that is currently only supported with PowerShell based functions. It enables dependencies to be automatically managed by the service.",
"type": "object",
"properties": {
"enabled": {
"description": "If true, the requirements.psd1 file is processed",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"retry": {
"description": "Retry policy of function execution failures at the app level. Retry policy applies to all the functions in the function app.",
"type": "object",
"properties": {
"strategy": {
"description": "Retry strategy to use for retrying function executions",
"enum": ["exponentialBackoff", "fixedDelay"],
"default": "exponentialBackoff"
},
"maxRetryCount": {
"description": "The maximum number of retries allowed per function execution. -1 means to retry indefinitely.",
"type": "integer"
},
"delayInterval": {
"description": "Value indicating the delayInterval for function execution retries when using FixedDelay strategy.",
"oneOf": [
{
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
{
"enum": [null]
}
]
},
"minimumInterval": {
"description": "Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.",
"oneOf": [
{
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
{
"enum": [null]
}
]
},
"maximumInterval": {
"description": "Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.",
"oneOf": [
{
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
{
"enum": [null]
}
]
}
}
},
"customHandler": {
"description": "Configuration settings for Custom Handler.",
"type": "object",
"properties": {
"description": {
"description": "Configuration settings for Custom Handler process",
"type": "object",
"properties": {
"defaultExecutablePath": {
"description": "Name or path to the Custom Handler process",
"type": "string"
},
"workingDirectory": {
"description": "WorkingDirectory to be used by the Custom Handler process. If not set, defaults to function app root folder.",
"type": "string"
},
"arguments": {
"description": "Arguments to be passed to the Custom Handler process. Can use environment variables following pattern %envVarName%",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"enableForwardingHttpRequest": {
"description": "Forward HttpTrigger request to the custom handler",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"singleton": {
"$ref": "#/definitions/singleton"
},
"watchDirectories": {
"$ref": "#/definitions/watchDirectories"
},
"watchFiles": {
"description": "An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files are changed, the updates are picked up by your functions",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
},
"additionalProperties": false
},
"version": {
"description": "The version of the Azure Functions host.json schema. This is NOT the version of the Azure Functions host.",
"enum": ["2.0"]
},
"extensions": {
"type": "object",
"properties": {
"http": {
"$ref": "#/definitions/http-extension"
},
"queues": {
"$ref": "#/definitions/queues-extension-v2"
},
"sendGrid": {
"type": "object",
"properties": {
"from": {
"description": "The sender's email address across all functions.",
"type": "string"
}
},
"additionalProperties": false
},
"serviceBus": {
"description": "Configuration settings for 'serviceBus' triggers.",
"type": "object",
"properties": {
"prefetchCount": {
"description": "The default PrefetchCount that will be used by the underlying MessageReceiver.",
"type": "integer"
},
"messageHandlerOptions": {
"description": "The options that will be used for the message handler registered with the MessageReceiver.",
"type": "object",
"properties": {
"maxConcurrentCalls": {
"description": "The maximum number of concurrent calls to the callback the message pump should initiate.",
"type": "integer",
"default": 32
},
"maxAutoRenewDuration": {
"description": "The maximum duration within which the Service Bus message lock will be renewed automatically.",
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:05:00"
},
"autoComplete": {
"description": "Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"sessionHandlerOptions": {
"type": "object",
"properties": {
"maxAutoRenewDuration": {
"description": "The maximum duration within which the Service Bus message lock will be renewed automatically.",
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:55:00"
},
"autoComplete": {
"description": "Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion.",
"type": "boolean",
"default": false
},
"maxConcurrentSessions": {
"description": "The maximum number of sessions that can be handled concurrently per scaled instance.",
"type": "integer",
"default": 16
},
"messageWaitTimeout": {
"type": "string",
"default": "00:00:30"
}
},
"additionalProperties": false
},
"batchOptions": {
"type": "object",
"properties": {
"maxMessageCount": {
"description": "The maximum number of messages sent to the function when triggered.",
"type": "integer",
"default": 1000
},
"operationTimeout": {
"description": "A time span value expressed in hh:mm:ss.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"default": "00:01:00"
},
"autoComplete": {
"description": "Whether the trigger should automatically call complete after processing, or if the function code will manually call complete.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"eventHubs": {
"description": "Configuration settings for 'eventHub' triggers.",
"oneOf": [
{
"type": "object",
"properties": {
"targetUnprocessedEventThreshold": {
"description": "The target number of unprocessed events per worker for Event Hub-triggered functions. This is used in target-based scaling to override the default scaling threshold inferred from maxEventBatchSize.",
"type": "integer",
"minimum": 1
},
"maxEventBatchSize": {
"description": "The maximum number of events that will be included in a batch for a single invocation.",
"type": "integer",
"default": 10,
"minimum": 1
},
"batchCheckpointFrequency": {
"description": "The number of batches to process before creating a checkpoint for the Event Hub.",
"type": "integer",
"default": 1
},
"prefetchCount": {
"description": "The number of events that will be eagerly requested from Event Hubs and held in a local cache to allow reads to avoid waiting on a network operation.",
"type": "integer",
"default": 300
},
"transportType": {
"description": "The protocol and transport that is used for communicating with Event Hubs.",
"type": "string",
"enum": ["amqpTcp", "amqpWebSockets"],
"default": "amqpTcp"
},
"webProxy": {
"description": "The proxy to use for communicating with Event Hubs over web sockets. A proxy cannot be used with the amqpTcp transport.",
"type": "string"
},
"customEndpointAddress": {
"description": "The address to use when establishing a connection to Event Hubs, allowing network requests to be routed through an application gateway or other path needed for the host environment.",
"type": "string"
},
"initialOffsetOptions": {
"type": "object",
"properties": {
"type": {
"description": "The location in the event stream to start processing when a checkpoint does not exist in storage. Applies to all partitions.",
"type": "string",
"enum": ["fromStart", "fromEnd", "fromEnqueuedTime"],
"default": "fromStart"
},
"enqueuedTimeUtc": {
"description": "Specifies the enqueued time of the event in the stream from which to start processing. When initialOffsetOptions/type is configured as fromEnqueuedTime, this setting is mandatory. Supports time in any format supported by DateTime.Parse(), such as 2020-10-26T20:31Z.",
"type": "string"
}
},
"additionalProperties": false
},
"clientRetryOptions": {
"type": "object",
"properties": {
"mode": {
"description": "The approach to use for calculating retry delays. Exponential mode will retry attempts with a delay based on a back-off strategy where each attempt will increase the duration that it waits before retrying.",
"type": "string",
"enum": ["exponential", "fixed"],
"default": "exponential"
},
"tryTimeout": {
"description": "The maximum duration to wait for an Event Hubs operation to complete, per attempt.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"type": "string",
"default": "00:01:00"
},
"delay": {
"description": "The maximum duration to wait for an Event Hubs operation to complete, per attempt.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d\\d$",
"type": "string",
"default": "00:00:00.80"
},
"maxDelay": {
"description": "The maximum delay to allow between retry attempts.",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$",
"type": "string",
"default": "00:00:01"
},
"maxRetries": {
"description": "The maximum number of retry attempts before considering the associated operation to have failed.",
"type": "integer",
"default": 3
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"batchCheckpointFrequency": {
"description": "The number of batches to process before creating an EventHub cursor checkpoint.",
"type": "integer",
"default": 1
},
"eventProcessorOptions": {
"type": "object",
"description": "Configuration on processing event hub events.",
"properties": {
"maxBatchSize": {
"description": "The maximum event count received per receive loop.",
"type": "integer"
},
"prefetchCount": {
"description": "The default PrefetchCount that will be used by the underlying EventProcessorHost.",
"type": "integer"
}
},
"additionalProperties": false
},
"initialOffsetOptions": {
"type": "object",
"properties": {
"type": {
"description": "The location in the event stream from which to start processing when a checkpoint doesn't exist in storage.",
"type": "string",
"enum": ["fromStart", "fromEnd", "fromEnqueuedTime"],
"default": "fromStart"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"maxBatchSize": {
"description": "The maximum event count received per receive loop.",
"type": "integer",
"default": 64
},
"prefetchCount": {
"description": "The default prefetch that will be used by the underlying EventProcessorHost.",
"type": "integer",
"default": 255
},
"batchCheckpointFrequency": {
"description": "The number of event batches to process before creating an EventHub cursor checkpoint.",
"type": "integer",
"default": 1
}
},
"additionalProperties": false
}
]
},
"durableTask": {
"$ref": "#/definitions/durableTask-extension"
},
"cosmosDB": {
"$ref": "#/definitions/cosmosDB-extension-v2"
},
"blobs": {
"type": "object",
"properties": {
"maxDegreeOfParallelism": {
"description": "The number of concurrent invocations allowed for each blob-triggered function.",
"type": "integer",
"minimum": 1
},
"maxDequeueCount": {
"description": "The number of times to try processing a message before moving it to the poison queue.",
"type": "integer",
"minimum": 1,
"default": 5
}
},
"additionalProperties": false
}
}
},
"concurrency": {
"description": "Configuration settings for dynamic concurrency",
"type": "object",
"properties": {
"dynamicConcurrencyEnabled": {
"description": "Enables or disables dynamic concurrency for function apps.",
"type": "boolean",
"default": true
},
"snapshotPersistenceEnabled": {
"description": "Enables or disables the learned concurrency values persisting in storage.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"required": ["version"],
"examples": [
{
"version": "2.0",
"logging": {
"applicationInsights": {
"samplingSettings": {
"isEnabled": true,
"excludedTypes": "Request"
}
}
},
"extensionBundle": {
"id": "Microsoft.Azure.Functions.ExtensionBundle",
"version": "[2.*, 3.0.0)"
}
}
],
"additionalProperties": false
}
},
"id": "https://json.schemastore.org/host.json",
"oneOf": [
{
"$ref": "#/definitions/version-1"
},
{
"$ref": "#/definitions/version-2"
}
],
"title": "JSON schema for Azure Functions host.json files",
"type": "object"
}
|
size-limit.json | {
"$id": "https://json.schemastore.org/size-limit.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"default": [],
"items": {
"title": "Configuration Section",
"allOf": [
{
"type": "object",
"properties": {
"path": {
"oneOf": [
{
"title": "relative path to files",
"type": "string",
"pattern": "^/?([^/]+/)*[^/]+/?$",
"default": ""
},
{
"title": "relative paths to files",
"type": "array",
"items": {
"title": "Path or Glob Pattern",
"type": "string",
"pattern": "^/?([^/]+/)*[^/]+/?$",
"default": ""
},
"uniqueItems": true
}
]
},
"import": {
"title": "partial import to test tree-shaking",
"oneOf": [
{
"type": "string",
"default": ""
},
{
"type": "object",
"patternProperties": {
"^/?([^/]+/)*[^/]+/?$": {
"type": "string",
"default": ""
}
},
"additionalProperties": false,
"default": {}
}
],
"default": ""
},
"limit": {
"title": "size or time limit for files from the path option. It should be a string with a number and unit, separated by a space.",
"type": "string",
"pattern": "\\d+( ?(ms|s)|\\s*(B|kB|[MGTPEZY]i?B|KiB))",
"default": ""
},
"name": {
"title": "the name of the current section. It will only be useful if you have multiple sections.",
"type": "string",
"default": ""
},
"entry": {
"title": "when using a custom webpack config, a webpack entry could be given. It could be a string or an array of strings. By default, the total size of all entry points will be checked.",
"oneOf": [
{
"type": "string",
"default": ""
},
{
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"default": []
}
],
"default": ""
},
"webpack": {
"title": "with false it will disable webpack.",
"type": "boolean",
"default": false
},
"running": {
"title": "with false it will disable calculating running time.",
"type": "boolean",
"default": true
},
"gzip": {
"title": "with false it will disable gzip compression.",
"type": "boolean",
"default": true
},
"brotli": {
"title": "with true it will use brotli compression and disable gzip compression.",
"type": "boolean",
"default": false
},
"ignore": {
"type": "array",
"items": {
"title": "an array of files and dependencies to exclude from the project size calculation.",
"type": "string",
"pattern": "^/?([^/]+/)*[^/]+/?$"
},
"uniqueItems": true,
"default": []
}
},
"required": ["path"],
"default": {}
},
{
"if": {
"not": {
"properties": {
"webpack": {
"type": "boolean",
"enum": [false]
}
}
}
},
"then": {
"properties": {
"config": {
"title": "a path to a custom webpack config.",
"type": "string",
"pattern": "^/?([^/]+/)*[^/]+/?$",
"default": "webpack.config.js"
}
}
}
}
]
},
"title": "JSON Schema for configuration for size-limit",
"type": "array",
"uniqueItems": true
}
|
cryproj.54.schema.json | {
"$comment": "JSON Schema for CRYENGINE 5.4",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"cvars": {
"$id": "/definitions/cvars",
"type": "string",
"title": "Variable name",
"description": "CVar name",
"default": "sys_target_platforms",
"enum": [
"a_poseAlignerDebugDraw",
"a_poseAlignerEnable",
"a_poseAlignerForceLock",
"a_poseAlignerForceNoIntersections",
"a_poseAlignerForceNoRootOffset",
"a_poseAlignerForceTargetSmoothing",
"a_poseAlignerForceWeightOne",
"ac_ColliderModeAI",
"ac_ColliderModePlayer",
"ac_debugAnimEffects",
"ac_debugAnimTarget",
"ac_debugColliderMode",
"ac_debugEntityParams",
"ac_DebugFilter",
"ac_debugLocations",
"ac_debugLocationsGraphs",
"ac_debugMotionParams",
"ac_debugMovementControlMethods",
"ac_debugText",
"ac_debugXXXValues",
"ac_disableSlidingContactEvents",
"ac_enableExtraSolidCollider",
"ac_entityAnimClamp",
"ac_forceSimpleMovement",
"ac_frametime",
"ac_movementControlMethodFilter",
"ac_movementControlMethodHor",
"ac_movementControlMethodVer",
"ac_templateMCMs",
"ac_useMovementPrediction",
"ac_useQueuedRotation",
"ag_debugExactPos",
"ag_defaultAIStance",
"ag_travelSpeedSmoothing",
"ag_turnAngleSmoothing",
"ag_turnSpeedParamScale",
"ag_turnSpeedSmoothing",
"ai_AdjustPathsAroundDynamicObstacles",
"ai_AgentStatsDist",
"ai_AllowedToHit",
"ai_AllowedToHitPlayer",
"ai_AllTime",
"ai_AmbientFireEnable",
"ai_AmbientFireQuota",
"ai_AmbientFireUpdateInterval",
"ai_AttemptStraightPath",
"ai_BannedNavSoTime",
"ai_BeautifyPath",
"ai_BubblesSystem",
"ai_BubblesSystemAlertnessFilter",
"ai_BubblesSystemAllowPrototypeDialogBubbles",
"ai_BubblesSystemDecayTime",
"ai_BubblesSystemFontSize",
"ai_BubblesSystemNameFilter",
"ai_BubblesSystemUseDepthTest",
"ai_BurstWhileMovingDestinationRange",
"ai_CheckWalkabilityOptimalSectionLength",
"ai_CodeCoverageMode",
"ai_CollisionAvoidanceAgentExtraFat",
"ai_CollisionAvoidanceAgentTimeHorizon",
"ai_CollisionAvoidanceClampVelocitiesWithNavigationMesh",
"ai_CollisionAvoidanceEnableRadiusIncrement",
"ai_CollisionAvoidanceMinSpeed",
"ai_CollisionAvoidanceObstacleTimeHorizon",
"ai_CollisionAvoidancePathEndCutoffRange",
"ai_CollisionAvoidanceRadiusIncrementDecreaseRate",
"ai_CollisionAvoidanceRadiusIncrementIncreaseRate",
"ai_CollisionAvoidanceRange",
"ai_CollisionAvoidanceSmartObjectCutoffRange",
"ai_CollisionAvoidanceTargetCutoffRange",
"ai_CollisionAvoidanceTimestep",
"ai_CollisionAvoidanceUpdateVelocities",
"ai_CommunicationForceTestVoicePack",
"ai_CommunicationManagerHeighThresholdForTargetPosition",
"ai_CompatibilityMode",
"ai_CoolMissesBoxHeight",
"ai_CoolMissesBoxSize",
"ai_CoolMissesCooldown",
"ai_CoolMissesMaxLightweightEntityMass",
"ai_CoolMissesMinMissDistance",
"ai_CoolMissesProbability",
"ai_CoverExactPositioning",
"ai_CoverMaxEyeCount",
"ai_CoverPredictTarget",
"ai_CoverSpacing",
"ai_CoverSystem",
"ai_CrouchVisibleRange",
"ai_CrowdControlInPathfind",
"ai_DebugCheckWalkability",
"ai_DebugCheckWalkabilityRadius",
"ai_DebugCollisionAvoidanceForceSpeed",
"ai_DebugDraw",
"ai_DebugDrawAdaptiveUrgency",
"ai_DebugDrawAmbientFire",
"ai_DebugDrawArrowLabelsVisibilityDistance",
"ai_DebugDrawAStarOpenList",
"ai_DebugDrawAStarOpenListTime",
"ai_DebugDrawBannedNavsos",
"ai_DebugDrawCollisionAvoidance",
"ai_DebugDrawCollisionAvoidanceAgentName",
"ai_DebugDrawCommunication",
"ai_DebugDrawCommunicationHistoryDepth",
"ai_DebugDrawCoolMisses",
"ai_DebugDrawCover",
"ai_DebugDrawCoverLocations",
"ai_DebugDrawCoverOccupancy",
"ai_DebugDrawCoverPlanes",
"ai_DebugDrawCoverSampler",
"ai_DebugDrawCrowdControl",
"ai_DebugDrawDamageControl",
"ai_DebugDrawDamageParts",
"ai_DebugDrawDynamicCoverSampler",
"ai_DebugDrawDynamicHideObjectsRange",
"ai_DebugDrawEnabledActors",
"ai_DebugDrawEnabledPlayers",
"ai_DebugDrawExpensiveAccessoryQuota",
"ai_DebugDrawFireCommand",
"ai_DebugDrawFlight2",
"ai_DebugDrawGroups",
"ai_DebugDrawHidespotRange",
"ai_DebugDrawHideSpotSearchRays",
"ai_DebugDrawLightLevel",
"ai_DebugDrawNavigation",
"ai_DebugDrawNavigationWorldMonitor",
"ai_DebugDrawPhysicsAccess",
"ai_DebugDrawPlayerActions",
"ai_DebugDrawReinforcements",
"ai_DebugDrawStanceSize",
"ai_DebugDrawVegetationCollisionDist",
"ai_DebugDrawVisionMap",
"ai_DebugDrawVisionMapObservables",
"ai_DebugDrawVisionMapObservers",
"ai_DebugDrawVisionMapObserversFOV",
"ai_DebugDrawVisionMapStats",
"ai_DebugDrawVisionMapVisibilityChecks",
"ai_DebugDrawVolumeVoxels",
"ai_DebugGlobalPerceptionScale",
"ai_DebugHideSpotName",
"ai_DebugInterestSystem",
"ai_DebugMovementSystem",
"ai_DebugMovementSystemActorRequests",
"ai_DebugPathfinding",
"ai_DebugPerceptionManager",
"ai_DebugRangeSignaling",
"ai_DebugSignalTimers",
"ai_DebugTacticalPoints",
"ai_DebugTacticalPointsBlocked",
"ai_DebugTargetSilhouette",
"ai_DebugTargetTracksAgent",
"ai_DebugTargetTracksConfig",
"ai_DebugTargetTracksConfig_Filter",
"ai_DebugTargetTracksTarget",
"ai_DebugTimestamps",
"ai_DebugWalkabilityCache",
"ai_DrawAgentFOV",
"ai_DrawAgentStats",
"ai_DrawAgentStatsGroupFilter",
"ai_DrawAreas",
"ai_DrawAttentionTargetPositions",
"ai_DrawBadAnchors",
"ai_DrawBulletEvents",
"ai_DrawCollisionEvents",
"ai_DrawDistanceLUT",
"ai_DrawExplosions",
"ai_DrawFakeDamageInd",
"ai_DrawFakeHitEffects",
"ai_DrawFakeTracers",
"ai_DrawFireEffectDecayRange",
"ai_DrawFireEffectEnabled",
"ai_DrawFireEffectMaxAngle",
"ai_DrawFireEffectMinDistance",
"ai_DrawFireEffectMinTargetFOV",
"ai_DrawFireEffectTimeScale",
"ai_DrawFormations",
"ai_DrawGetEnclosingFailures",
"ai_DrawGoals",
"ai_DrawGrenadeEvents",
"ai_DrawGroupTactic",
"ai_DrawHidespots",
"ai_DrawModifiers",
"ai_DrawModularBehaviorTreeStatistics",
"ai_DrawNode",
"ai_DrawNodeLinkCutoff",
"ai_DrawNodeLinkType",
"ai_DrawOffset",
"ai_DrawPath",
"ai_DrawPathAdjustment",
"ai_DrawPathFollower",
"ai_DrawPerceptionDebugging",
"ai_DrawPerceptionHandlerModifiers",
"ai_DrawPerceptionIndicators",
"ai_DrawPerceptionModifiers",
"ai_DrawPlayerRanges",
"ai_DrawProbableTarget",
"ai_DrawRadar",
"ai_DrawRadarDist",
"ai_DrawReadibilities",
"ai_DrawRefPoints",
"ai_DrawSelectedTargets",
"ai_DrawShooting",
"ai_DrawSmartObjects",
"ai_DrawSoundEvents",
"ai_DrawStats",
"ai_DrawTargets",
"ai_DrawTrajectory",
"ai_DrawType",
"ai_DrawUpdate",
"ai_DynamicHidespotsEnabled",
"ai_EnableCoolMisses",
"ai_EnableORCA",
"ai_EnablePerceptionStanceVisibleRange",
"ai_EnableWarningsErrors",
"ai_EnableWaterOcclusion",
"ai_ExtraForbiddenRadiusDuringBeautification",
"ai_ExtraRadiusDuringBeautification",
"ai_ExtraVehicleAvoidanceRadiusBig",
"ai_ExtraVehicleAvoidanceRadiusSmall",
"ai_FilterAgentName",
"ai_FlowNodeAlertnessCheck",
"ai_ForceAGAction",
"ai_ForceAGSignal",
"ai_ForceAllowStrafing",
"ai_ForceLookAimTarget",
"ai_ForcePosture",
"ai_ForceSerializeAllObjects",
"ai_ForceStance",
"ai_IgnoreBulletRainStimulus",
"ai_IgnorePlayer",
"ai_IgnoreSoundStimulus",
"ai_IgnoreVisibilityChecks",
"ai_IgnoreVisualStimulus",
"ai_InterestSystem",
"ai_InterestSystemCastRays",
"ai_IntersectionTesterQuota",
"ai_IslandConnectionsSystemProfileMemory",
"ai_LobThrowMinAllowedDistanceFromFriends",
"ai_LobThrowPercentageOfDistanceToTargetUsedForInaccuracySimulation",
"ai_LobThrowTimePredictionForFriendPositions",
"ai_LobThrowUseRandomForInaccuracySimulation",
"ai_Locate",
"ai_LogConsoleVerbosity",
"ai_LogFileVerbosity",
"ai_LogModularBehaviorTreeExecutionStacks",
"ai_LogSignals",
"ai_MinActorDynamicObstacleAvoidanceRadius",
"ai_MNMAllowDynamicRegenInEditor",
"ai_MNMDebugAccessibility",
"ai_MNMEditorBackgroundUpdate",
"ai_MNMPathfinderConcurrentRequests",
"ai_MNMPathFinderDebug",
"ai_MNMPathfinderMT",
"ai_MNMPathfinderPositionInTrianglePredictionType",
"ai_MNMPathFinderQuota",
"ai_MNMProfileMemory",
"ai_MNMRaycastImplementation",
"ai_ModularBehaviorTree",
"ai_MovementSystemPathReplanningEnabled",
"ai_NavGenThreadJobs",
"ai_NavigationSystemMT",
"ai_NavmeshStabilizationTimeToUpdate",
"ai_NavmeshTileDistanceDraw",
"ai_NetworkDebug",
"ai_NoUpdate",
"ai_ObstacleSizeThreshold",
"ai_OutputPersonalLogToConsole",
"ai_OverlayMessageDuration",
"ai_PathfinderAvoidanceCostForGroupMates",
"ai_PathfinderDangerCostForAttentionTarget",
"ai_PathfinderDangerCostForExplosives",
"ai_PathfinderExplosiveDangerMaxThreatDistance",
"ai_PathfinderExplosiveDangerRadius",
"ai_PathfinderGroupMatesAvoidanceRadius",
"ai_PathfinderUpdateTime",
"ai_PathfindTimeLimit",
"ai_PathStringPullingIterations",
"ai_PlayerAffectedByLight",
"ai_PredictivePathFollowing",
"ai_ProfileGoals",
"ai_ProneVisibleRange",
"ai_RayCasterQuota",
"ai_RecordCommunicationStats",
"ai_Recorder",
"ai_Recorder_Auto",
"ai_Recorder_Buffer",
"ai_RecordLog",
"ai_RODAliveTime",
"ai_RODAmbientFireInc",
"ai_RODCombatRangeMod",
"ai_RODCoverFireTimeMod",
"ai_RODDirInc",
"ai_RODFakeHitChance",
"ai_RODKillRangeMod",
"ai_RODKillZoneInc",
"ai_RODLowHealthMercyTime",
"ai_RODMoveInc",
"ai_RODReactionDarkIllumInc",
"ai_RODReactionDirInc",
"ai_RODReactionDistInc",
"ai_RODReactionLeanInc",
"ai_RODReactionMediumIllumInc",
"ai_RODReactionSuperDarkIllumInc",
"ai_RODReactionTime",
"ai_RODStanceInc",
"ai_ShowBehaviorCalls",
"ai_SightRangeDarkIllumMod",
"ai_SightRangeMediumIllumMod",
"ai_SightRangeSuperDarkIllumMod",
"ai_SimpleWayptPassability",
"ai_SmartPathFollower_decelerationHuman",
"ai_SmartPathFollower_decelerationVehicle",
"ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathRunAndSprint",
"ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathWalk",
"ai_SmartPathFollower_useAdvancedPathShortcutting",
"ai_SmartPathFollower_useAdvancedPathShortcutting_debug",
"ai_SOMSpeedCombat",
"ai_SOMSpeedRelaxed",
"ai_SoundPerception",
"ai_StatsDisplayMode",
"ai_StatsTarget",
"ai_SteepSlopeAcrossValue",
"ai_SteepSlopeUpValue",
"ai_SystemUpdate",
"ai_TacticalPointsDebugDrawMode",
"ai_TacticalPointsDebugFadeMode",
"ai_TacticalPointsDebugScaling",
"ai_TacticalPointsDebugTime",
"ai_TacticalPointsWarnings",
"ai_TacticalPointUpdateTime",
"ai_TargetTracking",
"ai_TargetTracks_GlobalTargetLimit",
"ai_UpdateAllAlways",
"ai_UpdateInterval",
"ai_UpdateProxy",
"ai_UseCalculationStopperCounter",
"ai_UseSimplePathfindingHeuristic",
"ai_UseSmartPathFollower",
"ai_UseSmartPathFollower_AABB_based",
"ai_UseSmartPathFollower_LookAheadDistance",
"ai_VisionMapNumberOfPVSUpdatesPerFrame",
"ai_VisionMapNumberOfVisibilityUpdatesPerFrame",
"ai_WaterOcclusion",
"ban_timeout",
"br_breakmaxworldsize",
"br_breakworldoffsetx",
"br_breakworldoffsety",
"c_shakeMult",
"ca_AllowMultipleEffectsOfSameName",
"ca_AnimWarningLevel",
"ca_ApplyJointVelocitiesMode",
"ca_AttachmentCullingRation",
"ca_AttachmentCullingRationMP",
"ca_AttachmentMergingMemoryBudget",
"ca_AttachmentTextureMemoryBudget",
"ca_CharEditModel",
"ca_cloth_air_resistance",
"ca_cloth_damping",
"ca_cloth_friction",
"ca_cloth_max_safe_step",
"ca_cloth_max_timestep",
"ca_cloth_stiffness",
"ca_cloth_stiffness_norm",
"ca_cloth_stiffness_tang",
"ca_cloth_thickness",
"ca_cloth_vars_reset",
"ca_ClothBlending",
"ca_ClothBypassSimulation",
"ca_ClothMaxChars",
"ca_DBAUnloadRemoveTime",
"ca_DBAUnloadUnregisterTime",
"ca_DeathBlendTime",
"ca_DebugADIKTargets",
"ca_DebugAnimationStreaming",
"ca_DebugAnimMemTracking",
"ca_DebugAnimUpdates",
"ca_DebugAnimUsage",
"ca_DebugAnimUsageOnFileAccess",
"ca_DebugCommandBuffer",
"ca_DebugCriticalErrors",
"ca_DebugFacial",
"ca_DebugFacialEyes",
"ca_DebugModelCache",
"ca_DebugSegmentation",
"ca_DebugSkeletonEffects",
"ca_DebugSWSkinning",
"ca_DecalSizeMultiplier",
"ca_disable_thread",
"ca_DisableAnimationUnloading",
"ca_DisableAuxPhysics",
"ca_DrawAimIKVEGrid",
"ca_DrawAimPoses",
"ca_DrawAllSimulatedSockets",
"ca_DrawAttachmentOBB",
"ca_DrawAttachmentProjection",
"ca_DrawAttachments",
"ca_DrawAttachmentsMergedForShadows",
"ca_DrawBaseMesh",
"ca_DrawBBox",
"ca_DrawBinormals",
"ca_DrawCC",
"ca_DrawCGA",
"ca_DrawCHR",
"ca_DrawCloth",
"ca_DrawDecalsBBoxes",
"ca_DrawEmptyAttachments",
"ca_DrawLocator",
"ca_DrawLookIK",
"ca_DrawNormals",
"ca_DrawPose",
"ca_DrawPositionPost",
"ca_DrawSkeleton",
"ca_DrawTangents",
"ca_DrawVEGInfo",
"ca_DrawWireframe",
"ca_DumpUsedAnims",
"ca_eyes_procedural",
"ca_FacialAnimationRadius",
"ca_FilterJoints",
"ca_ForceUpdateSkeletons",
"ca_KeepModels",
"ca_lipsync_debug",
"ca_lipsync_phoneme_crossfade",
"ca_lipsync_phoneme_offset",
"ca_lipsync_phoneme_strength",
"ca_lipsync_vertex_drag",
"ca_LoadUncompressedChunks",
"ca_LockFeetWithIK",
"ca_MemoryDefragEnabled",
"ca_MemoryDefragPoolSize",
"ca_MemoryUsageLog",
"ca_MinInPlaceCAFStreamSize",
"ca_MotionBlurMovementThreshold",
"ca_NoAnim",
"ca_ParametricPoolSize",
"ca_physicsProcessImpact",
"ca_PrecacheAnimationSets",
"ca_PreloadAllCAFs",
"ca_ReloadAllCHRPARAMS",
"ca_SampleQuatHemisphereFromCurrentPose",
"ca_SaveAABB",
"ca_SerializeSkeletonAnim",
"ca_SnapToVGrid",
"ca_StoreAnimNamesOnLoad",
"ca_StreamCHR",
"ca_StreamDBAInPlace",
"ca_thread",
"ca_thread0Affinity",
"ca_thread1Affinity",
"ca_UnloadAnimationCAF",
"ca_UnloadAnimationDBA",
"ca_useADIKTargets",
"ca_UseAimIK",
"ca_UseAssetDefinedLod",
"ca_UseDecals",
"ca_UseFacialAnimation",
"ca_UseIMG_AIM",
"ca_UseIMG_CAF",
"ca_UseJointMasking",
"ca_UseLookIK",
"ca_UseMorph",
"ca_UsePhysics",
"ca_UseRecoil",
"ca_UseScaling",
"ca_vaBlendCullingDebug",
"ca_vaBlendCullingThreshold",
"ca_vaBlendEnable",
"ca_vaBlendPostSkinning",
"ca_vaEnable",
"ca_Validate",
"ca_vaProfile",
"ca_vaScaleFactor",
"ca_vaSkipVertexAnimationLOD",
"ca_vaUpdateTangents",
"capture_file_format",
"capture_file_name",
"capture_file_prefix",
"capture_folder",
"capture_frame_once",
"capture_frames",
"cl_AISystem",
"cl_bandwidth",
"cl_camera_noise",
"cl_camera_noise_freq",
"cl_comment",
"cl_DefaultNearPlane",
"cl_DisableHUDText",
"cl_ETColorOverrideB",
"cl_ETColorOverrideEnable",
"cl_ETColorOverrideG",
"cl_ETColorOverrideR",
"cl_ETFontSizeMultiplier",
"cl_ETHideAIDebug",
"cl_ETHideAll",
"cl_ETHideBehaviour",
"cl_ETHideFlowgraph",
"cl_ETHideReadability",
"cl_ETHideScriptBind",
"cl_ETLog",
"cl_ETMaxDisplayDistance",
"cl_nickname",
"cl_packetRate",
"cl_serveraddr",
"cl_serverpassword",
"cl_serverport",
"cl_tokenid",
"cl_useCurrentUserNameAsDefault",
"cl_ViewApplyHmdOffset",
"cl_ViewSystemDebug",
"cl_voice_recording",
"cl_voice_volume",
"co_coopAnimDebug",
"co_slideWhileStreaming",
"co_usenewcoopanimsystem",
"con_debug",
"con_display_last_messages",
"con_line_buffer_size",
"con_restricted",
"con_showonload",
"connect_repeatedly_num_attempts",
"connect_repeatedly_time_between_attempts",
"cvDoVerboseWindowTitle",
"d3d11_CBUpdateStats",
"d3d11_debugBreakOnce",
"d3d11_debugBreakOnMsgID",
"d3d11_debugMuteMsgID",
"d3d11_debugMuteSeverity",
"d3d11_forcedFeatureLevel",
"d3d11_preventDriverThreading",
"demo_ai",
"demo_file",
"demo_finish_cmd",
"demo_finish_memreplay_sizer",
"demo_finish_memreplay_stop",
"demo_fixed_timestep",
"demo_game_state",
"demo_max_frames",
"demo_noinfo",
"demo_num_orientations",
"demo_num_runs",
"demo_panoramic",
"demo_profile",
"demo_quit",
"demo_restart_level",
"demo_save_every_frame",
"demo_savestats",
"demo_screenshot_frame",
"demo_scroll_pause",
"demo_time_of_day",
"demo_use_hmd_rotation",
"demo_vtune",
"dlc_directory",
"doc_use_subfolder_for_crash_backup",
"doc_validate_surface_types",
"drs_dataPath",
"drs_dialogAudio",
"drs_dialogBinaryFileFormat",
"drs_dialogEntityRtpcName",
"drs_dialogGlobalRtpcName",
"drs_dialogsDefaultMaxQueueTime",
"drs_dialogsDefaultPauseAfterLines",
"drs_dialogsDefaultTalkAnimation",
"drs_dialogsLipsyncAnimationLayer",
"drs_dialogsLipsyncTransitionTime",
"drs_dialogsSamePriorityCancels",
"drs_dialogSubtitles",
"drs_fileFormat",
"drs_loggingOptions",
"ds_AutoReloadScripts",
"ds_LevelNameOverride",
"ds_LoadExcelScripts",
"ds_LoadSoundsSync",
"ds_LogLevel",
"ds_PrecacheSounds",
"ds_WarnOnMissingLoc",
"e_3dEngineLogAlways",
"e_3dEngineTempPoolSize",
"e_AutoPrecacheCameraJumpDist",
"e_AutoPrecacheCgf",
"e_AutoPrecacheTerrainAndProcVeget",
"e_AutoPrecacheTexturesAndShaders",
"e_BBoxes",
"e_Brushes",
"e_BrushUseTerrainColor",
"e_CacheNearestCubePicking",
"e_CameraFreeze",
"e_CameraGoto",
"e_CameraRotationSpeed",
"e_CGFMaxFileSize",
"e_CharLodMin",
"e_CheckOcclusion",
"e_CheckOcclusionOutputQueueSize",
"e_CheckOcclusionQueueSize",
"e_CheckOctreeObjectsBoxSize",
"e_Clouds",
"e_CoverageBuffer",
"e_CoverageBufferAABBExpand",
"e_CoverageBufferBias",
"e_CoverageBufferCullIndividualBrushesMaxNodeSize",
"e_CoverageBufferDebug",
"e_CoverageBufferDebugFreeze",
"e_CoverageBufferDrawOccluders",
"e_CoverageBufferEarlyOut",
"e_CoverageBufferEarlyOutDelay",
"e_CoverageBufferOccludersViewDistRatio",
"e_CoverageBufferRastPolyLimit",
"e_CoverageBufferReproj",
"e_CoverageBufferShowOccluder",
"e_CoverageBufferTerrain",
"e_CoverageBufferTerrainExpand",
"e_CoverCgfDebug",
"e_CullVegActivation",
"e_DebugDraw",
"e_DebugDrawFilter",
"e_DebugDrawListBBoxIndex",
"e_DebugDrawListFilter",
"e_DebugDrawListSize",
"e_DebugDrawShowOnlyCompound",
"e_DebugDrawShowOnlyLod",
"e_DebugGeomPrep",
"e_DebugLights",
"e_Decals",
"e_DecalsAllowGameDecals",
"e_DecalsClip",
"e_DecalsDeferredDynamic",
"e_DecalsDeferredDynamicDepthScale",
"e_DecalsDeferredDynamicMinSize",
"e_DecalsDeferredStatic",
"e_DecalsForceDeferred",
"e_DecalsHitCache",
"e_DecalsLifeTimeScale",
"e_DecalsMaxTrisInObject",
"e_DecalsMaxUpdatesPerFrame",
"e_DecalsMaxValidFrames",
"e_DecalsMerge",
"e_DecalsNeighborMaxLifeTime",
"e_DecalsOverlapping",
"e_DecalsPlacementTestAreaSize",
"e_DecalsPlacementTestMinDepth",
"e_DecalsPreCreate",
"e_DecalsRange",
"e_DecalsScissor",
"e_DefaultMaterial",
"e_DeferredPhysicsEvents",
"e_DeformableObjects",
"e_DisplayMemoryUsageIcon",
"e_DynamicDistanceShadows",
"e_DynamicLights",
"e_DynamicLightsConsistentSortOrder",
"e_DynamicLightsForceDeferred",
"e_DynamicLightsFrameIdVisTest",
"e_DynamicLightsMaxCount",
"e_DynamicLightsMaxEntityLights",
"e_Entities",
"e_EntitySuppressionLevel",
"e_Fog",
"e_FogVolumes",
"e_FoliageBranchesDamping",
"e_FoliageBranchesStiffness",
"e_FoliageBranchesTimeout",
"e_FoliageBrokenBranchesDamping",
"e_FoliageStiffness",
"e_FoliageWindActivationDist",
"e_ForceDetailLevelForScreenRes",
"e_GeomCacheBufferSize",
"e_GeomCacheDebug",
"e_GeomCacheDebugDrawMode",
"e_GeomCacheDebugFilter",
"e_GeomCacheDecodeAheadTime",
"e_GeomCacheLerpBetweenFrames",
"e_GeomCacheMaxBufferAheadTime",
"e_GeomCacheMaxPlaybackFromMemorySize",
"e_GeomCacheMinBufferAheadTime",
"e_GeomCachePreferredDiskRequestSize",
"e_GeomCaches",
"e_GI",
"e_GsmCastFromTerrain",
"e_GsmDepthBoundsDebug",
"e_GsmLodsNum",
"e_GsmRange",
"e_GsmRangeStep",
"e_GsmStats",
"e_HwOcclusionCullingWater",
"e_JointStrengthScale",
"e_levelStartupFrameDelay",
"e_levelStartupFrameNum",
"e_LightVolumes",
"e_LightVolumesDebug",
"e_LodCompMaxSize",
"e_LodFaceArea",
"e_LodFaceAreaTargetSize",
"e_LodMax",
"e_LodMin",
"e_LodMinTtris",
"e_LodRatio",
"e_Lods",
"e_LodsForceUse",
"e_LodTransitionSpriteDistRatio",
"e_LodTransitionSpriteMinDist",
"e_LodTransitionTime",
"e_MaxDrawCalls",
"e_MaxViewDistance",
"e_MaxViewDistFullDistCamHeight",
"e_MaxViewDistSpecLerp",
"e_MergedMeshes",
"e_MergedMeshesActiveDist",
"e_MergedMeshesBulletLifetime",
"e_MergedMeshesBulletScale",
"e_MergedMeshesBulletSpeedFactor",
"e_MergedMeshesClusterVisualization",
"e_MergedMeshesClusterVisualizationDimension",
"e_MergedMeshesDebug",
"e_MergedMeshesDeformViewDistMod",
"e_MergedMeshesInstanceDist",
"e_MergedMeshesLodRatio",
"e_MergedMeshesMaxTriangles",
"e_MergedMeshesOutdoorOnly",
"e_MergedMeshesPool",
"e_MergedMeshesPoolSpines",
"e_MergedMeshesTesselationSupport",
"e_MergedMeshesUseSpines",
"e_MergedMeshesViewDistRatio",
"e_ObjectLayersActivation",
"e_ObjectLayersActivationPhysics",
"e_Objects",
"e_ObjectsTreeBBoxes",
"e_ObjectsTreeNodeMinSize",
"e_ObjectsTreeNodeSizeRatio",
"e_ObjFastRegister",
"e_ObjQuality",
"e_ObjShadowCastSpec",
"e_ObjStats",
"e_OcclusionCullingViewDistRatio",
"e_OcclusionLazyHideFrames",
"e_OcclusionVolumes",
"e_OcclusionVolumesViewDistRatio",
"e_OnDemandMaxSize",
"e_OnDemandPhysics",
"e_Particles",
"e_ParticlesAllowRuntimeLoad",
"e_ParticlesAnimBlend",
"e_ParticlesAudio",
"e_ParticlesConvertPfx1",
"e_ParticlesCullAgainstOcclusionBuffer",
"e_ParticlesCullAgainstViewFrustum",
"e_ParticlesDebug",
"e_ParticlesDumpMemoryAfterMapLoad",
"e_ParticlesForceSeed",
"e_ParticlesGI",
"e_ParticleShadowsNumGSMs",
"e_ParticlesIndexPoolSize",
"e_ParticlesLightMinColorThreshold",
"e_ParticlesLightMinRadiusThreshold",
"e_ParticlesLights",
"e_ParticlesLightsViewDistRatio",
"e_ParticlesLod",
"e_ParticlesMaxDrawScreen",
"e_ParticlesMaxScreenFill",
"e_ParticlesMinDrawAlpha",
"e_ParticlesMinDrawPixels",
"e_ParticlesMinPhysicsDynamicBounds",
"e_ParticlesMotionBlur",
"e_ParticlesObjectCollisions",
"e_ParticlesPoolSize",
"e_ParticlesPreload",
"e_ParticlesProfile",
"e_ParticlesProfiler",
"e_ParticlesProfilerCountBudget",
"e_ParticlesProfilerOutputFolder",
"e_ParticlesProfilerOutputName",
"e_ParticlesProfilerTimingBudget",
"e_ParticlesQuality",
"e_ParticlesSerializeNamedFields",
"e_ParticlesShadows",
"e_ParticlesSoftIntersect",
"e_ParticlesSortQuality",
"e_ParticlesThread",
"e_ParticlesUseLevelSpecificLibs",
"e_ParticlesVertexPoolSize",
"e_PermanentRenderObjects",
"e_PhysFoliage",
"e_PhysMinCellSize",
"e_PhysOceanCell",
"e_PhysProxyTriLimit",
"e_Portals",
"e_PortalsBigEntitiesFix",
"e_PortalsBlend",
"e_PortalsMaxRecursion",
"e_PrecacheLevel",
"e_PreloadDecals",
"e_PreloadMaterials",
"e_PrepareDeformableObjectsAtLoadTime",
"e_ProcVegetation",
"e_ProcVegetationMaxCacheLevels",
"e_ProcVegetationMaxChunksInCache",
"e_ProcVegetationMaxObjectsInChunk",
"e_ProcVegetationMaxSectorsInCache",
"e_ProcVegetationMaxViewDistance",
"e_Recursion",
"e_RecursionViewDistRatio",
"e_Render",
"e_RenderMeshCollisionTolerance",
"e_RenderMeshUpdateAsync",
"e_RNTmpDataPoolMaxFrames",
"e_Roads",
"e_Ropes",
"e_ScissorDebug",
"e_ScreenShot",
"e_ScreenShotDebug",
"e_ScreenShotFileFormat",
"e_ScreenShotHeight",
"e_ScreenShotMapCamHeight",
"e_ScreenShotMapCenterX",
"e_ScreenShotMapCenterY",
"e_ScreenShotMapOrientation",
"e_ScreenShotMapSizeX",
"e_ScreenShotMapSizeY",
"e_ScreenShotMinSlices",
"e_ScreenShotQuality",
"e_ScreenShotWidth",
"e_Shadows",
"e_ShadowsAdaptScale",
"e_ShadowsBlendCascades",
"e_ShadowsBlendCascadesVal",
"e_ShadowsCacheObjectLod",
"e_ShadowsCacheRenderCharacters",
"e_ShadowsCacheUpdate",
"e_ShadowsCascadesCentered",
"e_ShadowsCascadesDebug",
"e_ShadowsCastViewDistRatio",
"e_ShadowsCastViewDistRatioLights",
"e_ShadowsClouds",
"e_ShadowsConstBias",
"e_ShadowsConstBiasHQ",
"e_ShadowsDebug",
"e_ShadowsFrustums",
"e_ShadowsLodBiasFixed",
"e_ShadowsLodBiasInvis",
"e_ShadowsMasksLimit",
"e_ShadowsMaxTexRes",
"e_ShadowsPerObject",
"e_ShadowsPerObjectResolutionScale",
"e_ShadowsPoolSize",
"e_ShadowsResScale",
"e_ShadowsSlopeBias",
"e_ShadowsSlopeBiasHQ",
"e_ShadowsTessellateCascades",
"e_ShadowsTessellateDLights",
"e_ShadowsUpdateViewDistRatio",
"e_SkyBox",
"e_SkyQuality",
"e_SkyType",
"e_SkyUpdateRate",
"e_Sleep",
"e_SQTestBegin",
"e_SQTestCount",
"e_SQTestDelay",
"e_SQTestDistance",
"e_SQTestExitOnFinish",
"e_SQTestMip",
"e_SQTestMoveSpeed",
"e_SQTestTextureName",
"e_StaticInstancing",
"e_StaticInstancingMinInstNum",
"e_StatObjBufferRenderTasks",
"e_StatObjMerge",
"e_StatObjMergeMaxTrisPerDrawCall",
"e_StatObjPreload",
"e_StatObjRenderFilter",
"e_StatObjRenderFilterMode",
"e_StatObjStoreMesh",
"e_StatObjTessellationMode",
"e_StatObjValidate",
"e_StatoscopeAllowFpsOverride",
"e_StatoscopeConnectTimeout",
"e_StatoscopeCreateLogFilePerLevel",
"e_StatoscopeDataGroups",
"e_StatoscopeDumpAll",
"e_StatoscopeEnabled",
"e_StatoscopeFilenameUseBuildInfo",
"e_StatoscopeFilenameUseDatagroups",
"e_StatoscopeFilenameUseMap",
"e_StatoscopeFilenameUseTag",
"e_StatoscopeFilenameUseTime",
"e_StatoscopeIvDataGroups",
"e_StatoscopeLogDestination",
"e_StatoscopeMaxNumFuncsPerFrame",
"e_StatoscopeMinFuncLengthMs",
"e_StatoscopeScreenCapWhenGPULimited",
"e_StatoscopeScreenshotCapturePeriod",
"e_StatoscopeWriteTimeout",
"e_StreamAutoMipFactorMax",
"e_StreamAutoMipFactorMaxDVD",
"e_StreamAutoMipFactorMin",
"e_StreamAutoMipFactorSpeedThreshold",
"e_StreamCgf",
"e_StreamCgfDebug",
"e_StreamCgfDebugFilter",
"e_StreamCgfDebugHeatMap",
"e_StreamCgfDebugMinObjSize",
"e_StreamCgfFastUpdateMaxDistance",
"e_StreamCgfGridUpdateDistance",
"e_StreamCgfMaxNewTasksPerUpdate",
"e_StreamCgfMaxTasksInProgress",
"e_StreamCgfPoolSize",
"e_StreamCgfUpdatePerNodeDistance",
"e_StreamCgfVisObjPriority",
"e_StreamInstances",
"e_StreamInstancesDistRatio",
"e_StreamInstancesMaxTasks",
"e_StreamPredictionAhead",
"e_StreamPredictionAheadDebug",
"e_StreamPredictionAlwaysIncludeOutside",
"e_StreamPredictionBoxRadius",
"e_StreamPredictionDistanceFar",
"e_StreamPredictionDistanceNear",
"e_StreamPredictionMaxVisAreaRecursion",
"e_StreamPredictionMinFarZoneDistance",
"e_StreamPredictionMinReportDistance",
"e_StreamPredictionTexelDensity",
"e_StreamPredictionUpdateTimeSlice",
"e_StreamSaveStartupResultsIntoXML",
"e_Sun",
"e_SunAngleSnapDot",
"e_SunAngleSnapSec",
"e_svoDebug",
"e_svoDispatchX",
"e_svoDispatchY",
"e_svoDVR",
"e_svoDVR_DistRatio",
"e_svoEnabled",
"e_svoLoadTree",
"e_svoMaxAreaMeshSizeKB",
"e_svoMaxAreaSize",
"e_svoMaxBricksOnCPU",
"e_svoMaxBrickUpdates",
"e_svoMaxNodeSize",
"e_svoMaxStreamRequests",
"e_svoMinNodeSize",
"e_svoRender",
"e_svoRootSize",
"e_svoTI_Active",
"e_svoTI_AnalyticalGI",
"e_svoTI_AnalyticalOccluders",
"e_svoTI_AnalyticalOccludersRange",
"e_svoTI_AnalyticalOccludersSoftness",
"e_svoTI_Apply",
"e_svoTI_AsyncCompute",
"e_svoTI_ConeMaxLength",
"e_svoTI_ConstantAmbientDebug",
"e_svoTI_Diffuse_Cache",
"e_svoTI_Diffuse_Spr",
"e_svoTI_DiffuseAmplifier",
"e_svoTI_DiffuseBias",
"e_svoTI_DiffuseConeWidth",
"e_svoTI_DualTracing",
"e_svoTI_DynLights",
"e_svoTI_EmissiveMultiplier",
"e_svoTI_ForceGIForAllLights",
"e_svoTI_GsmCascadeLod",
"e_svoTI_HalfresKernelPrimary",
"e_svoTI_HalfresKernelSecondary",
"e_svoTI_HighGlossOcclusion",
"e_svoTI_InjectionMultiplier",
"e_svoTI_IntegrationMode",
"e_svoTI_LowSpecMode",
"e_svoTI_MinReflectance",
"e_svoTI_MinVoxelOpacity",
"e_svoTI_NumberOfBounces",
"e_svoTI_ObjectsLod",
"e_svoTI_ObjectsMaxViewDistance",
"e_svoTI_PointLightsMultiplier",
"e_svoTI_PortalsDeform",
"e_svoTI_PortalsInject",
"e_svoTI_PropagationBooster",
"e_svoTI_Reflect_Vox_Max",
"e_svoTI_Reflect_Vox_Max_Overhead",
"e_svoTI_Reflect_Vox_MaxEdit",
"e_svoTI_ResScaleAir",
"e_svoTI_ResScaleBase",
"e_svoTI_RsmConeMaxLength",
"e_svoTI_RsmUseColors",
"e_svoTI_RT_MaxDist",
"e_svoTI_Saturation",
"e_svoTI_Shadow_Sev",
"e_svoTI_SkipNonGILights",
"e_svoTI_SkyColorMultiplier",
"e_svoTI_SkyLightBottomMultiplier",
"e_svoTI_Specular_FromDiff",
"e_svoTI_Specular_Reproj",
"e_svoTI_Specular_Sev",
"e_svoTI_SpecularAmplifier",
"e_svoTI_SSAOAmount",
"e_svoTI_SSDepthTrace",
"e_svoTI_SunRSMInject",
"e_svoTI_TemporalFilteringBase",
"e_svoTI_ThreadAffinity0",
"e_svoTI_ThreadAffinity1",
"e_svoTI_TraceVoxels",
"e_svoTI_TranslucentBrightness",
"e_svoTI_Troposphere_Active",
"e_svoTI_Troposphere_Brightness",
"e_svoTI_Troposphere_CloudGen_Freq",
"e_svoTI_Troposphere_CloudGen_FreqStep",
"e_svoTI_Troposphere_CloudGen_Height",
"e_svoTI_Troposphere_CloudGen_Scale",
"e_svoTI_Troposphere_CloudGenTurb_Freq",
"e_svoTI_Troposphere_CloudGenTurb_Scale",
"e_svoTI_Troposphere_Density",
"e_svoTI_Troposphere_Ground_Height",
"e_svoTI_Troposphere_Layer0_Dens",
"e_svoTI_Troposphere_Layer0_Height",
"e_svoTI_Troposphere_Layer0_Rand",
"e_svoTI_Troposphere_Layer1_Dens",
"e_svoTI_Troposphere_Layer1_Height",
"e_svoTI_Troposphere_Layer1_Rand",
"e_svoTI_Troposphere_Snow_Height",
"e_svoTI_Troposphere_Subdivide",
"e_svoTI_UpdateGeometry",
"e_svoTI_UpdateLighting",
"e_svoTI_UseLightProbes",
"e_svoTI_UseTODSkyColor",
"e_svoTI_VegetationMaxOpacity",
"e_svoTI_VoxelizaionLODRatio",
"e_svoTI_VoxelizaionPostpone",
"e_svoTI_VoxelizeHiddenObjects",
"e_svoTI_VoxelizeUnderTerrain",
"e_svoTI_VoxelOpacityMultiplier",
"e_svoVoxDistRatio",
"e_svoVoxelPoolResolution",
"e_svoVoxGenRes",
"e_svoVoxNodeRatio",
"e_Terrain",
"e_TerrainBBoxes",
"e_TerrainDeformations",
"e_TerrainDetailMaterials",
"e_TerrainDetailMaterialsDebug",
"e_TerrainDetailMaterialsViewDistXY",
"e_TerrainDetailMaterialsViewDistZ",
"e_TerrainDrawThisSectorOnly",
"e_TerrainIntegrateObjectsMaxHeight",
"e_TerrainIntegrateObjectsMaxVertices",
"e_TerrainLodDistRatio",
"e_TerrainLodRatio",
"e_TerrainLodRatioHolesMin",
"e_TerrainMeshInstancingMinLod",
"e_TerrainMeshInstancingShadowBias",
"e_TerrainMeshInstancingShadowLodRatio",
"e_TerrainOcclusionCulling",
"e_TerrainOcclusionCullingDebug",
"e_TerrainOcclusionCullingMaxDist",
"e_TerrainOcclusionCullingMaxSteps",
"e_TerrainOcclusionCullingPrecision",
"e_TerrainOcclusionCullingPrecisionDistRatio",
"e_TerrainOcclusionCullingStepSize",
"e_TerrainOcclusionCullingStepSizeDelta",
"e_TerrainTextureLodRatio",
"e_TerrainTextureStreamingDebug",
"e_TerrainTextureStreamingPoolItemsNum",
"e_Tessellation",
"e_TessellationMaxDistance",
"e_TimeOfDay",
"e_TimeOfDayDebug",
"e_TimeOfDaySpeed",
"e_UseConsoleMtl",
"e_Vegetation",
"e_VegetationBending",
"e_VegetationBillboards",
"e_VegetationBoneInfo",
"e_VegetationMinSize",
"e_VegetationSprites",
"e_VegetationSpritesBatching",
"e_VegetationSpritesDistanceCustomRatioMin",
"e_VegetationSpritesDistanceRatio",
"e_VegetationSpritesMinDistance",
"e_VegetationSpritesScaleFactor",
"e_VegetationUseTerrainColor",
"e_VegetationUseTerrainColorDistance",
"e_ViewDistCompMaxSize",
"e_ViewDistMin",
"e_ViewDistRatio",
"e_ViewDistRatioCustom",
"e_ViewDistRatioDetail",
"e_ViewDistRatioLights",
"e_ViewDistRatioPortals",
"e_ViewDistRatioVegetation",
"e_VolObjShadowStrength",
"e_VolumetricFog",
"e_WaterOcean",
"e_WaterOceanBottom",
"e_WaterOceanFFT",
"e_WaterRipplesDebug",
"e_WaterTessellationAmount",
"e_WaterTessellationAmountX",
"e_WaterTessellationAmountY",
"e_WaterTessellationSwathWidth",
"e_WaterVolumes",
"e_WaterWaves",
"e_WaterWavesTessellationAmount",
"e_Wind",
"e_WindAreas",
"e_WindBendingAreaStrength",
"e_WindBendingDistRatio",
"e_WindBendingStrength",
"ed_enableAssetPickers",
"ed_indexfiles",
"ed_keepEditorActive",
"ed_killmemory_size",
"ed_logFileChanges",
"ed_PhysToolHitExplPress0",
"ed_PhysToolHitExplPress1",
"ed_PhysToolHitExplR",
"ed_PhysToolHitProjMass",
"ed_PhysToolHitProjVel0",
"ed_PhysToolHitProjVel1",
"ed_PhysToolHitVelMax",
"ed_PhysToolHitVelMin",
"ed_useDevManager",
"es_bboxes",
"es_CharZOffsetSpeed",
"es_DebrisLifetimeScale",
"es_debug",
"es_debug_not_seen_timeout",
"es_debugContainers",
"es_debugDrawEntityIDs",
"es_debugEntityLifetime",
"es_DebugEntityUsage",
"es_DebugEntityUsageFilter",
"es_DebugEntityUsageSortMode",
"es_DebugEvents",
"es_DebugFindEntity",
"es_DebugTimers",
"es_DisableTriggers",
"es_DrawAreaDebug",
"es_DrawAreaGrid",
"es_DrawAreaGridCells",
"es_DrawAreas",
"es_DrawAudioProxyZRay",
"es_DrawProximityTriggers",
"es_enable_full_script_save",
"es_EntityUpdatePosDelta",
"es_FarPhysTimeout",
"es_helpers",
"es_HitCharacters",
"es_HitDeadBodies",
"es_ImpulseScale",
"es_LayerDebugInfo",
"es_LayerSaveLoadSerialization",
"es_log_collisions",
"es_MaxImpulseAdjMass",
"es_MaxJointFx",
"es_MaxPhysDist",
"es_MaxPhysDistCloth",
"es_MaxPhysDistInvisible",
"es_MinImpulseVel",
"es_not_seen_timeout",
"es_profileentities",
"es_removeEntity",
"es_SaveLoadUseLUANoSaveFlag",
"es_SortUpdatesByClass",
"es_SplashThreshold",
"es_SplashTimeout",
"es_UpdateAI",
"es_UpdateCollision",
"es_UpdateCollisionScript",
"es_UpdateContainer",
"es_UpdateEntities",
"es_UpdatePhysics",
"es_UpdateScript",
"es_UpdateTimer",
"es_UsePhysVisibilityChecks",
"es_VisCheckForUpdate",
"ExitOnQuit",
"ffs_debug",
"fg_abortOnLoadError",
"fg_debugmodules",
"fg_debugmodules_filter",
"fg_iDebugNextStep",
"fg_iEnableFlowgraphNodeDebugging",
"fg_inspectorLog",
"fg_noDebugText",
"fg_profile",
"fg_SystemEnable",
"g_aimdebug",
"g_allowDisconnectIfUpdateFails",
"g_allowSaveLoadInEditor",
"g_asynclevelload",
"g_breakage_debug",
"g_breakage_mem_limit",
"g_breakage_particles_limit",
"g_breakageFadeDelay",
"g_breakageFadeTime",
"g_breakagelog",
"g_breakageMinAxisInertia",
"g_breakageNoDebrisCollisions",
"g_breakageTreeDec",
"g_breakageTreeInc",
"g_breakageTreeIncGlass",
"g_breakageTreeMax",
"g_breakImpulseScale",
"g_breaktimeoutframes",
"g_debug_stats",
"g_debugAspectChanges",
"g_debugAspectFilterClass",
"g_debugAspectFilterEntity",
"g_debugAspectTrap",
"g_debugAspectTrapCount",
"g_debugDialogBuffers",
"g_debugHardwareMouse",
"g_debugRMI",
"g_debugSaveLoadMemory",
"g_disableInputKeyFlowNodeInDevMode",
"g_disableSequencePlayback",
"g_disableWinKeys",
"g_displayCheckpointName",
"g_distanceForceNoIk",
"g_distanceForceNoLegRaycasts",
"g_enableitems",
"g_enableloadingscreen",
"g_EnableLoadSave",
"g_enableMergedMeshRuntimeAreas",
"g_forceFastUpdate",
"g_gameplayAnalyst",
"g_glassAutoShatter",
"g_glassAutoShatterMinArea",
"g_glassAutoShatterOnExplosions",
"g_glassForceTimeout",
"g_glassForceTimeoutSpread",
"g_glassMaxPanesToBreakPerFrame",
"g_glassNoDecals",
"g_glassSystemEnable",
"g_groundAlignAll",
"g_groundeffectsdebug",
"g_handleEvents",
"g_hostMigrationServerDelay",
"g_immersive",
"g_joint_breaking",
"g_landingBobLandTimeFactor",
"g_landingBobTimeFactor",
"g_language",
"g_languageAudio",
"g_localPacketRate",
"g_manualFrameStepFrequency",
"g_multiplayerEnableVehicles",
"g_no_breaking_by_objects",
"g_no_secondary_breaking",
"g_playerInteractorRadius",
"g_procedural_breaking",
"g_saveLoadBasicEntityOptimization",
"g_saveLoadExtendedLog",
"g_saveLoadUseExportedEntityList",
"g_showUpdateState",
"g_spectatorCollisions",
"g_statisticsMode",
"g_syncClassRegistry",
"g_tree_cut_reuse_dist",
"g_userNeverAutoSignsIn",
"g_useSinglePosition",
"g_useXMLCPBinForSaveLoad",
"g_visibilityTimeout",
"g_visibilityTimeoutTime",
"g_waterHitOnly",
"g_XMLCPBAddExtraDebugInfoToXmlDebugFiles",
"g_XMLCPBBlockQueueLimit",
"g_XMLCPBGenerateXmlDebugFiles",
"g_XMLCPBSizeReportThreshold",
"g_XMLCPBUseExtraZLibCompression",
"gfx_ampserver",
"gfx_debugdraw",
"gfx_draw",
"gfx_enabled",
"gfx_FlashReloadEnabled",
"gfx_FlashReloadTime",
"gfx_inputevents_triggerrepeat",
"gfx_inputevents_triggerstart",
"gfx_loadtimethread",
"gfx_reloadonlanguagechange",
"gfx_uiaction_enable",
"gfx_uiaction_folder",
"gfx_uiaction_log",
"gfx_uiaction_log_filter",
"gfx_uievents_editorenabled",
"gpu_particle_physics",
"gt_show",
"gt_showFilter",
"gt_showLines",
"gt_showPosX",
"gt_showPosY",
"hmd_device",
"hmd_info",
"hmd_resolution_scale",
"hmd_social_screen",
"hmd_social_screen_keep_aspect",
"hmd_tracking_origin",
"http_password",
"i_bufferedkeys",
"i_debug",
"i_debugDigitalButtons",
"i_forcefeedback",
"i_inventory_capacity",
"i_itemSystemDebugMemStats",
"i_kinectDebug",
"i_kinectXboxConnect",
"i_kinectXboxConnectIP",
"i_kinectXboxConnectPort",
"i_kinGlobalExpCorrectionFactor",
"i_kinGlobalExpDeviationRadius",
"i_kinGlobalExpJitterRadius",
"i_kinGlobalExpPredictionFactor",
"i_kinGlobalExpSmoothFactor",
"i_kinSkeletonMovedDistance",
"i_kinSkeletonSmoothType",
"i_listActionMaps",
"i_lying_item_limit_mp",
"i_lying_item_limit_sp",
"i_mouse_accel",
"i_mouse_accel_max",
"i_mouse_buffered",
"i_mouse_inertia",
"i_mouse_sensitivity",
"i_mouse_smooth",
"i_precache",
"i_seatedTracking",
"i_useKinect",
"i_xinput",
"i_xinput_deadzone_handling",
"i_xinput_poll_time",
"log_EnableRemoteConsole",
"log_IncludeTime",
"log_Module",
"log_SpamDelay",
"log_tick",
"log_Verbosity",
"log_VerbosityOverridesWriteToFile",
"log_WriteToFile",
"log_WriteToFileVerbosity",
"lua_CodeCoverage",
"lua_debugger",
"lua_stackonmalloc",
"lua_StopOnError",
"MemInfo",
"MemStats",
"MemStatsMaxDepth",
"MemStatsThreshold",
"mfx_Debug",
"mfx_DebugFlowGraphFX",
"mfx_DebugVisual",
"mfx_DebugVisualFilter",
"mfx_Enable",
"mfx_EnableAttachedEffects",
"mfx_EnableFGEffects",
"mfx_ParticleImpactThresh",
"mfx_pfx_maxDist",
"mfx_pfx_maxScale",
"mfx_pfx_minScale",
"mfx_RaisedSoundImpactThresh",
"mfx_SerializeFGEffects",
"mfx_SoundImpactThresh",
"mfx_Timeout",
"mi_defaultMaterial",
"mi_jointSize",
"mi_lazyLodGeneration",
"mn_allowEditableDatabasesInPureGame",
"mn_LogToFile",
"mn_override_preview_file",
"mn_sequence_path",
"mov_cameraPrecacheTime",
"mov_debugSequences",
"mov_NoCutscenes",
"mov_overrideCam",
"movie_physicalentity_animation_lerp",
"movie_timeJumpTransitionTime",
"net_availableBandwidthClient",
"net_availableBandwidthServer",
"net_backofftimeout",
"net_breakage_sync_entities",
"net_bw_aggressiveness",
"net_channelstats",
"net_connectivity_detection_interval",
"net_debug_draw_scale",
"net_debugChannelIndex",
"net_debugEntityInfo",
"net_debugEntityInfoClassName",
"net_debugInfo",
"net_debugVerboseLevel",
"net_dedi_scheduler_client_base_port",
"net_dedi_scheduler_server_port",
"net_defaultBandwidthShares",
"net_defaultPacketRate",
"net_defaultPacketRateIdle",
"net_disconnect_on_rmi_error",
"net_enable_tfrc",
"net_enable_voice_chat",
"net_enable_watchdog_timer",
"net_fragment_expiration_time",
"net_highlatencythreshold",
"net_highlatencytimelimit",
"net_inactivitytimeout",
"net_inactivitytimeoutDevmode",
"net_keepalive_time",
"net_lan_scanport_first",
"net_lan_scanport_num",
"net_lanbrowser",
"net_lobbyUpdateFrequency",
"net_log",
"net_log_remote_methods",
"net_max_fragmented_packets_per_source",
"net_maxpacketsize",
"net_meminfo",
"net_minTCPFriendlyBitRate",
"net_netMsgDispatcherDebug",
"net_netMsgDispatcherLogging",
"net_netMsgDispatcherWarnThreshold",
"net_new_queue_behaviour",
"net_numNetIDHighBitBits",
"net_numNetIDLowBitBits",
"net_numNetIDMediumBitBits",
"net_packet_read_debug_output",
"net_packetfragmentlossrate",
"net_PacketLagMax",
"net_PacketLagMin",
"net_PacketLossRate",
"net_phys_debug",
"net_phys_lagsmooth",
"net_phys_pingsmooth",
"net_ping_time",
"net_profile_budget_logging",
"net_profile_budget_logname",
"net_profile_deep_bandwidth_logging",
"net_profile_deep_bandwidth_logname",
"net_profile_enable",
"net_profile_logging",
"net_profile_logname",
"net_profile_show_socket_measurements",
"net_profile_untouched_delay",
"net_profile_worst_num_channels",
"net_receiveQueueSize",
"net_remotetimeestimationwarning",
"net_safetysleeps",
"net_scheduler_debug",
"net_scheduler_debug_mode",
"net_scheduler_expiration_period",
"net_sendQueueSize",
"net_sim_loadprofiles",
"net_SimUseProfile",
"net_socketBoostTimeout",
"net_socketMaxTimeout",
"net_socketMaxTimeoutMultiplayer",
"net_stats_login",
"net_stats_pass",
"osm_debug",
"osm_enabled",
"osm_fbMinScale",
"osm_fbScaleDeltaDown",
"osm_fbScaleDeltaUp",
"osm_historyLength",
"osm_stress",
"osm_targetFPS",
"osm_targetFPSTolerance",
"p_accuracy_LCPCG",
"p_accuracy_LCPCG_no_improvement",
"p_accuracy_MC",
"p_approx_caps_len",
"p_break_on_validation",
"p_CharacterIK",
"p_check_out_of_bounds",
"p_collision_mode",
"p_cull_distance",
"p_damping_group_size",
"p_debug_explosions",
"p_debug_joints",
"p_do_step",
"p_draw_helpers",
"p_draw_helpers_num",
"p_draw_helpers_opacity",
"p_enforce_contacts",
"p_ent_grid_use_obb",
"p_fixed_timestep",
"p_fly_mode",
"p_force_sync",
"p_GEB_max_cells",
"p_gravity_z",
"p_group_damping",
"p_joint_damage_accum",
"p_joint_damage_accum_threshold",
"p_joint_gravity_step",
"p_jump_to_profile_ent",
"p_lattice_max_iters",
"p_limit_simple_solver_energy",
"p_list_active_objects",
"p_log_lattice_tension",
"p_max_approx_caps",
"p_max_bone_velocity",
"p_max_contact_gap",
"p_max_contact_gap_player",
"p_max_contact_gap_simple",
"p_max_contacts",
"p_max_debris_mass",
"p_max_entity_cells",
"p_max_LCPCG_contacts",
"p_max_LCPCG_fruitless_iters",
"p_max_LCPCG_iters",
"p_max_LCPCG_microiters",
"p_max_LCPCG_microiters_final",
"p_max_LCPCG_subiters",
"p_max_LCPCG_subiters_final",
"p_max_MC_iters",
"p_max_MC_mass_ratio",
"p_max_MC_vel",
"p_max_object_splashes",
"p_max_plane_contacts",
"p_max_plane_contacts_distress",
"p_max_player_velocity",
"p_max_substeps",
"p_max_substeps_large_group",
"p_max_unproj_vel",
"p_max_velocity",
"p_max_world_step",
"p_min_LCPCG_improvement",
"p_min_MC_iters",
"p_min_separation_speed",
"p_net_debugDraw",
"p_net_extrapmax",
"p_net_interp",
"p_net_sequencefrequency",
"p_num_bodies_large_group",
"p_num_startup_overload_checks",
"p_num_threads",
"p_penalty_scale",
"p_physics_library",
"p_players_can_break",
"p_profile",
"p_profile_entities",
"p_profile_functions",
"p_prohibit_unprojection",
"p_proxy_highlight_range",
"p_proxy_highlight_threshold",
"p_ray_fadeout",
"p_ray_peak_time",
"p_rope_collider_size_limit",
"p_single_step_mode",
"p_skip_redundant_colldet",
"p_splash_dist0",
"p_splash_dist1",
"p_splash_force0",
"p_splash_force1",
"p_splash_vel0",
"p_splash_vel1",
"p_tick_breakable",
"p_time_granularity",
"p_unproj_vel_scale",
"p_use_distance_contacts",
"p_use_unproj_vel",
"p_wireframe_distance",
"pp_LoadOnlineAttributes",
"pp_RichSaveGames",
"pp_RSFDebugWrite",
"pp_RSFDebugWriteOnLoad",
"profile",
"profile_additionalsub",
"profile_allthreads",
"profile_callstack",
"profile_deep",
"profile_disk",
"profile_disk_budget",
"profile_disk_max_draw_items",
"profile_disk_max_items",
"profile_disk_timeframe",
"profile_disk_type_filter",
"profile_filter",
"profile_filter_thread",
"profile_graph",
"profile_graphScale",
"profile_log",
"profile_network",
"profile_pagefaults",
"profile_peak",
"profile_peak_display",
"profile_sampler",
"profile_sampler_max_samples",
"profile_smooth",
"profile_weighting",
"profileStreaming",
"q_Renderer",
"q_ShaderFX",
"q_ShaderGeneral",
"q_ShaderGlass",
"q_ShaderHDR",
"q_ShaderIce",
"q_ShaderMetal",
"q_ShaderPostProcess",
"q_ShaderShadow",
"q_ShaderSky",
"q_ShaderTerrain",
"q_ShaderVegetation",
"q_ShaderWater",
"r_3MonHack",
"r_3MonHackHUDFOVX",
"r_3MonHackHUDFOVY",
"r_3MonHackLeftCGFOffsetX",
"r_3MonHackRightCGFOffsetX",
"r_AllowLiveMoCap",
"r_AntialiasingMode",
"r_AntialiasingModeDebug",
"r_AntialiasingModeEditor",
"r_AntialiasingModeSCull",
"r_AntialiasingTAAFalloffHiFreq",
"r_AntialiasingTAAFalloffLowFreq",
"r_AntialiasingTAAPattern",
"r_AntialiasingTAASharpening",
"r_AntialiasingTSAAMipBias",
"r_AntialiasingTSAASmoothness",
"r_AntialiasingTSAASubpixelDetection",
"r_ArmourPulseSpeedMultiplier",
"r_auxGeom",
"r_Batching",
"r_BatchType",
"r_BreakOnError",
"r_Brightness",
"r_buffer_banksize",
"r_buffer_enable_lockless_updates",
"r_buffer_pool_defrag_dynamic",
"r_buffer_pool_defrag_max_moves",
"r_buffer_pool_defrag_static",
"r_buffer_pool_max_allocs",
"r_buffer_sli_workaround",
"r_CBufferUseNativeDepth",
"r_Character_NoDeform",
"r_ChromaticAberration",
"r_CloakFadeByDist",
"r_CloakFadeLightScale",
"r_CloakFadeMaxDistSq",
"r_CloakFadeMinDistSq",
"r_CloakFadeMinValue",
"r_CloakHeatScale",
"r_cloakHighlightStrength",
"r_CloakInterferenceSparksAlpha",
"r_CloakLightScale",
"r_CloakMinAmbientIndoors",
"r_CloakMinAmbientOutdoors",
"r_CloakMinLightValue",
"r_CloakRefractionFadeByDist",
"r_CloakRefractionFadeMaxDistSq",
"r_CloakRefractionFadeMinDistSq",
"r_CloakRefractionFadeMinValue",
"r_CloakRenderInThermalVision",
"r_CloakSparksAlpha",
"r_CloakTransitionLightScale",
"r_ColorBits",
"r_ColorGrading",
"r_ColorGradingCharts",
"r_ColorGradingChartsCache",
"r_ColorGradingFilters",
"r_ColorGradingLevels",
"r_ColorGradingSelectiveColor",
"r_ColorRangeCompression",
"r_ComputeSkinning",
"r_ComputeSkinningDebugDraw",
"r_ComputeSkinningMorphs",
"r_ComputeSkinningTangents",
"r_ConditionalRendering",
"r_constantbuffer_banksize",
"r_constantbuffer_watermarm",
"r_Contrast",
"r_CustomResHeight",
"r_CustomResMaxSize",
"r_CustomResPreview",
"r_CustomResWidth",
"r_CustomVisions",
"r_D3D12AsynchronousCompute",
"r_D3D12BatchResourceBarriers",
"r_D3D12EarlyResourceBarriers",
"r_D3D12HardwareComputeQueue",
"r_D3D12HardwareCopyQueue",
"r_D3D12SubmissionThread",
"r_D3D12WaitableSwapChain",
"r_DebugFontRendering",
"r_DebugGBuffer",
"r_DebugLayerEffect",
"r_DebugLights",
"r_DebugLightVolumes",
"r_DebugRefraction",
"r_DebugRenderMode",
"r_DeferredDecals",
"r_deferredDecalsDebug",
"r_DeferredShadingAmbient",
"r_DeferredShadingAmbientLights",
"r_DeferredShadingAmbientSClear",
"r_DeferredShadingAreaLights",
"r_DeferredShadingDBTstencil",
"r_DeferredShadingDebug",
"r_DeferredShadingDepthBoundsTest",
"r_DeferredShadingEnvProbes",
"r_DeferredShadingFilterGBuffer",
"r_DeferredShadingLBuffersFmt",
"r_DeferredShadingLightLodRatio",
"r_DeferredShadingLights",
"r_DeferredShadingLightStencilRatio",
"r_DeferredShadingLightVolumes",
"r_DeferredShadingScissor",
"r_DeferredShadingSortLights",
"r_DeferredShadingSSS",
"r_DeferredShadingStencilPrepass",
"r_DeferredShadingTiled",
"r_DeferredShadingTiledDebug",
"r_DeferredShadingTiledHairQuality",
"r_DepthBits",
"r_DepthOfField",
"r_DepthOfFieldBokehQuality",
"r_DepthOfFieldDilation",
"r_DepthOfFieldMode",
"r_DetailDistance",
"r_DetailTextures",
"r_DisplayInfo",
"r_displayinfoTargetFPS",
"r_dofMinZ",
"r_dofMinZBlendMult",
"r_dofMinZScale",
"r_DrawNearFarPlane",
"r_DrawNearFoV",
"r_DrawNearShadows",
"r_DrawNearZRange",
"r_Driver",
"r_durango_async_dips",
"r_durango_async_dips_sync",
"r_DynTexAtlasCloudsMaxSize",
"r_DynTexAtlasDynTexSrcSize",
"r_DynTexAtlasSpritesMaxSize",
"r_DynTexAtlasVoxTerrainMaxSize",
"r_DynTexMaxSize",
"r_DynTexSourceSharedRTHeight",
"r_DynTexSourceSharedRTWidth",
"r_DynTexSourceUseSharedRT",
"r_enable_full_gpu_sync",
"r_enableAltTab",
"r_enableAuxGeom",
"r_EnableDebugLayer",
"r_EnvCMResolution",
"r_EnvTexResolution",
"r_EnvTexUpdateInterval",
"r_ExcludeMesh",
"r_ExcludeShader",
"r_FlareHqShafts",
"r_Flares",
"r_FlaresChromaShift",
"r_FlaresIrisShaftMaxPolyNum",
"r_FlaresTessellationRatio",
"r_FlashMatTexResQuality",
"r_FogDepthTest",
"r_FogShadows",
"r_FogShadowsMode",
"r_FogShadowsWater",
"r_Fullscreen",
"r_FullscreenNativeRes",
"r_FullscreenPreemption",
"r_FullscreenWindow",
"r_Gamma",
"r_GeomCacheInstanceThreshold",
"r_GeomInstancing",
"r_GeomInstancingDebug",
"r_GeomInstancingThreshold",
"r_GetScreenShot",
"r_GpuParticles",
"r_GpuParticlesConstantRadiusBoundingBoxes",
"r_GpuPhysicsFluidDynamicsDebug",
"r_GraphicsPipeline",
"r_GraphicsPipelineMobile",
"r_GraphicsPipelinePassScheduler",
"r_GraphStyle",
"r_HDRBloom",
"r_HDRBloomQuality",
"r_HDRDebug",
"r_HDREyeAdaptationMode",
"r_HDREyeAdaptationSpeed",
"r_HDRGrainAmount",
"r_HDRRangeAdapt",
"r_HDRRangeAdaptationSpeed",
"r_HDRRangeAdaptLBufferMax",
"r_HDRRangeAdaptLBufferMaxRange",
"r_HDRRangeAdaptMax",
"r_HDRRangeAdaptMaxRange",
"r_HDRRendering",
"r_HDRTexFormat",
"r_HDRVignetting",
"r_Height",
"r_HeightMapAO",
"r_HeightMapAOAmount",
"r_HeightMapAORange",
"r_HeightMapAOResolution",
"r_HideSunInCubemaps",
"r_LightsSinglePass",
"r_Log",
"r_LogShaders",
"r_LogTexStreaming",
"r_LogVBuffers",
"r_LogVidMem",
"r_MaterialsBatching",
"r_MaxSuitPulseSpeedMultiplier",
"r_MeasureOverdrawScale",
"r_MergeShadowDrawcalls",
"r_MeshInstancePoolSize",
"r_MeshPoolSize",
"r_MeshPrecache",
"r_minimizeLatency",
"r_MotionBlur",
"r_MotionBlurCameraMotionScale",
"r_MotionBlurGBufferVelocity",
"r_MotionBlurMaxViewDist",
"r_MotionBlurQuality",
"r_MotionBlurShutterSpeed",
"r_MotionBlurThreshold",
"r_MotionVectors",
"r_MouseCursorTexture",
"r_MSAA",
"r_MSAA_debug",
"r_MSAA_quality",
"r_MSAA_samples",
"r_MSAA_threshold_depth",
"r_MSAA_threshold_normal",
"r_MultiGPU",
"r_MultiThreaded",
"r_MultiThreadedDrawing",
"r_MultiThreadedDrawingMinJobSize",
"r_NightVision",
"r_NightVisionBrightLevel",
"r_NightVisionCamMovNoiseAmount",
"r_NightVisionCamMovNoiseBlendSpeed",
"r_NightVisionFinalMul",
"r_NightVisionSonarLifetime",
"r_NightVisionSonarMultiplier",
"r_NightVisionSonarRadius",
"r_NoDraw",
"r_NoDrawNear",
"r_NoDrawShaders",
"r_NoHWGamma",
"r_NormalsLength",
"r_overrideDXGIAdapter",
"r_overrideDXGIOutput",
"r_overrideDXGIOutputFS",
"r_overrideRefreshRate",
"r_overrideScanlineOrder",
"r_OverscanBorderScaleX",
"r_OverscanBorderScaleY",
"r_OverscanBordersDrawDebugView",
"r_ParticlesAmountGI",
"r_ParticlesDebug",
"r_ParticlesHalfRes",
"r_ParticlesHalfResAmount",
"r_ParticlesHalfResBlendMode",
"r_ParticlesInstanceVertices",
"r_ParticlesRefraction",
"r_ParticlesSoftIsec",
"r_ParticlesTessellation",
"r_ParticlesTessellationTriSize",
"r_ParticleVerticePoolSize",
"r_PostProcessEffects",
"r_PostProcessFilters",
"r_PostProcessGameFx",
"r_PostProcessHUD3D",
"r_PostProcessHUD3DCache",
"r_PostProcessHUD3DDebugView",
"r_PostProcessHUD3DGlowAmount",
"r_PostProcessHUD3DShadowAmount",
"r_PostProcessHUD3DStencilClear",
"r_PostProcessNanoGlassDebugView",
"r_PostProcessParamsBlending",
"r_PostprocessParamsBlendingTimeScale",
"r_PostProcessReset",
"r_PredicatedTiling",
"r_PrintMemoryLeaks",
"r_profiler",
"r_profilerTargetFPS",
"r_Rain",
"r_RainAmount",
"r_RainDistMultiplier",
"r_RainDropsEffect",
"r_RainIgnoreNearest",
"r_RainMaxViewDist",
"r_RainMaxViewDist_Deferred",
"r_RainOccluderSizeTreshold",
"r_RC_AutoInvoke",
"r_ReadZBufferDirectlyFromVMEM",
"r_Reflections",
"r_ReflectionsOffset",
"r_ReflectionsQuality",
"r_ReflectTextureSlots",
"r_Refraction",
"r_RefractionPartialResolves",
"r_RefractionPartialResolvesDebug",
"r_ReleaseAllResourcesOnExit",
"r_ReloadShaders",
"r_RenderMeshHashGridUnitSize",
"r_RenderTargetPoolSize",
"r_ReprojectOnlyStaticObjects",
"r_ReverseDepth",
"r_Scissor",
"r_ShaderCompilerDontCache",
"r_ShaderCompilerFolderName",
"r_ShaderCompilerFolderSuffix",
"r_ShaderCompilerPort",
"r_ShaderCompilerServer",
"r_ShaderEmailCCs",
"r_ShaderEmailTags",
"r_ShadersAllowCompilation",
"r_ShadersAsyncActivation",
"r_ShadersAsyncCompiling",
"r_ShadersAsyncMaxThreads",
"r_ShadersCacheDeterministic",
"r_ShadersCompileAutoActivate",
"r_ShadersCompileCompatible",
"r_ShadersCompileStrict",
"r_ShadersDebug",
"r_ShadersDurango",
"r_ShadersDX11",
"r_ShadersEditing",
"r_ShadersExport",
"r_ShadersGL4",
"r_ShadersGLES3",
"r_ShadersIgnoreIncludesChanging",
"r_ShadersImport",
"r_ShadersLazyUnload",
"r_ShadersLogCacheMisses",
"r_ShadersOrbis",
"r_ShadersPrecacheAllLights",
"r_ShadersRemoteCompiler",
"r_ShadersSubmitRequestline",
"r_ShadowBluriness",
"r_ShadowCastingLightsMaxCount",
"r_ShadowGen",
"r_ShadowGenDepthClip",
"r_ShadowGenMode",
"r_ShadowJittering",
"r_ShadowMaskStencilPrepass",
"r_ShadowPass",
"r_ShadowPoolMaxFrames",
"r_ShadowPoolMaxTimeslicedUpdatesPerFrame",
"r_ShadowsAdaptionMin",
"r_ShadowsAdaptionRangeClamp",
"r_ShadowsAdaptionSize",
"r_ShadowsBias",
"r_ShadowsCache",
"r_ShadowsCacheFormat",
"r_ShadowsCacheResolutions",
"r_ShadowsDepthBoundNV",
"r_ShadowsGridAligned",
"r_ShadowsMaskDownScale",
"r_ShadowsMaskResolution",
"r_ShadowsNearestMapResolution",
"r_ShadowsParticleAnimJitterAmount",
"r_ShadowsParticleJitterAmount",
"r_ShadowsParticleKernelSize",
"r_ShadowsParticleNormalEffect",
"r_ShadowsPCFiltering",
"r_ShadowsScreenSpace",
"r_ShadowsStencilPrePass",
"r_ShadowsUseClipVolume",
"r_ShadowTexFormat",
"r_Sharpening",
"r_ShowBufferUsage",
"r_ShowDynTextures",
"r_ShowDynTexturesFilter",
"r_ShowDynTexturesMaxCount",
"r_ShowLightBounds",
"r_ShowLines",
"r_ShowNormals",
"r_ShowTangents",
"r_ShowTexture",
"r_ShowTimeGraph",
"r_ShowVideoMemoryStats",
"r_SilhouettePOM",
"r_SkipAlphaTested",
"r_Snow",
"r_SnowDisplacement",
"r_SnowFlakeClusters",
"r_SnowHalfRes",
"r_SoftAlphaTest",
"r_SonarVision",
"r_ssdo",
"r_ssdoAmountAmbient",
"r_ssdoAmountDirect",
"r_ssdoAmountReflection",
"r_ssdoColorBleeding",
"r_ssdoHalfRes",
"r_ssdoRadius",
"r_ssdoRadiusMax",
"r_ssdoRadiusMin",
"r_SSReflections",
"r_SSReflHalfRes",
"r_Stats",
"r_statsMinDrawCalls",
"r_StencilBits",
"r_StereoDevice",
"r_StereoEnableMgpu",
"r_StereoEyeDist",
"r_StereoFlipEyes",
"r_StereoGammaAdjustment",
"r_StereoHudScreenDist",
"r_stereoMirrorProjection",
"r_StereoMode",
"r_StereoNearGeoScale",
"r_StereoOutput",
"r_stereoScaleCoefficient",
"r_StereoScreenDist",
"r_StereoStrength",
"r_sunshafts",
"r_Supersampling",
"r_SupersamplingFilter",
"r_SyncToFrameFence",
"r_TessellationDebug",
"r_TessellationTriangleSize",
"r_TexAtlasSize",
"r_TexBindMode",
"r_TexelsPerMeter",
"r_TexLog",
"r_TexMaxAnisotropy",
"r_TexMinAnisotropy",
"r_TexNoAnisoAlphaTest",
"r_TexNoLoad",
"r_TexPostponeLoading",
"r_TexPreallocateAtlases",
"r_TextureCompiling",
"r_TextureCompilingIndicator",
"r_TextureCompressor",
"r_TextureLodDistanceRatio",
"r_texturesskiplowermips",
"r_TexturesStreaming",
"r_TexturesStreamingDebug",
"r_TexturesStreamingDebugDumpIntoLog",
"r_TexturesStreamingDebugFilter",
"r_TexturesStreamingDebugMinMip",
"r_TexturesStreamingDebugMinSize",
"r_texturesstreamingDeferred",
"r_TexturesStreamingDisableNoStreamDuringLoad",
"r_texturesstreamingJobUpdate",
"r_TexturesStreamingMaxRequestedJobs",
"r_TexturesStreamingMaxRequestedMB",
"r_TexturesStreamingMinReadSizeKB",
"r_texturesstreamingMinUsableMips",
"r_TexturesStreamingMipBias",
"r_TexturesStreamingMipClampDVD",
"r_TexturesStreamingMipFading",
"r_TexturesStreamingNoUpload",
"r_TexturesStreamingOnlyVideo",
"r_TexturesStreamingPostponeMips",
"r_TexturesStreamingPostponeThresholdKB",
"r_texturesstreamingPostponeThresholdMip",
"r_TexturesStreamingPrecacheRounds",
"r_texturesstreamingSkipMips",
"r_TexturesStreamingSuppress",
"r_TexturesStreamingSync",
"r_TexturesStreamingUpdateType",
"r_texturesstreampooldefragmentation",
"r_texturesstreampooldefragmentationmaxamount",
"r_texturesstreampooldefragmentationmaxmoves",
"r_TexturesStreamPoolSecondarySize",
"r_TexturesStreamPoolSize",
"r_ThermalVision",
"r_ThermalVisionViewCloakFlickerMaxIntensity",
"r_ThermalVisionViewCloakFlickerMinIntensity",
"r_ThermalVisionViewCloakFrequencyPrimary",
"r_ThermalVisionViewCloakFrequencySecondary",
"r_ThermalVisionViewDistance",
"r_transient_pool_size",
"r_TransparentPasses",
"r_TranspDepthFixup",
"r_Unlit",
"r_UpdateInstances",
"r_UseDisplacementFactor",
"r_UseESRAM",
"r_UseHWSkinning",
"r_UseMaterialLayers",
"r_UseMergedPosts",
"r_UsePersistentRTForModelHUD",
"r_UseShadowsPool",
"r_UseZPass",
"r_ValidateDraw",
"r_VegetationSpritesDebug",
"r_VegetationSpritesGenAlways",
"r_VegetationSpritesMaxLightingUpdates",
"r_VegetationSpritesNoGen",
"r_VegetationSpritesTexRes",
"r_VisAreaClipLightsPerPixel",
"r_VolumetricClouds",
"r_VolumetricCloudsPipeline",
"r_VolumetricCloudsRaymarchStepNum",
"r_VolumetricCloudsShadowResolution",
"r_VolumetricCloudsStereoReprojection",
"r_VolumetricCloudsTemporalReprojection",
"r_VolumetricFogDownscaledSunShadow",
"r_VolumetricFogDownscaledSunShadowRatio",
"r_VolumetricFogMinimumLightBulbSize",
"r_VolumetricFogReprojectionBlendFactor",
"r_VolumetricFogReprojectionMode",
"r_VolumetricFogSample",
"r_VolumetricFogShadow",
"r_VolumetricFogSunLightCorrection",
"r_VolumetricFogTexDepth",
"r_VolumetricFogTexScale",
"r_VrProjectionPreset",
"r_VrProjectionType",
"r_VSync",
"r_WaterCaustics",
"r_WaterCausticsDeferred",
"r_WaterCausticsDistance",
"r_WaterGodRays",
"r_WaterGodRaysDistortion",
"r_WaterReflections",
"r_WaterReflectionsMGPU",
"r_WaterReflectionsMinVisiblePixelsUpdate",
"r_WaterReflectionsMinVisUpdateDistanceMul",
"r_WaterReflectionsMinVisUpdateFactorMul",
"r_WaterReflectionsQuality",
"r_WaterReflectionsUseMinOffset",
"r_WaterTessellationHW",
"r_WaterUpdateDistance",
"r_WaterUpdateFactor",
"r_WaterUpdateThread",
"r_WaterVolumeCaustics",
"r_WaterVolumeCausticsDensity",
"r_WaterVolumeCausticsMaxDist",
"r_WaterVolumeCausticsRes",
"r_WaterVolumeCausticsSnapFactor",
"r_Width",
"r_WindowIconTexture",
"r_wireframe",
"r_ZFightingDepthScale",
"r_ZFightingExtrude",
"r_ZPassDepthSorting",
"r_ZPassOnly",
"r_ZPrepassMaxDist",
"rc_debugVerboseLevel",
"rcon_password",
"s_AudioEventPoolSize",
"s_AudioImplName",
"s_AudioLoggingOptions",
"s_AudioObjectPoolSize",
"s_AudioObjectsDebugFilter",
"s_AudioObjectsRayType",
"s_AudioProxiesInitType",
"s_AudioStandaloneFilePoolSize",
"s_AudioTriggersDebugFilter",
"s_DefaultStandaloneFilesAudioTrigger",
"s_DrawAudioDebug",
"s_FileCacheManagerDebugFilter",
"s_FileCacheManagerSize",
"s_FullObstructionMaxDistance",
"s_IgnoreWindowFocus",
"s_OcclusionHighDistance",
"s_OcclusionMaxDistance",
"s_OcclusionMaxSyncDistance",
"s_OcclusionMediumDistance",
"s_OcclusionMinDistance",
"s_OcclusionRayLengthOffset",
"s_PositionUpdateThresholdMultiplier",
"s_SDLMixerStandaloneFileExtension",
"s_ShowActiveAudioObjectsOnly",
"s_TickWithMainThread",
"s_VelocityTrackingThreshold",
"sc_allowFlowGraphNodes",
"sc_DisplayCriticalErrors",
"sc_EnableScriptPartitioning",
"sc_EntityDebugConfig",
"sc_EntityDebugFilter",
"sc_EntityDebugTextPos",
"sc_ExperimentalFeatures",
"sc_IgnorePAKFiles",
"sc_IgnoreUnderscoredFolders",
"sc_LogFileMessageTypes",
"sc_LogFileStreams",
"sc_LogToFile",
"sc_RootFolder",
"sc_RunUnitTests",
"sensor_Debug",
"sensor_DebugRange",
"STAP_DEBUG",
"STAP_DISABLE",
"STAP_LOCK_EFFECTOR",
"STAP_OVERRIDE_TRACK_FACTOR",
"STAP_TRANSLATION_FEATHER",
"STAP_TRANSLATION_FUDGE",
"stats_FpsBuckets",
"stats_PakFile",
"stats_Particles",
"stats_RenderBatchStats",
"stats_RenderSummary",
"stats_Warnings",
"sv_AISystem",
"sv_autoconfigurl",
"sv_bandwidth",
"sv_bind",
"sv_DedicatedCPUPercent",
"sv_DedicatedCPUVariance",
"sv_DedicatedMaxRate",
"sv_dumpstats",
"sv_dumpstatsperiod",
"sv_gamerules",
"sv_gamerulesdefault",
"sv_lanonly",
"sv_levelrotation",
"sv_LoadAllLayersForResList",
"sv_map",
"sv_maxmemoryusage",
"sv_maxplayers",
"sv_maxspectators",
"sv_packetRate",
"sv_password",
"sv_port",
"sv_ranked",
"sv_requireinputdevice",
"sv_servername",
"sv_timeofdayenable",
"sv_timeofdaylength",
"sv_timeofdaystart",
"sv_timeout_disconnect",
"sw_debugInfo",
"sw_draw_bbox",
"sw_gridSize",
"sys_AI",
"sys_archive_host_xml_version",
"sys_asserts",
"sys_audio_disable",
"sys_bp_frames",
"sys_bp_frames_threshold",
"sys_bp_frames_worker_thread",
"sys_bp_time_threshold",
"sys_budget_frametime",
"sys_budget_numdrawcalls",
"sys_budget_numpolys",
"sys_budget_soundchannels",
"sys_budget_soundCPU",
"sys_budget_soundmem",
"sys_budget_streamingthroughput",
"sys_budget_sysmem",
"sys_budget_videomem",
"sys_build_folder",
"sys_crashrpt",
"sys_crashrpt_appname",
"sys_crashrpt_appversion",
"sys_crashrpt_email",
"sys_crashrpt_privacypolicy",
"sys_crashrpt_server",
"sys_DeactivateConsole",
"sys_debugger_adjustments",
"sys_deferAudioUpdateOptim",
"sys_display_threads",
"sys_dll_ai",
"sys_dll_game",
"sys_dll_response_system",
"sys_dump_aux_threads",
"sys_dump_type",
"sys_enable_budgetmonitoring",
"sys_enable_crash_handler",
"sys_entities",
"sys_error_debugbreak",
"sys_filesystemCaseSensitivity",
"sys_firstlaunch",
"sys_flash",
"sys_flash_address_space",
"sys_flash_allow_reset_mesh_cache",
"sys_flash_check_filemodtime",
"sys_flash_curve_tess_error",
"sys_flash_debugdraw",
"sys_flash_debugdraw_depth",
"sys_flash_debuglog",
"sys_flash_edgeaa",
"sys_flash_info",
"sys_flash_info_histo_scale",
"sys_flash_info_peak_exclude",
"sys_flash_info_peak_tolerance",
"sys_flash_log_options",
"sys_flash_reset_mesh_cache",
"sys_flash_static_pool_size",
"sys_flash_stereo_maxparallax",
"sys_flash_use_arenas",
"sys_flash_video_soundvolume",
"sys_flash_video_subaudiovolume",
"sys_flash_warning_level",
"sys_float_exceptions",
"sys_force_installtohdd_mode",
"sys_game_folder",
"sys_game_name",
"sys_highrestimer",
"sys_ime",
"sys_initpreloadpacks",
"sys_intromoviesduringinit",
"sys_job_system_enable",
"sys_job_system_filter",
"sys_job_system_max_worker",
"sys_job_system_profiler",
"sys_keyboard",
"sys_keyboard_break",
"sys_limit_phys_thread_count",
"sys_livecreate",
"sys_LoadFrontendShaderCache",
"sys_localization_debug",
"sys_localization_encode",
"sys_localization_folder",
"sys_LocalMemoryDiagramAlpha",
"sys_LocalMemoryDiagramDistance",
"sys_LocalMemoryDiagramRadius",
"sys_LocalMemoryDiagramStreamingSpeedDistance",
"sys_LocalMemoryDiagramStreamingSpeedRadius",
"sys_LocalMemoryDiagramWidth",
"sys_LocalMemoryDrawText",
"sys_LocalMemoryGeometryLimit",
"sys_LocalMemoryGeometryStreamingSpeedLimit",
"sys_LocalMemoryInnerViewDistance",
"sys_LocalMemoryLogText",
"sys_LocalMemoryMaxMSecBetweenCalls",
"sys_LocalMemoryObjectAlpha",
"sys_LocalMemoryObjectHeight",
"sys_LocalMemoryObjectWidth",
"sys_LocalMemoryOptimalMSecPerSec",
"sys_LocalMemoryOuterViewDistance",
"sys_LocalMemoryStreamingSpeedObjectLength",
"sys_LocalMemoryStreamingSpeedObjectWidth",
"sys_LocalMemoryTextureLimit",
"sys_LocalMemoryTextureStreamingSpeedLimit",
"sys_LocalMemoryWarningRatio",
"sys_log_asserts",
"sys_logallocations",
"sys_max_step",
"sys_MaxFPS",
"sys_maxTimeStepForMovieSystem",
"sys_memory_debug",
"sys_MemoryDeadListSize",
"sys_menupreloadpacks",
"sys_min_step",
"sys_no_crash_dialog",
"sys_noupdate",
"sys_PakDisableNonLevelRelatedPaks",
"sys_PakInMemorySizeLimit",
"sys_PakLoadCache",
"sys_PakLoadModePaks",
"sys_PakLogAllFileAccess",
"sys_PakLogInvalidFileAccess",
"sys_PakLogMissingFiles",
"sys_PakMessageInvalidFileAccess",
"sys_PakPriority",
"sys_PakReadSlice",
"sys_PakSaveFastLoadResourceList",
"sys_PakSaveLevelResourceList",
"sys_PakSaveMenuCommonResourceList",
"sys_PakSaveTotalResourceList",
"sys_PakStreamCache",
"sys_PakTotalInMemorySizeLimit",
"sys_PakValidateFileHash",
"sys_perfhud",
"sys_perfhud_fpsBucketsExclusive",
"sys_perfhud_pause",
"sys_physics",
"sys_physics_enable_MT",
"sys_preload",
"sys_ProfileLevelLoading",
"sys_ProfileLevelLoadingDump",
"sys_project",
"sys_rendersplashscreen",
"sys_resource_cache_folder",
"sys_root",
"sys_scale3DMouseTranslation",
"sys_Scale3DMouseYPR",
"sys_screensaver_allowed",
"sys_simple_http_base_port",
"sys_SimulateTask",
"sys_spec",
"sys_spec_full",
"sys_spec_gameeffects",
"sys_spec_light",
"sys_spec_objectdetail",
"sys_spec_particles",
"sys_spec_physics",
"sys_spec_postprocessing",
"sys_spec_quality",
"sys_spec_shading",
"sys_spec_shadows",
"sys_spec_sound",
"sys_spec_texture",
"sys_spec_textureresolution",
"sys_spec_volumetriceffects",
"sys_spec_water",
"sys_SSInfo",
"sys_streaming_debug",
"sys_streaming_debug_filter",
"sys_streaming_debug_filter_file_name",
"sys_streaming_debug_filter_min_time",
"sys_streaming_in_blocks",
"sys_streaming_max_bandwidth",
"sys_streaming_max_finalize_per_frame",
"sys_streaming_memory_budget",
"sys_streaming_requests_grouping_time_period",
"sys_streaming_resetstats",
"sys_streaming_use_optical_drive_thread",
"sys_target_platforms",
"sys_trackview",
"sys_UncachedStreamReads",
"sys_update_profile_time",
"sys_use_mono",
"sys_usePlatformSavingAPI",
"sys_usePlatformSavingAPIEncryption",
"sys_user_folder",
"sys_UserAnalyticsCollect",
"sys_UserAnalyticsLogging",
"sys_UserAnalyticsServerAddress",
"sys_version",
"sys_vr_support",
"sys_vtune",
"sys_warnings",
"sys_WER",
"t_Debug",
"t_FixedStep",
"t_MaxStep",
"t_Scale",
"t_Smoothing",
"ui_to_show",
"v_autoDisable",
"v_clientPredict",
"v_clientPredictAdditionalTime",
"v_clientPredictMaxTime",
"v_clientPredictSmoothing",
"v_clientPredictSmoothingConst",
"v_debug_flip_over",
"v_debug_mem",
"v_debug_reorient",
"v_debugCollisionDamage",
"v_debugdraw",
"v_debugSuspensionIK",
"v_debugVehicle",
"v_debugViewAbove",
"v_debugViewAboveH",
"v_debugViewDetach",
"v_disable_hull",
"v_disableEntry",
"v_draw_components",
"v_draw_helpers",
"v_draw_passengers",
"v_draw_seats",
"v_draw_tm",
"v_driverControlledMountedGuns",
"v_enableMannequin",
"v_FlippedExplosionPlayerMinDistance",
"v_FlippedExplosionRetryTimeMS",
"v_FlippedExplosionTimeToExplode",
"v_goliathMode",
"v_independentMountedGuns",
"v_lights",
"v_lights_enable_always",
"v_playerTransitions",
"v_ragdollPassengers",
"v_serverControlled",
"v_set_passenger_tm",
"v_show_all",
"v_slipFrictionModFront",
"v_slipFrictionModRear",
"v_slipSlopeFront",
"v_slipSlopeRear",
"v_staticTreadDeform",
"v_testClientPredict",
"v_transitionAnimations",
"v_vehicle_quality"
]
},
"commands": {
"$id": "/definitions/commands",
"type": "string",
"title": "Command name",
"description": "Console command name",
"default": "",
"enum": [
"_TestFormatMessage",
"ai_CheckGoalpipes",
"ai_commTest",
"ai_commTestStop",
"ai_DebugAgent",
"ai_debugMNMAgentType",
"ai_dumpCheckpoints",
"ai_MNMCalculateAccessibility",
"ai_MNMComputeConnectedIslands",
"ai_NavigationReloadConfig",
"ai_Recorder_Start",
"ai_Recorder_Stop",
"ai_reload",
"ai_resetCommStats",
"ai_writeCommStats",
"audit_cvars",
"ban",
"ban_remove",
"ban_status",
"Bind",
"ca_DebugText",
"ca_DefaultTransitionInterpolationType",
"connect",
"connect_repeatedly",
"ConsoleHide",
"ConsoleShow",
"demo",
"demo_StartDemoChain",
"demo_StartDemoLevel",
"disconnect",
"disconnectchannel",
"drs_sendSignal",
"ds_Dump",
"ds_DumpSessions",
"ds_Reload",
"dump_action_maps",
"dump_maps",
"dump_stats",
"DumpCommandsVars",
"DumpVars",
"e_DebugDrawListCMD",
"e_ParticleListEffects",
"e_ParticleListEmitters",
"e_ParticleMemory",
"e_ReloadSurfaces",
"e_StatoscopeAddUserMarker",
"ed_disable_game_mode",
"ed_GenerateBillboardTextures",
"ed_goto",
"ed_killmemory",
"ed_randomize_variations",
"eqp_DumpPacks",
"es_compile_area_grid",
"es_debugAnim",
"es_dump_entities",
"es_dump_entity_classes_in_use",
"es_togglelayer",
"exec",
"ffs_PlayEffect",
"ffs_Reload",
"ffs_StopAllEffects",
"fg_InspectAction",
"fg_InspectEntity",
"fg_Inspector",
"fg_reloadClasses",
"fg_writeDocumentation",
"g_dump_stats",
"g_dumpClassRegistry",
"g_saveLoadDumpEntity",
"gamedata_playback",
"gamedata_record",
"gamedata_stop_record_or_playback",
"gfx_reload_all",
"gt_AddToDebugList",
"gt_RemoveFromDebugList",
"hmd_recenter_pose",
"http_startserver",
"http_stopserver",
"i_dropitem",
"i_giveallitems",
"i_giveammo",
"i_givedebugitems",
"i_giveitem",
"i_listitems",
"i_reloadActionMaps",
"i_saveweaponposition",
"kick",
"kickid",
"load",
"LoadConfig",
"LocalizationDumpLoadedInfo",
"lua_debugger_show",
"lua_dump_coverage",
"lua_dump_state",
"lua_garbagecollect",
"lua_reload_script",
"map",
"memDumpAllocs",
"memReplayAddSizerTree",
"memReplayDumpSymbols",
"memReplayInfo",
"memReplayLabel",
"memReplayPause",
"memReplayResume",
"memReplayStop",
"memResetAllocs",
"mfx_Reload",
"mfx_ReloadFGEffects",
"mn_DebugAI",
"mn_listAssets",
"mn_reload",
"mono_reload",
"mov_goToFrameEditor",
"net_dump_object_state",
"net_DumpMessageApproximations",
"net_getChannelPerformanceMetrics",
"net_netMsgDispatcherClearStats",
"net_pb_cl_enable",
"net_pb_sv_enable",
"net_set_cdkey",
"net_setChannelPerformanceMetrics",
"open_url",
"osm_setFBScale",
"play",
"py",
"q_Quality",
"r_ColorGradingChartImage",
"r_DumpFontNames",
"r_DumpFontTexture",
"r_getposteffectparamf",
"r_OptimiseShaders",
"r_OverscanBorders",
"r_PrecacheShaderList",
"r_setposteffectparamf",
"r_ShowRenderTarget",
"r_StatsShaderList",
"rcon_command",
"rcon_connect",
"rcon_disconnect",
"rcon_startserver",
"rcon_stopserver",
"readabilityReload",
"record",
"RecordClip",
"ReloadDialogData",
"RunUnitTests",
"s_ExecuteTrigger",
"s_SetRtpc",
"s_SetSwitchState",
"s_StopTrigger",
"save",
"save_genstrings",
"SaveLevelStats",
"sc_CriticalError",
"sc_FatalError",
"sc_rpcShow",
"sc_SaveAllScriptFiles",
"Screenshot",
"sensor_SetOctreeBounds",
"sensor_SetOctreeDepth",
"status",
"stopdemo",
"stoprecording",
"sys_crashrpt_generate",
"sys_crashtest",
"sys_crashtest_thread",
"sys_job_system_dump_job_list",
"sys_LvlRes_finalstep",
"sys_LvlRes_findunused",
"sys_RestoreSpec",
"sys_StroboscopeDumpResults",
"sys_StroboscopeStart",
"sys_StroboscopeStop",
"sys_threads_dump_thread_config_list",
"test_delegate",
"test_playersBounds",
"test_profile",
"test_reset",
"unload",
"v_dump_classes",
"v_exit_player",
"v_reload_system",
"version",
"VisRegTest",
"voice_mute",
"wait_frames",
"wait_seconds"
]
}
},
"id": "https://json.schemastore.org/cryproj.54.schema",
"properties": {
"console_variables": {
"$id": "/properties/console_variables",
"type": "array",
"uniqueItems": true,
"items": {
"$id": "/properties/console_variables/items",
"type": "object",
"properties": {
"name": {
"$id": "/properties/console_variables/items/properties/name",
"$ref": "#/definitions/cvars"
},
"value": {
"$id": "/properties/console_variables/items/properties/value",
"type": "string",
"title": "Value of the CVar",
"description": "The default value of the CVar",
"default": "pc,ps4,xboxone,linux"
}
},
"required": ["name", "value"]
}
},
"content": {
"$id": "/properties/content",
"type": "object",
"properties": {
"assets": {
"$id": "/properties/content/properties/assets",
"type": "array",
"items": {
"$id": "/properties/content/properties/assets/items",
"type": "string",
"title": "Assets folder",
"description": "This indicates where the assets are stored",
"default": "Assets",
"examples": ["Assets"]
}
},
"code": {
"$id": "/properties/content/properties/code",
"type": "array",
"items": {
"$id": "/properties/content/properties/code/items",
"type": "string",
"title": "Code folder",
"description": "This indicates where the code is stored",
"default": "Code",
"examples": ["Code"]
}
},
"libs": {
"$id": "/properties/content/properties/libs",
"type": "array",
"items": {
"$id": "/properties/content/properties/libs/items",
"type": "object",
"properties": {
"name": {
"$id": "/properties/content/properties/libs/items/properties/name",
"type": "string",
"title": "Lib's name",
"default": "",
"examples": ["Blank"]
},
"shared": {
"$id": "/properties/content/properties/libs/items/properties/shared",
"type": "object",
"properties": {
"any": {
"$id": "/properties/content/properties/libs/items/properties/shared/properties/any",
"type": "string",
"title": "Lib's name to import for all the supported platforms",
"default": "",
"examples": ["CryGameSDK"]
},
"win_x64": {
"$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x64",
"type": "string",
"title": "Lib's name to import for the win_x64 platform",
"default": "",
"examples": ["bin/win_x64/Game.dll"]
},
"win_x86": {
"$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x86",
"type": "string",
"title": "Lib's name to import for the win_x86 platform",
"default": "",
"examples": ["bin/win_x86/Game.dll"]
}
}
}
}
}
}
},
"required": ["code"]
},
"info": {
"$id": "/properties/info",
"type": "object",
"properties": {
"name": {
"$id": "/properties/info/properties/name",
"type": "string",
"title": "Project name",
"description": "This indicates the project name",
"default": "",
"examples": ["MyFancyProject"]
},
"guid": {
"$id": "/properties/info/properties/guid",
"type": "string",
"title": "Project GUID",
"default": "",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
}
},
"required": ["name"]
},
"require": {
"$id": "/properties/require",
"type": "object",
"properties": {
"engine": {
"$id": "/properties/require/properties/engine",
"type": "string",
"title": "Engine version",
"description": "This indicates which engine version will be used",
"default": "",
"examples": ["engine-5.4"],
"enum": ["engine-5.4"]
},
"plugins": {
"$id": "/properties/require/properties/plugins",
"type": "array",
"items": {
"$id": "/properties/require/properties/plugins/items",
"type": "object",
"properties": {
"path": {
"$id": "/properties/require/properties/plugins/items/properties/path",
"type": "string",
"title": "Plugin name",
"description": "Required plugin's name",
"examples": [
"CryDefaultEntities",
"CrySensorSystem",
"CryPerceptionSystem",
"CryUserAnalytics",
"CryOSVR",
"CryOculusVR",
"CryOpenVR",
"CryLobby"
]
},
"type": {
"$id": "/properties/require/properties/plugins/items/properties/type",
"type": "string",
"title": "Plugin type",
"description": "EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one",
"default": "",
"examples": ["EPluginType::Native", "EPluginType::Managed"],
"enum": ["EPluginType::Native", "EPluginType::Managed"]
},
"platforms": {
"$id": "/properties/plugins/items/properties/platforms",
"type": "array",
"items": {
"$id": "/properties/plugins/items/properties/platforms/items",
"type": "string",
"title": "This plugin will be used only by these platforms",
"default": "",
"examples": ["PS4"],
"enum": ["pc", "ps4", "xboxone", "linux"]
}
}
},
"required": ["path", "type"]
}
}
},
"required": ["engine"]
},
"type": {
"$id": "/properties/type",
"type": "string",
"title": "",
"default": "",
"examples": [""]
},
"version": {
"$id": "/properties/version",
"type": "integer",
"title": "Project version",
"default": 1,
"examples": [1]
},
"console_commands": {
"$id": "/properties/console_commands",
"type": "array",
"uniqueItems": true,
"items": {
"$id": "/properties/console_commands/items",
"type": "object",
"properties": {
"name": {
"$id": "/properties/console_commands/items/properties/name",
"$ref": "#/definitions/commands"
},
"value": {
"$id": "/properties/console_commands/items/properties/value",
"type": "string",
"title": "Value of the command",
"description": "Arguments that has to be passed to the command. Leave empty if it has not parameters",
"default": ""
}
},
"required": ["name", "value"]
}
}
},
"required": ["content", "info", "require", "version"],
"title": "CryProj schema",
"type": "object"
}
|
ntangle.json | {
"title": "NTangle - https://github.com/Avanade/ntangle",
"$schema": "https://json-schema.org/draft-04/schema#",
"definitions": {
"Root": {
"type": "object",
"title": "The 'Root' object (database-driven)",
"description": "The 'RootConfig' object defines the global properties that are used to drive the underlying database-driven CDC-oriented code-generation.",
"properties": {
"schema": {
"type": "string",
"title": "The default 'Schema' name where the existing tables are defined within the database.",
"description": "This is used as the default 'Schema' for all child objects. Defaults to 'dbo' (literal)."
},
"cdcSchema": {
"type": "string",
"title": "The schema name for the _ntangle_ generated 'CDC'-related database artefacts.",
"description": "Defaults to 'NTangle' (literal)."
},
"cdcSchemaCreate": {
"type": "boolean",
"title": "Indicates whether to create the 'CdcSchema' within the database.",
"description": "Defaults to 'false'."
},
"versionTrackingTable": {
"type": "string",
"title": "The table name for the 'Cdc'-VersionTracking.",
"description": "Defaults to 'VersionTracking' (literal)."
},
"cdcEnable": {
"type": "boolean",
"title": "Indicates whether to enable 'Cdc' within the database for the tables that participate.",
"description": "Defaults to 'false'. This option can be overridden for each underlying table referenced."
},
"identifierMapping": {
"type": "boolean",
"title": "Indicates whether to include the generation of the generic 'CDC'-IdentifierMapping database capabilities.",
"description": "Where set to 'true' each underlying 'Table' and corresponding 'Join' must set 'IdentifierMapping' explicitly."
},
"identifierMappingType": {
"type": "string",
"title": "The type for the identifier mapping value.",
"description": "Defaults to 'String'.",
"enum": [
"String",
"Int",
"Long",
"Guid"
]
},
"identifierMappingTable": {
"type": "string",
"title": "The table name for the 'Cdc'-IdentifierMapping.",
"description": "Defaults to 'IdentifierMapping' (literal)."
},
"identifierMappingStoredProcedure": {
"type": "string",
"title": "The stored procedure name for the 'Cdc'-IdentifierMapping create.",
"description": "Defaults to 'spIdentifierMappingCreate' (literal)."
},
"isDeletedColumn": {
"type": "string",
"title": "The column name for the 'IsDeleted' (logical delete) capability (if any).",
"description": "Defaults to 'IsDeleted'."
},
"autoDotNetRename": {
"type": "string",
"title": "The option to automatically rename the SQL Tables and Columns for use in .NET.",
"description": "Defaults to 'SnakeKebabToPascalCase' which will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.",
"enum": [
"None",
"PascalCase",
"SnakeKebabToPascalCase"
]
},
"excludeColumnsFromETag": {
"type": "array",
"title": "The default list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking)",
"items": {
"type": "string"
}
},
"jsonSerializer": {
"type": "string",
"title": "The JSON Serializer to use for JSON property attribution.",
"description": "Defaults to 'SystemText'.",
"enum": [
"SystemText",
"Newtonsoft"
]
},
"service": {
"type": "string",
"title": "The type of service that manages the underlying orchestrator.",
"description": "Defaults to 'None'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.",
"enum": [
"None",
"HostedService",
"Service"
]
},
"eventSubjectRoot": {
"type": "string",
"title": "The root for the event name by prepending to all event subject names via CDC.",
"description": "Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc."
},
"eventSubjectFormat": {
"type": "string",
"title": "The default formatting for the Subject when an Event is published via CDC.",
"description": "Defaults to 'NameOnly'.",
"enum": [
"NameOnly",
"NameAndKey",
"NameAndTableKey"
]
},
"eventActionFormat": {
"type": "string",
"title": "The formatting for the Action when an Event is published via CDC.",
"description": "Defaults to 'None' (no formatting required, i.e. as-is).",
"enum": [
"None",
"PastTense"
]
},
"eventSourceKind": {
"type": "string",
"title": "The URI kind for the event source URIs for CDC.",
"description": "Defaults to 'Relative' (being a relative path).",
"enum": [
"None",
"Absolute",
"Relative",
"RelativeOrAbsolute"
]
},
"eventSourceRoot": {
"type": "string",
"title": "The URI root for the event source by prepending to all event source URIs for CDC.",
"description": "The event source is only updated where an 'EventSourceKind' is not 'None'."
},
"eventSourceFormat": {
"type": "string",
"title": "The default formatting for the Source when an Event is published via CDC.",
"description": "Defaults to 'NameAndTableKey' (being the child 'Cdc.ModelName' appended with the corresponding table key).",
"enum": [
"NameOnly",
"NameAndKey",
"NameAndTableKey"
]
},
"eventTypeRoot": {
"type": "string",
"title": "The root for the event type by prepending to all event type names via CDC.",
"description": "Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc. Defaults to 'EventSubjectRoot'."
},
"outbox": {
"type": "boolean",
"title": "Indicates whether to generate the event outbox SQL and .NET artefacts.",
"description": "Defaults to 'false'."
},
"outboxSchema": {
"type": "string",
"title": "The schema name of the event outbox table.",
"description": "Defaults to 'Outbox' (literal)."
},
"outboxSchemaCreate": {
"type": "boolean",
"title": "Indicates whether to create the 'OutboxSchema' within the database.",
"description": "Defaults to 'false'."
},
"outboxTable": {
"type": "string",
"title": "The name of the event outbox table.",
"description": "Defaults to 'EventOutbox' (literal)."
},
"outboxEnqueueStoredProcedure": {
"type": "string",
"title": "The stored procedure name for the event outbox enqueue.",
"description": "Defaults to 'spEventOutboxEnqueue' (literal)."
},
"outboxDequeueStoredProcedure": {
"type": "string",
"title": "The stored procedure name for the event outbox dequeue.",
"description": "Defaults to 'spEventOutboxDequeue' (literal)."
},
"pathBase": {
"type": "string",
"title": "The base path (directory) prefix for the Database-related artefacts; other 'Path*' properties append to this value when they are not specifically overridden.",
"description": "Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'."
},
"pathDatabase": {
"type": "string",
"title": "The path (directory) for the Schema Database-related artefacts.",
"description": "Defaults to 'PathBase' + '.Database' (literal). For example 'Avanade.Application.Database'."
},
"pathDatabaseSchema": {
"type": "string",
"title": "The path (directory) for the Schema Database-related artefacts.",
"description": "Defaults to 'PathDatabase' + '/Schema' (literal). For example 'Avanade.Application.Database/Schema'."
},
"pathDatabaseMigrations": {
"type": "string",
"title": "The path (directory) for the Schema Database-related artefacts.",
"description": "Defaults to 'PathDatabase' + '/Migrations' (literal). For example 'Avanade.Application.Database/Migrations'."
},
"pathDotNetPublisher": {
"type": "string",
"title": "The path (directory) for the CDC-related (.NET) artefacts.",
"description": "Defaults to 'PathBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'."
},
"namespaceBase": {
"type": "string",
"title": "The base Namespace (root) for the .NET artefacts.",
"description": "Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'."
},
"namespacePublisher": {
"type": "string",
"title": "The Namespace (root) for the CDC-related Publisher .NET artefacts.",
"description": "Defaults to 'NamespaceBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'."
},
"namespaceOutbox": {
"type": "string",
"title": "The Namespace (root) for the Outbox-related Publisher .NET artefacts.",
"description": "Defaults to 'NamespacePublisher'."
},
"tables": {
"type": "array",
"title": "The corresponding 'Table' collection.",
"description": "A 'Table' object provides the primary database table configuration for Change Data Capture (CDC), including multiple child table joins to form a composite entity.",
"items": {
"$ref": "#/definitions/Table"
}
}
}
},
"Table": {
"type": "object",
"title": "'Table' object (database-driven)",
"description": "The 'Table' object enables the definition of the primary table, one-or-more child tables and their respective join relationships, to enable Change Data Capture (CDC) event publishing. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.",
"properties": {
"name": {
"type": "string",
"title": "The name of the primary table."
},
"schema": {
"type": "string",
"title": "The default schema name used where not otherwise explicitly specified.",
"description": "Defaults to 'Root.Schema'."
},
"table": {
"type": "string",
"title": "The name of the primary table.",
"description": "Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness)."
},
"alias": {
"type": "string",
"title": "The table alias name (must be unique).",
"description": "Will automatically default where not specified; for example a table named 'Person' will default to 'p'."
},
"includeColumns": {
"type": "array",
"title": "The list of 'Column' names to be included in the underlying generated output.",
"description": "Where not specified this indicates that all 'Columns' are to be included.",
"items": {
"type": "string"
}
},
"excludeColumns": {
"type": "array",
"title": "The list of 'Column' names to be excluded from the underlying generated output.",
"description": "Where not specified this indicates no 'Columns' are to be excluded.",
"items": {
"type": "string"
}
},
"aliasColumns": {
"type": "array",
"title": "The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column aliasing/renaming.",
"description": "Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'.",
"items": {
"type": "string"
}
},
"executeStoredProcedure": {
"type": "string",
"title": "The 'CDC' _execute_ batch stored procedure name.",
"description": "Defaults to 'sp' (literal) + 'Name' + 'BatchExecute' (literal); e.g. 'spNameBatchExecute'."
},
"completeStoredProcedure": {
"type": "string",
"title": "The 'CDC' _complete_ batch stored procedure name.",
"description": "Defaults to 'sp' (literal) + 'Name' + 'BatchComplete' (literal); e.g. 'spNameBatchComplete'."
},
"cdcSchema": {
"type": "string",
"title": "The schema name for the generated 'CDC'-related database artefacts.",
"description": "Defaults to 'Root.CdcSchema'."
},
"batchTrackingTable": {
"type": "string",
"title": "The corresponding 'CDC' Batch tracking table name.",
"description": "Defaults to 'Name' + 'BatchTracking' (literal)."
},
"cdcEnable": {
"type": "boolean",
"title": "Indicates whether to enable 'Cdc' within the database for the tables that participate.",
"description": "Defaults to 'false'. This option can be overridden for each underlying table referenced."
},
"model": {
"type": "string",
"title": "The .NET model name.",
"description": "Defaults to 'Name'."
},
"orchestratorCtorParams": {
"type": "array",
"title": "The list of additional (non-default) Dependency Injection (DI) parameters for the generated CDC 'Orchestrator' constructor.",
"description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred.",
"items": {
"type": "string"
}
},
"database": {
"type": "string",
"title": "The .NET database 'IDatabase' Type name used in the constructor for Dependency Injection (DI).",
"description": "Defaults to 'IDatabase'."
},
"includeColumnsOnDelete": {
"type": "array",
"title": "The list of 'Column' names that should be included (in addition to the primary key) for a logical delete.",
"description": "Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.",
"items": {
"type": "string"
}
},
"service": {
"type": "string",
"title": "The type of service that manages the underlying orchestrator.",
"description": "Defaults to 'Root.Service'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.",
"enum": [
"None",
"HostedService",
"Service"
]
},
"excludeColumnsFromETag": {
"type": "array",
"title": "The list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking).",
"description": "Defaults to 'Root.CdcExcludeColumnsFromETag'.",
"items": {
"type": "string"
}
},
"tenantIdColumns": {
"type": "array",
"title": "The list of 'Column' names that represent the tenant identifier.",
"items": {
"type": "string"
}
},
"partitionKey": {
"type": "string",
"title": "The partition key.",
"description": "A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'."
},
"partitionKeyColumns": {
"type": "array",
"title": "The list of 'Column' names that represent the partition key.",
"description": "A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'.",
"items": {
"type": "string"
}
},
"eventSource": {
"type": "string",
"title": "The Event Source.",
"description": "Defaults to 'Schema' + '/' (literal) + 'Name' (as lowercase). Note: when used in code-generation the 'Root.EventSourceRoot' will be prepended where specified."
},
"eventSourceFormat": {
"type": "string",
"title": "The default formatting for the Source when an Event is published.",
"description": "Defaults to 'Root.EventSourceFormat'.",
"enum": [
"NameOnly",
"NameAndKey",
"NameAndTableKey"
]
},
"eventSubject": {
"type": "string",
"title": "The Event Subject.",
"description": "Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventSubjectRoot' will be prepended where specified."
},
"eventSubjectFormat": {
"type": "string",
"title": "The default formatting for the Subject when an Event is published.",
"description": "Defaults to 'Root.EventSubjectFormat'.",
"enum": [
"NameOnly",
"NameAndKey",
"NameAndTableKey"
]
},
"eventType": {
"type": "string",
"title": "The Event Type.",
"description": "Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventTypeRoot' will be prepended where specified."
},
"identifierMapping": {
"type": "boolean",
"title": "Indicates whether to perform Identifier Mapping (mapping to 'GlobalId') for the primary key.",
"description": "This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s)."
},
"identifierName": {
"type": "string",
"title": "The JSON name for the 'GlobalId' property where 'IdentifierMapping' is 'true'. Defaults to 'globalId'.",
"description": "This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s)."
},
"isDeletedColumn": {
"type": "string",
"title": "The column name for the 'IsDeleted' (logical delete) capability (if any).",
"description": "Defaults to 'Root.ColumnIsDeleted'."
},
"joins": {
"type": "array",
"title": "The corresponding 'Join' collection.",
"description": "A 'Join' object provides the configuration for a table join.",
"items": {
"$ref": "#/definitions/Join"
}
},
"where": {
"type": "array",
"title": "The corresponding 'Where' collection.",
"description": "A 'Where' object provides the configuration for a table where clause.",
"items": {
"$ref": "#/definitions/Where"
}
},
"mappings": {
"type": "array",
"title": "The corresponding 'TableMapping' collection.",
"items": {
"$ref": "#/definitions/TableMapping"
}
}
},
"required": [
"name"
]
},
"Join": {
"type": "object",
"title": "'Join' object (database-driven)",
"description": "The 'Join' object defines a join to another (or same) table within the logical CDC entity. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.",
"properties": {
"name": {
"type": "string",
"title": "The unique name.",
"description": "A unique name is required where the same 'Table' is referenced more than once within a logical CDC entity. However, generally, this will represent the unique name of the table within the database."
},
"schema": {
"type": "string",
"title": "The schema name of the table to join.",
"description": "Defaults to 'Cdc.Schema'; i.e. same schema."
},
"table": {
"type": "string",
"title": "The name of the table to join.",
"description": "Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness)."
},
"alias": {
"type": "string",
"title": "The 'Schema' and 'Table' alias name.",
"description": "Will automatically default where not specified."
},
"type": {
"type": "string",
"title": "The SQL join type.",
"description": "Defaults to 'Cdc'. The 'Cdc' value indicates this is a related secondary table (within a logical CDC entity) that also has Change Data Capture turned on and equally needs to be monitored for changes.",
"enum": [
"Cdc",
"Inner",
"Left",
"Right",
"Full"
]
},
"joinTo": {
"type": "string",
"title": "The name of the table to join to (must be previously specified).",
"description": "Defaults to parent 'Table.Name'."
},
"joinCardinality": {
"type": "string",
"title": "The join cardinality being whether there is a One-to-Many or One-to-One relationship.",
"description": "Defaults to 'OneToMany'. This represents the Parent ('JoinTo') to child (_this_) relationship.",
"enum": [
"OneToMany",
"OneToOne"
]
},
"cdcEnable": {
"type": "boolean",
"title": "Indicates whether to enable 'Cdc' within the database for the tables that participate.",
"description": "Defaults to 'false'. This option can be overridden for each underlying table referenced."
},
"querySizeMultiplier": {
"type": "number",
"title": "The query size multiplier for the CDC-Join.",
"description": "Defaults to '1.0'. This is applied to the execute stored procedure '@MaxQuerySize' parameter to allow tailoring on the join query ('TOP') sizes to optimize selection. Must be greater than zero and less than or equal to 100."
},
"includeColumns": {
"type": "array",
"title": "The list of 'Column' names to be included in the underlying generated output.",
"description": "Where not specified this indicates that all 'Columns' are to be included.",
"items": {
"type": "string"
}
},
"excludeColumns": {
"type": "array",
"title": "The list of 'Column' names to be excluded from the underlying generated output.",
"description": "Where not specified this indicates no 'Columns' are to be excluded.",
"items": {
"type": "string"
}
},
"aliasColumns": {
"type": "array",
"title": "The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column renaming.",
"description": "Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'",
"items": {
"type": "string"
}
},
"model": {
"type": "string",
"title": "The .NET model name.",
"description": "Defaults to 'Name'."
},
"property": {
"type": "string",
"title": "The .NET property name.",
"description": "Defaults to 'Model' where 'JoinCardinality' is 'OneToOne'; otherwise, it will be the 'Model' pluralized."
},
"includeColumnsOnDelete": {
"type": "array",
"title": "The list of 'Column' names that should be included (in addition to the primary key) for a logical delete.",
"description": "Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.",
"items": {
"type": "string"
}
},
"excludeColumnsFromETag": {
"type": "array",
"title": "The list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking).",
"description": "Defaults to 'CodeGeneration.CdcExcludeColumnsFromETag'.",
"items": {
"type": "string"
}
},
"identifierMapping": {
"type": "boolean",
"title": "Indicates whether to perform Identifier Mapping (mapping to 'GlobalId') for the primary key.",
"description": "This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s)."
},
"identifierName": {
"type": "string",
"title": "The JSON name for the 'GlobalId' property where 'IdentifierMapping' is 'true'. Defaults to 'globalId'.",
"description": "This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s)."
},
"on": {
"type": "array",
"title": "The corresponding 'JoinOn' collection.",
"items": {
"$ref": "#/definitions/JoinOn"
}
},
"mappings": {
"type": "array",
"title": "The corresponding 'JoinMapping' collection.",
"items": {
"$ref": "#/definitions/JoinMapping"
}
}
},
"required": [
"name"
]
},
"JoinOn": {
"type": "object",
"title": "'JoinOn' object (database-driven)",
"description": "The 'JoinOn' object defines the join on characteristics for a 'Join' object.",
"properties": {
"name": {
"type": "string",
"title": "The name of the join column (from the 'Join' table)."
},
"toColumn": {
"type": "string",
"title": "The name of the join to column.",
"description": "Defaults to 'Name'; i.e. assumes same name."
},
"toStatement": {
"type": "string",
"title": "The SQL statement for the join on bypassing the corresponding 'ToColumn' specification."
}
},
"required": [
"name"
]
},
"JoinMapping": {
"type": "object",
"title": "'JoinMapping' object (database-driven)",
"description": "The 'JoinMapping' object defines one or more related table identifier mappings.",
"properties": {
"name": {
"type": "string",
"title": "The name of of the existing column that requires identifier mapping."
},
"schema": {
"type": "string",
"title": "The schema name of the related table.",
"description": "Defaults to the owning (parent) table schema."
},
"table": {
"type": "string",
"title": "The name of the related table."
}
},
"required": [
"name",
"table"
]
},
"Where": {
"type": "object",
"title": "'Where' object (database-driven)",
"description": "This should only be used where the column value is largely immutable; otherwise, unintended side-effects may occur. _NTangle_ uses the condition explictily and does not attempt to handle value change to infer creation or deletion of data as a result of the underlying change; as such, this should be used cautiously. Note that the 'where' is applied when querying the 'cdc.fn_cdc_get_all_changes_...' function, not the underlying table itself.",
"properties": {
"name": {
"type": "string",
"title": "The column name.",
"description": "The column name."
},
"nullable": {
"type": "string",
"title": "The where nullability clause operator",
"description": "This enables statements such as 'WHERE (COL IS NULL)' or 'WHERE (COL IS NULL OR COL = VALUE)' (where .",
"enum": [
"ISNULL",
"ISNOTNULL"
]
},
"operator": {
"type": "string",
"title": "The where clause equality operator",
"description": "Defaults to 'EQ' where 'Value' is specified.",
"enum": [
"EQ",
"NE",
"LT",
"LE",
"GT",
"GE",
"LIKE"
]
},
"value": {
"type": "string",
"title": "The comparison value",
"description": "This must be valid formatted/escaped SQL."
}
},
"required": [
"name"
]
},
"TableMapping": {
"type": "object",
"title": "'TableMapping' object (database-driven)",
"description": "The 'TableMapping' object defines one or more related table identifier mappings.",
"properties": {
"name": {
"type": "string",
"title": "The name of of the existing column that requires identifier mapping."
},
"schema": {
"type": "string",
"title": "The schema name of the related table.",
"description": "Defaults to the owning (parent) table schema."
},
"table": {
"type": "string",
"title": "The name of the related table."
}
},
"required": [
"name",
"table"
]
}
},
"allOf": [
{
"$ref": "#/definitions/Root"
}
]
} |
mycode.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"classification": {
"enum": ["MyCode", "LibraryCode", "UnrelatedCode"]
},
"includes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"id": "https://json.schemastore.org/mycode.json",
"properties": {
"Eval": {
"description": "Script that is executed by passing a string to the host-provided eval function.",
"default": "MyCode",
"allOf": [
{
"$ref": "#/definitions/classification"
}
]
},
"Function": {
"description": "Script that is executed by passing a string to the 'Function' constructor.",
"default": "LibraryCode",
"allOf": [
{
"$ref": "#/definitions/classification"
}
]
},
"ScriptBlock": {
"description": "Script that is executed by passing a string to the 'setTimeout', 'setImmediate', or 'setInterval' functions.",
"default": "UnrelatedCode",
"allOf": [
{
"$ref": "#/definitions/classification"
}
]
},
"MyCode": {
"description": "An array of urls or files that are classified as 'MyCode'.",
"allOf": [
{
"$ref": "#/definitions/includes"
}
]
},
"Libraries": {
"description": "An array of urls or files that are classified as 'LibraryCode'.",
"allOf": [
{
"$ref": "#/definitions/includes"
}
]
},
"Unrelated": {
"description": "An array of urls or files that are classified as 'UnrelatedCode'.",
"allOf": [
{
"$ref": "#/definitions/includes"
}
]
}
},
"title": "JSON schema for mycode.js files",
"type": "object"
}
|
nlu.schema.json | {
"title": "JSON schema for NLU (npm-link-up) library.",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"oneOf": [
{ "required": ["list"] },
{ "required": ["packages"] },
{ "required": ["deps"] }
],
"definitions": {
"PackagesMap": {
"additionalProperties": {
},
"type": "object"
}
},
"properties": {
"$schema": {
"type": "string"
},
"alwaysReinstall": {
"type": "boolean"
},
"comments": {
"items": {
"type": "string"
},
"type": "array"
},
"deps": {
"items": {
"type": "string"
},
"type": "array"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"linkToItself": {
"type": "boolean"
},
"linkable": {
"enum": [
true
],
"type": "boolean"
},
"list": {
"items": {
"type": "string"
},
"type": "array"
},
"localSettings": {
"additionalProperties": {
},
"type": "object"
},
"npm-link-up": {
"type": "boolean"
},
"packages": {
"$ref": "#/definitions/PackagesMap"
},
"searchRoots": {
"items": {
"type": "string"
},
"type": "array"
}
}
}
|
mimetypes.json | {
"$id": "https://json.schemastore.org/mimetypes.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"patternProperties": {
"^\\..+$": {
"description": "A file extension",
"pattern": "^[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_.]+$",
"type": "string",
"examples": ["application/json"]
}
},
"title": "Mime types",
"type": "object"
}
|
ort-configuration-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://oss-review-toolkit.org/ort-configuration.yml",
"title": "ORT configuration",
"description": "The main configuration file for the OSS-Review-Toolkit (ORT). A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/resources/reference.yml.",
"type": "object",
"properties": {
"ort": {
"properties": {
"licenseFilePatterns": {
"$ref": "#/definitions/LicenseFilePatterns"
},
"severeIssueThreshold": {
"$ref": "#/definitions/Severity"
},
"severeRuleViolationThreshold": {
"$ref": "#/definitions/Severity"
},
"enableRepositoryPackageCurations": {
"type": "boolean"
},
"enableRepositoryPackageConfigurations": {
"type": "boolean"
},
"analyzer": {
"$ref": "#/definitions/Analyzer"
},
"advisor": {
"$ref": "#/definitions/Advisor"
},
"downloader": {
"$ref": "#/definitions/Downloader"
},
"scanner": {
"$ref": "#/definitions/Scanner"
},
"reporter": {
"$ref": "#/definitions/Reporter"
},
"notifier": {
"$ref": "#/definitions/Notifier"
}
}
}
},
"required": [
"ort"
],
"definitions": {
"Advisor": {
"type": "object",
"additionalProperties": false,
"properties": {
"nexusIq": {
"$ref": "#/definitions/NexusIq"
},
"ossIndex": {
"$ref": "#/definitions/OssIndex"
},
"vulnerableCode": {
"$ref": "#/definitions/VulnerableCode"
},
"gitHubDefects": {
"$ref": "#/definitions/GitHubDefects"
},
"osv": {
"$ref": "#/definitions/Osv"
},
"options": {
"$ref": "#/definitions/AdvisorOptions"
}
}
},
"GitHubDefects": {
"type": "object",
"additionalProperties": false,
"properties": {
"token": {
"type": "string"
},
"labelFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"maxNumberOfIssuesPerRepository": {
"type": "integer"
},
"parallelRequests": {
"type": "integer"
}
},
"required": [
"labelFilter"
]
},
"NexusIq": {
"type": "object",
"additionalProperties": false,
"properties": {
"serverUrl": {
"type": "string",
"format": "uri"
},
"browseUrl": {
"type": "string",
"format": "uri"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"serverUrl"
]
},
"OssIndex": {
"type": "object",
"additionalProperties": false,
"properties": {
"serverUrl": {
"type": "string",
"format": "uri"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"AdvisorOptions": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"CustomAdvisor": {
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
},
"Osv": {
"type": "object",
"additionalProperties": false,
"properties": {
"serverUrl": {
"type": "string",
"format": "uri"
}
}
},
"VulnerableCode": {
"type": "object",
"additionalProperties": false,
"properties": {
"serverUrl": {
"type": "string",
"format": "uri"
},
"apiKey": {
"type": "string"
}
},
"required": [
"serverUrl"
]
},
"Analyzer": {
"$ref": "https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/analyzer-configuration-schema.json"
},
"Downloader": {
"type": "object",
"additionalProperties": false,
"properties": {
"allowMovingRevisions": {
"type": "boolean"
},
"includedLicenseCategories": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceCodeOrigins": {
"type": "array",
"items": {
"$ref": "#/definitions/SourceCodeOrigins"
}
}
}
},
"LicenseFilePatterns": {
"type": "object",
"additionalProperties": false,
"properties": {
"licenseFilenames": {
"type": "array",
"items": {
"type": "string"
}
},
"patentFilenames": {
"type": "array",
"items": {
"type": "string"
}
},
"rootLicenseFilenames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Notifier": {
"type": "object",
"additionalProperties": false,
"properties": {
"mail": {
"$ref": "#/definitions/Mail"
},
"jira": {
"$ref": "#/definitions/Jira"
}
}
},
"Jira": {
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"Mail": {
"type": "object",
"additionalProperties": false,
"properties": {
"hostName": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"type": "integer"
},
"useSsl": {
"type": "boolean"
},
"fromAddress": {
"type": "string"
}
}
},
"Reporter": {
"type": "object",
"additionalProperties": false,
"properties": {
"options": {
"$ref": "#/definitions/ReporterOptions"
}
},
"required": [
"options"
]
},
"ReporterOptions": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"Scanner": {
"type": "object",
"additionalProperties": false,
"properties": {
"skipConcluded": {
"type": "boolean"
},
"archive": {
"$ref": "#/definitions/Archive"
},
"createMissingArchives": {
"type": "boolean"
},
"detectedLicenseMapping": {
"$ref": "#/definitions/DetectedLicenseMapping"
},
"fileListStorage": {
"$ref": "#/definitions/FileListStorage"
},
"options": {
"$ref": "#/definitions/ScannerOptions"
},
"storages": {
"$ref": "#/definitions/Storages"
},
"storageReaders": {
"type": "array",
"items": {
"$ref": "#/definitions/StorageTypes"
}
},
"storageWriters": {
"type": "array",
"items": {
"$ref": "#/definitions/StorageTypes"
}
},
"ignorePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"provenanceStorage": {
"$ref": "#/definitions/ProvenanceStorage"
}
}
},
"Archive": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"fileStorage": {
"$ref": "#/definitions/FileStorage"
},
"postgresStorage": {
"$ref": "#/definitions/PostgresConfig"
}
}
},
"FileListStorage": {
"type": "object",
"additionalProperties": false,
"properties": {
"fileStorage": {
"$ref": "#/definitions/FileStorage"
},
"postgresStorage": {
"$ref": "#/definitions/PostgresConfig"
}
}
},
"FileStorage": {
"type": "object",
"additionalProperties": false,
"properties": {
"localFileStorage": {
"$ref": "#/definitions/LocalFileStorage"
},
"httpFileStorage": {
"§ref": "#/definitions/HttpFileStorage"
}
},
"required": [
"localFileStorage"
]
},
"LocalFileStorage": {
"type": "object",
"additionalProperties": false,
"properties": {
"directory": {
"type": "string"
},
"compression": {
"type": "boolean"
}
},
"required": [
"directory"
]
},
"HttpFileStorage": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"query": {
"type": "string"
},
"headers": {
"$ref": "#/definitions/Headers"
}
},
"required": [
"url"
]
},
"PostgresConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/definitions/Connection"
}
},
"required": [
"connection"
]
},
"Connection": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"schema": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"sslmode": {
"type": "string"
},
"sslcert": {
"type": "string"
},
"sslkey": {
"type": "string"
},
"sslrootcert": {
"type": "string"
},
"parallelTransactions": {
"type": "integer"
}
},
"required": [
"url",
"username"
]
},
"DetectedLicenseMapping": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"ScannerOptions": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"ProvenanceStorage": {
"type": "object",
"additionalProperties": false,
"properties": {
"fileStorage": {
"$ref": "#/definitions/FileStorage"
},
"postgresStorage": {
"$ref": "#/definitions/PostgresConfig"
}
}
},
"Storages": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"Severity": {
"enum": [
"HINT",
"WARNING",
"ERROR"
]
},
"SourceCodeOrigins": {
"enum": [
"ARTIFACT",
"VCS"
]
},
"StorageTypes": {
"enum": [
"clearlyDefined",
"http",
"local",
"postgres"
]
},
"Headers": {
"type": "object",
"additionalProperties": {
"type": [
"boolean",
"number",
"string"
]
}
}
}
}
|
codeship-services.json | {
"$id": "https://json.schemastore.org/codeship-services.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {
"$ref": "#/definitions/ExternalService"
},
"definitions": {
"ExternalService": {
"title": "CodeShip Pro Service",
"description": "The definition of a service in a CodeShip Pro build, which can have steps run on it or have other services depend on it",
"properties": {
"add_docker": {
"description": "If true, the docker socket will be exposed in this service.",
"default": false,
"type": "boolean"
},
"build": {
"description": "How to build the image for this service. Mutually exclusive with 'image'. Can either be just a path containing a Dockerfile, or a build definition.",
"oneOf": [
{
"$ref": "#/definitions/externalBuild"
},
{
"type": "string"
}
]
},
"cached": {
"description": "Whether the image for this service should be rebuilt from scratch for each run, or if the latest build of the service's image from the configured cache branch (defaulting to 'master') should be used.",
"default": false,
"type": "boolean"
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array"
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "The command to run when launching the service, overriding the 'CMD' in the image. Optional.",
"type": "string"
},
"cpuset": {
"type": "string"
},
"cpu_shares": {
"type": "integer"
},
"default_cache_branch": {
"description": "The branch to use for caching. Defaults to 'master'",
"type": "string"
},
"dns": {
"items": {
"type": "string"
},
"type": "array"
},
"dns_search": {
"items": {
"type": "string"
},
"type": "array"
},
"dockercfg_service": {
"description": "The name of another defined service that provides the Docker configuration for building and running this service. Optional.",
"type": "string"
},
"dockerfile": {
"description": "A specific Dockerfile to use, rather than the one in the build context",
"type": "string"
},
"domainname": {
"type": "string"
},
"encrypted_dockercfg_path": {
"description": "The location of a Docker configuration file encrypted by Jet to be used with building and running this service. Optional.",
"type": "string"
},
"encrypted_env_file": {
"description": "The location of one or more files, encrypted with Jet, containing environment variables to be made available to this service and steps running on it. Optional.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"encrypted_environment": {
"description": "A list of encrypted key/value pairs to be used in the environment for this service and steps running on it. Optional.",
"items": {
"type": "string"
},
"type": "array"
},
"entrypoint": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"env_file": {
"description": "The location of one or more files containing environment variables to be made available to this service and steps running on it. Optional.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"environment": {
"description": "Either a map of key/value pairs or a list of 'KEY=VALUE' pairs to be used in the environment for this service and steps running on it. Optional.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "object",
"additionalProperties": true
}
]
},
"expose": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_hosts": {
"items": {
"type": "string"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"image": {
"description": "A pre-existing image to use for this service. Mutually exclusive with 'build'",
"type": "string"
},
"links": {
"items": {
"type": "string"
},
"type": "array"
},
"depends_on": {
"description": "A list of other services that this service depends on. Use this instead of 'links'",
"items": {
"type": "string"
},
"type": "array"
},
"mem_limit": {
"type": "string"
},
"privileged": {
"type": "boolean"
},
"ports": {
"description": "A list of ports that should be exposed to other services. The ports should be defined like '9999', as strings",
"items": {
"type": "string"
},
"type": "array"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes": {
"description": "A list of origin/destination pairs of directories or files relative to the build context and where they should be mounted in the service. Optional.",
"items": {
"type": "string"
},
"type": "array"
},
"volumes_from": {
"description": "A list of other services which should have their defined volumes mounted into this service as well. Optional.",
"items": {
"type": "string"
},
"type": "array"
},
"working_dir": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object",
"oneOf": [
{
"required": ["build"]
},
{
"required": ["image"]
}
]
},
"externalBuild": {
"title": "Image Build",
"description": "Configuration of how to build the image for this service",
"properties": {
"path": {
"description": "DEPRECATED: Use 'context' instead.",
"type": "string"
},
"dockerfile_path": {
"description": "DEPRECATED: Use 'dockerfile' instead",
"type": "string"
},
"image": {
"description": "The output image name for this image. Optional.",
"type": "string"
},
"context": {
"description": "The directory used as the Docker build context. Defaults to the same directory as the codeship-services.yml file",
"type": "string"
},
"dockerfile": {
"description": "A specific Dockerfile to use rather than the 'Dockerfile' present in the build context. Optional.",
"type": "string"
},
"configure": {
"$ref": "#/definitions/externalBuildConfigure"
},
"args": {
"description": "Build args to pass to Docker. Optional.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "object",
"additionalProperties": true
}
]
},
"encrypted_args_file": {
"description": "One or more files, encrypted with Jet, to have their contents decrypted and passed to Docker as build args. Optional.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"encrypted_args": {
"description": "A list of encrypted key/value pairs to be used as build args to Docker. Optional.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
}
},
"additionalProperties": false,
"type": "object"
},
"externalBuildConfigure": {
"properties": {
"service": {
"type": "string"
},
"command": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
},
"description": "codeship-services.yml is where you configure each service you need to run your CI/CD builds with CodeShip.",
"title": "CodeShip Pro services configuration",
"type": "object"
}
|
winget-pkgs-singleton-1.0.0.json | {
"$id": "https://aka.ms/winget-manifest.singleton.1.0.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"PackageIdentifier": {
"type": "string",
"pattern": "^[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}(\\.[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}){1,3}$",
"maxLength": 128,
"description": "The package unique identifier"
},
"PackageVersion": {
"type": "string",
"pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
"maxLength": 128,
"description": "The package version"
},
"Locale": {
"type": ["string", "null"],
"pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$",
"maxLength": 20,
"description": "The package meta-data locale"
},
"Url": {
"type": ["string", "null"],
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
"maxLength": 2000,
"description": "Optional Url type"
},
"Tag": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 40,
"description": "Package moniker or tag"
},
"Channel": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 16,
"description": "The distribution channel"
},
"Platform": {
"type": ["array", "null"],
"items": {
"title": "Platform",
"type": "string",
"enum": ["Windows.Desktop", "Windows.Universal"]
},
"maxItems": 2,
"uniqueItems": true,
"description": "The installer supported operating system"
},
"MinimumOSVersion": {
"type": ["string", "null"],
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){0,3}$",
"description": "The installer minimum operating system version"
},
"InstallerType": {
"type": ["string", "null"],
"enum": [
"msix",
"msi",
"appx",
"exe",
"zip",
"inno",
"nullsoft",
"wix",
"burn",
"pwa"
],
"description": "Enumeration of supported installer types"
},
"Scope": {
"type": ["string", "null"],
"enum": ["user", "machine"],
"description": "Scope indicates if the installer is per user or per machine"
},
"InstallModes": {
"type": ["array", "null"],
"items": {
"title": "InstallModes",
"type": "string",
"enum": ["interactive", "silent", "silentWithProgress"]
},
"maxItems": 3,
"uniqueItems": true,
"description": "List of supported installer modes"
},
"InstallerSwitches": {
"type": "object",
"properties": {
"Silent": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 512,
"description": "Silent is the value that should be passed to the installer when user chooses a silent or quiet install"
},
"SilentWithProgress": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 512,
"description": "SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install"
},
"Interactive": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 512,
"description": "Interactive is the value that should be passed to the installer when user chooses an interactive install"
},
"InstallLocation": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 512,
"description": "InstallLocation is the value passed to the installer for custom install location. <INSTALLPATH> token can be included in the switch value so that winget will replace the token with user provided path"
},
"Log": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 512,
"description": "Log is the value passed to the installer for custom log file path. <LOGPATH> token can be included in the switch value so that winget will replace the token with user provided path"
},
"Upgrade": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 512,
"description": "Upgrade is the value that should be passed to the installer when user chooses an upgrade"
},
"Custom": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 2048,
"description": "Custom switches will be passed directly to the installer by winget"
}
}
},
"InstallerSuccessCodes": {
"type": ["array", "null"],
"items": {
"type": "integer",
"not": {
"enum": [0]
}
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of additional non-zero installer success exit codes other than known default values by winget"
},
"UpgradeBehavior": {
"type": ["string", "null"],
"enum": ["install", "uninstallPrevious"],
"description": "The upgrade method"
},
"Commands": {
"type": ["array", "null"],
"items": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of commands or aliases to run the package"
},
"Protocols": {
"type": ["array", "null"],
"items": {
"type": "string",
"pattern": "^[a-z][-a-z0-9\\.\\+]*$",
"maxLength": 2048
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of protocols the package provides a handler for"
},
"FileExtensions": {
"type": ["array", "null"],
"items": {
"type": "string",
"pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
"maxLength": 40
},
"maxItems": 256,
"uniqueItems": true,
"description": "List of file extensions the package could support"
},
"Dependencies": {
"type": ["object", "null"],
"properties": {
"WindowsFeatures": {
"type": ["array", "null"],
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of Windows feature dependencies"
},
"WindowsLibraries": {
"type": ["array", "null"],
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of Windows library dependencies"
},
"PackageDependencies": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"PackageIdentifier": {
"$ref": "#/definitions/PackageIdentifier"
},
"MinimumVersion": {
"$ref": "#/definitions/PackageVersion"
}
},
"required": ["PackageIdentifier"]
},
"maxItems": 16,
"description": "List of package dependencies from current source"
},
"ExternalDependencies": {
"type": ["array", "null"],
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of external package dependencies"
}
}
},
"PackageFamilyName": {
"type": ["string", "null"],
"pattern": "^[A-Za-z0-9][-\\.A-Za-z0-9]+_[A-Za-z0-9]{13}$",
"maxLength": 255,
"description": "PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources"
},
"ProductCode": {
"type": ["string", "null"],
"minLength": 1,
"maxLength": 255,
"description": "ProductCode could be used for correlation of packages across sources"
},
"Capabilities": {
"type": ["array", "null"],
"items": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"maxItems": 1000,
"uniqueItems": true,
"description": "List of appx or msix installer capabilities"
},
"RestrictedCapabilities": {
"type": ["array", "null"],
"items": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"maxItems": 1000,
"uniqueItems": true,
"description": "List of appx or msix installer restricted capabilities"
},
"Installer": {
"type": "object",
"properties": {
"InstallerLocale": {
"$ref": "#/definitions/Locale"
},
"Platform": {
"$ref": "#/definitions/Platform"
},
"MinimumOSVersion": {
"$ref": "#/definitions/MinimumOSVersion"
},
"Architecture": {
"type": "string",
"enum": ["x86", "x64", "arm", "arm64", "neutral"],
"description": "The installer target architecture"
},
"InstallerType": {
"$ref": "#/definitions/InstallerType"
},
"Scope": {
"$ref": "#/definitions/Scope"
},
"InstallerUrl": {
"type": "string",
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
"description": "The installer Url"
},
"InstallerSha256": {
"type": "string",
"pattern": "^[A-Fa-f0-9]{64}$",
"description": "Sha256 is required. Sha256 of the installer"
},
"SignatureSha256": {
"type": ["string", "null"],
"pattern": "^[A-Fa-f0-9]{64}$",
"description": "SignatureSha256 is recommended for appx or msix. It is the sha256 of signature file inside appx or msix. Could be used during streaming install if applicable"
},
"InstallModes": {
"$ref": "#/definitions/InstallModes"
},
"InstallerSwitches": {
"$ref": "#/definitions/InstallerSwitches"
},
"InstallerSuccessCodes": {
"$ref": "#/definitions/InstallerSuccessCodes"
},
"UpgradeBehavior": {
"$ref": "#/definitions/UpgradeBehavior"
},
"Commands": {
"$ref": "#/definitions/Commands"
},
"Protocols": {
"$ref": "#/definitions/Protocols"
},
"FileExtensions": {
"$ref": "#/definitions/FileExtensions"
},
"Dependencies": {
"$ref": "#/definitions/Dependencies"
},
"PackageFamilyName": {
"$ref": "#/definitions/PackageFamilyName"
},
"ProductCode": {
"$ref": "#/definitions/ProductCode"
},
"Capabilities": {
"$ref": "#/definitions/Capabilities"
},
"RestrictedCapabilities": {
"$ref": "#/definitions/RestrictedCapabilities"
}
},
"required": ["Architecture", "InstallerUrl", "InstallerSha256"]
}
},
"description": "A representation of a single-file manifest representing an app in the OWC. v1.0.0",
"properties": {
"PackageIdentifier": {
"$ref": "#/definitions/PackageIdentifier"
},
"PackageVersion": {
"$ref": "#/definitions/PackageVersion"
},
"PackageLocale": {
"type": "string",
"pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$",
"maxLength": 20,
"description": "The package meta-data locale"
},
"Publisher": {
"type": "string",
"minLength": 2,
"maxLength": 256,
"description": "The publisher name"
},
"PublisherUrl": {
"$ref": "#/definitions/Url",
"description": "The publisher home page"
},
"PublisherSupportUrl": {
"$ref": "#/definitions/Url",
"description": "The publisher support page"
},
"PrivacyUrl": {
"$ref": "#/definitions/Url",
"description": "The publisher privacy page or the package privacy page"
},
"Author": {
"type": ["string", "null"],
"minLength": 2,
"maxLength": 256,
"description": "The package author"
},
"PackageName": {
"type": "string",
"minLength": 2,
"maxLength": 256,
"description": "The package name"
},
"PackageUrl": {
"$ref": "#/definitions/Url",
"description": "The package home page"
},
"License": {
"type": "string",
"minLength": 3,
"maxLength": 512,
"description": "The package license"
},
"LicenseUrl": {
"$ref": "#/definitions/Url",
"description": "The license page"
},
"Copyright": {
"type": ["string", "null"],
"minLength": 3,
"maxLength": 512,
"description": "The package copyright"
},
"CopyrightUrl": {
"$ref": "#/definitions/Url",
"description": "The package copyright page"
},
"ShortDescription": {
"type": "string",
"minLength": 3,
"maxLength": 256,
"description": "The short package description"
},
"Description": {
"type": ["string", "null"],
"minLength": 3,
"maxLength": 10000,
"description": "The full package description"
},
"Moniker": {
"$ref": "#/definitions/Tag",
"description": "The most common package term"
},
"Tags": {
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/Tag"
},
"maxItems": 16,
"uniqueItems": true,
"description": "List of additional package search terms"
},
"Channel": {
"$ref": "#/definitions/Channel"
},
"InstallerLocale": {
"$ref": "#/definitions/Locale"
},
"Platform": {
"$ref": "#/definitions/Platform"
},
"MinimumOSVersion": {
"$ref": "#/definitions/MinimumOSVersion"
},
"InstallerType": {
"$ref": "#/definitions/InstallerType"
},
"Scope": {
"$ref": "#/definitions/Scope"
},
"InstallModes": {
"$ref": "#/definitions/InstallModes"
},
"InstallerSwitches": {
"$ref": "#/definitions/InstallerSwitches"
},
"InstallerSuccessCodes": {
"$ref": "#/definitions/InstallerSuccessCodes"
},
"UpgradeBehavior": {
"$ref": "#/definitions/UpgradeBehavior"
},
"Commands": {
"$ref": "#/definitions/Commands"
},
"Protocols": {
"$ref": "#/definitions/Protocols"
},
"FileExtensions": {
"$ref": "#/definitions/FileExtensions"
},
"Dependencies": {
"$ref": "#/definitions/Dependencies"
},
"PackageFamilyName": {
"$ref": "#/definitions/PackageFamilyName"
},
"ProductCode": {
"$ref": "#/definitions/ProductCode"
},
"Capabilities": {
"$ref": "#/definitions/Capabilities"
},
"RestrictedCapabilities": {
"$ref": "#/definitions/RestrictedCapabilities"
},
"Installers": {
"type": "array",
"items": {
"$ref": "#/definitions/Installer"
},
"minItems": 1,
"maxItems": 1
},
"ManifestType": {
"type": "string",
"default": "singleton",
"const": "singleton",
"description": "The manifest type"
},
"ManifestVersion": {
"type": "string",
"default": "1.0.0",
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
"description": "The manifest syntax version"
}
},
"required": [
"PackageIdentifier",
"PackageVersion",
"PackageLocale",
"Publisher",
"PackageName",
"License",
"ShortDescription",
"Installers",
"ManifestType",
"ManifestVersion"
],
"type": "object"
}
|
schema-app.json | {
"title": "JSON schema for Outblocks App configuration files",
"$schema": "http://json-schema.org/draft-07/schema",
"$ref": "#/definitions/OutblocksApp",
"definitions": {
"OutblocksApp": {
"title": "OutblocksApp",
"type": "object",
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the app. Defaults to directory name.",
"type": "string"
},
"type": {
"description": "Type of the app.",
"type": "string",
"enum": [
"static",
"function",
"service"
]
},
"env": {
"description": "Environment variables common for all operations.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"dir": {
"description": "Working directory of the app where all commands will be run. Defaults to location of this yaml. All other dirs will be relative to this one.",
"type": "string"
},
"url": {
"description": "External URL of the app.",
"type": "string"
},
"path_redirect": {
"description": "Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.",
"type": "string"
},
"needs": {
"description": "Application dependencies to inject.",
"$ref": "#/definitions/Needs"
},
"run": {
"description": "Run config used for dev builds during run.",
"$ref": "#/definitions/Run"
},
"cdn": {
"description": "CDN settings.",
"$ref": "#/definitions/CDN"
},
"build": {
"type": "object"
}
},
"required": [
"type"
],
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "static"
}
}
},
"then": {
"properties": {
"routing": {
"description": "Routing type. Defaults to 'react'.",
"type": "string",
"enum": [
"react",
"gatsby",
"disabled"
]
},
"remove_trailing_slash": {
"description": "Remove trailing slash with permanent redirect. Currently used only for deployments. Defaults to 'true' when gatsby routing is used, 'false' otherwise.",
"type": "boolean"
},
"basic_auth": {
"description": "Static application basic authentication config. Currently used only for deployments.",
"$ref": "#/definitions/StaticBasicAuth"
},
"build": {
"description": "Static application build config used for deployment builds.",
"$ref": "#/definitions/StaticBuild"
},
"deploy": {
"description": "Static deploy config.",
"$ref": "#/definitions/StaticDeploy"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "service"
}
}
},
"then": {
"properties": {
"private": {
"description": "Marks app as private - won't allow unauthenticated access.",
"type": "boolean"
},
"build": {
"description": "Service application build config used for deployment builds.",
"$ref": "#/definitions/ServiceBuild"
},
"container": {
"description": "Service application container config used for docker based deployments/runs.",
"$ref": "#/definitions/ServiceContainer"
},
"deploy": {
"description": "Service deploy config.",
"$ref": "#/definitions/ServiceDeploy"
},
"scheduler": {
"description": "Service scheduler config.",
"$ref": "#/definitions/Scheduler"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "function"
}
}
},
"then": {
"required": [
"type"
],
"properties": {
"private": {
"description": "Marks app as private - won't allow unauthenticated access.",
"type": "boolean"
},
"runtime": {
"description": "The runtime in which the function is going to run, refer to cloud provider docs for possible options.",
"type": "string"
},
"entrypoint": {
"description": "Name of the function that will be executed when the function is triggered. Not all deployment plugins support it. Defaults to application name.",
"type": "string"
},
"build": {
"description": "Function application build config used for deployment builds.",
"$ref": "#/definitions/FunctionBuild"
},
"deploy": {
"description": "Function deploy config.",
"$ref": "#/definitions/FunctionDeploy"
},
"package": {
"description": "Function package config.",
"$ref": "#/definitions/FunctionPackage"
},
"scheduler": {
"description": "Function scheduler config.",
"$ref": "#/definitions/Scheduler"
}
}
}
}
]
},
"Needs": {
"title": "Needs",
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"oneOf": [
{
"type": "null"
},
{
"type": "object"
}
]
}
}
},
"Run": {
"title": "Run config",
"type": "object",
"additionalProperties": true,
"properties": {
"plugin": {
"description": "Run plugin override. Defaults to first supported plugin available.",
"type": "string"
},
"command": {
"description": "Command to be run to for dev mode.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"port": {
"description": "Port override, by default just assigns next port starting from listen-port.",
"type": "integer"
},
"env": {
"description": "Additional environment variables available local run.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"StaticDeploy": {
"title": "Static deploy config",
"type": "object",
"additionalProperties": true,
"properties": {
"plugin": {
"description": "Deploy plugin override. Defaults to first supported plugin available.",
"type": "string"
},
"min_scale": {
"description": "Minimum scale of container deployment (used if deployment uses a container).",
"type": "integer"
},
"max_scale": {
"description": "Maximum scale of container deployment (used if deployment uses a container).",
"type": "integer"
},
"timeout": {
"description": "Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.",
"type": "integer"
},
"patterns": {
"description": "File/dir patterns to exclude (or force include if starts with '!').",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ServiceDeploy": {
"title": "Service deploy config",
"type": "object",
"additionalProperties": true,
"properties": {
"plugin": {
"description": "Deploy plugin override. Defaults to first supported plugin available.",
"type": "string"
},
"env": {
"description": "Additional environment variables.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"cpu_limit": {
"description": "CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.",
"type": "number"
},
"memory_limit": {
"description": "Memory limit in MiB of container deployment.",
"type": "integer"
},
"min_scale": {
"description": "Minimum scale of container deployment.",
"type": "integer"
},
"max_scale": {
"description": "Maximum scale of container deployment.",
"type": "integer"
},
"timeout": {
"description": "Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.",
"type": "integer"
},
"container": {
"description": "Service application container config used for docker based deployments.",
"$ref": "#/definitions/ServiceContainer"
}
}
},
"Scheduler": {
"title": "Scheduler config",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"cron"
],
"properties": {
"cron": {
"description": "Scheduler cron, e.g. */30 * * * * runs every 30 minutes.",
"type": "string"
},
"name": {
"description": "Name of cron (just for information purpose).",
"type": "string"
},
"method": {
"description": "HTTP method to use. Defaults to 'GET'.",
"type": "string",
"enum": [
"GET", "POST", "HEAD", "PUT", "DELETE", "PATCH", "OPTIONS"
]
},
"path": {
"description": "Path to call in current app url.",
"type": "string"
},
"headers": {
"description": "Additional headers to use for this call.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
},
"FunctionDeploy": {
"title": "Function deploy config",
"type": "object",
"additionalProperties": true,
"properties": {
"plugin": {
"description": "Deploy plugin override. Defaults to first supported plugin available.",
"type": "string"
},
"env": {
"description": "Additional environment variables.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"memory_limit": {
"description": "Memory limit in MiB of function deployment.",
"type": "integer"
},
"min_scale": {
"description": "Minimum scale of container deployment (used if deployment uses a container).",
"type": "integer"
},
"max_scale": {
"description": "Maximum scale of container deployment (used if deployment uses a container).",
"type": "integer"
},
"timeout": {
"description": "Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.",
"type": "integer"
}
}
},
"FunctionPackage": {
"title": "Function package config",
"type": "object",
"additionalProperties": false,
"properties": {
"patterns": {
"description": "Package patterns to exclude (or force include if starts with '!').",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CDN": {
"title": "CDN",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"StaticBasicAuth": {
"title": "Static app basic auth config",
"type": "object",
"additionalProperties": false,
"properties": {
"realm": {
"description": "Basic auth realm name, defaults to 'restricted'.",
"type": "string"
},
"users": {
"description": "Basic auth users in form of `user: password` where password is either in plain text or in a form of apr1 hash (used by htpasswd).",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"StaticBuild": {
"title": "Build static app",
"type": "object",
"additionalProperties": false,
"properties": {
"env": {
"description": "Additional environment variables available during build.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"command": {
"description": "Command to be run to generate output files.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"dir": {
"description": "Output dir to where static files end up.",
"type": "string"
}
}
},
"ServiceBuild": {
"title": "Service app build definition",
"type": "object",
"additionalProperties": false,
"properties": {
"image": {
"description": "Docker image to use. If specified, will try to pull this image if skip-build is enabled.",
"type": "string"
},
"skip_build": {
"description": "Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.",
"type": "boolean"
},
"skip_pull": {
"description": "Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.",
"type": "boolean"
},
"build_args": {
"description": "Docker build-args.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"context": {
"description": "Docker context directory, relative to application dir.",
"type": "string"
},
"dockerfile": {
"description": "Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.",
"type": "string"
}
}
},
"FunctionBuild": {
"title": "Build function app",
"type": "object",
"additionalProperties": false,
"properties": {
"env": {
"description": "Additional environment variables available during build.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"command": {
"description": "Command to be run to generate output files.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"dir": {
"description": "Output dir to where built files end up.",
"type": "string"
}
}
},
"ServiceContainer": {
"title": "Service app container definition",
"type": "object",
"additionalProperties": false,
"properties": {
"port": {
"description": "Docker container port to use.",
"type": "integer"
},
"command": {
"description": "Docker command (CMD) to override.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"entrypoint": {
"description": "Docker entrypoint (ENTRYPOINT) to override.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
}
}
} |
powerpages-web-template-manifest.json | {
"$id": "https://json.schemastore.org/powerpages-web-template-manifest.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"examples": [
{
"type": "functional",
"displayName": "Card Template",
"description": "renders the gallery card",
"params": [
{
"id": "name",
"displayName": "Display name",
"description": "Main heading of the web template"
},
{
"id": "count",
"displayName": "Items per row",
"description": "No of items to be displayed per row"
},
{
"id": "paramTable",
"type": "table",
"displayName": "Select table"
}
]
}
],
"properties": {
"type": {
"type": "string",
"title": "type",
"description": "The web template type. Use 'functional' for custom site components and 'layout' for custom layouts.",
"enum": ["functional", "layout"]
},
"displayName": {
"type": "string",
"description": "The display name of the web template",
"examples": ["Card Template"]
},
"description": {
"type": "string",
"description": "The description of the web template",
"examples": ["renders the gallery card"]
},
"tables": {
"type": "array",
"description": "An array of table logical names that are used in the web template",
"items": {
"type": "string"
}
},
"params": {
"type": "array",
"title": "params",
"description": "The editable properties of the web template. These will be customizable in Studio",
"items": {
"type": "object",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The id of the param. This correlates with the liquid tag's key for this property",
"examples": ["name", "count", "specifiedTable"]
},
"displayName": {
"type": "string",
"description": "The label displayed when editing a property in Studio. If no displayName is given, the label will fallback on the id",
"examples": ["Display name", "Items per row", "Selected table"]
},
"description": {
"type": "string",
"description": "The description to be displayed in the tooltip when editing a property in Studio. If no description is given, no tooltip will be displayed",
"examples": [
"Main heading of the web template",
"No of items to be displayed per row"
]
},
"type": {
"type": "string",
"description": "Used to specify a property that correlates to a table's logical name",
"enum": ["table"]
}
},
"examples": [
{
"id": "name",
"displayName": "Display name",
"description": "Main heading of the web template"
},
{
"id": "count",
"displayName": "Items per row"
},
{
"id": "specifiedTable",
"type": "table",
"displayName": "Select table"
}
]
},
"examples": [
[
{
"id": "name",
"displayName": "Display name",
"description": "Main heading of the web template"
},
{
"id": "count",
"displayName": "Items per row",
"description": "No of items to be displayed per row"
},
{
"id": "specifiedTable",
"type": "table",
"displayName": "Select table"
}
]
]
}
},
"required": ["type"],
"title": "Root Schema",
"type": "object"
}
|
httpmockrc.json | {
"$id": "https://json.schemastore.org/httpmockrc.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A tool for mock local requests or proxy remote requests.",
"properties": {
"mockFileName": {
"default": "mocks",
"type": "string",
"description": "Root of mock files"
},
"requestHeaders": {
"type": "object",
"description": "Custom request header"
},
"responseHeaders": {
"type": "object",
"description": "Custom response header"
},
"parseBody": {
"type": "boolean",
"description": "Parse post body by express.json()"
},
"routes": {
"type": "object",
"description": "Rules for proxy and mock",
"patternProperties": {
"^.*$": {
"type": "object",
"description": "Rule of Matching route",
"properties": {
"path": {
"type": "string",
"description": "Where Mock result file located"
},
"ignore": {
"type": "boolean",
"description": "Whether to ignore this rule, generally used for remote interfaces instead of mock in the local"
},
"delay": {
"type": "number",
"description": "How many milliseconds are delayed to return a request, general used for control the request sequence"
},
"validate": {
"type": "object",
"description": "Validate params in body by key and typeof value"
}
},
"required": ["path"]
}
}
}
},
"required": ["mockFileName", "routes"],
"title": "Http-mocker configuration.",
"type": "object"
}
|
minecraft-loot-table.json | {
"$comment": "https://minecraft.fandom.com/wiki/Loot_table",
"$id": "https://json.schemastore.org/minecraft-loot-table.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"numberProvider": {
"$comment": "https://minecraft.fandom.com/wiki/Loot_table#Number_Providers",
"properties": {
"type": {
"title": "Type",
"description": "The number provider type.",
"type": "string",
"enum": [
"minecraft:constant",
"minecraft:uniform",
"minecraft:binomial",
"minecraft:score"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "minecraft:constant"
}
}
},
"then": {
"description": "A constant value.",
"properties": {
"value": {
"title": "Value",
"description": "The exact value.",
"type": "number"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "minecraft:uniform"
}
}
},
"then": {
"description": "A random number following a uniform distribution between two values (inclusive).",
"properties": {
"min": {
"title": "Minimum",
"description": "The minimum value.",
"type": ["number", "object"],
"$ref": "#/definitions/numberProvider"
},
"max": {
"title": "Max",
"description": "The maximum value.",
"type": ["number", "object"],
"$ref": "#/definitions/numberProvider"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "minecraft:binomial"
}
}
},
"then": {
"description": "A random number following a binomial distribution.",
"properties": {
"n": {
"title": "n",
"description": "The amount of trials.",
"type": ["integer", "object"],
"$ref": "#/definitions/numberProvider"
},
"p": {
"title": "p",
"description": "The probability of success on an individual trial.",
"$ref": "#/definitions/numberProvider"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "minecraft:score"
}
}
},
"then": {
"description": "A scoreboard value.",
"properties": {
"target": {
"title": "Target",
"description": "Scoreboard name provider.",
"type": ["string", "object"],
"enum": ["this", "killer", "direct_killer", "player_killer"],
"properties": {
"type": {
"title": "Type",
"description": "Resource location.",
"type": "string",
"enum": ["fixed", "context"]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "fixed"
}
}
},
"then": {
"properties": {
"name": {
"title": "Name",
"description": "A UUID or player name.",
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "context"
}
}
},
"then": {
"properties": {
"target": {
"title": "Target",
"type": "string",
"enum": [
"this",
"killer",
"direct_killer",
"player_killer"
]
}
}
}
}
]
},
"score": {
"title": "Score",
"description": "The scoreboard objective.",
"type": "string"
},
"scale": {
"title": "Scale",
"description": "Scale to multiply the score before returning it.",
"type": "number"
}
}
}
}
]
}
},
"description": "Configuration file defining a loot table for a data pack for Minecraft.",
"properties": {
"type": {
"title": "Type",
"type": "string",
"enum": [
"minecraft:empty",
"empty",
"minecraft:entity",
"entity",
"minecraft:block",
"block",
"minecraft:chest",
"chest",
"minecraft:fishing",
"fishing",
"minecraft:gift",
"gift",
"minecraft:advancement_reward",
"advancement_reward",
"minecraft:barter",
"barter",
"minecraft:command",
"command",
"minecraft:selector",
"selector",
"minecraft:advancement_entity",
"advancement_entity",
"minecraft:generic",
"generic"
]
},
"functions": {
"title": "Functions",
"description": " Applies functions to all item stacks produced by this table. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "A function.",
"type": "object",
"properties": {
"function": {
"title": "Function",
"description": "Namespaced ID of the function to apply.",
"type": "string"
},
"conditions": {
"title": "Conditions",
"description": "Determines conditions for this function to be applied. If multiple conditions are specified, all must pass.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "A function.",
"type": "object",
"properties": {
"condition": {
"title": "Condition",
"description": "Namespaced ID of condition.",
"type": "string"
}
}
}
}
}
}
}
}
},
"pools": {
"title": "Pools",
"description": "A list of all pools for this loot table. Each pool used generates items from its list of items based on the number of rolls. Pools are applied in order.",
"type": "array",
"items": {
"description": "A pool.",
"type": "object",
"properties": {
"conditions": {
"title": "Conditions",
"description": "Determines conditions for this pool to be used. If multiple conditions are specified, all must pass.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "A condition.",
"properties": {
"condition": {
"title": "Condition",
"description": "Namespaced ID of condition.",
"type": "string"
}
}
}
}
},
"functions": {
"title": "Functions",
"description": "Applies functions to all item stacks produced by this pool. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "A function.",
"properties": {
"function": {
"title": "Function",
"description": "Namespaced ID of the function to apply.",
"type": "string"
},
"conditions": {
"title": "Conditions",
"description": "Determines conditions for this function to be applied. If multiple conditions are specified, all must pass.",
"type": "array",
"items": {
"description": "A condition.",
"type": "object",
"properties": {
"condition": {
"title": "Condition",
"description": "Namespaced ID of condition.",
"type": "string"
}
}
}
}
}
}
}
},
"rolls": {
"title": "Rolls",
"description": "Specifies the number of rolls on the pool.",
"type": ["integer", "object"],
"$ref": "#/definitions/numberProvider"
},
"bonus_rolls": {
"title": "Bonus Rolls",
"description": "Specifies the number of bonus rolls on the pool per point of luck. Rounded down after multiplying.",
"type": ["number", "object"],
"$ref": "#/definitions/numberProvider"
},
"entries": {
"title": "Entries",
"description": "A list of all things that can be produced by this pool. One entry is chosen per roll as a weighted random selection from all entries without failing conditions.",
"type": "array",
"items": {
"description": "An entry.",
"type": "object",
"properties": {
"conditions": {
"title": "Conditions",
"description": "Determines conditions for this entry to be used. If multiple conditions are specified, all must pass.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "A condition.",
"properties": {
"condition": {
"title": "Condition",
"description": "Namespaced ID of condition.",
"type": "string"
}
}
}
}
},
"functions": {
"title": "Functions",
"description": "Applies functions to the item stack or item stacks being produced. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "A function.",
"properties": {
"function": {
"title": "Function",
"description": "Namespaced ID of the function to apply.",
"type": "string"
},
"conditions": {
"title": "Conditions",
"description": "Determines conditions for this function to be applied. If multiple conditions are specified, all must pass.",
"type": "array",
"items": {
"description": "A condition.",
"type": "object",
"properties": {
"condition": {
"title": "Condition",
"description": "Namespaced ID of condition.",
"type": "string"
}
}
}
}
}
}
}
},
"type": {
"title": "Type",
"description": "Namespaced ID type of entry.",
"type": "string",
"enum": [
"minecraft:item",
"minecraft:tag",
"minecraft:loot_table",
"minecraft:group",
"minecraft:alternatives",
"minecraft:sequence",
"minecraft:dynamic",
"minecraft:empty"
]
},
"name": {
"title": "Name",
"type": "string"
},
"children": {
"title": "Children",
"type": "array"
},
"expand": {
"title": "Expand",
"description": "For type 'tag', if set to true, it chooses one item of the tag, each with the same weight and quality. If false, it generates one of each of the items in the tag.",
"type": "boolean"
},
"weight": {
"title": "Weight",
"description": "Determines how often this entry is chosen out of all the entries in the pool. Entries with higher weights are used more often (chance is this entry's weight⁄total of all considered entries' weights).",
"type": "integer"
},
"quality": {
"title": "Quality",
"description": "Modifies the entry's weight based on the killing/opening/fishing player's luck attribute. Formula is floor( weight + (quality * generic.luck)).",
"type": "integer"
}
}
}
}
}
}
}
},
"title": "Minecraft Data Pack Loot Table"
}
|
tokenlist.schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://uniswap.org/tokenlist.schema.json",
"title": "Uniswap Token List",
"description": "Schema for lists of tokens compatible with the Uniswap Interface",
"definitions": {
"Version": {
"type": "object",
"description": "The version of the list, used in change detection",
"examples": [
{
"major": 1,
"minor": 0,
"patch": 0
}
],
"additionalProperties": false,
"properties": {
"major": {
"type": "integer",
"description": "The major version of the list. Must be incremented when tokens are removed from the list or token addresses are changed.",
"minimum": 0,
"examples": [
1,
2
]
},
"minor": {
"type": "integer",
"description": "The minor version of the list. Must be incremented when tokens are added to the list.",
"minimum": 0,
"examples": [
0,
1
]
},
"patch": {
"type": "integer",
"description": "The patch version of the list. Must be incremented for any changes to the list.",
"minimum": 0,
"examples": [
0,
1
]
}
},
"required": [
"major",
"minor",
"patch"
]
},
"TagIdentifier": {
"type": "string",
"description": "The unique identifier of a tag",
"minLength": 1,
"maxLength": 10,
"pattern": "^[\\w]+$",
"examples": [
"compound",
"stablecoin"
]
},
"ExtensionIdentifier": {
"type": "string",
"description": "The name of a token extension property",
"minLength": 1,
"maxLength": 40,
"pattern": "^[\\w]+$",
"examples": [
"color",
"is_fee_on_transfer",
"aliases"
]
},
"ExtensionMap": {
"type": "object",
"description": "An object containing any arbitrary or vendor-specific token metadata",
"maxProperties": 10,
"propertyNames": {
"$ref": "#/definitions/ExtensionIdentifier"
},
"additionalProperties": {
"$ref": "#/definitions/ExtensionValue"
},
"examples": [
{
"color": "#000000",
"is_verified_by_me": true
},
{
"x-bridged-addresses-by-chain": {
"1": {
"bridgeAddress": "0x4200000000000000000000000000000000000010",
"tokenAddress": "0x4200000000000000000000000000000000000010"
}
}
}
]
},
"ExtensionPrimitiveValue": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 42,
"examples": [
"#00000"
]
},
{
"type": "boolean",
"examples": [
true
]
},
{
"type": "number",
"examples": [
15
]
},
{
"type": "null"
}
]
},
"ExtensionValue": {
"anyOf": [
{
"$ref": "#/definitions/ExtensionPrimitiveValue"
},
{
"type": "object",
"maxProperties": 10,
"propertyNames": {
"$ref": "#/definitions/ExtensionIdentifier"
},
"additionalProperties": {
"$ref": "#/definitions/ExtensionValueInner0"
}
}
]
},
"ExtensionValueInner0": {
"anyOf": [
{
"$ref": "#/definitions/ExtensionPrimitiveValue"
},
{
"type": "object",
"maxProperties": 10,
"propertyNames": {
"$ref": "#/definitions/ExtensionIdentifier"
},
"additionalProperties": {
"$ref": "#/definitions/ExtensionValueInner1"
}
}
]
},
"ExtensionValueInner1": {
"anyOf": [
{
"$ref": "#/definitions/ExtensionPrimitiveValue"
}
]
},
"TagDefinition": {
"type": "object",
"description": "Definition of a tag that can be associated with a token via its identifier",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "The name of the tag",
"pattern": "^[ \\w]+$",
"minLength": 1,
"maxLength": 20
},
"description": {
"type": "string",
"description": "A user-friendly description of the tag",
"pattern": "^[ \\w\\.,:]+$",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"name",
"description"
],
"examples": [
{
"name": "Stablecoin",
"description": "A token with value pegged to another asset"
}
]
},
"TokenInfo": {
"type": "object",
"description": "Metadata for a single token in a token list",
"additionalProperties": false,
"properties": {
"chainId": {
"type": "integer",
"description": "The chain ID of the Ethereum network where this token is deployed",
"minimum": 1,
"examples": [
1,
42
]
},
"address": {
"type": "string",
"description": "The checksummed address of the token on the specified chain ID",
"pattern": "^0x[a-fA-F0-9]{40}$",
"examples": [
"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
]
},
"decimals": {
"type": "integer",
"description": "The number of decimals for the token balance",
"minimum": 0,
"maximum": 255,
"examples": [
18
]
},
"name": {
"type": "string",
"description": "The name of the token",
"minLength": 0,
"maxLength": 40,
"anyOf": [
{
"const": ""
},
{
"pattern": "^[ \\S+]+$"
}
],
"examples": [
"USD Coin"
]
},
"symbol": {
"type": "string",
"description": "The symbol for the token",
"minLength": 0,
"maxLength": 20,
"anyOf": [
{
"const": ""
},
{
"pattern": "^\\S+$"
}
],
"examples": [
"USDC"
]
},
"logoURI": {
"type": "string",
"description": "A URI to the token logo asset; if not set, interface will attempt to find a logo based on the token address; suggest SVG or PNG of size 64x64",
"format": "uri",
"examples": [
"ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"
]
},
"tags": {
"type": "array",
"description": "An array of tag identifiers associated with the token; tags are defined at the list level",
"items": {
"$ref": "#/definitions/TagIdentifier"
},
"maxItems": 10,
"examples": [
"stablecoin",
"compound"
]
},
"extensions": {
"$ref": "#/definitions/ExtensionMap"
}
},
"required": [
"chainId",
"address",
"decimals",
"name",
"symbol"
]
}
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the token list",
"minLength": 1,
"maxLength": 30,
"pattern": "^[\\w ]+$",
"examples": [
"My Token List"
]
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "The timestamp of this list version; i.e. when this immutable version of the list was created"
},
"version": {
"$ref": "#/definitions/Version"
},
"tokens": {
"type": "array",
"description": "The list of tokens included in the list",
"items": {
"$ref": "#/definitions/TokenInfo"
},
"minItems": 1,
"maxItems": 10000
},
"tokenMap": {
"type": "object",
"description": "A mapping of key 'chainId_tokenAddress' to its corresponding token object",
"minProperties": 1,
"maxProperties": 10000,
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/definitions/TokenInfo"
},
"examples": [
{
"4_0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984": {
"name": "Uniswap",
"address": "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984",
"symbol": "UNI",
"decimals": 18,
"chainId": 4,
"logoURI": "ipfs://QmXttGpZrECX5qCyXbBQiqgQNytVGeZW5Anewvh2jc4psg"
}
}
]
},
"keywords": {
"type": "array",
"description": "Keywords associated with the contents of the list; may be used in list discoverability",
"items": {
"type": "string",
"description": "A keyword to describe the contents of the list",
"minLength": 1,
"maxLength": 20,
"pattern": "^[\\w ]+$",
"examples": [
"compound",
"lending",
"personal tokens"
]
},
"maxItems": 20,
"uniqueItems": true
},
"tags": {
"type": "object",
"description": "A mapping of tag identifiers to their name and description",
"propertyNames": {
"$ref": "#/definitions/TagIdentifier"
},
"additionalProperties": {
"$ref": "#/definitions/TagDefinition"
},
"maxProperties": 20,
"examples": [
{
"stablecoin": {
"name": "Stablecoin",
"description": "A token with value pegged to another asset"
}
}
]
},
"logoURI": {
"type": "string",
"description": "A URI for the logo of the token list; prefer SVG or PNG of size 256x256",
"format": "uri",
"examples": [
"ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"
]
}
},
"required": [
"name",
"timestamp",
"version",
"tokens"
]
} |
theme.json | {
"title": "JSON schema for WordPress block theme global settings and styles",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"//": {
"explainer": "https://developer.wordpress.org/themes/advanced-topics/theme-json/",
"createTheme": "https://developer.wordpress.org/block-editor/how-to-guides/themes/create-block-theme/",
"reference": "https://developer.wordpress.org/block-editor/how-to-guides/themes/theme-json/"
},
"behaviorsBlocksPropertiesComplete": {
"type": "object",
"properties": {
"lightbox": {
"description": "Settings related to the lightbox behavior.",
"type": "object",
"properties": {
"enabled": {
"description": "Allow users to enable the lightbox behavior.",
"type": "boolean",
"default": false
},
"animation": {
"description": "Set lightbox animation. Possible values: `fade`, `zoom`, `''` (empty string).",
"type": "string",
"enum": [ "fade", "zoom", "" ]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"refComplete": {
"type": "object",
"properties": {
"ref": {
"description": "A reference to another property value. e.g. `styles.color.text`",
"type": "string"
}
}
},
"settingsPropertiesAppearanceTools": {
"type": "object",
"properties": {
"appearanceTools": {
"description": "Setting that enables the following UI tools:\n\n- border: color, radius, style, width\n- color: link\n- dimensions: minHeight\n- position: sticky\n- spacing: blockGap, margin, padding\n- typography: lineHeight",
"type": "boolean",
"default": false
}
}
},
"settingsPropertiesUseRootPaddingAwareAlignments": {
"properties": {
"useRootPaddingAwareAlignments": {
"description": "_**Note:** Since WordPress 6.1._\n\nEnables root padding (the values from `styles.spacing.padding`) to be applied to the contents of full-width blocks instead of the root block.\n\nPlease note that when using this setting, `styles.spacing.padding` should always be set as an object with `top`, `right`, `bottom`, `left` values declared separately.",
"type": "boolean",
"default": false
}
}
},
"settingsPropertiesBorder": {
"type": "object",
"properties": {
"border": {
"description": "Settings related to borders.",
"type": "object",
"properties": {
"color": {
"description": "Allow users to set custom border colors.",
"type": "boolean",
"default": false
},
"radius": {
"description": "Allow users to set custom border radius.",
"type": "boolean",
"default": false
},
"style": {
"description": "Allow users to set custom border styles.",
"type": "boolean",
"default": false
},
"width": {
"description": "Allow users to set custom border widths.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesShadow": {
"type": "object",
"properties": {
"shadow": {
"description": "Settings related to shadows.",
"type": "object",
"properties": {
"defaultPresets": {
"description": "Allow users to choose shadows from the default shadow presets.",
"type": "boolean",
"default": true
},
"presets": {
"description": "Shadow presets for the shadow picker.\nGenerates a single custom property (`--wp--preset--shadow--{slug}`) per preset value.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the shadow preset, translatable.",
"type": "string"
},
"slug": {
"description": "Kebab-case unique identifier for the shadow preset.",
"type": "string"
},
"shadow": {
"description": "CSS box-shadow value",
"type": "string"
}
},
"required": [ "name", "slug", "shadow" ],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesColor": {
"type": "object",
"properties": {
"color": {
"description": "Settings related to colors.",
"type": "object",
"properties": {
"background": {
"description": "Allow users to set background colors.",
"type": "boolean",
"default": true
},
"custom": {
"description": "Allow users to select custom colors.",
"type": "boolean",
"default": true
},
"customDuotone": {
"description": "Allow users to create custom duotone filters.",
"type": "boolean",
"default": true
},
"customGradient": {
"description": "Allow users to create custom gradients.",
"type": "boolean",
"default": true
},
"defaultDuotone": {
"description": "Allow users to choose filters from the default duotone filter presets.",
"type": "boolean",
"default": true
},
"defaultGradients": {
"description": "Allow users to choose colors from the default gradients.",
"type": "boolean",
"default": true
},
"defaultPalette": {
"description": "Allow users to choose colors from the default palette.",
"type": "boolean",
"default": true
},
"duotone": {
"description": "Duotone presets for the duotone picker.\nDoesn't generate classes or properties.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the duotone preset, translatable.",
"type": "string"
},
"slug": {
"description": "Kebab-case unique identifier for the duotone preset.",
"type": "string"
},
"colors": {
"description": "List of colors from dark to light.",
"type": "array",
"items": {
"description": "CSS hex or rgb string.",
"type": "string"
}
}
},
"required": [ "name", "slug", "colors" ],
"additionalProperties": false
}
},
"gradients": {
"description": "Gradient presets for the gradient picker.\nGenerates a single class (`.has-{slug}-background`) and custom property (`--wp--preset--gradient--{slug}`) per preset value.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the gradient preset, translatable.",
"type": "string"
},
"slug": {
"description": "Kebab-case unique identifier for the gradient preset.",
"type": "string"
},
"gradient": {
"description": "CSS gradient string.",
"type": "string"
}
},
"required": [ "name", "slug", "gradient" ],
"additionalProperties": false
}
},
"link": {
"description": "Allow users to set link colors.",
"type": "boolean",
"default": false
},
"palette": {
"description": "Color palette presets for the color picker.\nGenerates three classes (`.has-{slug}-color`, `.has-{slug}-background-color`, and `.has-{slug}-border-color`) and a single custom property (`--wp--preset--color--{slug}`) per preset value.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the color preset, translatable.",
"type": "string"
},
"slug": {
"description": "Kebab-case unique identifier for the color preset.",
"type": "string"
},
"color": {
"description": "CSS hex or rgb(a) string.",
"type": "string"
}
},
"required": [ "name", "slug", "color" ],
"additionalProperties": false
}
},
"text": {
"description": "Allow users to set text colors.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesDimensions": {
"type": "object",
"properties": {
"dimensions": {
"description": "Settings related to dimensions.",
"type": "object",
"properties": {
"minHeight": {
"description": "Allow users to set custom minimum height.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesLayout": {
"type": "object",
"properties": {
"layout": {
"description": "Settings related to layout.",
"type": "object",
"properties": {
"contentSize": {
"description": "Sets the max-width of the content.",
"type": "string"
},
"wideSize": {
"description": "Sets the max-width of wide (`.alignwide`) content. Also used as the maximum viewport when calculating fluid font sizes",
"type": "string"
},
"allowEditing": {
"description": "Disable the layout UI controls.",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesPosition": {
"type": "object",
"properties": {
"position": {
"description": "Settings related to position.",
"type": "object",
"properties": {
"sticky": {
"description": "Allow users to set sticky position.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesSpacing": {
"type": "object",
"properties": {
"spacing": {
"description": "Settings related to spacing.",
"type": "object",
"properties": {
"blockGap": {
"description": "Enables `--wp--style--block-gap` to be generated from styles.spacing.blockGap.\nA value of `null` instead of `false` further disables layout styles from being generated.",
"oneOf": [
{ "type": "boolean" },
{ "type": "null" }
],
"default": null
},
"margin": {
"description": "Allow users to set a custom margin.",
"type": "boolean",
"default": false
},
"padding": {
"description": "Allow users to set a custom padding.",
"type": "boolean",
"default": false
},
"units": {
"description": "List of units the user can use for spacing values.",
"type": "array",
"items": {
"type": "string"
},
"default": [ "px", "em", "rem", "vh", "vw", "%" ]
},
"customSpacingSize": {
"description": "Allow users to set custom space sizes.",
"type": "boolean",
"default": true
},
"spacingSizes": {
"description": "Space size presets for the space size selector.\nGenerates a custom property (`--wp--preset--spacing--{slug}`) per preset value.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the space size preset, translatable.",
"type": "string"
},
"slug": {
"description": "Unique identifier for the space size preset. For best cross theme compatibility these should be in the form '10','20','30','40','50','60', etc. with '50' representing the 'Medium' size step.",
"type": "string"
},
"size": {
"description": "CSS space-size value, including units.",
"type": "string"
}
},
"additionalProperties": false
}
},
"spacingScale": {
"description": "Settings to auto-generate space size presets for the space size selector.\nGenerates a custom property (--wp--preset--spacing--{slug}`) per preset value.",
"type": "object",
"properties": {
"operator": {
"description": "With + or * depending on whether scale is generated by increment or multiplier.",
"type": "string",
"enum": [ "+", "*" ],
"default": "*"
},
"increment": {
"description": "The amount to increment each step by.",
"type": "number",
"default": 1.5
},
"steps": {
"description": "Number of steps to generate in scale.",
"type": "integer",
"default": 7
},
"mediumStep": {
"description": "The value to medium setting in the scale.",
"type": "number",
"default": 1.5
},
"unit": {
"description": "Unit that the scale uses, eg. rem, em, px.",
"type": "string",
"enum": [
"px",
"em",
"rem",
"vh",
"vw",
"%"
],
"default": "rem"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesTypography": {
"type": "object",
"properties": {
"typography": {
"description": "Settings related to typography.",
"type": "object",
"properties": {
"customFontSize": {
"description": "Allow users to set custom font sizes.",
"type": "boolean",
"default": true
},
"fontStyle": {
"description": "Allow users to set custom font styles.",
"type": "boolean",
"default": true
},
"fontWeight": {
"description": "Allow users to set custom font weights.",
"type": "boolean",
"default": true
},
"fluid": {
"description": "Enables fluid typography and allows users to set global fluid typography parameters.",
"oneOf": [
{
"type": "object",
"properties": {
"minFontSize": {
"description": "Allow users to set a global minimum font size boundary in px, rem or em. Custom font sizes below this value will not be clamped, and all calculated minimum font sizes will be, at a minimum, this value.",
"type": "string"
},
"maxViewportWidth": {
"description": "Allow users to set custom a max viewport width in px, rem or em, used to set the maximum size boundary of a fluid font size.",
"type": "string"
},
"minViewportWidth": {
"description": "Allow users to set a custom min viewport width in px, rem or em, used to set the minimum size boundary of a fluid font size.",
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "boolean"
}
],
"default": false
},
"letterSpacing": {
"description": "Allow users to set custom letter spacing.",
"type": "boolean",
"default": true
},
"lineHeight": {
"description": "Allow users to set custom line height.",
"type": "boolean",
"default": false
},
"textColumns": {
"description": "Allow users to set the number of text columns.",
"type": "boolean",
"default": false
},
"textDecoration": {
"description": "Allow users to set custom text decorations.",
"type": "boolean",
"default": true
},
"writingMode": {
"description": "Allow users to set the writing mode.",
"type": "boolean",
"default": false
},
"textTransform": {
"description": "Allow users to set custom text transforms.",
"type": "boolean",
"default": true
},
"dropCap": {
"description": "Enable drop cap.",
"type": "boolean",
"default": true
},
"fontSizes": {
"description": "Font size presets for the font size selector.\nGenerates a single class (`.has-{slug}-color`) and custom property (`--wp--preset--font-size--{slug}`) per preset value.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the font size preset, translatable.",
"type": "string"
},
"slug": {
"description": "Kebab-case unique identifier for the font size preset.",
"type": "string"
},
"size": {
"description": "CSS font-size value, including units.",
"type": "string"
},
"fluid": {
"description": "Specifies the minimum and maximum font size value of a fluid font size. Set to `false` to bypass fluid calculations and use the static `size` value.",
"oneOf": [
{
"type": "object",
"properties": {
"min": {
"description": "A min font size for fluid font size calculations in px, rem or em.",
"type": "string"
},
"max": {
"description": "A max font size for fluid font size calculations in px, rem or em.",
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false
}
},
"fontFamilies": {
"description": "Font family presets for the font family selector.\nGenerates a single custom property (`--wp--preset--font-family--{slug}`) per preset value.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the font family preset, translatable.",
"type": "string"
},
"slug": {
"description": "Kebab-case unique identifier for the font family preset.",
"type": "string"
},
"fontFamily": {
"description": "CSS font-family value.",
"type": "string"
},
"fontFace": {
"description": "Array of font-face declarations.",
"type": "array",
"items": {
"type": "object",
"properties": {
"fontFamily": {
"description": "CSS font-family value.",
"type": "string",
"default": ""
},
"fontStyle": {
"description": "CSS font-style value.",
"type": "string",
"default": "normal"
},
"fontWeight": {
"description": "List of available font weights, separated by a space.",
"default": "400",
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"fontDisplay": {
"description": "CSS font-display value.",
"type": "string",
"default": "fallback",
"enum": [
"auto",
"block",
"fallback",
"swap",
"optional"
]
},
"src": {
"description": "Paths or URLs to the font files.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"default": []
},
"fontStretch": {
"description": "CSS font-stretch value.",
"type": "string"
},
"ascentOverride": {
"description": "CSS ascent-override value.",
"type": "string"
},
"descentOverride": {
"description": "CSS descent-override value.",
"type": "string"
},
"fontVariant": {
"description": "CSS font-variant value.",
"type": "string"
},
"fontFeatureSettings": {
"description": "CSS font-feature-settings value.",
"type": "string"
},
"fontVariationSettings": {
"description": "CSS font-variation-settings value.",
"type": "string"
},
"lineGapOverride": {
"description": "CSS line-gap-override value.",
"type": "string"
},
"sizeAdjust": {
"description": "CSS size-adjust value.",
"type": "string"
},
"unicodeRange": {
"description": "CSS unicode-range value.",
"type": "string"
}
},
"required": [ "fontFamily", "src" ],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"settingsPropertiesCustom": {
"type": "object",
"properties": {
"custom": {
"description": "Generate custom CSS custom properties of the form `--wp--custom--{key}--{nested-key}: {value};`. `camelCased` keys are transformed to `kebab-case` as to follow the CSS property naming schema. Keys at different depth levels are separated by `--`, so keys should not include `--` in the name.",
"$ref": "#/definitions/settingsCustomAdditionalProperties"
}
}
},
"settingsPropertiesBehaviors": {
"type": "object",
"properties": {
"behaviors": {
"description": "Settings related to behaviors.",
"type": "object",
"properties": {
"lightbox": {
"description": "Allow users to enable/disable lightbox.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
}
},
"settingsProperties": {
"allOf": [
{ "$ref": "#/definitions/settingsPropertiesAppearanceTools" },
{ "$ref": "#/definitions/settingsPropertiesBehaviors" },
{ "$ref": "#/definitions/settingsPropertiesBorder" },
{ "$ref": "#/definitions/settingsPropertiesColor" },
{ "$ref": "#/definitions/settingsPropertiesDimensions" },
{ "$ref": "#/definitions/settingsPropertiesShadow" },
{ "$ref": "#/definitions/settingsPropertiesLayout" },
{ "$ref": "#/definitions/settingsPropertiesPosition" },
{ "$ref": "#/definitions/settingsPropertiesSpacing" },
{ "$ref": "#/definitions/settingsPropertiesTypography" },
{ "$ref": "#/definitions/settingsPropertiesCustom" }
]
},
"settingsPropertiesComplete": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/settingsProperties"
},
{
"properties": {
"appearanceTools": {},
"behaviors": {},
"border": {},
"color": {},
"dimensions": {},
"layout": {},
"position": {},
"shadow": {},
"spacing": {},
"typography": {},
"custom": {}
},
"additionalProperties": false
}
]
},
"settingsBlocksPropertiesComplete": {
"type": "object",
"properties": {
"core/archives": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/audio": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/avatar": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/block": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/button": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/buttons": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/calendar": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/categories": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/code": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/column": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/columns": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-author-avatar": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-author-name": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-content": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-date": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-edit-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-reply-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comments": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comments-pagination": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comments-pagination-next": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comments-pagination-numbers": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comments-pagination-previous": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comments-title": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/comment-template": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/cover": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/details": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/embed": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/file": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/freeform": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/gallery": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/group": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/heading": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/home-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/html": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/image": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/latest-comments": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/latest-posts": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/list": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/list-item": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/loginout": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/media-text": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/missing": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/more": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/navigation": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/navigation-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/navigation-submenu": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/nextpage": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/page-list": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/page-list-item": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/paragraph": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-author": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-author-biography": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-author-name": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-comment": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-comments-count": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-comments-form": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-comments-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-content": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-date": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-excerpt": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-featured-image": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-navigation-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-template": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-terms": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-time-to-read": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/post-title": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/preformatted": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/pullquote": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query-no-results": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query-pagination": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query-pagination-next": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query-pagination-numbers": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query-pagination-previous": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/query-title": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/quote": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/read-more": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/rss": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/search": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/separator": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/shortcode": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/site-logo": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/site-tagline": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/site-title": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/social-link": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/social-links": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/spacer": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/table": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/table-of-contents": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/tag-cloud": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/template-part": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/term-description": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/text-columns": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/verse": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/video": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/widget-area": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/legacy-widget": {
"$ref": "#/definitions/settingsPropertiesComplete"
},
"core/widget-group": {
"$ref": "#/definitions/settingsPropertiesComplete"
}
},
"patternProperties": {
"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": {
"$ref": "#/definitions/settingsPropertiesComplete"
}
},
"additionalProperties": false
},
"settingsCustomAdditionalProperties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"$ref": "#/definitions/settingsCustomAdditionalProperties"
}
]
}
},
"stylesProperties": {
"type": "object",
"properties": {
"border": {
"description": "Border styles.",
"type": "object",
"properties": {
"color": {
"description": "Sets the `border-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"radius": {
"description": "Sets the `border-radius` CSS property.",
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
},
{
"type": "object",
"properties": {
"topLeft": {
"description": "Sets the `border-top-left-radius` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"topRight": {
"description": "Sets the `border-top-right-radius` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"bottomLeft": {
"description": "Sets the `border-bottom-left-radius` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"bottomRight": {
"description": "Sets the `border-bottom-right-radius` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
}
}
]
},
"style": {
"description": "Sets the `border-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"width": {
"description": "Sets the `border-width` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"top": {
"type": "object",
"properties": {
"color": {
"description": "Sets the `border-top-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"style": {
"description": "Sets the `border-top-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"width": {
"description": "Sets the `border-top-width` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"right": {
"type": "object",
"properties": {
"color": {
"description": "Sets the `border-right-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"style": {
"description": "Sets the `border-right-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"width": {
"description": "Sets the `border-right-width` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"bottom": {
"type": "object",
"properties": {
"color": {
"description": "Sets the `border-bottom-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"style": {
"description": "Sets the `border-bottom-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"width": {
"description": "Sets the `border-bottom-width` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"left": {
"type": "object",
"properties": {
"color": {
"description": "Sets the `border-left-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"style": {
"description": "Sets the `border-left-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"width": {
"description": "Sets the `border-left-width` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"color": {
"description": "Color styles.",
"type": "object",
"properties": {
"background": {
"description": "Sets the `background-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"gradient": {
"description": "Sets the `background` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"text": {
"description": "Sets the `color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"dimensions": {
"description": "Dimensions styles",
"type": "object",
"properties": {
"minHeight": {
"description": "Sets the `min-height` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
}
},
"spacing": {
"description": "Spacing styles.",
"type": "object",
"properties": {
"blockGap": {
"description": "Sets the `--wp--style--block-gap` CSS custom property when settings.spacing.blockGap is true.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"margin": {
"description": "Margin styles.",
"type": "object",
"properties": {
"top": {
"description": "Sets the `margin-top` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"right": {
"description": "Sets the `margin-right` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"bottom": {
"description": "Sets the `margin-bottom` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"left": {
"description": "Sets the `margin-left` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"padding": {
"description": "Padding styles.",
"type": "object",
"properties": {
"top": {
"description": "Sets the `padding-top` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"right": {
"description": "Sets the `padding-right` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"bottom": {
"description": "Sets the `padding-bottom` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"left": {
"description": "Sets the `padding-left` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"typography": {
"description": "Typography styles.",
"type": "object",
"properties": {
"fontFamily": {
"description": "Sets the `font-family` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"fontSize": {
"description": "Sets the `font-size` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"fontStyle": {
"description": "Sets the `font-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"fontWeight": {
"description": "Sets the `font-weight` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"letterSpacing": {
"description": "Sets the `letter-spacing` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"lineHeight": {
"description": "Sets the `line-height` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"textColumns": {
"description": "Sets the `column-count` CSS property.",
"type": "string"
},
"textDecoration": {
"description": "Sets the `text-decoration` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"writingMode": {
"description": "Sets the `writing-mode` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"textTransform": {
"description": "Sets the `text-transform` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"filter": {
"description": "CSS and SVG filter styles.",
"type": "object",
"properties": {
"duotone": {
"description": "Sets the duotone filter.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"shadow": {
"description": "Box shadow styles.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"outline": {
"description": "Outline styles.",
"type": "object",
"properties": {
"color": {
"description": "Sets the `outline-color` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"offset": {
"description": "Sets the `outline-offset` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"style": {
"description": "Sets the `outline-style` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
},
"width": {
"description": "Sets the `outline-width` CSS property.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/refComplete"
}
]
}
},
"additionalProperties": false
},
"css": {
"description": "Sets custom CSS to apply styling not covered by other theme.json properties.",
"type": "string"
}
}
},
"stylesPropertiesComplete": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/stylesProperties"
},
{
"properties": {
"border": {},
"color": {},
"dimensions": {},
"spacing": {},
"typography": {},
"filter": {},
"shadow": {},
"outline": {},
"css": {}
},
"additionalProperties": false
}
]
},
"stylesElementsPropertiesComplete": {
"type": "object",
"properties": {
"button": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/stylesProperties"
},
{
"properties": {
"border": {},
"color": {},
"filter": {},
"shadow": {},
"outline": {},
"spacing": {},
"typography": {},
"css": {},
":hover": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":focus": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":active": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":visited": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":link": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":any-link": {
"$ref": "#/definitions/stylesPropertiesComplete"
}
},
"additionalProperties": false
}
]
},
"link": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/stylesProperties"
},
{
"properties": {
"border": {},
"color": {},
"spacing": {},
"typography": {},
":hover": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":focus": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":active": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":visited": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":link": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
":any-link": {
"$ref": "#/definitions/stylesPropertiesComplete"
}
},
"additionalProperties": false
}
]
},
"heading": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"h1": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"h2": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"h3": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"h4": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"h5": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"h6": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"caption": {
"$ref": "#/definitions/stylesPropertiesComplete"
},
"cite": {
"$ref": "#/definitions/stylesPropertiesComplete"
}
},
"additionalProperties": false
},
"stylesBlocksPropertiesComplete": {
"type": "object",
"properties": {
"core/archives": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/audio": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/avatar": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/block": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/button": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/buttons": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/calendar": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/categories": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/code": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/column": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/columns": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-author-avatar": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-author-name": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-content": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-date": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-edit-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-reply-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comments": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comments-pagination": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comments-pagination-next": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comments-pagination-numbers": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comments-pagination-previous": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comments-title": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/comment-template": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/cover": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/details": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/embed": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/file": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/freeform": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/gallery": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/group": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/heading": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/home-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/html": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/image": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/latest-comments": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/latest-posts": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/list": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/list-item": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/loginout": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/media-text": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/missing": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/more": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/navigation": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/navigation-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/navigation-submenu": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/nextpage": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/page-list": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/page-list-item": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/paragraph": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-author": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-author-biography": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-author-name": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-comment": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-comments-count": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-comments-form": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-comments-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-content": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-date": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-excerpt": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-featured-image": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-navigation-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-template": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-terms": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-time-to-read": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/post-title": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/preformatted": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/pullquote": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query-no-results": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query-pagination": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query-pagination-next": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query-pagination-numbers": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query-pagination-previous": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/query-title": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/quote": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/read-more": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/rss": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/search": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/separator": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/shortcode": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/site-logo": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/site-tagline": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/site-title": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/social-link": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/social-links": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/spacer": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/table": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/table-of-contents": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/tag-cloud": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/template-part": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/term-description": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/text-columns": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/verse": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/video": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/widget-area": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/legacy-widget": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
},
"core/widget-group": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
}
},
"patternProperties": {
"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": {
"$ref": "#/definitions/stylesPropertiesAndElementsComplete"
}
},
"additionalProperties": false
},
"stylesPropertiesAndElementsComplete": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/stylesProperties"
},
{
"properties": {
"border": {},
"color": {},
"dimensions": {},
"spacing": {},
"typography": {},
"filter": {},
"shadow": {},
"outline": {},
"css": {},
"elements": {
"$ref": "#/definitions/stylesElementsPropertiesComplete"
},
"variations": {
"$ref": "#/definitions/stylesVariationPropertiesComplete"
}
},
"additionalProperties": false
}
]
},
"stylesVariationPropertiesComplete": {
"type": "object",
"patternProperties": {
"^[a-z][a-z0-9-]*$": {
"$ref": "#/definitions/stylesPropertiesComplete"
}
}
}
},
"type": "object",
"properties": {
"$schema": {
"description": "JSON schema URI for theme.json.",
"type": "string"
},
"version": {
"description": "Version of theme.json to use.",
"type": "integer",
"enum": [ 2 ]
},
"title": {
"type": "string",
"description": "Title of the global styles variation. If not defined, the file name will be used."
},
"description": {
"type": "string",
"description": "Description of the global styles variation."
},
"behaviors": {
"description": "A list of blocks that have behaviors. This setting controls the display of the Behaviors UI in the block editor.",
"type": "object",
"properties": {
"blocks": {
"type": "object",
"properties": {
"core/image": {
"$ref": "#/definitions/behaviorsBlocksPropertiesComplete"
}
},
"additionalProperties": false
}
}
},
"settings": {
"description": "Settings for the block editor and individual blocks. These include things like:\n- Which customization options should be available to the user. \n- The default colors, font sizes... available to the user. \n- CSS custom properties and class names used in styles.\n- And the default layout of the editor (widths and available alignments).",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/settingsProperties"
},
{
"properties": {
"appearanceTools": {},
"useRootPaddingAwareAlignments": {
"$ref": "#/definitions/settingsPropertiesUseRootPaddingAwareAlignments/properties/useRootPaddingAwareAlignments"
},
"color": {},
"layout": {},
"spacing": {},
"typography": {},
"border": {},
"shadow": {},
"position": {},
"dimensions": {},
"custom": {},
"blocks": {
"description": "Settings defined on a per-block basis.",
"$ref": "#/definitions/settingsBlocksPropertiesComplete"
}
},
"additionalProperties": false
}
]
},
"styles": {
"description": "Organized way to set CSS properties. Styles in the top-level will be added in the `body` selector.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/stylesProperties"
},
{
"properties": {
"border": {},
"color": {},
"spacing": {},
"typography": {},
"filter": {},
"shadow": {},
"outline": {},
"css": {},
"elements": {
"description": "Styles defined on a per-element basis using the element's selector.",
"$ref": "#/definitions/stylesElementsPropertiesComplete"
},
"blocks": {
"description": "Styles defined on a per-block basis using the block's selector.",
"$ref": "#/definitions/stylesBlocksPropertiesComplete"
}
},
"additionalProperties": false
}
]
},
"customTemplates": {
"description": "Additional metadata for custom templates defined in the templates folder.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Filename, without extension, of the template in the templates folder.",
"type": "string"
},
"title": {
"description": "Title of the template, translatable.",
"type": "string"
},
"postTypes": {
"description": "List of post types that can use this custom template.",
"type": "array",
"items": {
"type": "string"
},
"default": [ "page" ]
}
},
"required": [ "name", "title" ],
"additionalProperties": false
}
},
"templateParts": {
"description": "Additional metadata for template parts defined in the parts folder.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Filename, without extension, of the template in the parts folder.",
"type": "string"
},
"title": {
"description": "Title of the template, translatable.",
"type": "string"
},
"area": {
"description": "The area the template part is used for. Block variations for `header` and `footer` values exist and will be used when the area is set to one of those.",
"type": "string",
"default": "uncategorized"
}
},
"required": [ "name" ],
"additionalProperties": false
}
},
"patterns": {
"description": "An array of pattern slugs to be registered from the Pattern Directory.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [ "version" ],
"additionalProperties": false
}
|
dependabot-2.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"dependency-type": {
"type": "string",
"enum": ["direct", "indirect", "all", "production", "development"],
"x-intellij-enum-metadata": {
"direct": {
"description": "All explicitly defined dependencies."
},
"indirect": {
"description": "Dependencies of direct dependencies (also known as sub-dependencies, or transient dependencies)."
},
"all": {
"description": "All explicitly defined dependencies. For bundler, pip, composer, cargo, also the dependencies of direct dependencies."
},
"production": {
"description": "Only dependencies in the 'Product dependency group'."
},
"development": {
"description": "Only dependencies in the 'Development dependency group'."
}
}
},
"update-types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"version-update:semver-major",
"version-update:semver-minor",
"version-update:semver-patch"
]
}
},
"insecure-external-code-execution": {
"type": "string",
"enum": ["allow", "deny"]
},
"versioning-strategy": {
"type": "string",
"enum": [
"lockfile-only",
"auto",
"widen",
"increase",
"increase-if-necessary"
],
"x-intellij-enum-metadata": {
"lockfile-only": {
"description": "Only create pull requests to update lockfiles updates. Ignore any new versions that would require package manifest changes."
},
"auto": {
"description": "Follow the default strategy described above."
},
"widen": {
"description": "Relax the version requirement to include both the new and old version, when possible."
},
"increase": {
"description": "Always increase the version requirement to match the new version."
},
"increase-if-necessary": {
"description": "Increase the version requirement only when required by the new version."
}
}
},
"package-ecosystem": {
"type": "string",
"enum": [
"bundler",
"cargo",
"composer",
"docker",
"elm",
"gitsubmodule",
"github-actions",
"gomod",
"gradle",
"maven",
"mix",
"npm",
"nuget",
"pip",
"pub",
"terraform"
]
},
"schedule-day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"schedule-interval": {
"type": "string",
"enum": ["daily", "weekly", "monthly"]
},
"update": {
"type": "object",
"properties": {
"allow": {
"description": "Customize which updates are allowed",
"type": "array",
"items": {
"type": "object",
"properties": {
"dependency-name": {
"type": "string"
},
"dependency-type": {
"$ref": "#/definitions/dependency-type"
}
}
}
},
"assignees": {
"description": "Assignees to set on pull requests",
"type": "array",
"items": {
"type": "string"
},
"minimum": 1
},
"commit-message": {
"description": "Commit message preferences",
"type": "object",
"properties": {
"prefix": {
"type": "string"
},
"prefix-development": {
"type": "string"
},
"include": {
"type": "string",
"enum": ["scope"],
"default": "scope"
}
}
},
"directory": {
"description": "Location of package manifests",
"type": "string",
"default": "/"
},
"ignore": {
"description": "Ignore certain dependencies or versions",
"type": "array",
"items": {
"type": "object",
"properties": {
"dependency-name": {
"type": "string"
},
"update-types": {
"$ref": "#/definitions/update-types"
},
"versions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"insecure-external-code-execution": {
"description": "Allow or deny code execution in manifest files",
"$ref": "#/definitions/insecure-external-code-execution"
},
"labels": {
"description": "Labels to set on pull requests",
"type": "array",
"items": {
"type": "string"
},
"default": ["dependencies"]
},
"milestone": {
"description": "Milestone to set on pull requests",
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"open-pull-requests-limit": {
"description": "Limit number of open pull requests for version updates",
"type": "integer",
"default": 5
},
"package-ecosystem": {
"description": "Package manager to use",
"$ref": "#/definitions/package-ecosystem"
},
"pull-request-branch-name": {
"description": "Pull request branch name preferences",
"type": "object",
"properties": {
"separator": {
"description": "Change separator for PR branch name",
"type": "string",
"default": "/",
"enum": ["-", "_", "/"]
}
},
"required": ["separator"]
},
"rebase-strategy": {
"description": "Disable automatic rebasing",
"type": "string",
"enum": ["auto", "disabled"],
"default": "auto"
},
"reviewers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Reviewers to set on pull requests",
"minimum": 1
},
"schedule": {
"description": "Schedule preferences",
"type": "object",
"properties": {
"interval": {
"$ref": "#/definitions/schedule-interval"
},
"day": {
"$ref": "#/definitions/schedule-day",
"description": "Specify an alternative day to check for updates"
},
"time": {
"type": "string",
"description": "Specify an alternative time of day to check for updates (format: hh:mm)"
},
"timezone": {
"type": "string",
"description": "The time zone identifier must be from the Time Zone database maintained by IANA",
"default": "05:00 UTC"
}
}
},
"target-branch": {
"type": "string",
"description": "Branch to create pull requests against"
},
"vendor": {
"description": "Update vendored or cached dependencies",
"type": "boolean"
},
"versioning-strategy": {
"description": "How to update manifest version requirements",
"$ref": "#/definitions/versioning-strategy"
}
},
"required": ["package-ecosystem", "directory", "schedule"]
},
"registry": {
"type": "object",
"title": "registries",
"description": "The top-level registries key is optional. It allows you to specify authentication details that Dependabot can use to access private package registries.",
"additionalProperties": false,
"patternProperties": {
".*": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Identifies the type of registry.",
"enum": [
"composer-repository",
"docker-registry",
"git",
"hex-organization",
"hex-repository",
"maven-repository",
"npm-registry",
"nuget-feed",
"python-index",
"rubygems-server",
"terraform-registry"
]
},
"url": {
"description": "The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, https:// is assumed. Dependabot adds or ignores trailing slashes as required.",
"type": "string"
},
"username": {
"description": "The username that Dependabot uses to access the registry.",
"type": "string"
},
"password": {
"description": "A reference to a Dependabot secret containing the password for the specified user.",
"type": "string"
},
"key": {
"description": "A reference to a Dependabot secret containing an access key for this registry.",
"type": "string"
},
"token": {
"description": "A reference to a Dependabot secret containing an access token for this registry.",
"type": "string"
},
"replaces-base": {
"description": "For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).",
"type": "boolean"
},
"organization": {
"description": "",
"type": "string"
},
"repo": {
"description": "",
"type": "string"
},
"auth-key": {
"description": "",
"type": "string"
},
"public-key-fingerprint": {
"description": "",
"type": "string"
}
},
"required": ["type"]
}
}
}
},
"id": "https://json.schemastore.org/dependabot-2.0.json",
"properties": {
"version": {
"anyOf": [
{
"type": "string",
"default": "2"
},
{
"type": "integer",
"default": 2
}
]
},
"enable-beta-ecosystems": {
"description": "Enable ecosystems that have beta-level support",
"type": "boolean"
},
"updates": {
"type": "array",
"items": {
"title": "Package Ecosystem",
"description": "Element for each one package manager that you want GitHub Dependabot to monitor for new versions",
"$ref": "#/definitions/update"
}
},
"registries": {
"type": "object",
"$ref": "#/definitions/registry"
}
},
"required": ["version", "updates"],
"title": "GitHub Dependabot v2 config",
"type": "object"
}
|
dart-test.json | {
"$id": "https://json.schemastore.org/dart-test",
"$ref": "#/definitions/runnerConfiguration",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"timeout": {
"$comment": "Based on https://github.com/dart-lang/test/blob/3b8d3b90efd24f55f7316cd414716d1cb031761c/pkgs/test_api/lib/src/frontend/timeout.dart#L55-L68",
"oneOf": [
{
"enum": ["none"],
"title": "No timeout",
"description": "Indicates that tests should never time out."
},
{
"type": "string",
"title": "Exact timeout",
"description": "Exact timeout duration for a test.",
"pattern": "^(?:[^a-df-zA-DF-Z\\s]+(?:[umUM][sS]|[dhmsDHMS])\\s?)+$",
"examples": ["1m", "30s", "1m 30s"]
},
{
"type": "string",
"title": "Multiplicative timeout",
"description": "Timeout is applied as a multiple of the default value (30 seconds)",
"pattern": "^[^a-df-zA-DF-Z\\s]+[xX]$",
"examples": ["12x", "1.5X"]
}
]
},
"skip": {
"oneOf": [
{
"type": "boolean",
"title": "Skip the test if true"
},
{
"type": "string",
"title": "Reason for skipping the test"
}
]
},
"executable": {
"type": "string",
"description": "The executable to run. Can be a plain basename, an absolute path or a relative path on Windows."
},
"browserAndNodeSettings": {
"type": "object",
"title": "Settings for browsers and Node.js",
"additionalProperties": false,
"properties": {
"arguments": {
"type": "string",
"title": "Extra arguments to the executable",
"description": "The arguments are parsed in the same way as the POSIX shell"
},
"executable": {
"oneOf": [
{
"$ref": "#/definitions/executable"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"linux": {
"$ref": "#/definitions/executable"
},
"mac_os": {
"$ref": "#/definitions/executable"
},
"windows": {
"$ref": "#/definitions/executable"
}
}
}
]
},
"headless": {
"type": "boolean",
"title": "Run the browser in headless mode"
}
}
},
"foldStackFrameOptions": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"except": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"only": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"testConfiguration": {
"type": "object",
"$comment": "Based on https://github.com/dart-lang/test/blob/master/pkgs/test/doc/configuration.md#test-configuration",
"properties": {
"timeout": {
"$ref": "#/definitions/timeout"
},
"verbose_trace": {
"type": "boolean",
"title": "Remove internal stack frames",
"description": "This field controls whether or not traces caused by errors are trimmed to remove internal stack frames. This includes frames from the Dart core libraries, the stack_trace package, and the test package itself.",
"default": false
},
"chain_stack_traces": {
"type": "boolean",
"title": "Whether stack traces are chained",
"description": "Disabling stack trace chaining will improve performance for heavily async code at the cost of debuggability."
},
"js_trace": {
"type": "boolean",
"title": "Convert JS traces to Dart traces",
"description": "Whether or not stack traces caused by errors while running Dart compiled to JS are converted back to Dart style.",
"default": false
},
"skip": {
"$ref": "#/definitions/skip"
},
"retry": {
"type": "number",
"description": "This field controls how many times a test is retried upon failure."
},
"test_on": {
"type": "string",
"examples": ["browser && !ie"]
},
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/_testConfigurationInner"
}
},
"add_tags": {
"type": "array",
"description": "Adds additional tags. This is usually used in a tag definition to enable tag inheritance.",
"items": {
"type": "string"
}
},
"on_platform": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/_testConfigurationInner"
}
}
}
},
"_testConfigurationInner": {
"$comment": "presets and on_os can have different properties when used in a test vs runner configuration. We make runnerConfiguration extend from testConfiguration, so this configuration is used when we're definitely in a non-runner configuration context.",
"allOf": [
{
"$ref": "#/definitions/testConfiguration"
},
{
"properties": {
"presets": {
"type": "object",
"description": "A preset used in a test configuration can contain test configuration.",
"additionalProperties": {
"$ref": "#/definitions/testConfiguration"
}
},
"on_os": {
"type": "object",
"description": "Applies test options when a specific operating system is used",
"additionalProperties": {
"$ref": "#/definitions/testConfiguration"
}
}
}
}
]
},
"runnerConfiguration": {
"allOf": [
{
"$comment": "Runner configurations are a superset of test configurations",
"$ref": "#/definitions/testConfiguration"
},
{
"properties": {
"include": {
"type": "string",
"format": "uri"
},
"paths": {
"type": "array",
"items": {
"type": "string"
},
"default": ["test"]
},
"filename": {
"type": "string",
"description": "Filename pattern that the test runner uses to find test files in directories."
},
"names": {
"type": "array",
"description": "Only run tests whose names match the given regular expressions A test's name must match all regular expressions in names in order to be run.",
"items": {
"type": "string"
}
},
"plain_names": {
"type": "array",
"description": "This field causes the runner to only run tests whose names contain the given strings. A test's name must contain all strings in order to be run.",
"items": {
"type": "string"
}
},
"include_tags": {
"type": "string",
"description": "This field causes the runner to only run tests whose tags match the given boolean selector."
},
"exclude_tags": {
"type": "string",
"description": "This field causes the runner to only run tests whose tags match the given boolean selector. This takes precedence over include_tags"
},
"platforms": {
"description": "The platforms on which tests should be run.",
"type": "array",
"items": {
"type": "string"
},
"default": ["vm"]
},
"concurrency": {
"type": "integer",
"description": "The default number of test suites to run in parallel. This defaults to approximately half the number of processors on the current machine. Setting it to 1 will disable concurrency"
},
"pause_after_load": {
"type": "boolean",
"description": "Indicates that the test runner should pause for debugging after each test suite is loaded but before its tests are executed. This disables concurrency and timeouts."
},
"run_skipped": {
"type": "boolean",
"description": "Run tests even if they're marked as skipped."
},
"reporter": {
"type": "string",
"description": "This field indicates the default reporter to use.",
"examples": ["compact", "expanded", "json"]
},
"file_reporters": {
"type": "object",
"description": "Specifies additional reporters that will write their output to a file rather than stdout",
"additionalProperties": {
"type": "string"
}
},
"fold_stack_frames": {
"$ref": "#/definitions/foldStackFrameOptions"
},
"custom_html_template_path": {
"description": "This field specifies the path of the HTML template to be used for tests run in an HTML environment.",
"type": "string"
},
"presets": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/runnerConfiguration"
}
},
"add_presets": {
"type": "array",
"description": "Commonly used in a preset, it can be used to enable present inheritance by adding the configuration from another preset.",
"items": {
"type": "string"
}
},
"on_os": {
"type": "object",
"description": "Applies test or runner options when a specific operating system is used",
"additionalProperties": {
"$ref": "#/definitions/runnerConfiguration"
}
},
"override_platforms": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"settings": {
"$ref": "#/definitions/browserAndNodeSettings"
}
}
}
},
"define_platforms": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"extends": {
"type": "string"
},
"settings": {
"$ref": "#/definitions/browserAndNodeSettings"
}
}
}
}
}
}
]
}
},
"description": "Configuration for Dart tests",
"title": "dart_test.yaml"
}
|
jsinspectrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://json.schemastore.org/jsinspectrc.json",
"properties": {
"identifiers": {
"default": false,
"description": "A flag indicating whether to limit the search to nodes with matching identifiers",
"type": "boolean"
},
"ignore": {
"description": "A regular expression used for matching paths to ignore",
"type": "string"
},
"jsx": {
"default": false,
"description": "A flag indicating whether to process JSX files",
"type": "boolean"
},
"reporter": {
"default": "default",
"description": "The name of the reporter to be used",
"enum": ["default", "json", "pmd"],
"type": "string"
},
"suppress": {
"default": 100,
"description": "The number of lines at which diffs should be suppressed. A value of 0 is off.",
"minimum": 0,
"type": "integer"
},
"threshold": {
"default": 15,
"description": "A threshold determining the smallest subset of nodes to analyze",
"type": "integer"
}
},
"title": "JSON schema for JSInspect configuration files",
"type": "object"
}
|
sfdx-hardis.jsonschema.json | {
"$id": "http://github.com/hardisgroupcom/sfdx-hardis.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "Configuration file definition for sfdx-hardis Salesforce DX plugin",
"properties": {
"allowedOrgTypes": {
"$id": "#/properties/allowedOrgTypes",
"description": "Types of orgs allowed for config & development. If not set, sandbox and scratch are allowed by default",
"examples": [["sandbox"]],
"items": {
"type": "string",
"enum": ["sandbox", "scratch"]
},
"title": "Allowed org types",
"type": "array"
},
"autoCleanTypes": {
"$id": "#/properties/autoCleanTypes",
"description": "When saving a sfdx-hardis task, the list of cleanings will be automatically applied to sfdx sources",
"examples": [["dashboards", "datadotcom", "destructivechanges"]],
"items": {
"type": "string",
"enum": [
"caseentitlement",
"dashboards",
"datadotcom",
"destructivechanges",
"localfields",
"listViewsMine",
"minimizeProfiles",
"productrequest",
"systemDebug"
]
},
"title": "Auto-Cleaning types",
"type": "array"
},
"autoRemoveUserPermissions": {
"$id": "#/properties/autoRemoveUserPermissions",
"description": "When saving a sfdx-hardis task, these permissions will be removed from profiles",
"examples": [["EnableCommunityAppLauncher", "FieldServiceAccess", "OmnichannelInventorySync"]],
"items": {
"type": "string"
},
"title": "Auto-Remove User Permissions on profiles",
"type": "array"
},
"autoRetrieveWhenPull": {
"$id": "#/properties/autoRetrieveWhenPull",
"description": "When calling hardis:scratch:pull, if you define metadatas (named or not), they will also be retrieved using force:source:retrieve",
"examples": [["CustomApplication"], ["CustomApplication:MyApp1", "CustomApplication:MyApp2"]],
"items": {
"type": "string"
},
"title": "Auto-Retrieve when pull",
"type": "array"
},
"apexTestsMinCoverageOrgWide": {
"$id": "#/properties/apexTestsMinCoverageOrgWide",
"default": 75.0,
"description": "Minimum percentage of apex code coverage accepted",
"examples": [80.0, 95.0],
"title": "Minimum apex test coverage %",
"type": "number"
},
"availableProjects": {
"$id": "#/properties/availableProjects",
"description": "List of business projects that are managed in the same repository. Will be used to build git branch name when using hardis:work:new",
"examples": [["sales_cloud", "service_cloud", "community"]],
"items": {
"type": "string"
},
"title": "Available projects",
"type": "array"
},
"availableTargetBranches": {
"$id": "#/properties/availableTargetBranches",
"description": "List of git branches that can be used as target for merge requests",
"examples": [["develop", "develop_next"]],
"items": {
"type": "string"
},
"title": "Available target branches",
"type": "array"
},
"branchPrefixChoices": {
"$id": "#/properties/branchPrefixChoices",
"description": "When calling hardis:work:new, you can override the default branch prefixes. Input title, value and description for each of them",
"default": [
{
"title": "Feature",
"value": "feat",
"description": "New feature, evolution of an existing feature... If you don't know, just select Feature"
},
{ "title": "Debug", "value": "fix", "description": "A bug has been identified and you are the right person to solve it !" }
],
"examples": [
[
{
"title": "Feature",
"value": "feat",
"description": "New feature, evolution of an existing feature... If you don't know, just select Feature"
},
{ "title": "Debug", "value": "fix", "description": "A bug has been identified and you are the right person to solve it !" }
]
],
"title": "New branches prefixes choices",
"type": "array"
},
"cleanXmlPatterns": {
"$id": "#/properties/cleanXmlPatterns",
"examples": [
[
{
"globPattern": "/**/*.flexipage-meta.xml",
"xpaths": ["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]
},
{
"globPattern": "/**/*.layout-meta.xml",
"xpaths": ["//ns:relatedLists//ns:relatedList[contains(text(),'RelatedSolutionList')]"]
}
]
],
"description": "List of patterns to automatically clean XML files",
"items": {
"$id": "#/properties/cleanXmlPatterns/items",
"type": "object",
"additionalProperties": false,
"description": "Clean XML pattern and xpaths",
"properties": {
"globPattern": {
"$id": "#/properties/cleanXmlPatterns/items/properties/globPattern",
"description": "Glob pattern to identify XML files to clean",
"examples": ["/**/*.flexipage-meta.xml"],
"title": "Glob pattern",
"type": "string"
},
"xpaths": {
"$id": "#/properties/cleanXmlPatterns/items/properties/xpaths",
"description": "XPaths to identify elements to remove",
"examples": [["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]],
"title": "XPath list",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": ["globPattern", "xpaths"]
},
"title": "Clean XML Patterns",
"type": "array"
},
"customCommands": {
"$id": "#/properties/customCommands",
"description": "List of custom commands for VsCode SFDX-Hardis extension",
"examples": [
[
{
"id": "custom-menu",
"label": "Custom commands",
"commands": [
{
"id": "generate-manifest-xml",
"label": "Generate manifest",
"icon": "file.svg",
"tooltip": "Generates a manifest package.xml using local sfdx source files",
"command": "sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest"
},
{
"id": "list-all-orgs",
"label": "List all orgs",
"icon": "salesforce.svg",
"tooltip": "List all orgs that has already been authenticated using sfdx",
"command": "sfdx force:org:list --all"
}
]
},
{
"id": "custom-menu-2",
"label": "Another custom menu",
"commands": [
{
"id": "echo",
"label": "Echo something",
"icon": "user.svg",
"tooltip": "Useless commands just to show that we can use not sfdx commands too",
"command": "echo \"Something\""
}
]
}
]
],
"items": {
"$id": "#/properties/customCommands/items",
"type": "object",
"additionalProperties": false,
"description": "Custom command definition",
"properties": {
"id": {
"$id": "#/properties/customCommands/items/properties/id",
"description": "Identifier of the menu (can be any string)",
"title": "Id",
"type": "string"
},
"label": {
"$id": "#/properties/customCommands/items/properties/label",
"description": "Label of the menu",
"title": "Label",
"type": "string"
},
"commands": {
"$id": "#/properties/customCommands/items/properties/commands",
"description": "List of commands of the menu",
"items": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties",
"type": "object",
"additionalProperties": false,
"description": "Custom command definition",
"properties": {
"id": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties/id",
"description": "Identifier of the command (can be any string)",
"title": "Id",
"type": "string"
},
"label": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties/label",
"description": "Label of the command that will appear in menu",
"title": "Label",
"type": "string"
},
"icon": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties/icon",
"description": "Icon (can be any of svg icons of this list: https://github.com/hardisgroupcom/vscode-sfdx-hardis/tree/master/resources",
"title": "Icon",
"type": "string"
},
"tooltip": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties/tooltip",
"description": "Text that will appear when user will hover the command",
"title": "Tooltip",
"type": "string"
},
"command": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties/command",
"description": "Command line to run when clicking on the menu",
"title": "Command",
"type": "string"
},
"helpUrl": {
"$id": "#/properties/customCommands/items/properties/commands/items/properties/helpUrl",
"description": "URL for help page of the command",
"title": "Help url",
"type": "string"
}
},
"required": ["id", "label", "command"]
},
"title": "Label",
"type": "array"
}
},
"required": ["id", "label"]
},
"title": "Custom commands",
"type": "array"
},
"customCommandsPosition": {
"$id": "#/properties/customCommandsPosition",
"description": "Position of custom commands in the menu (first or last)",
"default": "first",
"enum": ["first", "last"],
"examples": ["first", "last"],
"title": "Custom commands position",
"type": "string"
},
"customOrgColors": {
"$id": "#/properties/customOrgColors",
"additionalProperties": true,
"description": "Custom colors set by VsCode SFDX Hardis",
"title": "Custom Org Colors",
"type": "object"
},
"customPlugins": {
"$id": "#/properties/customPlugins",
"description": "List of additional plugins that will be displayed in VsCode SFDX-Hardis Dependencies panel",
"examples": [
[
{
"name": "mo-dx-plugin",
"helpUrl": "https://github.com/msrivastav13/mo-dx-plugin"
},
{
"name": "shane-sfdx-plugins",
"helpUrl": "https://github.com/mshanemc/shane-sfdx-plugins"
}
]
],
"items": {
"$id": "#/properties/customPlugins/items",
"type": "object",
"additionalProperties": false,
"description": "Plugin definition",
"properties": {
"name": {
"$Id": "#/properties/customPlugins/items/properties/name",
"description": "Name of the plugin npm package",
"examples": ["mo-dx-plugin", "shane-sfdx-plugins"],
"title": "Name",
"type": "string"
},
"helpUrl": {
"$Id": "#/properties/customPlugins/items/properties/helpUrl",
"description": "Url of plugin documentation",
"examples": ["https://github.com/msrivastav13/mo-dx-plugin", "https://github.com/mshanemc/shane-sfdx-plugins"],
"title": "Name",
"type": "string"
}
},
"title": "Plugin"
},
"title": "Custom plugins",
"type": "array"
},
"dataPackages": {
"$id": "#/properties/dataPackages",
"description": "List of data packages",
"items": {
"$id": "#/properties/dataPackages/items",
"type": "object",
"additionalProperties": false,
"description": "Data package",
"properties": {
"dataPath": {
"$id": "#/properties/dataPackages/items/properties/dataPath",
"description": "Path to SFDMU project",
"title": "SFDMU Data project path",
"type": "string"
},
"importInScratchOrgs": {
"$id": "#/properties/dataPackages/items/properties/importInScratchOrgs",
"description": "Path to SFDMU project",
"title": "SFDMU Data project path",
"type": "boolean"
}
},
"required": ["dataPath", "importInScratchOrgs"]
},
"title": "Data packages",
"type": "array"
},
"defaultPackageInstallationKey": {
"$id": "#/properties/defaultPackageInstallationKey",
"description": "When generating a new package version protected with password, use this value as default package installation key",
"examples": ["hardis", "myPassword", "dFGGF43656YfdFDG{{{dhgfh:::;FSEDSFd78"],
"title": "Defaut package installation key",
"type": "string"
},
"developmentBranch": {
"$id": "#/properties/developmentBranch",
"default": "developpement",
"description": "When creating a new sfdx-hardis task, this git branch is used as base to create the feature/debug sub branch. The merge request will later have this branch as target.",
"examples": ["developpement", "dev_lot2", "hotfixes"],
"title": "Default pull/merge request target org",
"type": "string"
},
"deploymentPlan": {
"$id": "#/properties/deploymentPlan",
"description": "Deployment plan that will be performed during deployments. Can be based on packageXmlFile for sources or on dataPath for sfdmu data deployments",
"examples": [
{
"packages": [
{
"label": "Import EmailTemplate records",
"dataPath": "scripts/data/EmailTemplate",
"order": -21
},
{
"label": "Deploy EmailTemplate",
"packageXmlFile": "manifest/splits/packageXmlEmails.xml",
"order": -20
},
{
"label": "Deploy Flow-Workflow",
"packageXmlFile": "manifest/splits/packageXmlFlowWorkflow.xml",
"order": 6
}
]
}
],
"properties": {
"packages": {
"$id": "#/properties/deploymentPlan/properties/packages",
"description": "During deployment, main package.xml will be split into these packages. Can also contain data packages",
"examples": [
[
{
"label": "Import EmailTemplate records",
"dataPath": "scripts/data/EmailTemplate",
"order": -21
},
{
"label": "Deploy EmailTemplate",
"packageXmlFile": "manifest/splits/packageXmlEmails.xml",
"order": -20
}
]
],
"items": {
"$id": "#/properties/install/properties/packages/items",
"type": "object",
"additionalProperties": false,
"description": "Source or data package to deploy",
"properties": {
"dataPath": {
"$id": "#/properties/install/properties/packages/items/dataPath",
"examples": ["scripts/data/EmailTemplate"],
"title": "Path to SFDMU data project to deploy",
"type": "string"
},
"label": {
"$id": "#/properties/install/properties/packages/items/label",
"examples": ["Deploy EmailTemplate", "Import EmailTemplate records"],
"title": "Source or data package label",
"type": "string"
},
"order": {
"$id": "#/properties/install/properties/packages/items/order",
"examples": [-20, 13, 50],
"title": "Execution order in deployment plan",
"type": "number"
},
"packageXmlFile": {
"$id": "#/properties/install/properties/packages/items/packageXmlFile",
"examples": ["manifest/splits/packageXmlEmails.xml"],
"title": "Path to package.xml file to use for deployment",
"type": "string"
},
"waitAfter": {
"$id": "#/properties/install/properties/packages/items/waitAfter",
"description": "Delay to wait before installing the next package",
"examples": [10, 20],
"title": "Wait after install (seconds)",
"type": "number"
}
}
},
"required": ["label", "order"],
"title": "List of packages to deploy",
"type": "array"
}
},
"title": "Deployment plan",
"type": "object"
},
"devHubAlias": {
"$id": "#/properties/devHubAlias",
"default": "",
"description": "Dev Hub alias, usually DevHub_ProjectName",
"examples": ["DevHub_MyClientMyProject", "DevHub_GoogleGmail", "DevHub_AppleIWatch"],
"title": "Dev Hub org alias",
"type": "string"
},
"devHubUsername": {
"$id": "#/properties/devHubUsername",
"default": "",
"description": "Dev Hub username, used to authenticate to DevHub from CI jobs",
"examples": ["[email protected]", "[email protected]", "[email protected]"],
"title": "Dev Hub Username",
"type": "string"
},
"extends": {
"$id": "#/properties/extends",
"description": "You can base your local sfdx-hardis configuration on a remote config file. That allows you to have the same config base for all your projects",
"examples": ["https://raw.githubusercontent.com/worldcompany/shared-config/main/.sfdx-hardis.yml"],
"title": "Extends remote configuration URL",
"type": "string"
},
"initPermissionSets": {
"$id": "#/properties/initPermissionSets",
"description": "When creating a scratch org, Admin user will be automatically assigned to those permission sets",
"examples": [["MyPermissionSet", "MyPermissionSetGroup"]],
"items": {
"$id": "#/properties/initPermissionSets/items",
"type": ["object", "string"],
"additionalProperties": false,
"description": "Permission Set or Permission Set Group",
"properties": {
"name": {
"$Id": "#/properties/initPermissionSets/items/properties/name",
"description": "Permission Set or Permission Set Group name",
"examples": [["MyPermissionSet", "MyPermissionSetGroup", "MyPermissionSetGroup2"]],
"title": "Name",
"type": "string"
}
}
},
"title": "Initial Permission Sets",
"type": "array"
},
"installedPackages": {
"$id": "#/properties/installedPackages",
"description": "Defines the list of packages installed on the project. Use ",
"examples": [
[
{
"Id": "0A30N000000ALWrSAO",
"SubscriberPackageId": "033b0000000Pf2AAAS",
"SubscriberPackageName": "Declarative Lookup Rollup Summaries Tool",
"SubscriberPackageNamespace": "dlrs",
"SubscriberPackageVersionId": "04t0N000000IyYrQAK",
"SubscriberPackageVersionName": "2.11",
"SubscriberPackageVersionNumber": "2.11.0.1",
"installOnScratchOrgs": false,
"installDuringDeployments": true,
"installationkey": "MyInstallationKey"
},
{
"Id": "0A35r000000GveVCAS",
"SubscriberPackageId": "0330o000000B3vIAAS",
"SubscriberPackageName": "Files Attachment Notes",
"SubscriberPackageNamespace": "fan_astrea",
"SubscriberPackageVersionId": "04t0o000003nRWAAA2",
"SubscriberPackageVersionName": "Summer2021",
"SubscriberPackageVersionNumber": "1.22.0.2",
"installOnScratchOrgs": true,
"installDuringDeployments": true
}
]
],
"items": {
"$id": "#/properties/installedPackages/items",
"type": "object",
"additionalProperties": false,
"description": "Salesforce package info (managed, unlocked or unmanaged)",
"properties": {
"Id": {
"$Id": "#/properties/install/properties/packages/items/Id",
"examples": ["0A35r000000GveVCAS"],
"title": "(unused) PackageId",
"type": "string"
},
"SubscriberPackageId": {
"$Id": "#/properties/install/properties/packages/items/SubscriberPackageId",
"examples": ["033b0000000Pf2AAAS"],
"title": "Subscriber Package Id",
"type": "string"
},
"SubscriberPackageName": {
"$Id": "#/properties/install/properties/packages/items/SubscriberPackageName",
"examples": ["Files Attachment Notes"],
"title": "Subscriber Package Name",
"type": "string"
},
"SubscriberPackageNamespace": {
"$Id": "#/properties/install/properties/packages/items/SubscriberPackageNamespace",
"examples": ["fan_astrea"],
"title": "Subscriber Package NameSpace",
"type": ["string", "null"]
},
"SubscriberPackageVersionId": {
"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionId",
"examples": ["04t0o000003nRWAAA2"],
"title": "Subscriber Version Id (IMPORTANT)",
"type": "string"
},
"SubscriberPackageVersionName": {
"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionName",
"examples": ["Summer2021"],
"title": "Subscriber Version Name",
"type": "string"
},
"SubscriberPackageVersionNumber": {
"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionNumber",
"examples": ["1.22.0.2"],
"title": "Subscriber Version Number",
"type": "string"
},
"installDuringDeployments": {
"$Id": "#/properties/install/properties/packages/items/installDuringDeployments",
"default": false,
"description": "If true, during deployments this package will be installed in target org if not installed yet",
"examples": [true, false],
"title": "Install during deployments",
"type": "boolean"
},
"installOnScratchOrgs": {
"$Id": "#/properties/install/properties/packages/items/installOnScratchOrgs",
"default": false,
"description": "If true, this package will be installed when creating a new scratch org with sfdx-hardis",
"examples": [true, false],
"title": "Install on scratch orgs",
"type": "boolean"
},
"installationkey": {
"$Id": "#/properties/install/properties/packages/items/installationkey",
"examples": ["MyInstallationKey", "4FzkMzUSwFfP#@"],
"description": "Installation key for key-protected package",
"title": "Package installation key",
"type": "string"
}
},
"required": ["SubscriberPackageVersionId"],
"title": "Salesforce package"
},
"title": "Installed Packages",
"type": "array"
},
"installPackagesDuringCheckDeploy": {
"$id": "#/properties/installPackagesDuringCheckDeploy",
"default": false,
"description": "When calling deployment check command, installs any package referred within installedPackages property",
"examples": [true],
"title": "Install packages during deployment checks",
"type": "boolean"
},
"instanceUrl": {
"$id": "#/properties/instanceUrl",
"default": "",
"description": "Salesforce instance URL used by CI for deployment or backups",
"examples": ["https://myclient.force.com", "https://google.force.com", "https://apple.force.com"],
"title": "Instance URL",
"type": "string"
},
"listViewsToSetToMine": {
"$id": "#/properties/listViewsToSetToMine",
"default": [],
"description": "List of ListView items to set to Mine after a delivery (that does not accept value 'Everything')",
"examples": [],
"items": {
"type": "string"
},
"title": "List views to set to Mine",
"type": "array"
},
"sourcesToRetrofit": {
"$id": "#/properties/sourcesToRetrofit",
"description": "List of metadata to retrieve for retrofit job",
"examples": [["CustomField", "Layout", "PermissionSet"]],
"items": {
"type": "string"
},
"title": "Metadata to retrofit",
"type": "array"
},
"msTeamsWebhookUrl": {
"$id": "#/properties/msTeamsWebhookUrl",
"default": "",
"description": "Url of the Ms Teams channel Web Hook that can be used to send ALL notifications",
"examples": ["https://my.msteams.webhook.url"],
"title": "MsTeams WebHook Url (ALL)",
"type": "string"
},
"msTeamsWebhookUrlCritical": {
"$id": "#/properties/msTeamsWebhookUrlCritical",
"default": "",
"description": "Url of the Ms Teams channel Web Hook that can be used to send CRITICAL notifications",
"examples": ["https://my.msteams.webhook.url"],
"title": "MsTeams WebHook Url (CRITICAL)",
"type": "string"
},
"msTeamsWebhookUrlSevere": {
"$id": "#/properties/msTeamsWebhookUrlSevere",
"default": "",
"description": "Url of the Ms Teams channel Web Hook that can be used to send SEVERE notifications",
"examples": ["https://my.msteams.webhook.url"],
"title": "MsTeams WebHook Url (SEVERE)",
"type": "string"
},
"msTeamsWebhookUrlWarning": {
"$id": "#/properties/msTeamsWebhookUrlWarning",
"default": "",
"description": "Url of the Ms Teams channel Web Hook that can be used to send WARNING notifications",
"examples": ["https://my.msteams.webhook.url"],
"title": "MsTeams WebHook Url (WARNING)",
"type": "string"
},
"msTeamsWebhookUrlInfo": {
"$id": "#/properties/msTeamsWebhookUrlWarning",
"default": "",
"description": "Url of the Ms Teams channel Web Hook that can be used to send INFO notifications",
"examples": ["https://my.msteams.webhook.url"],
"title": "MsTeams WebHook Url (INFO)",
"type": "string"
},
"poolConfig": {
"$id": "#/properties/poolConfig",
"description": "Configuration allowing to generate and fetch scratch orgs from scratch org pool",
"examples": [
{
"maxScratchOrgsNumber": 10,
"storageService": "kvdb.io"
}
],
"title": "Scratch org pool configuration",
"type": "object",
"properties": {
"minScratchOrgRemainingDays": {
"$id": "#/properties/poolConfig/minScratchOrgRemainingDays",
"description": "When pool scratch org is less than this number, it is deleted and another one is created",
"title": "Min scratch org remaining days",
"default": 25,
"type": "number"
},
"maxScratchOrgsNumber": {
"$id": "#/properties/poolConfig/maxScratchOrgsNumber",
"description": "Maximum number of active scratch orgs in the scratch org pool",
"title": "Maximum number of scratch orgs",
"type": "number"
},
"maxScratchOrgsNumberToCreateOnce": {
"$id": "#/properties/poolConfig/maxScratchOrgsNumberToCreateOnce",
"description": "Maximum number of scratch orgs to create in one CI job",
"title": "Maximum number of scratch orgs to create once",
"type": "number"
},
"storageService": {
"$id": "#/properties/poolConfig/storageService",
"description": "Remote service allowing to store scratch org pool details",
"title": "Storage service for scratch org pool",
"type": "string"
}
}
},
"productionBranch": {
"$id": "#/properties/productionBranch",
"default": "",
"description": "Name of the git branch corresponding to production environment",
"examples": ["master", "main", "production"],
"title": "Production branch name",
"type": "string"
},
"projectName": {
"$id": "#/properties/projectName",
"default": "",
"description": "Identifier for the project (can be the client and project)",
"examples": ["MyClientMyProject", "GoogleGmail", "AppleIWatch"],
"title": "Project Name",
"type": "string"
},
"retrofitBranch": {
"$id": "#/properties/retrofitBranch",
"default": "",
"description": "Name of the git branch where retrofit merge requests targets to",
"examples": ["preprod", "dev", "maintenance"],
"title": "Retrofit branch name",
"type": "string"
},
"retrofitIgnoredFiles": {
"$id": "#/properties/retrofitIgnoredFiles",
"description": "When calling hardis:org:retrieve:sources:retrofit, list of files to ignore (discard just after retrieve)",
"examples": [
[
"force-app/main/default/applications/MyAppIWantToManageInProduction.app-meta.xml",
"force-app/main/default/flexipages/MyFlexipageWithDashboards.flexipage-meta.xml"
]
],
"items": {
"type": "string"
},
"title": "Retrofit ignored files",
"type": "array"
},
"scratchOrgInitApexScripts": {
"$id": "#/properties/scratchOrgInitApexScripts",
"description": "Apex scripts to call after scratch org initialization",
"examples": [["scripts/apex/init-scratch.apex", "scripts/apex/init-custom-settings.apex"]],
"items": {
"type": "string"
},
"title": "Scratch org init apex scripts",
"type": "array"
},
"sfdmuCanModify": {
"$id": "#/properties/sfdmuCanModify",
"default": "",
"description": "Instance host name to allow SFDMU to deploy data in a production org",
"examples": ["myproject.force.com"],
"title": "SFDMU can modify",
"type": "string"
},
"skipUpdateForceIgnore": {
"$id": "#/properties/skipUpdateForceIgnore",
"default": false,
"description": "Defines if sfdx-hardis will propose to upgrade local .forceignore file",
"title": "Skip update .forceignore file",
"type": "boolean"
},
"skipUpdateGitIgnore": {
"$id": "#/properties/skipUpdateGitIgnore",
"default": false,
"description": "Defines if sfdx-hardis will propose to upgrade local .gitignore file",
"title": "Skip update .gitignore file",
"type": "boolean"
},
"targetUsername": {
"$id": "#/properties/targetUsername",
"default": "",
"description": "Salesforce username used by CI for deployment or backups",
"examples": ["[email protected]", "[email protected]", "[email protected]"],
"title": "Target Username",
"type": "string"
},
"linterIgnoreRightMetadataFile": {
"$id": "#/properties/linterIgnoreRightMetadataFile",
"default": "",
"description": "Ignore profiles or permission sets",
"examples": ["Profile", "Profile:ProfileA", "PermissionSet", "PermissionSet:PermissionSetA, Profile:ProfileA"],
"title": "Linter ignore permission set or/and profile",
"type": "string"
}
},
"title": "sfdx-hardis configuration",
"type": "object"
}
|
sarif-2.1.0-rtm.6.json | {
"$id": "https://json.schemastore.org/sarif-2.1.0-rtm.6.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"address": {
"description": "A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).",
"additionalProperties": false,
"type": "object",
"properties": {
"absoluteAddress": {
"description": "The address expressed as a byte offset from the start of the addressable region.",
"type": "integer",
"minimum": -1,
"default": -1
},
"relativeAddress": {
"description": "The address expressed as a byte offset from the absolute address of the top-most parent object.",
"type": "integer"
},
"length": {
"description": "The number of bytes in this range of addresses.",
"type": "integer"
},
"kind": {
"description": "An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.",
"type": "string"
},
"name": {
"description": "A name that is associated with the address, e.g., '.text'.",
"type": "string"
},
"fullyQualifiedName": {
"description": "A human-readable fully qualified name that is associated with the address.",
"type": "string"
},
"offsetFromParent": {
"description": "The byte offset of this address from the absolute or relative address of the parent object.",
"type": "integer"
},
"index": {
"description": "The index within run.addresses of the cached object for this address.",
"type": "integer",
"default": -1,
"minimum": -1
},
"parentIndex": {
"description": "The index within run.addresses of the parent object.",
"type": "integer",
"default": -1,
"minimum": -1
},
"properties": {
"description": "Key/value pairs that provide additional information about the address.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifact": {
"description": "A single artifact. In some cases, this artifact might be nested within another artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A short description of the artifact.",
"$ref": "#/definitions/message"
},
"location": {
"description": "The location of the artifact.",
"$ref": "#/definitions/artifactLocation"
},
"parentIndex": {
"description": "Identifies the index of the immediate parent of the artifact, if this artifact is nested.",
"type": "integer",
"default": -1,
"minimum": -1
},
"offset": {
"description": "The offset in bytes of the artifact within its containing artifact.",
"type": "integer",
"minimum": 0
},
"length": {
"description": "The length of the artifact in bytes.",
"type": "integer",
"default": -1,
"minimum": -1
},
"roles": {
"description": "The role or roles played by the artifact in the analysis.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"enum": [
"analysisTarget",
"attachment",
"responseFile",
"resultFile",
"standardStream",
"tracedFile",
"unmodified",
"modified",
"added",
"deleted",
"renamed",
"uncontrolled",
"driver",
"extension",
"translation",
"taxonomy",
"policy",
"referencedOnCommandLine",
"memoryContents",
"directory",
"userSpecifiedConfiguration",
"toolSpecifiedConfiguration",
"debugOutputFile"
]
}
},
"mimeType": {
"description": "The MIME type (RFC 2045) of the artifact.",
"type": "string",
"pattern": "[^/]+/.+"
},
"contents": {
"description": "The contents of the artifact.",
"$ref": "#/definitions/artifactContent"
},
"encoding": {
"description": "Specifies the encoding for an artifact object that refers to a text file.",
"type": "string"
},
"sourceLanguage": {
"description": "Specifies the source language for any artifact object that refers to a text file that contains source code.",
"type": "string"
},
"hashes": {
"description": "A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"lastModifiedTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifactChange": {
"description": "A change to a single artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"artifactLocation": {
"description": "The location of the artifact to change.",
"$ref": "#/definitions/artifactLocation"
},
"replacements": {
"description": "An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/replacement"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the change.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactLocation", "replacements"]
},
"artifactContent": {
"description": "Represents the contents of an artifact.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "UTF-8-encoded content from a text artifact.",
"type": "string"
},
"binary": {
"description": "MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.",
"type": "string"
},
"rendered": {
"description": "An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).",
"$ref": "#/definitions/multiformatMessageString"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact content.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifactLocation": {
"description": "Specifies the location of an artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"uri": {
"description": "A string containing a valid relative or absolute URI.",
"type": "string",
"format": "uri-reference"
},
"uriBaseId": {
"description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.",
"type": "string"
},
"index": {
"description": "The index within the run artifacts array of the artifact object associated with the artifact location.",
"type": "integer",
"default": -1,
"minimum": -1
},
"description": {
"description": "A short description of the artifact location.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"attachment": {
"description": "An artifact relevant to a result.",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A message describing the role played by the attachment.",
"$ref": "#/definitions/message"
},
"artifactLocation": {
"description": "The location of the attachment.",
"$ref": "#/definitions/artifactLocation"
},
"regions": {
"description": "An array of regions of interest within the attachment.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/region"
}
},
"rectangles": {
"description": "An array of rectangles specifying areas of interest within the image.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/rectangle"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the attachment.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactLocation"]
},
"codeFlow": {
"description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to the code flow.",
"$ref": "#/definitions/message"
},
"threadFlows": {
"description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/threadFlow"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the code flow.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["threadFlows"]
},
"configurationOverride": {
"description": "Information about how a specific rule or notification was reconfigured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"configuration": {
"description": "Specifies how the rule or notification was configured during the scan.",
"$ref": "#/definitions/reportingConfiguration"
},
"descriptor": {
"description": "A reference used to locate the descriptor whose configuration was overridden.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the configuration override.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["configuration", "descriptor"]
},
"conversion": {
"description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "A tool object that describes the converter.",
"$ref": "#/definitions/tool"
},
"invocation": {
"description": "An invocation object that describes the invocation of the converter.",
"$ref": "#/definitions/invocation"
},
"analysisToolLogFiles": {
"description": "The locations of the analysis tool's per-run log files.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the conversion.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["tool"]
},
"edge": {
"description": "Represents a directed edge in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the edge within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the edge.",
"$ref": "#/definitions/message"
},
"sourceNodeId": {
"description": "Identifies the source node (the node at which the edge starts).",
"type": "string"
},
"targetNodeId": {
"description": "Identifies the target node (the node at which the edge ends).",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id", "sourceNodeId", "targetNodeId"]
},
"edgeTraversal": {
"description": "Represents the traversal of a single edge during a graph traversal.",
"type": "object",
"additionalProperties": false,
"properties": {
"edgeId": {
"description": "Identifies the edge being traversed.",
"type": "string"
},
"message": {
"description": "A message to display to the user as the edge is traversed.",
"$ref": "#/definitions/message"
},
"finalState": {
"description": "The values of relevant expressions after the edge has been traversed.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"stepOverEdgeCount": {
"description": "The number of edge traversals necessary to return from a nested graph.",
"type": "integer",
"minimum": 0
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge traversal.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["edgeId"]
},
"exception": {
"description": "Describes a runtime exception encountered during the execution of an analysis tool.",
"type": "object",
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal."
},
"message": {
"description": "A message that describes the exception.",
"type": "string"
},
"stack": {
"description": "The sequence of function calls leading to the exception.",
"$ref": "#/definitions/stack"
},
"innerExceptions": {
"description": "An array of exception objects each of which is considered a cause of this exception.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/exception"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the exception.",
"$ref": "#/definitions/propertyBag"
}
}
},
"externalProperties": {
"description": "The top-level element of an external property file.",
"type": "object",
"additionalProperties": false,
"properties": {
"schema": {
"description": "The URI of the JSON schema corresponding to the version of the external property file format.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this external properties object.",
"enum": ["2.1.0"]
},
"guid": {
"description": "A stable, unique identifier for this external properties object, in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"runGuid": {
"description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"conversion": {
"description": "A conversion object that will be merged with a separate run.",
"$ref": "#/definitions/conversion"
},
"graphs": {
"description": "An array of graph objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/graph"
}
},
"externalizedProperties": {
"description": "Key/value pairs that provide additional information that will be merged with a separate run.",
"$ref": "#/definitions/propertyBag"
},
"artifacts": {
"description": "An array of artifact objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifact"
}
},
"invocations": {
"description": "Describes the invocation of the analysis tool that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/invocation"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"results": {
"description": "An array of result objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/result"
}
},
"taxonomies": {
"description": "Tool taxonomies that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"driver": {
"description": "The analysis tool object that will be merged with a separate run.",
"$ref": "#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"policies": {
"description": "Tool policies that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"translations": {
"description": "Tool translations that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/address"
}
},
"webRequests": {
"description": "Requests that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webRequest"
}
},
"webResponses": {
"description": "Responses that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webResponse"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external properties.",
"$ref": "#/definitions/propertyBag"
}
}
},
"externalPropertyFileReference": {
"description": "Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.",
"type": "object",
"additionalProperties": false,
"properties": {
"location": {
"description": "The location of the external property file.",
"$ref": "#/definitions/artifactLocation"
},
"guid": {
"description": "A stable, unique identifier for the external property file in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"itemCount": {
"description": "A non-negative integer specifying the number of items contained in the external property file.",
"type": "integer",
"default": -1,
"minimum": -1
},
"properties": {
"description": "Key/value pairs that provide additional information about the external property file.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["location"]
},
{
"required": ["guid"]
}
]
},
"externalPropertyFileReferences": {
"description": "References to external property files that should be inlined with the content of a root log file.",
"additionalProperties": false,
"type": "object",
"properties": {
"conversion": {
"description": "An external property file containing a run.conversion object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"graphs": {
"description": "An array of external property files containing a run.graphs object to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"externalizedProperties": {
"description": "An external property file containing a run.properties object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"artifacts": {
"description": "An array of external property files containing run.artifacts arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"invocations": {
"description": "An array of external property files containing run.invocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"logicalLocations": {
"description": "An array of external property files containing run.logicalLocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"threadFlowLocations": {
"description": "An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"results": {
"description": "An array of external property files containing run.results arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"taxonomies": {
"description": "An array of external property files containing run.taxonomies arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"addresses": {
"description": "An array of external property files containing run.addresses arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"driver": {
"description": "An external property file containing a run.driver object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"extensions": {
"description": "An array of external property files containing run.extensions arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"policies": {
"description": "An array of external property files containing run.policies arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"translations": {
"description": "An array of external property files containing run.translations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"webRequests": {
"description": "An array of external property files containing run.requests arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"webResponses": {
"description": "An array of external property files containing run.responses arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external property files.",
"$ref": "#/definitions/propertyBag"
}
}
},
"fix": {
"description": "A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.",
"$ref": "#/definitions/message"
},
"artifactChanges": {
"description": "One or more artifact changes that comprise a fix for a result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifactChange"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the fix.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactChanges"]
},
"graph": {
"description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the graph.",
"$ref": "#/definitions/message"
},
"nodes": {
"description": "An array of node objects representing the nodes of the graph.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/node"
}
},
"edges": {
"description": "An array of edge objects representing the edges of the graph.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/edge"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph.",
"$ref": "#/definitions/propertyBag"
}
}
},
"graphTraversal": {
"description": "Represents a path through a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"runGraphIndex": {
"description": "The index within the run.graphs to be associated with the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"resultGraphIndex": {
"description": "The index within the result.graphs to be associated with the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"description": {
"description": "A description of this graph traversal.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the graph traversal that may change during graph traversal.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"immutableState": {
"description": "Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"edgeTraversals": {
"description": "The sequences of edges traversed by this graph traversal.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/edgeTraversal"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph traversal.",
"$ref": "#/definitions/propertyBag"
}
},
"oneOf": [
{
"required": ["runGraphIndex"]
},
{
"required": ["resultGraphIndex"]
}
]
},
"invocation": {
"description": "The runtime environment of the analysis tool run.",
"additionalProperties": false,
"type": "object",
"properties": {
"commandLine": {
"description": "The command line used to invoke the tool.",
"type": "string"
},
"arguments": {
"description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"type": "string"
}
},
"responseFiles": {
"description": "The locations of any response files specified on the tool's command line.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"startTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the invocation started. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"endTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the invocation ended. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"exitCode": {
"description": "The process exit code.",
"type": "integer"
},
"ruleConfigurationOverrides": {
"description": "An array of configurationOverride objects that describe rules related runtime overrides.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/configurationOverride"
}
},
"notificationConfigurationOverrides": {
"description": "An array of configurationOverride objects that describe notifications related runtime overrides.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/configurationOverride"
}
},
"toolExecutionNotifications": {
"description": "A list of runtime conditions detected by the tool during the analysis.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/notification"
}
},
"toolConfigurationNotifications": {
"description": "A list of conditions detected by the tool that are relevant to the tool's configuration.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/notification"
}
},
"exitCodeDescription": {
"description": "The reason for the process exit.",
"type": "string"
},
"exitSignalName": {
"description": "The name of the signal that caused the process to exit.",
"type": "string"
},
"exitSignalNumber": {
"description": "The numeric value of the signal that caused the process to exit.",
"type": "integer"
},
"processStartFailureMessage": {
"description": "The reason given by the operating system that the process failed to start.",
"type": "string"
},
"executionSuccessful": {
"description": "Specifies whether the tool's execution completed successfully.",
"type": "boolean"
},
"machine": {
"description": "The machine on which the invocation occurred.",
"type": "string"
},
"account": {
"description": "The account under which the invocation occurred.",
"type": "string"
},
"processId": {
"description": "The id of the process in which the invocation occurred.",
"type": "integer"
},
"executableLocation": {
"description": "An absolute URI specifying the location of the executable that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"workingDirectory": {
"description": "The working directory for the invocation.",
"$ref": "#/definitions/artifactLocation"
},
"environmentVariables": {
"description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stdin": {
"description": "A file containing the standard input stream to the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stdout": {
"description": "A file containing the standard output stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stderr": {
"description": "A file containing the standard error stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stdoutStderr": {
"description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the invocation.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["executionSuccessful"]
},
"location": {
"description": "A location within a programming artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Value that distinguishes this location from all other locations within a single result object.",
"type": "integer",
"minimum": -1,
"default": -1
},
"physicalLocation": {
"description": "Identifies the artifact and region.",
"$ref": "#/definitions/physicalLocation"
},
"logicalLocations": {
"description": "The logical locations associated with the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"message": {
"description": "A message relevant to the location.",
"$ref": "#/definitions/message"
},
"annotations": {
"description": "A set of regions relevant to the location.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/region"
}
},
"relationships": {
"description": "An array of objects that describe relationships between this location and others.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/locationRelationship"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"locationRelationship": {
"description": "Information about the relation of one location to another.",
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"description": "A reference to the related location.",
"type": "integer",
"minimum": 0
},
"kinds": {
"description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.",
"type": "array",
"default": ["relevant"],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"description": {
"description": "A description of the location relationship.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the location relationship.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["target"]
},
"logicalLocation": {
"description": "A logical location of a construct that produced a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"name": {
"description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.",
"type": "string"
},
"index": {
"description": "The index within the logical locations array.",
"type": "integer",
"default": -1,
"minimum": -1
},
"fullyQualifiedName": {
"description": "The human-readable fully qualified name of the logical location.",
"type": "string"
},
"decoratedName": {
"description": "The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.",
"type": "string"
},
"parentIndex": {
"description": "Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.",
"type": "integer",
"default": -1,
"minimum": -1
},
"kind": {
"description": "The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the logical location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"message": {
"description": "Encapsulates a message intended to be read by the end user.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string.",
"type": "string"
},
"markdown": {
"description": "A Markdown message string.",
"type": "string"
},
"id": {
"description": "The identifier for this message.",
"type": "string"
},
"arguments": {
"description": "An array of strings to substitute into the message string.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"type": "string"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the message.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["text"]
},
{
"required": ["id"]
}
]
},
"multiformatMessageString": {
"description": "A message string or message format string rendered in multiple formats.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string or format string.",
"type": "string"
},
"markdown": {
"description": "A Markdown message string or format string.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the message.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["text"]
},
"node": {
"description": "Represents a node in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the node within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the node.",
"$ref": "#/definitions/message"
},
"location": {
"description": "A code location associated with the node.",
"$ref": "#/definitions/location"
},
"children": {
"description": "Array of child nodes.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/node"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the node.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id"]
},
"notification": {
"description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.",
"type": "object",
"additionalProperties": false,
"properties": {
"locations": {
"description": "The locations relevant to this notification.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"message": {
"description": "A message that describes the condition that was encountered.",
"$ref": "#/definitions/message"
},
"level": {
"description": "A value specifying the severity level of the notification.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"threadId": {
"description": "The thread identifier of the code that generated the notification.",
"type": "integer"
},
"timeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.",
"type": "string",
"format": "date-time"
},
"exception": {
"description": "The runtime exception, if any, relevant to this notification.",
"$ref": "#/definitions/exception"
},
"descriptor": {
"description": "A reference used to locate the descriptor relevant to this notification.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"associatedRule": {
"description": "A reference used to locate the rule descriptor associated with this notification.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the notification.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["message"]
},
"physicalLocation": {
"description": "A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"address": {
"description": "The address of the location.",
"$ref": "#/definitions/address"
},
"artifactLocation": {
"description": "The location of the artifact.",
"$ref": "#/definitions/artifactLocation"
},
"region": {
"description": "Specifies a portion of the artifact.",
"$ref": "#/definitions/region"
},
"contextRegion": {
"description": "Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.",
"$ref": "#/definitions/region"
},
"properties": {
"description": "Key/value pairs that provide additional information about the physical location.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["address"]
},
{
"required": ["artifactLocation"]
}
]
},
"propertyBag": {
"description": "Key/value pairs that provide additional information about the object.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
},
"rectangle": {
"description": "An area within an image.",
"additionalProperties": false,
"type": "object",
"properties": {
"top": {
"description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"left": {
"description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"bottom": {
"description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"right": {
"description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"message": {
"description": "A message relevant to the rectangle.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the rectangle.",
"$ref": "#/definitions/propertyBag"
}
}
},
"region": {
"description": "A region within an artifact where a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"startLine": {
"description": "The line number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"startColumn": {
"description": "The column number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"endLine": {
"description": "The line number of the last character in the region.",
"type": "integer",
"minimum": 1
},
"endColumn": {
"description": "The column number of the character following the end of the region.",
"type": "integer",
"minimum": 1
},
"charOffset": {
"description": "The zero-based offset from the beginning of the artifact of the first character in the region.",
"type": "integer",
"default": -1,
"minimum": -1
},
"charLength": {
"description": "The length of the region in characters.",
"type": "integer",
"minimum": 0
},
"byteOffset": {
"description": "The zero-based offset from the beginning of the artifact of the first byte in the region.",
"type": "integer",
"default": -1,
"minimum": -1
},
"byteLength": {
"description": "The length of the region in bytes.",
"type": "integer",
"minimum": 0
},
"snippet": {
"description": "The portion of the artifact contents within the specified region.",
"$ref": "#/definitions/artifactContent"
},
"message": {
"description": "A message relevant to the region.",
"$ref": "#/definitions/message"
},
"sourceLanguage": {
"description": "Specifies the source language, if any, of the portion of the artifact specified by the region object.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the region.",
"$ref": "#/definitions/propertyBag"
}
}
},
"replacement": {
"description": "The replacement of a single region of an artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"deletedRegion": {
"description": "The region of the artifact to delete.",
"$ref": "#/definitions/region"
},
"insertedContent": {
"description": "The content to insert at the location specified by the 'deletedRegion' property.",
"$ref": "#/definitions/artifactContent"
},
"properties": {
"description": "Key/value pairs that provide additional information about the replacement.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["deletedRegion"]
},
"reportingDescriptor": {
"description": "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "A stable, opaque identifier for the report.",
"type": "string"
},
"deprecatedIds": {
"description": "An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"guid": {
"description": "A unique identifier for the reporting descriptor in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"deprecatedGuids": {
"description": "An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"name": {
"description": "A report identifier that is understandable to an end user.",
"type": "string"
},
"deprecatedNames": {
"description": "An array of readable identifiers by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"shortDescription": {
"description": "A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
"$ref": "#/definitions/multiformatMessageString"
},
"messageStrings": {
"description": "A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"defaultConfiguration": {
"description": "Default reporting configuration information.",
"$ref": "#/definitions/reportingConfiguration"
},
"helpUri": {
"description": "A URI where the primary documentation for the report can be found.",
"type": "string",
"format": "uri"
},
"help": {
"description": "Provides the primary documentation for the report, useful when there is no online documentation.",
"$ref": "#/definitions/multiformatMessageString"
},
"relationships": {
"description": "An array of objects that describe relationships between this reporting descriptor and others.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorRelationship"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the report.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id"]
},
"reportingConfiguration": {
"description": "Information about a rule or notification that can be configured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Specifies whether the report may be produced during the scan.",
"type": "boolean",
"default": true
},
"level": {
"description": "Specifies the failure level for the report.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"rank": {
"description": "Specifies the relative priority of the report. Used for analysis output only.",
"type": "number",
"default": -1.0,
"minimum": -1.0,
"maximum": 100.0
},
"parameters": {
"description": "Contains configuration information specific to a report.",
"$ref": "#/definitions/propertyBag"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting configuration.",
"$ref": "#/definitions/propertyBag"
}
}
},
"reportingDescriptorReference": {
"description": "Information about how to locate a relevant reporting descriptor.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The id of the descriptor.",
"type": "string"
},
"index": {
"description": "The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.",
"type": "integer",
"default": -1,
"minimum": -1
},
"guid": {
"description": "A guid that uniquely identifies the descriptor.",
"type": "string",
"format": "uuid"
},
"toolComponent": {
"description": "A reference used to locate the toolComponent associated with the descriptor.",
"$ref": "#/definitions/toolComponentReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["index"]
},
{
"required": ["guid"]
},
{
"required": ["id"]
}
]
},
"reportingDescriptorRelationship": {
"description": "Information about the relation of one reporting descriptor to another.",
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"description": "A reference to the related reporting descriptor.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"kinds": {
"description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.",
"type": "array",
"default": ["relevant"],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"description": {
"description": "A description of the reporting descriptor relationship.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["target"]
},
"result": {
"description": "A result produced by an analysis tool.",
"additionalProperties": false,
"type": "object",
"properties": {
"ruleId": {
"description": "The stable, unique identifier of the rule, if any, to which this result is relevant.",
"type": "string"
},
"ruleIndex": {
"description": "The index within the tool component rules array of the rule object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"rule": {
"description": "A reference used to locate the rule descriptor relevant to this result.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"kind": {
"description": "A value that categorizes results by evaluation state.",
"default": "fail",
"enum": [
"notApplicable",
"pass",
"fail",
"review",
"open",
"informational"
]
},
"level": {
"description": "A value specifying the severity level of the result.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"message": {
"description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.",
"$ref": "#/definitions/message"
},
"analysisTarget": {
"description": "Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.",
"$ref": "#/definitions/artifactLocation"
},
"locations": {
"description": "The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"guid": {
"description": "A stable, unique identifier for the result in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"occurrenceCount": {
"description": "A positive integer specifying the number of times this logically unique result was observed in this run.",
"type": "integer",
"minimum": 1
},
"partialFingerprints": {
"description": "A set of strings that contribute to the stable, unique identity of the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fingerprints": {
"description": "A set of strings each of which individually defines a stable, unique identity for the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stacks": {
"description": "An array of 'stack' objects relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/stack"
}
},
"codeFlows": {
"description": "An array of 'codeFlow' objects relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/codeFlow"
}
},
"graphs": {
"description": "An array of zero or more unique graph objects associated with the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graph"
}
},
"graphTraversals": {
"description": "An array of one or more unique 'graphTraversal' objects.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graphTraversal"
}
},
"relatedLocations": {
"description": "A set of locations relevant to this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"suppressions": {
"description": "A set of suppressions relevant to this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/suppression"
}
},
"baselineState": {
"description": "The state of a result relative to a baseline of a previous run.",
"enum": ["new", "unchanged", "updated", "absent"]
},
"rank": {
"description": "A number representing the priority or importance of the result.",
"type": "number",
"default": -1.0,
"minimum": -1.0,
"maximum": 100.0
},
"attachments": {
"description": "A set of artifacts relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/attachment"
}
},
"hostedViewerUri": {
"description": "An absolute URI at which the result can be viewed.",
"type": "string",
"format": "uri"
},
"workItemUris": {
"description": "The URIs of the work items associated with this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"format": "uri"
}
},
"provenance": {
"description": "Information about how and when the result was detected.",
"$ref": "#/definitions/resultProvenance"
},
"fixes": {
"description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/fix"
}
},
"taxa": {
"description": "An array of references to taxonomy reporting descriptors that are applicable to the result.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorReference"
}
},
"webRequest": {
"description": "A web request associated with this result.",
"$ref": "#/definitions/webRequest"
},
"webResponse": {
"description": "A web response associated with this result.",
"$ref": "#/definitions/webResponse"
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["message"]
},
"resultProvenance": {
"description": "Contains information about how and when a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"firstDetectionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the result was first detected. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"lastDetectionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"firstDetectionRunGuid": {
"description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.",
"type": "string",
"format": "uuid"
},
"lastDetectionRunGuid": {
"description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.",
"type": "string",
"format": "uuid"
},
"invocationIndex": {
"description": "The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"conversionSources": {
"description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/physicalLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"$ref": "#/definitions/propertyBag"
}
}
},
"run": {
"description": "Describes a single run of an analysis tool, and contains the reported output of that run.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.",
"$ref": "#/definitions/tool"
},
"invocations": {
"description": "Describes the invocation of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/invocation"
}
},
"conversion": {
"description": "A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.",
"$ref": "#/definitions/conversion"
},
"language": {
"description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
"type": "string",
"default": "en-US",
"pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"
},
"versionControlProvenance": {
"description": "Specifies the revision in version control of the artifacts that were scanned.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/versionControlDetails"
}
},
"originalUriBaseIds": {
"description": "The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactLocation"
}
},
"artifacts": {
"description": "An array of artifact objects relevant to the run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifact"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"graphs": {
"description": "An array of zero or more unique graph objects associated with the run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graph"
}
},
"results": {
"description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/result"
}
},
"automationDetails": {
"description": "Automation details that describe this run.",
"$ref": "#/definitions/runAutomationDetails"
},
"runAggregates": {
"description": "Automation details that describe the aggregate of runs to which this run belongs.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/runAutomationDetails"
}
},
"baselineGuid": {
"description": "The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.",
"type": "string",
"format": "uuid"
},
"redactionTokens": {
"description": "An array of strings used to replace sensitive information in a redaction-aware property.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
},
"defaultEncoding": {
"description": "Specifies the default encoding for any artifact object that refers to a text file.",
"type": "string"
},
"defaultSourceLanguage": {
"description": "Specifies the default source language for any artifact object that refers to a text file that contains source code.",
"type": "string"
},
"newlineSequences": {
"description": "An ordered list of character sequences that were treated as line breaks when computing region information for the run.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"default": ["\r\n", "\n"],
"items": {
"type": "string"
}
},
"columnKind": {
"description": "Specifies the unit in which the tool measures columns.",
"enum": ["utf16CodeUnits", "unicodeCodePoints"]
},
"externalPropertyFileReferences": {
"description": "References to external property files that should be inlined with the content of a root log file.",
"$ref": "#/definitions/externalPropertyFileReferences"
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"taxonomies": {
"description": "An array of toolComponent objects relevant to a taxonomy in which results are categorized.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses associated with this run instance, if any.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/address"
}
},
"translations": {
"description": "The set of available translations of the localized data provided by the tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"policies": {
"description": "Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"webRequests": {
"description": "An array of request objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webRequest"
}
},
"webResponses": {
"description": "An array of response objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webResponse"
}
},
"specialLocations": {
"description": "A specialLocations object that defines locations of special significance to SARIF consumers.",
"$ref": "#/definitions/specialLocations"
},
"properties": {
"description": "Key/value pairs that provide additional information about the run.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["tool"]
},
"runAutomationDetails": {
"description": "Information that describes a run's identity and role within an engineering system process.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A description of the identity and role played within the engineering system by this object's containing run object.",
"$ref": "#/definitions/message"
},
"id": {
"description": "A hierarchical string that uniquely identifies this object's containing run object.",
"type": "string"
},
"guid": {
"description": "A stable, unique identifier for this object's containing run object in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"properties": {
"description": "Key/value pairs that provide additional information about the run automation details.",
"$ref": "#/definitions/propertyBag"
}
}
},
"specialLocations": {
"description": "Defines locations of special significance to SARIF consumers.",
"type": "object",
"additionalProperties": false,
"properties": {
"displayBase": {
"description": "Provides a suggestion to SARIF consumers to display file paths relative to the specified location.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the special locations.",
"$ref": "#/definitions/propertyBag"
}
}
},
"stack": {
"description": "A call stack that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to this call stack.",
"$ref": "#/definitions/message"
},
"frames": {
"description": "An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/stackFrame"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["frames"]
},
"stackFrame": {
"description": "A function call within a stack trace.",
"additionalProperties": false,
"type": "object",
"properties": {
"location": {
"description": "The location to which this stack frame refers.",
"$ref": "#/definitions/location"
},
"module": {
"description": "The name of the module that contains the code of this stack frame.",
"type": "string"
},
"threadId": {
"description": "The thread identifier of the stack frame.",
"type": "integer"
},
"parameters": {
"description": "The parameters of the call that is executing.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"type": "string",
"default": []
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack frame.",
"$ref": "#/definitions/propertyBag"
}
}
},
"suppression": {
"description": "A suppression that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"guid": {
"description": "A stable, unique identifier for the suprression in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"kind": {
"description": "A string that indicates where the suppression is persisted.",
"enum": ["inSource", "external"]
},
"status": {
"description": "A string that indicates the review status of the suppression.",
"enum": ["accepted", "underReview", "rejected"]
},
"justification": {
"description": "A string representing the justification for the suppression.",
"type": "string"
},
"location": {
"description": "Identifies the location associated with the suppression.",
"$ref": "#/definitions/location"
},
"properties": {
"description": "Key/value pairs that provide additional information about the suppression.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["kind"]
},
"threadFlow": {
"description": "Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.",
"type": "string"
},
"message": {
"description": "A message relevant to the thread flow.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the thread flow that may change during thread flow execution.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"immutableState": {
"description": "Values of relevant expressions at the start of the thread flow that remain constant.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"locations": {
"description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the thread flow.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["locations"]
},
"threadFlowLocation": {
"description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.",
"additionalProperties": false,
"type": "object",
"properties": {
"index": {
"description": "The index within the run threadFlowLocations array.",
"type": "integer",
"default": -1,
"minimum": -1
},
"location": {
"description": "The code location.",
"$ref": "#/definitions/location"
},
"stack": {
"description": "The call stack leading to this location.",
"$ref": "#/definitions/stack"
},
"kinds": {
"description": "A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
},
"taxa": {
"description": "An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorReference"
}
},
"module": {
"description": "The name of the module that contains the code that is executing.",
"type": "string"
},
"state": {
"description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"nestingLevel": {
"description": "An integer representing a containment hierarchy within the thread flow.",
"type": "integer",
"minimum": 0
},
"executionOrder": {
"description": "An integer representing the temporal order in which execution reached this location.",
"type": "integer",
"default": -1,
"minimum": -1
},
"executionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which this location was executed.",
"type": "string",
"format": "date-time"
},
"importance": {
"description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".",
"enum": ["important", "essential", "unimportant"],
"default": "important"
},
"webRequest": {
"description": "A web request associated with this thread flow location.",
"$ref": "#/definitions/webRequest"
},
"webResponse": {
"description": "A web response associated with this thread flow location.",
"$ref": "#/definitions/webResponse"
},
"properties": {
"description": "Key/value pairs that provide additional information about the threadflow location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"tool": {
"description": "The analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"driver": {
"description": "The analysis tool that was run.",
"$ref": "#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that contributed to or reconfigured the analysis tool that was run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["driver"]
},
"toolComponent": {
"description": "A component, such as a plug-in or the driver, of the analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"guid": {
"description": "A unique identifier for the tool component in the form of a GUID.",
"type": "string",
"format": "uuid"
},
"name": {
"description": "The name of the tool component.",
"type": "string"
},
"organization": {
"description": "The organization or company that produced the tool component.",
"type": "string"
},
"product": {
"description": "A product suite to which the tool component belongs.",
"type": "string"
},
"productSuite": {
"description": "A localizable string containing the name of the suite of products to which the tool component belongs.",
"type": "string"
},
"shortDescription": {
"description": "A brief description of the tool component.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A comprehensive description of the tool component.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullName": {
"description": "The name of the tool component along with its version and any other useful identifying information, such as its locale.",
"type": "string"
},
"version": {
"description": "The tool component version, in whatever format the component natively provides.",
"type": "string"
},
"semanticVersion": {
"description": "The tool component version in the format specified by Semantic Versioning 2.0.",
"type": "string"
},
"dottedQuadFileVersion": {
"description": "The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).",
"type": "string",
"pattern": "[0-9]+(\\.[0-9]+){3}"
},
"releaseDateUtc": {
"description": "A string specifying the UTC date (and optionally, the time) of the component's release.",
"type": "string"
},
"downloadUri": {
"description": "The absolute URI from which the tool component can be downloaded.",
"type": "string",
"format": "uri"
},
"informationUri": {
"description": "The absolute URI at which information about this version of the tool component can be found.",
"type": "string",
"format": "uri"
},
"globalMessageStrings": {
"description": "A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"notifications": {
"description": "An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"rules": {
"description": "An array of reportingDescriptor objects relevant to the analysis performed by the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"taxa": {
"description": "An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"locations": {
"description": "An array of the artifactLocation objects associated with the tool component.",
"type": "array",
"minItems": 0,
"default": [],
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"language": {
"description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
"type": "string",
"default": "en-US",
"pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"
},
"contents": {
"description": "The kinds of data contained in this object.",
"type": "array",
"uniqueItems": true,
"default": ["localizedData", "nonLocalizedData"],
"items": {
"enum": ["localizedData", "nonLocalizedData"]
}
},
"isComprehensive": {
"description": "Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.",
"type": "boolean",
"default": false
},
"localizedDataSemanticVersion": {
"description": "The semantic version of the localized strings defined in this component; maintained by components that provide translations.",
"type": "string"
},
"minimumRequiredLocalizedDataSemanticVersion": {
"description": "The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.",
"type": "string"
},
"associatedComponent": {
"description": "The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.",
"$ref": "#/definitions/toolComponentReference"
},
"translationMetadata": {
"description": "Translation metadata, required for a translation, not populated by other component types.",
"$ref": "#/definitions/translationMetadata"
},
"supportedTaxonomies": {
"description": "An array of toolComponentReference objects to declare the taxonomies supported by the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponentReference"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool component.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["name"]
},
"toolComponentReference": {
"description": "Identifies a particular toolComponent object, either the driver or an extension.",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "The 'name' property of the referenced toolComponent.",
"type": "string"
},
"index": {
"description": "An index into the referenced toolComponent in tool.extensions.",
"type": "integer",
"default": -1,
"minimum": -1
},
"guid": {
"description": "The 'guid' property of the referenced toolComponent.",
"type": "string",
"format": "uuid"
},
"properties": {
"description": "Key/value pairs that provide additional information about the toolComponentReference.",
"$ref": "#/definitions/propertyBag"
}
}
},
"translationMetadata": {
"description": "Provides additional metadata related to translation.",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "The name associated with the translation metadata.",
"type": "string"
},
"fullName": {
"description": "The full name associated with the translation metadata.",
"type": "string"
},
"shortDescription": {
"description": "A brief description of the translation metadata.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A comprehensive description of the translation metadata.",
"$ref": "#/definitions/multiformatMessageString"
},
"downloadUri": {
"description": "The absolute URI from which the translation metadata can be downloaded.",
"type": "string",
"format": "uri"
},
"informationUri": {
"description": "The absolute URI from which information related to the translation metadata can be downloaded.",
"type": "string",
"format": "uri"
},
"properties": {
"description": "Key/value pairs that provide additional information about the translation metadata.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["name"]
},
"versionControlDetails": {
"description": "Specifies the information necessary to retrieve a desired revision from a version control system.",
"type": "object",
"additionalProperties": false,
"properties": {
"repositoryUri": {
"description": "The absolute URI of the repository.",
"type": "string",
"format": "uri"
},
"revisionId": {
"description": "A string that uniquely and permanently identifies the revision within the repository.",
"type": "string"
},
"branch": {
"description": "The name of a branch containing the revision.",
"type": "string"
},
"revisionTag": {
"description": "A tag that has been applied to the revision.",
"type": "string"
},
"asOfTimeUtc": {
"description": "A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.",
"type": "string",
"format": "date-time"
},
"mappedTo": {
"description": "The location in the local file system to which the root of the repository was mapped at the time of the analysis.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the version control details.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["repositoryUri"]
},
"webRequest": {
"description": "Describes an HTTP request.",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"description": "The index within the run.webRequests array of the request object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"protocol": {
"description": "The request protocol. Example: 'http'.",
"type": "string"
},
"version": {
"description": "The request version. Example: '1.1'.",
"type": "string"
},
"target": {
"description": "The target of the request.",
"type": "string"
},
"method": {
"description": "The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.",
"type": "string"
},
"headers": {
"description": "The request headers.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"parameters": {
"description": "The request parameters.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"description": "The body of the request.",
"$ref": "#/definitions/artifactContent"
},
"properties": {
"description": "Key/value pairs that provide additional information about the request.",
"$ref": "#/definitions/propertyBag"
}
}
},
"webResponse": {
"description": "Describes the response to an HTTP request.",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"description": "The index within the run.webResponses array of the response object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"protocol": {
"description": "The response protocol. Example: 'http'.",
"type": "string"
},
"version": {
"description": "The response version. Example: '1.1'.",
"type": "string"
},
"statusCode": {
"description": "The response status code. Example: 451.",
"type": "integer"
},
"reasonPhrase": {
"description": "The response reason. Example: 'Not found'.",
"type": "string"
},
"headers": {
"description": "The response headers.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"description": "The body of the response.",
"$ref": "#/definitions/artifactContent"
},
"noResponseReceived": {
"description": "Specifies whether a response was received from the server.",
"type": "boolean",
"default": false
},
"properties": {
"description": "Key/value pairs that provide additional information about the response.",
"$ref": "#/definitions/propertyBag"
}
}
}
},
"description": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.6 JSON Schema: a standard format for the output of static analysis tools.",
"properties": {
"$schema": {
"description": "The URI of the JSON schema corresponding to the version.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this log file.",
"enum": ["2.1.0"]
},
"runs": {
"description": "The set of runs contained in this log file.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/run"
}
},
"inlineExternalProperties": {
"description": "References to external property files that share data between runs.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/externalProperties"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the log file.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["version", "runs"],
"title": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.6 JSON Schema",
"type": "object"
}
|
prometheus.rules.json | {
"$id": "https://json.schemastore.org/prometheus.rules.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"duration": {
"type": ["string", "null"],
"pattern": "^([0-9]+y)?([0-9]+w)?([0-9]+d)?([0-9]+h)?([0-9]+m)?([0-9]+s)?([0-9]+ms)?$",
"minLength": 1
},
"label_name": {
"type": "string",
"pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
},
"label_value": {
"type": "string"
},
"labels": {
"type": ["object", "null"],
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
"$ref": "#/definitions/label_value"
}
},
"additionalProperties": false
},
"tmpl_string": {
"description": "A string which is template-expanded before usage.",
"type": "string"
},
"annotations": {
"type": ["object", "null"],
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
"$ref": "#/definitions/tmpl_string"
}
},
"additionalProperties": false
},
"recording_rule": {
"type": "object",
"properties": {
"record": {
"description": "The name of the time series to output to. Must be a valid metric name.",
"type": "string"
},
"expr": {
"description": "The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and the result recorded as a new set of time series with the metric name as given by 'record'.",
"type": "string"
},
"labels": {
"description": "Labels to add or overwrite before storing the result.",
"$ref": "#/definitions/labels"
}
},
"required": ["record", "expr"],
"additionalProperties": false
},
"alerting_rule": {
"type": "object",
"properties": {
"alert": {
"description": "The name of the alert. Must be a valid metric name.",
"type": "string"
},
"expr": {
"description": "The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.",
"type": "string"
},
"for": {
"description": "Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending.",
"$ref": "#/definitions/duration"
},
"labels": {
"description": "Labels to add or overwrite for each alert.",
"$ref": "#/definitions/labels"
},
"annotations": {
"description": "Annotations to add to each alert.",
"$ref": "#/definitions/annotations"
}
},
"required": ["alert", "expr"],
"additionalProperties": false
}
},
"description": "Prometheus rules file",
"properties": {
"groups": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"name": {
"description": "The name of the group. Must be unique within a file.",
"type": "string"
},
"interval": {
"description": "How often rules in the group are evaluated.",
"$ref": "#/definitions/duration"
},
"limit": {
"description": "Limit the number of alerts an alerting rule and series a recording rule can produce. 0 is no limit.",
"type": ["integer", "null"],
"default": 0
},
"rules": {
"type": ["array", "null"],
"items": {
"oneOf": [
{
"$ref": "#/definitions/recording_rule"
},
{
"$ref": "#/definitions/alerting_rule"
}
]
}
}
},
"required": ["name"],
"additionalProperties": false
}
}
},
"title": "Prometheus Rules",
"type": ["object", "null"]
}
|
yippee-ki-json_config_schema.json | {
"$schema": "http://json-schema.org/draft-07/schema",
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Configuring-your-actions",
"definitions": {
"commonTypes": {
"description": "Some of the reusable base types",
"definitions": {
"charSet": {
"description": "Standard character sets.",
"type": "string",
"enum": [
"ISO-8859-1",
"US-ASCII",
"UTF-16",
"UTF-16BE",
"UTF-16LE",
"UTF-8"
],
"additionalItems": false
},
"chronoUnit": {
"description": "The chrono unit we want to use.",
"type": "string",
"enum": [
"NANOS",
"MICROS",
"MILLIS",
"SECONDS",
"MINUTES",
"HOURS",
"HALF_DAYS",
"DAYS",
"WEEKS",
"MONTHS",
"YEARS",
"DECADES",
"CENTURIES",
"MILLENNIA",
"ERAS",
"FOREVER"
],
"additionalItems": false
},
"httpHeaders": {
"type": "object",
"description": "HTTP header map.",
"additionalProperties": {
"type": "string"
},
"uniqueItems": true
},
"httpMethod": {
"description": "Supported HTTP methods.",
"type": "string",
"enum": [
"GET",
"POST"
],
"additionalItems": false
},
"jsonPath": {
"$comment": "https://github.com/json-path/JsonPath",
"description": "A JSON Path selecting one or more nodes of the parsed JSON document.",
"type": "string",
"pattern": "^[$@](((\\.|\\.\\.)([$_a-zA-Z]+[$a-zA-Z0-9\\-_]*|\\*))|\\[\\*]|\\[[0-9]+((, [0-9]+)*|:[0-9]+)]|\\['[$_a-zA-Z]+[$a-zA-Z0-9\\-_]*'(, '[$_a-zA-Z]+[$a-zA-Z0-9\\-_]*')*]|\\[\\?\\(.+\\)])*$"
},
"name": {
"description": "A single JSON key name",
"type": "string",
"pattern": "^[$_a-zA-Z]+[$a-zA-Z0-9\\-_]*$"
}
}
},
"functionTypes": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions",
"description": "Definition of known function types",
"definitions": {
"functionAbsoluteValue": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#absolute-value-function",
"description": "Absolute value function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "absoluteValue",
"description": "The name of the component."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"scale"
],
"additionalProperties": false
},
"functionAdd": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#decimal-add-function",
"description": "Decimal add function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "add",
"description": "The name of the component."
},
"operand": {
"type": "number",
"description": "Second operand of the calculation."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"operand",
"scale"
],
"additionalProperties": false
},
"functionChangeCase": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#change-case",
"description": "Change case",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "changeCase",
"description": "The name of the component."
},
"to": {
"description": "Defines what is the desired case change operation we want to do.",
"type": "string",
"enum": [
"CAPITALIZED",
"UNCAPITALIZED",
"LOWER_CASE",
"UPPER_CASE"
],
"additionalItems": false
}
},
"required": [
"name",
"to"
],
"additionalProperties": false
},
"functionCloneKey": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#clone-key-function",
"description": "Clone key function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "cloneKey",
"description": "The name of the component."
},
"from": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/name"
},
{
"description": "The name of the key we need to duplicate."
}
]
},
"to": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/name"
},
{
"description": "The name of the destination key."
}
]
}
},
"required": [
"from",
"name",
"to"
],
"additionalProperties": false
},
"functionDivide": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#decimal-divide-function",
"description": "Decimal divide function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "divide",
"description": "The name of the component."
},
"operand": {
"type": "number",
"description": "Second operand of the calculation."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"operand",
"scale"
],
"additionalProperties": false
},
"functionDividend": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#decimal-dividend-function",
"description": "Decimal dividend function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "dividend",
"description": "The name of the component."
},
"operand": {
"type": "number",
"description": "First operand of the calculation."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"operand",
"scale"
],
"additionalProperties": false
},
"functionEpochMillisDateAdd": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#epoch-millis-date-add-function",
"description": "Epoch millis date add function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "epochMillisDateAdd",
"description": "The name of the component."
},
"amount": {
"type": "integer",
"description": "The amount of time units we need to add to the date time."
},
"unit": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/chronoUnit"
},
{
"description": "The time unit we want to use to interpret the amount."
}
]
}
},
"required": [
"amount",
"name",
"unit"
],
"additionalProperties": false
},
"functionHttpResource": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#http-resource-content-map-function",
"description": "HTTP resource content map function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResource",
"description": "The name of the component."
},
"uriFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/stringObjectMapToStringFunctionType"
},
{
"description": "The function that is calculating the request URI based on the input map."
}
]
},
"methodFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/stringObjectMapToStringFunctionType"
},
{
"description": "The function that is calculating the request method based on the input map."
}
]
},
"headerFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/anyFunctionType"
},
{
"description": "The function that is calculating the request headers based on the input map."
}
]
},
"uri": {
"type": "string",
"description": "The default request URI as a fallback."
},
"httpMethod": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/httpMethod"
},
{
"description": "The default request method as a fallback. Defaults to GET."
}
]
},
"httpHeaders": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/httpHeaders"
},
{
"description": "The default request headers as a fallback."
}
]
},
"charset": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/charSet"
},
{
"description": "The charset used to read the response. Defaults to UTF-8."
}
]
}
},
"required": [
"name"
],
"minProperties": 2,
"additionalProperties": false
},
"functionHttpResourceByUri": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#http-resource-by-uri-function",
"description": "HTTP resource by URI function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResourceByUri",
"description": "The name of the component."
},
"uriFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/stringToStringFunctionType"
},
{
"description": "The function that is calculating the request URI based on the input map."
}
]
},
"uri": {
"type": "string",
"description": "The default request URI as a fallback."
},
"httpMethod": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/httpMethod"
},
{
"description": "The default request method as a fallback. Defaults to GET."
}
]
},
"httpHeaders": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/httpHeaders"
},
{
"description": "The default request headers as a fallback."
}
]
},
"charset": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/charSet"
},
{
"description": "The charset used to read the response. Defaults to UTF-8."
}
]
}
},
"required": [
"name"
],
"minProperties": 2,
"additionalProperties": false
},
"functionJsonParse": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#json-parse-function",
"description": "JSON parse function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "jsonParse",
"description": "The name of the component."
}
},
"required": [
"name"
],
"additionalProperties": false
},
"functionMultiply": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#decimal-multiply-function",
"description": "Decimal multiply function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "multiply",
"description": "The name of the component."
},
"operand": {
"type": "number",
"description": "Second operand of the calculation."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"operand",
"scale"
],
"additionalProperties": false
},
"functionRegex": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#regex-replace-function",
"description": "RegEx replace function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex",
"description": "The name of the component."
},
"pattern": {
"type": "string",
"description": "A regex pattern that will be matched against the input, capturing certain named groups for later use."
},
"replacement": {
"type": "string",
"description": "Defines how the captured groups should be used to piece together the output value using EL-like syntax."
}
},
"required": [
"name",
"pattern",
"replacement"
],
"additionalProperties": false
},
"functionReplace": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#literal-replace-function",
"description": "Literal replace function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replace",
"description": "The name of the component."
},
"find": {
"type": "string",
"description": "A literal we need to find in the input String."
},
"replace": {
"type": "string",
"description": "The replacement we need to use."
}
},
"required": [
"find",
"name",
"replace"
],
"additionalProperties": false
},
"functionRoundDecimal": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#round-decimal-function",
"description": "Round decimal function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "roundDecimal",
"description": "The name of the component."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"scale"
],
"additionalProperties": false
},
"functionStringDateAdd": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#string-date-add-function",
"description": "String date add function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "stringDateAdd",
"description": "The name of the component."
},
"formatter": {
"type": "string",
"description": "The format String we need to use for date time parsing. [See](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html)"
},
"amount": {
"type": "integer",
"description": "The amount of time units we need to add to the date time."
},
"unit": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/chronoUnit"
},
{
"description": "The time unit we want to use to interpret the amount."
}
]
}
},
"required": [
"amount",
"formatter",
"name",
"unit"
],
"additionalProperties": false
},
"functionSubtract": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#decimal-subtract-function",
"description": "Decimal subtract function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "subtract",
"description": "The name of the component."
},
"operand": {
"type": "number",
"description": "Second operand of the calculation."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"operand",
"scale"
],
"additionalProperties": false
},
"functionSubtractFrom": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-functions#decimal-subtract-from-function",
"description": "Decimal subtract from function",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "subtractFrom",
"description": "The name of the component."
},
"operand": {
"type": "number",
"description": "First operand of the calculation."
},
"scale": {
"type": "integer",
"description": "The number of digits we want to keep right of the decimal point."
}
},
"required": [
"name",
"operand",
"scale"
],
"additionalProperties": false
},
"stringToObjectFunctionType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"changeCase",
"httpResourceByUri",
"jsonParse",
"regex",
"replace",
"stringDateAdd"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "changeCase"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionChangeCase"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResourceByUri"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionHttpResourceByUri"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "jsonParse"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionJsonParse"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionRegex"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replace"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionReplace"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "stringDateAdd"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionStringDateAdd"
}
}
]
},
"stringToStringFunctionType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"changeCase",
"httpResourceByUri",
"regex",
"replace",
"stringDateAdd"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "changeCase"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionChangeCase"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResourceByUri"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionHttpResourceByUri"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionRegex"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replace"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionReplace"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "stringDateAdd"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionStringDateAdd"
}
}
]
},
"bigDecimalToBigDecimalFunctionType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"absoluteValue",
"add",
"divide",
"dividend",
"epochMillisDateAdd",
"multiply",
"roundDecimal",
"subtract",
"subtractFrom"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "absoluteValue"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionAbsoluteValue"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "add"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionAdd"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "divide"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionDivide"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "dividend"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionDividend"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "epochMillisDateAdd"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionEpochMillisDateAdd"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "multiply"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionMultiply"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "roundDecimal"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionRoundDecimal"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "subtract"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionSubtract"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "subtractFrom"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionSubtractFrom"
}
}
]
},
"stringObjectMapToStringObjectMapFunctionType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"cloneKey"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "cloneKey"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionCloneKey"
}
}
]
},
"stringObjectMapToStringFunctionType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"httpResource"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResource"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionHttpResource"
}
}
]
},
"anyFunctionType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"absoluteValue",
"add",
"changeCase",
"cloneKey",
"divide",
"dividend",
"epochMillisDateAdd",
"httpResource",
"httpResourceByUri",
"jsonParse",
"multiply",
"regex",
"replace",
"roundDecimal",
"stringDateAdd",
"subtract",
"subtractFrom"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "absoluteValue"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionAbsoluteValue"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "add"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionAdd"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "changeCase"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionChangeCase"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "cloneKey"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionCloneKey"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "divide"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionDivide"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "dividend"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionDividend"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "epochMillisDateAdd"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionEpochMillisDateAdd"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResource"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionHttpResource"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResourceByUri"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionHttpResourceByUri"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "jsonParse"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionJsonParse"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "multiply"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionMultiply"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionRegex"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replace"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionReplace"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "roundDecimal"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionRoundDecimal"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "stringDateAdd"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionStringDateAdd"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "subtract"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionSubtract"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "subtractFrom"
}
}
},
"then": {
"$ref": "#/definitions/functionTypes/definitions/functionSubtractFrom"
}
}
]
}
}
},
"predicateTypes": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates",
"description": "Definition of known predicate types",
"definitions": {
"predicateAllMatch": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#all-match-predicate",
"description": "All Match predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "allMatch",
"description": "The name of the component."
},
"from": {
"type": "array",
"items": {
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
"minItems": 1,
"additionalItems": false
}
},
"required": [
"from",
"name"
],
"additionalProperties": false
},
"predicateAnyMatch": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#any-match-predicate",
"description": "Any Match predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyMatch",
"description": "The name of the component."
},
"from": {
"type": "array",
"items": {
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
"minItems": 1,
"additionalItems": false
}
},
"required": [
"from",
"name"
],
"additionalProperties": false
},
"predicateAnyString": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#any-string-predicate",
"description": "Any String predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyString",
"description": "The name of the component."
}
},
"required": [
"name"
],
"additionalProperties": false
},
"predicateContainsKey": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#contains-key-predicate",
"description": "Contains key predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "containsKey",
"description": "The name of the component."
},
"key": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/name"
},
{
"description": "The name of the key we want to check."
}
]
}
},
"required": [
"key",
"name"
],
"additionalProperties": false
},
"predicateEvalOn": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#eval-on-predicate",
"description": "Eval on predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "evalOn",
"description": "The name of the component."
},
"childPath": {
"description": "The desired navigation we want to perform relative to the Map/Object we operate on.",
"type": "string",
"pattern": "^([$_a-zA-Z]+[$a-zA-Z0-9\\-_]+)(.[$_a-zA-Z]+[$a-zA-Z0-9\\-_]+)*$"
},
"predicate": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The Predicate we need to evaluate after the navigation is done."
}
]
}
},
"required": [
"childPath",
"name",
"predicate"
],
"additionalProperties": false
},
"predicateIsNull": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#is-null-predicate",
"description": "Is null predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "isNull",
"description": "The name of the component."
}
},
"required": [
"name"
],
"additionalProperties": false
},
"predicateNoneMatch": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#none-match-predicate",
"description": "None Match predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "noneMatch",
"description": "The name of the component."
},
"from": {
"type": "array",
"items": {
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
"minItems": 1,
"additionalItems": false
}
},
"required": [
"from",
"name"
],
"additionalProperties": false
},
"predicateNotNull": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#not-null-predicate",
"description": "Not null predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "notNull",
"description": "The name of the component."
}
},
"required": [
"name"
],
"additionalProperties": false
},
"predicateRegex": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#regex-predicate",
"description": "RegEx predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex",
"description": "The name of the component."
},
"pattern": {
"type": "string",
"description": "The regular expression we want to match."
}
},
"required": [
"name",
"pattern"
],
"additionalProperties": false
},
"predicateSpEL": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-predicates#spel-predicate",
"description": "SpEL predicate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "SpEL",
"description": "The name of the component."
},
"expression": {
"type": "string",
"description": "The SpEL expression we want to match."
}
},
"required": [
"expression",
"name"
],
"additionalProperties": false
},
"stringPredicateType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"SpEL",
"allMatch",
"anyMatch",
"anyString",
"isNull",
"noneMatch",
"notNull",
"regex"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyString"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAnyString"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateRegex"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "allMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAllMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAnyMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "isNull"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateIsNull"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "noneMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateNoneMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "notNull"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateNotNull"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "SpEL"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateSpEL"
}
}
]
},
"stringObjectMapPredicateType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"SpEL",
"allMatch",
"anyMatch",
"containsKey",
"evalOn",
"isNull",
"noneMatch",
"notNull"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "containsKey"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateContainsKey"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "evalOn"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateEvalOn"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "allMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAllMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAnyMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "isNull"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateIsNull"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "noneMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateNoneMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "notNull"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateNotNull"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "SpEL"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateSpEL"
}
}
]
},
"anyPredicateType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"SpEL",
"allMatch",
"anyMatch",
"anyString",
"containsKey",
"evalOn",
"isNull",
"noneMatch",
"notNull",
"regex"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "allMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAllMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAnyMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "anyString"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateAnyString"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "containsKey"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateContainsKey"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "evalOn"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateEvalOn"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "isNull"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateIsNull"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "noneMatch"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateNoneMatch"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "notNull"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateNotNull"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "regex"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateRegex"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "SpEL"
}
}
},
"then": {
"$ref": "#/definitions/predicateTypes/definitions/predicateSpEL"
}
}
]
}
}
},
"supplierTypes": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers",
"description": "Definition of known supplier types",
"definitions": {
"supplierConverting": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#converting-supplier",
"description": "Converting supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "converting",
"description": "The name of the component."
},
"stringSource": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "The supplier of the raw String data we will use as input."
}
]
},
"converter": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/stringToObjectFunctionType"
},
{
"description": "The function that will convert the string data."
}
]
}
},
"required": [
"converter",
"name",
"stringSource"
],
"additionalProperties": false
},
"supplierEpochMillisRelativeDate": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#epoch-millis-relative-date-supplier",
"description": "Epoch Millis Relative Date supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "epochMillisRelativeDate",
"description": "The name of the component."
},
"amount": {
"type": "integer",
"description": "The amount of time units we need to add to the current date time."
},
"unit": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/chronoUnit"
},
{
"description": "The time unit we want to use to interpret the amount."
}
]
},
"relativeTo": {
"type": "integer",
"description": "The value we want to be relative to (in case it is not the current time)."
}
},
"required": [
"amount",
"name",
"unit"
],
"additionalProperties": false
},
"supplierFile": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#file-content-supplier",
"description": "File content supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "file",
"description": "The name of the component."
},
"path": {
"type": "string",
"description": "The path of the file we want to use as input."
},
"charset": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/charSet"
},
{
"description": "The charset used for reading the contents of the file. Defaults to UTF-8."
}
]
}
},
"required": [
"name",
"path"
],
"additionalProperties": false
},
"supplierHttpResource": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#http-resource-content-supplier",
"description": "HTTP resource content supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResource",
"description": "The name of the component."
},
"uri": {
"type": "string",
"description": "The URI we want to send the request to."
},
"httpMethod": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/httpMethod"
},
{
"description": "The HTTP request method we want to use. Defaults to GET."
}
]
},
"httpHeaders": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/httpHeaders"
},
{
"description": "HTTP headers we want to send with our request."
}
]
},
"charset": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/charSet"
},
{
"description": "The charset used for reading the contents of the response. Defaults to UTF-8."
}
]
}
},
"required": [
"name",
"uri"
],
"additionalProperties": false
},
"supplierJsonSchema": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#json-schema-supplier",
"description": "JSON schema supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "jsonSchema",
"description": "The name of the component."
},
"source": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "The supplier of the String of the JSON Schema which we will use as input."
}
]
}
},
"required": [
"name",
"source"
],
"additionalProperties": false
},
"supplierRelativeStringDate": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#relative-string-date-supplier",
"description": "Relative String Date supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "relativeStringDate",
"description": "The name of the component."
},
"formatter": {
"type": "string",
"description": "The format String we need to use for date time parsing. [See](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html)"
},
"amount": {
"type": "integer",
"description": "The amount of time units we need to add to the current date time."
},
"unit": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/chronoUnit"
},
{
"description": "The time unit we want to use to interpret the amount."
}
]
},
"relativeTo": {
"type": "string",
"description": "The value we want to be relative to (in case it is not the current time)."
}
},
"required": [
"amount",
"formatter",
"name",
"unit"
],
"additionalProperties": false
},
"supplierSchemaStore": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#schemastore-schema-supplier",
"description": "SchemaStore schema supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "schemaStore",
"description": "The name of the component."
},
"schemaName": {
"type": "string",
"description": "The name of the JSON schema as found in the SchemaStore.org catalog."
}
},
"required": [
"name",
"schemaName"
],
"additionalProperties": false
},
"supplierStaticBoolean": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#static-boolean-supplier",
"description": "Static Boolean supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticBoolean",
"description": "The name of the component."
},
"value": {
"type": "boolean",
"description": "The static value that must be returned each time the supplier is called."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"supplierStaticDecimal": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#static-bigdecimal-supplier",
"description": "Static BigDecimal supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticDecimal",
"description": "The name of the component."
},
"value": {
"type": "number",
"description": "The static value that must be returned each time the supplier is called."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"supplierStaticInteger": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#static-biginteger-supplier",
"description": "Static BigInteger supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticInteger",
"description": "The name of the component."
},
"value": {
"type": "integer",
"description": "The static value that must be returned each time the supplier is called."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"supplierStaticJson": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#static-json-supplier",
"description": "Static JSON supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticJson",
"description": "The name of the component."
},
"value": {
"type": "string",
"description": "The static JSON value we want to supply every time our supplier is called."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"supplierStaticString": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-suppliers#static-string-supplier",
"description": "Static String supplier",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticString",
"description": "The name of the component."
},
"value": {
"type": "string",
"description": "The static value that must be returned each time the supplier is called."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"jsonSchemaSupplierType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"jsonSchema"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "jsonSchema"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierJsonSchema"
}
}
]
},
"stringSupplierType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"file",
"httpResource",
"relativeStringDate",
"schemaStore",
"staticString"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "file"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierFile"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResource"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierHttpResource"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "relativeStringDate"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierRelativeStringDate"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "schemaStore"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierSchemaStore"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticString"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticString"
}
}
]
},
"bigDecimalSupplierType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"staticDecimal"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticDecimal"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticDecimal"
}
}
]
},
"anySupplierType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"converting",
"epochMillisRelativeDate",
"file",
"httpResource",
"jsonSchema",
"relativeStringDate",
"schemaStore",
"staticBoolean",
"staticDecimal",
"staticInteger",
"staticJson",
"staticString"
],
"additionalItems": false
}
},
"required": [
"name"
]
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "converting"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierConverting"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "epochMillisRelativeDate"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierEpochMillisRelativeDate"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "file"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierFile"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "httpResource"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierHttpResource"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "jsonSchema"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierJsonSchema"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "relativeStringDate"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierRelativeStringDate"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "schemaStore"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierSchemaStore"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticBoolean"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticBoolean"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticDecimal"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticDecimal"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticInteger"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticInteger"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticJson"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticJson"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "staticString"
}
}
},
"then": {
"$ref": "#/definitions/supplierTypes/definitions/supplierStaticString"
}
}
]
}
}
},
"ruleTypes": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules",
"description": "Definition of known rule types",
"definitions": {
"ruleAdd": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#add",
"description": "Add",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "add",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "The supplier that will define the key of the new node."
}
]
},
"value": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "The supplier that will define the value assigned to the new node identified by the key."
}
]
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleCalculate": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#calculate",
"description": "Calculate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "calculate",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"predicate": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The predicate that will determine whether we should apply the function."
}
]
},
"numberFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/bigDecimalToBigDecimalFunctionType"
},
{
"description": "The function that will tell the rule what kind of calculation needs to be done."
}
]
}
},
"required": [
"numberFunction"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleCopy": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#copy",
"description": "Copy",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "copy",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "The supplier that will define the key we want to copy."
}
]
},
"to": {
"type": "object",
"properties": {
"value": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
{
"description": "The destination path where this rule will attempt to create the copied node."
}
]
}
},
"required": [
"value"
],
"additionalProperties": false
}
},
"required": [
"key",
"to"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleDelete": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#delete",
"description": "Delete",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "delete",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
}
},
"required": [
"name",
"path"
],
"additionalProperties": false
},
"ruleDeleteFrom": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#delete-from",
"description": "Delete from",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "deleteFrom",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"predicate": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "Determines whether any deletion should be performed for the matching node"
}
]
},
"keepKey": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The predicate that will be used to test whether a key should be kept, keeping only the matching keys."
}
]
},
"deleteKey": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The predicate that will be used to test whether a key should be deleted, deleting all the matching keys."
}
]
},
"keepValue": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The predicate that will be used to test whether a key should be kept, keeping only the matching keys."
}
]
},
"deleteValue": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The predicate that will be used to test whether an entry should be deleted, deleting all of them with matching values."
}
]
}
},
"minProperties": 1,
"maxProperties": 5,
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleRename": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#rename",
"description": "Rename",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "rename",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"oldKey": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "Provides the name of the key we want to rename under the node matching the `path` parameter at the time of evaluation."
}
]
},
"newKey": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "Provides the new name we want to use after the child node was renamed."
}
]
}
},
"required": [
"newKey",
"oldKey"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleReplace": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#replace",
"description": "Replace",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replace",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"predicate": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "Adds an opportunity to filter by value before we apply the replace `stringFunction`."
}
]
},
"stringFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/stringToStringFunctionType"
},
{
"description": "Defines how the existing value needs to change during the operation."
}
]
}
},
"required": [
"stringFunction"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleReplaceMap": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#replace-map",
"description": "Replace map",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replaceMap",
"description": "The name of the component."
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"predicate": {
"allOf": [
{
"$ref": "#/definitions/predicateTypes/definitions/anyPredicateType"
},
{
"description": "The predicate that will determine whether we need to run the rule on the matching path."
}
]
},
"mapFunction": {
"allOf": [
{
"$ref": "#/definitions/functionTypes/definitions/stringObjectMapToStringObjectMapFunctionType"
},
{
"description": "The function that defines the transformation which needs to be done on the selected map/object."
}
]
}
},
"required": [
"mapFunction"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"ruleValidate": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Built-in-rules#json-schema-validate",
"description": "JSON Schema validate",
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "validate",
"description": "The name of the component."
},
"path": {
"type": "string",
"const": "$",
"description": "Must be the root JSON Path as the validator cannot work on sub-schema."
},
"params": {
"description": "Additional parameters of the rule.",
"type": "object",
"properties": {
"schema": {
"allOf": [
{
"$ref": "#/definitions/supplierTypes/definitions/anySupplierType"
},
{
"description": "The supplier providing the schema we will use for validation."
}
]
},
"onFailure": {
"type": "object",
"properties": {
"transformation": {
"description": "Defines how the transformation should handle a validation failure.",
"type": "string",
"enum": [
"ABORT",
"SKIP_REST",
"CONTINUE"
],
"additionalItems": false
},
"violation": {
"description": "Defines how the rule should document/report the violations.",
"type": "string",
"enum": [
"LOG_ONLY",
"COMMENT_JSON",
"IGNORE"
],
"additionalItems": false
}
},
"required": [
"transformation",
"violation"
],
"additionalProperties": false
}
},
"required": [
"onFailure",
"schema"
],
"additionalProperties": false
}
},
"required": [
"name",
"params",
"path"
],
"additionalProperties": false
},
"anyRuleType": {
"allOf": [
{
"type": "object",
"properties": {
"name": {
"description": "The name of the rule.",
"type": "string",
"enum": [
"add",
"calculate",
"copy",
"delete",
"deleteFrom",
"rename",
"replace",
"replaceMap",
"validate"
],
"additionalItems": false
},
"path": {
"$ref": "#/definitions/commonTypes/definitions/jsonPath"
},
"params": {
"type": "object",
"description": "The optional parameter map to allow configuration of the selected rule."
}
},
"required": [
"name",
"path"
],
"additionalProperties": false
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "add"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleAdd"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "calculate"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleCalculate"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "copy"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleCopy"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "delete"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleDelete"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "deleteFrom"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleDeleteFrom"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "rename"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleRename"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replace"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleReplace"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "replaceMap"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleReplaceMap"
}
},
{
"if": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "validate"
}
}
},
"then": {
"$ref": "#/definitions/ruleTypes/definitions/ruleValidate"
}
}
]
}
}
},
"actionTypes": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Configuring-your-actions",
"definitions": {
"actionName": {
"allOf": [
{
"$ref": "#/definitions/commonTypes/definitions/name"
},
{
"description": "The name of the action (rule list) to allow selecting it when we want to start transformation."
}
]
},
"action": {
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/actionTypes/definitions/actionName"
},
"rules": {
"description": "The array of rules representing the sequentially triggered steps of the transformation action.",
"type": "array",
"items": {
"$ref": "#/definitions/ruleTypes/definitions/anyRuleType"
},
"minItems": 1,
"additionalItems": false
}
},
"required": [
"name",
"rules"
],
"additionalProperties": false
},
"actions": {
"$comment": "https://github.com/nagyesta/yippee-ki-json/wiki/Configuring-your-actions",
"description": "The array of transformation action we will be able to select from at startup.",
"type": "array",
"items": {
"$ref": "#/definitions/actionTypes/definitions/action"
},
"minItems": 1,
"additionalItems": false
}
}
}
},
"properties": {
"actions": {
"$ref": "#/definitions/actionTypes/definitions/actions"
}
},
"required": [
"actions"
],
"additionalProperties": false
}
|
nodehawkrc.json | {
"$id": "https://json.schemastore.org/nodehawkrc.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"paths": {
"$id": "#/properties/paths",
"description": "A string or an array of paths to watch. Supports globbing.",
"default": "./src",
"examples": ["./src"],
"oneOf": [
{
"type": "string",
"default": "./src"
},
{
"type": "array",
"default": ["./src"],
"items": {
"type": "string"
}
}
]
},
"root": {
"$id": "#/properties/root",
"type": "string",
"description": "The root path from which all other paths will be resolved.",
"default": ".",
"examples": ["."]
},
"ignored": {
"$id": "#/properties/ignored",
"type": "string",
"description": "Paths, globs or regular expressions to ignore.",
"default": ""
},
"exec": {
"$id": "#/properties/exec",
"type": "string",
"description": "The command to execute on file change.",
"default": "",
"examples": ["babel-node src/server", "ts-node src/server"]
},
"port": {
"$id": "#/properties/port",
"type": "integer",
"description": "The port on which the server should run. This is passed to your application as `process.env.PORT` which should be used by you.",
"default": 4000
},
"logLevel": {
"$id": "#/properties/logLevel",
"type": "integer",
"description": "The level of logging. 0 - fatal, 1 - error, 2 - warning, 3 - info, 4 - debug",
"default": 3
},
"buffer": {
"$id": "#/properties/buffer",
"type": "integer",
"description": "The buffer duration to wait before triggering a restart.",
"default": 1500
},
"bufferPoll": {
"$id": "#/properties/bufferPoll",
"type": "integer",
"description": "The buffer polling interval to check for the file stability.",
"default": 100
},
"display": {
"$id": "#/properties/display",
"type": "object",
"description": "The various messages to display during different events.",
"properties": {
"onBeforeStart": {
"$id": "#/properties/display/properties/onBeforeStart",
"type": "string",
"description": "The message to display before the watcher starts.",
"default": "Starting..."
},
"onStart": {
"$id": "#/properties/display/properties/onStart",
"type": "string",
"description": "The message to display after the watcher starts.",
"default": "Started"
},
"onBeforeRestart": {
"$id": "#/properties/display/properties/onBeforeRestart",
"type": "string",
"description": "The message to display before the watcher restarts.",
"default": "Restarting..."
},
"onRestart": {
"$id": "#/properties/display/properties/onRestart",
"type": "string",
"description": "The message to display after the watcher restarts.",
"default": "Restarted"
},
"onBeforeStop": {
"$id": "#/properties/display/properties/onBeforeStop",
"type": "string",
"description": "The message to display before the watcher stops.",
"default": "Stopping..."
}
}
},
"clearScreen": {
"$id": "#/properties/clearScreen",
"type": "boolean",
"description": "Clear the screen on start and on every restart.",
"default": true
},
"env": {
"$id": "#/properties/env",
"type": "object",
"description": "A set of key-value pairs which will be promptly passed on to your process and accessible via `process.env`.",
"default": {}
}
},
"required": ["exec"],
"title": "Nodehawk configuration schema.",
"type": "object"
}
|
hawkconfig.json | {"$schema":"http://json-schema.org/draft/2019-09/schema#","id":"com.stackhawk.nest.HawkScanMessages$HawkscanConf","type":"object","title":"com.stackhawk.nest.HawkScanMessages$HawkscanConf","definitions":{"HawkscanConf":{"id":"#/definitions/HawkscanConf","type":"object","properties":{"hawk":{"$ref":"#/definitions/HawkConf","description":"Parameters for scanner runtime and how it should look for vulnerabilities."},"app":{"$ref":"#/definitions/AppConf","description":"**Required** Parameters for the target application and specifics for how it should be scanned."},"hawkAddOn":{"$ref":"#/definitions/HawkAddOnConf","description":"Parameters for additional HawkScan add-ons."},"tags":{"type":"array","description":"Searchable keywords to associate with this scan","items":{"$ref":"#/definitions/Tag"}}},"required":["app"],"additionalProperties":false},"HawkConf":{"id":"#/definitions/HawkConf","type":"object","properties":{"spider":{"$ref":"#/definitions/Spider","description":"Spider configuration"},"startupTimeoutMinutes":{"type":"number","description":"Maximum time in minutes to wait for the scanner process to start","exclusiveMinimum":0},"failureThreshold":{"type":"string","description":"The lowest alert level that returns a failed scan status. Accepted values: high, medium, or low","pattern":"\\b(?:high|medium|low|HIGH|MEDIUM|LOW)\\b"},"scan":{"$ref":"#/definitions/ScanConf","description":"Scan Configuration"},"config":{"type":"array","description":"Scanner configuration overrides, provided as a list of strings.","items":{"type":"string","pattern":"^([a-zA-Z0-9]*\\.)*([a-zA-Z_$0-9])+=.*$"}},"outboundProxy":{"$ref":"#/definitions/Proxy","description":"Configuration for an outbound proxy"}},"additionalProperties":false},"Spider":{"id":"#/definitions/Spider","type":"object","properties":{"base":{"type":"boolean","description":"Enable the basic web crawler for discovering your application’s routes. This spider is appropriate for most traditional web applications.","default":true},"ajax":{"type":"boolean","description":"Enable the ajax web crawler for discovering your application’s routes. This spider is appropriate for single-page web applications.","default":true},"maxDurationMinutes":{"type":"number","description":"Maximum allowed time for enabled spiders to crawl your web application. defaults to 5","exclusiveMinimum":0},"ajaxBrowser":{"type":"string","description":"The browser to type and style to use when running the AjaxSpider. This value is ignored when running the hawkscan docker container and use's the default FIREFOX_HEADLESS.","enum":["FIREFOX_HEADLESS","CHROME_HEADLESS","FIREFOX","CHROME"]},"seedPaths":{"type":"array","description":"List of seed paths to add to the site tree. Will be crawled in addition to the root of the application. Used to add unreachable paths to the scanner.","items":{"type":"string"}},"custom":{"$ref":"#/definitions/CustomDiscovery","description":""},"postmanConfig":{"$ref":"#/definitions/PostmanConfig","description":""}}},"CustomDiscovery":{"id":"#/definitions/CustomDiscovery","type":"object","properties":{}},"PostmanConfig":{"id":"#/definitions/PostmanConfig","type":"object","properties":{"apikey":{"type":"string","description":"api key to authenticated the user with Postman"},"collectionUID":{"type":"string","description":"Id of the collection to be pulled from Postman"},"filePath":{"type":"string","description":"File path of the Postman collection"}}},"ScanConf":{"id":"#/definitions/ScanConf","type":"object","properties":{"maxDurationMinutes":{"type":["number","string"],"description":"Maximum duration that a scan will run.","minimum":0,"pattern":"^([0-9][0-9]+|[1-9]|0)$"},"maxRuleDurationMinutes":{"type":["number","string"],"description":"Maximum duration that a scan will spend on a rule.","minimum":0,"pattern":"^([0-9][0-9]+|[1-9]|0)$"},"requestDelayMillis":{"type":["number","string"],"description":"Delay time between sending requests.","minimum":0,"pattern":"^([0-9][0-9]+|[1-9]|0)$"},"concurrentRequests":{"type":["number","string"],"description":"Number of request threads. _If you need that little extra push._ defaults to 20","exclusiveMinimum":0,"pattern":"^([0-9][0-9]+|[1-9])$"},"throttlePassiveBacklog":{"type":["number","string"],"description":"Pause active scan when passive backlog is greater than this value, resumes once backlog is empty. defaults to 50","exclusiveMinimum":0,"pattern":"^([0-9][0-9]+|[1-9])$"},"policyName":{"type":"string","description":"Name of the scan policy to use. This field is optional and defaults will be selected if omitted"},"includedPlugins":{"type":"array","description":"Specify to only run scan on the listed plugins","items":{"type":"string"}}}},"Proxy":{"id":"#/definitions/Proxy","type":"object","properties":{"host":{"type":"string","description":"**Required**. The host of the outbound proxy"},"credentials":{"$ref":"#/definitions/ProxyCredentials","description":"Credentials for logging into the proxy"}}},"ProxyCredentials":{"id":"#/definitions/ProxyCredentials","type":"object","properties":{"username":{"type":"string","description":"**Required**. The username for proxy credentials"},"password":{"type":"string","description":"**Required**. The password for proxy credentials"},"realm":{"type":"string","description":"Realm for proxy credentials"},"scheme":{"type":"string","description":"Scheme of auth: BASIC, NTLM,"}}},"AppConf":{"id":"#/definitions/AppConf","type":"object","properties":{"host":{"type":"string","description":"**Required** The base url of the application to scan ex: `http://localhost:8000`. If the url cannot be reached, the scan will not proceed.","pattern":"(?:(?:https?|ftp|file):\\/\\/|www\\.|ftp\\.)(?:\\([-\\w\\d+&@#\\/%=~_|$?!:,.]*\\)|[-\\w\\d+&@#\\/%=~_|$?!:,.])*(?:\\([-\\w\\d+&@#\\/%=~_|$?!:,.]*\\)|[\\w\\d+&@#\\/%=~_|$])"},"sessionTokens":{"type":"array","description":"The names of any session tokens used by your application, provided as an array of strings (Hint: these are the names of session cookies used by your application).","items":{"type":"string"}},"antiCsrfParam":{"type":"string","description":"The name of your CSRF security parameter used in any application form inputs. Globally set, HawkScan will parse this parameter value from form responses to use in subsequent requests."},"authentication":{"$ref":"#/definitions/Authentication","description":"Authenticated scan configuration"},"excludePaths":{"type":"array","description":"An array of strings, used as regexes to match against routes that should be ignored entirely by HawkScan. This field is useful for prohibiting asset directories or other resources that don’t require vulnerability scanning. (TODO: ADD EXAMPLE)","items":{"type":"string"}},"applicationId":{"type":"string","description":"**Required**. The `applicationId` of an application from the StackHawk platform","pattern":"\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b"},"env":{"type":"string","description":"**Required**. The `env` environment name to organize Scan Results"},"graphqlConf":{"$ref":"#/definitions/GraphQLConf","description":"GraphQL API scanner parameters."},"includePaths":{"type":"array","description":"An array of strings, used as regexes to constrain the application routes HawkScan will specifically visit. This field is useful for constraining the reach of the HawkScan scanner and spider. (TODO: add examples)","items":{"type":"string"}},"autoPolicy":{"type":"boolean","description":"Set to `true` to enable an optimized policy when scanning specific APIs like GraphQL and OpenAPI. Defaults to True"},"autoInputVectors":{"type":"boolean","description":"Set to `true` to automatically enabled the correct input data types when scanning API’s like GraphQL and OpenAPI. This can increase scan accuracy and reduce false positives. Defaults to True"},"openApiConf":{"$ref":"#/definitions/OpenApiConf","description":"OpenApi scanner parameters."},"soapConf":{"$ref":"#/definitions/SoapConf","description":"SOAP API scanner parameters."},"grpcConf":{"$ref":"#/definitions/GrpcConf","description":"gRPC scanner parameters"},"inputVectors":{"$ref":"#/definitions/InputVectorParams","description":"Fine grained control of injectable input vectors"},"waitForAppTarget":{"$ref":"#/definitions/WaitForAppTarget","description":"Adds a wait time for app to startup"},"redact":{"$ref":"#/definitions/AppRedactions","description":"Specification for additional redaction of words in the scan logs"}},"required":["host","applicationId","env"],"additionalProperties":false,"allOf":[{"oneOf":[{"required":["authentication"]},{"not":{"anyOf":[{"required":["authentication"]}]}}]}]},"Authentication":{"id":"#/definitions/Authentication","type":"object","properties":{"usernamePassword":{"$ref":"#/definitions/UsernamePasswordCredentials","description":"Optional configuration specifying a username and password based authentication configuration. Do not configure if using `external`."},"external":{"$ref":"#/definitions/ExternalCredentials","description":"Optional configuration block for specifying an externally supplied authorization token. Do not configure if using `usernamePassword`."},"script":{"$ref":"#/definitions/AuthenticationScript","description":"Optional configuration block for using an authentication script."},"tokenExtraction":{"$ref":"#/definitions/TokenExtraction","description":"Optional configuration block for extracting the authorization token from the authentication response."},"cookieAuthorization":{"$ref":"#/definitions/CookieAuthorization","description":"Optional configuration specifying if authorization is maintained via a cookie session. Do not configure if using `tokenAuthorization`."},"tokenAuthorization":{"$ref":"#/definitions/TokenAuthorization","description":"Optional configuration telling HawkScan how to pass the authorization token to your application on each request to maintain authorized access. Do not configure if using `cookieAuthorization`."},"sessionScript":{"$ref":"#/definitions/SessionScript","description":"Optional configuration for using a session management script."},"loggedInIndicator":{"type":"string","description":"**Required**. A regex to match against http responses from pages in the web application to determine if the scanned pages user session is still logged in to the app, provided as a string (ex. `\"\\\\Qsigned in as\\\\E\"`)."},"loggedOutIndicator":{"type":"string","description":"**Required**. A regex to match against http responses from pages in the web application to determine if the scanned pages user session is logged out of the app, provided as a string"},"testPath":{"$ref":"#/definitions/AuthTestPath","description":"A configuration block specifying how to verify authentication/authorization is working"}},"required":["loggedInIndicator","loggedOutIndicator","testPath"],"allOf":[{"oneOf":[{"required":["usernamePassword"]},{"required":["external"]},{"required":["script"]}]},{"oneOf":[{"required":["cookieAuthorization"]},{"required":["tokenAuthorization"]},{"required":["sessionScript"]}]}]},"UsernamePasswordCredentials":{"id":"#/definitions/UsernamePasswordCredentials","type":"object","properties":{"loginPagePath":{"type":"string","description":"The path to your login form, if applicable. This is an optional path but is often required if the `POST` to the loginPath requires an anti csrf token to be passed as part of the `POST`. The `app.antiCsrfParam` will be extracted from the response body of a GET request to this page.","pattern":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"loginPath":{"type":"string","description":"**Required** login route to `POST` credentials for a user in the application (ex. `/login`). An http `POST` request using the type specified will be made to this path.","pattern":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"usernameField":{"type":"string","description":"**Required** the username html field used in your application form or json, provided as a string."},"passwordField":{"type":"string","description":"**Required** The password html field used in your application form or json, provided as a string."},"scanUsername":{"type":"string","description":"*Required** The username credentials provided to authentication when attempting to login to the web application, provided as a string.\nHawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. \"${SCAN_USERNAME:admin}\" will use the $SCAN_USERNAME environment variable as the scanUsername, or fallback to admin)."},"scanPassword":{"type":"string","description":"*Required** The password credentials provided to authentication when attempting to login to the web application, provided as a string.\nHawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. \"${SCAN_PASSWORD}\" will use the $SCAN_PASSWORD environment variable as the scanPassword)."},"type":{"type":"string","description":"An enum value describing the type of `POST` data expected by the `loginPath`","enum":["FORM","JSON","HTTP"]},"otherParams":{"type":"array","description":"Other request parameters required by your login payload, provided as an array of objects with `name` and `value` string keys. This setting is helpful if your authentication process requires other parameters included in the form POST besides the username and password parameters. If in doubt, this setting can be safely left unconfigured.","items":{"$ref":"#/definitions/NameValParam"}},"realm":{"type":"string","description":"Realm for NTLM authentication"}},"required":["loginPath","usernameField","passwordField","scanUsername","scanPassword"]},"NameValParam":{"id":"#/definitions/NameValParam","type":"object","properties":{"name":{"type":"string","description":""},"val":{"type":"string","description":""}}},"ExternalCredentials":{"id":"#/definitions/ExternalCredentials","type":"object","properties":{"type":{"type":"string","description":"Specifies the type of token being supplied. If `COOKIE` is specified the .external.value should be in the form of a cookie value <cookie-name>=<cookie-value> . Defaults to `Token`.","enum":["TOKEN","COOKIE"]},"values":{"type":"array","description":"The value pairs containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`.","items":{"$ref":"#/definitions/NameValParam"}}}},"AuthenticationScript":{"id":"#/definitions/AuthenticationScript","type":"object","properties":{"name":{"type":"string","description":"The name of the authentication script specified in the hawkAddOn.scripts.name"},"parameters":{"$ref":"#/definitions/ParametersEntry","description":"The parameters required for the authentication script."},"credentials":{"$ref":"#/definitions/CredentialsEntry","description":"The credentials required for the authentication script. These values will be redacted."}},"required":["name"]},"ParametersEntry":{"id":"#/definitions/ParametersEntry","type":"object","additionalProperties":{"type":"string"}},"CredentialsEntry":{"id":"#/definitions/CredentialsEntry","type":"object","additionalProperties":{"type":"string"}},"TokenExtraction":{"id":"#/definitions/TokenExtraction","type":"object","properties":{"type":{"type":"string","description":"Specifying `TOKEN_PATH` tells HawkScan to extract the token from the JSON payload of the response from authentication. `HEADER` tells HawkScan to extract the token from a header in the response from authentication. defaults to `TOKEN_PATH`.","enum":["TOKEN_PATH","HEADER_NAME"]},"value":{"type":"string","description":"*Required**. String containing the path to the token in the JSON payload authentication response or the name of the response header containing the token.\nExample: if the authentication response JSON payload looks like `{\"auth\" : {\"token\": \"<my-auth-token>\"}}` the value would be `auth.token`. If the authentication response has a header named `AuthToken: <my-token>`, then the value should be `AuthToken`."}},"required":["value"]},"CookieAuthorization":{"id":"#/definitions/CookieAuthorization","type":"object","properties":{"cookieNames":{"type":"array","description":"A list of strings that are the names of cookies used for maintaining a session. Typically this is one value like `jsessionid` or `PHPSESS`. When used in combination with authentication HawkScan will use this value to persist authenticated session state with your application.","items":{"type":"string"}}}},"TokenAuthorization":{"id":"#/definitions/TokenAuthorization","type":"object","properties":{"type":{"type":"string","description":"An enum value representing how to pass the authorization token to your application.\n`HEADER` indicates that each request should have the authorization token header added to the requests.\n`QUERY_PARAM` indicates that the token should be passed as a query parameter.","enum":["HEADER","QUERY_PARAM"]},"value":{"type":"string","description":"**Required** The name of the `HEADER` or `QUERY_PARAM` the token should be passed as."}},"required":["value"]},"SessionScript":{"id":"#/definitions/SessionScript","type":"object","properties":{"name":{"type":"string","description":"The name of the session script specified in the hawkAddOn.scripts.name"},"parameters":{"$ref":"#/definitions/ParametersEntry","description":"The parameters required for the session script."}},"required":["name"]},"AuthTestPath":{"id":"#/definitions/AuthTestPath","type":"object","properties":{"type":{"type":"string","description":"An enum value representing what to match against in the response from issuing a GET request to the `testPath.path`. The supported values are `HEADER` and `BODY`.","enum":["HEADER","BODY"]},"path":{"type":"string","description":"**Required**. The path to a protected route in your application that requires authorization. For example `/mysettings`. A `GET` request will be made to this path using the configured authentication.","pattern":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"success":{"type":"string","description":"A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`.\nA match of the regex supplied will indicate that scanning should proceed with the specified authentication."},"fail":{"type":"string","description":"A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`.\nA match of the regex supplied will indicate that scanning should halt and enter an error state."},"requestMethod":{"type":"string","description":"Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings.","enum":["GET","POST","PUT"]},"requestBody":{"type":"string","description":"The request content to send along with POST or PUT requests for authentication verification."},"requestHeaders":{"$ref":"#/definitions/RequestHeadersEntry","description":"List of key/value pairs to be included as headers in the request to the `path`.\nHeaders that match the following pattern are unable to be added or modified `'^(Host|Origin|Proxy-.*|Sec-.*|Content-Length)'`."}},"required":["path"],"allOf":[{"oneOf":[{"required":["success"]},{"required":["fail"]}]}]},"RequestHeadersEntry":{"id":"#/definitions/RequestHeadersEntry","type":"object","additionalProperties":{"type":"string"}},"GraphQLConf":{"id":"#/definitions/GraphQLConf","type":"object","properties":{"schemaPath":{"type":"string","description":"Path to the GraphQL introspection endpoint, relative to the target URI","pattern":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"requestMethod":{"type":"string","description":"Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings.","enum":["POST","GET"]},"uriMaxLength":{"type":["number","string"],"description":"Max length of URIs when generation queries for GET requests.","minimum":0,"pattern":"^([0-9][0-9]+|[1-9]|0)$"},"maxDepth":{"type":["number","string"],"description":"Maximum depth for generated query graphs","exclusiveMinimum":0,"maximum":50,"pattern":"^([0-9][0-9]+|[1-9]|0)$"},"enabled":{"type":"boolean","description":"Enable GraphQL scan support. HawkScan will enumerate all possible field types and input values for GraphQL Queries and Mutations. Provide relative path to the API endpoint."},"operation":{"type":"string","description":"GraphQL operation to enumerate and scan. Defaults to find all Query and Mutation operations.","enum":["ALL","QUERY","MUTATION"]},"filePath":{"type":"string","description":"Relative path to a JSON formatted GraphQL schema (default: None)"},"excludeOperations":{"type":"array","description":"GraphQL operations to exclude from the spider","items":{"$ref":"#/definitions/GraphQLExcludeOperationParam"}},"fakerEnabled":{"type":"boolean","description":"Enables faker for a GraphQL scan to generate more realistic values when format is provided on the API spec or custom variables."},"customVariables":{"type":"array","description":"Define custom variables and values for use in GraphQL scanning.","items":{"$ref":"#/definitions/GraphQLCustomVariable"}}}},"GraphQLExcludeOperationParam":{"id":"#/definitions/GraphQLExcludeOperationParam","type":"object","properties":{"name":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["ALL","QUERY","MUTATION"]}}},"GraphQLCustomVariable":{"id":"#/definitions/GraphQLCustomVariable","type":"object","properties":{"field":{"type":"string","description":"The field name of the param to inject values into"},"values":{"type":"array","description":"A list of possible values to be randomly selected for the given field","items":{"type":"string"}},"operationName":{"type":"string","description":"An optional operationName that will only inject custom values if the name of the operation on the request matches"},"operationType":{"type":"string","description":"An optional GraphQL operation type (MUTATION or QUERY) that will inject custom values only when the request matches the operation type","enum":["ALL","QUERY","MUTATION"]}}},"OpenApiConf":{"id":"#/definitions/OpenApiConf","type":"object","properties":{"path":{"type":"string","description":"A string relative path to an OpenAPI specification file (JSON or YAML) from the specified app.host","pattern":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"filePath":{"type":"string","description":"Relative path to specification file(s) (JSON or YAML).\nThe path is relative to the `/hawk` mount point specified by the `-v` docker run argument. ie: `docker run -v $(pwd):/hawk`."},"inline":{"type":"string","description":"Define your openapi specification yaml inlined as a string."},"strict":{"type":"boolean","description":"Enable strict parsing of the openapi."},"customVariables":{"type":"array","description":"Define custom variables and values for use in REST API scanning.","items":{"$ref":"#/definitions/OpenApiCustomVariable"}},"includeAllMethods":{"type":"boolean","description":"When custom variables are provided, DELETE's are skipped for injection. Set this to true to override this default and include all methods in variable injection."},"includedMethods":{"type":"array","description":"List of methods to include in custom variable injection. Note: if 'includeAllMethods' is set to true, this list is ignored and all methods will be used for custom variable injection.","items":{"type":"string","enum":["POST","PUT","DELETE","GET","OPTIONS","PATCH","HEAD"]}},"fakerEnabled":{"type":"boolean","description":"Enables faker for a REST API scan to generate more realistic values when format is provided on the API spec or custom variables."},"maxAliasesForCollections":{"type":["number","string"],"description":"Maximum number of aliases for a collection when parsing YAML.\n Increase this value if you see the error \"Number of aliases for non-scalar nodes exceeds the specified max=100\"","default":100,"minimum":0,"pattern":"^([0-9][0-9]+|[1-9]|0)$"}}},"OpenApiCustomVariable":{"id":"#/definitions/OpenApiCustomVariable","type":"object","properties":{"field":{"type":"string","description":"The field name of the param to inject values into"},"values":{"type":"array","description":"A list of possible values to be randomly selected for the given field","items":{"type":"string"}},"path":{"type":"string","description":"An optional path regex that will only inject custom values if the path of the request matches"},"requestMethods":{"type":"array","description":"A list of optional HTTP request methods that will inject custom values only when the request matches one of those methods.","items":{"type":"string","enum":["POST","PUT","DELETE","GET","OPTIONS","PATCH","HEAD"]}}}},"SoapConf":{"id":"#/definitions/SoapConf","type":"object","properties":{"path":{"type":"string","description":"Host path to the SOAP WSDL, prefixed with a `/`","pattern":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"filePath":{"type":"string","description":"Relative path to the SOAP WSDL schema definition file"}}},"GrpcConf":{"id":"#/definitions/GrpcConf","type":"object","properties":{"path":{"type":"string","description":"Host path for the grpc reflection endpoint."},"filePath":{"type":"string","description":"Relative path to the grpc protobuf file"},"customVariables":{"type":"array","description":"Define custom variables and values for use in gRPC scanning.","items":{"$ref":"#/definitions/CustomVariable"}}}},"CustomVariable":{"id":"#/definitions/CustomVariable","type":"object","properties":{"field":{"type":"string","description":"The field name of the param to inject values into"},"values":{"type":"array","description":"A list of possible values to be randomly selected for the given field","items":{"type":"string"}}}},"InputVectorParams":{"id":"#/definitions/InputVectorParams","type":"object","properties":{"injectableParam":{"$ref":"#/definitions/InjectableParam","description":""},"enabledRpcParam":{"$ref":"#/definitions/EnabledRPCParam","description":""}}},"InjectableParam":{"id":"#/definitions/InjectableParam","type":"object","properties":{}},"EnabledRPCParam":{"id":"#/definitions/EnabledRPCParam","type":"object","properties":{}},"WaitForAppTarget":{"id":"#/definitions/WaitForAppTarget","type":"object","properties":{"path":{"type":"string","description":"The path to a public reachable route in your application. For example `/index`. A `GET` request will be made to this path to confirm the host is up and ready to receive traffic.","default":"/","pattern\"":"^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"},"requestMethod":{"type":"string","description":"Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings.","enum":["GET","POST","PUT"]},"requestBody":{"type":"string","description":"The request content to send along with POST or PUT requests for target verification."},"waitTimeoutMillis":{"type":["number","string"],"description":"The maximum amount of time in milliseconds that HawkScan will wait for your app to be available before it starts scanning","minimum":0,"pattern":"^([0-9][0-9]+|[1-9]|0)$"},"pollDelay":{"type":["number","string"],"description":"The maximum amount of time in milliseconds in between requests to your application to see if it's running","minimum":50,"pattern":"^([0-9][0-9]+|[1-9]|0)$"}},"required":["waitTimeoutMillis","pollDelay"]},"AppRedactions":{"id":"#/definitions/AppRedactions","type":"object","properties":{"headers":{"type":"array","description":"List of string header names: the values of HTTP headers matching these names will be redacted from alerts and logs.","items":{"type":"string"}},"values":{"type":"array","description":"List of string static values: the values here will be added to the redacted token list. This is best used with ${ENV_VAR:default} interpolation.","items":{"type":"string"}}},"required":[],"additionalProperties":false},"HawkAddOnConf":{"id":"#/definitions/HawkAddOnConf","type":"object","properties":{"replacer":{"$ref":"#/definitions/Replacer","description":"Configuration for the replacer addOn"},"scripts":{"type":"array","description":"List of configurations for custom scripts.","items":{"$ref":"#/definitions/Script"}}},"additionalProperties":false},"Replacer":{"id":"#/definitions/Replacer","type":"object","properties":{"rules":{"type":"array","description":"List of regex match and replace rules for request headers.","items":{"$ref":"#/definitions/ReplacerRules"}}}},"ReplacerRules":{"id":"#/definitions/ReplacerRules","type":"object","properties":{"matchString":{"type":"string","description":"If `replaceOnly` is false, only match the header name. If `replaceOnly` is true, matches the exact string on the header line."},"replacement":{"type":"string","description":"If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line."},"initiators":{"type":"array","description":"","items":{"type":"string","enum":["PROXY","ACTIVE_SCANNER","SPIDER","FUZZER","AUTHENTICATION","MANUAL_REQUEST","CHECK_FOR_UPDATES","BEAN_SHELL","ACCESS_CONTROL_SCANNER","AJAX_SPIDER","FORCED_BROWSE","TOKEN_GENERATOR","WEB_SOCKET","AUTHENTICATION_HELPER"]}},"replaceOnly":{"type":"boolean","description":"If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line."},"isRegex":{"type":"boolean","description":"Enable regex search for `matchString`. Useful when `replaceOnly` is true (e.g. `Referer:.*` will replace the entire `Referer:` header line)"}},"required":["matchString","replacement"]},"Script":{"id":"#/definitions/Script","type":"object","properties":{"name":{"type":"string","description":"the name of this custom script"},"type":{"type":"string","description":"","enum":["active","authentication","httpsender","passive","proxy","standalone","targeted","session"]},"path":{"type":"string","description":"Path to the file location for the custom script"},"vars":{"type":"array","description":"Named variables to expose to the script","items":{"$ref":"#/definitions/NameValParam"}},"language":{"type":"string","description":"**Required**. The language of this script","enum":["KOTLIN","JAVASCRIPT"]},"id":{"type":["number","string"],"description":"Plugin Id for script"}},"required":["language"]},"Tag":{"id":"#/definitions/Tag","type":"object","properties":{"name":{"type":"string","description":"The keyword name.","maxLength":128,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$"},"value":{"type":"string","description":"An arbitrary value to associate with the keyword.","maxLength":512,"minLength":1}},"additionalProperties":false}},"properties":{"hawk":{"id":"#/properties/hawk","type":"object","$ref":"#/definitions/HawkConf"},"app":{"id":"#/properties/app","type":"object","$ref":"#/definitions/AppConf"},"hawkAddOn":{"id":"#/properties/hawkAddOn","type":"object","$ref":"#/definitions/HawkAddOnConf"},"tags":{"id":"#/properties/tags","type":"array","items":{"$ref":"#/definitions/Tag"}}}} |
solution-filter.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://json.schemastore.org/solution-filter.json",
"properties": {
"solution": {
"type": "object",
"description": "Solution filter description",
"properties": {
"path": {
"type": "string",
"description": "Path to filtered solution. Should be relative to current .slnf"
},
"projects": {
"description": "List of projects that will be included in filitered solution. Paths should be relative to solution rather than to .slnf",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"title": "JSON Schema for MSBuild solution filters",
"type": "object"
}
|
component_spec.json_schema.json | {
"$schema": "http://json-schema.org/draft-06/schema#",
"$id": "https://github.com/Cloud-Pipelines/component_spec_schema/components.json_schema.json",
"allOf": [{"$ref": "#/definitions/ComponentSpec"}],
"definitions": {
"TypeSpecType": {
"oneOf": [
{"type": "string"},
{"type": "object", "additionalProperties": {"$ref": "#/definitions/TypeSpecType"}}
]
},
"InputSpec": {
"desZcription": "Describes the component input specification",
"type": "object",
"required": ["name"],
"properties": {
"name": {"type": "string"},
"type": {"$ref": "#/definitions/TypeSpecType"},
"description": {"type": "string"},
"default": {"type": "string"},
"optional": {"type": "boolean", "default": false},
"annotations": {"type": "object"}
},
"additionalProperties": false
},
"OutputSpec": {
"description": "Describes the component output specification",
"type": "object",
"required": ["name"],
"properties": {
"name": {"type": "string"},
"type": {"$ref": "#/definitions/TypeSpecType"},
"description": {"type": "string"},
"annotations": {"type": "object"}
},
"additionalProperties": false
},
"InputValuePlaceholder": {
"description": "Represents the command-line argument placeholder that will be replaced at run-time by the input argument value.",
"type": "object",
"required": ["inputValue"],
"properties": {
"inputValue" : {
"description": "Name of the input.",
"type": "string"
}
},
"additionalProperties": false
},
"InputPathPlaceholder": {
"description": "Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file containing the input argument value.",
"type": "object",
"required": ["inputPath"],
"properties": {
"inputPath" : {
"description": "Name of the input.",
"type": "string"
}
},
"additionalProperties": false
},
"OutputPathPlaceholder": {
"description": "Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file where the program should write its output data.",
"type": "object",
"required": ["outputPath"],
"properties": {
"outputPath" : {
"description": "Name of the output.",
"type": "string"
}
},
"additionalProperties": false
},
"StringOrPlaceholder": {
"oneOf": [
{"type": "string"},
{"$ref": "#/definitions/InputValuePlaceholder"},
{"$ref": "#/definitions/InputPathPlaceholder"},
{"$ref": "#/definitions/OutputPathPlaceholder"},
{"$ref": "#/definitions/ConcatPlaceholder"},
{"$ref": "#/definitions/IfPlaceholder"}
]
},
"ConcatPlaceholder": {
"description": "Represents the command-line argument placeholder that will be replaced at run-time by the concatenated values of its items.",
"type": "object",
"required": ["concat"],
"properties": {
"concat" : {
"description": "Items to concatenate",
"type": "array",
"items": {"$ref": "#/definitions/StringOrPlaceholder"}
}
},
"additionalProperties": false
},
"IsPresentPlaceholder": {
"description": "Represents the command-line argument placeholder that will be replaced at run-time by a boolean value specifying whether the caller has passed an argument for the specified optional input.",
"type": "object",
"required": ["isPresent"],
"properties": {
"isPresent": {
"description": "Name of the input.",
"type": "string"
}
},
"additionalProperties": false
},
"IfConditionArgumentType": {
"oneOf": [
{"$ref": "#/definitions/IsPresentPlaceholder"},
{"type": "boolean"},
{"type": "string"},
{"$ref": "#/definitions/InputValuePlaceholder"}
]
},
"ListOfStringsOrPlaceholders" : {
"type": "array",
"items": {"$ref": "#/definitions/StringOrPlaceholder"}
},
"IfPlaceholder": {
"description": "Represents the command-line argument placeholder that will be replaced at run-time by a boolean value specifying whether the caller has passed an argument for the specified optional input.",
"type": "object",
"required": ["if"],
"properties": {
"if" : {
"type": "object",
"required": ["cond", "then"],
"properties": {
"cond": {"$ref": "#/definitions/IfConditionArgumentType"},
"then": {"$ref": "#/definitions/ListOfStringsOrPlaceholders"},
"else": {"$ref": "#/definitions/ListOfStringsOrPlaceholders"}
}
}
}
},
"ContainerSpec": {
"type": "object",
"required": ["image"],
"properties": {
"image": {
"description": "Docker image name.",
"$ref": "#/definitions/StringOrPlaceholder"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.",
"type": "array",
"items": {"$ref": "#/definitions/StringOrPlaceholder"}
},
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided.",
"type": "array",
"items": {"$ref": "#/definitions/StringOrPlaceholder"}
},
"env": {
"description": "List of environment variables to set in the container.",
"type": "object",
"additionalProperties": {"$ref": "#/definitions/StringOrPlaceholder"}
}
},
"additionalProperties": false
},
"ContainerImplementation": {
"description": "Represents the container component implementation.",
"type": "object",
"required": ["container"],
"properties": {
"container": {"$ref": "#/definitions/ContainerSpec"}
}
},
"ImplementationType": {
"oneOf": [
{"$ref": "#/definitions/ContainerImplementation"},
{"$ref": "#/definitions/GraphImplementation"}
]
},
"MetadataSpec": {
"type": "object",
"properties": {
"annotations": {"type": "object"}
},
"additionalProperties": false
},
"ComponentSpec": {
"description": "Component specification. Describes the metadata (name, description, source), the interface (inputs and outputs) and the implementation of the component.",
"type": "object",
"required": ["implementation"],
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"inputs": {"type": "array", "items": {"$ref": "#/definitions/InputSpec"}},
"outputs": {"type": "array", "items": {"$ref": "#/definitions/OutputSpec"}},
"implementation": {"$ref": "#/definitions/ImplementationType"},
"metadata": {"$ref": "#/definitions/MetadataSpec"}
},
"additionalProperties": false
},
"ComponentReference": {
"description": "Component reference. Contains information that can be used to locate and load a component by name, digest or URL",
"type": "object",
"properties": {
"name": {"type": "string"},
"digest": {"type": "string"},
"tag": {"type": "string"},
"url": {"type": "string"},
"spec": {"$ref": "#/definitions/ComponentSpec"}
},
"additionalProperties": false
},
"GraphInputArgument": {
"description": "Represents the component argument value that comes from the graph component input.",
"type": "object",
"required": ["graphInput"],
"properties": {
"graphInput": {
"description": "References the input of the graph/pipeline.",
"type": "object",
"required": ["inputName"],
"properties": {
"inputName": {"type": "string"},
"type": {"$ref": "#/definitions/TypeSpecType"}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"TaskOutputArgument": {
"description": "Represents the component argument value that comes from the output of a sibling task.",
"type": "object",
"required": ["taskOutput"],
"properties": {
"taskOutput": {
"description": "References the output of a sibling task.",
"type": "object",
"required": ["taskId", "outputName"],
"properties": {
"taskId": {"type": "string"},
"outputName": {"type": "string"},
"type": {"$ref": "#/definitions/TypeSpecType"}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ArgumentType": {
"oneOf": [
{"type": "string"},
{"$ref": "#/definitions/GraphInputArgument"},
{"$ref": "#/definitions/TaskOutputArgument"}
]
},
"TwoArgumentOperands": {
"description": "Pair of operands for a binary operation.",
"type": "object",
"required": ["op1", "op2"],
"properties": {
"op1": {"$ref": "#/definitions/ArgumentType"},
"op2": {"$ref": "#/definitions/ArgumentType"}
},
"additionalProperties": false
},
"TwoLogicalOperands": {
"description": "Pair of operands for a binary logical operation.",
"type": "object",
"required": ["op1", "op2"],
"properties": {
"op1": {"$ref": "#/definitions/PredicateType"},
"op2": {"$ref": "#/definitions/PredicateType"}
},
"additionalProperties": false
},
"PredicateType": {
"oneOf": [
{"type": "object", "required": ["=="], "properties": {"==": {"$ref": "#/definitions/TwoArgumentOperands"}}},
{"type": "object", "required": ["!="], "properties": {"!=": {"$ref": "#/definitions/TwoArgumentOperands"}}},
{"type": "object", "required": [">"], "properties": {">": {"$ref": "#/definitions/TwoArgumentOperands"}}},
{"type": "object", "required": [">="], "properties": {">=": {"$ref": "#/definitions/TwoArgumentOperands"}}},
{"type": "object", "required": ["<"], "properties": {"<": {"$ref": "#/definitions/TwoArgumentOperands"}}},
{"type": "object", "required": ["<="], "properties": {"<=": {"$ref": "#/definitions/TwoArgumentOperands"}}},
{"type": "object", "required": ["and"], "properties": {"and": {"$ref": "#/definitions/TwoLogicalOperands"}}},
{"type": "object", "required": ["or"], "properties": {"or": {"$ref": "#/definitions/TwoLogicalOperands"}}},
{"type": "object", "required": ["not"], "properties": {"not": {"$ref": "#/definitions/PredicateType"}}}
]
},
"RetryStrategySpec": {
"description": "Optional configuration that specifies how the task should be retried if it fails.",
"type": "object",
"properties": {
"maxRetries": {"type": "integer"}
},
"additionalProperties": false
},
"CachingStrategySpec": {
"description": "Optional configuration that specifies how the task execution may be skipped if the output data exist in cache.",
"type": "object",
"properties": {
"maxCacheStaleness": {"type": "string", "format": "duration"}
},
"additionalProperties": false
},
"ExecutionOptionsSpec": {
"description": "Optional configuration that specifies how the task should be executed. Can be used to set some platform-specific options.",
"type": "object",
"properties": {
"retryStrategy": {"$ref": "#/definitions/RetryStrategySpec"},
"cachingStrategy": {"$ref": "#/definitions/CachingStrategySpec"}
},
"additionalProperties": false
},
"TaskSpec": {
"description": "'Task specification. Task is a configured component - a component supplied with arguments and other applied configuration changes.",
"type": "object",
"required": ["componentRef"],
"properties": {
"componentRef": {"$ref": "#/definitions/ComponentReference"},
"arguments": {"type": "object", "additionalProperties": {"$ref": "#/definitions/ArgumentType"}},
"isEnabled": {"$ref": "#/definitions/PredicateType"},
"executionOptions": {"$ref": "#/definitions/ExecutionOptionsSpec"},
"annotations": {"type": "object"}
},
"additionalProperties": false
},
"GraphSpec": {
"description": "Describes the graph component implementation. It represents a graph of component tasks connected to the upstream sources of data using the argument specifications. It also describes the sources of graph output values.",
"type": "object",
"required": ["tasks"],
"properties": {
"tasks": {"type": "object", "additionalProperties": {"$ref": "#/definitions/TaskSpec"}},
"outputValues": {"type": "object", "additionalProperties": {"$ref": "#/definitions/TaskOutputArgument"}}
},
"additionalProperties": false
},
"GraphImplementation": {
"description": "Represents the graph component implementation.",
"type": "object",
"required": ["graph"],
"properties": {
"graph": {"$ref": "#/definitions/GraphSpec"}
},
"additionalProperties": false
},
"PipelineRunSpec": {
"description": "The object that can be sent to the backend to start a new Run.",
"type": "object",
"required": ["rootTask"],
"properties": {
"rootTask": {"$ref": "#/definitions/TaskSpec"},
"onExitTask": {"$ref": "#/definitions/TaskSpec"}
},
"additionalProperties": false
}
}
}
|
motif.schema.json | {"title":"Motif Config","markdownDescription":"This is your project's main configuration file. It is a JSON file, and includes information such as `head` data and template mappings. It can be accessed via the project settings (<kbd>Ctrl+,</kbd> (PC) / <kbd>Cmd+,</kbd> (Mac)) → _General_ → _Open motif.json_. Alternatively, you can find it at the top level of your project source tree.","properties":{"title":{"type":"string","markdownDescription":"If set, this title will be used for your pages whenever your pages don't specify a `title` entry in the [metadata](https://motif.land/docs/basics/metadata)."},"titleTemplate":{"type":"string","markdownDescription":"A title template for your pages. The `%s` part will be replaced with your page's title."},"baseCanonicalUrl":{"type":"string","markdownDescription":"The base of a canonical URL link tag."},"gaMeasurementId":{"type":"string","pattern":"^(G|UA|YT|MO)-[a-zA-Z0-9-]+$","markdownDescription":"Google Analytics tracking IDs, as explained in the [Google Analytics](https://motif.land/docs/guides/google-analytics) guide, to set up analytics tracking for your public pages."},"gaTrackingId":{"$ref":"#/properties/gaMeasurementId"},"templates":{"type":"object","markdownDescription":"This is a mapping between your pages, and the templates that should be used. It is automatically generated if you set a template via the page's document bar, but you can also edit it manually, for instance to set up automatic mapping rules that we describe below.\nThe template value (e.g. `home` or `blog-index`) must correspond to the name of the file in the `templates` folder.\nMappings are determined using a [glob syntax](https://en.wikipedia.org/wiki/Glob_(programming)), where:\n- `*` means all files in a given folder. E.g. `blog/*` means any files in the `blog` folder (but not in any of its subfolders)\n- `**/*` means all files in a given folder and subfolders of any depth. E.g. `blog/**/*` includes all files in the `blog` folder and its subfolders.\n**Note**: The most specific rule takes precendence.","additionalProperties":{"type":"string"}},"head":{"type":"array","markdownDescription":"This is a list of tags to inject in the `<head>` section of all your pages. This is where you load fonts, set Open Graph metadata, or load a custom stylesheet. Any HTML tags can be used.","items":{"type":"string"}},"sitemap":{"type":"object","properties":{"excludePaths":{"type":"array","markdownDescription":"If you wish to exclude the paths of some public pages from the sitemap, you can do so by adding a `sitemap.excludePaths` entry and specify a list of paths, either explicitly, or using the glob pattern mentioned above.","items":{"type":"string"}}}}}} |
drupal-routing.json | {
"$id": "https://json.schemastore.org/drupal-routing.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {
"type": "object",
"properties": {
"path": {
"title": "Route path",
"type": "string"
},
"defaults": {
"title": "Default route parameters",
"type": "object",
"properties": {
"_controller": {
"title": "A controller to execute when the route is matched",
"type": "string"
},
"_form": {
"type": "string"
},
"_title": {
"type": "string"
},
"_title_callback": {
"type": "string"
},
"_access": {
"type": "string"
},
"_entity_list": {
"type": "string"
},
"_entity_form": {
"type": "string"
},
"_entity_view": {
"type": "string"
}
}
},
"requirements": {
"title": "List of requirements that makes a specific route only match under specific conditions",
"type": "object",
"properties": {
"_access": {
"type": "string"
},
"_custom_access": {
"type": "string"
},
"_format": {
"type": "string"
},
"_entity_access": {
"type": "string"
},
"_entity_create_access": {
"type": "string"
},
"_entity_delete_multiple_access": {
"type": "string"
},
"_module_dependencies": {
"type": "string"
},
"_csrf_token": {
"type": "string"
},
"_user_is_logged_in": {
"type": "string"
},
"_access_theme": {
"type": "string"
},
"_permission": {
"type": "string"
}
}
},
"methods": {
"title": "Method of the incoming request to match the route",
"type": "array",
"items": {
"type": "string",
"enum": ["GET", "POST", "PATCH", "PUT", "DELETE"]
},
"uniqueItems": true
},
"options": {
"title": "Additional route options",
"type": "object",
"properties": {
"no_cache": {
"type": "boolean"
},
"_admin_route": {
"type": "boolean"
},
"_no_path": {
"type": "boolean"
},
"_maintenance_access": {
"type": "boolean"
},
"_node_operation_route": {
"type": "boolean"
},
"parameters": {
"type": "object"
},
"_auth": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
}
},
"additionalProperties": false
},
"properties": {
"route_callbacks": {
"title": "List of callbacks to provide routes",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
"title": "JSON schema for Drupal routing file",
"type": "object"
}
|
minecraft-advancement.json | {
"$comment": "https://minecraft.fandom.com/wiki/Advancement/JSON_format",
"$id": "https://json.schemastore.org/minecraft-advancement.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"jsonTextComponent": {
"$comment": "https://minecraft.fandom.com/wiki/Raw_JSON_text_format",
"type": ["string", "boolean", "number", "array", "object"],
"properties": {
"extra": {
"description": "A list of additional raw JSON text components to be displayed after this one.",
"type": "array",
"items": {
"description": "A child text component. Child text components inherit all formatting and interactivity from the parent component, unless they explicitly override them.",
"$ref": "#/definitions/jsonTextComponent"
}
},
"color": {
"description": "The color to render the content in.",
"type": "string",
"anyOf": [
{
"enum": [
"black",
"dark_blue",
"dark_green",
"dark_aqua",
"dark_red",
"dark_purple",
"gold",
"gray",
"dark_gray",
"blue",
"green",
"aqua",
"red",
"light_purple",
"yellow",
"white",
"reset"
]
},
{
"pattern": "#[A-F\\d]{6}"
}
]
},
"font": {
"description": "The resource location of the font for this component in the resource pack within assets/<namespace>/font.",
"type": "string",
"default": "minecraft:default"
},
"bold": {
"description": "Whether to render the content in bold.",
"type": "boolean"
},
"italic": {
"description": "Whether to render the content in italics. Note that text that is italicized by default, such as custom item names, can be unitalicized by setting this to false.",
"type": "boolean"
},
"underlined": {
"description": "Whether to underline the content.",
"type": "boolean"
},
"strikethrough": {
"description": "Whether to strikethrough the content.",
"type": "boolean"
},
"obfuscated": {
"description": "Whether to render the content obfuscated.",
"type": "boolean"
},
"insertion": {
"description": "When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing. This only works in chat messages.",
"type": "string"
},
"clickEvent": {
"title": "click event",
"description": "Allows for events to occur when the player clicks on text. Only work in chat messages and written books, unless specified otherwise.",
"type": "object",
"properties": {
"action": {
"description": "The action to perform when clicked.",
"type": "string",
"enum": [
"open_url",
"open_file",
"run_command",
"suggest_command",
"change_page",
"copy_to_clipboard"
]
},
"value": {
"description": "The URL, file path, chat, command or book page used by the specified action.",
"type": "string"
}
}
},
"hoverEvent": {
"title": "hover event",
"description": "Allows for a tooltip to be displayed when the player hovers their mouse over text.",
"type": "object",
"properties": {
"action": {
"description": "The type of tooltip to show.",
"type": "string",
"enum": ["show_text", "show_item", "show_entity"]
},
"value": {
"description": "The formatting and type of this tag varies depending on the action.",
"type": "string"
},
"contents": {
"title": "contents",
"description": "The formatting of this tag varies depending on the action.",
"type": "object"
}
}
},
"text": {
"description": "A string containing plain text to display directly. Can also be a number or boolean that is displayed directly.",
"type": ["string", "number", "boolean"]
},
"translate": {
"description": "A translation identifier, corresponding to the identifiers found in loaded language files. Displayed as the corresponding text in the player's selected language. If no corresponding translation can be found, the identifier itself is used as the translated text.",
"type": "string"
},
"with": {
"description": "A list of raw JSON text components to be inserted into slots in the translation text.",
"type": "array",
"items": {
"description": "A raw JSON text component. If no component is provided for a slot, the slot is displayed as no text.",
"$ref": "#/definitions/jsonTextComponent"
}
}
}
}
},
"description": "A data pack advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"properties": {
"display": {
"title": "display",
"description": "Display options for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "object",
"properties": {
"icon": {
"title": "icon",
"description": "Icon options for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "object",
"properties": {
"item": {
"description": "An item identifier for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"minLength": 1
},
"nbt": {
"description": "A named binary tag of an item for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"minLength": 1
}
}
},
"title": {
"title": "title",
"description": "A title for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"$ref": "#/definitions/jsonTextComponent"
},
"frame": {
"description": "A frame type for the icon for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"enum": ["challenge", "goal", "task"],
"default": "task"
},
"background": {
"description": "A background directory for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"$ref": "https://json.schemastore.org/base.json#/definitions/path"
},
"description": {
"title": "description",
"description": "A description for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"$ref": "#/definitions/jsonTextComponent"
},
"show_toast": {
"description": "Whether or not to show the toast pop up after completing the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "boolean",
"default": true
},
"annouce_to_chat": {
"description": "Whether or not to announce in the chat when the current advancement has been completed\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "boolean",
"default": true
},
"hidden": {
"description": "Whether or not to hide this advancement and all its children from the advancement screen until the current advancement have been completed\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "boolean",
"default": false
}
}
},
"parent": {
"description": "A parent directory for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"$ref": "https://json.schemastore.org/base.json#/definitions/path"
},
"criteria": {
"title": "criterias",
"description": "Required criterias have to be met for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "object",
"additionalProperties": {
"title": "criteria",
"description": "Required criteria have to be met for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "object",
"properties": {
"trigger": {
"description": "A trigger for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria",
"type": "string"
},
"conditions": {
"description": "Conditions need to be met when the trigger gets activated for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria",
"type": "object",
"properties": {
"player": {
"title": "player options",
"description": "Check properties of the player for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria",
"type": ["array", "object"]
}
}
}
}
}
},
"requirements": {
"description": "Requirements for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "array",
"uniqueItems": true,
"items": {
"description": "Criterions for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "array",
"uniqueItems": true,
"items": {
"description": "Criterion name for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"minLength": 1
}
}
},
"rewards": {
"title": "rewards",
"description": "Rewards for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "object",
"properties": {
"recipes": {
"description": "Recipes to unlock for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "array",
"uniqueItems": true,
"items": {
"description": "A namespaced identifier for a recipe for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"minLength": 1
}
},
"loot": {
"description": "Loot tables to give to the player for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "array",
"uniqueItems": true,
"items": {
"description": "A namespaced identifier for a loot table for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"minLength": 1
}
},
"experience": {
"description": "An experience amount for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "integer",
"minimum": 0
},
"function": {
"description": "A function to run for the current advancement\nhttps://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
},
"title": "data pack advancement",
"type": "object"
}
|
cluster.yml.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/RancherKubernetesEngineConfig",
"definitions": {
"AESConfiguration": {
"required": [
"Keys"
],
"properties": {
"Keys": {
"items": {
"$ref": "#/definitions/Key"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"AWSCloudProvider": {
"required": [
"global"
],
"properties": {
"global": {
"$ref": "#/definitions/GlobalAwsOpts"
},
"service_override": {
"patternProperties": {
".*": {
"$ref": "#/definitions/ServiceOverride"
}
},
"type": "object"
}
},
"additionalProperties": false,
"type": "object"
},
"AWSElasticBlockStoreVolumeSource": {
"required": [
"VolumeID",
"FSType",
"Partition",
"ReadOnly"
],
"properties": {
"VolumeID": {
"type": "string"
},
"FSType": {
"type": "string"
},
"Partition": {
"type": "integer"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"AciNetworkProvider": {
"properties": {
"system_id": {
"type": "string"
},
"apic_hosts": {
"items": {
"type": "string"
},
"type": "array"
},
"token": {
"type": "string"
},
"apic_user_name": {
"type": "string"
},
"apic_user_key": {
"type": "string"
},
"apic_user_crt": {
"type": "string"
},
"apic_refresh_time": {
"type": "string"
},
"vmm_domain": {
"type": "string"
},
"vmm_controller": {
"type": "string"
},
"encap_type": {
"type": "string"
},
"node_subnet": {
"type": "string"
},
"mcast_range_start": {
"type": "string"
},
"mcast_range_end": {
"type": "string"
},
"aep": {
"type": "string"
},
"vrf_name": {
"type": "string"
},
"vrf_tenant": {
"type": "string"
},
"l3out": {
"type": "string"
},
"l3out_external_networks": {
"items": {
"type": "string"
},
"type": "array"
},
"extern_dynamic": {
"type": "string"
},
"extern_static": {
"type": "string"
},
"node_svc_subnet": {
"type": "string"
},
"kube_api_vlan": {
"type": "string"
},
"service_vlan": {
"type": "string"
},
"infra_vlan": {
"type": "string"
},
"tenant": {
"type": "string"
},
"ovs_memory_limit": {
"type": "string"
},
"image_pull_policy": {
"type": "string"
},
"image_pull_secret": {
"type": "string"
},
"service_monitor_interval": {
"type": "string"
},
"pbr_tracking_non_snat": {
"type": "string"
},
"install_istio": {
"type": "string"
},
"istio_profile": {
"type": "string"
},
"drop_log_enable": {
"type": "string"
},
"controller_log_level": {
"type": "string"
},
"host_agent_log_level": {
"type": "string"
},
"opflex_log_level": {
"type": "string"
},
"use_aci_cni_priority_class": {
"type": "string"
},
"no_priority_class": {
"type": "string"
},
"max_nodes_svc_graph": {
"type": "string"
},
"snat_contract_scope": {
"type": "string"
},
"pod_subnet_chunk_size": {
"type": "string"
},
"enable_endpoint_slice": {
"type": "string"
},
"snat_namespace": {
"type": "string"
},
"ep_registry": {
"type": "string"
},
"opflex_mode": {
"type": "string"
},
"snat_port_range_start": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"snat_port_range_end": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"snat_ports_per_node": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"opflex_client_ssl": {
"type": "string"
},
"use_privileged_container": {
"type": "string"
},
"use_host_netns_volume": {
"type": "string"
},
"use_opflex_server_volume": {
"type": "string"
},
"subnet_domain_name": {
"type": "string"
},
"kafka_brokers": {
"items": {
"type": "string"
},
"type": "array"
},
"kafka_client_crt": {
"type": "string"
},
"kafka_client_key": {
"type": "string"
},
"capic": {
"type": "string"
},
"use_aci_anywhere_crd": {
"type": "string"
},
"overlay_vrf_name": {
"type": "string"
},
"gbp_pod_subnet": {
"type": "string"
},
"run_gbp_container": {
"type": "string"
},
"run_opflex_server_container": {
"type": "string"
},
"opflex_server_port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"additionalProperties": false,
"type": "object"
},
"AdmissionConfiguration": {
"required": [
"Kind",
"APIVersion",
"Plugins"
],
"properties": {
"Kind": {
"type": "string"
},
"APIVersion": {
"type": "string"
},
"Plugins": {
"items": {
"$ref": "#/definitions/AdmissionPluginConfiguration"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"AdmissionPluginConfiguration": {
"required": [
"Name",
"Path",
"Configuration"
],
"properties": {
"Name": {
"type": "string"
},
"Path": {
"type": "string"
},
"Configuration": {
"$ref": "#/definitions/Unknown"
}
},
"additionalProperties": false,
"type": "object"
},
"AuditLog": {
"properties": {
"enabled": {
"type": "boolean"
},
"configuration": {
"$ref": "#/definitions/AuditLogConfig"
}
},
"additionalProperties": false,
"type": "object"
},
"AuditLogConfig": {
"properties": {
"max_age": {
"type": "integer"
},
"max_backup": {
"type": "integer"
},
"max_size": {
"type": "integer"
},
"path": {
"type": "string"
},
"format": {
"type": "string"
},
"policy": {
"$ref": "#/definitions/Policy"
}
},
"additionalProperties": false,
"type": "object"
},
"AuthWebhookConfig": {
"properties": {
"config_file": {
"type": "string",
"description": "ConfigFile is a multiline string that represent a custom webhook config file"
},
"cache_timeout": {
"type": "string",
"description": "CacheTimeout controls how long to cache authentication decisions"
}
},
"additionalProperties": false,
"type": "object"
},
"AuthnConfig": {
"properties": {
"strategy": {
"type": "string",
"description": "Authentication strategy that will be used in kubernetes cluster"
},
"sans": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of additional hostnames and IPs to include in the api server PKI cert"
},
"webhook": {
"$ref": "#/definitions/AuthWebhookConfig",
"description": "Webhook configuration options"
}
},
"additionalProperties": false,
"type": "object"
},
"AuthzConfig": {
"properties": {
"mode": {
"type": "string",
"description": "Authorization mode used by kubernetes"
},
"options": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "Authorization mode options"
}
},
"additionalProperties": false,
"type": "object"
},
"AzureCloudProvider": {
"required": [
"cloud",
"tenantId",
"subscriptionId",
"resourceGroup",
"location",
"vnetName",
"vnetResourceGroup",
"subnetName",
"securityGroupName",
"routeTableName",
"primaryAvailabilitySetName",
"vmType",
"primaryScaleSetName",
"aadClientId",
"aadClientSecret",
"aadClientCertPath",
"aadClientCertPassword",
"cloudProviderBackoff",
"cloudProviderBackoffRetries",
"cloudProviderBackoffExponent",
"cloudProviderBackoffDuration",
"cloudProviderBackoffJitter",
"cloudProviderRateLimit",
"cloudProviderRateLimitQPS",
"cloudProviderRateLimitBucket",
"useInstanceMetadata",
"useManagedIdentityExtension",
"maximumLoadBalancerRuleCount"
],
"properties": {
"cloud": {
"type": "string",
"description": "The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13"
},
"tenantId": {
"type": "string",
"description": "The AAD Tenant ID for the Subscription that the cluster is deployed in"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the Azure Subscription that the cluster is deployed in"
},
"resourceGroup": {
"type": "string",
"description": "The name of the resource group that the cluster is deployed in"
},
"location": {
"type": "string",
"description": "The location of the resource group that the cluster is deployed in"
},
"vnetName": {
"type": "string",
"description": "The name of the VNet that the cluster is deployed in"
},
"vnetResourceGroup": {
"type": "string",
"description": "The name of the resource group that the Vnet is deployed in"
},
"subnetName": {
"type": "string",
"description": "The name of the subnet that the cluster is deployed in"
},
"securityGroupName": {
"type": "string",
"description": "The name of the security group attached to the cluster's subnet"
},
"routeTableName": {
"type": "string",
"description": "(Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in"
},
"primaryAvailabilitySetName": {
"type": "string",
"description": "(Optional) The name of the availability set that should be used as the load balancer backend\nIf this is set, the Azure cloudprovider will only add nodes from that availability set to the load\nbalancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then\nthe cloudprovider will try to add all nodes to a single backend pool which is forbidden.\nIn other words, if you use multiple agent pools (availability sets), you MUST set this field."
},
"vmType": {
"type": "string",
"description": "The type of azure nodes. Candidate valudes are: vmss and standard.\nIf not set, it will be default to standard."
},
"primaryScaleSetName": {
"type": "string",
"description": "The name of the scale set that should be used as the load balancer backend.\nIf this is set, the Azure cloudprovider will only add nodes from that scale set to the load\nbalancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then\nthe cloudprovider will try to add all nodes to a single backend pool which is forbidden.\nIn other words, if you use multiple agent pools (scale sets), you MUST set this field."
},
"aadClientId": {
"type": "string",
"description": "The ClientID for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md"
},
"aadClientSecret": {
"type": "string",
"description": "The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md"
},
"aadClientCertPath": {
"type": "string",
"description": "The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service"
},
"aadClientCertPassword": {
"type": "string",
"description": "The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs\nThis's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service"
},
"cloudProviderBackoff": {
"type": "boolean",
"description": "Enable exponential backoff to manage resource request retries"
},
"cloudProviderBackoffRetries": {
"type": "integer",
"description": "Backoff retry limit"
},
"cloudProviderBackoffExponent": {
"type": "integer",
"description": "Backoff exponent"
},
"cloudProviderBackoffDuration": {
"type": "integer",
"description": "Backoff duration"
},
"cloudProviderBackoffJitter": {
"type": "integer",
"description": "Backoff jitter"
},
"cloudProviderRateLimit": {
"type": "boolean",
"description": "Enable rate limiting"
},
"cloudProviderRateLimitQPS": {
"type": "integer",
"description": "Rate limit QPS"
},
"cloudProviderRateLimitBucket": {
"type": "integer",
"description": "Rate limit Bucket Size"
},
"useInstanceMetadata": {
"type": "boolean",
"description": "Use instance metadata service where possible"
},
"useManagedIdentityExtension": {
"type": "boolean",
"description": "Use managed service identity for the virtual machine to access Azure ARM APIs\nThis's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview\nFor user-assigned managed identity, need to set the below UserAssignedIdentityID"
},
"userAssignedIdentityID": {
"type": "string",
"description": "The Client ID of the user assigned MSI which is assigned to the underlying VMs\nThis's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview"
},
"maximumLoadBalancerRuleCount": {
"type": "integer",
"description": "Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148"
},
"loadBalancerSku": {
"type": "string",
"description": "Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`"
},
"excludeMasterFromStandardLB": {
"type": "boolean",
"description": "Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true`\nIf want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes"
}
},
"additionalProperties": false,
"type": "object"
},
"AzureDiskVolumeSource": {
"required": [
"DiskName",
"DataDiskURI",
"CachingMode",
"FSType",
"ReadOnly",
"Kind"
],
"properties": {
"DiskName": {
"type": "string"
},
"DataDiskURI": {
"type": "string"
},
"CachingMode": {
"type": "string"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"Kind": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"AzureFileVolumeSource": {
"required": [
"SecretName",
"ShareName",
"ReadOnly"
],
"properties": {
"SecretName": {
"type": "string"
},
"ShareName": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"BackupConfig": {
"required": [
"enabled",
"interval_hours",
"retention",
"safe_timestamp",
"timeout"
],
"properties": {
"enabled": {
"type": "boolean"
},
"interval_hours": {
"type": "integer"
},
"retention": {
"type": "integer"
},
"S3BackupConfig": {
"$ref": "#/definitions/S3BackupConfig"
},
"safe_timestamp": {
"type": "boolean"
},
"timeout": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"BastionHost": {
"properties": {
"address": {
"type": "string",
"description": "Address of Bastion Host"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "SSH Port of Bastion Host"
},
"user": {
"type": "string",
"description": "ssh User to Bastion Host"
},
"ssh_agent_auth": {
"type": "boolean",
"description": "SSH Agent Auth enable"
},
"ssh_key": {
"type": "string",
"description": "SSH Private Key"
},
"ssh_key_path": {
"type": "string",
"description": "SSH Private Key Path"
},
"ssh_cert": {
"type": "string",
"description": "SSH Certificate"
},
"ssh_cert_path": {
"type": "string",
"description": "SSH Certificate Path"
},
"ignore_proxy_env_vars": {
"type": "boolean",
"description": "Ignore proxy environment variables"
}
},
"additionalProperties": false,
"type": "object"
},
"BlockStorageOpenstackOpts": {
"required": [
"bs-version",
"trust-device-path",
"ignore-volume-az"
],
"properties": {
"bs-version": {
"type": "string",
"description": "overrides autodetection. v1 or v2. Defaults to auto"
},
"trust-device-path": {
"type": "boolean",
"description": "See Issue #33128"
},
"ignore-volume-az": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"CSIVolumeSource": {
"required": [
"Driver",
"ReadOnly",
"FSType",
"VolumeAttributes",
"NodePublishSecretRef"
],
"properties": {
"Driver": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"FSType": {
"type": "string"
},
"VolumeAttributes": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"NodePublishSecretRef": {
"$ref": "#/definitions/LocalObjectReference"
}
},
"additionalProperties": false,
"type": "object"
},
"CalicoNetworkProvider": {
"required": [
"CloudProvider"
],
"properties": {
"CloudProvider": {
"type": "string",
"description": "Cloud provider type used with calico"
}
},
"additionalProperties": false,
"type": "object"
},
"CanalNetworkProvider": {
"required": [
"Iface"
],
"properties": {
"Iface": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"CephFSVolumeSource": {
"required": [
"Monitors",
"Path",
"User",
"SecretFile",
"SecretRef",
"ReadOnly"
],
"properties": {
"Monitors": {
"items": {
"type": "string"
},
"type": "array"
},
"Path": {
"type": "string"
},
"User": {
"type": "string"
},
"SecretFile": {
"type": "string"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"CinderVolumeSource": {
"required": [
"VolumeID",
"FSType",
"ReadOnly",
"SecretRef"
],
"properties": {
"VolumeID": {
"type": "string"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
}
},
"additionalProperties": false,
"type": "object"
},
"CloudProvider": {
"properties": {
"name": {
"type": "string",
"description": "Name of the Cloud Provider"
},
"awsCloudProvider": {
"$ref": "#/definitions/AWSCloudProvider",
"description": "AWSCloudProvider"
},
"azureCloudProvider": {
"$ref": "#/definitions/AzureCloudProvider",
"description": "AzureCloudProvider"
},
"openstackCloudProvider": {
"$ref": "#/definitions/OpenstackCloudProvider",
"description": "OpenstackCloudProvider"
},
"vsphereCloudProvider": {
"$ref": "#/definitions/VsphereCloudProvider",
"description": "VsphereCloudProvider"
},
"customCloudProvider": {
"type": "string",
"description": "CustomCloudProvider is a multiline string that represent a custom cloud config file"
}
},
"additionalProperties": false,
"type": "object"
},
"ConfigMapKeySelector": {
"required": [
"Name",
"Key",
"Optional"
],
"properties": {
"Name": {
"type": "string"
},
"Key": {
"type": "string"
},
"Optional": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"ConfigMapProjection": {
"required": [
"Name",
"Items",
"Optional"
],
"properties": {
"Name": {
"type": "string"
},
"Items": {
"items": {
"$ref": "#/definitions/KeyToPath"
},
"type": "array"
},
"Optional": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"ConfigMapVolumeSource": {
"required": [
"Name",
"Items",
"DefaultMode",
"Optional"
],
"properties": {
"Name": {
"type": "string"
},
"Items": {
"items": {
"$ref": "#/definitions/KeyToPath"
},
"type": "array"
},
"DefaultMode": {
"type": "integer"
},
"Optional": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"Configuration": {
"required": [
"Kind",
"APIVersion",
"Limits"
],
"properties": {
"Kind": {
"type": "string"
},
"APIVersion": {
"type": "string"
},
"Limits": {
"items": {
"$ref": "#/definitions/Limit"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"DNSConfig": {
"properties": {
"provider": {
"type": "string",
"description": "DNS provider"
},
"options": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "DNS config options"
},
"upstreamnameservers": {
"items": {
"type": "string"
},
"type": "array",
"description": "Upstream nameservers"
},
"reversecidrs": {
"items": {
"type": "string"
},
"type": "array",
"description": "ReverseCIDRs"
},
"stubdomains": {
"patternProperties": {
".*": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"description": "Stubdomains"
},
"node_selector": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "NodeSelector key pair"
},
"nodelocal": {
"$ref": "#/definitions/Nodelocal",
"description": "Nodelocal DNS"
},
"update_strategy": {
"$ref": "#/definitions/DeploymentStrategy",
"description": "Update strategy"
},
"linear_autoscaler_params": {
"$ref": "#/definitions/LinearAutoscalerParams",
"description": "Autoscaler fields to determine number of dns replicas"
},
"tolerations": {
"items": {
"$ref": "#/definitions/Toleration"
},
"type": "array",
"description": "Tolerations for Deployments"
}
},
"additionalProperties": false,
"type": "object"
},
"DaemonSetUpdateStrategy": {
"required": [
"Strategy",
"RollingUpdate"
],
"properties": {
"Strategy": {
"type": "string"
},
"RollingUpdate": {
"$ref": "#/definitions/RollingUpdateDaemonSet"
}
},
"additionalProperties": false,
"type": "object"
},
"DeploymentStrategy": {
"required": [
"Strategy",
"RollingUpdate"
],
"properties": {
"Strategy": {
"type": "string"
},
"RollingUpdate": {
"$ref": "#/definitions/RollingUpdateDeployment"
}
},
"additionalProperties": false,
"type": "object"
},
"DiskVsphereOpts": {
"properties": {
"scsicontrollertype": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"DownwardAPIProjection": {
"required": [
"Items"
],
"properties": {
"Items": {
"items": {
"$ref": "#/definitions/DownwardAPIVolumeFile"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"DownwardAPIVolumeFile": {
"required": [
"Path",
"FieldRef",
"ResourceFieldRef",
"Mode"
],
"properties": {
"Path": {
"type": "string"
},
"FieldRef": {
"$ref": "#/definitions/ObjectFieldSelector"
},
"ResourceFieldRef": {
"$ref": "#/definitions/ResourceFieldSelector"
},
"Mode": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"DownwardAPIVolumeSource": {
"required": [
"Items",
"DefaultMode"
],
"properties": {
"Items": {
"items": {
"$ref": "#/definitions/DownwardAPIVolumeFile"
},
"type": "array"
},
"DefaultMode": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"Duration": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"ECRCredentialPlugin": {
"required": [
"aws_access_key_id",
"aws_secret_access_key",
"aws_session_token"
],
"properties": {
"aws_access_key_id": {
"type": "string"
},
"aws_secret_access_key": {
"type": "string"
},
"aws_session_token": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"ETCDService": {
"properties": {
"image": {
"type": "string"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"win_extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"external_urls": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of etcd urls"
},
"ca_cert": {
"type": "string",
"description": "External CA certificate"
},
"cert": {
"type": "string",
"description": "External Client certificate"
},
"key": {
"type": "string",
"description": "External Client key"
},
"path": {
"type": "string",
"description": "External etcd prefix"
},
"uid": {
"type": "integer",
"description": "UID to run etcd container as"
},
"gid": {
"type": "integer",
"description": "GID to run etcd container as"
},
"snapshot": {
"type": "boolean",
"description": "Etcd Recurring snapshot Service, used by rke only"
},
"retention": {
"type": "string",
"description": "Etcd snapshot Retention period"
},
"creation": {
"type": "string",
"description": "Etcd snapshot Creation period"
},
"backup_config": {
"$ref": "#/definitions/BackupConfig",
"description": "Backup backend for etcd snapshots"
}
},
"additionalProperties": false,
"type": "object"
},
"EmptyDirVolumeSource": {
"required": [
"Medium",
"SizeLimit"
],
"properties": {
"Medium": {
"type": "string"
},
"SizeLimit": {
"$ref": "#/definitions/Quantity"
}
},
"additionalProperties": false,
"type": "object"
},
"EncryptionConfiguration": {
"required": [
"Kind",
"APIVersion",
"Resources"
],
"properties": {
"Kind": {
"type": "string"
},
"APIVersion": {
"type": "string"
},
"Resources": {
"items": {
"$ref": "#/definitions/ResourceConfiguration"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"EnvVarSource": {
"required": [
"FieldRef",
"ResourceFieldRef",
"ConfigMapKeyRef",
"SecretKeyRef"
],
"properties": {
"FieldRef": {
"$ref": "#/definitions/ObjectFieldSelector"
},
"ResourceFieldRef": {
"$ref": "#/definitions/ResourceFieldSelector"
},
"ConfigMapKeyRef": {
"$ref": "#/definitions/ConfigMapKeySelector"
},
"SecretKeyRef": {
"$ref": "#/definitions/SecretKeySelector"
}
},
"additionalProperties": false,
"type": "object"
},
"EphemeralVolumeSource": {
"required": [
"VolumeClaimTemplate"
],
"properties": {
"VolumeClaimTemplate": {
"$ref": "#/definitions/PersistentVolumeClaimTemplate"
}
},
"additionalProperties": false,
"type": "object"
},
"EventRateLimit": {
"properties": {
"enabled": {
"type": "boolean"
},
"configuration": {
"$ref": "#/definitions/Configuration"
}
},
"additionalProperties": false,
"type": "object"
},
"ExtraEnv": {
"required": [
"Name",
"Value",
"ValueFrom"
],
"properties": {
"Name": {
"type": "string"
},
"Value": {
"type": "string"
},
"ValueFrom": {
"$ref": "#/definitions/EnvVarSource"
}
},
"additionalProperties": false,
"type": "object"
},
"ExtraVolume": {
"required": [
"Name",
"HostPath",
"EmptyDir",
"GCEPersistentDisk",
"AWSElasticBlockStore",
"GitRepo",
"Secret",
"NFS",
"ISCSI",
"Glusterfs",
"PersistentVolumeClaim",
"RBD",
"FlexVolume",
"Cinder",
"CephFS",
"Flocker",
"DownwardAPI",
"FC",
"AzureFile",
"ConfigMap",
"VsphereVolume",
"Quobyte",
"AzureDisk",
"PhotonPersistentDisk",
"Projected",
"PortworxVolume",
"ScaleIO",
"StorageOS",
"CSI",
"Ephemeral"
],
"properties": {
"Name": {
"type": "string"
},
"HostPath": {
"$ref": "#/definitions/HostPathVolumeSource"
},
"EmptyDir": {
"$ref": "#/definitions/EmptyDirVolumeSource"
},
"GCEPersistentDisk": {
"$ref": "#/definitions/GCEPersistentDiskVolumeSource"
},
"AWSElasticBlockStore": {
"$ref": "#/definitions/AWSElasticBlockStoreVolumeSource"
},
"GitRepo": {
"$ref": "#/definitions/GitRepoVolumeSource"
},
"Secret": {
"$ref": "#/definitions/SecretVolumeSource"
},
"NFS": {
"$ref": "#/definitions/NFSVolumeSource"
},
"ISCSI": {
"$ref": "#/definitions/ISCSIVolumeSource"
},
"Glusterfs": {
"$ref": "#/definitions/GlusterfsVolumeSource"
},
"PersistentVolumeClaim": {
"$ref": "#/definitions/PersistentVolumeClaimVolumeSource"
},
"RBD": {
"$ref": "#/definitions/RBDVolumeSource"
},
"FlexVolume": {
"$ref": "#/definitions/FlexVolumeSource"
},
"Cinder": {
"$ref": "#/definitions/CinderVolumeSource"
},
"CephFS": {
"$ref": "#/definitions/CephFSVolumeSource"
},
"Flocker": {
"$ref": "#/definitions/FlockerVolumeSource"
},
"DownwardAPI": {
"$ref": "#/definitions/DownwardAPIVolumeSource"
},
"FC": {
"$ref": "#/definitions/FCVolumeSource"
},
"AzureFile": {
"$ref": "#/definitions/AzureFileVolumeSource"
},
"ConfigMap": {
"$ref": "#/definitions/ConfigMapVolumeSource"
},
"VsphereVolume": {
"$ref": "#/definitions/VsphereVirtualDiskVolumeSource"
},
"Quobyte": {
"$ref": "#/definitions/QuobyteVolumeSource"
},
"AzureDisk": {
"$ref": "#/definitions/AzureDiskVolumeSource"
},
"PhotonPersistentDisk": {
"$ref": "#/definitions/PhotonPersistentDiskVolumeSource"
},
"Projected": {
"$ref": "#/definitions/ProjectedVolumeSource"
},
"PortworxVolume": {
"$ref": "#/definitions/PortworxVolumeSource"
},
"ScaleIO": {
"$ref": "#/definitions/ScaleIOVolumeSource"
},
"StorageOS": {
"$ref": "#/definitions/StorageOSVolumeSource"
},
"CSI": {
"$ref": "#/definitions/CSIVolumeSource"
},
"Ephemeral": {
"$ref": "#/definitions/EphemeralVolumeSource"
}
},
"additionalProperties": false,
"type": "object"
},
"ExtraVolumeMount": {
"required": [
"Name",
"ReadOnly",
"MountPath",
"SubPath",
"MountPropagation",
"SubPathExpr"
],
"properties": {
"Name": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"MountPath": {
"type": "string"
},
"SubPath": {
"type": "string"
},
"MountPropagation": {
"type": "string"
},
"SubPathExpr": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"FCVolumeSource": {
"required": [
"TargetWWNs",
"Lun",
"FSType",
"ReadOnly",
"WWIDs"
],
"properties": {
"TargetWWNs": {
"items": {
"type": "string"
},
"type": "array"
},
"Lun": {
"type": "integer"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"WWIDs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"FieldsV1": {
"required": [
"Raw"
],
"properties": {
"Raw": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"FlannelNetworkProvider": {
"required": [
"Iface"
],
"properties": {
"Iface": {
"type": "string",
"description": "Alternate cloud interface for flannel"
}
},
"additionalProperties": false,
"type": "object"
},
"FlexVolumeSource": {
"required": [
"Driver",
"FSType",
"SecretRef",
"ReadOnly",
"Options"
],
"properties": {
"Driver": {
"type": "string"
},
"FSType": {
"type": "string"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
},
"ReadOnly": {
"type": "boolean"
},
"Options": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
}
},
"additionalProperties": false,
"type": "object"
},
"FlockerVolumeSource": {
"required": [
"DatasetName",
"DatasetUUID"
],
"properties": {
"DatasetName": {
"type": "string"
},
"DatasetUUID": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"GCEPersistentDiskVolumeSource": {
"required": [
"PDName",
"FSType",
"Partition",
"ReadOnly"
],
"properties": {
"PDName": {
"type": "string"
},
"FSType": {
"type": "string"
},
"Partition": {
"type": "integer"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"GitRepoVolumeSource": {
"required": [
"Repository",
"Revision",
"Directory"
],
"properties": {
"Repository": {
"type": "string"
},
"Revision": {
"type": "string"
},
"Directory": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"GlobalAwsOpts": {
"required": [
"zone",
"vpc",
"subnet-id",
"routetable-id",
"role-arn",
"kubernetes-cluster-tag",
"kubernetes-cluster-id",
"disable-security-group-ingress",
"elb-security-group",
"disable-strict-zone-check"
],
"properties": {
"zone": {
"type": "string",
"description": "TODO: Is there any use for this? We can get it from the instance metadata service\nMaybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful"
},
"vpc": {
"type": "string",
"description": "The AWS VPC flag enables the possibility to run the master components\non a different aws account, on a different cloud provider or on-premises.\nIf the flag is set also the KubernetesClusterTag must be provided"
},
"subnet-id": {
"type": "string",
"description": "SubnetID enables using a specific subnet to use for ELB's"
},
"routetable-id": {
"type": "string",
"description": "RouteTableID enables using a specific RouteTable"
},
"role-arn": {
"type": "string",
"description": "RoleARN is the IAM role to assume when interaction with AWS APIs."
},
"kubernetes-cluster-tag": {
"type": "string",
"description": "KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources"
},
"kubernetes-cluster-id": {
"type": "string",
"description": "KubernetesClusterID is the cluster id we'll use to identify our cluster resources"
},
"disable-security-group-ingress": {
"type": "boolean",
"description": "The aws provider creates an inbound rule per load balancer on the node security\ngroup. However, this can run into the AWS security group rule limit of 50 if\nmany LoadBalancers are created.\n\nThis flag disables the automatic ingress creation. It requires that the user\nhas setup a rule that allows inbound traffic on kubelet ports from the\nlocal VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000."
},
"elb-security-group": {
"type": "string",
"description": "AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB\ncan cause the max number of security groups to be reached. If this is set instead of creating a new\nSecurity group for each ELB this security group will be used instead."
},
"disable-strict-zone-check": {
"type": "boolean",
"description": "During the instantiation of an new AWS cloud provider, the detected region\nis validated against a known set of regions.\n\nIn a non-standard, AWS like environment (e.g. Eucalyptus), this check may\nbe undesirable. Setting this to true will disable the check and provide\na warning that the check was skipped. Please note that this is an\nexperimental feature and work-in-progress for the moment. If you find\nyourself in an non-AWS cloud and open an issue, please indicate that in the\nissue body."
}
},
"additionalProperties": false,
"type": "object"
},
"GlobalOpenstackOpts": {
"required": [
"auth-url",
"username",
"user-id",
"password",
"tenant-id",
"tenant-name",
"trust-id",
"domain-id",
"domain-name",
"region",
"ca-file"
],
"properties": {
"auth-url": {
"type": "string"
},
"username": {
"type": "string"
},
"user-id": {
"type": "string"
},
"password": {
"type": "string"
},
"tenant-id": {
"type": "string"
},
"tenant-name": {
"type": "string"
},
"trust-id": {
"type": "string"
},
"domain-id": {
"type": "string"
},
"domain-name": {
"type": "string"
},
"region": {
"type": "string"
},
"ca-file": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"GlobalVsphereOpts": {
"properties": {
"user": {
"type": "string"
},
"password": {
"type": "string"
},
"server": {
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"insecure-flag": {
"type": "boolean"
},
"datacenter": {
"type": "string"
},
"datacenters": {
"type": "string"
},
"datastore": {
"type": "string"
},
"working-dir": {
"type": "string"
},
"soap-roundtrip-count": {
"type": "integer"
},
"vm-uuid": {
"type": "string"
},
"vm-name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"GlusterfsVolumeSource": {
"required": [
"EndpointsName",
"Path",
"ReadOnly"
],
"properties": {
"EndpointsName": {
"type": "string"
},
"Path": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"GroupResources": {
"required": [
"Group",
"Resources",
"ResourceNames"
],
"properties": {
"Group": {
"type": "string"
},
"Resources": {
"items": {
"type": "string"
},
"type": "array"
},
"ResourceNames": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"HostPathVolumeSource": {
"required": [
"Path",
"Type"
],
"properties": {
"Path": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"ISCSIVolumeSource": {
"required": [
"TargetPortal",
"IQN",
"Lun",
"ISCSIInterface",
"FSType",
"ReadOnly",
"Portals",
"DiscoveryCHAPAuth",
"SessionCHAPAuth",
"SecretRef",
"InitiatorName"
],
"properties": {
"TargetPortal": {
"type": "string"
},
"IQN": {
"type": "string"
},
"Lun": {
"type": "integer"
},
"ISCSIInterface": {
"type": "string"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"Portals": {
"items": {
"type": "string"
},
"type": "array"
},
"DiscoveryCHAPAuth": {
"type": "boolean"
},
"SessionCHAPAuth": {
"type": "boolean"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
},
"InitiatorName": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"IdentityConfiguration": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"IngressConfig": {
"properties": {
"provider": {
"type": "string",
"description": "Ingress controller type used by kubernetes"
},
"options": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "These options are NOT for configuring Ingress's addon template.\nThey are used for its ConfigMap options specifically."
},
"node_selector": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "NodeSelector key pair"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "Ingress controller extra arguments"
},
"dns_policy": {
"type": "string",
"description": "DNS Policy"
},
"extra_envs": {
"items": {
"$ref": "#/definitions/ExtraEnv"
},
"type": "array",
"description": "Extra Env vars"
},
"extra_volumes": {
"items": {
"$ref": "#/definitions/ExtraVolume"
},
"type": "array",
"description": "Extra volumes"
},
"extra_volume_mounts": {
"items": {
"$ref": "#/definitions/ExtraVolumeMount"
},
"type": "array",
"description": "Extra volume mounts"
},
"update_strategy": {
"$ref": "#/definitions/DaemonSetUpdateStrategy",
"description": "nginx daemonset upgrade strategy"
},
"http_port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Http port for ingress controller daemonset"
},
"https_port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Https port for ingress controller daemonset"
},
"network_mode": {
"type": "string",
"description": "NetworkMode selector for ingress controller pods. Default is HostNetwork"
},
"tolerations": {
"items": {
"$ref": "#/definitions/Toleration"
},
"type": "array",
"description": "Tolerations for Deployments"
},
"default_backend": {
"type": "boolean",
"description": "Enable or disable nginx default-http-backend"
},
"default_http_backend_priority_class_name": {
"type": "string",
"description": "Priority class name for Nginx-Ingress's \"default-http-backend\" deployment"
},
"nginx_ingress_controller_priority_class_name": {
"type": "string",
"description": "Priority class name for Nginx-Ingress's \"nginx-ingress-controller\" daemonset"
}
},
"additionalProperties": false,
"type": "object"
},
"IntOrString": {
"required": [
"Type",
"IntVal",
"StrVal"
],
"properties": {
"Type": {
"type": "integer"
},
"IntVal": {
"type": "integer"
},
"StrVal": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"KMSConfiguration": {
"required": [
"Name",
"CacheSize",
"Endpoint",
"Timeout"
],
"properties": {
"Name": {
"type": "string"
},
"CacheSize": {
"type": "integer"
},
"Endpoint": {
"type": "string"
},
"Timeout": {
"$ref": "#/definitions/Duration"
}
},
"additionalProperties": false,
"type": "object"
},
"Key": {
"required": [
"Name",
"Secret"
],
"properties": {
"Name": {
"type": "string"
},
"Secret": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"KeyToPath": {
"required": [
"Key",
"Path",
"Mode"
],
"properties": {
"Key": {
"type": "string"
},
"Path": {
"type": "string"
},
"Mode": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"KubeAPIService": {
"properties": {
"image": {
"type": "string"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"win_extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"service_cluster_ip_range": {
"type": "string",
"description": "Virtual IP range that will be used by Kubernetes services"
},
"service_node_port_range": {
"type": "string",
"description": "Port range for services defined with NodePort type"
},
"pod_security_policy": {
"type": "boolean",
"description": "Enabled/Disable PodSecurityPolicy"
},
"always_pull_images": {
"type": "boolean",
"description": "Enable/Disable AlwaysPullImages admissions plugin"
},
"secrets_encryption_config": {
"$ref": "#/definitions/SecretsEncryptionConfig",
"description": "Secrets encryption provider config"
},
"audit_log": {
"$ref": "#/definitions/AuditLog",
"description": "Audit Log Configuration"
},
"admission_configuration": {
"$ref": "#/definitions/AdmissionConfiguration",
"description": "AdmissionConfiguration"
},
"event_rate_limit": {
"$ref": "#/definitions/EventRateLimit",
"description": "Event Rate Limit configuration"
}
},
"additionalProperties": false,
"type": "object"
},
"KubeControllerService": {
"properties": {
"image": {
"type": "string"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"win_extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"cluster_cidr": {
"type": "string",
"description": "CIDR Range for Pods in cluster"
},
"service_cluster_ip_range": {
"type": "string",
"description": "Virtual IP range that will be used by Kubernetes services"
}
},
"additionalProperties": false,
"type": "object"
},
"KubeletService": {
"properties": {
"image": {
"type": "string"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"win_extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"cluster_domain": {
"type": "string",
"description": "Domain of the cluster (default: \"cluster.local\")"
},
"infra_container_image": {
"type": "string",
"description": "The image whose network/ipc namespaces containers in each pod will use"
},
"cluster_dns_server": {
"type": "string",
"description": "Cluster DNS service ip"
},
"fail_swap_on": {
"type": "boolean",
"description": "Fail if swap is enabled"
},
"generate_serving_certificate": {
"type": "boolean",
"description": "Generate per node kubelet serving certificates created using kube-ca"
}
},
"additionalProperties": false,
"type": "object"
},
"KubeproxyService": {
"properties": {
"image": {
"type": "string"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"win_extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_env": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"LabelSelector": {
"required": [
"MatchLabels",
"MatchExpressions"
],
"properties": {
"MatchLabels": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"MatchExpressions": {
"items": {
"$ref": "#/definitions/LabelSelectorRequirement"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"LabelSelectorRequirement": {
"required": [
"Key",
"Operator",
"Values"
],
"properties": {
"Key": {
"type": "string"
},
"Operator": {
"type": "string"
},
"Values": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"Limit": {
"required": [
"Type",
"QPS",
"Burst",
"CacheSize"
],
"properties": {
"Type": {
"type": "string"
},
"QPS": {
"type": "integer"
},
"Burst": {
"type": "integer"
},
"CacheSize": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"LinearAutoscalerParams": {
"required": [
"min",
"max"
],
"properties": {
"cores_per_replica": {
"type": "number"
},
"nodes_per_replica": {
"type": "number"
},
"min": {
"type": "integer"
},
"max": {
"type": "integer"
},
"prevent_single_point_failure": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"LoadBalancerOpenstackOpts": {
"required": [
"lb-version",
"use-octavia",
"subnet-id",
"floating-network-id",
"lb-method",
"lb-provider",
"create-monitor",
"monitor-delay",
"monitor-timeout",
"monitor-max-retries",
"manage-security-groups"
],
"properties": {
"lb-version": {
"type": "string",
"description": "overrides autodetection. Only support v2."
},
"use-octavia": {
"type": "boolean",
"description": "uses Octavia V2 service catalog endpoint"
},
"subnet-id": {
"type": "string",
"description": "overrides autodetection."
},
"floating-network-id": {
"type": "string",
"description": "If specified, will create floating ip for loadbalancer, or do not create floating ip."
},
"lb-method": {
"type": "string",
"description": "default to ROUND_ROBIN."
},
"lb-provider": {
"type": "string"
},
"create-monitor": {
"type": "boolean"
},
"monitor-delay": {
"type": "string"
},
"monitor-timeout": {
"type": "string"
},
"monitor-max-retries": {
"type": "integer"
},
"manage-security-groups": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"LocalObjectReference": {
"required": [
"Name"
],
"properties": {
"Name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"ManagedFieldsEntry": {
"required": [
"Manager",
"Operation",
"APIVersion",
"Time",
"FieldsType",
"FieldsV1"
],
"properties": {
"Manager": {
"type": "string"
},
"Operation": {
"type": "string"
},
"APIVersion": {
"type": "string"
},
"Time": {
"type": "string",
"format": "date-time"
},
"FieldsType": {
"type": "string"
},
"FieldsV1": {
"$ref": "#/definitions/FieldsV1"
}
},
"additionalProperties": false,
"type": "object"
},
"MetadataOpenstackOpts": {
"required": [
"search-order",
"request-timeout"
],
"properties": {
"search-order": {
"type": "string"
},
"request-timeout": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"MonitoringConfig": {
"required": [
"replicas"
],
"properties": {
"provider": {
"type": "string",
"description": "Monitoring server provider"
},
"options": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "These options are NOT for configuring the Metrics-Server's addon template.\nThey are used to pass command args to the metric-server's deployment containers specifically."
},
"node_selector": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "NodeSelector key pair"
},
"update_strategy": {
"$ref": "#/definitions/DeploymentStrategy",
"description": "Update strategy"
},
"replicas": {
"type": "integer",
"description": "Number of monitoring addon pods"
},
"tolerations": {
"items": {
"$ref": "#/definitions/Toleration"
},
"type": "array",
"description": "Tolerations for Deployments"
},
"metrics_server_priority_class_name": {
"type": "string",
"description": "Priority class name for Metrics-Server's \"metrics-server\" deployment"
}
},
"additionalProperties": false,
"type": "object"
},
"NFSVolumeSource": {
"required": [
"Server",
"Path",
"ReadOnly"
],
"properties": {
"Server": {
"type": "string"
},
"Path": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"NetworkConfig": {
"properties": {
"plugin": {
"type": "string",
"description": "Network Plugin That will be used in kubernetes cluster"
},
"options": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "Plugin options to configure network properties"
},
"mtu": {
"type": "integer",
"description": "Set MTU for CNI provider"
},
"calico_network_provider": {
"$ref": "#/definitions/CalicoNetworkProvider",
"description": "CalicoNetworkProvider"
},
"canal_network_provider": {
"$ref": "#/definitions/CanalNetworkProvider",
"description": "CanalNetworkProvider"
},
"flannel_network_provider": {
"$ref": "#/definitions/FlannelNetworkProvider",
"description": "FlannelNetworkProvider"
},
"weave_network_provider": {
"$ref": "#/definitions/WeaveNetworkProvider",
"description": "WeaveNetworkProvider"
},
"aci_network_provider": {
"$ref": "#/definitions/AciNetworkProvider",
"description": "AciNetworkProvider"
},
"node_selector": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "NodeSelector key pair"
},
"update_strategy": {
"$ref": "#/definitions/DaemonSetUpdateStrategy",
"description": "Network plugin daemonset upgrade strategy"
},
"tolerations": {
"items": {
"$ref": "#/definitions/Toleration"
},
"type": "array",
"description": "Tolerations for Deployments"
}
},
"additionalProperties": false,
"type": "object"
},
"NetworkVshpereOpts": {
"properties": {
"public-network": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"NodeDrainInput": {
"required": [
"timeout"
],
"properties": {
"force": {
"type": "boolean",
"description": "Drain node even if there are pods not managed by a ReplicationController, Job, or DaemonSet\nDrain will not proceed without Force set to true if there are such pods"
},
"ignore_daemonsets": {
"type": "boolean",
"description": "If there are DaemonSet-managed pods, drain will not proceed without IgnoreDaemonSets set to true\n(even when set to true, kubectl won't delete pods - so setting default to true)"
},
"delete_local_data": {
"type": "boolean",
"description": "Continue even if there are pods using emptyDir"
},
"grace_period": {
"type": "integer",
"description": "Period of time in seconds given to each pod to terminate gracefully.\nIf negative, the default value specified in the pod will be used"
},
"timeout": {
"type": "integer",
"description": "Time to wait (in seconds) before giving up for one try"
}
},
"additionalProperties": false,
"type": "object"
},
"NodeUpgradeStrategy": {
"properties": {
"max_unavailable_worker": {
"type": "string",
"description": "MaxUnavailableWorker input can be a number of nodes or a percentage of nodes (example, max_unavailable_worker: 2 OR max_unavailable_worker: 20%)"
},
"max_unavailable_controlplane": {
"type": "string",
"description": "MaxUnavailableControlplane input can be a number of nodes or a percentage of nodes"
},
"drain": {
"type": "boolean"
},
"node_drain_input": {
"$ref": "#/definitions/NodeDrainInput"
}
},
"additionalProperties": false,
"type": "object"
},
"Nodelocal": {
"properties": {
"ip_address": {
"type": "string",
"description": "link-local IP for nodelocal DNS"
},
"update_strategy": {
"$ref": "#/definitions/DaemonSetUpdateStrategy",
"description": "Nodelocal DNS daemonset upgrade strategy"
},
"node_selector": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "NodeSelector key pair"
},
"node_local_dns_priority_class_name": {
"type": "string",
"description": "Priority class name for NodeLocal's \"node-local-dns\" daemonset"
}
},
"additionalProperties": false,
"type": "object"
},
"ObjectFieldSelector": {
"required": [
"APIVersion",
"FieldPath"
],
"properties": {
"APIVersion": {
"type": "string"
},
"FieldPath": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"OpenstackCloudProvider": {
"required": [
"global",
"load_balancer",
"block_storage",
"route",
"metadata"
],
"properties": {
"global": {
"$ref": "#/definitions/GlobalOpenstackOpts"
},
"load_balancer": {
"$ref": "#/definitions/LoadBalancerOpenstackOpts"
},
"block_storage": {
"$ref": "#/definitions/BlockStorageOpenstackOpts"
},
"route": {
"$ref": "#/definitions/RouteOpenstackOpts"
},
"metadata": {
"$ref": "#/definitions/MetadataOpenstackOpts"
}
},
"additionalProperties": false,
"type": "object"
},
"OwnerReference": {
"required": [
"APIVersion",
"Kind",
"Name",
"UID",
"Controller",
"BlockOwnerDeletion"
],
"properties": {
"APIVersion": {
"type": "string"
},
"Kind": {
"type": "string"
},
"Name": {
"type": "string"
},
"UID": {
"type": "string"
},
"Controller": {
"type": "boolean"
},
"BlockOwnerDeletion": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"PersistentVolumeClaimSpec": {
"required": [
"AccessModes",
"Selector",
"Resources",
"VolumeName",
"StorageClassName",
"VolumeMode",
"DataSource"
],
"properties": {
"AccessModes": {
"items": {
"type": "string"
},
"type": "array"
},
"Selector": {
"$ref": "#/definitions/LabelSelector"
},
"Resources": {
"$ref": "#/definitions/ResourceRequirements"
},
"VolumeName": {
"type": "string"
},
"StorageClassName": {
"type": "string"
},
"VolumeMode": {
"type": "string"
},
"DataSource": {
"$ref": "#/definitions/TypedLocalObjectReference"
}
},
"additionalProperties": false,
"type": "object"
},
"PersistentVolumeClaimTemplate": {
"required": [
"Name",
"GenerateName",
"Namespace",
"SelfLink",
"UID",
"ResourceVersion",
"Generation",
"CreationTimestamp",
"DeletionTimestamp",
"DeletionGracePeriodSeconds",
"Labels",
"Annotations",
"OwnerReferences",
"Finalizers",
"ClusterName",
"ManagedFields",
"Spec"
],
"properties": {
"Name": {
"type": "string"
},
"GenerateName": {
"type": "string"
},
"Namespace": {
"type": "string"
},
"SelfLink": {
"type": "string"
},
"UID": {
"type": "string"
},
"ResourceVersion": {
"type": "string"
},
"Generation": {
"type": "integer"
},
"CreationTimestamp": {
"$ref": "#/definitions/Time"
},
"DeletionTimestamp": {
"type": "string",
"format": "date-time"
},
"DeletionGracePeriodSeconds": {
"type": "integer"
},
"Labels": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"Annotations": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"OwnerReferences": {
"items": {
"$ref": "#/definitions/OwnerReference"
},
"type": "array"
},
"Finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"ClusterName": {
"type": "string"
},
"ManagedFields": {
"items": {
"$ref": "#/definitions/ManagedFieldsEntry"
},
"type": "array"
},
"Spec": {
"$ref": "#/definitions/PersistentVolumeClaimSpec"
}
},
"additionalProperties": false,
"type": "object"
},
"PersistentVolumeClaimVolumeSource": {
"required": [
"ClaimName",
"ReadOnly"
],
"properties": {
"ClaimName": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"PhotonPersistentDiskVolumeSource": {
"required": [
"PdID",
"FSType"
],
"properties": {
"PdID": {
"type": "string"
},
"FSType": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"Policy": {
"required": [
"Kind",
"APIVersion",
"Name",
"GenerateName",
"Namespace",
"SelfLink",
"UID",
"ResourceVersion",
"Generation",
"CreationTimestamp",
"DeletionTimestamp",
"DeletionGracePeriodSeconds",
"Labels",
"Annotations",
"OwnerReferences",
"Finalizers",
"ClusterName",
"ManagedFields",
"Rules",
"OmitStages"
],
"properties": {
"Kind": {
"type": "string"
},
"APIVersion": {
"type": "string"
},
"Name": {
"type": "string"
},
"GenerateName": {
"type": "string"
},
"Namespace": {
"type": "string"
},
"SelfLink": {
"type": "string"
},
"UID": {
"type": "string"
},
"ResourceVersion": {
"type": "string"
},
"Generation": {
"type": "integer"
},
"CreationTimestamp": {
"$ref": "#/definitions/Time"
},
"DeletionTimestamp": {
"type": "string",
"format": "date-time"
},
"DeletionGracePeriodSeconds": {
"type": "integer"
},
"Labels": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"Annotations": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"OwnerReferences": {
"items": {
"$ref": "#/definitions/OwnerReference"
},
"type": "array"
},
"Finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"ClusterName": {
"type": "string"
},
"ManagedFields": {
"items": {
"$ref": "#/definitions/ManagedFieldsEntry"
},
"type": "array"
},
"Rules": {
"items": {
"$ref": "#/definitions/PolicyRule"
},
"type": "array"
},
"OmitStages": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"PolicyRule": {
"required": [
"Level",
"Users",
"UserGroups",
"Verbs",
"Resources",
"Namespaces",
"NonResourceURLs",
"OmitStages"
],
"properties": {
"Level": {
"type": "string"
},
"Users": {
"items": {
"type": "string"
},
"type": "array"
},
"UserGroups": {
"items": {
"type": "string"
},
"type": "array"
},
"Verbs": {
"items": {
"type": "string"
},
"type": "array"
},
"Resources": {
"items": {
"$ref": "#/definitions/GroupResources"
},
"type": "array"
},
"Namespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"NonResourceURLs": {
"items": {
"type": "string"
},
"type": "array"
},
"OmitStages": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"PortworxVolumeSource": {
"required": [
"VolumeID",
"FSType",
"ReadOnly"
],
"properties": {
"VolumeID": {
"type": "string"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"PrivateRegistry": {
"properties": {
"url": {
"type": "string",
"description": "URL for the registry"
},
"user": {
"type": "string",
"description": "User name for registry acces"
},
"password": {
"type": "string",
"description": "Password for registry access"
},
"is_default": {
"type": "boolean",
"description": "Default registry"
},
"ecr_credential_plugin": {
"$ref": "#/definitions/ECRCredentialPlugin",
"description": "ECRCredentialPlugin"
}
},
"additionalProperties": false,
"type": "object"
},
"ProjectedVolumeSource": {
"required": [
"Sources",
"DefaultMode"
],
"properties": {
"Sources": {
"items": {
"$ref": "#/definitions/VolumeProjection"
},
"type": "array"
},
"DefaultMode": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"ProviderConfiguration": {
"required": [
"AESGCM",
"AESCBC",
"Secretbox",
"Identity",
"KMS"
],
"properties": {
"AESGCM": {
"$ref": "#/definitions/AESConfiguration"
},
"AESCBC": {
"$ref": "#/definitions/AESConfiguration"
},
"Secretbox": {
"$ref": "#/definitions/SecretboxConfiguration"
},
"Identity": {
"$ref": "#/definitions/IdentityConfiguration"
},
"KMS": {
"$ref": "#/definitions/KMSConfiguration"
}
},
"additionalProperties": false,
"type": "object"
},
"Quantity": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"QuobyteVolumeSource": {
"required": [
"Registry",
"Volume",
"ReadOnly",
"User",
"Group",
"Tenant"
],
"properties": {
"Registry": {
"type": "string"
},
"Volume": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"User": {
"type": "string"
},
"Group": {
"type": "string"
},
"Tenant": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"RBDVolumeSource": {
"required": [
"CephMonitors",
"RBDImage",
"FSType",
"RBDPool",
"RadosUser",
"Keyring",
"SecretRef",
"ReadOnly"
],
"properties": {
"CephMonitors": {
"items": {
"type": "string"
},
"type": "array"
},
"RBDImage": {
"type": "string"
},
"FSType": {
"type": "string"
},
"RBDPool": {
"type": "string"
},
"RadosUser": {
"type": "string"
},
"Keyring": {
"type": "string"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"RKEConfigNode": {
"properties": {
"nodeName": {
"type": "string",
"description": "Name of the host provisioned via docker machine"
},
"address": {
"type": "string",
"description": "IP or FQDN that is fully resolvable and used for SSH communication"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Port used for SSH communication"
},
"internal_address": {
"type": "string",
"description": "Optional - Internal address that will be used for components communication"
},
"role": {
"items": {
"type": "string"
},
"type": "array",
"description": "Node role in kubernetes cluster (controlplane, worker, or etcd)"
},
"hostname_override": {
"type": "string",
"description": "Optional - Hostname of the node"
},
"user": {
"type": "string",
"description": "SSH usesr that will be used by RKE"
},
"docker_socket": {
"type": "string",
"description": "Optional - Docker socket on the node that will be used in tunneling"
},
"ssh_agent_auth": {
"type": "boolean",
"description": "SSH Agent Auth enable"
},
"ssh_key": {
"type": "string",
"description": "SSH Private Key"
},
"ssh_key_path": {
"type": "string",
"description": "SSH Private Key Path"
},
"ssh_cert": {
"type": "string",
"description": "SSH Certificate"
},
"ssh_cert_path": {
"type": "string",
"description": "SSH Certificate Path"
},
"labels": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object",
"description": "Node Labels"
},
"taints": {
"items": {
"$ref": "#/definitions/RKETaint"
},
"type": "array",
"description": "Node Taints"
}
},
"additionalProperties": false,
"type": "object"
},
"RKEConfigServices": {
"properties": {
"etcd": {
"$ref": "#/definitions/ETCDService",
"description": "Etcd Service"
},
"kube-api": {
"$ref": "#/definitions/KubeAPIService",
"description": "KubeAPI Service"
},
"kube-controller": {
"$ref": "#/definitions/KubeControllerService",
"description": "KubeController Service"
},
"scheduler": {
"$ref": "#/definitions/SchedulerService",
"description": "Scheduler Service"
},
"kubelet": {
"$ref": "#/definitions/KubeletService",
"description": "Kubelet Service"
},
"kubeproxy": {
"$ref": "#/definitions/KubeproxyService",
"description": "KubeProxy Service"
}
},
"additionalProperties": false,
"type": "object"
},
"RKESystemImages": {
"properties": {
"etcd": {
"type": "string",
"description": "etcd image"
},
"alpine": {
"type": "string",
"description": "Alpine image"
},
"nginx_proxy": {
"type": "string",
"description": "rke-nginx-proxy image"
},
"cert_downloader": {
"type": "string",
"description": "rke-cert-deployer image"
},
"kubernetes_services_sidecar": {
"type": "string",
"description": "rke-service-sidekick image"
},
"kubedns": {
"type": "string",
"description": "KubeDNS image"
},
"dnsmasq": {
"type": "string",
"description": "DNSMasq image"
},
"kubedns_sidecar": {
"type": "string",
"description": "KubeDNS side car image"
},
"kubedns_autoscaler": {
"type": "string",
"description": "KubeDNS autoscaler image"
},
"coredns": {
"type": "string",
"description": "CoreDNS image"
},
"coredns_autoscaler": {
"type": "string",
"description": "CoreDNS autoscaler image"
},
"nodelocal": {
"type": "string",
"description": "Nodelocal image"
},
"kubernetes": {
"type": "string",
"description": "Kubernetes image"
},
"flannel": {
"type": "string",
"description": "Flannel image"
},
"flannel_cni": {
"type": "string",
"description": "Flannel CNI image"
},
"calico_node": {
"type": "string",
"description": "Calico Node image"
},
"calico_cni": {
"type": "string",
"description": "Calico CNI image"
},
"calico_controllers": {
"type": "string",
"description": "Calico Controllers image"
},
"calico_ctl": {
"type": "string",
"description": "Calicoctl image"
},
"calico_flexvol": {
"type": "string",
"description": "CalicoFlexVol image"
},
"canal_node": {
"type": "string",
"description": "Canal Node Image"
},
"canal_cni": {
"type": "string",
"description": "Canal CNI image"
},
"canal_controllers": {
"type": "string",
"description": "Canal Controllers Image needed for Calico/Canal v3.14.0+"
},
"canal_flannel": {
"type": "string",
"description": "CanalFlannel image"
},
"canal_flexvol": {
"type": "string",
"description": "CanalFlexVol image"
},
"weave_node": {
"type": "string",
"description": "Weave Node image"
},
"weave_cni": {
"type": "string",
"description": "Weave CNI image"
},
"pod_infra_container": {
"type": "string",
"description": "Pod infra container image"
},
"ingress": {
"type": "string",
"description": "Ingress Controller image"
},
"ingress_backend": {
"type": "string",
"description": "Ingress Controller Backend image"
},
"ingress_webhook": {
"type": "string",
"description": "Ingress Webhook image"
},
"metrics_server": {
"type": "string",
"description": "Metrics Server image"
},
"windows_pod_infra_container": {
"type": "string",
"description": "Pod infra container image for Windows"
},
"aci_cni_deploy_container": {
"type": "string",
"description": "Cni deployer container image for Cisco ACI"
},
"aci_host_container": {
"type": "string",
"description": "host container image for Cisco ACI"
},
"aci_opflex_container": {
"type": "string",
"description": "opflex agent container image for Cisco ACI"
},
"aci_mcast_container": {
"type": "string",
"description": "mcast daemon container image for Cisco ACI"
},
"aci_ovs_container": {
"type": "string",
"description": "OpenvSwitch container image for Cisco ACI"
},
"aci_controller_container": {
"type": "string",
"description": "Controller container image for Cisco ACI"
},
"aci_gbp_server_container": {
"type": "string",
"description": "GBP Server container image for Cisco ACI"
},
"aci_opflex_server_container": {
"type": "string",
"description": "Opflex Server container image for Cisco ACI"
}
},
"additionalProperties": false,
"type": "object"
},
"RKETaint": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"effect": {
"type": "string"
},
"timeAdded": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"type": "object"
},
"RancherKubernetesEngineConfig": {
"properties": {
"nodes": {
"items": {
"$ref": "#/definitions/RKEConfigNode"
},
"type": "array",
"description": "Kubernetes nodes"
},
"services": {
"$ref": "#/definitions/RKEConfigServices",
"description": "Kubernetes components"
},
"network": {
"$ref": "#/definitions/NetworkConfig",
"description": "Network configuration used in the kubernetes cluster (flannel, calico)"
},
"authentication": {
"$ref": "#/definitions/AuthnConfig",
"description": "Authentication configuration used in the cluster (default: x509)"
},
"addons": {
"type": "string",
"description": "YAML manifest for user provided addons to be deployed on the cluster"
},
"addons_include": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of urls or paths for addons"
},
"system_images": {
"$ref": "#/definitions/RKESystemImages",
"description": "List of images used internally for proxy, cert download and kubedns"
},
"ssh_key_path": {
"type": "string",
"description": "SSH Private Key Path"
},
"ssh_cert_path": {
"type": "string",
"description": "SSH Certificate Path"
},
"ssh_agent_auth": {
"type": "boolean",
"description": "SSH Agent Auth enable"
},
"authorization": {
"$ref": "#/definitions/AuthzConfig",
"description": "Authorization mode configuration used in the cluster"
},
"ignore_docker_version": {
"type": "boolean",
"description": "Enable/disable strict docker version checking"
},
"enable_cri_dockerd": {
"type": "boolean",
"description": "Enable/disable using cri-dockerd"
},
"kubernetes_version": {
"type": "string",
"description": "Kubernetes version to use (if kubernetes image is specified, image version takes precedence)"
},
"private_registries": {
"items": {
"$ref": "#/definitions/PrivateRegistry"
},
"type": "array",
"description": "List of private registries and their credentials"
},
"ingress": {
"$ref": "#/definitions/IngressConfig",
"description": "Ingress controller used in the cluster"
},
"cluster_name": {
"type": "string",
"description": "Cluster Name used in the kube config"
},
"cloud_provider": {
"$ref": "#/definitions/CloudProvider",
"description": "Cloud Provider options"
},
"prefix_path": {
"type": "string",
"description": "kubernetes directory path"
},
"win_prefix_path": {
"type": "string",
"description": "kubernetes directory path for windows"
},
"addon_job_timeout": {
"type": "integer",
"description": "Timeout in seconds for status check on addon deployment jobs"
},
"bastion_host": {
"$ref": "#/definitions/BastionHost",
"description": "Bastion/Jump Host configuration"
},
"monitoring": {
"$ref": "#/definitions/MonitoringConfig",
"description": "Monitoring Config"
},
"restore": {
"$ref": "#/definitions/RestoreConfig",
"description": "RestoreCluster flag"
},
"rotate_certificates": {
"$ref": "#/definitions/RotateCertificates",
"description": "Rotating Certificates Option"
},
"rotate_encryption_key": {
"type": "boolean",
"description": "Rotate Encryption Key Option"
},
"dns": {
"$ref": "#/definitions/DNSConfig",
"description": "DNS Config"
},
"upgrade_strategy": {
"$ref": "#/definitions/NodeUpgradeStrategy",
"description": "Upgrade Strategy for the cluster"
}
},
"additionalProperties": false,
"type": "object"
},
"ResourceConfiguration": {
"required": [
"Resources",
"Providers"
],
"properties": {
"Resources": {
"items": {
"type": "string"
},
"type": "array"
},
"Providers": {
"items": {
"$ref": "#/definitions/ProviderConfiguration"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"ResourceFieldSelector": {
"required": [
"ContainerName",
"Resource",
"Divisor"
],
"properties": {
"ContainerName": {
"type": "string"
},
"Resource": {
"type": "string"
},
"Divisor": {
"$ref": "#/definitions/Quantity"
}
},
"additionalProperties": false,
"type": "object"
},
"ResourceRequirements": {
"required": [
"Limits",
"Requests"
],
"properties": {
"Limits": {
"patternProperties": {
".*": {
"$ref": "#/definitions/Quantity"
}
},
"type": "object"
},
"Requests": {
"patternProperties": {
".*": {
"$ref": "#/definitions/Quantity"
}
},
"type": "object"
}
},
"additionalProperties": false,
"type": "object"
},
"RestoreConfig": {
"properties": {
"restore": {
"type": "boolean"
},
"snapshot_name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"RollingUpdateDaemonSet": {
"required": [
"MaxUnavailable",
"MaxSurge"
],
"properties": {
"MaxUnavailable": {
"$ref": "#/definitions/IntOrString"
},
"MaxSurge": {
"$ref": "#/definitions/IntOrString"
}
},
"additionalProperties": false,
"type": "object"
},
"RollingUpdateDeployment": {
"required": [
"MaxUnavailable",
"MaxSurge"
],
"properties": {
"MaxUnavailable": {
"$ref": "#/definitions/IntOrString"
},
"MaxSurge": {
"$ref": "#/definitions/IntOrString"
}
},
"additionalProperties": false,
"type": "object"
},
"RotateCertificates": {
"required": [
"CACertificates",
"Services"
],
"properties": {
"CACertificates": {
"type": "boolean",
"description": "Rotate CA Certificates"
},
"Services": {
"items": {
"type": "string"
},
"type": "array",
"description": "Services to rotate their certs"
}
},
"additionalProperties": false,
"type": "object"
},
"RouteOpenstackOpts": {
"required": [
"router-id"
],
"properties": {
"router-id": {
"type": "string",
"description": "required"
}
},
"additionalProperties": false,
"type": "object"
},
"S3BackupConfig": {
"required": [
"access_key",
"secret_key",
"bucket_name",
"region",
"endpoint",
"custom_ca",
"folder"
],
"properties": {
"access_key": {
"type": "string"
},
"secret_key": {
"type": "string"
},
"bucket_name": {
"type": "string"
},
"region": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"custom_ca": {
"type": "string"
},
"folder": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"ScaleIOVolumeSource": {
"required": [
"Gateway",
"System",
"SecretRef",
"SSLEnabled",
"ProtectionDomain",
"StoragePool",
"StorageMode",
"VolumeName",
"FSType",
"ReadOnly"
],
"properties": {
"Gateway": {
"type": "string"
},
"System": {
"type": "string"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
},
"SSLEnabled": {
"type": "boolean"
},
"ProtectionDomain": {
"type": "string"
},
"StoragePool": {
"type": "string"
},
"StorageMode": {
"type": "string"
},
"VolumeName": {
"type": "string"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"SchedulerService": {
"properties": {
"image": {
"type": "string"
},
"extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"extra_env": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_args": {
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"win_extra_binds": {
"items": {
"type": "string"
},
"type": "array"
},
"win_extra_env": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"SecretKeySelector": {
"required": [
"Name",
"Key",
"Optional"
],
"properties": {
"Name": {
"type": "string"
},
"Key": {
"type": "string"
},
"Optional": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"SecretProjection": {
"required": [
"Name",
"Items",
"Optional"
],
"properties": {
"Name": {
"type": "string"
},
"Items": {
"items": {
"$ref": "#/definitions/KeyToPath"
},
"type": "array"
},
"Optional": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"SecretVolumeSource": {
"required": [
"SecretName",
"Items",
"DefaultMode",
"Optional"
],
"properties": {
"SecretName": {
"type": "string"
},
"Items": {
"items": {
"$ref": "#/definitions/KeyToPath"
},
"type": "array"
},
"DefaultMode": {
"type": "integer"
},
"Optional": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
},
"SecretboxConfiguration": {
"required": [
"Keys"
],
"properties": {
"Keys": {
"items": {
"$ref": "#/definitions/Key"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"SecretsEncryptionConfig": {
"required": [
"custom_config"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/disable secrets encryption provider config"
},
"custom_config": {
"$ref": "#/definitions/EncryptionConfiguration",
"description": "Custom Encryption Provider configuration object"
}
},
"additionalProperties": false,
"type": "object"
},
"ServiceAccountTokenProjection": {
"required": [
"Audience",
"ExpirationSeconds",
"Path"
],
"properties": {
"Audience": {
"type": "string"
},
"ExpirationSeconds": {
"type": "integer"
},
"Path": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"ServiceOverride": {
"required": [
"service",
"region",
"url",
"signing-region",
"signing-method",
"signing-name"
],
"properties": {
"service": {
"type": "string"
},
"region": {
"type": "string"
},
"url": {
"type": "string"
},
"signing-region": {
"type": "string"
},
"signing-method": {
"type": "string"
},
"signing-name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"StorageOSVolumeSource": {
"required": [
"VolumeName",
"VolumeNamespace",
"FSType",
"ReadOnly",
"SecretRef"
],
"properties": {
"VolumeName": {
"type": "string"
},
"VolumeNamespace": {
"type": "string"
},
"FSType": {
"type": "string"
},
"ReadOnly": {
"type": "boolean"
},
"SecretRef": {
"$ref": "#/definitions/LocalObjectReference"
}
},
"additionalProperties": false,
"type": "object"
},
"Time": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"Toleration": {
"required": [
"Key",
"Operator",
"Value",
"Effect",
"TolerationSeconds"
],
"properties": {
"Key": {
"type": "string"
},
"Operator": {
"type": "string"
},
"Value": {
"type": "string"
},
"Effect": {
"type": "string"
},
"TolerationSeconds": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"TypedLocalObjectReference": {
"required": [
"APIGroup",
"Kind",
"Name"
],
"properties": {
"APIGroup": {
"type": "string"
},
"Kind": {
"type": "string"
},
"Name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"Unknown": {
"required": [
"Raw",
"ContentEncoding",
"ContentType"
],
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"Raw": {
"type": "string"
},
"ContentEncoding": {
"type": "string"
},
"ContentType": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"VirtualCenterConfig": {
"properties": {
"user": {
"type": "string"
},
"password": {
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"datacenters": {
"type": "string"
},
"soap-roundtrip-count": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object"
},
"VolumeProjection": {
"required": [
"Secret",
"DownwardAPI",
"ConfigMap",
"ServiceAccountToken"
],
"properties": {
"Secret": {
"$ref": "#/definitions/SecretProjection"
},
"DownwardAPI": {
"$ref": "#/definitions/DownwardAPIProjection"
},
"ConfigMap": {
"$ref": "#/definitions/ConfigMapProjection"
},
"ServiceAccountToken": {
"$ref": "#/definitions/ServiceAccountTokenProjection"
}
},
"additionalProperties": false,
"type": "object"
},
"VsphereCloudProvider": {
"properties": {
"global": {
"$ref": "#/definitions/GlobalVsphereOpts"
},
"virtual_center": {
"patternProperties": {
".*": {
"$ref": "#/definitions/VirtualCenterConfig"
}
},
"type": "object"
},
"network": {
"$ref": "#/definitions/NetworkVshpereOpts"
},
"disk": {
"$ref": "#/definitions/DiskVsphereOpts"
},
"workspace": {
"$ref": "#/definitions/WorkspaceVsphereOpts"
}
},
"additionalProperties": false,
"type": "object"
},
"VsphereVirtualDiskVolumeSource": {
"required": [
"VolumePath",
"FSType",
"StoragePolicyName",
"StoragePolicyID"
],
"properties": {
"VolumePath": {
"type": "string"
},
"FSType": {
"type": "string"
},
"StoragePolicyName": {
"type": "string"
},
"StoragePolicyID": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"WeaveNetworkProvider": {
"properties": {
"password": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"WorkspaceVsphereOpts": {
"properties": {
"server": {
"type": "string"
},
"datacenter": {
"type": "string"
},
"folder": {
"type": "string"
},
"default-datastore": {
"type": "string"
},
"resourcepool-path": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
} |
cypress.schema.json | {
"title": "JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"cypressConfig": {
"properties": {
"baseUrl": {
"type": "string",
"default": null,
"description": "Url used as prefix for cy.visit() or cy.request() command’s url. Example http://localhost:3030 or https://test.my-domain.com"
},
"env": {
"type": "object",
"description": "Any values to be set as environment variables. See https://on.cypress.io/environment-variables",
"body": {}
},
"ignoreTestFiles": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
},
"description": "A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match."
},
"numTestsKeptInMemory": {
"type": "number",
"default": 50,
"description": "The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run."
},
"port": {
"type": "number",
"default": null,
"description": "Port used to host Cypress. Normally this is a randomly generated port"
},
"reporter": {
"type": "string",
"default": "spec",
"description": "The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters"
},
"reporterOptions": {
"type": "object",
"default": null,
"description": "The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options"
},
"slowTestThreshold": {
"type": "number",
"default": 10000,
"description": "Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts"
},
"testFiles": {
"type": [
"string",
"array"
],
"default": "**/*.*",
"description": "A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global"
},
"watchForFileChanges": {
"type": "boolean",
"default": true,
"description": "Whether Cypress will watch and restart tests on test file changes"
},
"defaultCommandTimeout": {
"type": "number",
"default": 4000,
"description": "Time, in milliseconds, to wait until most DOM based commands are considered timed out"
},
"execTimeout": {
"type": "number",
"default": 60000,
"description": "Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command"
},
"taskTimeout": {
"type": "number",
"default": 60000,
"description": "Time, in milliseconds, to wait for a task to finish executing during a cy.task() command"
},
"pageLoadTimeout": {
"type": "number",
"default": 60000,
"description": "Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events. Network requests are limited by the underlying operating system, and may still time out if this value is increased."
},
"requestTimeout": {
"type": "number",
"default": 5000,
"description": "Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command"
},
"responseTimeout": {
"type": "number",
"default": 30000,
"description": "Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands"
},
"fileServerFolder": {
"type": "string",
"default": "root project folder",
"description": "Path to folder where application files will attempt to be served from"
},
"fixturesFolder": {
"type": [
"string",
"boolean"
],
"default": "cypress/fixtures",
"description": "Path to folder containing fixture files (Pass false to disable)"
},
"integrationFolder": {
"type": "string",
"default": "cypress/integration",
"description": "Path to folder containing integration test files"
},
"downloadsFolder": {
"type": "string",
"default": "cypress/downloads",
"description": "Path to folder where files downloaded during a test are saved"
},
"componentFolder": {
"type": [
"string",
"boolean"
],
"default": false,
"description": "Path to folder containing component test files (Pass false to disable)"
},
"pluginsFile": {
"type": [
"string",
"boolean"
],
"default": "cypress/plugins/index.js",
"description": "Path to plugins file. (Pass false to disable)"
},
"screenshotOnRunFailure": {
"type": "boolean",
"default": true,
"description": "Whether Cypress will take a screenshot when a test fails during cypress run"
},
"screenshotsFolder": {
"type": "string",
"default": "cypress/screenshots",
"description": "Path to folder where screenshots will be saved from cy.screenshot() command or after a test fails during cypress run"
},
"supportFile": {
"type": [
"string",
"boolean"
],
"default": "cypress/support/index.js",
"description": "Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)"
},
"videosFolder": {
"type": "string",
"default": "cypress/videos",
"description": "Path to folder where videos will be saved during cypress run"
},
"trashAssetsBeforeRuns": {
"type": "boolean",
"default": true,
"description": "Whether Cypress will trash assets within the screenshotsFolder and videosFolder before tests run with cypress run"
},
"videoCompression": {
"type": [
"number",
"boolean"
],
"default": 32,
"description": "The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size)."
},
"video": {
"type": "boolean",
"default": true,
"description": "Whether Cypress will capture a video of the tests run with cypress run"
},
"videoUploadOnPasses": {
"type": "boolean",
"default": true,
"description": "Whether Cypress will process, compress, and upload videos to the Dashboard even when all tests in a spec file are passing. This only applies when recording your runs to the Dashboard. Turn this off if you’d like to only upload the spec file’s video when there are failing tests."
},
"chromeWebSecurity": {
"type": "boolean",
"default": true,
"description": "Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security"
},
"userAgent": {
"type": "string",
"default": null,
"description": "Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent"
},
"blockHosts": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
},
"default": null,
"description": "A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blockHosts"
},
"modifyObstructiveCode": {
"type": "boolean",
"default": true,
"description": "Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevent Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode"
},
"viewportHeight": {
"type": "number",
"default": 660,
"description": "Default height in pixels for the application under tests’ viewport (Override with cy.viewport() command)"
},
"viewportWidth": {
"type": "number",
"default": 1000,
"description": "Default width in pixels for the application under tests’ viewport. (Override with cy.viewport() command)"
},
"animationDistanceThreshold": {
"type": "number",
"default": 5,
"description": "The distance in pixels an element must exceed over time to be considered animating"
},
"waitForAnimations": {
"type": "boolean",
"default": true,
"description": "Whether to wait for elements to finish animating before executing commands"
},
"scrollBehavior": {
"enum": [
false,
"center",
"top",
"bottom",
"nearest"
],
"default": "top",
"description": "Viewport position to which an element should be scrolled prior to action commands. Setting `false` disables scrolling."
},
"projectId": {
"type": "string",
"default": null,
"description": "A 6 character string use to identify this project in the Cypress Dashboard. See https://on.cypress.io/dashboard-service#Identification"
},
"nodeVersion": {
"enum": [
"system",
"bundled"
],
"default": "system",
"description": "DEPRECATED: If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files."
},
"experimentalInteractiveRunEvents": {
"type": "boolean",
"default": false,
"description": "Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode."
},
"experimentalSourceRewriting": {
"type": "boolean",
"default": false,
"description": "Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm."
},
"experimentalSessionSupport": {
"type": "boolean",
"default": false,
"description": "Enable experimental session support. See https://on.cypress.io/session"
},
"experimentalFetchPolyfill": {
"type": "boolean",
"default": false,
"description": "Polyfills `window.fetch` to enable Network spying and stubbing"
},
"experimentalStudio": {
"type": "boolean",
"default": false,
"description": "Generate and save commands directly to your test suite by interacting with your app as an end user would."
},
"retries": {
"type": [
"object",
"number",
"null"
],
"default": {
"runMode": 0,
"openMode": 0
},
"description": "The number of times to retry a failing. Can be configured to apply only in runMode or openMode"
},
"includeShadowDom": {
"type": "boolean",
"default": false,
"description": "Enables including elements within the shadow DOM when using querying commands (e.g. cy.get(), cy.find()). Can be set globally in cypress.json, per-suite or per-test in the test configuration object, or programmatically with Cypress.config()"
},
"clientCertificates": {
"description": "Defines client certificates to use when sending requests to the specified URLs",
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"description": "Requests for URLs matching this minimatch pattern will use the supplied client certificate",
"type": "string"
},
"ca": {
"description": "Path(s) to CA file(s) to validate certs against, relative to project root",
"type": "array",
"items": {
"type": "string"
}
},
"certs": {
"type": "array",
"items": {
"anyOf": [
{
"description": "PEM file specific properties",
"type": "object",
"properties": {
"cert": {
"description": "Path to the certificate, relative to project root",
"type": "string"
},
"key": {
"description": "Path to the private key, relative to project root",
"type": "string"
},
"passphrase": {
"description": "(Optional) File path to a UTF-8 text file containing the passphrase for the key, relative to project root",
"type": "string"
}
},
"required": [
"cert",
"key"
]
},
{
"description": "PFX file specific properties",
"type": "object",
"properties": {
"pfx": {
"description": "Path to the certificate container, relative to project root",
"type": "string"
},
"passphrase": {
"description": "(Optional) File path to a UTF-8 text file containing the passphrase for the container, relative to project root",
"type": "string"
}
},
"required": [
"pfx"
]
}
]
}
}
},
"required": [
"url",
"certs"
]
}
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/cypressConfig"
},
{
"properties": {
"component": {
"description": "Any component runner specific overrides",
"$ref": "#/definitions/cypressConfig"
},
"e2e": {
"description": "Any e2e runner specific overrides",
"$ref": "#/definitions/cypressConfig"
}
}
}
]
}
|
tslint.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"rule": {
"type": ["boolean", "object", "array"],
"minItems": 1,
"properties": {
"severity": {
"description": "Severity level. Level \"error\" will cause exit code 2.",
"type": "string",
"enum": ["default", "error", "warning", "warn", "off", "none"],
"default": "default"
}
}
},
"rules": {
"properties": {
"align": {
"description": "Enforces vertical alignment.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"arguments",
"elements",
"members",
"parameters",
"statements"
]
},
"minItems": 1,
"maxItems": 5,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/align/definitions/options/items"
},
"maxItems": 6,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/align/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/align/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"arrow-parens": {
"description": "Requires parentheses around the parameters of arrow function definitions.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["ban-single-arg-parens"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/arrow-parens/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/arrow-parens/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/arrow-parens/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"arrow-return-shorthand": {
"description": "Suggests to convert `() => { return x; }` to `() => x`.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["multiline"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/arrow-return-shorthand/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/arrow-return-shorthand/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/arrow-return-shorthand/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"ban": {
"description": "Bans the use of specific functions or global methods.",
"definitions": {
"options": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 3
},
{
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 3
}
]
},
"message": {
"type": "string"
}
},
"required": ["name"],
"additionalProperties": false
}
]
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/ban/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/ban/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/ban/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"ban-comma-operator": {
"description": "Bans the comma operator.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"binary-expression-operand-order": {
"description": "In a binary expression, a literal should always be on the right-hand side if possible.\nFor example, prefer 'x + 1' over '1 + x'.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"class-name": {
"description": "Enforces PascalCased class and interface names.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"comment-format": {
"description": "Enforces formatting rules for single-line comments.",
"definitions": {
"options": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"check-space",
"check-lowercase",
"check-uppercase"
],
"minItems": 1,
"maxItems": 3,
"uniqueItems": true
},
{
"type": "object",
"properties": {
"ignore-words": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"ignore-pattern": {
"type": "string"
}
},
"minProperties": 1,
"maxProperties": 1
}
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/comment-format/definitions/options/items"
},
"maxItems": 5,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/comment-format/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/comment-format/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"completed-docs": {
"description": "Enforces documentation for important items be filled out.",
"definitions": {
"options": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"enum": [
"classes",
"enums",
"enum-members",
"functions",
"interfaces",
"methods",
"namespaces",
"properties",
"types",
"variables"
]
},
{
"type": "object",
"properties": {
"classes": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"enums": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"enum-members": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"functions": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"interfaces": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"methods": {
"type": "object",
"properties": {
"locations": {
"type": "string",
"enum": ["all", "instance", "static"]
},
"privacies": {
"type": "string",
"enum": ["all", "private", "protected", "public"]
}
},
"additionalProperties": false
},
"namespaces": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"properties": {
"type": "object",
"properties": {
"locations": {
"type": "string",
"enum": ["all", "instance", "static"]
},
"privacies": {
"type": "string",
"enum": ["all", "private", "protected", "public"]
}
},
"additionalProperties": false
},
"types": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
},
"variables": {
"type": "object",
"properties": {
"visibilities": {
"type": "string",
"enum": ["all", "exported", "internal"]
}
},
"additionalProperties": false
}
}
}
]
},
"minItems": 1,
"maxItems": 10,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/completed-docs/definitions/options/items"
},
"maxItems": 11,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/completed-docs/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/completed-docs/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"curly": {
"description": "Enforces braces for `if`/`for`/`do`/`while` statements.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["as-needed", "ignore-same-line"],
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/curly/definitions/options/items"
},
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/curly/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/curly/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"cyclomatic-complexity": {
"description": "Enforces a threshold of cyclomatic complexity.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "number",
"minimum": 2
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/cyclomatic-complexity/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/cyclomatic-complexity/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/cyclomatic-complexity/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"deprecation": {
"description": "Warns when deprecated APIs are used.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"encoding": {
"description": "Enforces UTF-8 file encoding.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"eofline": {
"description": "Ensures the file ends with a newline.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"file-header": {
"description": "Enforces a certain header comment for all files, matched by a regular expression.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 2
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/file-header/definitions/options/items"
},
"maxItems": 3,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/file-header/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/file-header/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"file-name-casing": {
"description": "Enforces a consistent file naming convention.",
"definitions": {
"file-name-cases": {
"type": "string",
"enum": ["camel-case", "pascal-case", "kebab-case", "snake-case"]
}
},
"type": "array",
"minItems": 2,
"items": [
{
"type": "boolean"
},
{
"oneOf": [
{
"$ref": "#/definitions/rules/properties/file-name-casing/definitions/file-name-cases"
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/rules/properties/file-name-casing/definitions/file-name-cases"
},
"minProperties": 1
}
]
}
]
},
"forin": {
"description": "Requires a `for ... in` statement to be filtered with an `if` statement.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"import-blacklist": {
"description": "Disallows importing the specified modules directly via `import` and `require`.\nInstead only sub modules may be imported from that module.",
"definitions": {
"options": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "object",
"additionalProperties": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
}
},
{
"type": "array",
"items": {
"type": "string"
},
"minLength": 1
}
]
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/import-blacklist/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/import-blacklist/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/import-blacklist/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"import-spacing": {
"description": "Ensures proper spacing between import statement keywords",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"indent": {
"description": "Enforces indentation with tabs or spaces.",
"definitions": {
"options": {
"type": "array",
"items": [
{
"type": "string",
"enum": ["tabs", "spaces"]
},
{
"type": "number",
"enum": [2, 4]
}
],
"minItems": 1,
"maxItems": 2
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/rules/properties/indent/definitions/options/items/0"
},
{
"$ref": "#/definitions/rules/properties/indent/definitions/options/items/1"
}
],
"maxItems": 3,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/indent/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/indent/definitions/options/items/0"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"jsdoc-format": {
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["check-multiline-start"]
},
"minItems": 0,
"maxItems": 1,
"uniqueItems": true
}
},
"description": "Enforces basic format rules for JSDoc comments.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/jsdoc-format/definitions/options/items"
},
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/jsdoc-format/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/jsdoc-format/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"label-position": {
"description": "Only allows labels in sensible locations.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"linebreak-style": {
"description": "Enforces a consistent linebreak style.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["LF", "CRLF"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/linebreak-style/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/linebreak-style/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/linebreak-style/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"max-classes-per-file": {
"description": "A file may not contain more than the specified number of classes",
"definitions": {
"options": {
"type": "array",
"items": [
{
"type": "number",
"minimum": 1
},
{
"type": "string",
"enum": ["exclude-class-expressions"]
}
],
"minItems": 1,
"maxItems": 2
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/rules/properties/max-classes-per-file/definitions/options/items/0"
},
{
"$ref": "#/definitions/rules/properties/max-classes-per-file/definitions/options/items/1"
}
],
"additionalItems": false,
"minItems": 2,
"maxItems": 3,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/max-classes-per-file/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/max-classes-per-file/definitions/options/items/0"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"max-file-line-count": {
"description": "Requires files to remain under a certain number of lines",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "number",
"minimum": 1
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/max-file-line-count/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/max-file-line-count/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/max-file-line-count/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"max-line-length": {
"description": "Requires lines to be under a certain max length.",
"definitions": {
"options": {
"type": "array",
"items": {
"oneOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"limit": {
"type": "number"
},
"ignore-pattern": {
"type": "string"
},
"check-strings": {
"type": "boolean"
},
"check-regex": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"minLength": 1,
"maxLength": 2
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/max-line-length/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/max-line-length/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/max-line-length/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"member-ordering": {
"description": "Enforces member ordering.",
"definitions": {
"kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"static-field",
"instance-field",
"static-method",
"instance-method",
"constructor",
"public-static-field",
"public-static-method",
"protected-static-field",
"protected-static-method",
"private-static-field",
"private-static-method",
"public-instance-field",
"protected-instance-field",
"private-instance-field",
"public-constructor",
"protected-constructor",
"private-constructor",
"public-instance-method",
"protected-instance-method",
"private-instance-method",
"public-static-accessor",
"protected-static-accessor",
"private-static-accessor",
"public-instance-accessor",
"protected-instance-accessor",
"private-instance-accessor"
]
},
"minItems": 1,
"maxItems": 15,
"uniqueItems": true
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order": {
"oneOf": [
{
"type": "string",
"enum": [
"fields-first",
"instance-sandwich",
"statics-first"
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/rules/properties/member-ordering/definitions/kinds/items"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kinds": {
"$ref": "#/definitions/rules/properties/member-ordering/definitions/kinds"
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"maxItems": 15,
"uniqueItems": true
}
]
},
"alphabetize": {
"type": "boolean"
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/member-ordering/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/member-ordering/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/member-ordering/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"newline-before-return": {
"description": "Enforces blank line before return when not the only line in the block.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"newline-per-chained-call": {
"description": "Requires that chained method calls be broken apart onto separate lines.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"new-parens": {
"description": "Requires parentheses when invoking a constructor via the `new` keyword.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-arg": {
"description": "Disallows use of `arguments.callee`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-bitwise": {
"description": "Disallows bitwise operators.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-conditional-assignment": {
"description": "Disallows any type of assignment in conditionals.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-consecutive-blank-lines": {
"description": "Disallows one or more blank lines in a row.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "number",
"minimum": 1
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-consecutive-blank-lines/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-consecutive-blank-lines/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-consecutive-blank-lines/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-console": {
"description": "Bans the use of specified `console` methods.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-console/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-console/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-console/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-construct": {
"description": "Disallows access to the constructors of `String`, `Number`, and `Boolean`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-debugger": {
"description": "Disallows `debugger` statements.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-default-export": {
"description": "Disallows default exports in ES6-style modules.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-duplicate-imports": {
"description": "Disallows multiple import statements from the same module.",
"definitions": {
"options": {
"type": "object",
"properties": {
"allow-namespace-imports": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/rules/properties/no-duplicate-imports/definitions/options"
}
],
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-duplicate-imports/definitions/options"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-duplicate-super": {
"description": "Warns if 'super()' appears twice in a constructor.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-duplicate-switch-case": {
"description": "Prevents duplicate cases in switch statements.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-duplicate-variable": {
"description": "Disallows duplicate variable declarations in the same block scope.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["check-parameters"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-duplicate-variable/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-duplicate-variable/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-duplicate-variable/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-dynamic-delete": {
"description": "Bans usage of the delete operator with computed key expressions.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-empty": {
"description": "Disallows empty blocks.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["allow-empty-catch", "allow-empty-functions"]
},
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-empty/definitions/options/items"
},
"maxItems": 3,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-empty/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-empty/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-eval": {
"description": "Disallows `eval` function invocations.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-for-in": {
"description": "Forbid for…in statements\nhttps://palantir.github.io/tslint/rules/no-for-in/",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"additionalProperties": false
}
]
},
"no-for-in-array": {
"description": "Disallows iterating over an array with a for-in loop.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-implicit-dependencies": {
"description": "Disallows importing modules that are not listed as dependency in the project's package.json.",
"definitions": {
"options": {
"type": "array",
"items": [
{
"type": "string",
"enum": ["dev", "optional"]
},
{
"type": "array"
}
],
"minItems": 0,
"maxItems": 3
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"maxItems": 3,
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-implicit-dependencies/definitions/options/items"
},
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-implicit-dependencies/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-implicit-dependencies/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-import-side-effect": {
"description": "Avoid import statements with side-effect.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ignore-module": {
"type": "string"
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-import-side-effect/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-import-side-effect/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-import-side-effect/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-invalid-template-strings": {
"description": "Warns on use of `${` in non-template strings.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-invalid-this": {
"description": "Disallows using the `this` keyword outside of classes.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["check-function-in-method"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-invalid-this/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-invalid-this/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-invalid-this/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-irregular-whitespace": {
"description": "Disallow irregular whitespace outside of strings and comments",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-magic-numbers": {
"description": "Disallows the use constant number values outside of variable assignments.\nWhen no list of allowed values is specified, -1, 0 and 1 are allowed by default.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-magic-numbers/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-magic-numbers/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-magic-numbers/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-null-undefined-union": {
"description": "Forbid explicitly declared or implicitly returned union types with both null and undefined as members\nhttps://palantir.github.io/tslint/rules/no-null-undefined-union/",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"additionalProperties": false
}
]
},
"no-null-keyword": {
"description": "Disallows use of the `null` keyword literal.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-parameter-reassignment": {
"description": "Disallows reassigning parameters.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-reference": {
"description": "Disallows `/// <reference path=>` imports (use ES6-style imports instead).",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-return-await": {
"description": "Disallows unnecessary `return await`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-require-imports": {
"description": "Disallows invocation of `require()`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-shadowed-variable": {
"description": "Disallows shadowing variable declarations.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"class": {
"type": "boolean"
},
"enum": {
"type": "boolean"
},
"function": {
"type": "boolean"
},
"import": {
"type": "boolean"
},
"interface": {
"type": "boolean"
},
"namespace": {
"type": "boolean"
},
"typeAlias": {
"type": "boolean"
},
"typeParameter": {
"type": "boolean"
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-shadowed-variable/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-shadowed-variable/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-shadowed-variable/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-sparse-arrays": {
"description": "Forbids array literals to contain missing elements.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-string-literal": {
"description": "Forbids unnecessary string literal property access.\nAllows `obj[\"prop-erty\"]` (can't be a regular property access).\nDisallows `obj[\"property\"]` (should be `obj.property`).",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-string-throw": {
"description": "Flags throwing plain strings or concatenations of strings because only Errors produce proper stack traces.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-submodule-imports": {
"description": "Disallows importing any submodule.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-submodule-imports/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-submodule-imports/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-submodule-imports/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-switch-case-fall-through": {
"description": "Disallows falling through case statements.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-this-assignment": {
"description": "Disallows unnecessary references to `this`.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allow-destructuring": {
"type": "boolean"
},
"allowed-names": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-this-assignment/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-this-assignment/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-this-assignment/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-trailing-whitespace": {
"description": "Disallows trailing whitespace at the end of a line.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ignore-comments",
"ignore-jsdoc",
"ignore-template-strings",
"ignore-blank-lines"
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-trailing-whitespace/definitions/options/items"
},
"maxItems": 5,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-trailing-whitespace/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-trailing-whitespace/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unnecessary-callback-wrapper": {
"description": "Replaces `x => f(x)` with just `f`.\nTo catch more cases, enable `only-arrow-functions` and `arrow-return-shorthand` too.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unnecessary-class": {
"description": "Disallows classes that are not strictly necessary.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"allow-constructor-only",
"allow-empty-class",
"allow-static-only"
]
},
"minLength": 0,
"maxLength": 3
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-unnecessary-class/definitions/options/items"
},
"maxItems": 4,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-unnecessary-class/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-unnecessary-class/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unnecessary-initializer": {
"description": "Forbids a 'var'/'let' statement or destructuring initializer to be initialized to 'undefined'.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unsafe-finally": {
"description": "Disallows control flow statements, such as `return`, `continue` `break` and `throws` in finally blocks.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unused-expression": {
"description": "Disallows unused expression statements.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"allow-fast-null-checks",
"allow-new",
"allow-tagged-template"
]
},
"minItems": 1,
"maxItems": 3,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-unused-expression/definitions/options/items"
},
"maxItems": 4,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-unused-expression/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-unused-expression/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-use-before-declare": {
"description": "Disallows usage of variables before their declaration.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-var-keyword": {
"description": "Disallows usage of the `var` keyword.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-void-expression": {
"description": "Requires expressions of type `void` to appear in statement position.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["ignore-arrow-function-shorthand"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/no-void-expression/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/no-void-expression/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/no-void-expression/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"number-literal-format": {
"description": "Checks that decimal literals should begin with '0.' instead of just '.', and should not end with a trailing '0'.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"object-literal-key-quotes": {
"description": "Enforces consistent object literal property quote style.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"always",
"as-needed",
"consistent",
"consistent-as-needed"
]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/object-literal-key-quotes/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/object-literal-key-quotes/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/object-literal-key-quotes/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"object-literal-shorthand": {
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["always", "never"]
},
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
},
"description": "Enforces use of ES6 object literal shorthand when possible.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/object-literal-shorthand/definitions/options/items"
},
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/object-literal-shorthand/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/object-literal-shorthand/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"object-literal-sort-keys": {
"description": "Checks ordering of keys in object literals.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ignore-case",
"locale-compare",
"match-declaration-order",
"shorthand-first"
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/object-literal-sort-keys/definitions/options/items"
},
"maxItems": 5,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/object-literal-sort-keys/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/object-literal-sort-keys/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"one-line": {
"description": "Requires the specified tokens to be on the same line as the expression preceding them.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"check-catch",
"check-finally",
"check-else",
"check-open-brace",
"check-whitespace"
]
},
"minItems": 1,
"maxItems": 5,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/one-line/definitions/options/items"
},
"maxItems": 6,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/one-line/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/one-line/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"one-variable-per-declaration": {
"description": "Disallows multiple variable definitions in the same declaration statement.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["ignore-for-loop"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/one-variable-per-declaration/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/one-variable-per-declaration/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/one-variable-per-declaration/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"only-arrow-functions": {
"description": "Disallows traditional (non-arrow) function expressions.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["allow-declarations", "allow-named-functions"]
},
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/only-arrow-functions/definitions/options/items"
},
"maxItems": 3,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/only-arrow-functions/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/only-arrow-functions/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"ordered-imports": {
"description": "Requires that import statements be alphabetized.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"grouped-imports": {
"type": "boolean"
},
"groups": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"match": {
"type": "string"
},
"order": {
"type": "number"
}
},
"required": ["match", "order"]
}
]
}
},
"import-sources-order": {
"type": "string",
"enum": [
"case-insensitive",
"case-insensitive-legacy",
"lowercase-first",
"lowercase-last",
"any"
]
},
"named-imports-order": {
"type": "string",
"enum": [
"case-insensitive",
"case-insensitive-legacy",
"lowercase-first",
"lowercase-last",
"any"
]
},
"module-source-path": {
"type": "string",
"enum": ["full", "basename"]
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/ordered-imports/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/ordered-imports/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/ordered-imports/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-conditional-expression": {
"description": "Recommends to use a conditional expression instead of assigning to the same thing in each branch of an if statement.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["check-else-if"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/prefer-conditional-expression/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/prefer-conditional-expression/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/prefer-conditional-expression/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-const": {
"description": "Requires that variable declarations use `const` instead of `let` and `var` if possible.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": ["all", "any"]
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/prefer-const/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/prefer-const/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/prefer-const/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-for-of": {
"description": "Recommends a 'for-of' loop over a standard 'for' loop if the index is only used to access the array being iterated.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-function-over-method": {
"description": "Warns for class methods that do not use 'this'.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["allow-public", "allow-protected"]
},
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/prefer-function-over-method/definitions/options/items"
},
"maxItems": 3,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/prefer-function-over-method/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/prefer-function-over-method/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-method-signature": {
"description": "Prefer `foo(): void` over `foo: () => void` in interfaces and types.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-object-spread": {
"description": "Enforces the use of the ES2015 object spread operator over `Object.assign()` where appropriate.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-switch": {
"description": "Prefer a `switch` statement to an `if` statement with simple `===` comparisons.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"min-cases": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/prefer-switch/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/prefer-switch/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/prefer-switch/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-template": {
"description": "Prefer a template expression over string literal concatenation.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["allow-single-concat"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/prefer-template/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/prefer-template/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/prefer-template/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-while": {
"description": "Prefer while loops instead of for loops without an initializer and incrementor.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"additionalProperties": false
}
]
},
"no-async-without-await": {
"description": "Force functions marked async contain an await or return statement\nhttps://palantir.github.io/tslint/rules/no-async-without-await/",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"additionalProperties": false
}
]
},
"promise-function-async": {
"description": "Requires any function or method that returns a promise to be marked async.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"quotemark": {
"description": "Requires single or double quotes for string literals.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"single",
"double",
"jsx-single",
"jsx-double",
"avoid-escape",
"avoid-template"
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/quotemark/definitions/options/items"
},
"maxItems": 5,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/quotemark/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/quotemark/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"radix": {
"description": "Requires the radix parameter to be specified when calling `parseInt`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"restrict-plus-operands": {
"description": "When adding two variables, operands must both be of type number or of type string.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"return-undefined": {
"description": "Prefer `return;` in void functions and `return undefined;` in value-returning functions.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"semicolon": {
"description": "Enforces consistent semicolon usage at the end of every statement.",
"definitions": {
"options": {
"type": "array",
"items": [
{
"type": "string",
"enum": ["always", "never"]
},
{
"type": "string",
"enum": [
"ignore-interfaces",
"ignore-bound-class-methods",
"strict-bound-class-methods"
]
}
],
"minItems": 1,
"maxItems": 3
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/rules/properties/semicolon/definitions/options/items/0"
},
{
"$ref": "#/definitions/rules/properties/semicolon/definitions/options/items/1"
}
],
"maxItems": 3,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/semicolon/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/semicolon/definitions/options/items/0"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"space-before-function-paren": {
"description": "Require or disallow a space before function parenthesis",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"anonymous": {
"type": "string",
"enum": ["always", "never"]
},
"asyncArrow": {
"type": "string",
"enum": ["always", "never"]
},
"constructor": {
"type": "string",
"enum": ["always", "never"]
},
"method": {
"type": "string",
"enum": ["always", "never"]
},
"named": {
"type": "string",
"enum": ["always", "never"]
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/space-before-function-paren/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/space-before-function-paren/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/space-before-function-paren/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"space-within-parens": {
"description": "Enforces spaces within parentheses or disallow them.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "number",
"min": 0
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/space-within-parens/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/space-within-parens/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/space-within-parens/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"switch-default": {
"description": "Require a `default` case in all `switch` statements.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"switch-final-break": {
"description": "Checks whether the final clause of a switch statement ends in `break;`.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["always"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/switch-final-break/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/switch-final-break/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/switch-final-break/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"trailing-comma": {
"description": "Requires or disallows trailing commas in array and object literals, destructuring assignments, function typings, named imports and exports and function parameters.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"multiline": {
"anyOf": [
{
"type": "string",
"enum": ["always", "never"]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"exports": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"functions": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"imports": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"objects": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"typeLiterals": {
"type": "string",
"enum": ["always", "never", "ignore"]
}
},
"additionalProperties": false
}
]
},
"singleline": {
"anyOf": [
{
"type": "string",
"enum": ["always", "never"]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"exports": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"functions": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"imports": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"objects": {
"type": "string",
"enum": ["always", "never", "ignore"]
},
"typeLiterals": {
"type": "string",
"enum": ["always", "never", "ignore"]
}
},
"additionalProperties": false
}
]
},
"esSpecCompliant": {
"description": "Option to forbid trailing comma after rest",
"type": "boolean"
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/trailing-comma/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/trailing-comma/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/trailing-comma/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"triple-equals": {
"description": "Requires `===` and `!==` in place of `==` and `!=`.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["allow-null-check", "allow-undefined-check"]
},
"minItems": 1,
"maxItems": 3,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/triple-equals/definitions/options/items"
},
"maxItems": 3,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/triple-equals/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/triple-equals/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"typeof-compare": {
"description": "Makes sure result of `typeof` is compared to correct string values",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"use-isnan": {
"description": "Enforces use of the `isNaN()` function to check for NaN references instead of a comparison to the `NaN` constant.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"variable-name": {
"description": "Checks variable names for various errors.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"check-format",
"require-const-for-all-caps",
"allow-leading-underscore",
"allow-trailing-underscore",
"allow-pascal-case",
"allow-snake-case",
"ban-keywords"
]
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/variable-name/definitions/options/items"
},
"maxItems": 7,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/variable-name/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/variable-name/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"whitespace": {
"description": "Enforces whitespace style conventions.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"check-branch",
"check-decl",
"check-operator",
"check-module",
"check-separator",
"check-rest-spread",
"check-type",
"check-typecast",
"check-type-operator",
"check-preblock",
"check-postbrace"
],
"minItems": 1,
"maxItems": 10,
"uniqueItems": true
}
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/rules/properties/whitespace/definitions/options/items"
},
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/rules/properties/whitespace/definitions/options"
},
{
"$ref": "#/definitions/rules/properties/whitespace/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
}
}
},
"tsRules": {
"properties": {
"adjacent-overload-signatures": {
"description": "Enforces function overloads to be consecutive.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"ban-ts-ignore": {
"description": "Bans \"// @ts-ignore\" comments from being used.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"additionalProperties": false
}
]
},
"array-type": {
"description": "Requires using either 'T[]' or 'Array<T>' for arrays.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["array", "generic", "array-simple"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/array-type/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/array-type/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/array-type/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"await-promise": {
"description": "Warns for an awaited value that is not a Promise.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/await-promise/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/await-promise/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/await-promise/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"ban-types": {
"description": "Bans specific types from being used. Does not ban the corresponding runtime objects from being used.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 2
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/ban-types/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/ban-types/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/ban-types/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"callable-types": {
"description": "An interface or literal type with just a call signature can be written as a function type.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"interface-name": {
"description": "Requires interface names to begin with a capital 'I'",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["always-prefix", "never-prefix"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/interface-name/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/interface-name/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/interface-name/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"interface-over-type-literal": {
"description": "Prefer an interface declaration over a type literal (`type T = { ... }`)",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"match-default-export-name": {
"description": "Requires that a default import have the same name as the declaration it imports.\nDoes nothing for anonymous default exports.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"member-access": {
"description": "Requires explicit visibility declarations for class members.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"no-public",
"check-accessor",
"check-constructor",
"check-parameter-property"
]
},
"minItems": 1,
"maxItems": 4,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/member-access/definitions/options/items"
},
"maxItems": 4,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/member-access/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/member-access/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-angle-bracket-type-assertion": {
"description": "Requires the use of `as Type` for type assertions instead of `<Type>`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-any": {
"description": "Disallows usages of `any` as a type declaration.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"ignore-rest-args": {
"type": "boolean"
}
}
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-boolean-literal-compare": {
"description": "Warns on comparison to a boolean literal, as in `x === true`.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-empty-interface": {
"description": "Forbids empty interfaces.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-floating-promises": {
"description": "Promises returned by functions must be handled appropriately.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/no-floating-promises/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/no-floating-promises/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/no-floating-promises/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-inferrable-types": {
"description": "Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["ignore-params", "ignore-properties"]
},
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/no-inferrable-types/definitions/options/items"
},
"maxItems": 3,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/no-inferrable-types/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/no-inferrable-types/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-inferred-empty-object-type": {
"description": "Disallow type inference of {} (empty object type) at function and constructor call sites",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-internal-module": {
"description": "Disallows internal `module`",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-mergeable-namespace": {
"description": "Disallows mergeable namespaces in the same file.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-misused-new": {
"description": "Warns on apparent attempts to define constructors for interfaces or `new` for classes.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-namespace": {
"description": "Disallows use of internal `module`s and `namespace`s.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["allow-declarations"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/no-namespace/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/no-namespace/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/no-namespace/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-non-null-assertion": {
"description": "Disallows non-null assertions.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-object-literal-type-assertion": {
"description": "Forbids an object literal to appear in a type assertion expression.\nCasting to `any` is still allowed.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-parameter-properties": {
"description": "Disallows parameter properties in class constructors.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-redundant-jsdoc": {
"description": "Forbids JSDoc which duplicates TypeScript functionality.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-reference-import": {
"description": "Don't `<reference types=\"foo\" />` if you import `foo` anyway.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unbound-method": {
"description": "Warns when a method is used as outside of a method call.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": ["ignore-static"]
},
"minItems": 1,
"maxItems": 1
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/no-unbound-method/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/no-unbound-method/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/no-unbound-method/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unnecessary-qualifier": {
"description": "Warns when a namespace qualifier (`A.x`) is unnecessary.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unnecessary-type-assertion": {
"description": "Warns if a type assertion does not change the type of an expression.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/no-unnecessary-type-assertion/definitions/options/items"
},
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/no-unnecessary-type-assertion/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/no-unnecessary-type-assertion/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unsafe-any": {
"description": "Warns when using an expression of type 'any' in a dynamic way.\nUses are only allowed if they would work for `{} | null | undefined`.\nType casts and tests are allowed.\nExpressions that work on all values (such as `\"\" + x`) are allowed.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"no-unused-variable": {
"description": "Disallows unused imports, variables, functions and private class members. Similar to tsc's --noUnusedParameters and --noUnusedLocals options, but does not interrupt code compilation.",
"definitions": {
"options": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"enum": ["check-parameters"]
},
{
"type": "object",
"properties": {
"ignore-pattern": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"maxItems": 2,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/no-unused-variable/definitions/options/items"
},
"maxItems": 3,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/no-unused-variable/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/no-unused-variable/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"no-var-requires": {
"description": "Disallows the use of require statements except in import statements.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"prefer-readonly": {
"description": "Requires that private variables are marked as `readonly` if they're never modified outside of the constructor.",
"definitions": {
"options": {
"type": "array",
"items": {
"enum": ["only-inline-lambdas"],
"type": "string"
}
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/prefer-readonly/definitions/options/items"
},
"maxItems": 2,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/prefer-readonly/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/prefer-readonly/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"strict-boolean-expressions": {
"description": "Restricts the types allowed in boolean expressions. By default only booleans are allowed.\n\nThe following nodes are checked:\n* Arguments to the `!`, `&&`, and `||` operators\n* The condition in a conditional expression (`cond ? x : y`)\n* Conditions for `if`, `for`, `while`, and `do-while` statements.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"allow-null-union",
"allow-undefined-union",
"allow-string",
"allow-enum",
"allow-number",
"allow-mix",
"allow-boolean-or-undefined",
"ignore-rhs"
]
},
"minItems": 1,
"maxItems": 8,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/strict-boolean-expressions/definitions/options/items"
},
"maxItems": 6,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/strict-boolean-expressions/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/strict-boolean-expressions/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"strict-type-predicates": {
"description": "Warns for type predicates that are always true or always false.\nWorks for 'typeof' comparisons to constants (e.g. 'typeof foo === \"string\"'), and equality comparison to 'null'/'undefined'.\n(TypeScript won't let you compare '1 === 2', but it has an exception for '1 === undefined'.)\nDoes not yet work for 'instanceof'.\nDoes *not* warn for 'if (x.y)' where 'x.y' is always truthy. For that, see strict-boolean-expressions.\n\nThis rule requires `strictNullChecks` to work properly.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"typedef": {
"description": "Requires type definitions to exist.",
"definitions": {
"options": {
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minItems": 1,
"maxItems": 9,
"uniqueItems": true
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": {
"$ref": "#/definitions/tsRules/properties/typedef/definitions/options/items"
},
"maxItems": 10,
"uniqueItems": true,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/typedef/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/typedef/definitions/options/items"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"typedef-whitespace": {
"description": "Requires or disallows whitespace for type definitions.",
"definitions": {
"options": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"call-signature": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"index-signature": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"parameter": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"property-declaration": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"variable-declaration": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"call-signature": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"index-signature": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"parameter": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"property-declaration": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
},
"variable-declaration": {
"type": "string",
"enum": ["nospace", "onespace", "space"]
}
},
"additionalProperties": false
}
],
"minItems": 1,
"maxItems": 2
}
},
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/tsRules/properties/typedef-whitespace/definitions/options/items/0"
},
{
"$ref": "#/definitions/tsRules/properties/typedef-whitespace/definitions/options/items/1"
}
],
"maxItems": 3,
"properties": {
"options": {
"description": "An option value or an array of multiple option values.",
"oneOf": [
{
"$ref": "#/definitions/tsRules/properties/typedef-whitespace/definitions/options"
},
{
"$ref": "#/definitions/tsRules/properties/typedef-whitespace/definitions/options/items/0"
}
]
},
"severity": {}
},
"additionalProperties": false
}
]
},
"type-literal-delimiter": {
"description": "Checks that type literal members are separated by semicolons.\nEnforces a trailing semicolon for multiline type literals.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"singleLine": {
"type": "string",
"enum": ["always", "never"]
}
}
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"unified-signatures": {
"description": "Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"use-default-type-parameter": {
"description": "Warns if an explicitly specified type argument is the default for that type parameter.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"properties": {
"severity": {}
},
"additionalProperties": false
}
]
},
"function-constructor": {
"description": "Prevents using the built-in Function constructor.",
"allOf": [
{
"$ref": "#/definitions/rule"
},
{
"items": [
{
"type": "boolean"
}
],
"additionalItems": false,
"additionalProperties": false
}
]
}
}
}
},
"id": "https://json.schemastore.org/tslint.json",
"properties": {
"extends": {
"description": "The name of a built-in configuration preset, or a path or array of paths to other configuration files which are extended by this configuration. These values are handled using node module resolution semantics.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"rulesDirectory": {
"description": "A path to a directory or an array of paths to directories of custom rules. These values are handled using node module resolution semantics, if an `index.js` is placed in your rules directory.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"rules": {
"description": "A map of rules that will be used to lint TypeScript files. These rules apply to `.ts` and `.tsx` files.",
"allOf": [
{
"$ref": "#/definitions/tsRules"
},
{
"$ref": "#/definitions/rules"
}
]
},
"jsRules": {
"description": "A map of rules that will be used to lint JavaScript files. These rules apply to `.js` and `.jsx` files.",
"$ref": "#/definitions/rules"
},
"defaultSeverity": {
"description": "The severity level used when a rule specifies \"default\" as its severity level. If undefined, \"error\" is used.",
"type": "string",
"enum": ["error", "warning", "warn", "off", "none"],
"default": "error"
},
"linterOptions": {
"description": "Additional linter options.",
"type": "object",
"properties": {
"exclude": {
"description": "An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"title": "JSON schema for the TSLint configuration files.",
"type": "object"
}
|
project.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"compilationOptions": {
"title": "compilation options",
"description": "[Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead.",
"type": "object",
"properties": {
"define": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"nowarn": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"warningsAsErrors": {
"type": "boolean",
"default": false
},
"allowUnsafe": {
"type": "boolean",
"default": false
},
"emitEntryPoint": {
"type": "boolean",
"default": false
},
"optimize": {
"type": "boolean",
"default": false
},
"platform": {
"type": "string",
"enum": [
"anycpu",
"anycpu32bitpreferred",
"ARM",
"x86",
"x64",
"Itanium"
]
},
"languageVersion": {
"type": "string",
"enum": [
"csharp1",
"csharp2",
"csharp3",
"csharp4",
"csharp5",
"csharp6",
"experimental"
]
},
"keyFile": {
"type": "string"
},
"delaySign": {
"type": "boolean",
"default": false
},
"publicSign": {
"type": "boolean",
"default": false
},
"debugType": {
"type": "string",
"enum": ["portable", "full"]
},
"preserveCompilationContext": {
"type": "boolean",
"description": "Set this option to preserve reference assemblies and other context data to allow for runtime compilation"
},
"outputName": {
"type": "string"
}
}
},
"buildOptions": {
"title": "build options",
"description": "Options that are passed to the compiler.",
"type": "object",
"properties": {
"define": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"nowarn": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"warningsAsErrors": {
"type": "boolean",
"default": false
},
"allowUnsafe": {
"type": "boolean",
"default": false
},
"emitEntryPoint": {
"type": "boolean",
"default": false
},
"optimize": {
"type": "boolean",
"default": false
},
"platform": {
"type": "string",
"enum": [
"anycpu",
"anycpu32bitpreferred",
"ARM",
"x86",
"x64",
"Itanium"
]
},
"languageVersion": {
"type": "string",
"enum": [
"csharp1",
"csharp2",
"csharp3",
"csharp4",
"csharp5",
"csharp6",
"experimental"
]
},
"keyFile": {
"type": "string"
},
"delaySign": {
"type": "boolean",
"default": false
},
"publicSign": {
"type": "boolean",
"default": false
},
"debugType": {
"type": "string",
"enum": ["portable", "full", "none"]
},
"preserveCompilationContext": {
"type": "boolean",
"description": "Set this option to preserve reference assemblies and other context data to allow for runtime compilation."
},
"outputName": {
"type": "string"
},
"compilerName": {
"type": "string",
"default": "csc"
},
"compile": {
"description": "Defines glob patterns and file path to include for compilation.",
"type": ["string", "array", "object"],
"items": {
"type": "string"
},
"properties": {
"include": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "List of file globbing patterns to be included."
},
"exclude": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "List of file globbing patterns to be excluded."
},
"includeFiles": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "List of file paths to be included."
},
"excludeFiles": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "List of file paths to be excluded."
},
"builtIns": {
"type": ["string", "array", "object"],
"items": {
"type": "string"
},
"properties": {
"include": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "List of file globbing patterns to be included."
},
"exclude": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "List of file globbing patterns to be included."
}
}
},
"mappings": {
"title": "mapping options",
"type": "object",
"description": "Pairs of destination folders and glob patterns specifying additional files to include/exclude."
}
}
},
"embed": {
"allOf": [
{
"$ref": "#/definitions/buildOptions/properties/compile"
},
{
"description": "Defines glob patterns and file paths of resource files to include for compilation."
}
]
},
"copyToOutput": {
"allOf": [
{
"$ref": "#/definitions/buildOptions/properties/compile"
},
{
"description": "Defines glob patterns and file paths to include for copying to build output."
}
]
},
"xmlDoc": {
"type": "boolean"
},
"additionalArguments": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"runtimeOptions": {
"title": "runtime options",
"type": "object",
"properties": {
"configProperties": {
"title": "config options",
"type": "object",
"properties": {
"System.GC.Server": {
"type": "boolean",
"description": "Enables/disables server garbage collection.",
"default": false
},
"System.GC.Concurrent": {
"type": "boolean",
"description": "Enables/disables concurrent garbage collection.",
"default": true
},
"System.GC.HeapCount": {
"type": "integer",
"minimum": 0,
"description": "Limits the number of heaps created by the garbage collector."
},
"System.GC.HeapAffinitizeMask": {
"type": "integer",
"minimum": 0,
"description": "Specifies the exact processors that garbage collector threads should use."
},
"System.GC.GCHeapAffinitizeRanges": {
"type": "string",
"minLength": 1,
"description": "Specifies the list of processors to use for garbage collector threads."
},
"System.GC.NoAffinitize": {
"type": "boolean",
"description": "Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread.",
"default": false
},
"System.GC.HeapHardLimit": {
"type": "string",
"description": "Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping."
},
"System.GC.HeapHardLimitPercent": {
"type": "number",
"description": "Specifies the GC heap usage as a percentage of the total memory."
},
"System.GC.RetainVM": {
"type": "boolean",
"description": "Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS).",
"default": false
},
"System.GC.LOHThreshold": {
"type": "integer",
"description": "Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH).",
"default": 85000
},
"System.Threading.ThreadPool.MinThreads": {
"type": "integer",
"minimum": 1,
"description": "Sets the minimum number of threads for the thread pool."
},
"System.Threading.ThreadPool.MaxThreads": {
"type": "integer",
"minimum": 1,
"description": "Sets the maximum number of threads for the thread pool."
}
}
},
"framework": {
"title": "framework options",
"description": "Properties of the shared framework to use when activating the application.",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"applyPatches": {
"description": "Determines if the framework version is strictly obeyed by the host.",
"type": "boolean"
}
}
},
"packOptions": {
"title": "pack options",
"description": "Defines options pertaining to the packaging of the project output into a NuGet package.",
"type": "object",
"properties": {
"summary": {
"description": "A short description of the package.",
"type": "string"
},
"tags": {
"description": "A space-delimited list of tags and keywords that describe the package.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"owners": {
"description": "List of owners of the package.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"releaseNotes": {
"description": "A description of the changes made in each release of the package.",
"type": "string"
},
"iconUrl": {
"description": "A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.",
"type": "string"
},
"licenseUrl": {
"description": "A link to the license for the package.",
"type": "string"
},
"requireLicenseAcceptance": {
"description": "A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.",
"type": "boolean",
"default": false
},
"repository": {
"title": "repository options",
"type": "object",
"description": "Contains information about the repository where the project is stored.",
"properties": {
"type": {
"type": "string",
"enum": ["git"],
"default": "git"
},
"url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {
"type": "string"
}
},
"files": {
"allOf": [
{
"$ref": "#/definitions/buildOptions/properties/compile"
},
{
"description": "Defines glob patterns and file paths to include in the generated NuGet package."
}
]
}
}
},
"publishOptions": {
"allOf": [
{
"$ref": "#/definitions/buildOptions/properties/compile"
},
{
"description": "Defines glob patterns and file paths to include in publish output."
}
]
},
"configType": {
"title": "config options",
"type": "object",
"properties": {
"dependencies": {
"$ref": "#/definitions/dependencies"
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"buildOptions": {
"$ref": "#/definitions/buildOptions"
},
"frameworkAssemblies": {
"$ref": "#/definitions/dependencies"
},
"imports": {
"type": ["string", "array"],
"description": "Allow packages supporting these frameworks to be installed in this target, regardless of the compatibility rules.",
"items": {
"type": "string"
}
}
}
},
"libraryIncludeFlag": {
"type": "string",
"enum": [
"all",
"runtime",
"compile",
"build",
"contentFiles",
"native",
"analyzers",
"none"
]
},
"libraryIncludeFlags": {
"oneOf": [
{
"$ref": "#/definitions/libraryIncludeFlag"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/libraryIncludeFlag"
}
}
]
},
"dependencies": {
"title": "dependency options",
"type": "object",
"additionalProperties": {
"type": ["string", "object"],
"properties": {
"version": {
"type": "string"
},
"type": {
"type": "string",
"default": "default",
"enum": ["default", "build", "platform"]
},
"target": {
"type": "string",
"description": "Restrict this dependency to matching only a Project or a Package.",
"enum": ["project", "package"]
},
"include": {
"$ref": "#/definitions/libraryIncludeFlags"
},
"exclude": {
"$ref": "#/definitions/libraryIncludeFlags"
},
"suppressParent": {
"$ref": "#/definitions/libraryIncludeFlags"
}
}
},
"description": "Each dependency is defined by a name and a version. Dependencies are resolved from NuGet feeds defined by your package sources and projects located in the directories specified by the 'global.json' file."
},
"script": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "A command line script or scripts.\r\rAvailable variables:\r%project:Directory% - The project directory\r%project:Name% - The project name\r%project:Version% - The project version"
}
},
"id": "https://json.schemastore.org/project.json",
"properties": {
"authors": {
"description": "The author of the application.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"packInclude": {
"title": "path options",
"description": "[Deprecated] Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { \"tools/\": \"tools/**/*.*\" }. Use 'files' in 'packOptions' instead.",
"type": "object"
},
"publishExclude": {
"description": "[Deprecated] Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'publishOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["obj/**/*.*", "bin/**/*.*", "**/.*/**"]
},
"compile": {
"description": "[Deprecated] Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'compile' in 'buildOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**/*.cs"
},
"compileExclude": {
"description": "[Deprecated] Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'compile' in 'buildOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"compileFiles": {
"description": "[Deprecated] Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]. Use 'compile' in 'buildOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"content": {
"description": "[Deprecated] Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**/*"
},
"contentExclude": {
"description": "[Deprecated] Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"contentFiles": {
"description": "[Deprecated] Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"preprocess": {
"description": "Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "compiler/preprocess/**/*.cs"
},
"preprocessExclude": {
"description": "Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"preprocessFiles": {
"description": "Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"resource": {
"description": "[Deprecated] Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'embed' in 'buildOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["compiler/resources/**/*", "**/*.resx"]
},
"resourceExclude": {
"description": "[Deprecated] Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'embed' in 'buildOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"resourceFiles": {
"description": "[Deprecated] Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]. Use 'embed' in 'buildOptions' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"shared": {
"description": "Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "compiler/shared/**/*.cs"
},
"sharedExclude": {
"description": "Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"sharedFiles": {
"description": "Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"exclude": {
"description": "[Deprecated] Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'exclude' within 'compile' or 'embed' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"excludeBuiltIn": {
"description": "[Deprecated] Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]. Use 'exclude' within 'compile' or 'embed' instead.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["bin/**", "obj/**", "**/*.xproj"]
},
"testRunner": {
"description": "The name of the test runner to use with this project",
"type": "string"
},
"commands": {
"title": "command options",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"buildOptions": {
"$ref": "#/definitions/buildOptions"
},
"packOptions": {
"$ref": "#/definitions/packOptions"
},
"runtimeOptions": {
"$ref": "#/definitions/runtimeOptions"
},
"publishOptions": {
"$ref": "#/definitions/publishOptions"
},
"configurations": {
"title": "configuration options",
"type": "object",
"description": "Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.",
"additionalProperties": {
"title": "additional options",
"type": "object",
"properties": {
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"buildOptions": {
"$ref": "#/definitions/buildOptions"
}
}
}
},
"dependencies": {
"$ref": "#/definitions/dependencies"
},
"copyright": {
"description": "Copyright details for the package.",
"type": "string"
},
"iconUrl": {
"description": "[Deprecated] A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background. Use this in 'packOptions' instead.",
"type": "string"
},
"licenseUrl": {
"description": "[Deprecated] A link to the license for the package. Use this in 'packOptions' instead.",
"type": "string"
},
"requireLicenseAcceptance": {
"description": "[Deprecated] A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed. Use this in 'packOptions' instead.",
"type": "boolean",
"default": false
},
"owners": {
"description": "[Deprecated] List of owners of the package. Use this in 'packOptions' instead.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"projectUrl": {
"description": "A URL for the home page of the package.",
"type": "string"
},
"summary": {
"description": "[Deprecated] A short description of the package. Use this in 'packOptions' instead.",
"type": "string"
},
"tags": {
"description": "[Deprecated] A space-delimited list of tags and keywords that describe the package. Use this in 'packOptions' instead.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"title": {
"description": "The human-friendly title of the package",
"type": "string"
},
"releaseNotes": {
"description": "[Deprecated] A description of the changes made in each release of the package. Use this in 'packOptions' instead.",
"type": "string"
},
"language": {
"description": "The locale ID for the package, such as en-us.",
"type": "string"
},
"description": {
"description": "The description of the project/package.",
"type": "string"
},
"frameworks": {
"title": "framework options",
"description": "Target frameworks that will be built, and dependencies that are specific to the build of this project for that framework.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configType"
}
},
"namedResource": {
"title": "resource options",
"type": "object",
"description": "Overrides the generated resource names with custom ones.",
"additionalProperties": {
"type": "string"
}
},
"repository": {
"title": "repository options",
"type": "object",
"description": "[Deprecated] Contains information about the repository where the project is stored. Use this in 'packOptions' instead.",
"properties": {
"type": {
"type": "string",
"enum": ["git"],
"default": "git"
},
"url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {
"type": "string"
}
},
"scripts": {
"title": "script options",
"type": "object",
"description": "Scripts to execute during the various stages.",
"properties": {
"precompile": {
"$ref": "#/definitions/script"
},
"postcompile": {
"$ref": "#/definitions/script"
},
"prepack": {
"$ref": "#/definitions/script"
},
"postpack": {
"$ref": "#/definitions/script"
},
"prepublish": {
"$ref": "#/definitions/script"
},
"postpublish": {
"$ref": "#/definitions/script"
},
"prerestore": {
"$ref": "#/definitions/script"
},
"postrestore": {
"$ref": "#/definitions/script"
},
"prepare": {
"$ref": "#/definitions/script"
}
}
},
"version": {
"description": "The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*",
"type": "string"
},
"tools": {
"title": "tool options",
"description": "Project-specific command line tools accessible when in the project.json directory.",
"type": "object",
"additionalProperties": {
"type": ["string", "object"],
"properties": {
"version": {
"type": "string"
}
}
}
},
"runtimes": {
"title": "runtime options",
"description": "List of runtime identifiers supported by this project (used when building standalone applications).",
"type": "object"
},
"userSecretsId": {
"description": "Specify a unique identifier for the development time user secrets of the project.",
"type": "string"
}
},
"title": "JSON schema for .NET Core project.json files",
"type": "object"
}
|
ninjs-1.3.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "A news item as JSON object -- copyright 2020 IPTC - International Press Telecommunications Council - www.iptc.org - This document is published under the Creative Commons Attribution 4.0 license, see http://creativecommons.org/licenses/by/4.0/",
"id": "http://www.iptc.org/std/ninjs/ninjs-schema_1.3.json#",
"patternProperties": {
"^description_[a-zA-Z0-9_]+": {
"title": "Description",
"description": "A free-form textual description of the content of the item. (The string appended to description_ in the property name should reflect the format and/or the purpose of the text, separating the parts with _). nar:description",
"type": "string"
},
"^body_[a-zA-Z0-9_]+": {
"title": "Body",
"description": "The textual content of the news object. (The string appended to body_ in the property name should reflect the format and/or the purpose of the text, separating the parts with _). nar:inlineData or nar:inlineXML",
"type": "string"
},
"^headline_[a-zA-Z0-9_]+": {
"title": "Extra headlines",
"description": "Additional headlines or strings of that type can be handled here. This is not replacing the main headline-property in ninjs. (The string appended to headline_ in the property name should reflect the format and/or the purpose of the text, separating the parts with _) nar:headline with roles issue #13. (Added in 1.3)",
"type": "string"
}
},
"properties": {
"uri": {
"title": "Uniform Resource Identifier",
"description": "The identifier for this news object. nar:newsItem@guid",
"type": "string",
"format": "uri"
},
"type": {
"title": "Type",
"description": "The generic news type of this news object. (Value 'component' added in version 1.2 as issue #21.). nar:itemClass",
"type": "string",
"enum": [
"text",
"audio",
"video",
"picture",
"graphic",
"composite",
"component"
]
},
"mimetype": {
"title": "MIME type",
"description": "A MIME type which applies to this news object. nar:contentType",
"type": "string"
},
"representationtype": {
"title": "Representation type",
"description": "Indicates how complete this representation of a news item is. No mapping to nar. Specific for ninjs.",
"type": "string",
"enum": ["complete", "incomplete"]
},
"profile": {
"title": "Profile",
"description": "An identifier for the structure of the news object. This can be any string but we suggest something identifying the structure of the content such as 'text-only' or 'text-photo'. Profiles are typically provider-specific. nar:profile",
"type": "string"
},
"version": {
"title": "Version",
"description": "The version of the news object which is identified by the uri property. nar:newsItem@version",
"type": "string"
},
"firstcreated": {
"title": "First created",
"description": "Indicates when the first version of the item was created. (Added in version 1.2 from issue #5). nar:firstCreated",
"type": "string",
"format": "date-time"
},
"versioncreated": {
"title": "Version created",
"description": "The date and time when this version of the news object was created. nar:versionCreated",
"type": "string",
"format": "date-time"
},
"embargoed": {
"title": "Embargoed",
"description": "The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed. nar:embargoed",
"type": "string",
"format": "date-time"
},
"pubstatus": {
"title": "Publication status",
"description": "The publishing status of the news object, its value is *usable* by default. nar:pubStatus",
"type": "string",
"enum": ["usable", "withheld", "canceled"]
},
"urgency": {
"title": "Urgency",
"description": "The editorial urgency of the content from 1 to 9. 1 represents the highest urgency, 9 the lowest. nar:urgency",
"type": "number"
},
"copyrightholder": {
"title": "Copyright holder",
"description": "The person or organisation claiming the intellectual property for the content. nar:copyrightHolder",
"type": "string"
},
"copyrightnotice": {
"title": "Copyright notice",
"description": "Any necessary copyright notice for claiming the intellectual property for the content. nar:copyrightNotice",
"type": "string"
},
"usageterms": {
"title": "Usage terms",
"description": "A natural-language statement about the usage terms pertaining to the content. nar:usageTerms",
"type": "string"
},
"ednote": {
"title": "Editorial note",
"description": "A note that is intended to be read by internal staff at the receiving organisation, but not published to the end-user. (Added in version 1.2 from issue #6.) . ednote: nar:edNote",
"type": "string"
},
"language": {
"title": "Language",
"description": "The human language used by the content. The value should follow IETF BCP47. nar:language",
"type": "string"
},
"person": {
"title": "Person",
"description": "An individual human being. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of a person",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the person",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the person",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the person in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
},
"organisation": {
"title": "Organisation",
"description": "An administrative and functional structure which may act as as a business, as a political party or not-for-profit party. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the organisation",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the organisation",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the organisation",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the organisation in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
},
"symbols": {
"title": "Symbols",
"description": "Symbols used for a financial instrument linked to the organisation at a specific market place",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ticker": {
"title": "Ticker",
"description": "Ticker symbol used for the financial instrument",
"type": "string"
},
"exchange": {
"title": "Exchange",
"description": "Identifier for the marketplace which uses the ticker symbols of the ticker property",
"type": "string"
}
}
}
}
}
}
},
"place": {
"title": "Place",
"description": "A named location. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^geometry_[a-zA-Z0-9_]+": {
"description": "An object holding geo data of this place. Could be of any relevant geo data JSON object definition.",
"type": "object"
}
},
"properties": {
"name": {
"title": "Name",
"description": "The name of the place",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the place",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the place",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the place in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
},
"subject": {
"title": "Subject",
"description": "A concept with a relationship to the content. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the subject",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the subject",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the subject",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the subject in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
},
"event": {
"title": "Event",
"description": "Something which happens in a planned or unplanned manner. nar:?",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the event",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the event",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the event",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the event in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
},
"object": {
"title": "Object",
"description": "Something material, excluding persons. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the object",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the object",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the object",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the object in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
},
"infosource": {
"title": "Info source",
"description": "A party (person or organisation) which originated, modified, enhanced, distributed, aggregated or supplied the content or provided some information used to create or enhance the content. (Added in version 1.2 according to issue #15.) . infosource: nar:infoSource",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the infosource",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the infosource",
"type": "string"
},
"scheme": {
"title": "Schema",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the infosource",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the infosource in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
},
"title": {
"title": "Title",
"description": "A short natural-language name for the item. (Added in version 1.2 according to issue #9). nar:itemMeta/title",
"type": "string"
},
"byline": {
"title": "Byline",
"description": "The name(s) of the creator(s) of the content. nar:by",
"type": "string"
},
"headline": {
"title": "Headline",
"description": "A brief and snappy introduction to the content, designed to catch the reader's attention. nar:headline",
"type": "string"
},
"slugline": {
"title": "Slugline",
"description": "A human-readable identifier for the item. (Added in version 1.2 from issue #4.). nar:slugline",
"type": "string"
},
"located": {
"title": "Located",
"description": "The name of the location from which the content originates. nar:located",
"type": "string"
},
"charcount": {
"title": "Character count",
"description": "The total character count in the article excluding figure captions. (Added in version 1.2 according to issue #27.). nar:charcount",
"type": "number"
},
"wordcount": {
"title": "Word count",
"description": "The total number of words in the article excluding figure captions. (Added in version 1.2 according to issue #27.). nar:wordcount",
"type": "number"
},
"renditions": {
"title": "Renditions",
"description": "Wrapper for different renditions of the news object. nar:remoteContent",
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_]+": {
"description": "A specific rendition of the content of the news object. (Description changed in version 1.2 according to issue #17.)",
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"title": "href",
"description": "The URL for accessing the rendition as a resource. nar:remoteContent@ref",
"type": "string",
"format": "uri"
},
"mimetype": {
"title": "mimetype",
"description": "A MIME type which applies to the rendition. nar:remoteContent@contenttype",
"type": "string"
},
"title": {
"title": "Title",
"description": "A title for the link to the rendition resource",
"type": "string"
},
"height": {
"title": "Height",
"description": "For still and moving images: the height of the display area measured in pixels. nar:remoteContent@height",
"type": "number"
},
"width": {
"title": "Width",
"description": "For still and moving images: the width of the display area measured in pixels. nar:remoteContent@width",
"type": "number"
},
"sizeinbytes": {
"title": "Size in bytes",
"description": "The size of the rendition resource in bytes",
"type": "number"
},
"duration": {
"title": "Duration",
"description": "The total time duration of the content in seconds. (Added in version 1.2. Issue #18). nar:remoteContent@duration",
"type": "number"
},
"format": {
"title": "Format",
"description": "Binary format name. (Added in version 1.2. Issue #18). nar:remoteContent@format",
"type": "string"
}
}
}
}
},
"associations": {
"description": "Content of news objects which are associated with this news object. nar:link",
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9_]+": {
"$ref": "http://www.iptc.org/std/ninjs/ninjs-schema_1.3.json#"
}
}
},
"altids": {
"title": "Alternative id",
"description": "Alternative identifiers of the item. It is up to the individual provider to name and set type on the alternative identifiers they like to use. nar:altId issue #3. (Added in version 1.3)",
"type": "object",
"additionalProperties": true
},
"trustindicator": {
"title": "Trust indicator",
"description": "An array of objects to allow links to documents about trust indicators. (nar:link) issue #44. (Added in version 1.3)",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the trust indicator",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the trust indicator in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
},
"title": {
"title": "Title",
"description": "The title of the resource being referenced.",
"type": "string"
},
"href": {
"title": "href",
"description": "The URL for accessing the trust indicator resource.",
"type": "string",
"format": "uri"
}
}
}
},
"$standard": {
"title": "Standard",
"type": "object",
"description": "An object with information about standard, version and schema this instance is valid against. nar:standard, nar:standardversion and xml:schema issue #43. (Added in version 1.3)",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"title": "Name of standard.",
"description": "For example ninjs. nar:standard"
},
"version": {
"type": "string",
"title": "Version of standard.",
"description": "For example 1.3. nar:standardversion"
},
"schema": {
"type": "string",
"format": "uri",
"title": "Schema",
"description": "The uri of the json schema to use for validation."
}
}
},
"genre": {
"title": "Genre",
"description": "A nature, intellectual or journalistic form of the content. nar:genre. (Added in version 1.3)",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the genre",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "The identifier of a scheme (= controlled vocabulary) which includes a code for the genre. Normally http://cv.iptc.org/newscodes/genre/",
"type": "string",
"format": "uri"
},
"code": {
"title": "Code",
"description": "The code for the genre in a scheme (= controlled vocabulary) which is identified by the scheme property",
"type": "string"
}
}
}
}
},
"required": ["uri"],
"title": "IPTC ninjs - News in JSON - 1.3 (approved, 13 May 2020)",
"type": "object"
}
|
comet.json | {
"$id": "https://json.schemastore.org/comet.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"PrimitiveType": {
"type": "string",
"oneOf": [
{
"const": "string",
"description": "Any string that match the '.*' regex"
},
{
"const": "long",
"description": "Any whole number that match the '[-|+|0-9][0-9]*' regex.\nints are mapped to as 'int' in some database whereas 'longs are mapped as 'bigint' and shorts as 'smallint'"
},
{
"const": "int",
"description": "Any whole number that match the '[-|+|0-9][0-9]*' regex.\nints are mapped to as 'int' in some database whereas 'longs are mapped as 'bigint' and shorts as 'smallint'"
},
{
"const": "short",
"description": "Any whole number that match the '[-|+|0-9][0-9]*' regex.\nints are mapped to as 'int' in some database whereas 'longs are mapped as 'bigint' and shorts as 'smallint'"
},
{
"const": "double",
"description": "Any decimal number that match the '[-+]?\\d*\\.?\\d+[Ee]?[-+]?\\d*' regex"
},
{
"const": "boolean",
"description": "Any string that match the '(?i)true|yes|[y1]<-TF->(?i)false|no|[n0]' regex,\nwhere the value on the left of '<-T' represent true and values on the right of 'F->' represent the false"
},
{
"const": "byte",
"description": "Any single char"
},
{
"const": "date",
"description": "Any date that match the 'yyyy-MM-dd' regex (2023-12-31)"
},
{
"const": "basic_iso_date",
"description": "Any date that match the 'yyyyMMdd' regex (20231231)"
},
{
"const": "iso_local_date",
"description": "Any date that match the 'yyyy-MM-dd' regex (2023-12-31)"
},
{
"const": "iso_offset_date",
"description": "Timestamp based on `ISO Date with offset` pattern (2023-12-31+02:00)"
},
{
"const": "iso_date",
"description": "Timestamp based on `ISO Date with or without offset` pattern (2011-12-03+02:00)"
},
{
"const": "iso_local_date_time",
"description": "Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30)"
},
{
"const": "iso_offset_date_time",
"description": "Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30+01:00)"
},
{
"const": "iso_zoned_date_time",
"description": "Timestamp based on `ISO Zoned Date Time`pattern (2023-12-31T10:15:30+01:00[Europe/Paris])"
},
{
"const": "iso_date_time",
"description": "Timestamp based on `ISO Date and time with ZoneId` pattern (2011-12-03T10:15:30+01:00[Europe/Paris])"
},
{
"const": "iso_ordinal_date",
"description": "Timestamp based on `year and day of year` pattern (2023-337)"
},
{
"const": "iso_week_date",
"description": "Timestamp based on `Year and Week` pattern (2012-W48-6)"
},
{
"const": "iso_instant",
"description": "Timestamp based on `Date and Time of an Instant` pattern - UTC only - (2023-12-31T10:15:30Z)"
},
{
"const": "rfc_1123_date_time",
"description": "Timestamp based on `RFC 1123 / RFC 822` patterns (Tue, 3 Jun 2008 11:05:30 GMT)"
},
{
"const": "timestamp",
"description": "date/time that match the 'yyyy-MM-dd HH:mm:ss' regex s (2019-12-31 23:59:02).\nFor epoch timestamp, set pattern attribute to 'epoch_second' or 'epoch_milli'"
},
{
"const": "decimal",
"description": "Any floating value that match the '-?\\d*\\.{0,1}\\d+' regex"
},
{
"const": "struct",
"description": "Any attribute that has children. Set the array to true if this attribute is made of a list of attributes"
}
]
},
"IndexMapping": {
"type": "string",
"oneOf": [
{
"const": "text",
"description": ""
},
{
"const": "keyword",
"description": ""
},
{
"const": "long",
"description": ""
},
{
"const": "integer",
"description": ""
},
{
"const": "short",
"description": ""
},
{
"const": "byte",
"description": ""
},
{
"const": "double",
"description": ""
},
{
"const": "float",
"description": ""
},
{
"const": "half_float",
"description": ""
},
{
"const": "scaled_float",
"description": ""
},
{
"const": "date",
"description": ""
},
{
"const": "boolean",
"description": ""
},
{
"const": "binary",
"description": ""
},
{
"const": "integer_rang",
"description": ""
},
{
"const": "float_range",
"description": ""
},
{
"const": "long_range",
"description": ""
},
{
"const": "double_range",
"description": ""
},
{
"const": "date_range",
"description": ""
},
{
"const": "geo_point",
"description": ""
},
{
"const": "geo_shape",
"description": ""
},
{
"const": "ip",
"description": ""
},
{
"const": "completion",
"description": ""
},
{
"const": "token_count",
"description": ""
},
{
"const": "object",
"description": ""
},
{
"const": "array",
"description": ""
}
]
},
"WriteMode": {
"description": "Append to or overwrite existing data",
"type": "string",
"oneOf": [
{
"const": "OVERWRITE",
"description": "That data will overwrite the existing data or create it if it does not exist"
},
{
"const": "APPEND",
"description": "Append the data to an existing table or create it if it does not exist"
},
{
"const": "ERROR_IF_EXISTS",
"description": "Fail if teh table already exist"
},
{
"const": "IGNORE",
"description": "Do not save at all. Useful in interactive / test mode."
}
]
},
"UserType": {
"type": "string",
"oneOf": [
{
"const": "SA",
"description": "Service account"
},
{
"const": "USER",
"description": "End user"
},
{
"const": "GROUP",
"description": "Group of users / service accounts"
}
]
},
"Trim": {
"type": "string",
"oneOf": [
{
"const": "LEFT",
"description": "Remove all leading space chars from the input"
},
{
"const": "RIGHT",
"description": "Remove all trailing spaces from the input"
},
{
"const": "BOTH",
"description": "Remove all leading and trailing spaces from the input"
},
{
"const": "NONE",
"description": "Do not remove leading or trailing spaces from the input"
}
]
},
"TableDdl": {
"description": "DDL used to create a table",
"type": "object",
"properties": {
"createSql": {
"type": "string",
"description": "SQL CREATE DDL statement"
},
"pingSql": {
"type": "string",
"description": "How to test if the table exist.\nUse the following statement by default: 'select count(*) from tableName where 1=0'"
}
},
"required": ["createSql"]
},
"TableType": {
"type": "string",
"description": "Table types supported by the Extract module",
"oneOf": [
{
"const": "TABLE",
"description": "SQl Table"
},
{
"const": "VIEW",
"description": "SQl View"
},
{
"const": "SYSTEM TABLE",
"description": "Database specific system table"
},
{
"const": "GLOBAL TEMPORARY",
"description": ""
},
{
"const": "LOCAL TEMPORARY",
"description": ""
},
{
"const": "ALIAS",
"description": "Table alias"
},
{
"const": "SYNONYM",
"description": "Table synonym"
}
]
},
"Type": {
"type": "object",
"description": "Custom type definition. Custom types are defined in the types/types.comet.yml file",
"properties": {
"name": {
"type": "string",
"description": "unique id for this type"
},
"primitiveType": {
"$ref": "#/definitions/PrimitiveType",
"description": "To what primitive type should this type be mapped.\n This is the memory representation of the type, When saving, this primitive type is mapped to the database specific type "
},
"pattern": {
"type": "string",
"description": "Regex used to validate the input field"
},
"zone": {
"type": "string",
"description": "useful when parsing specific string:\n - double: To parse a french decimal (comma as decimal separator) set it to fr_FR locale.\n- decimal: to set the precision and scale of this number, '38,9' by default.\n- "
},
"sample": {
"type": "string",
"description": "This field makes sure that the pattern matches the value you want to match. This will be checked on startup"
},
"comment": {
"type": "string",
"description": "Describes this type"
},
"indexMapping": {
"type": "string",
"description": "How this type is indexed in your datawarehouse"
},
"ddlMapping": {
"$ref": "#/definitions/MapString",
"description": "Configure here the type mapping for each datawarehouse.\\nWill be used when inferring DDL from schema."
}
},
"required": ["name", "pattern", "primitiveType"]
},
"Partition": {
"description": "Partition columns, no partitioning by default",
"type": "object",
"properties": {
"sampling": {
"type": "number",
"description": "0.0 means no sampling, > 0 && < 1 means sample dataset, >=1 absolute number of partitions. Used exclusively on Hadoop & databricks warehouses"
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"description": "Attributes used to partition de dataset."
}
}
},
"required": []
},
"Position": {
"type": "object",
"properties": {
"first": {
"type": "number",
"description": "Zero based position of the first character for this attribute"
},
"last": {
"type": "number",
"description": "Zero based position of the last character to include in this attribute"
}
},
"required": ["first", "last"]
},
"Connection": {
"description": "Connection",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "aka jdbc, bigquery, snowflake, redshift ..."
},
"sparkFormat": {
"type": "string",
"description": "Set only if you want to use the Spark engine"
},
"mode": {
"$ref": "#/definitions/WriteMode",
"description": "Used for JDBC connections only. Write mode, APPEND by default"
},
"options": {
"$ref": "#/definitions/MapString",
"description": "Connection options"
}
},
"required": ["type"]
},
"RowLevelSecurity": {
"description": "Row level security policy to apply to the output data.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This Row Level Security unique name"
},
"description": {
"type": "string",
"description": "Description for this access policy"
},
"predicate": {
"type": "string",
"description": "The condition that goes to the WHERE clause and limit the visible rows."
},
"grants": {
"description": "user / groups / service accounts to which this security level is applied.\nex : user:[email protected],group:[email protected],serviceAccount:[email protected]",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["name", "grants"]
},
"AccessControlEntry": {
"description": "Column level security policy to apply to the attribute.",
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "This role to give to the granted users"
},
"grants": {
"description": "user / groups / service accounts to which this security level is applied.\nex : user:[email protected],group:[email protected],serviceAccount:[email protected]",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["role", "grants"]
},
"MergeOptions": {
"type": "object",
"properties": {
"key": {
"description": "list of attributes to join an existing and incoming dataset. Use renamed columns if any here.",
"type": "array",
"items": {
"type": "string"
}
},
"delete": {
"type": "string",
"description": "Optional valid delete condition on the incoming dataset. Use renamed column here."
},
"timestamp": {
"type": "string",
"description": "Timestamp column used to identify last version, if not specified currently ingested row is considered the last"
},
"queryFilter": {
"type": "string",
"description": "Useful when you want to merge only on a subset of the existing partitions, thus improving performance and reducing costs.\nYou may use here:\n- Any SQL condition\n- latest which will be translated to the last existing partition\n- column in last(10) which will apply the merge on the last 10 partitions of your dataset.\n last and latest assume that your table is partitioned by day."
}
},
"required": ["key"]
},
"Format": {
"description": "DSV by default. Supported file formats are :\\n- DSV : Delimiter-separated values file. Delimiter value is specified in the \"separator\" field.\\n- POSITION : FIXED format file where values are located at an exact position in each line.\\n- SIMPLE_JSON : For optimisation purpose, we differentiate JSON with top level values from JSON\\n with deep level fields. SIMPLE_JSON are JSON files with top level fields only.\\n- JSON : Deep JSON file. Use only when your json documents contain sub-documents, otherwise prefer to\\n use SIMPLE_JSON since it is much faster.\\n- XML : XML files",
"type": "string",
"oneOf": [
{
"const": "DSV",
"description": "any single or multiple character delimited file. Separator is specified in the separator field"
},
{
"const": "POSITION",
"description": "any fixed position file. Positions are specified in the position field"
},
{
"const": "JSON",
"description": "any deep json file.\nTo improve performance, prefer the SIMPLE_JSON format if your json documents are flat"
},
{
"const": "ARRAY_JSON",
"description": "any json file containing an array of json objects."
},
{
"const": "SIMPLE_JSON",
"description": "any flat json file.\nTo improve performance, prefer this format if your json documents are flat"
},
{
"const": "XML",
"description": "any xml file. Use the metadata.xml.rowTag field to specify the root tag of your xml file"
}
]
},
"MapString": {
"type": "object",
"description": "Map of string",
"additionalProperties": {
"type": "string"
}
},
"MapConnection": {
"type": "object",
"description": "Map of connections",
"additionalProperties": {
"$ref": "#/definitions/Connection"
}
},
"MapJdbcEngine": {
"type": "object",
"description": "Map of jdbc engines",
"additionalProperties": {
"$ref": "#/definitions/JdbcEngine"
}
},
"MapTableDdl": {
"type": "object",
"description": "Map of table ddl",
"additionalProperties": {
"$ref": "#/definitions/TableDdl"
}
},
"JdbcEngine": {
"type": "object",
"description": "Jdbc engine",
"properties": {
"tables": {
"description": "List of all SQL create statements used to create audit tables for this JDBC engine.\nTables are created only if the execution of the pingSQL statement fails",
"type": "array",
"items": {
"$ref": "#/definitions/MapTableDdl"
}
}
}
},
"Privacy": {
"type": "object",
"properties": {
"options": {
"description": "Privacy strategies. The following default strategies are defined by default:\n- none: Leave the data as is\n- hide: replace the data with an empty string\n- hideX(\"s\", n): replace the string with n occurrences of the string 's'\n- md5: Redact the data using the MD5 algorithm\n- sha1: Redact the data using the SHA1 algorithm\n- sha256: Redact the data using the SHA256 algorithm\n - sha512: Redact the data using the SHA512 algorithm\n- initials: keep only the first char of each word in the data",
"$ref": "#/definitions/MapString"
}
}
},
"Internal": {
"type": "object",
"description": "configure Spark internal options",
"properties": {
"cacheStorageLevel": {
"description": "How the RDD are cached. Default is MEMORY_AND_DISK_SER.\nAvailable options are (https://spark.apache.org/docs/latest/api/java/index.html?org/apache/spark/storage/StorageLevel.html):\n- MEMORY_ONLY\n- MEMORY_AND_DISK\n- MEMORY_ONLY_SER\n- MEMORY_AND_DISK_SER\n- DISK_ONLY\n- OFF_HEAP",
"type": "string"
},
"intermediateBigqueryFormat": {
"description": "May be parquet or ORC. Default is parquet. Used for BigQuery intermediate storage. Use ORC for for JSON files to keep the original data structure.\nhttps://stackoverflow.com/questions/53674838/spark-writing-parquet-arraystring-converts-to-a-different-datatype-when-loadin",
"type": "string"
},
"temporaryGcsBucket": {
"description": "The GCS bucket that temporarily holds the data before it is loaded to BigQuery.",
"type": "string"
},
"substituteVars": {
"description": "Internal use. Do not modify.",
"type": "boolean"
}
}
},
"AccessPolicies": {
"type": "object",
"properties": {
"apply": {
"description": "Should access policies be enforced ?",
"type": "boolean"
},
"location": {
"description": "GCP project location. Required if apply is true.",
"type": "string"
},
"database": {
"description": "GCP Project id. Required if apply is true.",
"type": "string"
},
"taxonomy": {
"description": "Taxonomy name. Required if apply is true.",
"type": "string"
}
}
},
"JobScheduling": {
"type": "object",
"properties": {
"maxJobs": {
"description": "Max number of Spark jobs to run in parallel, default is 1",
"type": "integer"
},
"poolName": {
"description": "Pool name to use for Spark jobs, default is 'default'",
"type": "string"
},
"mode": {
"description": "This can be FIFO or FAIR, to control whether jobs within the pool queue up behind each other (the default) or share the pool’s resources fairly.",
"type": "string"
},
"file": {
"description": "Scheduler filename in the metadata folder. If not set, defaults to fairscheduler.xml.",
"type": "string"
}
}
},
"Expectations": {
"type": "object",
"properties": {
"path": {
"description": "When using filesystem storage, the path to the expectations file",
"type": "string"
},
"active": {
"description": "should expectations be executed ?",
"type": "boolean"
}
}
},
"Metrics": {
"type": "object",
"properties": {
"path": {
"description": "When using filesystem storage, the path to the metrics file",
"type": "string"
},
"discreteMaxCardinality": {
"description": "Max number of unique values accepted for a discrete column. Default is 10",
"type": "integer"
},
"active": {
"description": "Should metrics be computed ?",
"type": "boolean"
}
}
},
"Sink": {
"type": "object",
"properties": {
"options": {
"$ref": "#/definitions/MapString",
"description": "spark options to use"
},
"id": {
"type": "string",
"description": "ES: Attribute to use as id of the document. Generated by Elasticsearch if not specified."
},
"timestamp": {
"type": "string",
"description": "ES or BQ: The timestamp column to use for table partitioning if any. No partitioning by default\\nES:Timestamp field format as expected by Elasticsearch (\"{beginTs|yyyy.MM.dd}\" for example)."
},
"location": {
"type": "string",
"description": "BQ: Database location (EU, US, ...)"
},
"clustering": {
"description": "FS or BQ: List of attributes to use for clustering",
"type": "array",
"items": {
"type": "string"
}
},
"days": {
"type": "number",
"description": "BQ: Number of days before this table is set as expired and deleted. Never by default."
},
"requirePartitionFilter": {
"type": "boolean",
"description": "BQ: Should be require a partition filter on every request ? No by default."
},
"materializedView": {
"type": "boolean",
"description": "BQ: Should we materialize as a table or as a view when saving the results ? false by default."
},
"enableRefresh": {
"type": "boolean",
"description": "BQ: Enable automatic refresh of materialized view ? false by default."
},
"refreshIntervalMs": {
"type": "number",
"description": "BQ: Refresh interval in milliseconds. Default to BigQuery default value"
},
"format": {
"type": "string",
"description": "FS: File format"
},
"extension": {
"type": "string",
"description": "FS: File extension"
},
"partition": {
"$ref": "#/definitions/Partition",
"description": "FS or BQ: List of partition attributes"
},
"connectionRef": {
"type": "string",
"description": "JDBC: Connection String"
},
"coalesce": {
"type": "boolean",
"description": "When outputting files, should we coalesce it to a single file. Useful when CSV is the output format."
}
}
},
"MapArrayOfString": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Metadata": {
"type": "object",
"properties": {
"format": {
"$ref": "#/definitions/Format"
},
"encoding": {
"type": "string",
"description": "UTF-8 if not specified."
},
"multiline": {
"type": "boolean",
"description": "are json objects on a single line or multiple line ? Single by default. false means single. false also means faster"
},
"array": {
"type": "boolean",
"description": "Is the json stored as a single object array ? false by default. This means that by default we have on json document per line."
},
"withHeader": {
"type": "boolean",
"description": "does the dataset has a header ? true bu default"
},
"separator": {
"type": "string",
"description": "the values delimiter, ';' by default value may be a multichar string starting from Spark3"
},
"quote": {
"type": "string",
"description": "The String quote char, '\"' by default"
},
"escape": {
"type": "string",
"description": "escaping char '\\' by default"
},
"write": {
"$ref": "#/definitions/WriteMode",
"description": "Write mode, APPEND by default"
},
"partition": {
"$ref": "#/definitions/Partition"
},
"sink": {
"$ref": "#/definitions/Sink"
},
"ignore": {
"type": "string",
"description": "Pattern to ignore or UDF to apply to ignore some lines"
},
"xml": {
"$ref": "#/definitions/MapString",
"description": "com.databricks.spark.xml options to use (eq. rowTag)"
},
"directory": {
"description": "Folder on the local filesystem where incoming files are stored.\n Typically, this folder will be scanned periodically to move the dataset to the cluster for ingestion.\n Files located in this folder are moved to the pending folder for ingestion by the \"import\" command.",
"type": "string"
},
"extensions": {
"type": "array",
"items": {
"type": "string"
},
"description": "recognized filename extensions. json, csv, dsv, psv are recognized by default.\nOnly files with these extensions will be moved to the pending folder."
},
"ack": {
"description": "Ack extension used for each file. \".ack\" if not specified.\nFiles are moved to the pending folder only once a file with the same name as the source file and with this extension is present.\nTo move a file without requiring an ack file to be present, set explicitly this property to the empty string value \"\".",
"type": "string"
},
"options": {
"$ref": "#/definitions/MapString",
"description": "Options to add to the spark reader"
},
"validator": {
"description": "Validator to use, 'spark' or 'native'. Default to 'spark' of SL_VALIDATOR env variable is set to 'native'",
"type": "string"
},
"emptyIsNull": {
"description": "Treat empty columns as null in DSV files. Default to false",
"type": "boolean"
},
"nullValue": {
"description": "Treat a specific input string as a null value indicator",
"type": "string"
},
"freshness": {
"description": "Configure freshness checks on this dataset",
"$ref": "#/definitions/Freshness"
},
"schedule": {
"type": "string",
"description": "Cron expression to use for this domain/table"
},
"dagRef": {
"type": "string",
"description": "Cron expression to use for this domain/table"
}
}
},
"ExternalDomain": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema in JDBC Database / Snowflake / Redshift or Dataset in BigQuery"
},
"tables": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tables to scan in this domain"
}
}
},
"Airflow": {
"type": "object",
"properties": {
"endpoint": {
"type": "string",
"description": "DAG reference"
},
"ingest": {
"type": "string",
"description": "Cron expression to use for this domain/table"
}
}
},
"External": {
"type": "object",
"properties": {
"database": {
"type": "string",
"description": "Database name of Project id in BigQuery"
},
"external": {
"description": "List of domains to scan",
"type": "array",
"items": {
"$ref": "#/definitions/ExternalDomain"
}
}
}
},
"Area": {
"type": "object",
"properties": {
"pending": {
"type": "string",
"description": "Files recognized by the extensions property are moved to this folder for ingestion by the \"import\" command."
},
"unresolved": {
"description": "Files that cannot be ingested (do not match by any table pattern) are moved to this folder.",
"type": "string"
},
"archive": {
"description": "Files that have been ingested are moved to this folder if SL_ARCHIVE is set to true.",
"type": "string"
},
"ingesting": {
"description": "Files that are being ingested are moved to this folder.",
"type": "string"
},
"accepted": {
"description": "When filesystem storage is used, successfully ingested stored in this this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.",
"type": "string"
},
"rejected": {
"description": "When filesystem storage is used, rejected records are stored in this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.",
"type": "string"
},
"replay": {
"description": "Invalid records are stored in this folder in source format when SL_SINK_REPLAY_TO_FILE is set to true.",
"type": "string"
},
"business": {
"description": "",
"type": "string"
},
"hiveDatabase": {
"description": "",
"type": "string"
}
}
},
"Freshness": {
"type": "object",
"properties": {
"warn": {
"type": "string",
"description": "How old may be teh data before a warning is raised. Use syntax like '3 day' or '2 hour' or '30 minute'"
},
"error": {
"type": "string",
"description": "How old may be teh data before an error is raised. Use syntax like '3 day' or '2 hour' or '30 minute'"
}
}
},
"Table": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Schema name, must be unique among all the schemas belonging to the same domain.\n * Will become the hive table name On Premise or BigQuery Table name on GCP."
},
"rename": {
"type": "string",
"description": "If present, the table is renamed with this name. Useful when use in conjunction with the 'extract' module"
},
"pattern": {
"description": "filename pattern to which this schema must be applied.\n * This instructs the framework to use this schema to parse any file with a filename that match this pattern.",
"type": "string"
},
"attributes": {
"description": "Attributes parsing rules.",
"type": "array",
"items": {
"$ref": "#/definitions/Attribute"
}
},
"metadata": {
"$ref": "#/definitions/Metadata",
"description": "Dataset metadata"
},
"merge": {
"$ref": "#/definitions/MergeOptions"
},
"comment": {
"type": "string",
"description": "free text"
},
"presql": {
"type": "array",
"description": "Reserved for future use.",
"items": {
"type": "string"
}
},
"postsql": {
"type": "array",
"description": "Reserved for future use.",
"items": {
"type": "string"
}
},
"tags": {
"description": "Set of string to attach to this Schema",
"type": "array",
"items": {
"type": "string"
}
},
"rls": {
"description": " Row level security on this schema.",
"type": "array",
"items": {
"$ref": "#/definitions/RowLevelSecurity"
}
},
"expectations": {
"$ref": "#/definitions/MapString",
"description": "Expectations to check after Load / Transform has succeeded"
},
"primaryKey": {
"description": "List of columns that make up the primary key",
"type": "array",
"items": {
"type": "string"
}
},
"acl": {
"description": "Map of rolename -> List[Users].",
"type": "array",
"items": {
"$ref": "#/definitions/AccessControlEntry"
}
},
"sample": {
"description": "Store here a couple of records illustrating the table data.",
"type": "string"
},
"filter": {
"description": "remove all records that do not match this condition",
"type": "string"
},
"patternSample": {
"description": "Sample of filename matching this schema",
"type": "string"
}
},
"required": ["name", "pattern"]
},
"Attribute": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Attribute name as defined in the source dataset and as received in the file"
},
"type": {
"type": "string",
"description": "semantic type of the attribute"
},
"array": {
"type": "boolean",
"description": "Is it an array ?"
},
"required": {
"type": "boolean",
"description": "Should this attribute always be present in the source"
},
"privacy": {
"type": "string",
"description": "Should this attribute be applied a privacy transformation at ingestion time"
},
"comment": {
"type": "string",
"description": "free text for attribute description"
},
"rename": {
"type": "string",
"description": "If present, the attribute is renamed with this name"
},
"metricType": {
"type": "string",
"description": "If present, what kind of stat should be computed for this field"
},
"attributes": {
"type": "array",
"description": "List of sub-attributes (valid for JSON and XML files only)",
"items": {
"$ref": "#/definitions/Attribute"
}
},
"position": {
"$ref": "#/definitions/Position"
},
"default": {
"type": "string",
"description": "Default value for this attribute when it is not present."
},
"tags": {
"type": "array",
"description": "Tags associated with this attribute",
"items": {
"type": "string"
}
},
"trim": {
"$ref": "#/definitions/Trim"
},
"script": {
"type": "string",
"description": "Scripted field : SQL request on renamed column"
},
"foreignKey": {
"type": "string",
"description": "If this attribute is a foreign key, reference to [domain.]table[.attribute]"
},
"ignore": {
"type": "boolean",
"description": "Should this attribute be ignored on ingestion. Default to false"
},
"accessPolicy": {
"type": "string",
"description": "Policy tag to assign to this attribute. Used for column level security"
}
},
"required": ["name", "type"]
},
"AutoTaskDesc": {
"type": "object",
"properties": {
"sql": {
"type": "string",
"description": "Main SQL request to execute (do not forget to prefix table names with the database name to avoid conflicts)"
},
"database": {
"type": "string",
"description": "Output Database (refer to a project id in BigQuery). Default to SL_DATABASE env var if set."
},
"domain": {
"type": "string",
"description": "Output domain in output Area (Will be the Database name in Hive or Dataset in BigQuery)"
},
"table": {
"type": "string",
"description": "Dataset Name in output Area (Will be the Table name in Hive & BigQuery)"
},
"write": {
"$ref": "#/definitions/WriteMode"
},
"partition": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of columns used for partitioning the output."
},
"presql": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of SQL requests to executed before the main SQL request is run"
},
"postsql": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of SQL requests to executed after the main SQL request is run"
},
"sink": {
"$ref": "#/definitions/Sink"
},
"rls": {
"type": "array",
"items": {
"$ref": "#/definitions/RowLevelSecurity"
}
},
"expectations": {
"$ref": "#/definitions/MapString",
"description": "Expectations to check after Load / Transform has succeeded"
},
"acl": {
"description": "Map of rolename -> List[Users].",
"type": "array",
"items": {
"$ref": "#/definitions/AccessControlEntry"
}
},
"comment": {
"type": "string",
"description": "Output table description"
},
"freshness": {
"description": "Configure freshness checks on the output table",
"$ref": "#/definitions/Freshness"
},
"attributesDesc": {
"description": "Attributes comments and access policies",
"type": "array",
"items": {
"$ref": "#/definitions/AttributeDesc"
}
},
"python": {
"type": "string",
"description": "Python script URI to execute instead of the SQL request"
},
"tags": {
"description": "Set of string to attach to the output table",
"type": "array",
"items": {
"type": "string"
}
},
"merge": {
"$ref": "#/definitions/MergeOptions"
},
"schedule": {
"type": "string",
"description": "Cron expression to use for this task"
},
"dagRef": {
"type": "string",
"description": "Cron expression to use for this domain/table"
}
},
"required": []
},
"Lock": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Name of the lock"
},
"timeout": {
"type": "integer",
"description": "Name of the lock"
},
"pollTime": {
"type": "string",
"description": "Name of the lock"
},
"refreshTime": {
"type": "string",
"description": "Name of the lock"
}
}
},
"Audit": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Main SQL request to execute (do not forget to prefix table names with the database name to avoid conflicts)"
},
"sink": {
"$ref": "#/definitions/Sink",
"description": "Output Database (refer to a project id in BigQuery). Default to SL_DATABASE env var if set."
},
"maxErrors": {
"type": "string",
"description": "Output domain in output Area (Will be the Database name in Hive or Dataset in BigQuery)"
},
"database": {
"type": "string",
"description": "Dataset Name in output Area (Will be the Table name in Hive & BigQuery)"
},
"domain": {
"$ref": "#/definitions/WriteMode"
},
"active": {
"type": "boolean",
"description": "Output table description"
}
},
"required": []
},
"AttributeDesc": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Column name"
},
"comment": {
"type": "string",
"description": "Column description"
},
"accessPolicy": {
"type": "string",
"description": "Access policy to apply to this column"
}
},
"required": ["name", "comment"]
},
"Domain": {
"type": "object",
"description": "A schema in JDBC database or a folder in HDFS or a dataset in BigQuery.",
"properties": {
"name": {
"type": "string",
"description": "Domain name. Make sure you use a name that may be used as a folder name on the target storage.\n - When using HDFS or Cloud Storage, files once ingested are stored in a sub-directory named after the domain name.\n - When used with BigQuery, files are ingested and sorted in tables under a dataset named after the domain name."
},
"rename": {
"type": "string",
"description": "If present, the attribute is renamed with this name"
},
"metadata": {
"$ref": "#/definitions/Metadata"
},
"tables": {
"type": "array",
"description": "List of schemas for each dataset in this domain.\nA domain usually contains multiple schemas. Each schema defining how the contents of the input file should be parsed.\nSee Schema for more details.",
"items": {
"$ref": "#/definitions/Table"
}
},
"comment": {
"description": "Domain Description (free text)",
"type": "string"
},
"database": {
"description": "Output Database (refer to a project id in BigQuery). Default to SL_DATABASE env var if set.",
"type": "string"
},
"tags": {
"description": "Set of string to attach to this domain",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AutoJobDesc": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Optional name. If not specified, the name of the file without the extension is used."
},
"default": {
"$ref": "#/definitions/AutoTaskDesc",
"description": "Default task properties to apply to all tasks defined in tasks section and in included files"
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/definitions/AutoTaskDesc",
"description": "List of transform tasks to execute"
}
}
}
},
"JDBCTable": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "table name. Set to '*' to extract all tables"
},
"columns": {
"description": "List of columns to extract. All columns by default.",
"type": "array",
"items": {
"type": "string"
}
},
"partitionColumn": {
"type": "string"
},
"numPartitions": {
"type": "integer"
},
"connectionOptions": {
"type": "string"
},
"fetchSize": {
"type": "integer"
},
"fullExport": {
"type": "boolean"
}
},
"required": ["name"]
},
"JDBCSchema": {
"type": "object",
"properties": {
"catalog": {
"type": "string",
"description": "Optional catalog name in the source database"
},
"schema": {
"type": "string",
"description": "Database schema where source tables are located"
},
"write": {
"$ref": "#/definitions/WriteMode"
},
"pattern": {
"type": "string"
},
"numericTrim": {
"$ref": "#/definitions/Trim"
},
"partitionColumn": {
"type": "string"
},
"numPartitions": {
"type": "integer"
},
"connectionOptions": {
"type": "string"
},
"fetchSize": {
"type": "integer"
},
"stringPartitionFunc": {
"type": "string"
},
"fullExport": {
"type": "boolean"
},
"tableRemarks": {
"type": "string"
},
"columnRemarks": {
"type": "string"
},
"template": {
"type": "string",
"description": "Metadata to use for the generated YAML file."
},
"tables": {
"description": "List of tables to extract",
"type": "array",
"items": {
"$ref": "#/definitions/JDBCTable"
}
},
"tableTypes": {
"description": "One or many of the predefined table types",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["tables"]
},
"JDBCSchemas": {
"type": "object",
"properties": {
"jdbcSchemas": {
"description": "List database connections to use to extract the data",
"type": "array",
"items": {
"$ref": "#/definitions/JDBCSchema"
}
},
"globalJdbcSchema": {
"$ref": "#/definitions/JDBCSchema"
},
"fetchSize": {
"type": "integer"
},
"connectionRef": {
"type": "string",
"description": "Connection name as defined in the connections section of the application.conf file"
},
"connection": {
"$ref": "#/definitions/MapString",
"description": "JDBC connection options: url, user, password ..."
}
}
},
"RefInput": {
"description": "Input for ref object",
"type": "object",
"properties": {
"database": {
"type": "string",
"description": "Database pattern to match, none if any database"
},
"domain": {
"type": "string",
"description": "Domain pattern to match, none if any domain match"
},
"table": {
"type": "string",
"description": "Table pattern to match"
}
},
"required": ["table"]
},
"RefOutput": {
"description": "Output for ref object",
"type": "object",
"properties": {
"database": {
"type": "string",
"description": ""
},
"domain": {
"type": "string",
"description": ""
},
"table": {
"type": "string",
"description": ""
}
},
"required": ["table", "domain", "database"]
},
"Ref": {
"description": "Describe how to resolve a reference in a transform task",
"type": "object",
"properties": {
"input": {
"$ref": "#/definitions/RefInput",
"description": "The input table to resolve"
},
"output": {
"$ref": "#/definitions/RefOutput",
"description": "The output table resolved with the domain and database"
}
},
"required": ["input", "output"]
},
"Refs": {
"type": "array",
"items": {
"$ref": "#/definitions/Ref"
}
},
"Application": {
"type": "object",
"properties": {
"env": {
"type": "string",
"description": "Default environment to use. May be also set using the SL_ENV environment variable"
},
"datasets": {
"type": "string",
"description": "When using filesystem storage, default path to store the datasets"
},
"dags": {
"type": "string",
"description": ""
},
"metadata": {
"type": "string",
"description": "default metadata folder name. May be also set using the SL_METADATA environment variable"
},
"metrics": {
"$ref": "#/definitions/Metrics"
},
"validateOnLoad": {
"type": "boolean",
"description": "Validate the YAML file when loading it. If set to true fails on any error"
},
"audit": {
"$ref": "#/definitions/Audit"
},
"archive": {
"type": "boolean",
"description": "Should ingested files be archived after ingestion ?"
},
"sinkReplayToFile": {
"type": "boolean",
"description": "Should invalid records be stored in a replay file ?"
},
"lock": {
"$ref": "#/definitions/Lock"
},
"defaultFormat": {
"type": "string",
"description": "Default write format in Spark. parquet is the default"
},
"defaultRejectedWriteFormat": {
"type": "string",
"description": "Default write format in Spark for rejected records. parquet is the default"
},
"defaultAuditWriteFormat": {
"type": "string",
"description": "Default write format in Spark for audit records. parquet is the default"
},
"csvOutput": {
"type": "boolean",
"description": "output files in CSV format ? Default is false"
},
"csvOutputExt": {
"type": "string",
"description": "CSV file extension when csvOutput is true. Default is .csv"
},
"privacyOnly": {
"type": "boolean",
"description": "Only generate privacy tasks. Reserved for internal use"
},
"emptyIsNull": {
"type": "boolean",
"description": "Should empty strings be considered as null values ?"
},
"validator": {
"type": "string",
"description": "Default validator to use when none is specified in the schema. Valid values are 'spark' or 'native'. Default is 'spark'"
},
"rowValidatorClass": {
"type": "string",
"description": ""
},
"treeValidatorClass": {
"type": "string",
"description": ""
},
"loadStrategyClass": {
"type": "string",
"description": "In what order should the files for a same table be loaded ? By time (default) or by or name ?\n",
"enum": [
"ai.starlake.job.load.IngestionNameStrategy",
"ai.starlake.job.load.IngestionTimeStrategy"
]
},
"analyze": {
"type": "boolean",
"description": "Should we analyze the result and generate HIVE statistics ? (useful for Spark / Databricks) "
},
"hive": {
"type": "boolean",
"description": "Should we create the table in Hive ? (useful for Spark / Databricks) "
},
"grouped": {
"type": "boolean",
"description": "Should we load of the files to be stored in the same table in a single task or one by one ?"
},
"groupedMax": {
"type": "integer",
"description": "Maximum number of files to be stored in the same table in a single task"
},
"mergeForceDistinct": {
"type": "boolean",
"description": "Should we force a distinct on the merge ?"
},
"mergeOptimizePartitionWrite": {
"type": "boolean",
"description": "Should we optimize the partition write on the merge ?"
},
"area": {
"$ref": "#/definitions/Area",
"description": "pending, accepted ... areas configuration"
},
"airflow": {
"$ref": "#/definitions/Airflow",
"description": "Airflow endpoint configuration when using Airflow Launcher"
},
"hadoop": {
"$ref": "#/definitions/MapString",
"description": "Hadoop configuration if applicable"
},
"connections": {
"$ref": "#/definitions/MapConnection",
"description": "Connection configurations"
},
"jdbcEngines": {
"$ref": "#/definitions/MapJdbcEngine",
"description": "JDBC engine configurations"
},
"privacy": {
"$ref": "#/definitions/Privacy",
"description": "Privacy algorithms"
},
"root": {
"type": "string",
"description": "Root folder for the application. May be also set using the SL_ROOT environment variable"
},
"internal": {
"$ref": "#/definitions/Internal",
"description": "Internal configuration"
},
"accessPolicies": {
"$ref": "#/definitions/AccessPolicies",
"description": "Access policies configuration"
},
"scheduling": {
"$ref": "#/definitions/JobScheduling",
"description": "Spark Job scheduling configuration"
},
"udfs": {
"type": "string",
"description": "Coma separated list of UDF to register in Spark jobs. May be also set using the SL_UDFS environment variable"
},
"expectations": {
"$ref": "#/definitions/Expectations",
"description": "Expectations configuration"
},
"sqlParameterPattern": {
"type": "string",
"description": "Pattern to use to replace parameters in SQL queries in addition to the jinja syntax {{param}}. Default is ${param}"
},
"rejectAllOnError": {
"type": "string",
"description": "Should we reject all records when an error occurs ? Default is false"
},
"rejectMaxRecords": {
"type": "integer",
"description": "Maximum number of records to reject when an error occurs. Default is 100"
},
"maxParCopy": {
"type": "integer",
"description": ""
},
"dsvOptions": {
"$ref": "#/definitions/MapString",
"description": "DSV ingestion extra options"
},
"forceViewPattern": {
"type": "string",
"description": "reserved"
},
"forceDomainPattern": {
"type": "string",
"description": "reserved"
},
"forceTablePattern": {
"type": "string",
"description": "reserved"
},
"forceJobPattern": {
"type": "string",
"description": "reserved"
},
"forceTaskPattern": {
"type": "string",
"description": "reserved"
},
"useLocalFileSystem": {
"type": "string",
"description": "reserved"
},
"sessionDurationServe": {
"type": "integer",
"description": "reserved"
},
"database": {
"type": "string",
"description": "Default target database (projectId in GCP). May be also set using the SL_DATABASE environment variable"
},
"tenant": {
"type": "string",
"description": "reserved"
},
"connectionRef": {
"type": "string",
"description": "Default connection to use when loading / transforming data"
}
}
}
},
"description": "JSON Schema for Starlake Data Pipeline",
"oneOf": [
{
"required": ["extract"]
},
{
"required": ["load"]
},
{
"required": ["transform"]
},
{
"required": ["expectations"]
},
{
"required": ["env"]
},
{
"required": ["types"]
},
{
"required": ["tables"]
},
{
"required": ["table"]
},
{
"required": ["task"]
},
{
"required": ["connections"]
},
{
"required": ["external"]
},
{
"required": ["application"]
},
{
"required": ["refs"]
}
],
"properties": {
"types": {
"type": "array",
"items": {
"$ref": "#/definitions/Type"
}
},
"extract": {
"$ref": "#/definitions/JDBCSchemas"
},
"load": {
"$ref": "#/definitions/Domain"
},
"transform": {
"$ref": "#/definitions/AutoJobDesc"
},
"task": {
"$ref": "#/definitions/AutoTaskDesc"
},
"env": {
"$ref": "#/definitions/MapString"
},
"expectations": {
"$ref": "#/definitions/MapString",
"description": "Expectations library defined as a map name(params) -> sql request that should return 0 record"
},
"table": {
"$ref": "#/definitions/Table"
},
"external": {
"$ref": "#/definitions/External"
},
"refs": {
"$ref": "#/definitions/Refs"
},
"application": {
"$ref": "#/definitions/Application"
}
},
"title": "Starlake Data Pipeline",
"type": "object"
}
|
har.json | {
"$id": "har.json#",
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"required": [
"log"
],
"properties": {
"log": {
"$ref": "log.json#"
}
}
}
|
imageoptimizer.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for imageoptimizer.json files",
"id": "https://json.schemastore.org/imageoptimizer.json",
"properties": {
"optimizations": {
"description": "An array of optimization rules",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": ["includes"],
"properties": {
"includes": {
"description": "An array of globbing patterns of files/folders to include in the optimization",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"excludes": {
"description": "An array of globbing patterns of files/folders to exclude in the optimization",
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": ["node_modules", "bower_components", "jspm_packages"]
},
"lossy": {
"description": "When set to true, images are compressed a lot more but with a slight quality loss that may not be visible to the human eye.",
"type": "boolean",
"default": false
}
}
}
}
},
"type": "object"
}
|
project-1.0.0-beta6.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"compilationOptions": {
"type": "object",
"properties": {
"define": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"warningsAsErrors": {
"type": "boolean",
"default": false
},
"allowUnsafe": {
"type": "boolean",
"default": false
},
"optimize": {
"type": "boolean",
"default": false
},
"languageVersion": {
"type": "string",
"enum": [
"csharp1",
"csharp2",
"csharp3",
"csharp4",
"csharp5",
"csharp6",
"experimental"
]
},
"keyFile": {
"type": "string"
},
"delaySign": {
"type": "boolean",
"default": false
},
"strongName": {
"type": "boolean",
"default": false
}
}
},
"configType": {
"type": "object",
"properties": {
"dependencies": {
"$ref": "#/definitions/dependencies"
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"frameworkAssemblies": {
"$ref": "#/definitions/dependencies"
}
}
},
"dependencies": {
"type": "object",
"additionalProperties": {
"type": ["string", "object"],
"properties": {
"version": {
"type": "string"
},
"type": {
"type": "string",
"default": "default",
"enum": ["default", "build"]
}
}
}
},
"script": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "A command line script or scripts.\r\rAvailable variables:\r%project:Directory% - The project directory\r%project:Name% - The project name\r%project:Version% - The project version"
}
},
"id": "https://json.schemastore.org/project-1.0.0-beta6.json",
"properties": {
"authors": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"bundleExclude": {
"description": "List of files to exclude from publish output (kpm bundle).",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ""
},
"code": {
"description": "Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ \"Folder1\\*.cs\", \"Folder2\\*.cs\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**\\*.cs"
},
"commands": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"configurations": {
"type": "object",
"description": "Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.",
"additionalProperties": {
"type": "object",
"properties": {
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
}
}
}
},
"dependencies": {
"$ref": "#/definitions/dependencies"
},
"copyright": {
"description": "Copyright details for the package",
"type": "string"
},
"iconUrl": {
"description": "A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.",
"type": "string"
},
"licenseUrl": {
"description": "A link to the license that the package is under",
"type": "string"
},
"requireLicenseAcceptance": {
"description": "A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.",
"type": "boolean",
"default": false
},
"owners": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"projectUrl": {
"description": "A URL for the home page of the package",
"type": "string"
},
"summary": {
"description": "A short description of the package",
"type": "string"
},
"tags": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"title": {
"description": "The human-friendly title of the package",
"type": "string"
},
"releaseNotes": {
"description": "A description of the changes made in each release of the package.",
"type": "string"
},
"language": {
"description": "The locale ID for the package, such as en-us.",
"type": "string"
},
"description": {
"description": "The description of the application",
"type": "string"
},
"exclude": {
"description": "Glob pattern to indicate all the code files to be excluded from compilation. (data type: string or array with glob pattern(s)).",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["bin/**/*.*", "obj/**/*.*"]
},
"frameworks": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configType"
}
},
"namedResource": {
"type": "object",
"description": "Overrides the generated resource names with custom ones.",
"additionalProperties": {
"type": "string"
}
},
"preprocess": {
"description": "Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).",
"type": "string",
"default": "Compiler\\Preprocess\\**\\*.cs"
},
"repository": {
"type": "object",
"description": "Contains information about the repository where the project is stored.",
"properties": {
"type": {
"type": "string",
"enum": ["git"],
"default": "git"
}
},
"additionalProperties": {
"type": "string"
}
},
"resources": {
"description": "Glob pattern to indicate all the files that need to be compiled as resources.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "Compiler\\Resources\\**\\*.cs"
},
"scripts": {
"type": "object",
"description": "Scripts to execute during the various stages.",
"properties": {
"prepack": {
"$ref": "#/definitions/script"
},
"postpack": {
"$ref": "#/definitions/script"
},
"prebundle": {
"$ref": "#/definitions/script"
},
"postbundle": {
"$ref": "#/definitions/script"
},
"prerestore": {
"$ref": "#/definitions/script"
},
"postrestore": {
"$ref": "#/definitions/script"
},
"prepare": {
"$ref": "#/definitions/script"
}
}
},
"shared": {
"description": "Glob pattern to specify the code files to share with dependent projects. Example: [ \"Folder1\\*.cs\", \"Folder2\\*.cs\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "Compiler\\Shared\\**\\*.cs"
},
"version": {
"description": "The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*",
"type": "string"
},
"webroot": {
"description": "Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.",
"type": "string"
}
},
"title": "JSON schema for ASP.NET project.json files",
"type": "object"
}
|
openfin.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://json.schemastore.org/openfin.json",
"properties": {
"appAssets": {
"description": "Set this object to co-deploy native apps along with your app.",
"type": "array",
"items": {
"additionalProperties": false,
"required": ["alias", "src", "version"],
"properties": {
"alias": {
"type": "string",
"description": "Name of the asset. The name will be used in launchExternalProcess to launch the asset."
},
"args": {
"type": "string",
"description": "The default command line arguments for the aforementioned target."
},
"src": {
"type": "string",
"description": "URL to a zip file containing the package files (executables, dlls, etc…)."
},
"target": {
"type": "string",
"description": "Specifies default executable to launch. This option can be overridden in launchExternalProcess."
},
"version": {
"type": "string",
"description": "Version of the package. To force new updates, increment the version."
}
}
}
},
"assets_url": {
"type": "string",
"description": "If an application specifies a valid \"assetsUrl\", then that \"assetsUrl\" will be used as the base portion of the URL instead of the OpenFin default, https://developer.openfin.co/release/."
},
"devtools_port": {
"type": "number",
"description": "You can access the Chromium development tools by navigating to the selected port, i.e.: http://localhost:9090."
},
"dialogSettings": {
"description": "An optional object to customize the appearance of the RVM progress dialog.",
"additionalProperties": false,
"properties": {
"bgColor": {
"type": "number",
"description": "Determines the color of the dialog. Color value is a decimal representation of a 32 bit number (A,R,G,B). For instance : FF00FF00 or 4278255360 is fully opaque green."
},
"logo": {
"type": "string",
"description": "Determines the logo or image in the progress dialog. The logo should be a semi-transparent PNG. 100×25 pixels."
},
"progressBarBgColor": {
"type": "number",
"description": "Determines the background color of the area where the progress bar is displayed."
},
"progressBarBorderColor": {
"type": "number",
"description": "Determines the border color of the progress bar."
},
"progressBarFillColor": {
"type": "number",
"description": "Determines the color of the progress bar."
},
"textColor": {
"type": "number",
"description": "Determines the color of the text displayed above the progress bar location."
}
}
},
"licenseKey": {
"type": "string",
"description": "A string used as a licensing identifier for each customer/contract (RVM 2.7+). The OpenFin team will generate this for your production app."
},
"runtime": {
"description": "Determines which runtime version the app will use.",
"additionalProperties": false,
"required": ["version"],
"properties": {
"arguments": {
"type": "string",
"description": "Command line arguments to set when launching the runtime. The OpenFin Runtime supports Chromium command line switches e.g.: \"– –disable-accelerated-compositing – –enable-threaded-compositing\" for a complete list of values please refer to current Chromium switches."
},
"fallbackVersion": {
"type": "string",
"description": "The RVM will fallback to this version if it fails to retrieve the desired Runtime version, assuming this version is already installed. (RVM 2.8+)"
},
"forceLatest": {
"type": "boolean",
"description": "If true, forces the runtime to always get the latest runtime version before launching (prevents background installs)."
},
"version": {
"type": "string",
"oneOf": [
{
"pattern": "(\\d{1,3}\\.){3}\\d{1,3}"
},
{
"enum": ["alpha", "beta", "canary", "stable", "staging"]
}
],
"description": "Specifies what version of the runtime the app should use. The value can either be a specific version or a release channel (e.g. alpha)."
}
}
},
"shortcut": {
"description": "Settings for the app's desktop shortcut",
"additionalProperties": false,
"required": ["company", "icon", "name"],
"properties": {
"company": {
"type": "string",
"description": "Company name for the application shortcut."
},
"description": {
"type": "string",
"description": "A short description of the application shortcut. Will be shown when hovering over the shortcut icon."
},
"force": {
"type": "boolean",
"description": "If set to true, a desktop icon is always created on application start-up (even when user has deleted it). If set to false, a desktop icon is created on initial application launch but not created on subsequent application launches."
},
"icon": {
"type": "string",
"description": "Location for the icon image to be used when installing the application shortcut."
},
"name": {
"type": "string",
"description": "Name of the application to display with the shortcut."
},
"startMenuRootFolder": {
"type": "string",
"description": "Set this value with a folder path (e.g. foo/bar) and the RVM will create the start menu shortcut under RootFolder/Company/App."
},
"target": {
"type": "array",
"items": {
"type": "string",
"enum": ["automatic-start-up", "desktop", "start-menu"]
},
"description": "Locations for where the application shortcut is added on the desktop owner's machine. Available options are \"desktop\", \"start-menu\" and \"automatic-start-up\". The default is start-menu and desktop."
},
"uninstall-shortcut": {
"type": "boolean",
"description": "Removes the Start menu uninstall shortcut."
}
}
},
"splashScreenImage": {
"type": "string",
"description": "You can specify an image to display while the runtime is loading. It takes any image file (including semi-transparent PNGs)."
},
"startup_app": {
"description": "Specifies the application level configuration.",
"additionalProperties": false,
"required": ["name", "url", "uuid"],
"properties": {
"accelerator": {
"description": "The name of this builder instance, which can be specified in the only/except property of a provisioner.",
"additionalProperties": false,
"properties": {
"devtools": {
"type": "boolean",
"description": "If true, allows the Dev Tools to be opened with the keyboard shortcut: Ctrl+Shift+i.",
"default": false
},
"reload": {
"type": "boolean",
"description": "If true, allows a window to reload with the keyboard shortcuts: Ctrl+r or F5.",
"default": false
},
"reloadIgnoreCache": {
"type": "boolean",
"description": "If true, allows a window to reload while ignoring the cache with the keyboard shortcuts: Ctrl+Shift or Shift+F5.",
"default": false
},
"zoom": {
"type": "boolean",
"description": "If true, enables the Zoom keyboard shortcuts: Ctrl+ (Zoom in), Ctrl- (Zoom out) and Ctrl+0 (Restore to 100%).",
"default": false
}
}
},
"alwaysOnTop": {
"type": "boolean",
"description": "A flag to always position the window at the top of the window stack.",
"default": false
},
"applicationIcon": {
"type": "string",
"description": "A URL for the icon to be shown in the window title bar."
},
"autoShow": {
"type": "boolean",
"description": "A flag to automatically show the Window when it is created.",
"default": false
},
"childWindowAutoAuth": {
"type": "boolean",
"description": "Allow non API created child windows, such as window.open, to authenticate.",
"default": true
},
"clearChildSubscriptionsOnReload": {
"type": "boolean",
"description": "Clear InterApplication subscriptions of all child windows when main window is reloaded.",
"default": true
},
"contextMenu": {
"type": "boolean",
"description": "A flag to show the context menu when right-clicking on a window. Gives access to the Developer Console for the Window.",
"default": true
},
"cornerRounding": {
"description": "This defines and applies rounded corners for the window.",
"additionalProperties": false,
"properties": {
"height": {
"type": "number",
"description": "This defines and applies rounded corners for the window."
},
"width": {
"type": "number",
"description": "This defines and applies rounded corners for the window."
}
}
},
"defaultCentered": {
"type": "boolean",
"description": "Specifies that the window will be positioned in the center of the primary monitor when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the position from before the window was closed is used.",
"default": false
},
"defaultHeight": {
"type": "number",
"description": "The default height of the window. Specifies the height of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the height is taken to be the last height of the window before it was closed.",
"default": 500
},
"defaultLeft": {
"type": "number",
"description": "The default left position of the window. Specifies the position of the left of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the value of left is taken to be the last value before the window was closed.",
"default": 10
},
"defaultTop": {
"type": "number",
"description": "The default top position of the window. Specifies the position of the top of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the value of top is taken to be the last value before the window was closed.",
"default": 10
},
"defaultWidth": {
"type": "number",
"description": "The default width of the window. Specifies the width of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the width is taken to be the last width of the window before it was closed.",
"default": 800
},
"description": {
"type": "string",
"description": "The name for the window which must be unique within the context of the invoking Application."
},
"frame": {
"type": "boolean",
"description": "A flag to show the frame.",
"default": true
},
"icon": {
"type": "string",
"description": "A URL for the icon to be shown in the window title bar."
},
"maxHeight": {
"type": "number",
"description": "The maximum height of a window. Will default to the OS defined value if set to -1.",
"default": -1
},
"maximizable": {
"type": "boolean",
"description": "A flag that lets the window be maximized.",
"default": true
},
"maxWidth": {
"type": "number",
"description": "The maximum width of a window. Will default to the OS defined value if set to -1.",
"default": -1
},
"minHeight": {
"type": "number",
"description": "The minimum height of a window."
},
"minWidth": {
"type": "number",
"description": "The minimum width of a window."
},
"name": {
"type": "string",
"description": "The name for the window which must be unique within the context of the invoking Application."
},
"nonPersistent": {
"type": "boolean",
"description": "A flag to configure the application as a non persistent. Runtime exits if there are no persistent apps running.",
"default": false
},
"opacity": {
"type": "number",
"description": "A flag that specifies how transparent the window will be. This value is clamped between 0.0 and 1.0.",
"default": 1
},
"permissions": {
"type": "object",
"description": "Enable secured APIs",
"properties": {
"ExternalWindow": {
"type": "object",
"properties": {
"wrap": {
"type": "boolean"
}
}
},
"System": {
"type": "object",
"properties": {
"downloadAsset": {
"type": "boolean"
},
"getAllExternalWindows": {
"type": "boolean"
},
"launchExternalProcess": {
"type": "boolean"
},
"readRegistryValue": {
"type": "boolean"
},
"terminateExternalProcess": {
"type": "boolean"
}
}
}
}
},
"preloadScripts": {
"type": "array",
"description": "An array of scripts to download and run before other scripts in the page.",
"items": {
"required": ["url"],
"properties": {
"url": {
"type": "string",
"description": "URL from which to fetch the script."
}
}
}
},
"resizable": {
"type": "boolean",
"description": "A flag to drop to allow the user to resize the window.",
"default": true
},
"resizeRegion": {
"description": "Define the attributes of the window's resize region.",
"additionalProperties": false,
"properties": {
"bottomRightCorner": {
"type": "number",
"description": "Defines a region in pixels of an additional square at the bottom right corner of a frameless window.",
"default": 4
},
"size": {
"type": "number",
"description": "Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.",
"default": 2
}
}
},
"saveWindowState": {
"type": "boolean",
"description": "A flag to cache the location of the window or not.",
"default": true
},
"showTaskbarIcon": {
"type": "boolean",
"description": "A flag to show the Window's icon in the taskbar.",
"default": true
},
"state": {
"type": "string",
"enum": ["maximized", "minimized", "normal"],
"description": "A string that sets the window to be \"minimized\", \"maximized\", or \"normal\" on creation.",
"default": "normal"
},
"taskbarIcon": {
"type": "string",
"description": "The URL of an icon to be shown on the desktop. Support formats: Portable Network Graphic (PNG); Size: 256 x 256."
},
"taskbarIconGroup": {
"type": "string",
"description": "Group your OpenFin apps in the Taskbar. v5.0+"
},
"url": {
"type": "string",
"description": "The URL of the window."
},
"uuid": {
"type": "string",
"description": "The UUID of the application, unique within the set of all other Applications running in OpenFin Runtime."
},
"waitForPageLoad": {
"type": "boolean",
"description": "When set to false, the page will render before the \"load\" event is fired on the window. Caution, when false you will see an initial empty white window.",
"default": true
}
}
},
"supportInformation": {
"description": "An optional object to customize error messages.",
"additionalProperties": false,
"required": ["company", "email", "product"],
"properties": {
"company": {
"type": "string",
"description": "Displays the company name in the title bar for the support error dialog that appears when an application fails to load."
},
"email": {
"type": "string",
"description": "Displays the email to contact in the support error dialog that appears when an application fails to load."
},
"enableErrorReporting": {
"type": "boolean",
"description": "To disable the error reporting feature, set this value to false.",
"default": true
},
"forwardErrorReports": {
"type": "boolean",
"description": "When set to true, prompts end users with a dialog when a deployment error occurs from within the RVM and enables them send along log files from their machine. Error reports are delivered to your email address set in supportInformation.",
"default": false
},
"product": {
"type": "string",
"description": "Displays the product name or application name in the support error dialog that appears when an application fails to load."
}
}
}
},
"required": ["runtime", "shortcut", "startup_app"],
"title": "JSON schema for OpenFin application configuration files"
}
|
azure-iot-edge-deployment-template-4.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"moduleSettings": {
"type": "object",
"required": ["image"],
"properties": {
"image": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleSettings/properties/image"
}
},
"patternProperties": {
"^(createoptions|createOptions)[0-9]*$": {
"$ref": "#/definitions/createOptions"
}
}
},
"createOptions": {
"type": ["object", "string"],
"contentMediaType": "application/json"
}
},
"id": "https://json.schemastore.org/azure-iot-edge-deployment-template-4.0.json",
"properties": {
"modulesContent": {
"type": "object",
"title": "The configuration for all the modules.",
"required": ["$edgeAgent"],
"properties": {
"$edgeAgent": {
"type": "object",
"title": "Configuration for the edgeAgent module",
"required": ["properties.desired"],
"properties": {
"properties.desired": {
"type": "object",
"required": [
"schemaVersion",
"runtime",
"systemModules",
"modules"
],
"properties": {
"schemaVersion": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/properties/$edgeAgent/properties/properties.desired/properties/schemaVersion"
},
"runtime": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/properties/$edgeAgent/properties/properties.desired/properties/runtime"
},
"systemModules": {
"type": "object",
"required": ["edgeAgent", "edgeHub"],
"properties": {
"edgeAgent": {
"type": "object",
"required": ["type", "settings"],
"properties": {
"type": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType"
},
"settings": {
"$ref": "#/definitions/moduleSettings"
},
"env": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env"
},
"imagePullPolicy": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy"
}
}
},
"edgeHub": {
"type": "object",
"title": "The Edgehub Schema",
"required": [
"type",
"settings",
"status",
"restartPolicy"
],
"properties": {
"type": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType"
},
"settings": {
"$ref": "#/definitions/moduleSettings"
},
"env": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env"
},
"status": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/status"
},
"restartPolicy": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/restartPolicy"
},
"imagePullPolicy": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy"
},
"startupOrder": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/startupOrder"
}
}
}
}
},
"modules": {
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": [
"type",
"status",
"restartPolicy",
"settings"
],
"properties": {
"version": {
"type": "string",
"examples": ["1.0"]
},
"type": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType"
},
"status": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/status"
},
"restartPolicy": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/restartPolicy"
},
"env": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env"
},
"settings": {
"$ref": "#/definitions/moduleSettings"
},
"imagePullPolicy": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy"
},
"startupOrder": {
"$ref": "https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/startupOrder"
}
}
}
}
}
}
}
}
},
"$edgeHub": {
"$ref": "https://json.schemastore.org/azure-iot-edgehub-deployment-1.2.json#/properties/$edgeHub"
}
}
}
},
"required": ["modulesContent"],
"title": "JSON schema for Azure IoT Edge Deployment Template version 4.0 (Edge Agent schema v1.1 + Edge Hub schema v1.2 )",
"type": "object"
}
|
stale.json | {
"$comment": "https://probot.github.io/apps/stale/",
"$ref": "#/definitions/configuration",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"configuration": {
"properties": {
"daysUntilStale": {
"title": "Days Until Stale",
"description": "Number of days of inactivity before an Issue or Pull Request becomes stale.",
"type": "number",
"default": 60
},
"daysUntilClose": {
"title": "Days Until Close",
"description": "Number of days of inactivity before an Issue or Pull Request with the stale label is closed.",
"type": ["integer", "boolean"],
"default": 7
},
"onlyLabels": {
"title": "Only Labels",
"description": "Only issues or pull requests with all of these labels are check if stale.",
"type": "array",
"items": {
"title": "Label",
"type": "string"
},
"default": []
},
"exemptLabels": {
"title": "Exempt Labels",
"description": "Issues or Pull Requests with these labels will never be considered stale.",
"type": "array",
"items": {
"title": "Label",
"type": "string"
},
"default": []
},
"exemptProjects": {
"title": "Exempt Projects",
"description": "Set to true to ignore issues in a milestone.",
"type": "boolean",
"default": false
},
"exemptAssignees": {
"title": "Exempt Assignees",
"description": "Set to true to ignore issues with an assignee.",
"type": "boolean",
"default": false
},
"staleLabel": {
"title": "Stale Label",
"description": "Label to use when marking as stale.",
"type": "string",
"default": "wontfix"
},
"markComment": {
"title": "Mark Comment",
"description": "Comment to post when marking as stale.",
"type": ["string", "boolean"],
"default": "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
},
"unmarkComment": {
"title": "Unmark Comment",
"description": "Comment to post when removing the stale label.",
"type": ["string", "boolean"]
},
"closeComment": {
"title": "Closed Comment",
"description": "Comment to post when closing a stale issue or pull request.",
"type": ["string", "boolean"]
},
"limitPerRun": {
"title": "Limit Per Run",
"description": "Limit the number of actions per hour.",
"type": "number",
"minimum": 1,
"maximum": 30,
"default": 30
},
"only": {
"title": "Only",
"description": "Limit to only issues or pulls requests.",
"enum": ["issues", "pulls"]
}
}
}
},
"description": "A GitHub app that closes abandoned issues and pull requests",
"id": "https://json.schemastore.org/stale.json",
"properties": {
"pulls": {
"title": "Pulls",
"description": "Specify configuration settings that are specific to pull requests.",
"$ref": "#/definitions/configuration"
},
"issues": {
"title": "Issues",
"description": "Specify configuration settings that are specific to issues.",
"$ref": "#/definitions/configuration"
}
},
"type": "object"
}
|
github-workflow-template-properties.json | {
"$comment": "https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization",
"$id": "https://json.schemastore.org/github-workflow-template-properties.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"name": {
"description": "A workflow template name\nhttps://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow",
"type": "string",
"minLength": 1,
"examples": ["Sample name"]
},
"description": {
"description": "A workflow template description\nhttps://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow",
"type": "string",
"minLength": 1,
"examples": ["Sample description"]
},
"iconName": {
"description": "A workflow template icon\nMust be the name of an SVG file, without the file name extension, stored in the workflow-templates directory\nhttps://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow",
"type": "string",
"minLength": 1,
"examples": ["Sample icon"]
},
"categories": {
"description": "A workflow category\nhttps://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"1C Enterprise",
"4D",
"ABAP CDS",
"ABAP",
"ABNF",
"AFDKO",
"AGS Script",
"AIDL",
"AL",
"AMPL",
"ANTLR",
"API Blueprint",
"APL",
"ASL",
"ASN.1",
"ASP.NET",
"ATS",
"ActionScript",
"Ada",
"Alloy",
"Alpine Abuild",
"Altium Designer",
"AngelScript",
"Ant Build System",
"ApacheConf",
"Apex",
"Apollo Guidance Computer",
"AppleScript",
"Arc",
"AsciiDoc",
"AspectJ",
"Assembly",
"Astro",
"Asymptote",
"Augeas",
"AutoHotkey",
"AutoIt",
"AutoIt3",
"AutoItScript",
"Avro IDL",
"Awk",
"BASIC",
"Ballerina",
"Batchfile",
"Beef",
"Befunge",
"BibTeX",
"Bicep",
"Bison",
"BitBake",
"Blade",
"BlitzBasic",
"BlitzMax",
"Boo",
"Boogie",
"Brainfuck",
"Brightscript",
"Browserslist",
"C",
"C#",
"C++",
"C-ObjDump",
"C2hs Haskell",
"CIL",
"CLIPS",
"CMake",
"COBOL",
"CODEOWNERS",
"COLLADA",
"CSON",
"CSS",
"CSV",
"CUE",
"CWeb",
"Cabal Config",
"Cabal",
"Cap'n Proto",
"Carto",
"CartoCSS",
"Ceylon",
"Chapel",
"Charity",
"ChucK",
"Cirru",
"Clarion",
"Classic ASP",
"Clean",
"Click",
"Clojure",
"Closure Templates",
"Cloud Firestore Security Rules",
"CoNLL",
"CoNLL-U",
"CoNLL-X",
"ColdFusion CFC",
"ColdFusion",
"Common Lisp",
"Common Workflow Language",
"Component Pascal",
"Containerfile",
"Cool",
"Coq",
"Cpp-ObjDump",
"Crystal",
"Csound Document",
"Csound Score",
"Csound",
"Cuda",
"Cue Sheet",
"Cycript",
"Cython",
"D-ObjDump",
"DIGITAL Command Language",
"DM",
"DTrace",
"Dafny",
"Darcs Patch",
"Dart",
"DataWeave",
"Dhall",
"Diff",
"Dlang",
"Dockerfile",
"Dogescript",
"Dylan",
"E",
"E-mail",
"EBNF",
"ECL",
"ECLiPSe",
"EJS",
"EQ",
"Eagle",
"Earthly",
"Easybuild",
"Ecere Projects",
"EditorConfig",
"Eiffel",
"Elixir",
"Elm",
"Emacs Lisp",
"EmberScript",
"Erlang",
"F#",
"F*",
"FIGfont",
"FIGlet Font",
"FLUX",
"Factor",
"Fancy",
"Fantom",
"Faust",
"Fennel",
"Filebench WML",
"Filterscript",
"Fluent",
"Formatted",
"Forth",
"Fortran Free Form",
"Fortran",
"FreeBasic",
"Frege",
"Futhark",
"G-code",
"GAML",
"GAMS",
"GAP",
"GCC Machine Description",
"GDB",
"GDScript",
"GEDCOM",
"GLSL",
"GN",
"Game Maker Language",
"Gemfile.lock",
"Genie",
"Genshi",
"Gentoo Eclass",
"Gerber Image",
"Gettext Catalog",
"Gherkin",
"Git Config",
"Glyph Bitmap Distribution Format",
"Glyph",
"Gnuplot",
"Go Checksums",
"Go Module",
"Go",
"Golo",
"Gosu",
"Grace",
"Gradle",
"Grammatical Framework",
"Graph Modeling Language",
"GraphQL",
"Graphviz (DOT)",
"Groovy Server Pages",
"Groovy",
"HAProxy",
"HCL",
"HTML",
"HTML+ECR",
"HTML+EEX",
"HTML+ERB",
"HTML+PHP",
"HTML+Razor",
"HTTP",
"HXML",
"Hack",
"Haml",
"Handlebars",
"Harbour",
"HashiCorp Configuration Language",
"Haskell",
"Haxe",
"HiveQL",
"HolyC",
"Hy",
"IDL",
"IGOR Pro",
"IPython Notebook",
"Idris",
"Ignore List",
"ImageJ Macro",
"Inform 7",
"Io",
"Ioke",
"Isabelle ROOT",
"Isabelle",
"J",
"JAR Manifest",
"JFlex",
"JSON with Comments",
"JSON",
"JSON5",
"JSONLD",
"JSONiq",
"Jasmin",
"Java Properties",
"Java Server Pages",
"Java",
"JavaScript",
"JavaScript+ERB",
"Jest Snapshot",
"Jinja",
"Jison Lex",
"Jison",
"Jolie",
"Jsonnet",
"Julia",
"Jupyter Notebook",
"Kaitai Struct",
"KakouneScript",
"KiCad Layout",
"KiCad Legacy Layout",
"KiCad Schematic",
"Kit",
"Kotlin",
"Kusto",
"LFE",
"LLVM",
"LOLCODE",
"LSL",
"LTspice Symbol",
"LabVIEW",
"Lark",
"Lasso",
"Lean",
"Less",
"Lex",
"LilyPond",
"Limbo",
"Linker Script",
"Linux Kernel Module",
"Liquid",
"Literate Agda",
"Literate CoffeeScript",
"Literate Haskell",
"LiveScript",
"Logos",
"Logtalk",
"LookML",
"LoomScript",
"Lua",
"M",
"M4",
"M4Sugar",
"MATLAB",
"MAXScript",
"MLIR",
"MQL4",
"MQL5",
"MTML",
"MUF",
"Macaulay2",
"Makefile",
"Mako",
"Markdown",
"Marko",
"Mathematica",
"Max",
"Mercury",
"Meson",
"Metal",
"Microsoft Developer Studio Project",
"Microsoft Visual Studio Solution",
"MiniD",
"Mirah",
"Modelica",
"Modula-2",
"Modula-3",
"Module Management System",
"Monkey",
"Moocode",
"MoonScript",
"Motoko",
"Motorola 68K Assembly",
"Muse",
"Myghty",
"NASL",
"NCL",
"NEON",
"NPM Config",
"NSIS",
"NWScript",
"Nearley",
"Nemerle",
"NeoSnippet",
"NetLinx",
"NetLinx+ERB",
"NetLogo",
"NewLisp",
"Nextflow",
"Nginx",
"Ninja",
"Nit",
"Nix",
"NumPy",
"Nunjucks",
"ObjDump",
"Object Data Instance Notation",
"ObjectScript",
"Objective-C",
"Objective-C++",
"Objective-J",
"Odin",
"Omgrofl",
"Opa",
"Opal",
"Open Policy Agent",
"OpenCL",
"OpenEdge ABL",
"OpenQASM",
"OpenRC runscript",
"OpenSCAD",
"OpenStep Property List",
"OpenType Feature File",
"Org",
"Ox",
"Oxygene",
"Oz",
"P4",
"PEG.js",
"PHP",
"PLpgSQL",
"POV-Ray SDL",
"Pan",
"Papyrus",
"Parrot Assembly",
"Parrot Internal Representation",
"Parrot",
"Pascal",
"Pawn",
"Pep8",
"Perl",
"Pickle",
"PicoLisp",
"PigLatin",
"Pike",
"PlantUML",
"Pod 6",
"Pod",
"PogoScript",
"Pony",
"PostCSS",
"PostScript",
"PowerShell",
"Prisma",
"Processing",
"Proguard",
"Prolog",
"Promela",
"Propeller Spin",
"Protocol Buffer",
"Protocol Buffers",
"Public Key",
"Pug",
"Puppet",
"Pure Data",
"PureBasic",
"PureScript",
"Python",
"Q#",
"QMake",
"Qt Script",
"Quake",
"R",
"RAML",
"RDoc",
"REALbasic",
"REXX",
"RMarkdown",
"RPC",
"RPM Spec",
"Racket",
"Ragel",
"Raw token data",
"ReScript",
"Readline Config",
"Reason",
"Rebol",
"Record Jar",
"Red",
"Redirect Rules",
"Regular Expression",
"RenderScript",
"Rich Text Format",
"Ring",
"Riot",
"RobotFramework",
"Roff",
"Rouge",
"Rscript",
"Ruby",
"Rust",
"SAS",
"SCSS",
"SELinux Kernel Policy Language",
"SELinux Policy",
"SMT",
"SPARQL",
"SQF",
"SQL",
"SQLPL",
"SRecode Template",
"SSH Config",
"STON",
"SVG",
"SWIG",
"Sage",
"SaltStack",
"Sass",
"Scala",
"Scaml",
"Scheme",
"Scilab",
"Self",
"ShaderLab",
"Shell",
"ShellCheck Config",
"Sieve",
"Singularity",
"Slash",
"Slice",
"Slim",
"SmPL",
"Smalltalk",
"SnipMate",
"Solidity",
"Soong",
"SourcePawn",
"Spline Font Database",
"Squirrel",
"Stan",
"Standard ML",
"Starlark",
"StringTemplate",
"Stylus",
"SubRip Text",
"SugarSS",
"SuperCollider",
"Svelte",
"Swift",
"SystemVerilog",
"TI Program",
"TLA",
"TOML",
"TSQL",
"TSV",
"TSX",
"TXL",
"Tcl",
"Tcsh",
"TeX",
"Tea",
"Terra",
"Texinfo",
"Text",
"TextMate Properties",
"Textile",
"Thrift",
"Turing",
"Turtle",
"Twig",
"Type Language",
"TypeScript",
"UltiSnip",
"UltiSnips",
"Unified Parallel C",
"Unity3D Asset",
"Unix Assembly",
"Uno",
"UnrealScript",
"Ur",
"Ur/Web",
"UrWeb",
"V",
"VBA",
"VCL",
"VHDL",
"Vala",
"Valve Data Format",
"Verilog",
"Vim Help File",
"Vim Script",
"Vim Snippet",
"Visual Basic .NET",
"Vue",
"Wavefront Material",
"Wavefront Object",
"Web Ontology Language",
"WebAssembly",
"WebVTT",
"Wget Config",
"Wikitext",
"Windows Registry Entries",
"Wollok",
"World of Warcraft Addon Data",
"X BitMap",
"X Font Directory Index",
"X PixMap",
"X10",
"XC",
"XCompose",
"XML Property List",
"XML",
"XPages",
"XProc",
"XQuery",
"XS",
"XSLT",
"Xojo",
"Xonsh",
"Xtend",
"YAML",
"YANG",
"YARA",
"YASnippet",
"Yacc",
"ZAP",
"ZIL",
"Zeek",
"ZenScript",
"Zephir",
"Zig",
"Zimpl",
"abl",
"abuild",
"acfm",
"aconf",
"actionscript 3",
"actionscript3",
"ada2005",
"ada95",
"adobe composite font metrics",
"adobe multiple font metrics",
"advpl",
"ags",
"ahk",
"altium",
"amfm",
"amusewiki",
"apache",
"apkbuild",
"arexx",
"as3",
"asm",
"asp",
"aspx",
"aspx-vb",
"ats2",
"au3",
"autoconf",
"b3d",
"bash session",
"bash",
"bat",
"batch",
"bazel",
"blitz3d",
"blitzplus",
"bmax",
"bplus",
"bro",
"bsdmake",
"byond",
"bzl",
"c++-objdump",
"c2hs",
"cURL Config",
"cake",
"cakescript",
"cfc",
"cfm",
"cfml",
"chpl",
"clipper",
"coccinelle",
"coffee",
"coffee-script",
"coldfusion html",
"console",
"cperl",
"cpp",
"csharp",
"csound-csd",
"csound-orc",
"csound-sco",
"cucumber",
"curlrc",
"cwl",
"dcl",
"delphi",
"desktop",
"dircolors",
"django",
"dosbatch",
"dosini",
"dpatch",
"dtrace-script",
"eC",
"ecr",
"editor-config",
"edn",
"eeschema schematic",
"eex",
"elisp",
"emacs muse",
"emacs",
"email",
"eml",
"erb",
"fb",
"fish",
"flex",
"foxpro",
"fsharp",
"fstar",
"ftl",
"fundamental",
"gf",
"git-ignore",
"gitattributes",
"gitconfig",
"gitignore",
"gitmodules",
"go mod",
"go sum",
"go.mod",
"go.sum",
"golang",
"groff",
"gsp",
"hbs",
"heex",
"help",
"html+django",
"html+jinja",
"html+ruby",
"htmlbars",
"htmldjango",
"hylang",
"i7",
"ignore",
"igor",
"igorpro",
"ijm",
"inc",
"inform7",
"inputrc",
"irc logs",
"irc",
"java server page",
"jq",
"jruby",
"js",
"jsonc",
"jsp",
"kak",
"kakscript",
"keyvalues",
"ksy",
"lassoscript",
"latex",
"leex",
"lhaskell",
"lhs",
"lisp",
"litcoffee",
"live-script",
"ls",
"m2",
"m68k",
"mIRC Script",
"macruby",
"mail",
"make",
"man page",
"man",
"man-page",
"manpage",
"markojs",
"max/msp",
"maxmsp",
"mbox",
"mcfunction",
"mdoc",
"mediawiki",
"mf",
"mma",
"mumps",
"mupad",
"nanorc",
"nasm",
"ne-on",
"nesC",
"nette object notation",
"nginx configuration file",
"nixos",
"njk",
"node",
"npmrc",
"nroff",
"nush",
"nvim",
"obj-c",
"obj-c++",
"obj-j",
"objc",
"objc++",
"objectivec",
"objectivec++",
"objectivej",
"objectpascal",
"objj",
"octave",
"odin-lang",
"odinlang",
"oncrpc",
"ooc",
"openedge",
"openrc",
"osascript",
"pandoc",
"pasm",
"pcbnew",
"perl-6",
"perl6",
"pir",
"plain text",
"posh",
"postscr",
"pot",
"pov-ray",
"povray",
"progress",
"protobuf",
"pwsh",
"pycon",
"pyrex",
"python3",
"q",
"ql",
"qsharp",
"ragel-rb",
"ragel-ruby",
"rake",
"raw",
"razor",
"rb",
"rbx",
"reStructuredText",
"readline",
"red/system",
"redirects",
"regex",
"regexp",
"renpy",
"rhtml",
"robots txt",
"robots",
"robots.txt",
"rpcgen",
"rs",
"rs-274x",
"rss",
"rst",
"rusthon",
"salt",
"saltstate",
"sed",
"sepolicy",
"sh",
"shell-script",
"shellcheckrc",
"sml",
"snippet",
"sourcemod",
"soy",
"specfile",
"splus",
"squeak",
"terraform",
"tl",
"tm-properties",
"troff",
"ts",
"udiff",
"vb .net",
"vb.net",
"vb6",
"vbnet",
"vdf",
"vim",
"vimhelp",
"viml",
"visual basic 6",
"visual basic for applications",
"visual basic",
"vlang",
"wasm",
"wast",
"wdl",
"wgetrc",
"wiki",
"winbatch",
"wisp",
"wl",
"wolfram lang",
"wolfram language",
"wolfram",
"wsdl",
"xBase",
"xbm",
"xdr",
"xhtml",
"xml+genshi",
"xml+kid",
"xpm",
"xsd",
"xsl",
"xten",
"yas",
"yml",
"zsh"
]
}
},
"filePatterns": {
"description": "A file name pattern to match against repository to enable this workflow when match is succeed\nhttps://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1,
"examples": ["*.sample"]
}
}
},
"required": ["name", "description"],
"title": "GitHub starter workflow config file schema",
"type": "object"
}
|
minecraft-particle.json | {
"$id": "https://json.schemastore.org/minecraft-particle.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A particle for a Minecraft resource pack config schema",
"properties": {
"textures": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["textures"],
"title": "Minecraft Resource Pack Particle",
"type": "object"
}
|
minecraft-trim-material.json | {
"$id": "https://json.schemastore.org/minecraft-trim-material.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A trim material for a Minecraft data pack config schema",
"properties": {
"asset_name": {
"type": "string"
},
"description": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"translate": {
"type": "string"
}
},
"required": ["color", "translate"]
},
"ingredient": {
"type": "string"
},
"item_model_index": {
"type": "number"
}
},
"required": ["asset_name", "description", "ingredient", "item_model_index"],
"title": "Minecraft Data Pack Trim Material",
"type": "object"
}
|
staticwebapp.config.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"default": {
"navigationFallback": {
"rewrite": "/index.html"
}
},
"definitions": {
"route": {
"type": "object",
"required": ["route"],
"properties": {
"route": {
"type": "string",
"description": "Request route pattern to match. May contain valid wildcards. See documentation: https://aka.ms/swa/config-schema"
},
"methods": {
"type": "array",
"description": "Request method(s) to match",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"PATCH",
"CONNECT",
"OPTIONS",
"TRACE"
]
}
]
}
},
"allowedRoles": {
"type": "array",
"description": "Roles that are allowed to access this route. If not empty, only role(s) listed are authorized to access the route. Roles are only used for authorization; they are not used to evaluate whether the route matches the request.",
"items": {
"anyOf": [
{
"type": "string",
"examples": ["anonymous", "authenticated"]
}
]
}
},
"headers": {
"type": "object",
"description": "Override any matching global headers",
"additionalProperties": true
},
"redirect": {
"type": "string",
"description": "Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301."
},
"statusCode": {
"type": "integer",
"description": "Status code override"
},
"rewrite": {
"type": "string",
"description": "A path to rewrite the request route to"
}
},
"additionalProperties": false
},
"auth": {
"type": "object",
"required": ["identityProviders"],
"properties": {
"rolesSource": {
"type": "string",
"description": "Route to API function for assigning roles. For example, \"/api/GetRoles\". See https://aka.ms/swa-roles-function"
},
"identityProviders": {
"type": "object",
"properties": {
"azureActiveDirectory": {
"type": "object",
"required": ["registration"],
"properties": {
"enabled": {
"description": "<false> if the azureActiveDirectory provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": ["openIdIssuer", "clientSecretSettingName"],
"properties": {
"openIdIssuer": {
"type": "string",
"description": "The endpoint for the OpenID configuration of the AAD tenant"
},
"clientIdSettingName": {
"type": "string",
"description": "The name of the application setting containing the Application (client) ID for the Azure AD app registration"
},
"clientSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the client secret for the Azure AD app registration"
}
},
"additionalProperties": false
},
"login": {
"type": "object",
"description": "",
"properties": {
"loginParameters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"userDetailsClaim": {
"type": "string",
"description": "The name of the claim from which we should read user details"
}
},
"additionalProperties": false
},
"apple": {
"type": "object",
"required": ["registration"],
"properties": {
"enabled": {
"description": "<false> if the apple provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": ["clientSecretSettingName"],
"properties": {
"clientIdSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client ID"
},
"clientSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client Secret"
}
},
"additionalProperties": false
},
"login": {
"type": "object",
"description": "",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"userDetailsClaim": {
"type": "string",
"description": "The name of the claim from which we should read user details"
}
},
"additionalProperties": false
},
"facebook": {
"type": "object",
"required": ["registration"],
"properties": {
"enabled": {
"description": "<false> if the facebook provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": ["appSecretSettingName"],
"properties": {
"appIdSettingName": {
"type": "string",
"description": "The name of the application setting containing the App ID"
},
"appSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the App Secret"
}
},
"additionalProperties": false
},
"login": {
"type": "object",
"description": "",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"userDetailsClaim": {
"type": "string",
"description": "The name of the claim from which we should read user details"
}
},
"additionalProperties": false
},
"github": {
"type": "object",
"required": ["registration"],
"properties": {
"enabled": {
"description": "<false> if the gitHub provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": ["clientSecretSettingName"],
"properties": {
"clientIdSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client ID"
},
"clientSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client Secret"
}
},
"additionalProperties": false
},
"login": {
"type": "object",
"description": "",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"userDetailsClaim": {
"type": "string",
"description": "The name of the claim from which we should read user details"
}
},
"additionalProperties": false
},
"google": {
"type": "object",
"required": ["registration"],
"properties": {
"enabled": {
"description": "<false> if the google provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": ["clientSecretSettingName"],
"properties": {
"clientIdSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client ID"
},
"clientSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client Secret"
}
},
"additionalProperties": false
},
"login": {
"type": "object",
"description": "",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"userDetailsClaim": {
"type": "string",
"description": "The name of the claim from which we should read user details"
}
},
"additionalProperties": false
},
"twitter": {
"type": "object",
"required": ["registration"],
"properties": {
"enabled": {
"description": "<false> if the twitter provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": ["consumerSecretSettingName"],
"properties": {
"consumerKeySettingName": {
"type": "string",
"description": "The name of the application setting containing the Consumer Key"
},
"consumerSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the Consumer Secret"
}
},
"additionalProperties": false
},
"userDetailsClaim": {
"type": "string",
"description": "The name of the claim from which we should read user details"
}
},
"additionalProperties": false
},
"customOpenIdConnectProviders": {
"type": "object",
"patternProperties": {
".*": {
"required": ["registration", "login"],
"properties": {
"enabled": {
"description": "<false> if the custom OpenID Connect provider is not enabled, <true> otherwise",
"type": "boolean",
"default": true
},
"registration": {
"type": "object",
"required": [
"clientCredential",
"openIdConnectConfiguration"
],
"properties": {
"clientIdSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client ID"
},
"clientCredential": {
"type": "object",
"required": ["clientSecretSettingName"],
"properties": {
"clientSecretSettingName": {
"type": "string",
"description": "The name of the application setting containing the Client Secret"
}
}
},
"openIdConnectConfiguration": {
"type": "object",
"properties": {
"authorizationEndpoint": {
"type": "string",
"description": "The path to the authorization endpoint"
},
"tokenEndpoint": {
"type": "string",
"description": "The path to the token endpoint"
},
"issuer": {
"type": "string",
"description": "The path to the issuer endpoint"
},
"certificationUri": {
"type": "string",
"description": "The path to the jwks uri"
},
"wellKnownOpenIdConfiguration": {
"type": "string",
"description": "The path to the well known configuration endpoint"
}
}
}
},
"additionalProperties": false
},
"login": {
"type": "object",
"description": "",
"properties": {
"nameClaimType": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"loginParameterNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"description": "Documentation: https://aka.ms/swa/config-schema",
"id": "https://json.schemastore.org/staticwebapp.config.json",
"properties": {
"routes": {
"type": "array",
"description": "Route definitions to modify routing behavior",
"default": [
{
"route": "/example",
"rewrite": "/example.html"
}
],
"items": {
"examples": [
{
"route": "/example",
"rewrite": "/example.html"
},
{
"route": "/login",
"redirect": "/.auth/login/github"
}
],
"anyOf": [
{
"allOf": [
{
"$ref": "#/definitions/route"
}
]
}
]
}
},
"navigationFallback": {
"type": "object",
"description": "A default file to return if the request does not match a resource",
"default": {
"rewrite": "/index.html"
},
"required": ["rewrite"],
"properties": {
"rewrite": {
"type": "string",
"description": "The default file to return if the request does not match a resource",
"default": "/index.html"
},
"exclude": {
"type": "array",
"description": "Paths to exclude from the fallback route. May use valid wildcards. https://aka.ms/swa/config-schema",
"examples": [["*.{jpg,gif,png}", "assets/*"]]
}
},
"additionalProperties": false
},
"responseOverrides": {
"type": "object",
"description": "Custom error pages or redirects",
"examples": [
{
"404": {
"rewrite": "/custom_404.html",
"statusCode": 200
}
}
],
"propertyNames": {
"pattern": "^\\d+$"
},
"patternProperties": {
".*": {
"oneOf": [
{
"type": "object",
"properties": {
"redirect": {
"type": "string",
"description": "Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301."
},
"statusCode": {
"type": "integer",
"description": "Status code"
},
"rewrite": {
"type": "string",
"description": "A path to rewrite the request route to"
}
}
}
]
}
}
},
"mimeTypes": {
"type": "object",
"description": "Custom mime types configuration",
"default": {},
"examples": [
{
".config": "application/xml"
}
],
"patternProperties": {
"^\\..+$": {
"type": "string"
}
},
"additionalProperties": false
},
"globalHeaders": {
"type": "object",
"description": "Default headers to set on all responses",
"additionalProperties": true
},
"auth": {
"$ref": "#/definitions/auth"
},
"networking": {
"type": "object",
"description": "Networking configuration",
"properties": {
"allowedIpRanges": {
"type": "array",
"description": "Restrict access to one or more IPv4 ranges. Supports CIDR notation (e.g., \"192.168.100.14/24\")",
"items": {
"type": "string"
},
"examples": [["10.0.0.0/24", "192.1.1.1/10"]]
}
},
"additionalProperties": false
},
"forwardingGateway": {
"type": "object",
"description": "Forwarding gateway configuration",
"properties": {
"allowedForwardedHosts": {
"type": "array",
"description": "The value of `X-Forwarded-Host` to allow to be used when generating redirect URLs",
"items": {
"type": "string"
},
"examples": [
["example.org", "www.example.org", "staging.example.org"]
]
},
"requiredHeaders": {
"type": "object",
"description": "HTTP header name/value pairs that are required for access",
"examples": [
{
"X-Azure-FDID": "10dd26ef"
}
],
"additionalProperties": true
}
},
"additionalProperties": false
},
"platform": {
"type": "object",
"description": "Platform configuration",
"properties": {
"apiRuntime": {
"type": "string",
"enum": [
"dotnet:3.1",
"dotnet:6.0",
"dotnet-isolated:6.0",
"dotnet-isolated:7.0",
"node:12",
"node:14",
"node:16",
"node:18",
"python:3.8",
"python:3.9",
"python:3.10"
],
"description": "Language runtime for the managed functions API"
}
},
"additionalProperties": false
},
"trailingSlash": {
"type": "string",
"enum": ["always", "never", "auto"],
"description": "Trailing slash configuration"
},
"$schema": {
"type": "string",
"default": "https://json.schemastore.org/staticwebapp.config.json",
"description": "JSON schema"
}
},
"title": "Azure Static Web Apps configuration file",
"type": "object"
}
|
semgrep.json | {
"$defs": {
"patterns-content": {
"type": "array",
"title": "Return finding where all of the nested conditions are true",
"items": {
"anyOf": [
{
"$ref": "#/$defs/patterns"
},
{
"$ref": "#/$defs/pattern-either"
},
{
"$ref": "#/$defs/focus-metavariable"
},
{
"$ref": "#/$defs/pattern-inside"
},
{
"$ref": "#/$defs/pattern-not-inside"
},
{
"$ref": "#/$defs/pattern-not"
},
{
"$ref": "#/$defs/pattern"
},
{
"$ref": "#/$defs/pattern-regex"
},
{
"$ref": "#/$defs/pattern-not-regex"
},
{
"$ref": "#/$defs/pattern-where-python"
},
{
"$ref": "#/$defs/metavariable-analysis"
},
{
"$ref": "#/$defs/metavariable-regex"
},
{
"$ref": "#/$defs/metavariable-pattern"
},
{
"$ref": "#/$defs/metavariable-comparison"
}
]
}
},
"pattern-either-content": {
"type": "array",
"title": "Return finding where any of the nested conditions are true",
"items": {
"anyOf": [
{
"$ref": "#/$defs/patterns"
},
{
"$ref": "#/$defs/pattern-either"
},
{
"$ref": "#/$defs/pattern-inside"
},
{
"$ref": "#/$defs/pattern"
},
{
"$ref": "#/$defs/pattern-regex"
}
]
}
},
"taint-content": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"pattern": {
"title": "Return finding where Semgrep pattern matches exactly",
"type": "string"
},
"pattern-regex": {
"title": "Return finding where regular expression matches exactly",
"type": "string"
},
"patterns": {
"$ref": "#/$defs/patterns-content"
},
"pattern-either": {
"$ref": "#/$defs/pattern-either-content"
}
},
"oneOf": [
{
"required": ["pattern"],
"not": {
"anyOf": [
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
]
}
},
{
"required": ["patterns"],
"not": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
]
}
},
{
"required": ["pattern-either"],
"not": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-regex"]
}
]
}
},
{
"required": ["pattern-regex"],
"not": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
}
]
}
}
]
}
]
}
},
"r2c-internal-project-depends-on-content": {
"type": "object",
"title": "One or more dependencies that the project contains in a lock file",
"properties": {
"namespace": {
"type": "string"
},
"package": {
"type": "string"
},
"version": {
"type": "string"
},
"depends-on-either": {
"type": "array",
"properties": {
"namespace": {
"type": "string"
},
"package": {
"type": "string"
},
"version": {
"type": "string"
}
},
"additionalProperties": false,
"required": ["namespace", "package", "version"]
}
},
"oneOf": [
{
"required": ["namespace", "package", "version"],
"not": {
"required": ["depends-on-either"]
}
},
{
"required": ["depends-on-either"],
"not": {
"anyOf": [
{
"required": ["namespace"]
},
{
"required": ["package"]
},
{
"required": ["version"]
}
]
}
}
]
},
"join-content": {
"type": "object",
"title": "Join one or more rules together based on metavariable contents",
"properties": {
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rule": {
"type": "string"
},
"renames": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
}
}
},
"as": {
"type": "string"
}
},
"additionalProperties": false
}
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": ["id", "languages"],
"oneOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-sources", "pattern-sinks"]
}
],
"properties": {
"id": {
"$ref": "#/$defs/id"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"pattern": {
"type": "string"
},
"patterns": {
"$ref": "#/$defs/patterns-content"
},
"mode": {
"enum": ["search", "taint"]
},
"pattern-sources": {
"$ref": "#/$defs/taint-content"
},
"pattern-propagators": {
"$ref": "#/$defs/taint-content"
},
"pattern-sinks": {
"$ref": "#/$defs/taint-content"
},
"pattern-sanitizers": {
"$ref": "#/$defs/taint-content"
}
},
"additionalProperties": false
}
},
"on": {
"type": "array",
"items": {
"type": "string"
}
},
"additionalProperties": false
},
"additionalProperties": false
},
"metavariable-analysis": {
"type": "object",
"properties": {
"metavariable-analysis": {
"type": "object",
"properties": {
"analyzer": {
"type": "string"
},
"metavariable": {
"type": "string"
},
"options": {
"type": "object"
}
},
"required": ["analyzer", "metavariable"],
"additionalProperties": false
}
},
"required": ["metavariable-analysis"],
"additionalProperties": false
},
"metavariable-regex": {
"type": "object",
"properties": {
"metavariable-regex": {
"type": "object",
"properties": {
"metavariable": {
"type": "string"
},
"regex": {
"type": "string"
},
"constant-propagation": {
"type": "boolean"
}
},
"required": ["metavariable", "regex"],
"additionalProperties": false
}
},
"required": ["metavariable-regex"],
"additionalProperties": false
},
"metavariable-pattern": {
"type": "object",
"properties": {
"metavariable-pattern": {
"type": "object",
"properties": {
"metavariable": {
"type": "string"
},
"language": {
"type": "string"
},
"pattern": {
"title": "Return finding where Semgrep pattern matches exactly",
"type": "string"
},
"pattern-regex": {
"title": "Return finding where regular expression matches exactly",
"type": "string"
},
"patterns": {
"$ref": "#/$defs/patterns-content"
},
"pattern-either": {
"$ref": "#/$defs/pattern-either-content"
}
},
"required": ["metavariable"],
"oneOf": [
{
"required": ["pattern"],
"not": {
"anyOf": [
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
]
}
},
{
"required": ["patterns"],
"not": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
]
}
},
{
"required": ["pattern-either"],
"not": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-regex"]
}
]
}
},
{
"required": ["pattern-regex"],
"not": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
}
]
}
}
],
"additionalProperties": false
}
},
"required": ["metavariable-pattern"],
"additionalProperties": false
},
"metavariable-comparison": {
"type": "object",
"properties": {
"metavariable-comparison": {
"type": "object",
"properties": {
"metavariable": {
"type": "string"
},
"comparison": {
"type": "string"
},
"strip": {
"type": "boolean"
},
"base": {
"type": "integer"
}
},
"required": ["comparison"],
"additionalProperties": false
}
},
"required": ["metavariable-comparison"],
"additionalProperties": false
},
"pattern": {
"type": "object",
"properties": {
"pattern": {
"title": "Return finding where Semgrep pattern matches exactly",
"type": "string"
}
},
"required": ["pattern"],
"additionalProperties": false
},
"pattern-regex": {
"type": "object",
"properties": {
"pattern-regex": {
"title": "Return finding where regular expression matches",
"type": "string"
}
},
"required": ["pattern-regex"],
"additionalProperties": false
},
"pattern-not-regex": {
"type": "object",
"properties": {
"pattern-not-regex": {
"title": "Do not return finding where regular expression matches",
"type": "string"
}
},
"required": ["pattern-not-regex"],
"additionalProperties": false
},
"patterns": {
"type": "object",
"properties": {
"patterns": {
"title": "Return finding where all of the nested conditions are true",
"$ref": "#/$defs/patterns-content"
}
},
"required": ["patterns"],
"additionalProperties": false
},
"pattern-either": {
"type": "object",
"properties": {
"pattern-either": {
"title": "Return finding where any of the nested conditions are true",
"$ref": "#/$defs/pattern-either-content"
}
},
"required": ["pattern-either"],
"additionalProperties": false
},
"focus-metavariable": {
"type": "object",
"properties": {
"focus-metavariable": {
"title": "Focus on what a given metavariable is matching",
"type": "string"
}
},
"required": ["focus-metavariable"],
"additionalProperties": false
},
"pattern-inside": {
"type": "object",
"properties": {
"pattern-inside": {
"title": "Return findings only from within snippets Semgrep pattern matches",
"type": "string"
}
},
"required": ["pattern-inside"],
"additionalProperties": false
},
"pattern-not-inside": {
"type": "object",
"properties": {
"pattern-not-inside": {
"title": "Do not return findings from within snippets Semgrep pattern matches",
"type": "string"
}
},
"required": ["pattern-not-inside"],
"additionalProperties": false
},
"pattern-not": {
"type": "object",
"properties": {
"pattern-not": {
"title": "Do not return finding where Semgrep pattern matches exactly",
"type": "string"
}
},
"required": ["pattern-not"],
"additionalProperties": false
},
"pattern-where-python": {
"type": "object",
"properties": {
"pattern-where-python": {
"title": "Return finding where Python expression returns true",
"type": "string"
}
},
"required": ["pattern-where-python"],
"additionalProperties": false
},
"path-array": {
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"title": "Rule ID to attach to findings",
"type": "string"
}
},
"$id": "https://raw.githubusercontent.com/returntocorp/semgrep-interfaces/main/rule_schema.yaml",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/id"
},
"version": {
"title": "Version of rule",
"type": "string"
},
"message": {
"title": "Description to attach to findings",
"type": "string"
},
"mode": {
"default": "search",
"enum": ["search", "taint", "join", "extract"]
},
"languages": {
"title": "Languages this pattern should run on",
"type": "array",
"items": {
"type": "string"
}
},
"paths": {
"title": "Path globs this pattern should run on",
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/path-array"
},
"exclude": {
"$ref": "#/$defs/path-array"
}
},
"additionalProperties": false
},
"severity": {
"title": "Severity to report alongside this finding",
"enum": ["ERROR", "WARNING", "INFO", "INVENTORY", "EXPERIMENT"]
},
"pattern-sinks": {
"$ref": "#/$defs/taint-content"
},
"pattern-sources": {
"$ref": "#/$defs/taint-content"
},
"pattern-propagators": {
"$ref": "#/$defs/taint-content"
},
"pattern-sanitizers": {
"$ref": "#/$defs/taint-content"
},
"join": {
"$ref": "#/$defs/join-content"
},
"fix": {
"title": "Replacement text to fix matched code. Can use matched metavariables.",
"type": "string"
},
"fix-regex": {
"type": "object",
"title": "Replacement regex to fix matched code.",
"properties": {
"count": {
"title": "Replace up to this many regex matches",
"type": "integer"
},
"regex": {
"title": "Regular expression to find in matched code",
"type": "string"
},
"replacement": {
"title": "Code to replace the regular expression match with. Can use capture groups.",
"type": "string"
}
},
"required": ["regex", "replacement"],
"additionalProperties": false
},
"metadata": {
"title": "Arbitrary structured data for your own reference",
"type": "object"
},
"options": {
"title": "Options object to enable/disable certain matching features in semgrep-core",
"type": "object"
},
"pattern": {
"title": "Return finding where Semgrep pattern matches exactly",
"type": "string"
},
"pattern-regex": {
"title": "Return finding where regular expression matches exactly",
"type": "string"
},
"patterns": {
"$ref": "#/$defs/patterns-content"
},
"pattern-either": {
"$ref": "#/$defs/pattern-either-content"
},
"r2c-internal-project-depends-on": {
"$ref": "#/$defs/r2c-internal-project-depends-on-content"
},
"extract": {
"title": "Metavariable whose content to use as the extracted result for subsequent rules",
"type": "string"
},
"dest-language": {
"title": "Language to process the extracted result of this rule as",
"type": "string"
},
"reduce": {
"title": "Method of intrafile match reduction",
"enum": ["concat", "separate"],
"default": "separate"
}
},
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"mode": {
"const": "extract"
}
},
"required": ["mode"]
},
"then": {
"required": ["id", "languages", "dest-language", "extract"],
"oneOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
],
"properties": {
"message": false,
"severity": false,
"pattern-sinks": false,
"pattern-sources": false,
"pattern-propagators": false,
"pattern-sanitizers": false,
"join": false
}
}
},
{
"if": {
"properties": {
"mode": {
"const": "taint"
}
},
"required": ["mode"]
},
"then": {
"required": [
"id",
"message",
"languages",
"severity",
"pattern-sinks",
"pattern-sources"
],
"properties": {
"extract": false,
"dest-language": false,
"reduce": false,
"pattern": false,
"patterns": false,
"pattern-either": false,
"pattern-regex": false,
"join": false
}
}
},
{
"if": {
"properties": {
"mode": {
"const": "join"
}
},
"required": ["mode"]
},
"then": {
"required": ["id", "message", "severity", "join"],
"properties": {
"extract": false,
"dest-language": false,
"reduce": false,
"patterns": false,
"pattern": false,
"pattern-either": false,
"pattern-regex": false,
"pattern-sinks": false,
"pattern-sources": false,
"pattern-propagators": false,
"pattern-sanitizers": false
}
}
},
{
"if": {
"properties": {
"mode": {
"const": "search"
}
}
},
"then": {
"required": ["id", "message", "languages", "severity"],
"if": {
"anyOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
]
},
"then": {
"oneOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
}
]
},
"else": {
"oneOf": [
{
"required": ["pattern"]
},
{
"required": ["patterns"]
},
{
"required": ["pattern-either"]
},
{
"required": ["pattern-regex"]
},
{
"required": ["r2c-internal-project-depends-on"]
}
]
},
"properties": {
"extract": false,
"dest-language": false,
"reduce": false,
"pattern-sinks": false,
"pattern-sources": false,
"pattern-propagators": false,
"pattern-sanitizers": false,
"join": false
}
}
}
]
}
}
},
"type": "object"
}
|
deployed.json | {
"$id": "https://json.schemastore.org/deployed.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"privateKey": {
"description": "Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).",
"type": ["string", "object"]
},
"passphrase": {
"description": "For an encrypted privateKey, this is the passphrase used to decrypt it.",
"type": "string",
"minLength": 1
},
"script": {
"description": "Execute script commands.",
"type": "string",
"minLength": 1
},
"backupName": {
"description": "Old version backup name.",
"type": "string",
"minLength": 1
},
"removeLocalDir": {
"description": "Delete localpath after deployment.",
"type": "boolean"
},
"clearRemoteDir": {
"description": "Empty the old version before deploying the new version.",
"type": "boolean"
}
},
"description": "JSON schema for the deployed cli config file. \n\nSee also: https://hyhello.github.io/deployed\n\n",
"properties": {
"projectName": {
"description": "Name of project to be released.",
"type": "string",
"minLength": 1
},
"cluster": {
"type": "array",
"uniqueItems": true,
"description": "Alias collection of environment to be deployed.",
"items": {
"type": "string"
}
},
"privateKey": {
"$ref": "#/definitions/privateKey"
},
"passphrase": {
"$ref": "#/definitions/passphrase"
},
"script": {
"$ref": "#/definitions/script"
},
"backupName": {
"$ref": "#/definitions/backupName"
},
"removeLocalDir": {
"$ref": "#/definitions/removeLocalDir"
},
"clearRemoteDir": {
"$ref": "#/definitions/clearRemoteDir"
},
"modeList": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"mode",
"name",
"host",
"port",
"username",
"localPath",
"remotePath"
],
"additionalProperties": false,
"properties": {
"mode": {
"description": "Deployment environment alias.",
"type": "string",
"minLength": 1
},
"name": {
"description": "Deployment environment name.",
"type": "string",
"minLength": 1
},
"host": {
"description": "Hostname or IP address of the server.",
"type": "string",
"minLength": 1
},
"port": {
"description": "Port number of the server.",
"type": "integer",
"minimum": 1
},
"username": {
"description": "Username for authentication.",
"type": "string",
"minLength": 1
},
"password": {
"description": "Password for password-based user authentication.",
"type": "string",
"minLength": 1
},
"remotePath": {
"description": "Deployment path.",
"type": "string",
"minLength": 2
},
"localPath": {
"description": "Local upload path.",
"type": "string",
"minLength": 1
},
"backupPath": {
"description": "Backup path.",
"type": "string",
"minLength": 2
},
"privateKey": {
"$ref": "#/definitions/privateKey"
},
"passphrase": {
"$ref": "#/definitions/passphrase"
},
"script": {
"$ref": "#/definitions/script"
},
"backupName": {
"$ref": "#/definitions/backupName"
},
"removeLocalDir": {
"$ref": "#/definitions/removeLocalDir"
},
"clearRemoteDir": {
"$ref": "#/definitions/clearRemoteDir"
}
}
}
},
"plugin": {
"description": "List of plugins to load and use.",
"type": "array",
"uniqueItems": true,
"items": {
"type": ["string", "array"],
"items": [
{
"description": "The name of the plugin.",
"type": "string"
},
{
"description": "The options of the plugin.",
"type": "object"
}
]
}
},
"$schema": {
"description": "JSON Schema for deployed.",
"type": "string",
"minLength": 1
}
},
"required": ["projectName", "modeList"],
"title": "deployed cli",
"type": "object"
}
|
pyproject.json | {
"$comment": "there are multiple resources describing pyproject.toml. The canonical reference is at https://packaging.python.org/en/latest/specifications/declaring-project-metadata/, which refers to multiple proposals such as PEP 517, PEP 518 and PEP 621",
"$id": "https://json.schemastore.org/pyproject.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"projectAuthor": {
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": ["name"],
"properties": {
"name": true
}
},
{
"required": ["email"],
"properties": {
"email": true
}
}
],
"properties": {
"name": {
"title": "Author name",
"type": "string"
},
"email": {
"title": "Author email",
"type": "string",
"format": "email"
}
}
},
"poetry-author-pattern": {
"description": "Pattern that matches `Name <email>` like 'King Arthur' or 'Miss Islington <[email protected]>'.",
"type": "string",
"pattern": "^(?:\\S+?\\s)+?(?:<(?:[a-z\\d!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z\\d!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z\\d](?:[a-z\\d-]*[a-z\\d])?\\.)+[a-z\\d](?:[a-z\\d-]*[a-z\\d])?|\\[(?:(?:25[0-5]|2[0-4][\\d]|[01]?[\\d][\\d]?)\\.){3}(?:25[0-5]|2[0-4][\\d]|[01]?[\\d][\\d]?|[a-z\\d-]*[a-z\\d]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])>)?$"
},
"poetry-authors": {
"type": "array",
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"$ref": "#/definitions/poetry-author-pattern"
}
},
"poetry-maintainers": {
"type": "array",
"description": "List of maintainers, other than the original author(s), that upkeep the package.",
"items": {
"$ref": "#/definitions/poetry-author-pattern"
}
},
"poetry-include-path": {
"type": "string",
"description": "Path to file or directory to include."
},
"poetry-package-format": {
"type": "string",
"enum": ["sdist", "wheel"],
"description": "A Python packaging format."
},
"poetry-package-formats": {
"oneOf": [
{
"$ref": "#/definitions/poetry-package-format"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/poetry-package-format"
}
}
],
"description": "The format(s) for which the package must be included."
},
"poetry-dependency-any": {
"oneOf": [
{
"$ref": "#/definitions/poetry-dependency"
},
{
"$ref": "#/definitions/poetry-long-dependency"
},
{
"$ref": "#/definitions/poetry-git-dependency"
},
{
"$ref": "#/definitions/poetry-file-dependency"
},
{
"$ref": "#/definitions/poetry-path-dependency"
},
{
"$ref": "#/definitions/poetry-url-dependency"
},
{
"$ref": "#/definitions/poetry-multiple-constraints-dependency"
}
]
},
"poetry-pep440-version": {
"type": "string",
"description": "A version constraint. Validates against the PEP 440's version pattern."
},
"poetry-dependency": {
"$ref": "#/definitions/poetry-pep440-version"
},
"poetry-long-dependency": {
"type": "object",
"required": ["version"],
"additionalProperties": false,
"properties": {
"version": {
"$ref": "#/definitions/poetry-pep440-version"
},
"python": {
"type": "string",
"description": "The python versions for which the dependency should be installed."
},
"platform": {
"type": "string",
"description": "The platform(s) for which the dependency should be installed."
},
"markers": {
"type": "string",
"description": "The PEP 508 compliant environment markers for which the dependency should be installed."
},
"allow-prereleases": {
"type": "boolean",
"description": "Whether the dependency allows prereleases or not."
},
"allows-prereleases": {
"type": "boolean",
"description": "Whether the dependency allows prereleases or not."
},
"optional": {
"type": "boolean",
"description": "Whether the dependency is optional or not."
},
"extras": {
"type": "array",
"description": "The required extras for this dependency.",
"items": {
"type": "string"
}
},
"source": {
"type": "string",
"description": "The exclusive source used to search for this dependency."
}
}
},
"poetry-git-dependency": {
"type": "object",
"required": ["git"],
"additionalProperties": false,
"properties": {
"git": {
"type": "string",
"description": "The url of the git repository.",
"format": "uri"
},
"branch": {
"type": "string",
"description": "The branch to checkout."
},
"tag": {
"type": "string",
"description": "The tag to checkout."
},
"rev": {
"type": "string",
"description": "The revision to checkout."
},
"subdirectory": {
"type": "string",
"description": "The relative path to the directory where the package is located."
},
"python": {
"type": "string",
"description": "The python versions for which the dependency should be installed."
},
"platform": {
"type": "string",
"description": "The platform(s) for which the dependency should be installed."
},
"markers": {
"type": "string",
"description": "The PEP 508 compliant environment markers for which the dependency should be installed."
},
"allow-prereleases": {
"type": "boolean",
"description": "Whether the dependency allows prereleases or not."
},
"allows-prereleases": {
"type": "boolean",
"description": "Whether the dependency allows prereleases or not."
},
"optional": {
"type": "boolean",
"description": "Whether the dependency is optional or not."
},
"extras": {
"type": "array",
"description": "The required extras for this dependency.",
"items": {
"type": "string"
}
},
"develop": {
"type": "boolean",
"description": "Whether to install the dependency in development mode."
}
}
},
"poetry-file-dependency": {
"type": "object",
"required": ["file"],
"additionalProperties": false,
"properties": {
"file": {
"type": "string",
"description": "The path to the file."
},
"python": {
"type": "string",
"description": "The python versions for which the dependency should be installed."
},
"platform": {
"type": "string",
"description": "The platform(s) for which the dependency should be installed."
},
"markers": {
"type": "string",
"description": "The PEP 508 compliant environment markers for which the dependency should be installed."
},
"optional": {
"type": "boolean",
"description": "Whether the dependency is optional or not."
},
"extras": {
"type": "array",
"description": "The required extras for this dependency.",
"items": {
"type": "string"
}
}
}
},
"poetry-path-dependency": {
"type": "object",
"required": ["path"],
"additionalProperties": false,
"properties": {
"path": {
"type": "string",
"description": "The path to the dependency."
},
"python": {
"type": "string",
"description": "The python versions for which the dependency should be installed."
},
"platform": {
"type": "string",
"description": "The platform(s) for which the dependency should be installed."
},
"markers": {
"type": "string",
"description": "The PEP 508 compliant environment markers for which the dependency should be installed."
},
"optional": {
"type": "boolean",
"description": "Whether the dependency is optional or not."
},
"extras": {
"type": "array",
"description": "The required extras for this dependency.",
"items": {
"type": "string"
}
},
"develop": {
"type": "boolean",
"description": "Whether to install the dependency in development mode."
}
}
},
"poetry-url-dependency": {
"type": "object",
"required": ["url"],
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"description": "The url to the file."
},
"python": {
"type": "string",
"description": "The python versions for which the dependency should be installed."
},
"platform": {
"type": "string",
"description": "The platform(s) for which the dependency should be installed."
},
"markers": {
"type": "string",
"description": "The PEP 508 compliant environment markers for which the dependency should be installed."
},
"optional": {
"type": "boolean",
"description": "Whether the dependency is optional or not."
},
"extras": {
"type": "array",
"description": "The required extras for this dependency.",
"items": {
"type": "string"
}
}
}
},
"poetry-multiple-constraints-dependency": {
"type": "array",
"minItems": 1,
"items": {
"oneOf": [
{
"$ref": "#/definitions/poetry-dependency"
},
{
"$ref": "#/definitions/poetry-long-dependency"
},
{
"$ref": "#/definitions/poetry-git-dependency"
},
{
"$ref": "#/definitions/poetry-file-dependency"
},
{
"$ref": "#/definitions/poetry-path-dependency"
},
{
"$ref": "#/definitions/poetry-url-dependency"
}
]
}
},
"poetry-script-table": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/poetry-extra-script-legacy"
},
{
"$ref": "#/definitions/poetry-extra-scripts"
}
]
},
"poetry-script-legacy": {
"type": "string",
"description": "A simple script pointing to a callable object."
},
"poetry-extra-scripts": {
"type": "object",
"description": "Either a console entry point or a script file that'll be included in the distribution package.",
"additionalProperties": false,
"properties": {
"reference": {
"type": "string",
"description": "If type is file this is the relative path of the script file, if console it is the module name."
},
"type": {
"description": "Value can be either file or console.",
"type": "string",
"enum": ["file", "console"]
},
"extras": {
"type": "array",
"description": "The required extras for this script. Only applicable if type is console.",
"items": {
"type": "string"
}
}
},
"required": ["reference", "type"]
},
"poetry-extra-script-legacy": {
"type": "object",
"description": "A script that should be installed only if extras are activated.",
"additionalProperties": false,
"properties": {
"callable": {
"$ref": "#/definitions/poetry-script-legacy",
"description": "The entry point of the script. Deprecated in favour of reference."
},
"extras": {
"type": "array",
"description": "The required extras for this script.",
"items": {
"type": "string"
}
}
}
},
"poetry-build-script": {
"type": "string",
"description": "The python script file used to build extensions."
},
"poetry-build-config": {
"type": "object",
"description": "Build specific configurations.",
"additionalProperties": false,
"properties": {
"generate-setup-file": {
"type": "boolean",
"description": "Generate and include a setup.py file in sdist.",
"default": true
},
"script": {
"$ref": "#/definitions/poetry-build-script"
}
}
},
"poetry-build-section": {
"oneOf": [
{
"$ref": "#/definitions/poetry-build-script"
},
{
"$ref": "#/definitions/poetry-build-config"
}
]
},
"BuildSystem": {
"title": "Project build system configuration",
"$comment": "see PEP 517 (https://peps.python.org/pep-0517/) and PEP 518 (https://peps.python.org/pep-0518/)",
"type": "object",
"x-taplo": {
"links": {
"key": "https://www.python.org/dev/peps/pep-0518/#build-system-table"
}
},
"description": "Build-related data.\n",
"additionalProperties": false,
"required": ["requires"],
"properties": {
"requires": {
"title": "Build system dependencies",
"description": "A list of strings representing [PEP 508](https://www.python.org/dev/peps/pep-0508) dependencies required to execute the build system.\n",
"type": "array",
"items": {
"type": "string"
},
"x-taplo": {
"links": {
"key": "https://www.python.org/dev/peps/pep-0518/#build-system-table"
}
},
"examples": ["setuptools >= 64.0"]
},
"build-backend": {
"title": "Build backend",
"description": "Python path to project's build backend",
"type": "string",
"x-taplo": {
"links": {
"key": "https://www.python.org/dev/peps/pep-0517/"
}
},
"examples": ["setuptools.build_meta", "my_build_backend:backend"]
},
"backend-path": {
"title": "Build backend directories",
"description": "paths to prepend to 'sys.path' when loading the build backend, relative to project root",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"properties": {
"build-system": {
"$ref": "#/definitions/BuildSystem"
},
"tool": {
"title": "Tool-specific configuration",
"type": "object",
"description": "A table for tool configurations.\n\nEvery tool that is used by the project can have its own sub-table for its configuration.\n",
"additionalProperties": {
"type": "object"
},
"x-taplo": {
"links": {
"key": "https://www.python.org/dev/peps/pep-0518/#id28"
}
},
"properties": {
"ruff": {
"$ref": "https://json.schemastore.org/ruff.json"
},
"poetry": {
"type": "object",
"additionalProperties": true,
"required": ["name", "version", "description", "authors"],
"properties": {
"name": {
"type": "string",
"description": "Package name."
},
"version": {
"type": "string",
"description": "Version of the package. It should follow semantic versioning, but it is not enforced."
},
"description": {
"type": "string",
"description": "Short package description.",
"pattern": "^[^\n]*$"
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"description": "A tag/keyword that this package relates to."
}
},
"homepage": {
"type": "string",
"description": "Homepage URL for the project.",
"format": "uri"
},
"repository": {
"type": "string",
"description": "Repository URL for the project.",
"format": "uri"
},
"documentation": {
"type": "string",
"description": "Documentation URL for the project.",
"format": "uri"
},
"license": {
"type": "string",
"description": "License name."
},
"authors": {
"$ref": "#/definitions/poetry-authors"
},
"maintainers": {
"$ref": "#/definitions/poetry-maintainers"
},
"readme": {
"anyOf": [
{
"type": "string",
"description": "The path to the README file."
},
{
"type": "array",
"description": "A list of paths to the readme files.",
"items": {
"type": "string"
}
}
]
},
"classifiers": {
"type": "array",
"description": "A list of trove classifers."
},
"packages": {
"type": "array",
"description": "A list of packages to include in the final distribution.",
"items": {
"type": "object",
"description": "Information about where the package resides.",
"additionalProperties": false,
"required": ["include"],
"properties": {
"include": {
"$ref": "#/definitions/poetry-include-path"
},
"from": {
"type": "string",
"description": "Where the source directory of the package resides."
},
"format": {
"$ref": "#/definitions/poetry-package-formats"
}
}
}
},
"include": {
"type": "array",
"description": "A list of files and folders to include.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/poetry-include-path"
},
{
"type": "object",
"additionalProperties": false,
"required": ["path"],
"properties": {
"path": {
"$ref": "#/definitions/poetry-include-path"
},
"format": {
"$ref": "#/definitions/poetry-package-formats"
}
}
}
]
}
},
"exclude": {
"type": "array",
"description": "A list of files and folders to exclude."
},
"dependencies": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"required": ["python"],
"properties": {
"python": {
"type": "string",
"description": "The Python versions the package is compatible with.",
"$ref": "#/definitions/poetry-dependency"
}
},
"patternProperties": {
"^(?!python$)[a-zA-Z-_.0-9]+$": {
"$ref": "#/definitions/poetry-dependency-any"
}
}
},
"dev-dependencies": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"$ref": "#/definitions/poetry-dependency-any"
}
}
},
"extras": {
"type": "object",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"group": {
"type": "object",
"description": "This represents groups of dependencies",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"type": "object",
"description": "This represents a single dependency group",
"required": ["dependencies"],
"properties": {
"optional": {
"type": "boolean",
"description": "Whether the dependency group is optional or not"
},
"dependencies": {
"type": "object",
"description": "The dependencies of this dependency group",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"$ref": "#/definitions/poetry-dependency-any"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"build": {
"$ref": "#/definitions/poetry-build-section"
},
"scripts": {
"type": "object",
"description": "A hash of scripts to be installed.",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"oneOf": [
{
"$ref": "#/definitions/poetry-script-legacy"
},
{
"$ref": "#/definitions/poetry-script-table"
}
]
}
}
},
"plugins": {
"type": "object",
"description": "A hash of hashes representing plugins",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"type": "object",
"patternProperties": {
"^[a-zA-Z-_.0-9]+$": {
"type": "string"
}
}
}
}
},
"urls": {
"type": "object",
"patternProperties": {
"^.+$": {
"type": "string",
"description": "The full url of the custom url."
}
}
}
}
}
},
"examples": [
{
"tool": {
"isort": {
"profile": "black"
}
}
}
]
},
"project": {
"title": "Project metadata",
"$comment": "see PEP 621 (https://peps.python.org/pep-0621/)",
"type": "object",
"additionalProperties": false,
"required": ["name"],
"properties": {
"name": {
"title": "Project name",
"type": "string",
"pattern": "^([a-zA-Z\\d]|[a-zA-Z\\d][\\w.-]*[a-zA-Z\\d])$"
},
"version": {
"title": "Project version",
"type": "string",
"pattern": "^([1-9]\\d*!)?(0|[1-9]\\d*)(\\.(0|[1-9]\\d*))*((a|b|rc)(0|[1-9]\\d*))?(\\.post(0|[1-9]\\d*))?(\\.dev(0|[1-9]\\d*))?$",
"examples": ["42.0.1", "0.3.9rc7.post0.dev5"]
},
"description": {
"title": "Project summary description",
"type": "string"
},
"readme": {
"title": "Project full description",
"description": "AKA the README",
"oneOf": [
{
"title": "README file path",
"type": "string"
},
{
"type": "object",
"required": ["content-type"],
"properties": {
"content-type": {
"title": "README text content-type",
"description": "RFC 1341 compliant content-type (with optional charset, defaulting to UTF-8)",
"type": "string"
}
},
"oneOf": [
{
"additionalProperties": false,
"required": ["file"],
"properties": {
"content-type": true,
"file": {
"title": "README file path",
"type": "string"
}
}
},
{
"additionalProperties": false,
"required": ["text"],
"properties": {
"content-type": true,
"text": {
"title": "README text",
"type": "string"
}
}
}
]
}
],
"examples": [
"README.md",
{
"file": "README.txt",
"content-type": "text/plain"
},
{
"text": "# Example project\n\nAn example project",
"content-type": "text/markdown"
}
]
},
"requires-python": {
"title": "Python version compatibility",
"type": "string",
"examples": [">= 3.7"]
},
"license": {
"title": "Project license",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": ["file"],
"properties": {
"file": {
"title": "License file path",
"type": "string"
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": ["text"],
"properties": {
"text": {
"title": "License text",
"type": "string"
}
}
},
{
"type": "string",
"description": "A SPDX license identifier"
}
],
"examples": [
{
"text": "MIT"
},
{
"file": "LICENSE"
},
"MIT",
"LicenseRef-Proprietary"
]
},
"authors": {
"title": "Project authors",
"type": "array",
"items": {
"$ref": "#/definitions/projectAuthor"
}
},
"maintainers": {
"title": "Project maintainers",
"type": "array",
"items": {
"$ref": "#/definitions/projectAuthor"
}
},
"keywords": {
"title": "Project keywords",
"type": "array",
"items": {
"type": "string"
}
},
"classifiers": {
"title": "Applicable Trove classifiers",
"type": "array",
"items": {
"type": "string"
}
},
"urls": {
"title": "Project URLs",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uri"
},
"examples": [
{
"homepage": "https://example.com/example-project"
}
]
},
"scripts": {
"title": "Console scripts",
"type": "object",
"additionalProperties": {
"type": "string"
},
"examples": [
{
"mycmd": "package.module:object.function"
}
]
},
"gui-scripts": {
"title": "GUI scripts",
"type": "object",
"additionalProperties": {
"type": "string"
},
"examples": [
{
"mycmd": "package.module:object.function"
}
]
},
"entry-points": {
"title": "Other entry-point groups",
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^\\w+(\\.\\w+)*$": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"propertyNames": {
"not": {
"anyOf": [
{
"const": "console_scripts"
},
{
"const": "gui_scripts"
}
]
}
},
"examples": [
{
"pygments.styles": {
"monokai": "package.module:object.attribute"
}
}
]
},
"dependencies": {
"title": "Project dependency requirements",
"type": "array",
"items": {
"type": "string"
},
"examples": [["attrs", "requests ~= 2.28"]]
},
"optional-dependencies": {
"title": "Project extra dependency requirements",
"description": "keys are extra names",
"type": "object",
"patternProperties": {
"^([a-z\\d]|[a-z\\d]([a-z\\d-](?!--))*[a-z\\d])$": {
"type": "array",
"items": {
"type": "string"
}
}
},
"examples": [
{
"typing": ["boto3-stubs", "typing-extensions ~= 4.1"]
}
]
},
"dynamic": {
"title": "Dynamic metadata values",
"type": "array",
"items": {
"type": "string",
"enum": [
"version",
"description",
"readme",
"requires-python",
"license",
"authors",
"maintainers",
"keywords",
"classifiers",
"urls",
"scripts",
"gui-scripts",
"entry-points",
"dependencies",
"optional-dependencies"
]
},
"examples": [["version"]]
}
},
"oneOf": [
{
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "version"
}
}
}
},
{
"required": ["version"],
"properties": {
"version": true
}
}
],
"dependencies": {
"version": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "version"
}
}
}
}
},
"description": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "description"
}
}
}
}
},
"readme": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "readme"
}
}
}
}
},
"requires-python": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "requires-python"
}
}
}
}
},
"license": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "license"
}
}
}
}
},
"authors": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "authors"
}
}
}
}
},
"maintainers": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "maintainers"
}
}
}
}
},
"keywords": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "keywords"
}
}
}
}
},
"classifiers": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "classifiers"
}
}
}
}
},
"urls": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "urls"
}
}
}
}
},
"scripts": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "scripts"
}
}
}
}
},
"gui-scripts": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "gui-scripts"
}
}
}
}
},
"entry-points": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "entry-points"
}
}
}
}
},
"dependencies": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "dependencies"
}
}
}
}
},
"optional-dependencies": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "optional-dependencies"
}
}
}
}
}
}
}
},
"title": "JSON schema for Python project metadata and configuration",
"type": "object",
"x-taplo-info": {
"authors": ["zevisert (https://github.com/zevisert)"],
"pattern": ["^(.*(/|\\\\)pyproject\\.toml|pyproject\\.toml)$"]
}
}
|
root.json | {
"type": "object",
"properties": {
"UETVersion": {
"default": "BleedingEdge",
"enum": [
"BleedingEdge",
"2023.1233.816",
"2023.1229.371",
"2023.1208.344",
"2023.1208.305",
"2023.1208.293",
"2023.1208.207",
"2023.1207.1040",
"2023.1207.1023",
"2023.1207.995",
"2023.1207.991",
"2023.1207.969",
"2023.1207.739",
"2023.1207.726",
"2023.1207.445",
"2023.1207.424",
"2023.1206.700",
"2023.1206.569",
"2023.1206.556",
"2023.1203.1299",
"2023.1203.1239",
"2023.1203.1230",
"2023.1203.1147",
"2023.1203.948",
"2023.1203.925",
"2023.1203.686",
"2023.1203.613",
"2023.1202.725",
"2023.1200.1054",
"2023.1200.517",
"2023.1200.473",
"2023.1199.634",
"2023.1199.605",
"2023.1199.586",
"2023.1199.399",
"2023.1195.604",
"2023.1195.219",
"2023.1195.198",
"2023.1195.182",
"2023.1195.151",
"2023.1195.19",
"2023.1194.1031",
"2023.1194.1009",
"2023.1194.988",
"2023.1193.613",
"2023.1193.573",
"2023.1193.561",
"2023.1193.532",
"2023.1193.450",
"2023.1193.414",
"2023.1192.1015",
"2023.1192.371",
"2023.1189.1071",
"2023.1189.1061",
"2023.1189.897",
"2023.1189.849",
"2023.1189.844",
"2023.1188.246",
"2023.1186.457",
"2023.1185.1089"
]
}
},
"allOf": [
{
"if": {
"properties": {
"UETVersion": {
"const": "BleedingEdge"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1233.816.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1233.816"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1233.816.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1229.371"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1229.371.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1208.344"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1208.344.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1208.305"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1208.305.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1208.293"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1208.293.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1208.207"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1208.207.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.1040"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.1040.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.1023"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.1023.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.995"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.995.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.991"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.991.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.969"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.969.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.739"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.739.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.726"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.726.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.445"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.445.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1207.424"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1207.424.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1206.700"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1206.700.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1206.569"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1206.569.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1206.556"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1206.556.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.1299"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.1299.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.1239"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.1239.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.1230"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.1230.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.1147"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.1147.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.948"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.948.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.925"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.925.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.686"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.686.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1203.613"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1203.613.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1202.725"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1202.725.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1200.1054"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1200.1054.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1200.517"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1200.517.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1200.473"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1200.473.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1199.634"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1199.634.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1199.605"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1199.605.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1199.586"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1199.586.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1199.399"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1199.399.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1195.604"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1195.604.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1195.219"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1195.219.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1195.198"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1195.198.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1195.182"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1195.182.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1195.151"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1195.151.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1195.19"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1195.19.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1194.1031"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1194.1031.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1194.1009"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1194.1009.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1194.988"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1194.988.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1193.613"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1193.613.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1193.573"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1193.573.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1193.561"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1193.561.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1193.532"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1193.532.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1193.450"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1193.450.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1193.414"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1193.414.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1192.1015"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1192.1015.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1192.371"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1192.371.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1189.1071"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1189.1071.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1189.1061"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1189.1061.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1189.897"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1189.897.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1189.849"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1189.849.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1189.844"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1189.844.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1188.246"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1188.246.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1186.457"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1186.457.json"
}
},
{
"if": {
"properties": {
"UETVersion": {
"const": "2023.1185.1089"
}
}
},
"then": {
"$ref": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2023.1185.1089.json"
}
}
]
} |