name
stringlengths 7
62
| content
stringlengths 200
6.79M
|
|---|---|
ruleset_schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/ansible/ansible-rulebook/main/ansible_rulebook/schema/ruleset_schema.json",
"type": "array",
"items": {
"$ref": "#/$defs/ruleset"
},
"minItems": 1,
"examples": [
"rulebooks/*.yml",
"rulebooks/*.yaml"
],
"$defs": {
"ruleset": {
"type": "object",
"properties": {
"default_events_ttl": {
"type": "string",
"pattern": "^\\d+\\s(seconds?|minutes?|hours?|days?)$"
},
"hosts": {
"type": "string"
},
"gather_facts": {
"type": "boolean",
"default": false
},
"match_multiple_rules": {
"type": "boolean",
"default": false
},
"name": {
"type": "string"
},
"execution_strategy": {
"type": "string",
"enum": [
"parallel",
"sequential"
],
"default": "sequential"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/$defs/source"
}
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/rule"
}
}
},
"required": [
"hosts",
"sources",
"rules"
],
"additionalProperties": false
},
"source": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"filters": {
"type": "array",
"items": {
"type": "object"
}
}
},
"additionalProperties": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
},
"throttle": {
"type": "object",
"oneOf": [
{
"required": [
"once_within",
"group_by_attributes"
]
},
{
"required": [
"once_after",
"group_by_attributes"
]
}
],
"properties": {
"once_within": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
},
"once_after": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
},
"group_by_attributes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"rule": {
"type": "object",
"oneOf": [
{
"required": [
"name",
"condition",
"actions"
]
},
{
"required": [
"name",
"condition",
"action"
]
}
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"enabled": {
"type": "boolean"
},
"throttle": {
"$ref": "#/$defs/throttle"
},
"condition": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/all-condition"
},
{
"$ref": "#/$defs/any-condition"
},
{
"$ref": "#/$defs/not-all-condition"
}
]
},
"actions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/run-playbook-action"
},
{
"$ref": "#/$defs/run-module-action"
},
{
"$ref": "#/$defs/run-job-template-action"
},
{
"$ref": "#/$defs/run-workflow-template-action"
},
{
"$ref": "#/$defs/post-event-action"
},
{
"$ref": "#/$defs/set-fact-action"
},
{
"$ref": "#/$defs/retract-fact-action"
},
{
"$ref": "#/$defs/print-event-action"
},
{
"$ref": "#/$defs/debug-action"
},
{
"$ref": "#/$defs/none-action"
},
{
"$ref": "#/$defs/shutdown-action"
}
]
}
},
"action": {
"oneOf": [
{
"$ref": "#/$defs/run-playbook-action"
},
{
"$ref": "#/$defs/run-module-action"
},
{
"$ref": "#/$defs/run-job-template-action"
},
{
"$ref": "#/$defs/run-workflow-template-action"
},
{
"$ref": "#/$defs/post-event-action"
},
{
"$ref": "#/$defs/set-fact-action"
},
{
"$ref": "#/$defs/retract-fact-action"
},
{
"$ref": "#/$defs/print-event-action"
},
{
"$ref": "#/$defs/debug-action"
},
{
"$ref": "#/$defs/none-action"
},
{
"$ref": "#/$defs/shutdown-action"
}
]
}
},
"additionalProperties": false
},
"all-condition": {
"type": "object",
"properties": {
"all": {
"type": "array",
"items": {
"type": "string"
}
},
"timeout": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
}
},
"additionalProperties": false
},
"not-all-condition": {
"type": "object",
"properties": {
"not_all": {
"type": "array",
"items": {
"type": "string"
}
},
"timeout": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
}
},
"required": [
"timeout",
"not_all"
],
"additionalProperties": false
},
"any-condition": {
"type": "object",
"properties": {
"any": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"run-playbook-action": {
"type": "object",
"properties": {
"run_playbook": {
"type": "object",
"properties": {
"copy_files": {
"type": "boolean"
},
"name": {
"type": "string"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"ruleset": {
"type": "string"
},
"verbosity": {
"type": "integer"
},
"var_root": {
"type": [
"string",
"object"
]
},
"json_mode": {
"type": "boolean"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "number"
},
"extra_vars": {
"type": "object"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"run_playbook"
],
"additionalProperties": false
},
"run-module-action": {
"type": "object",
"properties": {
"run_module": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"verbosity": {
"type": "integer"
},
"var_root": {
"type": [
"string",
"object"
]
},
"json_mode": {
"type": "boolean"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "number"
},
"module_args": {
"type": [
"object",
"string"
]
},
"extra_vars": {
"type": "object"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"run_module"
],
"additionalProperties": false
},
"run-job-template-action": {
"type": "object",
"properties": {
"run_job_template": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"organization": {
"type": "string"
},
"job_args": {
"type": "object"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"ruleset": {
"type": "string"
},
"var_root": {
"type": "string"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "integer"
}
},
"required": [
"name",
"organization"
],
"additionalProperties": false
}
},
"required": [
"run_job_template"
],
"additionalProperties": false
},
"run-workflow-template-action": {
"type": "object",
"properties": {
"run_workflow_template": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"organization": {
"type": "string"
},
"job_args": {
"type": "object"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"ruleset": {
"type": "string"
},
"var_root": {
"type": "string"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "integer"
}
},
"required": [
"name",
"organization"
],
"additionalProperties": false
}
},
"required": [
"run_workflow_template"
],
"additionalProperties": false
},
"post-event-action": {
"type": "object",
"properties": {
"post_event": {
"type": "object",
"properties": {
"ruleset": {
"type": "string"
},
"event": {
"type": "object"
}
},
"required": [
"event"
],
"additionalProperties": false
}
},
"required": [
"post_event"
],
"additionalProperties": false
},
"set-fact-action": {
"type": "object",
"properties": {
"set_fact": {
"type": "object",
"properties": {
"ruleset": {
"type": "string"
},
"fact": {
"type": "object"
}
},
"required": [
"fact"
],
"additionalProperties": false
}
},
"required": [
"set_fact"
],
"additionalProperties": false
},
"retract-fact-action": {
"type": "object",
"properties": {
"retract_fact": {
"type": "object",
"properties": {
"ruleset": {
"type": "string"
},
"fact": {
"type": "object"
},
"partial": {
"type": "boolean",
"default": true
}
},
"required": [
"fact"
],
"additionalProperties": false
}
},
"required": [
"retract_fact"
],
"additionalProperties": false
},
"print-event-action": {
"type": "object",
"properties": {
"print_event": {
"type": [
"object",
"null"
],
"properties": {
"var_root": {
"type": [
"string",
"object"
]
},
"pretty": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"print_event"
],
"additionalProperties": false
},
"debug-msg": {
"type": "object",
"properties": {
"msg": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false
},
"debug-var": {
"type": "object",
"properties": {
"var": {
"type": "string"
}
},
"additionalProperties": false
},
"debug-action": {
"type": "object",
"properties": {
"debug": {
"anyOf": [
{
"$ref": "#/$defs/debug-msg"
},
{
"$ref": "#/$defs/debug-var"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"required": [
"debug"
]
},
"none-action": {
"type": "object",
"properties": {
"none": {
"type": [
"object",
"null"
]
}
},
"required": [
"none"
],
"additionalProperties": false
},
"shutdown-action": {
"type": "object",
"properties": {
"shutdown": {
"type": [
"object",
"null"
],
"properties": {
"delay": {
"type": "number"
},
"message": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"graceful",
"now"
]
}
},
"additionalProperties": false
}
},
"required": [
"shutdown"
],
"additionalProperties": false
}
}
}
|
paf-module.schema.json | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"line_endings": "unix",
"$id": "https://qualisys.com/schemas/paf-module",
"title": "Qualisys PAF Module",
"description": "A settings.paf file used by Qualisys Project Automation Framework (PAF) Modules",
"type": "object",
"properties": {
"Project ID": {
"title": "Project ID",
"description": "A human readable name that identifies the project. This name is recorded in data files and should not be changed once data collection has started as doing so will render data files useless.",
"type": "string"
},
"Root type": {
"title": "Root type",
"description": "Reference to the class or type name to use at the highest level in the PAF item hierarchy.",
"type": "string"
},
"Date format": {
"title": "Date format",
"description": "Specifies what date format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are Iso, Little endian and Middle endian.",
"enum": ["Iso", "Little endian", "Middle endian"]
},
"Date separator": {
"title": "Date separator",
"description": "Specifies which token to use to separate the parts of the dates when formatting them. Accepted values are Dash, Slash, Dot and None.",
"enum": ["Dash", "Slash", "Dot", "None"]
},
"Time format": {
"title": "Time format",
"description": "Specifies what time format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are 12-hour and 24-hour.",
"enum": ["12-hour", "24-hour"]
},
"Filename filter": {
"title": "Filename filter",
"description": "A regular expression that determines which files (in addition to the qtm files) that will be visible in the tree view.",
"type": "string"
},
"Export c3d settings": {
"title": "Export c3d settings",
"description": "This section is optional and is used when exporting to c3d file.",
"type": "object",
"properties": {
"Point units": {
"title": "Point units in C3D export",
"description": "Possible units are: mm, cm or m.",
"enum": ["mm", "cm", "m"]
}
}
},
"Default fields": {
"title": "Default fields",
"description": "A sequence of names of fields that will be added to all types. QTM also adds a number of default fields automatically. For a list of these, see the Default Fields section.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"Package Information": {
"description": "This section contains information that the package management system uses. It is used mainly when installing packages and when creating new projects based on a package.",
"type": "object",
"properties": {
"Name": {
"title": "Package name",
"description": "The name of the package. Shown when creating a new project and used to keep the connection between a project and the package it was created from to, for instance, know if there is a new version of a package. This means that this value should not be changed unless strictly necessary because that will break the connection between existing projects and new versions of the package.",
"type": "string"
},
"Version": {
"title": "Module version",
"description": "Two numbers separated by a period sign (e.g. 44.23), three numbers separated by period signs (e.g. 1.45.3214), or three numbers separated by a period sign and a build number separated by a plus sign (e.g. 1.3.0+188). The version of the package. Used to keep track of which version a project is based on. Visible in the about box when a project is open. Useful for debugging purposes and for knowing if the package can be upgraded.",
"type": "string",
"pattern": "^\\d+\\.\\d+(\\.\\d+(\\+\\d+)?)?$"
},
"Required QTM version": {
"title": "Required QTM version",
"description": "Two or three digits separated by a period sign. The QTM version that is required for this package to work properly. Checked on install time. Must include major and minor version number and can optionally include build number too.",
"type": "string",
"pattern": "^\\d+\\.\\d+(\\.\\d+)?$"
},
"Previous names": {
"title": "Previous names",
"description": "A sequence of names that this package has had earlier in development. This is used only when checking if a project should be upgraded and allows for packages to be renamed without losing the project upgrade path.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"Name",
"Version",
"Required QTM version"
]
},
"Types": {
"title": "Types definition",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Type",
"description": "All type names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values.",
"properties": {
"Fields": {
"title": "Field reference",
"description": "Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"patternProperties": {
".+": {
"title": "Class",
"description": "All class names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values.",
"properties": {
"Fields": {
"title": "Class fields",
"description": "Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "object",
"patternProperties": {
".+": {
"type": "string"
}
}
}
]
},
"Children": {
"title": "Children types or classes",
"description": "A sequence of references to class or type names that can be created as children to items of this type. A type that has children cannot have measurements.",
"type": "array",
"items": {
"type": "string"
}
},
"Measurements": {
"title": "Measurements",
"description": "A sequence of measurement type names. If a type has the measurement property, it is considered to be a session-like type. It cannot have other children and it will have a wizard interface containing measurements (of the types specified by this parameter) and analyses.",
"type": "array",
"items": {
"type": "string"
}
},
"Analyses": {
"title": "Analyses",
"description": "A sequence of analysis names. These will be shown in the Analyze dropdown of the session wizard. The first analysis in the list will be the default analysis that is run when the button itself is clicked.",
"type": "array",
"items": {
"type": "string"
}
},
"Display order": {
"title": "Field display order",
"description": "A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order.",
"type": "array",
"items": {
"type": "string"
}
},
"Heading": {
"title": "Field display order",
"description": "An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane.",
"type": "string"
},
"PDF guide": {
"title": "Path to PDF guide",
"description": "The path to a PDF file to show when the user clicks the Show guide button in the wizard pane.",
"type": "string"
},
"Directory pattern": {
"title": "Directory pattern",
"description": "A naming pattern for the directory created for each item (except measurements, for which this property is useless).\n\nThe pattern can contain any text as well as names of items braced by $ signs, so for instance the directory pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.\n\nAn item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.\n\nThe default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique.",
"type": "string"
},
"Icon": {
"title": "Path to icon file",
"description": "The path to an icon file (.ico) to show at the side of the item in the tree view. The path is relative to the `Templates` folder.",
"type": "string"
}
},
"patternProperties": {
".+": {
"title": "Field reference",
"description": "Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"oneOf": [
{ "required": ["Children"] },
{ "required": ["Measurements"] }
]
}
}
}
}
},
"Measurements": {
"title": "Measurement definitions",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Measurement",
"description": "A uniquely named measurement, defining its properties.",
"properties": {
"Fields": {
"title": "Class fields",
"description": "Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "object",
"patternProperties": {
".+": {
"type": "string"
}
}
}
]
},
"Count": {
"title": "Default measurement button count",
"description": "The default number of measurement buttons that kind of measurement in a new session.",
"type": "integer",
"minimum": 0
},
"Minimum count": {
"title": "Minimum measurement count",
"description": "The minimum number of measurements of that kind in a session. The +/- buttons will not allow the count to go below this and if any analysis lists this kind of measurement as a prerequisite, the analysis will not be available until the minimum number of measurements have been performed.",
"type": "integer",
"minimum": 0
},
"Maximum count": {
"title": "Maximum measurement count",
"description": "The maximum number of measurements of that kind in a session.",
"type": "integer",
"minimum": 0
},
"Measurement length": {
"title": "Measurement recording length",
"description": "The default length of this kind of measurement.",
"type": "number",
"minimum": 0
},
"Pretrigger length": {
"title": "Pretrigger length",
"description": "The length of the pretrigger buffer. Setting this to zero disables pretrigger. Leaving this option out uses the project setting for pretrigger.",
"type": "number",
"minimum": 0
},
"Frequency": {
"title": "Measurement frequency",
"description": "The frequency used for this kind of measurement. If omitted, the frequency is not changed when starting the measurement.",
"type": "number",
"minimum": 1
},
"AIM models": {
"title": "AIM models",
"description": "A semicolon separated list (not a YAML sequence) of AIM models that should be applied to measurements of this kind.",
"type": "string"
},
"Display fields dialog after creation": {
"title": "Display fields dialog after creation",
"description": "If this value is set to true, the fields dialog will be displayed when a measurement has finished to allow the user to edit the fields of the measurement item in the same way that dialog is displayed when other (non-measurement) items are created.",
"$ref": "#/$defs/yaml-boolean"
},
"Heading": {
"title": "Measurement heading",
"description": "An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane.",
"type": "string"
},
"Display order": {
"title": "Field display order",
"description": "A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"Measurement pattern": {
"title": "Measurement pattern",
"description": "A naming pattern for measurements created for each item. The pattern can contain any text as well as names of items braced by $ signs, so for instance the measurement pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.\n\nAn item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.\n\nThe default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique. The file extension .qtm will be added automatically. The default value is $TypeName$ $InstanceNumber$.",
"type": "string"
}
},
"patternProperties": {
".+": {
"title": "Field reference",
"description": "Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
}
},
"Analyses": {
"title": "Analysis definitions",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Analysis",
"description": "A uniquely named analysis, defining its properties.",
"properties": {
"Type": {
"title": "Analysis type",
"description": "Names of the analysis type. Valid values are External program, Visual3D, Report, Compound, HTTPRequest, Instantiate template, Create skeleton, Solve skeleton.\n\nNote: only External program and Compound are available to all users. Other types require the Project Automation Framework developer license which is used for internal Qualisys development and by development partners.",
"enum": ["External program", "Visual3D", "Report", "Compound", "HTTPRequest", "Instantiate template", "Create skeleton", "Solve skeleton"]
},
"Prerequisites": {
"title": "Measurement and/or analysis prerequisites",
"description": "A sequence of measurement type names and analysis names that has to be completed before this analysis can be run. Measurement types are considered complete for the current session when the user has made at least the number of measurements given by that measurement type’s Minimum count field. Analyses are considered complete when the file denoted by the Output file field exists.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"Output file": {
"title": "Output file",
"description": "The name of a file that is created when this analysis is run. QTM uses this to check if the analysis has been completed. It is also used to issue a warning if this file has been changed since the analysis was last run for the current session. This property can contain patterns.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "string"
}
]
},
"Program display name": {
"title": "Program display name",
"description": "External program only: The name to be displayed in the directories tab in project options where the user will have to locate the external executable. NB: Because this path varies between computers rather than between projects, it is not stored in the project, but in computer-global settings file.\n\nSeveral analyses in different projects may share the same Program display name and QTM will automatically use the same executable path for all of them.",
"type": "string"
},
"Export session": {
"title": "Export session",
"description": "External program only: Optional. If present, the metadata of the session, all its ancestors and the measurements are exported into a file called session.xml.",
"$ref": "#/$defs/yaml-boolean"
},
"Export measurements": {
"title": "Formats for measurement exports",
"description": "External program only: Optional. A single string or an array containing any combination of the following values: “TSV”, “C3D”, “MAT”. Will make QTM export all the selected measurements to the corresponding formats before running the external program. Use “xml settings” to export a file with measurement settings (e.g. capture start time and analog channel names). The file will be named [file name].settings.xml.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]
},
"minItems": 1
},
{
"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]
}
]
},
"Template files": {
"title": "Template files",
"description": "External program only: Optional. A single string or an array containing names of files in the template directory. Each file will be run through the PHP engine and the result written to a file with the same name in the session directory. Standard Windows wildcards are supported, but note that if the asterisk is used to match a part of the filename, the pattern must be enclosed in single quotation marks to make sure it is not parsed as a YAML alias.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "string"
}
]
},
"Working directory": {
"title": "Working directory",
"description": "External program only: Optional. The working directory set when the program is launched. Defaults to the session directory.",
"type": "string"
},
"Arguments": {
"title": "Arguments",
"description": "Optional. An array of arguments to be sent to the program being started. Each argument will be subject to pattern expansion and if the result contains spaces, it will be enclosed in double quotation marks when the command line is built.",
"type": "array",
"items": {
"type": "string"
}
},
"Show output file": {
"title": "Show output file",
"description": "External program only: Optional. If set, and if the Output file property has been specified, and if the execution of the external program is successful (exit code 0), the output file will be shown in the systems standard program for that file type (as if it was double-clicked in the windows explorer).",
"$ref": "#/$defs/yaml-boolean"
},
"Do not wait for Application": {
"title": "Do not wait for Application",
"description": "External program only: Optional. If analysis includes this property, QTM does not wait for external program to finish the processing. If property does not exit, to continue with subsequent analyses, external program must be closed manually (> QTM 2019.1).",
"$ref": "#/$defs/yaml-boolean"
},
"Pipeline template": {
"title": "Pipeline template",
"description": "Visual3D analysis only: Required. The name of a template file in the Templates directory. This file will be instantiated and used as the pipeline script in visual 3d.",
"type": "string"
},
"Do not wait for Visual3D": {
"title": "Do not wait for Visual3D",
"description": "Visual3D analysis only: Optional. If analysis includes this property, QTM does not wait for Visual3D to finish the processing. If property does not exit, to continue with subsequent analyses, Visual3D must be closed manually or Exit_Workspace; command has to be added to the very end of Visual3D script.",
"$ref": "#/$defs/yaml-boolean"
},
"Close Visual3D": {
"title": "Deprecated: Close Visual3D",
"deprecated": true,
"description": "Visual3D analysis only: Deprecated (> QTM 2.16).",
"enum": ["Never", "No Warnings"]
},
"Components": {
"title": "Compound analysis components",
"description": "Compound analysis only. Required. An array of analysis steps.",
"type": "array",
"items": {
"type": "string"
}
},
"Template": {
"title": "Template to instantiate",
"description": "Instantiate template analysis only: Required. The name of the input file. If this name contains any path delimiter tokens, it will be considered to be relative to the project directory, otherwise QTM will assume that the input file is placed in the templates folder.",
"type": "string"
},
"Measurements": {
"title": "Measurements where skeleton should be solved",
"description": "Create / Solve skeleton analyses only: Required. A string or list of strings to specify the file names to solve the skeletons. Wildcard can be used in the name to specify multiple files at once. To specify all measurements, simply use the wildcard character. Only measurements that are marked as used in the PAF pane will be affected.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"Exclude": {
"title": "Measurements where skeleton should _not_ be solved",
"description": "Create / Solve skeleton analyses only: Optional. A string or list of strings to specify the file names to exclude. Wildcard can be used in the name to specify multiple files at once. Only measurements that are marked as used in the PAF pane will be affected.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
}
}
}
},
"Fields": {
"title": "Field definitions",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Field",
"description": "A uniquely named field, defining its properties.",
"properties": {
"Type": {
"title": "Field type",
"description": "Required. Defines the type of the field. Possible values are Integer, Float, String, Date, TimeOfDay, Enum or Boolean.",
"enum": ["Integer", "Float", "String", "Date", "TimeOfDay", "Enum", "Boolean"]
},
"Hidden": {
"title": "Hidden field",
"description": "If the value is Yes or True, this field will not be displayed in the GUI (and thus will not be editable by the user) but will be exported to files. It will keep its default value.",
"$ref": "#/$defs/yaml-boolean"
},
"Readonly": {
"title": "Readonly field",
"description": "If the value is Yes or True this field will be displayed, but the user will not be able to edit it. It will keep its default value.",
"$ref": "#/$defs/yaml-boolean"
},
"Inherit": {
"title": "Inherit from parent fields",
"description": "This field will be inherited by all subitems of the item that contains it. There are two modes of inheritance Copy and Connect and the value of this property has to be one of them.\n\nCopy: Inheritance by copying means that when a child to an item that has an inheritable field is created, a field with the same name is created in the child and the value of the field in the parent is copied to that field.\n\nConnect fields work the same way when an item is created, but if the field is changed in any of the items (any ancestor or heir) it is updated in all the items that have inherited this field from the same origin. If, for instance, a value is inherited by connection from a patient to a number of sessions and the measurements in those sessions and it is changed in one of the sessions it is changed in all those objects, but not in other patients and the sessions of those patients.\n\nFields are inherited all the down to the leaves from the item including the fields so if the root item would include an inherited field, it would be copied to all items in the tree.",
"enum": ["Copy", "Connect"]
},
"Default": {
"title": "Default field value",
"description": "The default value that this field will get when an item that contains it is created. This can be overridden in the item type specification and by inheritance. The value of this property should have the same data type as the field. String fields can also specify a sequence as default value. The sequence will be converted into a string containing the elements of the sequence separated by semicolon.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"Max": {
"title": "Maximum value",
"description": "Integer / Float types only: The maximum value that can be entered in this field.",
"type": "number"
},
"Min": {
"title": "Minimum value",
"description": "Integer / Float types only: The minimum value that can be entered in this field.",
"type": "number"
},
"Quantity": {
"title": "Field physical quantity",
"description": "Float type only: The physical quantity that this field represents. This list contains the basic physical quantities but also some derived quantities because there is no possibility to combine quantities.",
"enum": [
"Length",
"Mass",
"Voltage",
"Current",
"Force",
"Moment",
"Power",
"Angle",
"Time",
"Frequency",
"Temperature",
"Speed",
"Acceleration",
"Magnetic field strength",
"Rotational speed"
]
},
"Unit": {
"title": "Field unit",
"description": "Float type only: The unit of this field. Can only be specified if a quantity has been specified. Different units apply to different quantities. Either the unit name or the abbreviation can be given. If a unit is not entered, the S/I unit is used.",
"enum": [
"meters",
"ångstroms",
"nanometers",
"microns",
"millimeters",
"centimeters",
"kilometers",
"inches",
"feet",
"yards",
"miles",
"kilograms",
"micrograms",
"milligrams",
"grams",
"ounces",
"pounds",
"volts",
"nanovolts",
"microvolts",
"millivolts",
"kilovolts",
"ampere",
"nanoampere",
"microampere",
"milliampere",
"kiloampere",
"newtons",
"millinewtons",
"kilonewtons",
"meganewtons",
"kiloponds",
"pounds force",
"newtonmeter",
"newtonmillimeter",
"watt",
"radians",
"degrees",
"seconds",
"minutes",
"hours",
"hertz",
"kilohertz",
"megahertz",
"revolutions per minute",
"beats per minute",
"kelvin",
"degrees celsius",
"degrees farenheit",
"meters per second",
"millimeters per second",
"kilometers per hour",
"feet per second",
"miles per hour",
"knots",
"meters per second squared",
"millimeters per second squared",
"feet per second squared",
"standard gravity",
"tesla",
"millitesla",
"degrees per second",
"Meters",
"Ångstroms",
"Nanometers",
"Microns",
"Millimeters",
"Centimeters",
"Kilometers",
"Inches",
"Feet",
"Yards",
"Miles",
"Kilograms",
"Micrograms",
"Milligrams",
"Grams",
"Ounces",
"Pounds",
"Volts",
"Nanovolts",
"Microvolts",
"Millivolts",
"Kilovolts",
"Ampere",
"Nanoampere",
"Microampere",
"Milliampere",
"Kiloampere",
"Newtons",
"Millinewtons",
"Kilonewtons",
"Meganewtons",
"Kiloponds",
"Pounds force",
"Newtonmeter",
"Newtonmillimeter",
"Watt",
"Radians",
"Degrees",
"Seconds",
"Minutes",
"Hours",
"Hertz",
"Kilohertz",
"Megahertz",
"Revolutions per minute",
"Beats per minute",
"Kelvin",
"Degrees celsius",
"Degrees farenheit",
"Meters per second",
"Millimeters per second",
"Kilometers per hour",
"Feet per second",
"Miles per hour",
"Knots",
"Meters per second squared",
"Millimeters per second squared",
"Feet per second squared",
"Standard gravity",
"Tesla",
"Millitesla",
"Degrees per second",
"m/s"
]
},
"Decimals": {
"title": "Field decimal count",
"description": "Float type only: The number of decimals to present to the user.",
"type": "integer"
},
"Force": {
"title": "Force non-empty string",
"description": "String type only: Force the string to be non-empty.",
"$ref": "#/$defs/yaml-boolean"
},
"JSON": {
"title": "Treat string as JSON object",
"description": "String type only: The string should be returned as JSON object when queried from the REST api. JSON fields are not exported to session.xml during the analysis step. (Available from QTM 2.14).",
"$ref": "#/$defs/yaml-boolean"
},
"Values": {
"title": "Enum values",
"description": "Enum type only: The enum field defines an enumeration. To the user it will be presented as a multiple selection and internally it will be saved as a numeric value. The possible values that an enum can have has to be specified in the Values property. This property can be either a sequence or a map.\n\nIf it is a sequence it simply lists the choices of the enum and these will be assigned an integer value automatically.\n\nIf it is a map it is a map from the choices to the numeric value of each particular choice.",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"Display": {
"title": "Boolean display",
"description": "Boolean type only: Controls how this value will be displayed. Can be one of yesno, checkbox or truefalse.",
"enum": [
"yesno",
"checkbox",
"truefalse",
"YesNo",
"Checkbox",
"TrueFalse"
]
}
},
"required": [
"Type"
]
}
}
},
"Columns": {
"title": "Column definitions",
"description": "The columns section specifies the columns of the tree view in the project view. It allows the PAF file to specify multiple column setups. The idea is that the users should be able to switch between different configurations and possibly also add their own but currently only the first setup is used.",
"type": "object",
"patternProperties": {
".+": {
"title": "Column setup",
"description": "A uniquely named column setup. Each setup contains an arbitrary number of columns.",
"patternProperties": {
".+": {
"title": "Column",
"description": "A uniquely named column. Each column can specify a width (in pixels) and a way of determining the value displayed in the column. A key to understanding the column values is the understanding that each row in the tree view might contain a different type of item.",
"properties": {
"Width": {
"title": "Column width",
"description": "The width (in pixels) of this column.",
"type": "integer"
},
"Field": {
"title": "Column field",
"description": "The column will contain the value of the field named by this property regardless of the type of the item on the row.",
"type": "string"
},
"Fields": {
"title": "Column fields (with name mapping)",
"description": "A map from the item type name to the field to use. For each item type that is present as a key in the map the value of the field named will be used. For item types that are not named in the map the default field name will be used.",
"type": "object",
"properties": {
"Default": {
"title": "Default field",
"description": "Name used for item types not named in the map.",
"type": "string"
}
},
"patternProperties": {
".+": {
"title": "Field mapping",
"description": "Name used for item types not named in the map.",
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"Name": {
"title": "Type name",
"description": "",
"type": "string"
},
"Editable": {
"title": "Editable values",
"description": "If yes or true, the value of the field can be edited directly in the tree.",
"$ref": "#/$defs/yaml-boolean"
}
}
}
]
}
}
}
}
}
}
}
}
}
},
"required": [
"Project ID",
"Root type",
"Types",
"Columns"
],
"$defs": {
"yaml-boolean": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["Yes", "yes", "No", "no"]
}
]
}
}
} |
ninjs-2.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "A news item as JSON object -- copyright 2021 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_2.0.json#",
"name": "ninjs",
"properties": {
"uri": {
"title": "Uniform Resource Identifier",
"description": "The global unique identifier for this news object. This is the only required property and should identify the ninjs object, not be used for links to external resources etc. 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.). See: http://cv.iptc.org/newscodes/ninature/ nar:itemClass",
"type": "string",
"enum": [
"text",
"audio",
"video",
"picture",
"graphic",
"composite",
"component"
]
},
"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": ["full", "partial"]
},
"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 this ninjs object 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 this ninjs object was created. nar:versionCreated",
"type": "string",
"format": "date-time"
},
"contentcreated": {
"title": "Content created",
"description": "The date and time when the content of this ninjs object was originally created. For example and old photo that is now handled as a ninjs object. nar:contentCreated",
"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. Values 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 intended to be published. (Added in version 1.2 from issue #6.). (Consider using this before using the descriptions array.) 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"
},
"descriptions": {
"title": "Descriptions",
"description": "An array of one or more descriptions of the ninjs object. See also ednote for information from provider to reciever. Descriptions are seen as metadata. For a simple description use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.",
"type": "array",
"items": {
"type": "object",
"required": ["value"],
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of this description",
"type": "string"
},
"contenttype": {
"title": "Content Type",
"description": "The IANA (Internet Assigned Numbers Authority) MIME type of the content of this description.",
"type": "string"
},
"value": {
"title": "Value",
"description": "The descriptive text identified with the above role (and contenttype).",
"type": "string"
}
}
}
},
"bodies": {
"title": "Bodies",
"description": "An array of body objects with the content as text or with markup. For a simple body use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.",
"type": "array",
"items": {
"type": "object",
"required": ["value"],
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of this body",
"type": "string"
},
"contenttype": {
"title": "Content Type",
"description": "The IANA (Internet Assigned Numbers Authority) MIME type of the content of this body.",
"type": "string"
},
"charcount": {
"title": "Character count",
"description": "The total character count in this body 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 this body excluding figure captions. (Added in version 1.2 according to issue #27.). nar:wordcount",
"type": "number"
},
"value": {
"title": "Value",
"description": "The body text identified with the above role and contenttype.",
"type": "string"
}
}
}
},
"headlines": {
"title": "Headlines",
"description": "An array of objects containing various types of headlines. For a simple headline use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.",
"type": "array",
"items": {
"type": "object",
"required": ["value"],
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of this headline",
"type": "string"
},
"contenttype": {
"title": "Content Type",
"description": "The IANA (Internet Assigned Numbers Authority) MIME type of the content of this headline.",
"type": "string"
},
"value": {
"title": "Value",
"description": "The headline identified with the above role and contenttype.",
"type": "string"
}
}
}
},
"people": {
"title": "People",
"description": "An array of objects describing individual human beings. 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"
},
"uri": {
"title": "URI",
"description": "The identifier for the person as a complete uri with the code.",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the person as a literal value.",
"type": "string"
}
}
}
},
"organisations": {
"title": "Organisations",
"description": "An array of objects describing administrative and functional structures which may, for example, 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"
},
"uri": {
"title": "URI",
"description": "The identifier of the organisation as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the organisation as a literal",
"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"
}
}
}
}
}
}
},
"places": {
"title": "Places",
"description": "An array of named locations. nar:subject",
"additionalProperties": false,
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"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"
},
"uri": {
"title": "URI",
"description": "The identifier for the place as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the place as a literal",
"type": "string"
}
}
},
{
"$ref": "https://json.schemastore.org/geojson"
}
]
}
},
"subjects": {
"title": "Subjects",
"description": "An array of objects holding concepts 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"
},
"uri": {
"title": "URI",
"description": "The identifier of the subject as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the subject as a string literal",
"type": "string"
}
}
}
},
"events": {
"title": "Events",
"description": "An array of objects describing 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"
},
"uri": {
"title": "URI",
"description": "The identifier for the event as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the event as a string literal",
"type": "string"
}
}
}
},
"objects": {
"title": "Objects",
"description": "An array of objects describing 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"
},
"uri": {
"title": "URI",
"description": "The identifier for the object as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the object as a string literal",
"type": "string"
}
}
}
},
"infosources": {
"title": "Info sources",
"description": "An array of parties (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"
},
"role": {
"title": "Role",
"description": "The role the infosource in relationship to the content as a uri.",
"type": "string",
"format": "uri"
},
"uri": {
"title": "URI",
"description": "The identifier of the infosource as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the infosource as a string literal",
"type": "string"
}
}
}
},
"title": {
"title": "Title",
"description": "A short natural-language name for the item. Title is metadata, use headlines for publishable headlines. (Added in version 1.2 according to issue #9). nar:itemMeta/title",
"type": "string"
},
"by": {
"title": "By",
"description": "A natural-language statement about the creator (author, photographer etc.) of the content. nar:by",
"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"
},
"renditions": {
"title": "Renditions",
"description": "An array of objects with different renditions of the news object. nar:remoteContent",
"type": "array",
"additionalProperties": false,
"items": {
"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,
"required": ["name"],
"properties": {
"name": {
"title": "Name",
"description": "The name of this object in the array of renditions. For example 'thumbnail'",
"type": "string"
},
"href": {
"title": "href",
"description": "The URL for accessing the rendition as a resource. nar:remoteContent@ref",
"type": "string",
"format": "uri"
},
"contenttype": {
"title": "Content Type",
"description": "A MIME type which applies to this 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": {
"title": "Associations",
"description": "An array of objects with content of news objects which are associated with this news object.",
"type": "array",
"additionalProperties": false,
"items": {
"description": "One associated object where each object can use all properties in ninjs.",
"type": "object",
"anyOf": [
{
"properties": {
"name": {
"type": "string",
"description": "The name of this object in the array of associations. For example 'logo'"
}
},
"required": ["name"]
},
{
"$ref": "#"
}
]
}
},
"altids": {
"title": "Alternative ids",
"description": "Alternative identifiers assigned to the content. Each alternative id can have a role and a value. nar:altId issue #3.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of the alternative id",
"type": "string"
},
"value": {
"title": "Value",
"description": "The alternative id value",
"type": "string"
}
}
}
},
"trustindicators": {
"title": "Trust indicators",
"description": "An array of objects to allow links to documents about trust indicators. issue #44. (Added in version 1.3)",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of the trust indicator as a complete uri",
"type": "string",
"format": "uri"
},
"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": {
"title": "Name of standard.",
"description": "For example ninjs. nar:standard",
"type": "string"
},
"version": {
"title": "Version of standard.",
"description": "For example 1.3. nar:standardversion",
"type": "string"
},
"schema": {
"title": "Schema",
"description": "The uri of the json schema to use for validation.",
"type": "string",
"format": "uri"
}
}
},
"genres": {
"title": "Genres",
"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"
},
"uri": {
"title": "URI",
"description": "The identifier of the genre as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the genre as a string literal",
"type": "string"
}
}
}
},
"rightsinfo": {
"title": "Rights information",
"type": "object",
"description": "Expression of rights to be applied to content. nar:rightsInfo",
"properties": {
"langid": {
"type": "string",
"title": "Language id",
"description": "Identifier for the Rights Expression language used. nar:@langid",
"format": "uri"
},
"linkedrights": {
"title": "Linked rights",
"description": "A link from the current Item to Web resource with rights related information. nar:link",
"type": "string",
"format": "uri"
},
"encodedrights": {
"title": "Encoded Rights",
"additionalProperties": false,
"type": "string",
"description": "Contains a rights expression as defined by a Rights Expression Language. nar:rightsExpressionXML or nar:rightsExpressionData"
}
},
"oneOf": [
{
"required": ["linkedrights"]
},
{
"required": ["encodedrights"]
}
]
}
},
"required": ["uri"],
"title": "IPTC ninjs - News in JSON - version 2.0 (approved at IPTC Standards Committee October 2021)",
"type": "object"
}
|
snapcraft.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"grammar-string": {
"oneOf": [
{
"type": "string",
"usage": "<string>"
},
{
"type": "array",
"items": {
"minitems": 1,
"uniqueItems": true,
"oneOf": [
{
"type": "object",
"usage": "on <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^on\\s+.+$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "object",
"usage": "to <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^to\\s+.+$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "object",
"usage": "try:",
"additionalProperties": false,
"patternProperties": {
"^try$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "object",
"usage": "else:",
"additionalProperties": false,
"patternProperties": {
"^else$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "string",
"pattern": "else fail"
}
]
}
}
]
},
"grammar-array": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"oneOf": [
{
"type": "string",
"usage": "<string>"
},
{
"type": "object",
"usage": "on <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^on\\s+.+$": {
"$ref": "#/definitions/grammar-array"
}
}
},
{
"type": "object",
"usage": "to <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^to\\s+.+$": {
"$ref": "#/definitions/grammar-array"
}
}
},
{
"type": "object",
"usage": "try:",
"additionalProperties": false,
"patternProperties": {
"^try$": {
"$ref": "#/definitions/grammar-array"
}
}
},
{
"type": "object",
"usage": "else:",
"additionalProperties": false,
"patternProperties": {
"^else$": {
"$ref": "#/definitions/grammar-array"
}
}
}
]
}
},
"build-environment-grammar": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"oneOf": [
{
"type": "object",
"minProperties": 1,
"maxProperties": 1,
"additionalProperties": {
"type": "string"
}
},
{
"type": "object",
"usage": "on <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^on\\s+.+$": {
"$ref": "#/definitions/build-environment-grammar"
}
}
},
{
"type": "object",
"usage": "to <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^to\\s+.+$": {
"$ref": "#/definitions/build-environment-grammar"
}
}
},
{
"type": "object",
"usage": "else:",
"additionalProperties": false,
"patternProperties": {
"^else$": {
"$ref": "#/definitions/build-environment-grammar"
}
}
}
]
}
},
"apt-deb": {
"type": "object",
"description": "deb repositories",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"apt"
]
},
"architectures": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"description": "Architectures to enable, or restrict to, for this repository. Defaults to host architecture."
}
},
"formats": {
"type": "array",
"description": "deb types to enable. Defaults to [deb, deb-src].",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"deb",
"deb-src"
]
}
},
"components": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"description": "Deb repository components to enable, e.g. 'main, multiverse, unstable'"
}
},
"key-id": {
"type": "string",
"description": "GPG key identifier / fingerprint. May be used to identify key file in <project>/snap/keys/<key-id>.asc",
"pattern": "^[A-Z0-9]{40}$"
},
"key-server": {
"type": "string",
"description": "GPG keyserver to use to fetch GPG <key-id>, e.g. 'keyserver.ubuntu.com'. Defaults to keyserver.ubuntu.com if key is not found in project."
},
"path": {
"type": "string",
"description": "Exact path to repository (relative to URL). Cannot be used with suites or components."
},
"suites": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"description": "Deb repository suites to enable, e.g. 'xenial-updates, xenial-security')."
}
},
"url": {
"type": "string",
"description": "Deb repository URL, e.g. 'http://archive.canonical.com/ubuntu'."
}
},
"required": [
"type",
"key-id",
"url"
],
"validation-failure": "{!r} is not properly configured deb repository"
},
"apt-ppa": {
"type": "object",
"description": "PPA repository",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"apt"
]
},
"ppa": {
"type": "string",
"description": "ppa path: e.g. 'canonical-kernel-team/unstable'"
}
},
"required": [
"type",
"ppa"
],
"validation-failure": "{!r} is not properly configured PPA repository"
},
"system-username-scope": {
"type": "string",
"description": "short-form user configuration (<username>: <scope>)",
"enum": [
"shared"
],
"validation-failure": "{!r} is not a valid user scope. Valid scopes include: 'shared'"
},
"environment": {
"type": "object",
"description": "environment entries",
"minItems": 1,
"additionalProperties": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "number"
}
]
}
}
},
"title": "snapcraft schema",
"type": "object",
"properties": {
"build-packages": {
"$ref": "#/definitions/grammar-array",
"description": "top level build packages."
},
"adopt-info": {
"type": "string",
"description": "name of the part that provides source files that will be parsed to extract snap metadata information"
},
"name": {
"description": "name of the snap package",
"allOf": [
{
"$comment": "string, but not too long. the failure message avoids printing repr of the thing, as it could be huge",
"type": "string",
"validation-failure": "snap names need to be strings.",
"maxLength": 40
},
{
"pattern": "^[a-z0-9-]*[a-z][a-z0-9-]*$",
"validation-failure": "{.instance!r} is not a valid snap name. Snap names can only use ASCII lowercase letters, numbers, and hyphens, and must have at least one letter."
},
{
"pattern": "^[^-]",
"validation-failure": "{.instance!r} is not a valid snap name. Snap names cannot start with a hyphen."
},
{
"pattern": "[^-]$",
"validation-failure": "{.instance!r} is not a valid snap name. Snap names cannot end with a hyphen."
},
{
"not": {
"pattern": "--"
},
"validation-failure": "{.instance!r} is not a valid snap name. Snap names cannot have two hyphens in a row."
}
]
},
"title": {
"$comment": "https://forum.snapcraft.io/t/title-length-in-snapcraft-yaml-snap-yaml/8625/10",
"description": "title for the snap",
"type": "string",
"maxLength": 40
},
"architectures": {
"description": "architectures on which to build, and on which the resulting snap runs",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"format": "architectures",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"build-on"
],
"properties": {
"build-on": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true
}
]
},
"run-on": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true
}
]
}
}
}
]
}
},
"version": {
"description": "package version",
"allOf": [
{
"type": "string",
"validation-failure": "snap versions need to be strings. They must also be wrapped in quotes when the value will be interpreted by the YAML parser as a non-string. Examples: '1', '1.2', '1.2.3', git (will be replaced by a git describe based version string)."
},
{
"pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9:.+~-]*[a-zA-Z0-9+~])?$",
"maxLength": 32,
"validation-failure": "{.instance!r} is not a valid snap version string. Snap versions consist of upper- and lower-case alphanumeric characters, as well as periods, colons, plus signs, tildes, and hyphens. They cannot begin with a period, colon, plus sign, tilde, or hyphen. They cannot end with a period, colon, or hyphen."
}
]
},
"version-script": {
"type": "string",
"description": "a script that echoes the version to set."
},
"license": {
"type": "string",
"description": "the license the package holds"
},
"icon": {
"type": "string",
"description": "path to a 512x512 icon representing the package.",
"format": "icon-path"
},
"summary": {
"type": "string",
"description": "one line summary for the package",
"maxLength": 78
},
"description": {
"type": "string",
"description": "long description of the package",
"pattern": ".+",
"validation-failure": "{.instance!r} is not a valid description string."
},
"assumes": {
"type": "array",
"description": "featureset the snap requires in order to work.",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
"type": {
"type": "string",
"description": "the snap type, the implicit type is 'app'",
"enum": [
"app",
"base",
"gadget",
"kernel",
"snapd"
]
},
"frameworks": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
"confinement": {
"type": "string",
"description": "the type of confinement supported by the snap",
"default": "strict",
"enum": [
"classic",
"devmode",
"strict"
]
},
"grade": {
"type": "string",
"description": "the quality grade of the snap",
"default": "stable",
"enum": [
"stable",
"devel"
]
},
"base": {
"type": "string",
"description": "the base snap to use"
},
"build-base": {
"type": "string",
"description": "force a build environment based on base to create a snap"
},
"epoch": {
"description": "the snap epoch, used to specify upgrade paths",
"format": "epoch"
},
"compression": {
"description": "compression to use for snap archive - default is otherwise determined by 'snap pack'",
"type": "string",
"enum": [
"lzo",
"xz"
]
},
"environment": {
"description": "environment entries for the snap as a whole",
"$ref": "#/definitions/environment"
},
"passthrough": {
"type": "object",
"description": "properties to be passed into snap.yaml as-is"
},
"layout": {
"type": "object",
"description": "layout property to be passed into the snap.yaml as-is"
},
"package-repositories": {
"type": "array",
"description": "additional repository configuration.",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"oneOf": [
{
"$ref": "#/definitions/apt-deb"
},
{
"$ref": "#/definitions/apt-ppa"
}
]
}
]
},
"system-usernames": {
"type": "object",
"description": "system username",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid system-username.",
"patternProperties": {
"^snap_(daemon|microk8s|aziotedge|aziotdu)$": {
"oneOf": [
{
"$ref": "#/definitions/system-username-scope"
},
{
"type": "object",
"description": "long-form user configuration",
"additionalProperties": false,
"properties": {
"scope": {
"$ref": "#/definitions/system-username-scope"
}
},
"required": [
"scope"
]
}
]
}
}
},
"donation": {
"oneOf": [
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
{
"type": "string"
}
]
},
"issues": {
"oneOf": [
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
{
"type": "string"
}
]
},
"contact": {
"oneOf": [
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
{
"type": "string"
}
]
},
"source-code": {
"type": "string"
},
"website": {
"type": "string"
},
"apps": {
"type": "object",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid app name. App names consist of upper- and lower-case alphanumeric characters and hyphens. They cannot start or end with a hyphen.",
"patternProperties": {
"^[a-zA-Z0-9](?:-?[a-zA-Z0-9])*$": {
"type": "object",
"required": [
"command"
],
"dependencies": {
"bus-name": [
"daemon"
],
"activates-on": [
"daemon"
],
"refresh-mode": [
"daemon"
],
"stop-mode": [
"daemon"
],
"stop-command": [
"daemon"
],
"start-timeout": [
"daemon"
],
"stop-timeout": [
"daemon"
],
"watchdog-timeout": [
"daemon"
],
"restart-delay": [
"daemon"
],
"post-stop-command": [
"daemon"
],
"reload-command": [
"daemon"
],
"restart-condition": [
"daemon"
],
"before": [
"daemon"
],
"after": [
"daemon"
],
"timer": [
"daemon"
],
"install-mode": [
"daemon"
]
},
"additionalProperties": false,
"properties": {
"autostart": {
"type": "string",
"description": "Name of the desktop file placed by the application in $SNAP_USER_DATA/.config/autostart to indicate that application should be started with the user's desktop session.",
"pattern": "^[A-Za-z0-9. _#:$-]+\\.desktop$",
"validation-failure": "{.instance!r} is not a valid desktop file name (e.g. myapp.desktop)"
},
"common-id": {
"type": "string",
"description": "common identifier across multiple packaging formats"
},
"bus-name": {
"type": "string",
"description": "D-Bus name this service is reachable as",
"pattern": "^[A-Za-z0-9/. _#:$-]*$",
"validation-failure": "{.instance!r} is not a valid bus name."
},
"activates-on": {
"type": "array",
"description": "dbus interface slots this service activates on",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"desktop": {
"type": "string",
"description": "path to a desktop file representing the app, relative to the prime directory"
},
"command": {
"type": "string",
"description": "command executed to run the binary"
},
"completer": {
"type": "string",
"description": "bash completion script relative to the prime directory"
},
"stop-command": {
"type": "string",
"description": "command executed to stop a service"
},
"post-stop-command": {
"type": "string",
"description": "command executed after stopping a service"
},
"start-timeout": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid timeout value.",
"description": "Optional time to wait for daemon to start - <n>ns | <n>us | <n>ms | <n>s | <n>m"
},
"stop-timeout": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid timeout value.",
"description": "Optional time to wait for daemon to stop - <n>ns | <n>us | <n>ms | <n>s | <n>m"
},
"watchdog-timeout": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid timeout value.",
"description": "Service watchdog timeout - <n>ns | <n>us | <n>ms | <n>s | <n>m"
},
"reload-command": {
"type": "string",
"description": "Command to use to ask the service to reload its configuration."
},
"restart-delay": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid delay value.",
"description": "Delay between service restarts - <n>ns | <n>us | <n>ms | <n>s | <n>m. Defaults to unset. See the systemd.service manual on RestartSec for details."
},
"timer": {
"type": "string",
"description": "The service is activated by a timer, app must be a daemon. (systemd.time calendar event string)"
},
"daemon": {
"type": "string",
"description": "signals that the app is a service.",
"enum": [
"simple",
"forking",
"oneshot",
"notify",
"dbus"
]
},
"after": {
"type": "array",
"description": "List of applications that are ordered to be started after the current one",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"before": {
"type": "array",
"description": "List of applications that are ordered to be started before the current one",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"refresh-mode": {
"type": "string",
"description": "controls if the app should be restarted at all",
"enum": [
"endure",
"restart"
]
},
"stop-mode": {
"type": "string",
"description": "controls how the daemon should be stopped",
"enum": [
"sigterm",
"sigterm-all",
"sighup",
"sighup-all",
"sigusr1",
"sigusr1-all",
"sigusr2",
"sigusr2-all",
"sigint",
"sigint-all"
]
},
"restart-condition": {
"type": "string",
"enum": [
"on-success",
"on-failure",
"on-abnormal",
"on-abort",
"on-watchdog",
"always",
"never"
]
},
"install-mode": {
"type": "string",
"enum": [
"enable",
"disable"
]
},
"slots": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"plugs": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"aliases": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][-_.a-zA-Z0-9]*$",
"validation-failure": "{.instance!r} is not a valid alias. Aliases must be strings, begin with an ASCII alphanumeric character, and can only use ASCII alphanumeric characters and the following special characters: . _ -"
}
},
"environment": {
"description": "environment entries for the specific app.",
"$ref": "#/definitions/environment"
},
"adapter": {
"$comment": "Full should be the default, but it requires command-chain which isn't available in snapd until 2.36, which isn't yet stable. Until 2.36 is generally available, continue with legacy as the default.",
"type": "string",
"description": "What kind of wrapper to generate for the given command",
"enum": [
"none",
"legacy",
"full"
],
"default": "legacy"
},
"command-chain": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9/._#:$-]*$",
"validation-failure": "{.instance!r} is not a valid command-chain entry. Command chain entries must be strings, and can only use ASCII alphanumeric characters and the following special characters: / . _ # : $ -"
}
},
"sockets": {
"type": "object",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid socket name. Socket names consist of lower-case alphanumeric characters and hyphens.",
"patternProperties": {
"^[a-z][a-z0-9_-]*$": {
"type": "object",
"required": [
"listen-stream"
],
"description": "Sockets for automatic service activation",
"additionalProperties": false,
"properties": {
"listen-stream": {
"anyOf": [
{
"type": "integer",
"usage": "port number, an integer between 1 and 65535",
"minimum": 1,
"maximum": 65535
},
{
"type": "string",
"usage": "socket path, a string"
}
]
},
"socket-mode": {
"type": "integer"
}
}
}
}
},
"passthrough": {
"type": "object",
"description": "properties to be passed into snap.yaml as-is"
},
"extensions": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"enum": [
"flutter-stable",
"flutter-beta",
"flutter-dev",
"flutter-master",
"gnome",
"gnome-3-28",
"gnome-3-34",
"gnome-3-38",
"kde-neon",
"ros1-noetic",
"ros2-foxy"
]
}
}
}
}
}
},
"hooks": {
"type": "object",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid hook name. Hook names consist of lower-case alphanumeric characters and hyphens. They cannot start or end with a hyphen.",
"patternProperties": {
"^[a-z](?:-?[a-z0-9])*$": {
"type": "object",
"additionalProperties": false,
"properties": {
"command-chain": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9/._#:$-]*$",
"validation-failure": "{.instance!r} is not a valid command-chain entry. Command chain entries must be strings, and can only use ASCII alphanumeric characters and the following special characters: / . _ # : $ -"
}
},
"environment": {
"description": "environment entries for this hook",
"$ref": "#/definitions/environment"
},
"plugs": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"passthrough": {
"type": "object",
"description": "properties to be passed into snap.yaml as-is"
}
}
}
}
},
"parts": {
"type": "object",
"minProperties": 1,
"additionalProperties": false,
"validation-failure": "{!r} is not a valid part name. Part names consist of lower-case alphanumeric characters, hyphens and plus signs. As a special case, 'plugins' is also not a valid part name.",
"patternProperties": {
"^(?!plugins$)[a-z0-9][a-z0-9+-]*$": {
"type": [
"object",
"null"
],
"minProperties": 1,
"required": [
"plugin"
],
"properties": {
"plugin": {
"type": "string",
"description": "plugin name"
},
"source": {
"$ref": "#/definitions/grammar-string"
},
"source-checksum": {
"type": "string",
"default": ""
},
"source-branch": {
"type": "string",
"default": ""
},
"source-commit": {
"type": "string",
"default": ""
},
"source-depth": {
"type": "integer",
"default": 0
},
"source-submodules": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"description": "submodules to fetch, by pathname in source tree"
}
},
"source-subdir": {
"type": "string",
"default": ""
},
"source-tag": {
"type": "string",
"default": ""
},
"source-type": {
"type": "string",
"default": "",
"enum": [
"bzr",
"git",
"hg",
"mercurial",
"subversion",
"svn",
"tar",
"zip",
"deb",
"rpm",
"7z",
"local"
]
},
"disable-parallel": {
"type": "boolean",
"default": false
},
"after": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": []
},
"stage-snaps": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"stage-packages": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"build-snaps": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"build-packages": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"build-environment": {
"$ref": "#/definitions/build-environment-grammar",
"default": []
},
"build-attributes": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"core22-step-dependencies",
"enable-patchelf",
"no-patchelf",
"no-install",
"debug",
"keep-execstack"
]
},
"default": []
},
"organize": {
"type": "object",
"default": {},
"additionalProperties": {
"type": "string",
"minLength": 1
}
},
"filesets": {
"type": "object",
"default": {},
"additionalProperties": {
"type": "array",
"minitems": 1
}
},
"stage": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": [
"*"
]
},
"prime": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": [
"*"
]
},
"override-pull": {
"type": "string",
"default": "snapcraftctl pull"
},
"override-build": {
"type": "string",
"default": "snapcraftctl build"
},
"override-stage": {
"type": "string",
"default": "snapcraftctl stage"
},
"override-prime": {
"type": "string",
"default": "snapcraftctl prime"
},
"parse-info": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": []
}
}
}
}
},
"plugs": {
"type": "object"
},
"slots": {
"type": "object"
},
"ua-services": {
"type": "array",
"description": "UA services to enable.",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
}
},
"allOf": [
{
"anyOf": [
{
"usage": "type: <base|kernel|snapd> (without a base)",
"properties": {
"type": {
"enum": [
"base",
"kernel",
"snapd"
]
}
},
"allOf": [
{
"required": [
"type"
]
},
{
"not": {
"required": [
"base"
]
}
}
]
},
{
"usage": "base: <base> and type: <app|gadget>",
"properties": {
"type": {
"enum": [
"app",
"gadget"
]
}
},
"allOf": [
{
"required": [
"base"
]
}
]
},
{
"usage": "base: bare (with a build-base)",
"properties": {
"base": {
"enum": [
"bare"
]
}
},
"required": [
"build-base"
]
}
]
},
{
"anyOf": [
{
"required": [
"summary",
"description",
"version"
]
},
{
"required": [
"adopt-info"
]
}
]
}
],
"required": [
"name",
"parts"
],
"dependencies": {
"license-agreement": [
"license"
],
"license-version": [
"license"
]
},
"additionalProperties": false
}
|
schema-org-action.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/Action",
"id": "https://json.schemastore.org/schema-org-action.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": {
"type": "string",
"format": "regex",
"pattern": "Action",
"description": "override the @type property to ensure Action is used"
},
"actionStatus": {
"type": "object",
"description": "Indicates the current disposition of the Action."
},
"agent": {
"description": "The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Organization"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Person"
}
]
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December."
},
"error": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "For failed actions, more information on the cause of the failure."
},
"instrument": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "The object that helped the agent perform the action. e.g. John wrote a book with a pen."
},
"location": {
"description": "The location of for example where the event is happening, an organization is located, or where an action takes place.",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Place"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "PostalAddress"
},
{
"type": "string"
}
]
},
"object": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "The object upon the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book."
},
"participant": {
"description": "Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Organization"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Person"
},
{
"type": "array",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Organization"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Person"
}
]
}
]
},
"result": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "The result produced in the action. e.g. John wrote a book."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December."
},
"target": {
"type": "object",
"description": "Indicates a target EntryPoint for an Action."
}
},
"required": ["@type"],
"title": "JSON schema for schema.org / Action",
"type": "object"
}
|
project-1.0.0-beta3.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"
]
}
}
},
"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-beta3.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"
},
"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"
}
},
"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"
},
"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 application. Example: 1.2.0.0",
"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"
}
|
gradle-enterprise-config-schema-7.json | {
"$schema" : "http://json-schema.org/draft-07/schema#",
"definitions" : {
"ConfigParamKey" : {
"type" : "string",
"pattern" : "^(?=[^=]+$)(?!\\s+$)(.|\\n)+$"
},
"EmailAddress" : {
"type" : "string",
"pattern" : "^.+@.+$",
"format" : "gradle-enterprise:email-address",
"description" : "Internet email address conforming to most of RFC 822 syntax rules and by that allowing a majority of internalized email addresses as well."
},
"EncryptedSecret" : {
"type" : "string",
"pattern" : "^(?:plain:.+|aes256:(?:\\s*[A-Za-z0-9+/]){16}:(?:\\s*[A-Za-z0-9+/]){16}:(?:(?:\\s*[A-Za-z0-9+/]){4})*(?:(?:\\s*[A-Za-z0-9+/]){2}(?:\\s*=){2}|(?:\\s*[A-Za-z0-9+/]){3}(?:\\s*=))?\\s*)$"
},
"HashedSecret" : {
"type" : "string",
"pattern" : "^(?:\\s*[A-Za-z0-9+/]){43}(?:\\s*=):(?:(?:\\s*[A-Za-z0-9+/]){4})*(?:(?:\\s*[A-Za-z0-9+/]){2}(?:\\s*=){2}|(?:\\s*[A-Za-z0-9+/]){3}(?:\\s*=))?\\s*$"
},
"Map(ConfigParamKey,String)" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
},
"propertyNames" : {
"$ref" : "#/definitions/ConfigParamKey"
}
},
"Role" : {
"type" : "object",
"properties" : {
"assignToNewExternalUsers" : {
"type" : "boolean"
},
"description" : {
"type" : [ "string", "null" ]
},
"displayName" : {
"type" : [ "string", "null" ]
},
"externalValue" : {
"type" : [ "string", "null" ]
},
"permissions" : {
"uniqueItems" : true,
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "viewScan", "exportData", "administerGe", "administerProjects", "administerCache", "publishScan", "testDistribution", "readCache", "writeCache", "accessAllProjects", "accessAnonymousProjectData" ]
}
}
},
"additionalProperties" : false,
"minProperties" : 1
},
"TimeOfDay" : {
"type" : "string",
"pattern" : "^(?:[01]\\d|2[0-3]):[0-5]\\d$"
}
},
"type" : "object",
"required" : [ "systemPassword", "version" ],
"description" : "Gradle Enterprise configuration schema",
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"version" : {
"const" : 7,
"description" : "The version of the config file model (must be 7)."
},
"advanced" : {
"type" : "object",
"properties" : {
"app" : {
"type" : "object",
"properties" : {
"heapMemory" : {
"type" : "integer",
"description" : "The amount of heap memory allocated to the application",
"minimum" : 100
},
"offHeapMemory" : {
"type" : "integer",
"description" : "The amount of off-heap memory allocated to the application",
"minimum" : 100
},
"params" : {
"allOf" : [ {
"$ref" : "#/definitions/Map(ConfigParamKey,String)"
}, {
"description" : "Configuration parameters for the application"
} ]
},
"scanPayloadCacheSize" : {
"type" : "integer",
"description" : "The amount of memory for the scan payload event stream cache"
}
},
"additionalProperties" : false,
"minProperties" : 1
},
"appBackgroundProcessor" : {
"type" : "object",
"properties" : {
"heapMemory" : {
"type" : "integer",
"description" : "The amount of heap memory allocated to the application",
"minimum" : 100
},
"offHeapMemory" : {
"type" : "integer",
"description" : "The amount of off-heap memory allocated to the application",
"minimum" : 100
},
"params" : {
"allOf" : [ {
"$ref" : "#/definitions/Map(ConfigParamKey,String)"
}, {
"description" : "Configuration parameters for the application"
} ]
}
},
"additionalProperties" : false,
"minProperties" : 1
},
"buildCacheNode" : {
"type" : "object",
"properties" : {
"heapMemory" : {
"type" : "integer",
"description" : "The amount of heap memory allocated to the application",
"minimum" : 100
},
"offHeapMemory" : {
"type" : "integer",
"description" : "The amount of off-heap memory allocated to the application",
"minimum" : 100
},
"params" : {
"allOf" : [ {
"$ref" : "#/definitions/Map(ConfigParamKey,String)"
}, {
"description" : "Configuration parameters for the application"
} ]
}
},
"additionalProperties" : false,
"minProperties" : 1
},
"distributionBroker" : {
"type" : "object",
"properties" : {
"heapMemory" : {
"type" : "integer",
"description" : "The amount of heap memory allocated to the application",
"minimum" : 100
},
"offHeapMemory" : {
"type" : "integer",
"description" : "The amount of off-heap memory allocated to the application",
"minimum" : 100
},
"params" : {
"allOf" : [ {
"$ref" : "#/definitions/Map(ConfigParamKey,String)"
}, {
"description" : "Configuration parameters for the application"
} ]
}
},
"additionalProperties" : false,
"minProperties" : 1
}
},
"additionalProperties" : false,
"minProperties" : 1
},
"auth" : {
"type" : "object",
"properties" : {
"anonymousPermissions" : {
"description" : "Permissions to assign to anonymous users - does not support administerGe, administerCache, or testDistribution",
"uniqueItems" : true,
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "viewScan", "exportData", "administerGe", "administerProjects", "administerCache", "publishScan", "testDistribution", "readCache", "writeCache", "accessAllProjects", "accessAnonymousProjectData" ]
}
},
"external" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "ldap", "saml" ]
}
},
"required" : [ "type" ],
"allOf" : [ {
"if" : {
"properties" : {
"type" : {
"const" : "ldap"
}
}
},
"then" : {
"type" : "object",
"required" : [ "connectionUrl", "displayName", "roles", "users" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "ldap"
},
"bindUser" : {
"type" : [ "object", "null" ],
"properties" : {
"dn" : {
"type" : "string",
"description" : "Distinguished name for the LDAP user account"
},
"password" : {
"allOf" : [ {
"$ref" : "#/definitions/EncryptedSecret"
}, {
"description" : "Password for the LDAP user account"
} ]
}
},
"required" : [ "dn", "password" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Binding information used when LDAP requires authentication"
},
"connectionUrl" : {
"type" : "string",
"description" : "URL used to connect to LDAP server"
},
"displayName" : {
"type" : "string",
"description" : "Name of this identity provider configuration"
},
"roles" : {
"allOf" : [ {
"if" : {
"properties" : {
"type" : {
"const" : "external"
}
}
},
"then" : {
"type" : "object",
"required" : [ "baseDn", "membershipAttribute", "membershipAttributeType", "nameAttribute", "objectClass" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "external"
},
"baseDn" : {
"type" : "string",
"description" : "Base DN for the subtree holding roles"
},
"membershipAttribute" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding role membership"
},
"membershipAttributeType" : {
"type" : "string",
"enum" : [ "dn", "uid" ],
"description" : "Type of the membership-ldap-attribute"
},
"nameAttribute" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding the role name"
},
"objectClass" : {
"type" : "string",
"description" : "LDAP object classes for roles"
},
"retrieveStrategy" : {
"type" : "string",
"enum" : [ "groupMember", "userMemberof", "matchingRuleInChain" ],
"description" : "Type of roles retrieve strategy (defaults to GROUP_MEMBER)"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "local"
}
}
},
"then" : {
"type" : "object",
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "local"
}
}
}
} ],
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "external", "local" ]
}
},
"required" : [ "type" ],
"minProperties" : 1,
"description" : "Holds information when the identity provider manages roles"
},
"users" : {
"type" : "object",
"properties" : {
"attributes" : {
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding email address"
},
"firstName" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding first name"
},
"lastName" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding last name"
},
"userName" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding user name"
},
"uuid" : {
"type" : "string",
"description" : "Name of the LDAP attribute holding a unique id"
}
},
"required" : [ "email", "firstName", "lastName", "userName", "uuid" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Describes how user attributes are mapped"
},
"baseDn" : {
"type" : "string",
"description" : "Base DN for the subtree holding users"
},
"filter" : {
"allOf" : [ {
"type" : [ "string", "null" ],
"format" : "gradle-enterprise:ldap-filter",
"description" : "LDAP search filter expression."
}, {
"description" : "Optional LDAP filter expression to limit access"
} ]
}
},
"required" : [ "attributes", "baseDn" ],
"additionalProperties" : false,
"minProperties" : 1
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "saml"
}
}
},
"then" : {
"type" : "object",
"required" : [ "displayName", "idpMetadata", "roles" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "saml"
},
"displayName" : {
"type" : "string",
"description" : "Name of this identity provider configuration"
},
"idpMetadata" : {
"type" : "string",
"pattern" : "^(?:(?:\\s*[A-Za-z0-9+/]){4})*(?:(?:\\s*[A-Za-z0-9+/]){2}(?:\\s*=){2}|(?:\\s*[A-Za-z0-9+/]){3}(?:\\s*=))?\\s*$",
"description" : "SAML metadata that describes this identity provider"
},
"options" : {
"type" : "object",
"properties" : {
"requireEncryptedAssertion" : {
"type" : "boolean",
"description" : "Encrypt SAML assertions?"
},
"signAuthenticationRequests" : {
"type" : "boolean",
"description" : "Sign authentication requests?"
},
"validateAssertionSignature" : {
"type" : "boolean",
"description" : "Enable signature validation of SAML assertions?"
},
"validateResponseSignature" : {
"type" : "boolean",
"description" : "Enable signature validation of SAML responses?"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Groups all options and is only necessary when one or more needs to be enabled"
},
"roles" : {
"allOf" : [ {
"if" : {
"properties" : {
"type" : {
"const" : "external"
}
}
},
"then" : {
"type" : "object",
"required" : [ "attribute" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "external"
},
"attribute" : {
"type" : "string",
"description" : "Name of the SAML attribute holding role names"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "local"
}
}
},
"then" : {
"type" : "object",
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "local"
}
}
}
} ],
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "external", "local" ]
}
},
"required" : [ "type" ],
"minProperties" : 1,
"description" : "Holds information when the identity provider manages roles"
},
"userAttributes" : {
"type" : "object",
"properties" : {
"email" : {
"type" : [ "string", "null" ],
"description" : "Name of the SAML attribute holding email address"
},
"firstName" : {
"type" : [ "string", "null" ],
"description" : "Name of the SAML attribute holding first name"
},
"lastName" : {
"type" : [ "string", "null" ],
"description" : "Name of the SAML attribute holding last name"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Describes how user attributes are mapped"
}
}
}
} ],
"minProperties" : 1
} ]
},
"roles" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Role"
},
"propertyNames" : {
"type" : "string"
}
},
"scim" : {
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean",
"description" : "Whether to allow access to the SCIM API for user and group management"
},
"token" : {
"type" : [ "object", "null" ],
"properties" : {
"hash" : {
"allOf" : [ {
"$ref" : "#/definitions/HashedSecret"
}, {
"description" : "The hash of the token"
} ]
},
"length" : {
"type" : "integer",
"description" : "The length of the token"
},
"prefix" : {
"type" : "string",
"description" : "The prefix of the token"
}
},
"required" : [ "hash", "length", "prefix" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Token to authenticate with the SCIM API"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Configuration for System for Cross-domain Identity Management (SCIM) support"
},
"timeouts" : {
"type" : "object",
"properties" : {
"accessTokenLifespan" : {
"type" : "integer",
"description" : "The maximum time before an access token is expired (in minutes), default is 10 minutes"
},
"ssoSessionIdleTimeout" : {
"type" : "integer",
"description" : "The time a login session is allowed to be idle before it expires (in minutes), default is 4 days (5760 minutes)"
},
"ssoSessionMaxLifespan" : {
"type" : "integer",
"description" : "The maximum time before a login session is expired (in minutes), default is 30 days (43200 minutes)"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Timeouts you can specify for user logins in Gradle Enterprise"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Configuration of Gradle Enterprise authentication options"
},
"backups" : {
"type" : [ "object", "null" ],
"properties" : {
"backupsToRetain" : {
"type" : "integer",
"description" : "How many old backups to keep",
"minimum" : 1
},
"emailNotification" : {
"type" : "boolean",
"description" : "Send an email when backup is complete"
},
"schedule" : {
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "daily", "weekly", "cron" ]
}
},
"required" : [ "type" ],
"allOf" : [ {
"if" : {
"properties" : {
"type" : {
"const" : "daily"
}
}
},
"then" : {
"type" : "object",
"required" : [ "timeOfDay" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "daily"
},
"timeOfDay" : {
"allOf" : [ {
"$ref" : "#/definitions/TimeOfDay"
}, {
"description" : "Time (in UTC) to perform the backup"
} ]
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "weekly"
}
}
},
"then" : {
"type" : "object",
"required" : [ "dayOfWeek", "timeOfDay" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "weekly"
},
"dayOfWeek" : {
"type" : "string",
"enum" : [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ],
"description" : "Day (in UTC) to perform the backup"
},
"timeOfDay" : {
"allOf" : [ {
"$ref" : "#/definitions/TimeOfDay"
}, {
"description" : "Time (in UTC) to perform the backup"
} ]
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "cron"
}
}
},
"then" : {
"type" : "object",
"required" : [ "expression" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "cron"
},
"expression" : {
"type" : "string",
"pattern" : "^(?:\\*|(?:(?:\\*\\/)?[1-5]?[0-9])) (?:\\*|(?:(?:\\*\\/)?(?:1?[0-9]|2[0-3]))) (?:\\*|(?:(?:\\*\\/)?(?:[1-9]|[12][0-9]|3[0-1]))) (?:\\*|(?:(?:\\*\\/)?(?:[1-9]|1[0-2]))) (?:\\*|(?:(?:\\*\\/)?[0-6]))$",
"description" : "Custom cron expression for backup time"
}
}
}
} ],
"minProperties" : 1
}
},
"required" : [ "schedule" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Automatic backup configuration"
},
"buildCache" : {
"type" : "object",
"properties" : {
"allowUntrustedNodeSsl" : {
"type" : "boolean",
"description" : "Allow communication with nodes running over untrusted SSL"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Configuration specific to the build cache app"
},
"buildScans" : {
"type" : "object",
"properties" : {
"diskSpaceMonitoring" : {
"type" : "object",
"properties" : {
"autoDeleteWhileFreeSpaceLessThanPercentage" : {
"type" : [ "integer", "null" ],
"description" : "Threshold of free disk space before old scans will be automatically deleted",
"maximum" : 100,
"minimum" : 1
},
"rejectIncomingWhileFreeSpaceLessThanPercentage" : {
"type" : [ "integer", "null" ],
"description" : "Threshold of free disk space before new scans will be rejected",
"maximum" : 100,
"minimum" : 1
},
"sendWarningEmailWhenFreeSpaceLessThanPercentage" : {
"type" : [ "integer", "null" ],
"description" : "Threshold of free disk space before a warning is sent to users publishing a build scan",
"maximum" : 100,
"minimum" : 1
}
},
"additionalProperties" : false,
"minProperties" : 1
},
"incomingStorageType" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "string",
"enum" : [ null, "database", "objectStorage" ],
"description" : "Storage type of incoming builds"
} ]
},
"keepDays" : {
"type" : [ "integer", "null" ],
"description" : "How many days of scans should be retained",
"minimum" : 2
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Configuration specific to the build scans app"
},
"dailyMaintenanceTime" : {
"allOf" : [ {
"$ref" : "#/definitions/TimeOfDay"
}, {
"description" : "Which time (UTC) should retention-cleanup be performed"
} ]
},
"email" : {
"type" : [ "object", "null" ],
"properties" : {
"administratorAddress" : {
"allOf" : [ {
"$ref" : "#/definitions/EmailAddress"
}, {
"description" : "Email address notifications are sent to"
} ]
},
"authentication" : {
"type" : [ "object", "null" ],
"properties" : {
"password" : {
"$ref" : "#/definitions/EncryptedSecret"
},
"type" : {
"type" : "string",
"enum" : [ "login", "cramMd5", "plain" ]
},
"username" : {
"type" : "string"
}
},
"required" : [ "password", "type", "username" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "SMTP authentication method"
},
"fromAddress" : {
"allOf" : [ {
"$ref" : "#/definitions/EmailAddress"
}, {
"description" : "Email address notifications are sent from"
} ]
},
"smtpServer" : {
"type" : "string",
"pattern" : "^(?:(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])):(?:[1-9][0-9]{0,3}|[1-6][0-5][0-5][0-3][0-5])$",
"description" : "Address and port of the smtp server"
},
"sslProtocol" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "string",
"enum" : [ null, "startTls", "implicitTls" ],
"description" : "SMTP protocol flavour"
} ]
}
},
"required" : [ "administratorAddress", "fromAddress", "smtpServer" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "SMTP configuration for notifications"
},
"helpContact" : {
"type" : "object",
"properties" : {
"email" : {
"anyOf" : [ {
"type" : "null"
}, {
"$ref" : "#/definitions/EmailAddress"
} ],
"description" : "The email address users should contact"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "The name of the contact"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Who users should contact if they have a problem"
},
"network" : {
"type" : [ "object", "null" ],
"properties" : {
"additionalTrust" : {
"type" : [ "string", "null" ],
"pattern" : "(?:^|\\r?\\n)-----BEGIN CERTIFICATE-----(?:\\r?\\n)(?:(?:\\s*[A-Za-z0-9+/]){4})*(?:(?:\\s*[A-Za-z0-9+/]){2}(?:\\s*=){2}|(?:\\s*[A-Za-z0-9+/]){3}(?:\\s*=))?\\s*(?:\\r?\\n)-----END CERTIFICATE-----(?:$|\\r?\\n)",
"format" : "gradle-enterprise:x509-certs-pem",
"description" : "Required if Gradle Enterprise must communicate with servers using certificates not trusted by default"
},
"proxy" : {
"type" : [ "object", "null" ],
"properties" : {
"auth" : {
"type" : [ "object", "null" ],
"properties" : {
"password" : {
"allOf" : [ {
"$ref" : "#/definitions/EncryptedSecret"
}, {
"description" : "Proxy password"
} ]
},
"username" : {
"type" : "string",
"description" : "Proxy username"
}
},
"required" : [ "password", "username" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Proxy authentication credentials"
},
"excludedHosts" : {
"description" : "A list of hosts that should not be proxied",
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^(?:(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|(?:(?:^[\\*]|[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))$",
"format" : "gradle-enterprise:excludedHosts"
}
},
"host" : {
"type" : "string",
"pattern" : "^(?:(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))$",
"format" : "gradle-enterprise:host",
"description" : "Proxy host"
},
"port" : {
"type" : "integer",
"description" : "Proxy port",
"maximum" : 65535,
"minimum" : 1
},
"protocol" : {
"type" : "string",
"enum" : [ "http", "https" ],
"description" : "Proxy protocol"
}
},
"required" : [ "host" ],
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Http proxy config"
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Network configuration"
},
"objectStorage" : {
"type" : "object",
"properties" : {
"provider" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "s3" ]
}
},
"required" : [ "type" ],
"allOf" : [ {
"if" : {
"properties" : {
"type" : {
"const" : "s3"
}
}
},
"then" : {
"type" : "object",
"required" : [ "bucket", "credentials", "region" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"type" : {
"const" : "s3"
},
"bucket" : {
"type" : "string",
"description" : "The name of the bucket to store the scan payloads"
},
"credentials" : {
"allOf" : [ {
"if" : {
"properties" : {
"source" : {
"const" : "configuration"
}
}
},
"then" : {
"type" : "object",
"required" : [ "accessKey", "secretKey" ],
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"source" : {
"const" : "configuration"
},
"accessKey" : {
"type" : "string"
},
"secretKey" : {
"$ref" : "#/definitions/EncryptedSecret"
}
}
}
}, {
"if" : {
"properties" : {
"source" : {
"const" : "environment"
}
}
},
"then" : {
"type" : "object",
"additionalProperties" : false,
"minProperties" : 1,
"properties" : {
"source" : {
"const" : "environment"
}
}
}
} ],
"type" : "object",
"properties" : {
"source" : {
"enum" : [ "configuration", "environment" ]
}
},
"required" : [ "source" ],
"minProperties" : 1,
"description" : "The aws credentials"
},
"region" : {
"type" : "string",
"description" : "The region of the bucket"
}
}
}
} ],
"minProperties" : 1
} ]
}
},
"additionalProperties" : false,
"minProperties" : 1,
"description" : "Object Storage configuration"
},
"systemPassword" : {
"allOf" : [ {
"$ref" : "#/definitions/HashedSecret"
}, {
"description" : "The password for the system user"
} ]
}
}
} |
sil-kit-registry-configuration.json | {
"$id": "https://json.schemastore.org/sil-kit-registry-configuration.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"Logging": {
"type": "object",
"description": "Configures the properties of the SIL Kit Logging Service",
"properties": {
"FlushLevel": {
"type": "string",
"enum": ["Critical", "Error", "Warn", "Info", "Debug", "Trace", "Off"]
},
"Sinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": ["File", "Stdout"]
},
"Level": {
"type": "string",
"enum": [
"Critical",
"Error",
"Warn",
"Info",
"Debug",
"Trace",
"Off"
],
"default": "Info"
},
"LogName": {
"type": "string",
"description": "Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt"
}
},
"additionalProperties": false,
"required": ["Type"]
}
}
},
"additionalProperties": false,
"required": ["Sinks"]
}
},
"description": "JSON schema for SIL KIT Registry configuration files.",
"properties": {
"$schema": {
"type": "string",
"description": "The schema file",
"default": "",
"examples": ["./RegistryConfiguration.schema.json"]
},
"SchemaVersion": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"default": 0,
"description": "Version of the schema used to validate this document"
},
"Description": {
"type": "string",
"description": "Free text field allowing a user to describe the configuration file in their own words. The contents of this field are not parsed or used internally.",
"default": ""
},
"ListenUri": {
"type": "string",
"description": "The configured registry instance will listen on this address for incoming connections. Optional; This field overrides the -u, and --listen-uri command line parameters."
},
"Logging": {
"$ref": "#/definitions/Logging"
}
},
"type": "object"
}
|
config.schema.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Config",
"definitions": {
"BazelStep": {
"properties": {
"build_targets": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of bazel targets to build"
},
"test_targets": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of bazel targets to test"
},
"build_flags": {
"items": {
"type": "string"
},
"type": "array",
"description": "Build flags to use in addition to defined in /etc/bazel.bazelrc"
},
"test_flags": {
"items": {
"type": "string"
},
"type": "array",
"description": "Test flags to use in addition to defined in /etc/bazel.bazelrc"
}
},
"additionalProperties": false,
"type": "object"
},
"BranchesAndPaths": {
"required": [
"branches"
],
"properties": {
"branches": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of branch name masks (doubleglob) to match"
},
"paths": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of path masks (doubleglob) to match. If not specified, all paths are matched"
},
"branches-ignore": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of branch name masks (doubleglob) to ignore"
},
"paths-ignore": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of path masks (doubleglob) to match. If not specified, all paths are ignored"
}
},
"additionalProperties": false,
"type": "object"
},
"BranchesOrTags": {
"anyOf": [
{
"required": [
"branches"
]
},
{
"required": [
"tags"
]
}
],
"properties": {
"branches": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of branch name masks (doubleglob) to match"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of tag masks (doubleglob) to match"
},
"branches-ignore": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of branch name masks (doubleglob) to ignore"
},
"tags-ignore": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of tag masks (doubleglob) to ignore"
}
},
"additionalProperties": false,
"type": "object"
},
"Config": {
"required": [
"workflows"
],
"properties": {
"workflows": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Workflow"
},
"type": "array",
"description": "The list of FasterCI workflows"
}
},
"additionalProperties": false,
"type": "object"
},
"On": {
"anyOf": [
{
"required": [
"push"
]
},
{
"required": [
"pull_request"
]
}
],
"properties": {
"push": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/BranchesOrTags",
"description": "Run the workflow on code push"
},
"pull_request": {
"$ref": "#/definitions/BranchesAndPaths",
"description": "Run the workflow on pull request"
}
},
"additionalProperties": false,
"type": "object"
},
"Step": {
"anyOf": [
{
"required": [
"github_check_md_file"
]
},
{
"required": [
"run"
]
},
{
"required": [
"bazel"
]
}
],
"dependencies": {
"github_check": [
"name"
],
"github_check_md_file": [
"name"
]
},
"properties": {
"name": {
"type": "string",
"description": "Step name, optional"
},
"working-directory": {
"type": "string",
"description": "Directory to run the step instead of default repo directory"
},
"github_check": {
"type": "boolean",
"description": "Report the result of the step as a separate github check"
},
"github_check_md_file": {
"type": "string",
"description": "After completing the step, report as a separate Github Check, using the content of the file as a report body, optional"
},
"run": {
"type": "string",
"description": "Arbitrary command execution; Could be multiline"
},
"bazel": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/BazelStep",
"description": "Bazel step"
}
},
"additionalProperties": false,
"type": "object"
},
"Workflow": {
"required": [
"name",
"on"
],
"properties": {
"name": {
"type": "string",
"description": "Workflow name"
},
"on": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/On",
"description": "Event to activate the workflow on"
},
"image": {
"type": "string",
"description": "Docker image to run the workflow"
},
"cleanup": {
"type": "string",
"description": "optional cleanup command, executed after the workflow"
},
"max_parallel": {
"type": "integer",
"description": "optional maximum number of parallel runs of this workflow"
},
"env": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Environment variables"
},
"secrets": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of secrets to mount as environment variables"
},
"hide_from_github": {
"type": "boolean",
"description": "Do not notify github"
},
"init": {
"type": "string",
"description": "Optional command to run before the workflow. Use multiline for multiple commands"
},
"steps": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Step"
},
"type": "array",
"description": "List of workflow steps to execute"
}
},
"additionalProperties": false,
"type": "object"
}
}
} |
avro-avsc.json | {
"$id": "https://json.schemastore.org/avro-avsc.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"avroSchema": {
"title": "Avro Schema",
"description": "Root Schema",
"oneOf": [
{
"$ref": "#/definitions/types"
}
]
},
"types": {
"title": "Avro Types",
"description": "Allowed Avro types",
"oneOf": [
{
"$ref": "#/definitions/primitiveType"
},
{
"$ref": "#/definitions/primitiveTypeWithMetadata"
},
{
"$ref": "#/definitions/customTypeReference"
},
{
"$ref": "#/definitions/avroRecord"
},
{
"$ref": "#/definitions/avroEnum"
},
{
"$ref": "#/definitions/avroArray"
},
{
"$ref": "#/definitions/avroMap"
},
{
"$ref": "#/definitions/avroFixed"
},
{
"$ref": "#/definitions/avroUnion"
}
]
},
"primitiveType": {
"title": "Primitive Type",
"description": "Basic type primitives.",
"type": "string",
"enum": [
"null",
"boolean",
"int",
"long",
"float",
"double",
"bytes",
"string"
]
},
"primitiveTypeWithMetadata": {
"title": "Primitive Type With Metadata",
"description": "A primitive type with metadata attached.",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/primitiveType"
}
},
"required": ["type"]
},
"customTypeReference": {
"title": "Custom Type",
"description": "Reference to a ComplexType",
"not": {
"$ref": "#/definitions/primitiveType"
},
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*$"
},
"avroUnion": {
"title": "Union",
"description": "A Union of types",
"type": "array",
"items": {
"$ref": "#/definitions/avroSchema"
},
"minItems": 1
},
"avroField": {
"title": "Field",
"description": "A field within a Record",
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/name"
},
"type": {
"$ref": "#/definitions/types"
},
"doc": {
"type": "string"
},
"default": {},
"order": {
"enum": ["ascending", "descending", "ignore"]
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
}
},
"required": ["name", "type"]
},
"avroRecord": {
"title": "Record",
"description": "A Record",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["record"]
},
"name": {
"$ref": "#/definitions/name"
},
"namespace": {
"$ref": "#/definitions/namespace"
},
"doc": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
},
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/avroField"
}
}
},
"required": ["type", "name", "fields"]
},
"avroEnum": {
"title": "Enum",
"description": "An enumeration",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["enum"]
},
"name": {
"$ref": "#/definitions/name"
},
"namespace": {
"$ref": "#/definitions/namespace"
},
"doc": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
},
"symbols": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
}
},
"required": ["type", "name", "symbols"]
},
"avroArray": {
"title": "Array",
"description": "An array",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["array"]
},
"name": {
"$ref": "#/definitions/name"
},
"namespace": {
"$ref": "#/definitions/namespace"
},
"doc": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
},
"items": {
"$ref": "#/definitions/types"
}
},
"required": ["type", "items"]
},
"avroMap": {
"title": "Map",
"description": "A map of values",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["map"]
},
"name": {
"$ref": "#/definitions/name"
},
"namespace": {
"$ref": "#/definitions/namespace"
},
"doc": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
},
"values": {
"$ref": "#/definitions/types"
}
},
"required": ["type", "values"]
},
"avroFixed": {
"title": "Fixed",
"description": "A fixed sized array of bytes",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["fixed"]
},
"name": {
"$ref": "#/definitions/name"
},
"namespace": {
"$ref": "#/definitions/namespace"
},
"doc": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/definitions/name"
}
},
"size": {
"type": "number"
}
},
"required": ["type", "name", "size"]
},
"name": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"namespace": {
"type": "string",
"pattern": "^([A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*)*$"
}
},
"description": "Json-Schema definition for Avro AVSC files.",
"oneOf": [
{
"$ref": "#/definitions/avroSchema"
}
],
"title": "Avro Schema Definition"
}
|
metadata.json | {
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://f-droid.org/metadata.yml",
"title": "F-Droid Data metadata",
"description": "For every app on F-Droid a metadata file in the format of <application-id>.yml have to be provided, in order to build an app or check or if it has been updated. See https://f-droid.org/docs/Build_Metadata_Reference for a complete reference of a metadata file.",
"type": "object",
"properties": {
"AntiFeatures": {
"description": "Any number of anti-features the application has.",
"$ref": "#/definitions/anti_features"
},
"Categories": {
"description": "Any number of categories for the application to be placed in.",
"type": "array",
"items": {
"type": "string",
"enum": [
"Connectivity",
"Development",
"Games",
"Graphics",
"Internet",
"Money",
"Multimedia",
"Navigation",
"Phone & SMS",
"Reading",
"Science & Education",
"Security",
"Sports & Health",
"System",
"Theming",
"Time",
"Writing"
]
},
"uniqueItems": true,
"minItems": 1
},
"License": {
"description": "",
"type": "string",
"enum": [
"0BSD",
"AAL",
"AFL-1.1",
"AFL-1.2",
"AFL-2.0",
"AFL-2.1",
"AFL-3.0",
"AGPL-3.0-only",
"AGPL-3.0-or-later",
"APL-1.0",
"APSL-1.0",
"APSL-1.1",
"APSL-1.2",
"APSL-2.0",
"Apache-1.0",
"Apache-1.1",
"Apache-2.0",
"Artistic-1.0",
"Artistic-1.0-Perl",
"Artistic-1.0-cl8",
"Artistic-2.0",
"Beerware",
"BSD-1-Clause",
"BSD-2-Clause",
"BSD-2-Clause-FreeBSD",
"BSD-2-Clause-Patent",
"BSD-3-Clause",
"BSD-3-Clause-Clear",
"BSD-3-Clause-LBNL",
"BSD-4-Clause",
"BSL-1.0",
"BitTorrent-1.1",
"CAL-1.0",
"CAL-1.0-Combined-Work-Exception",
"CATOSL-1.1",
"CC-BY-4.0",
"CC-BY-SA-4.0",
"CC0-1.0",
"CDDL-1.0",
"CECILL-2.0",
"CECILL-2.1",
"CECILL-B",
"CECILL-C",
"CNRI-Python",
"CPAL-1.0",
"CPL-1.0",
"CUA-OPL-1.0",
"ClArtistic",
"Condor-1.1",
"ECL-1.0",
"ECL-2.0",
"EFL-1.0",
"EFL-2.0",
"EPL-1.0",
"EPL-2.0",
"EUDatagrid",
"EUPL-1.1",
"EUPL-1.2",
"Entessa",
"FSFAP",
"FTL",
"Fair",
"Frameworx-1.0",
"GFDL-1.1-only",
"GFDL-1.1-or-later",
"GFDL-1.2-only",
"GFDL-1.2-or-later",
"GFDL-1.3-only",
"GFDL-1.3-or-later",
"GPL-2.0-only",
"GPL-2.0-or-later",
"GPL-3.0-only",
"GPL-3.0-or-later",
"HPND",
"IJG",
"IPA",
"IPL-1.0",
"ISC",
"Imlib2",
"Intel",
"LGPL-2.0-only",
"LGPL-2.0-or-later",
"LGPL-2.1-only",
"LGPL-2.1-or-later",
"LGPL-3.0-only",
"LGPL-3.0-or-later",
"LPL-1.0",
"LPL-1.02",
"LPPL-1.2",
"LPPL-1.3a",
"LPPL-1.3c",
"LiLiQ-P-1.1",
"LiLiQ-R-1.1",
"LiLiQ-Rplus-1.1",
"MIT",
"MIT-0",
"MIT-CMU",
"MPL-1.0",
"MPL-1.1",
"MPL-2.0",
"MPL-2.0-no-copyleft-exception",
"MS-PL",
"MS-RL",
"MirOS",
"Motosoto",
"MulanPSL-2.0",
"Multics",
"NASA-1.3",
"NCSA",
"NGPL",
"NOSL",
"NPL-1.0",
"NPL-1.1",
"NPOSL-3.0",
"NTP",
"Naumen",
"Nokia",
"OCLC-2.0",
"ODbL-1.0",
"OFL-1.0",
"OFL-1.1",
"OFL-1.1-RFN",
"OFL-1.1-no-RFN",
"OGTSL",
"OLDAP-2.3",
"OLDAP-2.7",
"OLDAP-2.8",
"OSET-PL-2.1",
"OSL-1.0",
"OSL-1.1",
"OSL-2.0",
"OSL-2.1",
"OSL-3.0",
"OpenSSL",
"PHP-3.0",
"PHP-3.01",
"PostgreSQL",
"Python-2.0",
"QPL-1.0",
"RPL-1.1",
"RPL-1.5",
"RPSL-1.0",
"RSCPL",
"Ruby",
"SGI-B-2.0",
"SISSL",
"SMLNJ",
"SPL-1.0",
"SimPL-2.0",
"Sleepycat",
"UCL-1.0",
"UPL-1.0",
"Unicode-DFS-2016",
"Unlicense",
"VSL-1.0",
"Vim",
"W3C",
"WTFPL",
"Watcom-1.0",
"X11",
"XFree86-1.1",
"Xnet",
"XSkat",
"YPL-1.1",
"ZPL-2.0",
"ZPL-2.1",
"Zend-2.0",
"Zimbra-1.3",
"Zlib",
"gnuplot",
"iMatix",
"xinetd",
"PublicDomain"
]
},
"AuthorName": {
"description": "The name of the author, either full, abbreviated or pseudonym.",
"type": "string"
},
"AuthorEmail": {
"description": "The e-mail address of the author(s).",
"type": "string",
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
},
"AuthorWebSite": {
"description": "The website url of the author(s).",
"$ref": "#/definitions/url"
},
"WebSite": {
"description": "The URL for the application's web site.",
"$ref": "#/definitions/url"
},
"SourceCode": {
"description": "The URL to view or obtain the application's source code. This should be something human-friendly.",
"$ref": "#/definitions/url"
},
"IssueTracker": {
"description": "The URL for the application's issue tracker.",
"$ref": "#/definitions/url"
},
"Translation": {
"description": "The URL for the application's translation portal or at least a guide.",
"$ref": "#/definitions/url"
},
"Changelog": {
"description": "The URL for the application's changelog.",
"$ref": "#/definitions/url"
},
"Donate": {
"description": "The URL to donate to the project.",
"$ref": "#/definitions/url"
},
"FlattrID": {
"description": "The project's Flattr (https://flattr.com) ID.",
"type": "string",
"pattern": "^[0-9a-z]+$"
},
"Liberapay": {
"description": "The project's Liberapay (https://liberapay.com) user or group name.",
"type": "string"
},
"OpenCollective": {
"description": "The project's OpenCollective (https://opencollective.com) user or group name.",
"type": "string"
},
"Bitcoin": {
"description": "A Bitcoin address for donating to the project.",
"type": "string",
"pattern": "^(bc1|[13])[a-zA-HJ-NP-Z0-9]{25,39}$"
},
"Litecoin": {
"description": "A Litecoin address for donating to the project.",
"type": "string",
"pattern": "^([LM3][a-km-zA-HJ-NP-Z1-9]{26,33}|ltc1[a-km-z0-9]{39})$"
},
"Name": {
"description": "The title of the application, with optional descriptive phrase.",
"type": "string"
},
"AutoName": {
"description": "The name of the application as can best be retrieved from the source code.",
"type": "string"
},
"Summary": {
"description": "DEPRECATED. A brief summary of what the application is. Should rather be provided via Fastlane.",
"type": "string",
"maxLength": 80
},
"Description": {
"description": "DEPRECATED. A full description of the application, relevant to the latest version. Should rather be provided via Fastlane.",
"type": "string",
"maxLength": 4000
},
"AllowedAPKSigningKeys": {
"description": "The lowercase hex value of the SHA-256 fingerprint of the signing certificate of an app. If an APK of that app is not signed by one of these keys, it will not be included in the repository.",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
{
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
}
}
]
},
"MaintainerNotes": {
"description": "This is a multi-line field using the same rules and syntax as the description. It's used to record notes for F-Droid maintainers to assist in maintaining and updating the application in the repository.",
"type": "string",
"maxLength": 4000
},
"RepoType": {
"description": "The type of repository - for automatic building from source.",
"type": "string",
"enum": [
"git",
"svn",
"git-svn",
"hg",
"bzr",
"srclib"
]
},
"Repo": {
"description": "The repository location. Usually a git: or svn: URL, for example.",
"type": "string"
},
"Binaries": {
"description": "The location of binaries used in verification process.",
"$ref": "#/definitions/url"
},
"Builds": {
"description": "Any number of sub-entries can be present, each specifying a version to automatically build from source.",
"type": "array",
"items": {
"type": "object",
"properties": {
"versionName": {
"description": "Specifies to build version xxx, which has a version code of yyy.",
"type": "string"
},
"versionCode": {
"description": "Specifies to build version xxx, which has a version code of yyy.",
"type": "integer"
},
"commit": {
"description": "The commit parameter specifies the tag, commit or revision number from which to build it in the source repository.",
"type": "string"
},
"disable": {
"description": "Disables this build, giving a reason why.",
"type": "string"
},
"subdir": {
"description": "Specifies to build from a subdirectory of the checked out source code. Normally this directory is changed to before building.",
"type": "string"
},
"submodules": {
"description": "Use if the project (git only) has submodules - causes git submodule update --init --recursive to be executed after the source is cloned.",
"const": true
},
"sudo": {
"description": "Specifies a script to be run using sudo bash -x -c \"xxxx\" in the Buildserver VM guest. This script is run with full root privileges, but the state will be reset after each build.",
"$ref": "#/definitions/string_list"
},
"timeout": {
"description": "Time limit for this build (in seconds). After time is up, Buildserver VM is forcefully terminated. The default is 7200 (2 hours); 0 means no limit.",
"type": "integer"
},
"init": {
"description": "Like 'prebuild', but runs on the source code BEFORE any other processing takes place.",
"$ref": "#/definitions/string_list"
},
"oldsdkloc": {
"description": "The sdk location in the repo is in an old format, or the build.xml is expecting such. The 'new' format is sdk.dir while the VERY OLD format is sdk-location.",
"const": true
},
"target": {
"description": "Specifies a particular SDK target for compilation, overriding the value defined in the code by upstream. This has different effects depending on what build system used — this flag currently affects Ant, Maven and Gradle projects only.",
"type": "string"
},
"androidupdate": {
"description": "By default, 'android update' is used in Ant builds to generate or update the project and all its referenced projects. Specifying update=no bypasses that. Note that this is useless in builds that don't use Ant.",
"anyOf": [
{
"const": "auto"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"encoding": {
"description": "Adds a java.encoding property to local.properties with the given value. Generally the value will be 'utf-8'.",
"type": "string"
},
"forceversion": {
"description": "If specified, the package version in AndroidManifest.xml is replaced with the version name for the build as specified in the metadata.",
"const": true
},
"forcevercode": {
"description": "If specified, the package version code in the AndroidManifest.xml is replaced with the version code for the build. See also forceversion.",
"const": true
},
"rm": {
"description": "Specifies the relative paths of files or directories to delete before the build is done.",
"$ref": "#/definitions/string_list"
},
"extlibs": {
"description": "List of external libraries (jar files) from the build/extlib library, which will be placed in the libs directory of the project.",
"$ref": "#/definitions/string_list"
},
"srclibs": {
"description": "Comma-separated list of source libraries or Android projects. Each item is of the form name@rev where name is the predefined source library name and rev is the revision or tag to use in the respective source control.",
"$ref": "#/definitions/string_list"
},
"patch": {
"description": "Apply patch(es). 'x' names one (or more - comma-separated) files within a directory below the metadata, with the same name as the metadata file but without the extension. Each of these patches is applied to the code in turn.",
"$ref": "#/definitions/string_list"
},
"prebuild": {
"description": "Specifies a shell command (or commands - chain with &&) to run before the build takes place.",
"$ref": "#/definitions/string_list"
},
"scanignore": {
"description": "Enables one or more files/paths to be excluded from the scan process. This should only be used where there is a very good reason, and probably accompanied by a comment explaining why it is necessary.",
"$ref": "#/definitions/string_list"
},
"scandelete": {
"description": "When running the scan process, any files that trigger errors - like binaries - will be removed. It acts just like scanignore, but instead of ignoring the files, it removes them.",
"$ref": "#/definitions/string_list"
},
"build": {
"description": "As for 'prebuild', but runs during the actual build phase (but before the main Ant/Maven build). Use this only for actions that do actual building. Any preparation of the source code should be done using 'init' or 'prebuild'.",
"$ref": "#/definitions/string_list"
},
"postbuild": {
"description": "Specifies a single or a list of shell commands to run after the build takes place.",
"$ref": "#/definitions/string_list"
},
"buildjni": {
"description": "Enables building of native code via the ndk-build script before doing the main Ant build.",
"anyOf": [
{
"type": "string",
"enum": [
"yes",
"no"
]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"ndk": {
"description": "Version of the NDK to use in this build.",
"type": "string"
},
"gradle": {
"description": "Build with Gradle instead of Ant, specifying what flavours to use. Flavours are case sensitive since the path to the output APK is as well.",
"anyOf": [
{
"type": "array",
"items": {
"const": "yes"
},
"maxItems": 1
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"maven": {
"description": "Build with Maven instead of Ant. An extra @<dir> tells F-Droid to run Maven inside that relative subdirectory.",
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"yes",
"yes@"
]
}
]
},
"preassemble": {
"description": "List of Gradle tasks to be run before the assemble task in a Gradle project build.",
"$ref": "#/definitions/string_list"
},
"gradleprops": {
"description": "List of Gradle properties to pass via the command line to Gradle. A property can be of the form foo or of the form key=value.",
"$ref": "#/definitions/string_list"
},
"antcommands": {
"description": "Specify an alternate set of Ant commands (target) instead of the default 'release'. It can't be given any flags, such as the path to a build.xml.",
"$ref": "#/definitions/string_list"
},
"output": {
"description": "Specify a glob path where the resulting unsigned release APK from the build should be.",
"type": "string"
},
"binary": {
"description": "The location of binaries used in verification process.",
"$ref": "#/definitions/url"
},
"novcheck": {
"description": "Don't check that the version name and code in the resulting APK are correct by looking at the build output - assume the metadata is correct.",
"const": true
},
"antifeatures": {
"description": "List of Anti-Features for this specific build. They are described in AntiFeatures.",
"$ref": "#/definitions/anti_features"
}
},
"required": [
"versionName",
"versionCode"
],
"additionalProperties": false
},
"uniqueItems": true,
"minItems": 1
},
"Disabled": {
"description": "If this field is present, the application does not get put into the public index. The value should be a description of why the application is disabled.",
"type": "string"
},
"RequiresRoot": {
"description": "Whether the application requires root privileges to be usable.",
"type": "boolean"
},
"ArchivePolicy": {
"description": "This determines the number of versions to keep. The older versions of the app are moved to the archive repo, if one is configured. Defaults to 3.",
"type": "integer"
},
"AutoUpdateMode": {
"description": "This determines the method used for auto-generating new builds when new releases are available - in other words, adding a new Build Version line to the metadata.",
"type": "string",
"anyOf": [
{
"enum": [
"None",
"Version"
]
},
{
"pattern": "^Version( \\+.+)? [^+].+"
}
]
},
"UpdateCheckMode": {
"description": "This determines the method using for determining when new releases are available - in other words, the updating of the CurrentVersion and CurrentVersionCode fields in the metadata by the fdroid checkupdates process.",
"type": "string",
"anyOf": [
{
"enum": [
"None",
"Static",
"HTTP"
]
},
{
"pattern": "^RepoManifest(/.+)?$"
},
{
"pattern": "^Tags( .*)?$"
}
]
},
"VercodeOperation": {
"description": "A list of operations to be applied to the vercode obtained by the defined UpdateCheckMode. %c will be replaced by the actual vercode, and each string will be passed to python's eval function to calculate a version code.",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"minItems": 1
},
"UpdateCheckIgnore": {
"description": "When checking for updates (via UpdateCheckMode) this can be used to specify a regex which, if matched against the version name, causes that version to be ignored.",
"type": "string"
},
"UpdateCheckName": {
"description": "When checking for updates (via UpdateCheckMode) this can be used to specify the package name to search for. Useful when apps have a static package name but change it programmatically in some app flavors, by e.g. appending “.open” or “.free” at the end of the package name.",
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"Ignore"
]
}
]
},
"UpdateCheckData": {
"description": "Used in conjunction with UpdateCheckMode for certain modes.",
"type": "string"
},
"CurrentVersion": {
"description": "The name of the version that is the recommended release. There may be newer versions of the application than this (e.g. unstable versions), and there will almost certainly be older ones.",
"type": "string"
},
"CurrentVersionCode": {
"description": "The version code corresponding to the CurrentVersion field.",
"type": "integer"
},
"NoSourceSince": {
"description": "In case we are missing the source code for the CurrentVersion reported by Upstream, or that Non-Free elements have been introduced, this defines the first version that began to miss source code.",
"type": "string"
}
},
"required": [
"Categories",
"License",
"Builds"
],
"allOf": [
{
"anyOf": [
{
"required": [
"Repo",
"RepoType",
"SourceCode"
]
},
{
"required": [
"NoSourceSince"
]
}
]
},
{
"if": {
"anyOf": [
{
"properties": {
"ArchivePolicy": {
"const": "0 versions"
}
},
"required": [
"ArchivePolicy"
]
},
{
"required": [
"NoSourceSince"
]
}
]
},
"then": {
"properties": {
"AutoUpdateMode": {
"const": "None"
},
"UpdateCheckMode": {
"const": "None"
}
}
}
},
{
"if": {
"anyOf": [
{
"required": [
"Binaries"
]
},
{
"properties": {
"Builds": {
"contains": {
"required": [
"binary"
]
}
}
},
"required": [
"Builds"
]
}
]
},
"then": {
"required": [
"AllowedAPKSigningKeys"
]
}
},
{
"if": {
"properties": {
"UpdateCheckMode": {
"pattern": "^Tags"
}
}
},
"then": {
"properties": {
"AutoUpdateMode": {
"type": "string",
"pattern": "^(None|Version( \\+.+)?)$"
}
}
}
}
],
"additionalProperties": false,
"definitions": {
"anti_features": {
"$id": "#antifeatures",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"Ads",
"ApplicationDebuggable",
"KnownVuln",
"NonFreeAdd",
"NonFreeAssets",
"NonFreeDep",
"NonFreeNet",
"NoSourceSince",
"NSFW",
"UpstreamNonFree",
"TetheredNet",
"Tracking"
]
},
"uniqueItems": true,
"minItems": 1
},
{
"type": "object",
"patternProperties": {
"^(Ads|Tracking|ApplicationDebuggable|KnownVuln|NonFreeAdd|NonFreeAssets|NonFreeDep|NonFreeNet|NoSourceSince|NSFW|UpstreamNonFree|Tracking)$": {
"$ref": "#/definitions/localized_string"
}
},
"additionalProperties": false
}
]
},
"string_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"localized_string": {
"type": "object",
"patternProperties": {
"^[a-z]{2,3}(-([A-Z][a-zA-Z]+|\\d+|[a-z]+))*$": {
"type": "string"
}
},
"additionalProperties": false
},
"url": {
"type": "string",
"pattern": "^https?://.*$"
}
}
}
|
feed.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"item": {
"required": ["id"],
"additionalProperties": false,
"oneOf": [
{
"required": ["content_html"],
"not": {
"required": ["content_text"]
}
},
{
"required": ["content_text"],
"not": {
"required": ["content_html"]
}
},
{
"required": ["content_text", "content_html"]
}
],
"patternProperties": {
"^_[a-zA-Z]([^.]+)$": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/extension"
}
},
"properties": {
"attachments": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/attachments"
},
"author": {
"description": "Use the \"authors\" key instead, even when there is only one author. Existing feeds can include both \"author\" and \"authors\" for compatibility with existing feed readers. Feed readers should always prefer `authors` if present.",
"deprecated": true,
"allOf": [
{
"$ref": "https://json.schemastore.org/feed-1#/definitions/author"
}
]
},
"authors": {
"type": "array",
"items": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/author"
}
},
"banner_image": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/banner_image"
},
"content_html": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/content_html"
},
"content_text": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/content_text"
},
"date_modified": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/date_modified"
},
"date_published": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/date_published"
},
"external_url": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/external_url"
},
"id": {
"description": "Is unique for that item for that feed over time. If an item is ever updated, the id should be unchanged. New items should never use a previously-used id. Ideally, the id is the full URL of the resource described by the item, since URLs make great unique identifiers.",
"type": ["string"]
},
"image": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/image"
},
"language": {
"description": "The language for this item, using the same format as the top-level \"language\" field. The value can be different than the primary language for the feed when a specific item is written in a different language than other items in the feed.",
"type": "string"
},
"summary": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/summary"
},
"tags": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/tags"
},
"title": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/title"
},
"url": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/item/properties/url"
}
}
}
},
"id": "https://json.schemastore.org/feed.json",
"patternProperties": {
"^_[a-zA-Z]([^.]+)$": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/extension"
}
},
"properties": {
"author": {
"deprecated": true,
"description": "Use the \"authors\" key instead, even when there is only one author. Existing feeds can include both \"author\" and \"authors\" for compatibility with existing feed readers. Feed readers should always prefer `authors` if present.",
"allOf": [
{
"$ref": "https://json.schemastore.org/feed-1#/definitions/author"
}
]
},
"authors": {
"type": "array",
"items": {
"$ref": "https://json.schemastore.org/feed-1#/definitions/author"
}
},
"description": {
"$ref": "https://json.schemastore.org/feed-1#/properties/description"
},
"expired": {
"$ref": "https://json.schemastore.org/feed-1#/properties/expired"
},
"favicon": {
"$ref": "https://json.schemastore.org/feed-1#/properties/description"
},
"feed_url": {
"$ref": "https://json.schemastore.org/feed-1#/properties/feed_url"
},
"home_page_url": {
"$ref": "https://json.schemastore.org/feed-1#/properties/home_page_url"
},
"hubs": {
"$ref": "https://json.schemastore.org/feed-1#/properties/hubs"
},
"icon": {
"$ref": "https://json.schemastore.org/feed-1#/properties/icon"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/item"
}
},
"language": {
"description": "The primary language for the feed in the format specified in RFC 5646. The value is usually a 2-letter language tag from ISO 639-1, optionally followed by a region tag. (Examples: \"en\" or \"en-US\".)",
"type": "string"
},
"next_url": {
"$ref": "https://json.schemastore.org/feed-1#/properties/next_url"
},
"title": {
"$ref": "https://json.schemastore.org/feed-1#/properties/title"
},
"user_comment": {
"$ref": "https://json.schemastore.org/feed-1#/properties/user_comment"
},
"version": {
"description": "The URL of the version of the format the feed uses. This should appear at the very top, though we recognize that not all JSON generators allow for ordering.",
"anyOf": [
{
"enum": ["https://jsonfeed.org/version/1.1"]
},
{
"$ref": "https://json.schemastore.org/feed-1#/definitions/uri"
}
]
}
},
"required": ["items", "title", "version"],
"title": "JSON schema for the JSON Feed format",
"type": "object"
}
|
grunt-copy-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 grunt-contrib-copy",
"type": "object",
"properties": {
"noProcess": {
"description": "This option is passed to grunt.file.copy as an advanced way to control which file contents are processed.",
"type": "string"
},
"encoding": {
"description": "The file encoding to copy files with.",
"type": "string"
},
"mode": {
"description": "Whether to copy or set the existing file permissions. Set to true to copy the existing file permissions. Or set to the mode, i.e.: 0644, that copied files will be set to.",
"type": ["boolean", "number"],
"default": false
}
}
}
},
"id": "https://json.schemastore.org/grunt-copy-task.json",
"properties": {
"options": {
"$ref": "#/definitions/options"
}
},
"title": "JSON schema for the Grunt clean task",
"type": "object"
}
|
fly.json | {
"$id": "https://json.schemastore.org/fly.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"statics": {
"type": "object",
"required": ["guest_path", "url_prefix"],
"additionalProperties": false,
"properties": {
"guest_path": {
"description": "The path inside your container where the assets to serve are located.",
"type": "string"
},
"url_prefix": {
"description": "The URL prefix that should serve the static assets.",
"type": "string"
}
}
},
"services": {
"description": "Configure the mapping of ports from the public Fly proxy to your application.\n\nYou can have:\n* **No services section**: The application has no mappings to the external internet - typically apps like databases or background job workers that talk over 6PN private networking to other apps.\n* **One services section**: One internal port mapped to one external port on the internet.\n* **Multiple services sections**: Map multiple internal ports to multiple external ports.",
"type": "object",
"properties": {
"script_checks": {
"deprecated": true,
"description": "Health checks that run as one-off commands directly on the VM.\n\nThis type of check is **deprecated**. See `tcp_checks` or `http_checks` for alternatives."
},
"protocol": {
"description": "The protocol used to communicate with your application. Can be: `tcp` or `udp`.",
"type": "string",
"enum": ["tcp", "udp"]
},
"internal_port": {
"description": "The port this application listens on to communicate with clients. The default is 8080. We recommend applications use the default.",
"type": "integer",
"default": 8080
},
"concurrency": {
"type": "object",
"description": "Control autoscaling metrics (connections or requests) and limits (hard and soft).",
"properties": {
"type": {
"type": "string",
"default": "connections",
"x-taplo": {
"docs": {
"enumValues": [
"Autoscale based on number of concurrent connections",
"Autoscale based on number of concurrent requests"
]
}
},
"enum": ["connections", "requests"]
},
"hard_limit": {
"default": 25,
"type": "integer",
"description": "When an application instance is __at__ or __over__ this number, the system will bring up another instance."
},
"soft_limit": {
"default": 20,
"type": "integer",
"description": "When an application instance is __at__ or __over__ this number, the system is likely to bring up another instance."
}
}
},
"ports": {
"description": "For each external port you want to accept connections on, add a `ports` section.",
"type": "array",
"items": {
"type": "object",
"properties": {
"handlers": {
"x-taplo": {
"links": {
"key": "https://fly.io/docs/reference/services/#connection-handlers"
}
},
"description": "An array of strings that select handlers to terminate the connection at the edge.\n\nValid options: http, tls, proxy_proto, pg_tls, edge_http.",
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"enum": ["http", "tls", "proxy_proto", "pg_tls", "edge_http"]
}
},
"port": {
"default": 8080,
"type": "integer",
"description": "The port to accept traffic on. Valid ports: 1-65535"
},
"force_https": {
"type": "boolean",
"description": "Force HTTP connections to HTTPS. `force_https` requires the `http` handler in the `handlers` section."
}
}
}
},
"tcp_checks": {
"description": "Basic TCP connection health checks. This is the default check that runs against the configured `internal_port`.",
"type": "array",
"x-taplo": {
"links": {
"key": "https://fly.io/docs/reference/configuration/#services-tcp_checks"
}
},
"items": {
"type": "object",
"properties": {
"grace_period": {
"description": "The time to wait after a VM starts before checking its health. Units are milliseconds unless you specify them like `10s` or `1m`.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"interval": {
"description": "Length of the pause between connectivity checks. Units are milliseconds unless you specify them like `10s` or `1m`.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"restart_limit": {
"default": 0,
"description": "The number of consecutive TCP check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed TCP health checks.",
"type": "integer"
},
"timeout": {
"description": "The maximum time a connection can take before being reported as failing its healthcheck. Units are milliseconds unless you specify them like `10s` or `1m`.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
}
}
}
},
"http_checks": {
"description": "HTTP-based health checks run against the `internal_port`. These checks will pass when receiving a 2xx response. Any other response is considered a failure.",
"type": "array",
"x-taplo": {
"links": {
"key": "https://fly.io/docs/reference/configuration/#services-http_checks"
}
},
"items": {
"type": "object",
"properties": {
"grace_period": {
"description": "The time to wait after a VM starts before checking its health. Units are milliseconds unless you specify them like `10s` or `1m`.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"interval": {
"description": "Length of the pause between connectivity checks. Units are milliseconds unless you specify them like `10s` or `1m`.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"restart_limit": {
"default": 0,
"description": "The number of consecutive check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed health checks.",
"type": "integer"
},
"timeout": {
"description": "The maximum time a connection can take before being reported as failing its healthcheck. Units are milliseconds unless you specify them like `10s` or `1m`.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"method": {
"description": "The HTTP method to be used for the check.",
"type": "string"
},
"path": {
"description": "The path of the URL to be requested.",
"type": "string"
},
"protocol": {
"description": "The protocol to be used (`http` or `https`)",
"type": "string",
"enum": ["http", "https"]
},
"tls_skip_verify": {
"type": "boolean",
"default": false,
"description": "When set to `true` (and `protocol` is set to `https`), skip verifying the certificates sent by the server."
},
"headers": {
"type": "object",
"description": "Set key/value pairs of HTTP headers to pass along with the check request."
}
}
}
}
}
}
},
"description": "https://fly.io/docs/reference/configuration",
"properties": {
"app": {
"description": "Fly.io application name",
"type": "string"
},
"kill_timeout": {
"description": "Seconds to wait before forcing a VM process to exit. Default is 5 seconds.",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"kill_signal": {
"description": "Signal to send to a process to shut it down gracefully. Default is SIGINT.",
"type": "string",
"enum": [
"SIGINT",
"SIGTERM",
"SIGQUIT",
"SIGUSR1",
"SIGUSR2",
"SIGKILL",
"SIGSTOP"
]
},
"statics": {
"description": "The `statics` sections expose static assets built into your application's container to Fly's Anycast network. You can serve HTML files, Javascript, and images without needing to run a web server inside your container.",
"x-taplo": {
"links": {
"key": "https://fly.io/docs/reference/configuration/#the-statics-sections"
}
},
"anyOf": [
{
"$ref": "#/definitions/statics"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/statics"
}
}
]
},
"services": {
"oneOf": [
{
"$ref": "#/definitions/services"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/services"
}
}
]
},
"deploy": {
"type": "object",
"additionalProperties": false,
"properties": {
"release_command": {
"x-taplo": {
"links": {
"key": "https://fly.io/docs/reference/configuration/#release_command"
},
"initKeys": ["importantKey"]
},
"description": "Command to run after a build, with access to the production environment, but before deployment. Non-zero exit status will abort the deployment.\n\n```toml\n[deploy]\n release_command =\"bundle exec rails db:migrate\"\n```",
"type": "string"
},
"strategy": {
"description": "Strategy for replacing VMs during a deployment.",
"type": "string",
"default": "canary",
"enum": ["canary", "rolling", "bluegreen", "immediate"],
"x-taplo": {
"docs": {
"main": "Strategy for replacing VMs during a deployment.",
"enumValues": [
"This default strategy - for apps without volumes - will boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy.",
"One by one, each running VM is taken down and replaced by a new release VM. This is the default strategy for apps with volumes.",
"For every running VM, a new one is booted alongside it. All new VMs must pass health checks to complete deployment, when traffic gets migrated to new VMs. If your app has multiple VMs, this strategy may reduce deploy time and downtime, assuming your app is scaled to 2 or more VMs.",
"Replace all VMs with new releases immediately without waiting for health checks to pass. This is useful in emergency situations where you're confident a release will be healthy."
],
"defaultValue": "Default is 'canary': boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy."
},
"links": {
"key": "https://fly.io/docs/reference/configuration/#strategy"
}
}
}
}
},
"mounts": {
"type": "object",
"x-taplo": {
"links": {
"key": "https://fly.io/docs/reference/configuration/#the-mounts-section"
}
},
"description": "Mount [persistent storage volumes](https://fly.io/docs/reference/volumes) previously setup via `flyctl`. Both settings are required. Example:\n\n```toml\n[mounts]\n source = \"myapp_data\"\n destination = \"/data\"\n```",
"required": ["source", "destination"],
"additionalProperties": false,
"properties": {
"source": {
"description": "The name of the volume to mount as shown in `fly volumes list`.\n\nA volume of this name *must exist* in each of the app regions. If there's more than one volume in the target region with the same one, one will be picked randomly.",
"type": "string"
},
"destination": {
"description": "The path at which the `source` volume should be mounted in the running app VM.",
"type": "string"
},
"processes": {
"description": "The name of the process(es) to which this mount should be applied. See [multiple processes](https://community.fly.io/t/preview-multi-process-apps-get-your-workers-here/2316).",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
}
},
"experimental": {
"description": "Flags and features that are subject to change, deprecation or promotion to the main configuration.",
"type": "object",
"properties": {
"cmd": {
"description": "Override the server command (CMD) set by the Dockerfile. Specify as an array of strings:\n\n```toml\ncmd = [\"path/to/command\", \"arg1\", \"arg2\"]\n```",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"entrypoint": {
"description": "Override the ENTRYPOINT set by the Dockerfile. Specify as an array of strings:\n\n```toml\nentrypoint = [\"path/to/command\", \"arg1\", \"arg2\"]\n```",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"auto_rollback": {
"description": "Failed deployments should roll back automatically to the previous successfully deployed release. Defaults to `true`",
"type": "boolean"
},
"private_network": {
"description": "Enables private network access to the Fly organization. Defaults to `true`.",
"default": true,
"type": "boolean"
}
}
},
"env": {
"description": "Set non-sensitive information as environment variables in the application's [runtime environment](https://fly.io/docs/reference/runtime-environment/).\nFor sensitive information, such as credentials or passwords, use the [secrets command](https://fly.io/docs/reference/secrets). For anything else though, the `env` section provides a simple way to set environment variables. Here's an example:\n```toml\n[env]\n LOG_LEVEL = \"debug\"\n S3_BUCKET = \"my-bucket\"\n```",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"build": {
"description": "Build configuration options. See docs at https://fly.io/docs/reference/builders.",
"type": "object",
"properties": {
"builder": {
"description": "Builder Docker image to be used with the 'buildpacks' option",
"type": "string"
},
"buildpacks": {
"description": "Buildpacks to be run by the 'builder' Docker image",
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true,
"minItems": 1
},
"args": {
"description": "Build arguments passed to both Dockerfile and Buildpack builds. These arguments are **not available** on VMs at runtime.\n```toml\n[build.args]\n USER = \"julieta\"\n MODE = \"production\"\n```",
"type": "array",
"items": {
"type": "object"
}
},
"build-target": {
"description": "Specify the target stage for [multistage Dockerfile builds](https://docs.docker.com/develop/develop-images/multistage-build/).",
"type": "string"
},
"image": {
"description": "Docker image to be deployed (skips the build process)",
"type": "string"
},
"dockerfile": {
"description": "Dockerfile used for builds. Defaults to './Dockerfile'",
"type": "string"
},
"additionalProperties": false
}
},
"additionalProperties": true
},
"title": "Fly.io config schema (fly.toml)",
"type": "object",
"x-taplo-info": {
"authors": ["Joshua Sierles (https://github.com/jsierles)"],
"patterns": ["\\.*fly(.*)?\\.toml?$"]
}
}
|
clib.json | {
"$id": "https://json.schemastore.org/clib.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"name": {
"description": "The name of the package\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#name",
"type": "string",
"pattern": "^[0-9a-z-_]+$"
},
"version": {
"description": "The semantic version number of the package. This number should also be a git tag.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#version",
"type": "string"
},
"src": {
"description": "An array of source files that make up the implementation of your package.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#src",
"type": "array",
"items": {
"type": "string"
}
},
"dependencies": {
"description": "A dictionary of packages and their versions. Each entry represents a package dependency. A dependency must be a clib package.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#dependencies",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"development": {
"description": "Development dependencies are for testing and development purposes.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#development",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"repo": {
"description": "he GitHub slug for your package.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#repo",
"type": "string"
},
"description": {
"description": "A short-and-sweet description of your package.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#description",
"type": "string"
},
"keywords": {
"description": "An array of keywords which describe your package.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#keywords",
"type": "array",
"items": {
"type": "string"
}
},
"license": {
"description": "The license your package is released under.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#license",
"type": "string"
},
"makefile": {
"description": "Your package's Makefile.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#makefile",
"type": "string"
},
"install": {
"description": "Define a script to install your package. This is for executables and libraries only.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#install",
"type": "string"
},
"uninstall": {
"description": "Define a script to uninstall your package.\n\nhttps://github.com/clibs/clib/wiki/Explanation-of-clib.json#uninstall",
"type": "string"
}
},
"type": "object"
}
|
pgap_yaml_input_reader.json | {
"$id": "https://json.schemastore.org/pgap_yaml_input_reader",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {},
"description": "NCBI Prokaryotic Genome Annotation Pipeline (PGAP) input metadata (submol) JSON/YAML configuration file",
"properties": {
"$schema": {
"$id": "/$schema",
"type": "string",
"title": "Schema",
"description": "The value of this keyword MUST be a URI (containing a scheme) and this URI MUST be normalized. ",
"default": "",
"examples": ["https://json.schemastore.org/pgap_yaml_input_reader"]
},
"consortium": {
"$id": "/properties/consortium",
"type": "string",
"title": "Consortium",
"description": "Name of the project that generated the genome assembly",
"default": "",
"examples": ["SkyNet"]
},
"comment": {
"$id": "/properties/comment",
"type": "string",
"title": "Free text comment about the genome assembly",
"description": "Appears in the COMMENT section of each GenBank sequence record.",
"default": "",
"examples": [
"This draft WGS assembly was generated by running SKESA to generate a de-novo assembly. The de-novo assembly was then concatenated with configs generated using a guided assembler using antimicrobial resistance genes as baits to comprehensively catalog the set of resistance genes in the isolate. Note, some parts of the configs derived from the guided assembler may overlap de-novo configs, and other guided assembler configs. De-novo configs can be differentiated from guided assembler configs by their names, which include either 'denovo' or 'guided'."
]
},
"tp_assembly": {
"$id": "/properties/tp_assembly",
"type": "boolean",
"title": "Reserved",
"description": "NCBI internal flag used for testing.",
"default": false,
"examples": [false]
},
"sra": {
"$id": "/properties/sra",
"type": "array",
"title": "SRA assembly data",
"description": "Sequence reads used to build the assembly",
"items": {
"$id": "/properties/sra/items",
"type": "object",
"additionalProperties": false,
"required": ["accession"],
"properties": {
"accession": {
"$id": "/properties/sra/items/properties/accession",
"type": "string",
"title": "SRA Accession",
"description": "Sequence Read Archive (SRA) accession for the run (with SRR, ERR or DRR prefix)",
"default": "",
"examples": ["SRR8796989"]
}
}
}
},
"authors": {
"$id": "/properties/authors",
"type": "array",
"title": "Author(s) of the genome assembly",
"description": "Optional, but include if intending to submit to GenBank. Authors can be different from the contact.",
"items": {
"$id": "/properties/authors/items",
"type": "object",
"additionalProperties": false,
"required": ["author"],
"properties": {
"author": {
"$id": "/properties/authors/items/properties/author",
"type": "object",
"additionalProperties": false,
"required": ["first_name", "last_name"],
"properties": {
"first_name": {
"$id": "/properties/authors/items/properties/author/properties/first_name",
"type": "string",
"title": "First name",
"default": "",
"examples": ["Arnold"]
},
"last_name": {
"$id": "/properties/authors/items/properties/author/properties/last_name",
"type": "string",
"title": "Last name",
"default": "",
"examples": ["Schwarzenegger"]
},
"middle_initial": {
"$id": "/properties/authors/items/properties/author/properties/middle_initial",
"type": "string",
"title": "First letter of middle name",
"default": "",
"examples": ["T800"]
}
}
}
}
}
},
"bioproject": {
"$id": "/properties/bioproject",
"type": "string",
"title": "BioProject ID (PRJXX) for the project, if available",
"default": "",
"examples": ["PRJ9999999"]
},
"biosample": {
"$id": "/properties/biosample",
"type": "string",
"title": "BioSample ID (SAMXXX) for the sequenced sample, if available",
"default": "",
"examples": ["SAMN99999999"]
},
"contact_info": {
"$id": "/properties/contact_info",
"type": "object",
"title": "Submitter contact information",
"description": "Optional, but include if intending to submit to GenBank. The main contact for this genome assembly.",
"additionalProperties": false,
"required": [
"organization",
"department",
"city",
"country",
"street",
"email",
"first_name",
"last_name",
"postal_code"
],
"properties": {
"state": {
"$id": "/properties/contact_info/properties/state",
"type": "string",
"title": "State or region",
"default": "",
"examples": ["MD", "Florida"]
},
"fax": {
"$id": "/properties/contact_info/properties/fax",
"type": "string",
"title": "Fax number",
"default": "",
"examples": ["301-555-1234", "+7 095 555 1234"]
},
"city": {
"$id": "/properties/contact_info/properties/city",
"type": "string",
"title": "City",
"default": "",
"examples": ["Docker"]
},
"country": {
"$id": "/properties/contact_info/properties/country",
"type": "string",
"title": "Country",
"default": "",
"examples": ["Lappland"]
},
"department": {
"$id": "/properties/contact_info/properties/department",
"type": "string",
"title": "Department or division submitting the genome assembly",
"default": "",
"examples": ["Department of Using NCBI"]
},
"email": {
"$id": "/properties/contact_info/properties/email",
"type": "string",
"title": "Email address",
"default": "",
"examples": ["[email protected]"]
},
"first_name": {
"$id": "/properties/contact_info/properties/first_name",
"type": "string",
"title": "First name",
"default": "",
"examples": ["Jane"]
},
"middle_initial": {
"$id": "/properties/contact_info/properties/middle_initial",
"type": "string",
"title": "First letter of middle name",
"default": "",
"examples": ["N"]
},
"last_name": {
"$id": "/properties/contact_info/properties/last_name",
"type": "string",
"title": "Last name",
"default": "",
"examples": ["Doe"]
},
"organization": {
"$id": "/properties/contact_info/properties/organization",
"type": "string",
"title": "Organization or consortium submitting the genome assembly",
"default": "",
"examples": ["Institute of Klebsiella foobarensis research"]
},
"phone": {
"$id": "/properties/contact_info/properties/phone",
"type": "string",
"title": "Phone number",
"default": "",
"examples": ["301-555-0245"]
},
"postal_code": {
"$id": "/properties/contact_info/properties/postal_code",
"type": "string",
"title": "Postal code",
"default": "",
"examples": ["12345"]
},
"street": {
"$id": "/properties/contact_info/properties/street",
"type": "string",
"title": "Street address",
"default": "",
"examples": ["1234 Main St"]
}
}
},
"fasta": {
"$id": "/properties/fasta",
"type": "object",
"additionalProperties": false,
"properties": {
"class": {
"$id": "/properties/fasta/properties/class",
"type": "string",
"title": "Class of input type",
"default": "",
"examples": ["File"]
},
"location": {
"$id": "/properties/fasta/properties/location",
"type": "string",
"title": "Location of input file",
"default": "",
"examples": ["sample_fasta_input.fasta"]
}
}
},
"locus_tag_prefix": {
"$id": "/properties/locus_tag_prefix",
"type": "string",
"title": "Locus tag prefix",
"description": "One to 9-letter prefix to use for naming genes on this genome assembly. If an official locus tag prefix was already reserved from an INSDC organization (GenBank, ENA or DDBJ) for the given BioSample and BioProject pair, provide here. Otherwise, provide a string of your choice. If no value is provided, the prefix 'pgaptmp' will be used. See more details in this Note about locus tags at: https://github.com/ncbi/pgap/wiki/Input-Files#Note-about-locus-tags",
"default": "",
"examples": ["tmp"]
},
"organism": {
"$id": "/properties/organism",
"type": "object",
"additionalProperties": false,
"properties": {
"strain": {
"$id": "/properties/organism/properties/strain",
"type": "string",
"title": "Strain",
"description": "Strain of the sequenced organism",
"default": "",
"examples": ["my_strain"]
},
"genus_species": {
"$id": "/properties/organism/properties/genus_species",
"type": "string",
"title": "Genus and species",
"description": "Binomial name or, if the species is unknown, genus for the sequenced organism. This identifier must be valid in NCBI Taxonomy. See Taxonomy information for how to find out if the name is valid: https://github.com/ncbi/pgap/wiki/Input-Files#Taxonomy-information",
"default": "",
"examples": ["Escherichia coli"]
}
}
},
"publications": {
"$id": "/properties/publications",
"type": "array",
"title": "Publication describing the genome assembly",
"items": {
"$id": "/properties/publications/items",
"type": "object",
"additionalProperties": false,
"required": ["publication"],
"properties": {
"publication": {
"$id": "/properties/publications/items/properties/publication",
"type": "object",
"additionalProperties": false,
"properties": {
"authors": {
"$id": "/properties/publications/items/properties/publication/properties/authors",
"title": "Author(s)",
"type": "array",
"items": {
"$id": "/properties/publications/items/properties/publication/properties/authors/items",
"type": "object",
"additionalProperties": false,
"properties": {
"author": {
"$id": "/properties/publications/items/properties/publication/properties/authors/items/properties/author",
"type": "object",
"additionalProperties": false,
"required": ["first_name", "last_name"],
"properties": {
"first_name": {
"$id": "/properties/publications/items/properties/publication/properties/authors/items/properties/author/properties/first_name",
"type": "string",
"title": "First name",
"default": "",
"examples": ["Arnold"]
},
"last_name": {
"$id": "/properties/publications/items/properties/publication/properties/authors/items/properties/author/properties/last_name",
"type": "string",
"title": "Last name",
"default": "",
"examples": ["Schwarzenegger"]
},
"middle_initial": {
"$id": "/properties/publications/items/properties/publication/properties/authors/items/properties/author/properties/middle_initial",
"type": "string",
"title": "First letter of middle name",
"default": "",
"examples": ["T800"]
}
}
}
}
}
},
"status": {
"$id": "/properties/publications/items/properties/publication/properties/status",
"type": "string",
"title": "Publication status",
"description": "Can be only one of: published, in-press, unpublished",
"default": "",
"enum": ["published", "in-press", "unpublished"]
},
"pmid": {
"$id": "/properties/publications/items/properties/publication/properties/pmid",
"type": "integer",
"title": "PubMed ID for the publication",
"default": ""
},
"title": {
"$id": "/properties/publications/items/properties/publication/properties/title",
"type": "string",
"title": "Title",
"default": "",
"examples": [
"Discrete CHARMm of Klebsiella foobarensis. Journal of Improbable Results, vol. 34, issue 13, pages: 10001-100005, 2018"
]
}
}
}
}
}
},
"topology": {
"$id": "/properties/topology",
"type": "string",
"title": "Topology of the sequences included in the fasta file",
"description": "Possible values are linear or circular. Circular means that the first base in the sequence is adjacent to the last base. Please provide the topology in the metadata YAML file only if it is applicable to ALL sequences in the fasta file. If some sequences in the assembled genome are circular and others linear, include the topology in the definition line of each sequence in the fasta file with the tag value pair [topology=circular] or [topology=linear], after the SeqID and a space (e.g. >seq1 [topology=circular]). If the topology is provided in neither the metadata YAML nor the fasta file, the sequences will be presumed to be linear.",
"default": "",
"examples": ["circular", "linear"]
},
"location": {
"$id": "/properties/location",
"type": "string",
"title": "Location of the sequences included in the fasta file",
"description": "Possible values are chromosome or plasmid. Please provide the location in the metadata YAML file only if it is applicable to ALL sequences in the fasta file. If some sequences in the assembled genome are chromosomes and others plasmids, include the location in the definition line of each sequence in the fasta file with the tag value pair [location=chromosome] or [location=plasmid], after the SeqID and a space (e.g. >seq1 [location=plasmid]). In plasmid case add [plasmid-name=<plasmidname>]. If the location is provided in neither the metadata YAML nor the fasta file, the sequences will be presumed to be chromosome. Note: since 2021 releases of PGAPx this will affect noticeably the annotation on the molecule",
"default": "",
"examples": ["chromosome", "plasmid"]
}
},
"required": ["authors", "contact_info"],
"title": "NCBI PGAP submol YAML",
"type": "object"
}
|
rust-toolchain.json | {
"$id": "https://json.schemastore.org/rust-toolchain.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file",
"properties": {
"toolchain": {
"description": "A `toolchain` is a complete installation of the Rust compiler (`rustc`) and related tools (like `cargo`). A toolchain specification includes the release channel or version, and the host platform that the toolchain runs on.\n\n Get more from [`Toolchains`](https://rust-lang.github.io/rustup/concepts/toolchains.html)",
"type": "object",
"minProperties": 1,
"properties": {
"channel": {
"description": "`channel` is a named release channel, a major and minor version number such as `1.42`, or a fully specified version number, such as `1.42.0`. Channel names can be optionally appended with an archive date, as in `nightly-2014-12-18`, in which case the toolchain is downloaded from the archive for that date. Get more from [`Toolchain specification`](https://rust-lang.github.io/rustup/concepts/toolchains.html).\n\nOther valid channel like `stable`,`1.63`,`1.63.0`,`nightly-2022-09-20`,`stable-x86_64-pc-windows-msvc`,`1.63.0-riscv64gc-unknown-linux-gnu`,`nightly-2022-09-20-x86_64-unknown-nux-gnu`",
"type": "string",
"pattern": "^(?:stable|beta|nightly|\\d+(?:\\.\\d+){1,2})(?:-\\d{4}(?:-\\d{2}){2})?(?:-\\D[^-]*(?:(?:-(?:[^-]+)){1,3}))?$",
"examples": [
"stable",
"1.63",
"1.63.0",
"nightly-2022-09-20",
"stable-x86_64-pc-windows-msvc",
"1.63.0-riscv64gc-unknown-linux-gnu",
"nightly-2022-09-20-x86_64-unknown-linux-gnu"
],
"x-taplo": {
"links": {
"key": "https://rust-lang.github.io/rustup/concepts/channels.html"
}
}
},
"components": {
"description": "Each release of Rust includes several \"components\", some of\nwhich are required (like `rustc`) and some that are optional (like [`clippy`](https://github.com/rust-lang/rust-clippy)) \n\n Learn more from [`Components`](https://rust-lang.github.io/rustup/concepts/components.html)",
"type": "array",
"items": {
"type": "string",
"enum": [
"rustc",
"cargo",
"rustfmt",
"rust-std",
"rust-docs",
"rls",
"clippy",
"miri",
"rust-src",
"rust",
"rust-analysis",
"llvm-tools",
"rustc-docs",
"rustc-dev",
"rust-analyzer",
"reproducible-artifacts",
"rust-docs-json"
],
"x-taplo": {
"docs": {
"enumValues": [
"The Rust compiler and [Rustdoc].\n\n[rustdoc]: https://doc.rust-lang.org/rustdoc/",
"[Cargo] is a package manager and build tool.\n\n[cargo]: https://doc.rust-lang.org/cargo/",
"[Rustfmt] is a tool for automatically formatting code.\n\n[rustfmt]: https://github.com/rust-lang/rustfmt",
"This is the Rust [standard library]. There is a separate\n `rust-std` component for each target that `rustc` supports, such as\n `rust-std-x86_64-pc-windows-msvc`. See the [Cross-compilation] chapter for\n more detail.\n\n[standard library]: https://doc.rust-lang.org/std/\n[cross-compilation]: .https://rust-lang.github.io/rustup/cross-compilation.html",
"This is a local copy of the [Rust documentation]. Use the\n `rustup doc` command to open the documentation in a web browser. Run `rustup\n doc --help` for more options.\n\n[rust documentation]: https://doc.rust-lang.org/",
"[RLS] is a language server that provides support for editors and\n IDEs.\n\n[RLS]: https://github.com/rust-lang/rls",
"[Clippy] is a lint tool that provides extra checks for common\n mistakes and stylistic choices.\n\n[clippy]: https://github.com/rust-lang/rust-clippy",
"[Miri] is an experimental Rust interpreter, which can be used for\n checking for undefined-behavior.\n\n[miri]: https://github.com/rust-lang/miri/",
"This is a local copy of the source code of the Rust standard\n library. This can be used by some tools, such as [RLS], to provide\n auto-completion for functions within the standard library; [Miri] which is a\n Rust interpreter; and Cargo's experimental [build-std] feature, which allows\n you to rebuild the standard library locally.\n\n[RLS]: https://github.com/rust-lang/rls\n[miri]: https://github.com/rust-lang/miri/\n[build-std]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#build-std",
"Metadata about the standard library, used by tools like\n [RLS].\n\n[RLS]: https://github.com/rust-lang/rls",
"This contains a linker and platform libraries for building on\n the `x86_64-pc-windows-gnu` platform.",
"This is an experimental component which contains a\n collection of [LLVM] tools.\n\n[LLVM]: https://llvm.org/",
"This component contains the compiler as a library. Most users\n will not need this; it is only needed for development *of* tools that link\n to the compiler, such as making modifications to [Clippy].\n\n[clippy]: https://github.com/rust-lang/rust-clippy"
]
}
},
"$comment": "Empty schema to allow for forward compatibility of new components"
},
"x-taplo": {
"links": {
"key": "https://rust-lang.github.io/rustup/concepts/components.html"
}
}
},
"targets": {
"description": "`rustc` is capable of generating code for many platforms. The `target` specifies the platform that the code will be generated for. By default, `cargo` and `rustc` use the host toolchain's platform as the target. To build for a different `target`, usually the target's standard library needs to be installed first via the `rustup target` command. Or you can run `rustc --print target-list` to list [`\"built-in\" targets`](https://doc.rust-lang.org/rustc/targets/built-in.html) \n\n Get more from [`Platform Support`](https://doc.rust-lang.org/rustc/platform-support.html) and [`Targets`](https://doc.rust-lang.org/rustc/targets/index.html)",
"type": "array",
"$comment": "Allow arbitary strings for new targets or custom target JSON",
"items": {
"type": "string",
"$comment": "From `rustc +nightly --print target-list` or targets listed in https://doc.rust-lang.org/rustc/platform-support.html",
"enum": [
"aarch64-unknown-linux-gnu",
"i686-pc-windows-gnu",
"i686-pc-windows-msvc",
"i686-unknown-linux-gnu",
"x86_64-apple-darwin",
"x86_64-pc-windows-gnu",
"x86_64-pc-windows-msvc",
"x86_64-unknown-linux-gnu",
"aarch64-apple-darwin",
"aarch64-pc-windows-msvc",
"aarch64-unknown-linux-musl",
"arm-unknown-linux-gnueabi",
"arm-unknown-linux-gnueabihf",
"armv7-unknown-linux-gnueabihf",
"loongarch64-unknown-linux-gnu",
"mips-unknown-linux-gnu",
"mips64-unknown-linux-gnuabi64",
"mips64el-unknown-linux-gnuabi64",
"mipsel-unknown-linux-gnu",
"powerpc-unknown-linux-gnu",
"powerpc64-unknown-linux-gnu",
"powerpc64le-unknown-linux-gnu",
"riscv64gc-unknown-linux-gnu",
"s390x-unknown-linux-gnu",
"x86_64-unknown-freebsd",
"x86_64-unknown-illumos",
"x86_64-unknown-linux-musl",
"x86_64-unknown-netbsd",
"aarch64-apple-ios",
"aarch64-apple-ios-sim",
"aarch64-fuchsia",
"aarch64-linux-android",
"aarch64-unknown-fuchsia",
"aarch64-unknown-none",
"aarch64-unknown-none-softfloat",
"aarch64-unknown-uefi",
"arm-linux-androideabi",
"arm-unknown-linux-musleabi",
"arm-unknown-linux-musleabihf",
"armebv7r-none-eabi",
"armebv7r-none-eabihf",
"armv5te-unknown-linux-gnueabi",
"armv5te-unknown-linux-musleabi",
"armv7-linux-androideabi",
"armv7-unknown-linux-gnueabi",
"armv7-unknown-linux-musleabi",
"armv7-unknown-linux-musleabihf",
"armv7a-none-eabi",
"armv7r-none-eabi",
"armv7r-none-eabihf",
"asmjs-unknown-emscripten",
"i586-pc-windows-msvc",
"i586-unknown-linux-gnu",
"i586-unknown-linux-musl",
"i686-linux-android",
"i686-unknown-freebsd",
"i686-unknown-linux-musl",
"i686-unknown-uefi",
"mips-unknown-linux-musl",
"mips64-unknown-linux-muslabi64",
"mips64el-unknown-linux-muslabi64",
"mipsel-unknown-linux-musl",
"nvptx64-nvidia-cuda",
"riscv32i-unknown-none-elf",
"riscv32imac-unknown-none-elf",
"riscv32imc-unknown-none-elf",
"riscv64gc-unknown-none-elf",
"riscv64imac-unknown-none-elf",
"sparc64-unknown-linux-gnu",
"sparcv9-sun-solaris",
"thumbv6m-none-eabi",
"thumbv7em-none-eabi",
"thumbv7em-none-eabihf",
"thumbv7m-none-eabi",
"thumbv7neon-linux-androideabi",
"thumbv7neon-unknown-linux-gnueabihf",
"thumbv8m.base-none-eabi",
"thumbv8m.main-none-eabi",
"thumbv8m.main-none-eabihf",
"wasm32-unknown-emscripten",
"wasm32-unknown-unknown",
"wasm32-wasi",
"x86_64-apple-ios",
"x86_64-fortanix-unknown-sgx",
"x86_64-fuchsia",
"x86_64-linux-android",
"x86_64-pc-solaris",
"x86_64-unknown-fuchsia",
"x86_64-unknown-linux-gnux32",
"x86_64-unknown-none",
"x86_64-unknown-redox",
"x86_64-unknown-uefi",
"aarch64-apple-ios-macabi",
"aarch64-apple-tvos",
"aarch64-apple-watchos-sim",
"aarch64-kmc-solid_asp3",
"aarch64-nintendo-switch-freestanding",
"aarch64-pc-windows-gnullvm",
"aarch64-unknown-freebsd",
"aarch64-unknown-hermit",
"aarch64-unknown-linux-gnu_ilp32",
"aarch64-unknown-linux-ohos",
"aarch64-unknown-netbsd",
"aarch64-unknown-nto-qnx710",
"aarch64-unknown-openbsd",
"aarch64-unknown-redox",
"aarch64-uwp-windows-msvc",
"aarch64-wrs-vxworks",
"aarch64_be-unknown-linux-gnu",
"aarch64_be-unknown-linux-gnu_ilp32",
"arm64_32-apple-watchos",
"armeb-unknown-linux-gnueabi",
"armv4t-none-eabi",
"armv4t-unknown-linux-gnueabi",
"armv5te-none-eabi",
"armv5te-unknown-linux-uclibceabi",
"armv6-unknown-freebsd",
"armv6-unknown-netbsd-eabihf",
"armv6k-nintendo-3ds",
"armv7-apple-ios",
"armv7-sony-vita-newlibeabihf",
"armv7-unknown-freebsd",
"armv7-unknown-linux-ohos",
"armv7-unknown-linux-uclibceabi",
"armv7-unknown-linux-uclibceabihf",
"armv7-unknown-netbsd-eabihf",
"armv7-wrs-vxworks-eabihf",
"armv7a-kmc-solid_asp3-eabi",
"armv7a-kmc-solid_asp3-eabihf",
"armv7a-none-eabihf",
"armv7k-apple-watchos",
"armv7s-apple-ios",
"avr-unknown-gnu-atmega328",
"bpfeb-unknown-none",
"bpfel-unknown-none",
"hexagon-unknown-linux-musl",
"i386-apple-ios",
"i586-pc-nto-qnx700",
"i686-apple-darwin",
"i686-unknown-haiku",
"i686-unknown-netbsd",
"i686-unknown-openbsd",
"i686-uwp-windows-gnu",
"i686-uwp-windows-msvc",
"i686-wrs-vxworks",
"loongarch64-unknown-none",
"loongarch64-unknown-none-softfloat",
"m68k-unknown-linux-gnu",
"mips-unknown-linux-uclibc",
"mips64-openwrt-linux-musl",
"mipsel-sony-psp",
"mipsel-sony-psx",
"mipsel-unknown-linux-uclibc",
"mipsel-unknown-none",
"mipsisa32r6-unknown-linux-gnu",
"mipsisa32r6el-unknown-linux-gnu",
"mipsisa64r6-unknown-linux-gnuabi64",
"mipsisa64r6el-unknown-linux-gnuabi64",
"msp430-none-elf",
"powerpc-unknown-freebsd",
"powerpc-unknown-linux-gnuspe",
"powerpc-unknown-linux-musl",
"powerpc-unknown-netbsd",
"powerpc-unknown-openbsd",
"powerpc-wrs-vxworks",
"powerpc-wrs-vxworks-spe",
"powerpc64-ibm-aix",
"powerpc64-unknown-freebsd",
"powerpc64-unknown-linux-musl",
"powerpc64-unknown-openbsd",
"powerpc64-wrs-vxworks",
"powerpc64le-unknown-freebsd",
"powerpc64le-unknown-linux-musl",
"riscv32gc-unknown-linux-gnu",
"riscv32gc-unknown-linux-musl",
"riscv32im-unknown-none-elf",
"riscv32imac-unknown-xous-elf",
"riscv32imc-esp-espidf",
"riscv32imac-esp-espidf",
"riscv64gc-unknown-freebsd",
"riscv64gc-unknown-fuchsia",
"riscv64gc-unknown-linux-musl",
"riscv64gc-unknown-openbsd",
"s390x-unknown-linux-musl",
"sparc-unknown-linux-gnu",
"sparc64-unknown-netbsd",
"sparc64-unknown-openbsd",
"thumbv4t-none-eabi",
"thumbv5te-none-eabi",
"thumbv7a-pc-windows-msvc",
"thumbv7a-uwp-windows-msvc",
"thumbv7neon-unknown-linux-musleabihf",
"wasm64-unknown-unknown",
"x86_64-apple-ios-macabi",
"x86_64-apple-tvos",
"x86_64-apple-watchos-sim",
"x86_64-pc-nto-qnx710",
"x86_64-pc-windows-gnullvm",
"x86_64-sun-solaris",
"x86_64-unknown-dragonfly",
"x86_64-unknown-haiku",
"x86_64-unknown-hermit",
"x86_64-unknown-l4re-uclibc",
"x86_64-unknown-openbsd",
"x86_64-uwp-windows-gnu",
"x86_64-uwp-windows-msvc",
"x86_64-wrs-vxworks",
"x86_64h-apple-darwin"
]
},
"x-taplo": {
"links": {
"key": "https://rust-lang.github.io/rustup/cross-compilation.html"
}
}
},
"profile": {
"description": "[`Profiles`](https://rust-lang.github.io/rustup/concepts/profiles.htm) are groups of [`components`](https://rust-lang.github.io/rustup/concepts/components.html) you can choose to download while installing a new Rust [`toolchain`](https://rust-lang.github.io/rustup/concepts/toolchains.html).\n\n The `profiles` available at this time are `minimal`, `default`, and `complete`.",
"type": "string",
"default": "default",
"enum": ["minimal", "default", "complete"],
"x-taplo": {
"links": {
"key": "https://rust-lang.github.io/rustup/concepts/profiles.html"
},
"docs": {
"enumValues": [
"This profile includes as few components as possible to get a\nworking compiler (`rustc`, `rust-std`, and `cargo`). It's recommended to use\nthis component on Windows systems if you don't use local documentation (the\nlarge number of files can cause issues with some Antivirus systems), and in\nCI.",
"This profile includes all of components in the **minimal**\nprofile, and adds `rust-docs`, `rustfmt`, and `clippy`. This profile will be\nused by `rustup` by default, and it's the one recommended for general use.",
"This profile includes all the components available through\n`rustup`. This should never be used, as it includes *every* component ever\nincluded in the metadata and thus will almost always fail. If you are\nlooking for a way to install devtools such as `miri` or IDE integration\ntools (`rls`), you should use the `default` profile and\ninstall the needed additional components manually, either by using `rustup\ncomponent add` or by using `-c` when installing the toolchain."
]
}
}
},
"path": {
"type": "string",
"description": "Path to a custom local toolchain. Since a `path` directive directly names a local toolchain, other options\nlike `components`, `targets`, and `profile` have no effect. `channel`\nand `path` are mutually exclusive, since a `path` already points to a\nspecific toolchain. A relative `path` is resolved relative to the\nlocation of the `rust-toolchain.toml` file.\n\n Learn more from [`Custom toolchains`](https://rust-lang.github.io/rustup/concepts/toolchains.html#custom-toolchains)"
}
},
"oneOf": [
{
"not": {
"properties": {
"path": {
"type": "string"
}
},
"required": ["path"]
}
},
{
"required": ["path"]
}
],
"dependencies": {
"path": {
"not": {
"properties": {
"channel": {
"type": "string"
}
},
"required": ["channel"]
}
},
"channel": {
"not": {
"properties": {
"path": {
"type": "string"
}
},
"required": ["path"]
}
},
"profile": {
"anyOf": [
{
"properties": {
"channel": {
"type": "string"
}
},
"required": ["channel"]
},
{
"properties": {
"components": {
"type": "array"
}
},
"required": ["components"]
},
{
"properties": {
"targets": {
"type": "array"
}
},
"required": ["targets"]
}
]
}
},
"x-taplo": {
"links": {
"key": "https://rust-lang.github.io/rustup/concepts/toolchains.html"
},
"initKeys": ["channel"]
}
}
},
"required": ["toolchain"],
"title": "Schema for rust-toolchain.toml",
"type": "object",
"x-taplo-info": {
"authors": ["ian-h-chamberlain (https://github.com/ian-h-chamberlain)"],
"patterns": ["^(.*(/|\\\\)rust-toolchain([.]toml)?)$"]
}
}
|
KSP-AVC.schema.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Add-on Version Checker file",
"description": "A KSP-AVC version file's content",
"type": "object",
"properties": {
"NAME": {
"description": "The display name for the add-on",
"type": "string"
},
"URL": {
"description": "Location of a remote version file for update checking",
"type": "string",
"format": "uri"
},
"DOWNLOAD": {
"description": "Web address where the latest version can be downloaded",
"type": "string",
"format": "uri"
},
"CHANGE_LOG": {
"description": "The complete or incremental change log for the add-on",
"type": "string"
},
"CHANGE_LOG_URL": {
"description": "Populates the CHANGE_LOG field using the file at this url",
"type": "string",
"format": "uri"
},
"GITHUB": {
"description": "Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified. If the latest release version is not equal to the version in the file, an update notification will not appear.",
"type": "object",
"properties": {
"USERNAME ": {
"description": "Your GitHub username",
"type": "string"
},
"REPOSITORY ": {
"description": "The name of the source repository",
"type": "string"
},
"ALLOW_PRE_RELEASE ": {
"description": "Include pre-releases in the latest release search",
"type": "boolean"
}
},
"required": [
"USERNAME",
"REPOSITORY"
]
},
"KERBAL_STUFF_URL": {
"description": "URL to this mod's page on KerbalStuff",
"type": "string",
"format": "uri"
},
"VERSION": {
"description": "The version of the add-on",
"$ref": "#/definitions/version"
},
"KSP_VERSION": {
"description": "Version of KSP that the add-on was made to support",
"$ref": "#/definitions/version"
},
"KSP_VERSION_MIN": {
"description": "Minimum version of KSP that the add-on supports",
"$ref": "#/definitions/version"
},
"KSP_VERSION_MAX": {
"description": "Maximum version of KSP that the add-on supports",
"$ref": "#/definitions/version"
},
"DISALLOW_VERSION_OVERRIDE": {
"type": "boolean",
"description": "If true, don't trust KSP-AVC's idea of which game versions are compatible with which other game versions, based on user configuration"
},
"ASSEMBLY_NAME": {
"type": "string",
"description": "DO NOT USE, won't work with CKAN; name of a DLL to check for VERSION on the fly"
},
"KSP_VERSION_INCLUDE": {
"description": "DO NOT USE, won't work with CKAN; a list of versions with which this mod is compatible",
"type": "array",
"items": {
"$ref": "#/definitions/version"
},
"uniqueItems": true
},
"KSP_VERSION_EXCLUDE": {
"description": "DO NOT USE, won't work with CKAN; a list of versions with which this mod is incompatible",
"type": "array",
"items": {
"$ref": "#/definitions/version"
},
"uniqueItems": true
},
"LOCAL_HAS_PRIORITY": {
"type": "boolean",
"description": "DO NOT USE, won't work with CKAN; if true, don't override properties using the remote version file"
},
"REMOTE_HAS_PRIORITY": {
"type": "boolean",
"description": "DO NOT USE, won't work with CKAN; if false, don't override properties using the remote version file"
},
"INSTALL_LOC|INSTALL_LOC*": {
"description": "Stanza to define file location to check, used by MADLAD",
"$ref": "#/definitions/install_loc"
}
},
"required": [
"NAME",
"VERSION"
],
"definitions": {
"version": {
"description": "A semantic(?) version",
"anyOf": [
{
"type": "string",
"pattern": "^(any|[0-9]+\\.[0-9]+(\\.[0-9]+)?)$"
},
{
"type": "object",
"properties": {
"MAJOR": {
"description": "Change major version when you make incompatible API changes",
"type": "integer"
},
"MINOR": {
"description": "Change minor version when you add functionality in a backwards-compatible manner",
"type": "integer"
},
"PATCH": {
"description": "Change patch version when you make backwards-compatible bug fixes",
"type": "integer"
},
"BUILD": {
"description": "Build informaion",
"type": "integer"
}
},
"required": [
"MAJOR"
]
}
]
},
"install_loc": {
"description": "definition of the install_loc fields",
"NAME": {
"type": "string",
"description": "Name of the mod, If not specified, uses the Modname from the .version file"
},
"PATH": {
"type": "string",
"description": "Path to the directory, begins below the GameData. Must be there, but will be empty in most cases"
},
"DIRECTORY": {
"type": "string",
"description": "Directory where file is"
},
"FILE": {
"type": "string",
"description": "filename to be checked. If not specified, then it checks for the directory only"
},
"required": [
"PATH",
"DIRECTORY"
]
}
}
}
|
minecraft-predicate.json | {
"$comment": "https://minecraft.fandom.com/wiki/Predicate",
"$id": "https://json.schemastore.org/minecraft-predicate.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:alternative"
}
}
},
"then": {
"properties": {
"terms": {
"title": "Terms",
"description": "A list of conditions to join using 'or'.",
"type": "object"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:block_state_property"
}
}
},
"then": {
"properties": {
"block": {
"title": "Block",
"description": "A block ID.",
"type": "string"
},
"properties": {
"title": "Properties",
"description": "A map of block property names to values.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:damage_source_properties"
}
}
},
"then": {
"properties": {
"predicate": {
"title": "Predicate",
"description": "Predicate applied to the damage source.",
"$ref": "#/definitions/tagsCommonToAllDamageTypes"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:entity_properties"
}
}
},
"then": {
"description": "Test properties of an entity.",
"properties": {
"entity": {
"title": "Entity",
"description": "Specifies the entity to check for the condition.",
"type": "string",
"enum": ["this", "killer", "killer_player"]
},
"predicate": {
"title": "Predicate",
"description": "Predicate applied to entity.",
"$ref": "#/definitions/tagsCommonToAllEntities"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:entity_scores"
}
}
},
"then": {
"description": "Test the scoreboard scores of an entity.",
"properties": {
"entity": {
"title": "Entity",
"description": "Specifies the entity to check for the condition.",
"type": "string",
"enum": ["this", "killer", "killer_player"]
},
"scores": {
"title": "Scores",
"description": "Scores to check. All specified scores must pass for the condition to pass.",
"type": "object",
"additionalProperties": {
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
}
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:inverted"
}
}
},
"then": {
"description": "Inverts condition from parameter term.",
"properties": {
"term": {
"title": "Term",
"description": "The condition to be negated.",
"type": "object"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:killed_by_player"
}
}
},
"then": {
"description": "Test if a killer_player entity is available.",
"properties": {
"inverse": {
"title": "Inverse",
"description": "If true, the condition passes if killer_player is not available.",
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:location_check"
}
}
},
"then": {
"description": "Checks if the current location matches.",
"properties": {
"offsetX": {
"title": "Offset X",
"description": "Offsets to location.",
"type": "integer"
},
"offsetY": {
"title": "Offset Y",
"description": "Offsets to location.",
"type": "integer"
},
"offsetZ": {
"title": "Offset Z",
"description": "Offsets to location.",
"type": "integer"
},
"predicate": {
"title": "Predicate",
"description": "Predicate applied to location.",
"$ref": "#/definitions/tagsCommonToAllLocations"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:match_tool"
}
}
},
"then": {
"description": "Checks tool.",
"properties": {
"predicate": {
"title": "Predicate",
"description": "Predicate applied to item.",
"$ref": "#/definitions/tagsCommonToAllItems"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:random_chance"
}
}
},
"then": {
"description": "Test if a random number 0.0–1.0 is less than a specified value.",
"properties": {
"chance": {
"title": "Chance",
"description": "Success rate.",
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:random_chance_with_looting"
}
}
},
"then": {
"description": "Test if a random number 0.0–1.0 is less than a specified value, affected by the level of Looting on the killer entity.",
"properties": {
"chance": {
"title": "Chance",
"description": "Base success rate.",
"type": "number"
},
"looting_multiplier": {
"title": "Looting Multiplier",
"description": "Looting adjustment to the base success rate. Formula is chance + (looting_level * looting_multiplier).",
"type": "number"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:reference"
}
}
},
"then": {
"description": "Test if another referred condition (predicate) passes.",
"properties": {
"name": {
"title": "Name",
"description": "The namespaced ID of the condition (predicate) referred to. A cyclic reference causes a parsing failure.",
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:survives_explosion"
}
}
},
"then": {
"description": "Returns true with 1/explosion radius probability."
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:table_bonus"
}
}
},
"then": {
"description": "Passes with probability picked from table, indexed by enchantment level.",
"properties": {
"enchantment": {
"title": "Enchantment",
"description": "Id of enchantment.",
"type": "integer"
},
"chances": {
"title": "Chances",
"description": "List of probabilities for enchantment level, indexed from 0.",
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:time_check"
}
}
},
"then": {
"description": "Checks the current time.",
"properties": {
"value": {
"title": "Value",
"description": "The time value in ticks.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
},
"period": {
"title": "Period",
"description": "Time gets modulo-divided by this value (for example, if set to 24000, value operates on a time period of daytime ticks just like /time query daytime).",
"type": "integer"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:weather_check"
}
}
},
"then": {
"description": "Checks for a current weather state.",
"properties": {
"raining": {
"title": "Raining",
"description": "If true, the condition evaluates to true only if it's raining or thundering.",
"type": "boolean"
},
"thundering": {
"title": "Thundering",
"description": "If true, the condition evaluates to true only if it's thundering.",
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"conditions": {
"const": "minecraft:value_check"
}
}
},
"then": {
"description": "Checks for range of value.",
"properties": {
"value": {
"title": "Value",
"description": "The value to test.",
"type": ["integer", "object"],
"$ref": "#/definitions/numberProvider"
},
"range": {
"title": "Range",
"description": "If true, the condition evaluates to true only if it's thundering.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
}
}
}
}
],
"definitions": {
"numberRange": {
"type": "object",
"properties": {
"max": {
"title": "Max",
"description": "The max value.",
"type": "number"
},
"min": {
"title": "Minimum",
"description": "The minimum value.",
"type": "number"
}
}
},
"integerRange": {
"properties": {
"max": {
"title": "Max",
"description": "The max value.",
"type": ["integer", "object"],
"$ref": "#/definitions/numberProvider"
},
"min": {
"title": "Minimum",
"description": "The minimum value.",
"type": ["integer", "object"],
"$ref": "#/definitions/numberProvider"
}
}
},
"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"
}
}
}
}
]
},
"enchantments": {
"type": "array",
"items": {
"title": "Enchantment",
"type": "object",
"properties": {
"enchantment": {
"title": "Enchantment",
"description": "An enchantment ID.",
"type": "string"
},
"levels": {
"title": "Levels",
"description": "The level of the enchantment.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
}
}
}
},
"tagsCommonToAllDamageTypes": {
"type": "object",
"properties": {
"bypasses_armor": {
"title": "Bypasses Armor",
"description": "Checks if the damage bypassed the armor of the player (suffocation damage predominantly).",
"type": "boolean"
},
"bypasses_invulnerability": {
"title": "Bypasses Invulnerability",
"description": "Checks if the damage bypassed the invulnerability status of the player (void or /kill damage).",
"type": "boolean"
},
"bypasses_magic": {
"title": "Bypasses Magic",
"description": "Checks if the damage was caused by starvation.",
"type": "boolean"
},
"direct_entity": {
"title": "Direct Entity",
"description": "The entity that was the direct cause of the damage.",
"type": "object"
},
"is_explosion": {
"title": "Is Explosion",
"description": "Checks if the damage originated from an explosion.",
"type": "boolean"
},
"is_fire": {
"title": "Is Fire",
"description": "Checks if the damage originated from fire.",
"type": "boolean"
},
"is_magic": {
"title": "Is Magic",
"description": "Checks if the damage originated from magic.",
"type": "boolean"
},
"is_projectile": {
"title": "Is Projectile",
"description": "Checks if the damage originated from a projectile.",
"type": "boolean"
},
"is_lightning": {
"title": "Is Lightning",
"description": "Checks if the damage originated from lightning.",
"type": "boolean"
},
"source_entity": {
"title": "Source Entity",
"description": "Checks the entity that was the source of the damage (for example: The skeleton that shot the arrow).",
"$ref": "#/definitions/tagsCommonToAllEntities"
}
}
},
"tagsCommonToAllItems": {
"type": "object",
"properties": {
"count": {
"title": "Count",
"description": "The amount of the item.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
},
"durability": {
"title": "Durability",
"description": "The durability of the item.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
},
"enchantments": {
"title": "Enchantments",
"description": "List of enchantments.",
"$ref": "#/definitions/enchantments"
},
"stored_enchantments": {
"title": "Stored Enchantments",
"description": "List of stored enchantments.",
"$ref": "#/definitions/enchantments"
},
"items": {
"title": "Items",
"description": "List of item IDs.",
"type": "array"
},
"nbt": {
"title": "NBT",
"description": "An NBT string.",
"type": "string"
},
"potion": {
"title": "Potion",
"description": "A brewed potion ID.",
"type": "string"
},
"tag": {
"title": "Tag",
"description": "An item data pack tag.",
"type": "string"
}
}
},
"tagsCommonToAllLocations": {
"type": "object",
"properties": {
"biome": {
"title": "Biome",
"description": "The biome the entity is currently in.",
"type": "string",
"enum": [
"badlands",
"badlands_plateau",
"beach",
"birch_forest",
"birch_forest_hills",
"cold_ocean",
"dark_forest",
"dark_forest_hills",
"deep_cold_ocean",
"deep_frozen_ocean",
"deep_lukewarm_ocean",
"deep_ocean",
"deep_warm_ocean",
"desert",
"desert_hills",
"desert_lakes",
"end_barrens",
"end_highlands",
"end_midlands",
"eroded_badlands",
"flower_forest",
"forest",
"frozen_ocean",
"frozen_river",
"giant_spruce_taiga",
"giant_spruce_taiga_hills",
"giant_tree_taiga",
"giant_tree_taiga_hills",
"gravelly_mountains",
"ice_spikes",
"jungle",
"jungle_edge",
"jungle_hills",
"lukewarm_ocean",
"modified_badlands_plateau",
"modified_gravelly_mountains",
"modified_jungle",
"modified_jungle_edge",
"modified_wooded_badlands_plateau",
"mountain_edge",
"mountains",
"mushroom_field_shore",
"mushroom_fields",
"nether",
"ocean",
"plains",
"river",
"savanna",
"savanna_plateau",
"shattered_savanna",
"shattered_savanna_plateau",
"small_end_islands",
"snowy_beach",
"snowy_mountains",
"snowy_taiga",
"snowy_taiga_hills",
"snowy_taiga_mountains",
"snowy_tundra",
"stone_shore",
"sunflower_plains",
"swamp",
"swamp_hills",
"taiga",
"taiga_hills",
"taiga_mountains",
"tall_birch_forest",
"tall_birch_hills",
"the_end",
"the_void",
"warm_ocean",
"wooded_badlands_plateau",
"wooded_hills",
"wooded_mountains"
]
},
"block": {
"title": "Block",
"description": "The block at the location.",
"type": "object",
"properties": {
"blocks": {
"title": "Blocks",
"description": "A list of block IDs.",
"type": "array"
},
"tag": {
"title": "Tag",
"description": "The block tag.",
"type": "string"
},
"nbt": {
"title": "NBT",
"description": "The block NBT.",
"type": "string"
},
"state": {
"title": "State",
"description": "A map of block property names to values. Test will fail if the block doesn't match.",
"type": "object",
"properties": {
"key": {
"title": "Key",
"description": "Block property key and value pair.",
"type": ["boolean", "integer", "string", "object"],
"$ref": "#/definitions/integerRange"
}
}
}
}
},
"dimension": {
"title": "Dimension",
"description": "The dimension the entity is currently in.",
"type": "string"
},
"feature": {
"title": "Feature",
"description": "Name of a structure.",
"type": "string",
"enum": [
"buried_treasure",
"desert_pyramid",
"endcity",
"fortress",
"igloo",
"jungle_pyramid",
"mansion",
"mineshaft",
"monument",
"ocean_ruin",
"pillager_outpost",
"shipwreck",
"stronghold",
"swamp_hut",
"village"
]
},
"fluid": {
"title": "Fluid",
"description": "The fluid at the location.",
"type": "object",
"properties": {
"fluid": {
"title": "Fluid",
"description": "The fluid ID.",
"type": "string"
},
"tag": {
"title": "Tag",
"description": "The fluid tag.",
"type": "string"
},
"state": {
"title": "State",
"description": "A map of fluid property names to values. Test will fail if the fluid doesn't match.",
"type": ["boolean", "integer", "string", "object"],
"$ref": "#/definitions/integerRange"
}
}
},
"light": {
"title": "Light",
"description": "The light at the location.",
"type": "object",
"properties": {
"light": {
"title": "Light",
"description": "The light Level of visible light. Calculated using: (max(sky-darkening,block)).",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
}
}
},
"position": {
"title": "Position",
"type": "object",
"properties": {
"x": {
"title": "X",
"description": "The X position.",
"$ref": "#/definitions/numberRange"
},
"y": {
"title": "Y",
"description": "The Y position.",
"$ref": "#/definitions/numberRange"
},
"z": {
"title": "Z",
"description": "The Z position.",
"$ref": "#/definitions/numberRange"
}
}
},
"smokey": {
"title": "Smokey",
"description": "True if the block is closely above a campfire or soul campfire.",
"type": "boolean"
}
}
},
"tagsCommonToAllEntities": {
"type": "object",
"properties": {
"distance": {
"title": "Distance",
"type": "object",
"properties": {
"absolute": {
"title": "Absolute",
"$ref": "#/definitions/numberRange"
},
"horizontal": {
"title": "Horizontal",
"$ref": "#/definitions/numberRange"
},
"x": {
"title": "X",
"$ref": "#/definitions/numberRange"
},
"y": {
"title": "Y",
"$ref": "#/definitions/numberRange"
},
"z": {
"title": "Z",
"$ref": "#/definitions/numberRange"
}
}
},
"effects": {
"title": "Effects",
"description": "A map of status effects.",
"additionalProperties": {
"title": "Effect",
"description": "A status effect with the key name being the status effect name.",
"type": "object",
"properties": {
"ambient": {
"title": "Ambient",
"description": "Whether the effect is from a beacon.",
"type": "boolean"
},
"amplifier": {
"title": "Amplifier",
"description": "The effect amplifier.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
},
"duration": {
"title": "Duration",
"description": "The effect duration in ticks.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
},
"visible": {
"title": "Visible",
"description": "Whether the effect has visible particles.",
"type": "boolean"
}
}
}
},
"equipment": {
"title": "Equipment",
"type": "object",
"properties": {
"mainhand": {
"title": "Mainhand",
"$ref": "#/definitions/tagsCommonToAllItems"
},
"offhand": {
"title": "Offhand",
"$ref": "#/definitions/tagsCommonToAllItems"
},
"head": {
"title": "Head",
"$ref": "#/definitions/tagsCommonToAllItems"
},
"chest": {
"title": "Chest",
"$ref": "#/definitions/tagsCommonToAllItems"
},
"legs": {
"title": "Legs",
"$ref": "#/definitions/tagsCommonToAllItems"
},
"feet": {
"title": "Feet",
"$ref": "#/definitions/tagsCommonToAllItems"
}
}
},
"flags": {
"title": "Flags",
"description": "Predicate Flags to be checked.",
"type": "object",
"properties": {
"is_on_fire": {
"title": "Is on Fire",
"description": "Test whether the entity is or is not on fire."
},
"is_sneaking": {
"title": "Is Sneaking",
"description": "Test whether the entity is or is not sneaking.",
"type": "boolean"
},
"is_sprinting": {
"title": "Is Sprinting",
"description": "Test whether the entity is or is not sprinting.",
"type": "boolean"
},
"is_swimming": {
"title": "Is Swimming",
"description": "Test whether the entity is or is not swimming.",
"type": "boolean"
},
"is_baby": {
"title": "Is Baby",
"description": "Test whether the entity is or is not a baby variant.",
"type": "boolean"
}
}
},
"lightning_bolt": {
"title": "Lightning Bolt",
"description": "Lightning bolt properties to be checked. Fails when entity is not a lightning bolt.",
"type": "object",
"properties": {
"blocks_set_on_fire": {
"title": "Blocks Set on Fire",
"description": "Number of blocks set on fire by this lightning bolt.",
"type": "integer"
},
"entity_struck": {
"title": "Entity Struck",
"description": "Entity properties of entities struck by this lightning bolt. If present, this tag must match one or more entities.",
"$ref": "#/definitions/tagsCommonToAllEntities"
}
}
},
"location": {
"title": "Location",
"$ref": "#/definitions/tagsCommonToAllLocations"
},
"nbt": {
"title": "NBT",
"description": "An NBT string.",
"type": "string"
},
"passenger": {
"title": "Passanger",
"description": "The entity directly riding this entity.",
"$ref": "#/definitions/tagsCommonToAllEntities"
},
"player": {
"title": "Player",
"description": "Player properties to be checked. Fails when entity is not a player.",
"type": "object",
"properties": {
"looking_at": {
"title": "Looking At",
"description": "The entity that the player is looking at, as long as it is visible and within a radius of 100 blocks.",
"$ref": "#/definitions/tagsCommonToAllEntities"
},
"advancements": {
"title": "Advancements",
"description": "A map of advancements to check.",
"type": "object",
"additionalProperties": {
"description": "An advancement ID.",
"type": ["boolean", "object"],
"additionalProperties": {
"type": "boolean"
}
}
},
"gamemode": {
"title": "Game Mode",
"description": "The game mode of the player.",
"type": "string",
"enum": ["survival", "adventure", "creative", "spectator"]
},
"level": {
"title": "Level",
"description": "The level of the player.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
},
"recipes": {
"title": "Recipies",
"description": "A map of recipies to check.",
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"stats": {
"title": "Stats",
"description": "List of statistics to match.",
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The statistic base.",
"type": "string",
"enum": [
"minecraft:custom",
"minecraft:crafted",
"minecraft:used",
"minecraft:broken",
"minecraft:mined",
"minecraft:killed",
"minecraft:picked_up",
"minecraft:dropped",
"minecraft:killed_by"
]
},
"stat": {
"title": "Stat",
"description": "The statistic ID. Mostly mimics the criteria used for defining scoreboard objectives.",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the statistic.",
"type": ["integer", "object"],
"$ref": "#/definitions/integerRange"
}
}
}
}
}
},
"stepping_on": {
"title": "Stepping On",
"description": "Location predicate for the block the entity is standing on.",
"$ref": "#/definitions/tagsCommonToAllLocations"
},
"team": {
"title": "Team",
"description": "The team the entity belongs to.",
"type": "string"
},
"type": {
"title": "Type",
"description": "An entity ID.",
"type": "string"
},
"targeted_entity": {
"title": "Targeted Entity",
"description": "The entity which this entity is targeting for attacks.",
"$ref": "#/definitions/tagsCommonToAllEntities"
},
"vehicle": {
"title": "Vehicle",
"description": " The vehicle that the entity is riding on.",
"$ref": "#/definitions/tagsCommonToAllEntities"
}
}
}
},
"description": "Configuration file defining a predicate for a data pack for Minecraft.",
"properties": {
"conditions": {
"title": "Conditions",
"description": "The condition's ID.",
"type": "string",
"enum": [
"minecraft:alternative",
"minecraft:block_state_property",
"minecraft:damage_source_properties",
"minecraft:entity_properties",
"minecraft:entity_scores",
"minecraft:inverted",
"minecraft:killed_by_player",
"minecraft:location_check",
"minecraft:match_tool",
"minecraft:random_chance",
"minecraft:random_chance_with_looting",
"minecraft:reference",
"minecraft:survives_explosion",
"minecraft:table_bonus",
"minecraft:time_check",
"minecraft:weather_check",
"minecraft:value_check"
]
}
},
"title": "Minecraft Data Pack Predicate",
"type": "object"
}
|
project-1.0.0-beta8.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
},
"emitEntryPoint": {
"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"]
},
"target": {
"type": "string",
"description": "Restrict this dependency to matching only a Project or a Package",
"enum": ["project", "package"]
}
}
}
},
"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-beta8.json",
"properties": {
"authors": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"packInclude": {
"description": "Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { \"tools/\": \"tools/**/*.*\" }",
"type": "object"
},
"publishExclude": {
"description": "Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["obj/**/*.*", "bin/**/*.*", "**/.*/**"]
},
"compile": {
"description": "Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**/*.cs"
},
"compileExclude": {
"description": "Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"compileFiles": {
"description": "Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"content": {
"description": "Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**/*"
},
"contentExclude": {
"description": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"contentFiles": {
"description": "Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"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": "Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["compiler/resources/**/*", "**/*.resx"]
},
"resourceExclude": {
"description": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"resourceFiles": {
"description": "Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"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": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"excludeBuiltIn": {
"description": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["bin/**", "obj/**", "**/*.xproj"]
},
"commands": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"configurations": {
"type": "object",
"description": "Configurations are named groups of compilation settings. There are two defaults built into the runtime: '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 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
},
"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": {
"description": "A space-delimited list of tags and keywords that describe the package.",
"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 project/package.",
"type": "string"
},
"frameworks": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configType"
}
},
"namedResource": {
"type": "object",
"description": "Overrides the generated resource names with custom ones.",
"additionalProperties": {
"type": "string"
}
},
"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"
}
},
"scripts": {
"type": "object",
"description": "Scripts to execute during the various stages.",
"properties": {
"prebuild": {
"$ref": "#/definitions/script"
},
"postbuild": {
"$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"
},
"webroot": {
"description": "Specifies the web server root for the application. In Visual Studio when running IIS this folder will be used as the root of the application. Static files should be put in here.",
"type": "string"
}
},
"title": "JSON schema for DNX project.json files",
"type": "object"
}
|
postcssrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"ConfigPlugin": {
"oneOf": [
{
"type": "object"
},
{
"enum": [false]
}
]
}
},
"id": "https://json.schemastore.org/postcssrc.json",
"properties": {
"parser": {
"description": "A special syntax parser (for example, SCSS).",
"oneOf": [
{
"type": "string"
},
{
"enum": [false]
}
]
},
"stringifier": {
"description": "A special syntax output generator (for example, Midas).",
"oneOf": [
{
"type": "string"
},
{
"enum": [false]
}
]
},
"syntax": {
"description": "An object providing a syntax parser and a stringifier.",
"oneOf": [
{
"type": "string"
},
{
"enum": [false]
}
]
},
"map": {
"description": "Source map options.",
"enum": [false, "absolute", "inline", "sourcesContent"]
},
"from": {
"description": "The input file name (most runners set it automatically).",
"type": "string"
},
"to": {
"description": "The output file name (most runners set it automatically).",
"type": "string"
},
"plugins": {
"oneOf": [
{
"description": "An array of plugins.",
"type": "array",
"items": {
"$ref": "#/definitions/ConfigPlugin"
}
},
{
"description": "An object of options.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ConfigPlugin"
}
}
]
}
},
"type": "object"
}
|
venvironment-basic-schema.json | {
"$id": "https://json.schemastore.org/venvironment-basic-schema.json",
"$ref": "#/definitions/137d/full",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"137d": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "venvironment-basic schema",
"type": "object",
"required": ["version"],
"oneOf": [
{
"allOf": [
{
"properties": {
"version": {
"const": "2.1.0"
}
}
},
{
"$ref": "#/definitions/c88d/full"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "2.0.0"
}
}
},
{
"$ref": "#/definitions/6a2b/full"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.1.0"
}
}
},
{
"$ref": "#/definitions/c49d/full"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.0.0"
}
}
},
{
"$ref": "#/definitions/7e31/full"
}
]
}
]
}
},
"c88d": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "venvironment-basic schema",
"type": "object",
"additionalProperties": false,
"required": ["version"],
"properties": {
"version": {
"$ref": "#/definitions/be66/full"
},
"includes": {
"$ref": "#/definitions/8549/full"
},
"global-settings": {
"$ref": "#/definitions/11d8/full"
},
"system-variables": {
"$ref": "#/definitions/ae22/full"
},
"datasources": {
"$ref": "#/definitions/f858/full"
},
"user-files": {
"$ref": "#/definitions/3492/full"
},
"functional-mockup-units": {
"$ref": "#/definitions/1c0e/full"
},
"sil-kit": {
"$ref": "#/definitions/1ce7/full"
},
"logging": {
"$ref": "#/definitions/b245/full"
}
}
}
},
"6a2b": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "venvironment-basic schema",
"type": "object",
"additionalProperties": false,
"required": ["version"],
"properties": {
"version": {
"$ref": "#/definitions/380d/full"
},
"global-settings": {
"$ref": "#/definitions/9af4/full"
},
"includes": {
"$ref": "#/definitions/8549/full"
},
"datasources": {
"$ref": "#/definitions/f858/full"
},
"functional-mockup-units": {
"$ref": "#/definitions/1c0e/full"
},
"sil-kit": {
"$ref": "#/definitions/1ce7/full"
},
"system-variables": {
"$ref": "#/definitions/ae22/full"
},
"logging": {
"$ref": "#/definitions/b245/full"
}
}
}
},
"c49d": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "venvironment-basic schema",
"type": "object",
"additionalProperties": false,
"required": ["version"],
"properties": {
"version": {
"$ref": "#/definitions/6141/full"
},
"includes": {
"$ref": "#/definitions/8549/full"
},
"datasources": {
"$ref": "#/definitions/f858/full"
},
"functional-mockup-units": {
"$ref": "#/definitions/c1ef/full"
},
"sil-kit": {
"$ref": "#/definitions/a13a/full"
},
"system-variables": {
"$ref": "#/definitions/ae22/full"
},
"logging": {
"$ref": "#/definitions/5a4c/full"
}
}
}
},
"7e31": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "venvironment-basic schema",
"type": "object",
"additionalProperties": false,
"required": ["version"],
"properties": {
"version": {
"$ref": "#/definitions/ac6e/full"
},
"includes": {
"$ref": "#/definitions/6c39/full"
},
"datasources": {
"$ref": "#/definitions/f858/full"
},
"system-variables": {
"$ref": "#/definitions/ae22/full"
}
}
}
},
"be66": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Version",
"description": "Json schema version for the vEnvironment-Basic configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.",
"const": "2.1.0",
"type": "string",
"examples": ["2.1.0"]
}
},
"8549": {
"local": {
"one": {
"type": "string",
"pattern": "\\.([Yy][Aa]?[Mm][Ll]|[Jj][Ss][Oo][Nn])$"
}
},
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Include files",
"description": "Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.",
"oneOf": [
{
"$ref": "#/definitions/8549/local/one"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/8549/local/one"
}
}
],
"examples": [
"my_include.yaml",
["my_include.yml", "my_other_include.json"]
]
}
},
"11d8": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Global Settings",
"description": "Global settings for all scenarios.",
"type": "object",
"additionalProperties": false,
"properties": {
"time-source": {
"description": "Time source for the simulation. Operate without hardware and simulate all buses completely. \n'internal-realtime': The time response of the measurement (time basis) is controlled internally. \n'external-software': The time response of the measurement (time basis) is controlled by an external program.",
"default": "internal-realtime",
"anyOf": [
{
"enum": ["internal-realtime", "external-software"]
}
],
"examples": ["internal-realtime", "external-software"]
}
},
"examples": [
{
"time-source": "internal-realtime"
}
]
}
},
"ae22": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "System Variables",
"description": "A lists of system variables to be used by the simulation.",
"type": "array",
"items": {
"$ref": "#/definitions/8c98/full"
},
"examples": [
[
{
"file-path": "path/to/my.vsysvar"
}
]
]
}
},
"f858": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Datasources",
"description": "The definition of datasources used by application models.",
"type": "object",
"additionalProperties": false,
"properties": {
"input-files": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["file-path"],
"properties": {
"file-path": {
"$ref": "#/definitions/c269/full"
}
}
}
}
},
"examples": [
{
"input-files": [
{
"file-path": "path/to/my.vcdl"
}
]
}
]
}
},
"3492": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "User Files",
"description": "List of user files.",
"type": "array",
"items": {
"$ref": "#/definitions/07a1/full"
},
"examples": [
[
{
"file-path": "path/to/my.txt"
}
]
]
}
},
"1c0e": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Functional mockup units",
"description": "List of functional mockup units.",
"type": "array",
"items": {
"$ref": "#/definitions/bad4/full"
},
"examples": [
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001
}
],
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001,
"debug-output": true
}
],
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001,
"debug-output": false,
"active-model-variables": ["Variable1", "Variable2"]
}
],
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001,
"debug-output": false,
"inactive-model-variables": ["Variable3"]
}
]
]
}
},
"1ce7": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "SIL Kit",
"description": "SIL Kit settings.",
"type": "object",
"additionalProperties": false,
"required": ["participant-name"],
"properties": {
"registry-uri": {
"description": "The URI of the registry.",
"type": "string",
"anyOf": [
{
"pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?",
"default": "silkit://localhost:8500"
}
],
"examples": ["silkit://localhost:8500"]
},
"participant-name": {
"description": "Name used by the simulation tool to join a simulation as a participant at the start of a measurement.",
"anyOf": [
{
"type": "string"
}
],
"examples": ["CANoe4SW-SE"]
},
"config-file-path": {
"$ref": "#/definitions/0a5c/full"
},
"simulation-step-in-micro-sec": {
"description": "Time length of a single simulation step. Valid only for the time-source \"external-software\".",
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9223372036854775,
"default": 100
}
]
},
"life-cycle-event-timeout-in-sec": {
"description": "Maximum waiting time for the other simulation participants. Valid only for the time-source \"external-software\".",
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9223372036,
"default": 30
}
]
}
},
"examples": [
{
"participant-name": "CANoe4SW-SE"
},
{
"registry-uri": "silkit://localhost:8500",
"participant-name": "CANoe4SW-SE",
"config-file-path": "path/to/config-file.json"
},
{
"registry-uri": "silkit://localhost:8500",
"participant-name": "CANoe4SW-SE",
"config-file-path": "path/to/config-file.json",
"simulation-step-in-micro-sec": 150
},
{
"registry-uri": "silkit://localhost:8500",
"participant-name": "CANoe4SW-SE",
"config-file-path": "path/to/config-file.json",
"simulation-step-in-micro-sec": 150,
"life-cycle-event-timeout-in-sec": 30
}
]
}
},
"b245": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Logging Block",
"description": "Configuration of the logging for the environment.",
"type": "object",
"additionalProperties": false,
"required": ["file-name"],
"properties": {
"file-name": {
"$ref": "#/definitions/b8ec/full"
},
"logging-events": {
"type": "array",
"default": [
"application-layer",
"bus",
"diagnostic",
"internal",
"statistic",
"system-variable",
"test"
],
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"application-layer",
"bus",
"diagnostic",
"internal",
"statistic",
"system-variable",
"test"
]
}
]
}
},
"advanced": {
"$ref": "#/definitions/17c8/full"
}
},
"examples": []
}
},
"380d": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Version",
"description": "Json schema version for the vEnvironment-Basic configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.",
"const": "2.0.0",
"type": "string",
"examples": ["2.0.0"]
}
},
"9af4": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Global Settings",
"description": "Global settings for all scenarios.",
"type": "object",
"additionalProperties": false,
"properties": {
"time-source": {
"description": "Time source for the simulation. Operate without hardware and simulate all buses completely. \n'internal-realtime': The time response of the measurement (time basis) is controlled internally. \n'external-software': The time response of the measurement (time basis) is controlled by an external program.",
"default": "internal-realtime",
"anyOf": [
{
"type": "string",
"enum": ["internal-realtime", "external-software"]
}
],
"examples": ["internal-realtime", "external-software"]
}
},
"examples": [
{
"time-source": "internal-realtime"
}
]
}
},
"6141": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Version",
"description": "Json schema version for the vEnvironment-Basic configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.",
"const": "1.1.0",
"type": "string",
"examples": ["1.1.0"]
}
},
"c1ef": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Functional mockup units",
"description": "List of functional mockup units.",
"type": "array",
"items": {
"$ref": "#/definitions/d00c/full"
},
"examples": [
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001
}
],
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001,
"debug-output": true
}
],
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001,
"debug-output": false,
"active-model-variables": ["Variable1", "Variable2"]
}
],
[
{
"file-path": "path/to/some.fmu",
"stepsize-in-sec": 0.001,
"debug-output": false,
"inactive-model-variables": ["Variable3"]
}
]
]
}
},
"a13a": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "SIL Kit",
"description": "SIL Kit settings.",
"type": "object",
"additionalProperties": false,
"required": ["participant-name"],
"properties": {
"registry-uri": {
"description": "registry URI",
"type": "string",
"anyOf": [
{
"pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?"
}
],
"examples": ["silkit://localhost:8500"]
},
"participant-name": {
"description": "Name used by CANoe4SW to join a simulation as a participant at the start of a measurement.",
"anyOf": [
{
"type": "string"
}
],
"examples": ["CANoe4SW"]
},
"config-file-path": {
"$ref": "#/definitions/0a5c/full"
}
},
"examples": [
{
"registry-uri": "silkit://localhost:8500",
"participant-name": "CANoe4SW",
"config-file-path": "path/to/config-file.json"
}
]
}
},
"5a4c": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Logging Block",
"description": "Configuration of the standalone logging block.",
"type": "object",
"additionalProperties": false,
"required": ["file-name"],
"properties": {
"file-name": {
"$ref": "#/definitions/b8ec/full"
},
"logging-events": {
"type": "array",
"default": [
"bus",
"diagnostic",
"internal",
"statistic",
"system-variable",
"test"
],
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"bus",
"diagnostic",
"internal",
"statistic",
"system-variable",
"test"
]
}
]
}
},
"advanced": {
"$ref": "#/definitions/cb82/full"
}
},
"examples": []
}
},
"ac6e": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Version",
"description": "Json schema version for the vEnvironment-Basic configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.",
"const": "1.0.0",
"type": "string",
"examples": ["1.0.0"]
}
},
"6c39": {
"local": {
"one": {
"type": "string",
"pattern": "\\.([Yy][Aa][Mm][Ll]|[Jj][Ss][Oo][Nn])$"
}
},
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Include files",
"description": "Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.",
"oneOf": [
{
"$ref": "#/definitions/6c39/local/one"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/6c39/local/one"
}
}
],
"examples": [
"my_include.yaml",
["my_include.yaml", "my_other_include.json"]
]
}
},
"8c98": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "System variables",
"description": "Absolute or relative path to an external file containing system variables. Relative path specifications are resolved relative to the defining configuration file.",
"type": "object",
"additionalProperties": false,
"required": ["file-path"],
"properties": {
"file-path": {
"anyOf": [
{
"$ref": "#/definitions/9475/full"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/9475/full"
}
}
]
}
},
"examples": [
{
"file-path": "path/to/my.vsysvar"
}
]
}
},
"c269": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"anyOf": [
{
"$ref": "#/definitions/1440/full"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/1440/full"
},
"examples": [["path/to/my.vcdl"], ["path/to/my.vcodm"]]
}
],
"examples": ["path/to/my.vcdl", ["path/to/my.vcodm"]]
}
},
"07a1": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "User files",
"description": "Absolute or relative path to user files that can be read/written by CAPL/.NET Scripts. Relative path specifications are resolved relative to the defining configuration file.",
"type": "object",
"additionalProperties": false,
"required": ["file-path"],
"properties": {
"file-path": {
"anyOf": [
{
"type": "string",
"examples": ["path/to/my.txt"]
},
{
"type": "array",
"items": {
"type": "string"
},
"examples": [["path/to/my.txt"]]
}
]
}
},
"examples": [
{
"file-path": "path/to/my.txt"
},
{
"file-path": "path/to/my_file.ini"
}
]
}
},
"bad4": {
"local": {
"stepsize-in-sec": {
"description": "Step size in seconds.",
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 10000
}
],
"examples": [0, 0.0005, 10000]
},
"debug-output": {
"description": "Is the debug output active.",
"anyOf": [
{
"type": "boolean",
"default": false
}
],
"examples": [false, true]
},
"active-model-variables": {
"description": "List of the FMU variables which should be exported",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
],
"examples": ["Variable1"]
}
},
"inactive-model-variables": {
"description": "List of the FMU variables which should be excluded from the export",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
],
"examples": ["Variable1"]
}
}
},
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Functional mockup unit",
"description": "Represents a functional mockup unit used in a scenario.",
"type": "object",
"anyOf": [
{
"additionalProperties": false,
"required": ["file-path", "stepsize-in-sec"],
"properties": {
"file-path": {
"$ref": "#/definitions/503b/full"
},
"stepsize-in-sec": {
"$ref": "#/definitions/bad4/local/stepsize-in-sec"
},
"debug-output": {
"$ref": "#/definitions/bad4/local/debug-output"
}
}
},
{
"additionalProperties": false,
"required": [
"file-path",
"stepsize-in-sec",
"active-model-variables"
],
"properties": {
"file-path": {
"$ref": "#/definitions/503b/full"
},
"stepsize-in-sec": {
"$ref": "#/definitions/bad4/local/stepsize-in-sec"
},
"debug-output": {
"$ref": "#/definitions/bad4/local/debug-output"
},
"active-model-variables": {
"$ref": "#/definitions/bad4/local/active-model-variables"
}
}
},
{
"additionalProperties": false,
"required": [
"file-path",
"stepsize-in-sec",
"inactive-model-variables"
],
"properties": {
"file-path": {
"$ref": "#/definitions/503b/full"
},
"stepsize-in-sec": {
"$ref": "#/definitions/bad4/local/stepsize-in-sec"
},
"debug-output": {
"$ref": "#/definitions/bad4/local/debug-output"
},
"inactive-model-variables": {
"$ref": "#/definitions/bad4/local/inactive-model-variables"
}
}
}
]
}
},
"0a5c": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Absolute or relative path to a SIL Kit config file (.yaml or .json). Relative path specifications are resolved relative to the configuration file.",
"type": "string",
"anyOf": [
{
"pattern": "^.*\\.[yY][aA][mM][lL]$"
},
{
"pattern": "^.*\\.[jJ][sS][oO][nN]$"
}
],
"examples": ["path/to/myConfigFile.json", "path/to/myConfigFile.yaml"]
}
},
"b8ec": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Name of a blf file, supporting the field codes: {ComputerName}, {LocalTime}, {MeasurementIndex}, {MeasurementStart}, {IncSize|001|100MB} and {IncTime|001|01h00m}.",
"type": "string",
"anyOf": [
{
"pattern": "^(?!.*(\\{TriggerCondition\\}|\\{LoggingBlock\\}|\\{IncMeasurement\\}|\\{ConfigName\\}|\\{IncTrigger\\|[0-9]*\\}|[\"<>*?:/\\\\])).*\\.[bB][lL][fF]$"
}
],
"$comment": "|<|>",
"examples": [
"fileName.blf",
"log_{ComputerName}.blf",
"log_{LocalTime}.blf",
"log_{MeasurementIndex}.blf",
"log_{MeasurementStart}.blf"
]
}
},
"17c8": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Advanced logging configurations.",
"type": "object",
"additionalProperties": false,
"properties": {
"warn-overwritten-log-file": {
"anyOf": [
{
"type": "boolean"
}
],
"default": true
},
"show-error-on-data-loss": {
"anyOf": [
{
"type": "boolean"
}
],
"default": true
}
},
"examples": [
{
"warn-overwritten-log-file": false,
"show-error-on-data-loss": true
},
{
"warn-overwritten-log-file": true
}
]
}
},
"d00c": {
"local": {
"stepsize-in-sec": {
"description": "step size in seconds",
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1.79769e308
}
],
"examples": [0, 0.0005, 1568714585]
},
"debug-output": {
"description": "Are the debug outputs on",
"anyOf": [
{
"type": "boolean",
"default": false
}
],
"examples": [false, true]
},
"active-model-variables": {
"description": "List of the FMU variables which should be exported",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
],
"examples": ["Variable1"]
}
},
"inactive-model-variables": {
"description": "List of the FMU variables which should be excluded from the export",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
],
"examples": ["Variable1"]
}
}
},
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Functional mockup unit",
"description": "Represents a functional mockup unit used in a scenario",
"type": "object",
"anyOf": [
{
"additionalProperties": false,
"required": ["file-path", "stepsize-in-sec"],
"properties": {
"file-path": {
"$ref": "#/definitions/503b/full"
},
"stepsize-in-sec": {
"$ref": "#/definitions/d00c/local/stepsize-in-sec"
},
"debug-output": {
"$ref": "#/definitions/d00c/local/debug-output"
}
}
},
{
"additionalProperties": false,
"required": [
"file-path",
"stepsize-in-sec",
"active-model-variables"
],
"properties": {
"file-path": {
"$ref": "#/definitions/503b/full"
},
"stepsize-in-sec": {
"$ref": "#/definitions/d00c/local/stepsize-in-sec"
},
"debug-output": {
"$ref": "#/definitions/d00c/local/debug-output"
},
"active-model-variables": {
"$ref": "#/definitions/d00c/local/active-model-variables"
}
}
},
{
"additionalProperties": false,
"required": [
"file-path",
"stepsize-in-sec",
"inactive-model-variables"
],
"properties": {
"file-path": {
"$ref": "#/definitions/503b/full"
},
"stepsize-in-sec": {
"$ref": "#/definitions/d00c/local/stepsize-in-sec"
},
"debug-output": {
"$ref": "#/definitions/d00c/local/debug-output"
},
"inactive-model-variables": {
"$ref": "#/definitions/d00c/local/inactive-model-variables"
}
}
}
]
}
},
"cb82": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Advanced logging configurations",
"type": "object",
"additionalProperties": false,
"properties": {
"warn-overwritten-log-file": {
"anyOf": [
{
"type": "boolean"
}
],
"default": true
},
"show-error-on-data-loss": {
"anyOf": [
{
"type": "boolean"
}
],
"default": true
}
},
"examples": [
{
"warn-overwritten-log-file": false,
"show-error-on-data-loss": true
},
{
"warn-overwritten-log-file": true
}
]
}
},
"9475": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Absolute or relative path to a vsysvar file. Relative path specifications are resolved relative to the configuration file.",
"type": "string",
"anyOf": [
{
"pattern": "^.*\\.[vV][sS][yY][sS][vV][aA][rR]$"
}
],
"examples": ["path/to/my.vsysvar"]
}
},
"1440": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Reference to external datasource files (.vcdl/.vcodm). Absolute or relative path. Relative path specifications are resolved relative to the defining configuration file.",
"type": "string",
"anyOf": [
{
"pattern": "^.*\\.[vV][cC][dD][lL]$"
},
{
"pattern": "^.*\\.[vV][cC][oO][dD][mM]$"
}
],
"examples": ["path/to/my.vcdl", "path/to/my.vcodm"]
}
},
"503b": {
"full": {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Absolute or relative path to a source file of a functional mockup unit (.fmu). Relative path specifications are resolved relative to the defining configuration file.",
"type": "string",
"anyOf": [
{
"pattern": "^.*\\.[Ff][Mm][Uu]$"
}
],
"examples": ["my_functional_mockup_unit.fmu", "Inputs/MyFmu.FMU"]
}
}
},
"title": "venvironment-basic schema",
"type": "object"
}
|
meta-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://dwp.gov.uk/exchange/publishing-tools/apigw/meta-schema.json",
"title": "Meta",
"type": "object",
"properties": {
"workspace": {
"$id": "#root/workspace",
"title": "Workspace",
"type": "string",
"minLength": 2,
"maxLength": 60,
"examples": [
"integration"
],
"pattern": "^(?!-)[a-zA-Z0-9./_-]*$"
},
"product_name": {
"$id": "#root/product_name",
"title": "Product name",
"type": "string",
"minLength": 2,
"maxLength": 60,
"examples": [
"NHS Charge Exemption"
],
"pattern": "^(?!-\\s)[a-zA-Z0-9\\s._-]+$"
},
"product_id": {
"$id": "#root/product_id",
"title": "Product ID",
"type": "string",
"format": "uuid"
},
"authentication_proxy": {
"$id": "#root/authentication_proxy",
"title": "Authentication proxy",
"type": "boolean",
"examples": [
"true"
]
},
"workspace_gitlab_groups": {
"$id": "#root/workspace_gitlab_groups",
"title": "GitLab groups for workspace",
"type": "array",
"items": {
"type": "string",
"examples": [
"@dwp/team-name"
]
}
},
"product_gitlab_groups": {
"$id": "#root/product_gitlab_groups",
"title": "GitLab groups for product name",
"type": "array",
"items": {
"type": "string",
"examples": [
"@dwp/team-name"
]
}
}
},
"additionalProperties": false,
"required": [
"workspace"
],
"anyOf": [
{
"required": [
"product_name"
]
},
{
"required": [
"workspace_gitlab_groups"
]
}
],
"dependencies": {
"product_gitlab_groups": [
"product_name"
],
"product_name": [
"product_id"
]
}
}
|
es6importsorterrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://json.schemastore.org/base-04.json",
"properties": {
"sourcePrefixes": {
"description": "The prefixes of your source imports. Ex: import sth from '@data' => '@' can considered as a sourcePrefix",
"type": "array",
"items": {
"type": "string"
}
},
"sectionPrefix": {
"description": "The prefix of your section title",
"type": "string"
},
"sectionNames": {
"description": "The names (which comes right after 'sectionPrefix') of your section title",
"type": "array",
"items": {
"type": "string"
}
},
"startImportBlockSign": {
"description": "The sign to mark the start of import block. Default is '' - the start of the file",
"default": "",
"type": "string"
},
"endImportBlockSign": {
"description": "The sign to mark the end of import block. Default is '' - the first empty line",
"default": "",
"type": "string"
},
"statementTerminator": {
"description": "The sign to mark the end of an import statement. Default is ';'",
"default": ";",
"type": "string"
},
"preCommands": {
"description": "The command list run before sorting",
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"description": "string value means terminal command"
},
{
"type": "object",
"description": "Define command with vscode command option",
"properties": {
"command": {
"type": "string",
"description": "the command you need to execute before sorting. It can be terminal command or vscode command",
"minLength": 1
},
"system": {
"description": "Define the system will execute the command",
"default": "terminal",
"oneOf": [
{
"enum": ["vscode"],
"description": "Command will be executed as vscode command"
},
{
"enum": ["terminal"],
"description": "Command will be executed as terminal command"
}
]
}
},
"additionalProperties": false,
"required": ["command"]
}
]
}
}
},
"title": "JSON schema for ES6 Import Sorter",
"type": "object"
}
|
grunt-clean-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"
}
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"definitions": {
"options": {
"description": "Set the options for grunt-contrib-copy",
"type": "object",
"properties": {
"force": {
"description": "This overrides this task from blocking deletion of folders outside current working dir (CWD). Use with caution.",
"type": "boolean",
"default": false
},
"no-write": {
"description": "Will log messages of what would happen if the task was ran but doesn't actually delete the files.",
"type": "boolean",
"default": false
}
}
}
},
"id": "https://json.schemastore.org/grunt-clean-task.json",
"properties": {
"options": {
"$ref": "#/definitions/options"
}
},
"title": "JSON schema for the Grunt clean task",
"type": "object"
}
|
cryproj.52.schema.json | {
"$comment": "JSON Schema for CRYENGINE 5.2",
"$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_BigBrushCheckLimitSize",
"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_DebugBehaviorSelection",
"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_DynamicVolumeUpdateTime",
"ai_DynamicWaypointUpdateTime",
"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_IncludeNonColEntitiesInNavigation",
"ai_InterestSystem",
"ai_InterestSystemCastRays",
"ai_IntersectionTesterQuota",
"ai_IslandConnectionsSystemProfileMemory",
"ai_LayerSwitchDynamicLinkBump",
"ai_LayerSwitchDynamicLinkBumpDuration",
"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_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_RadiusForAutoForbidden",
"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_ShowNavAreas",
"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_initClientActor",
"cl_nickname",
"cl_packetRate",
"cl_serveraddr",
"cl_serverpassword",
"cl_serverport",
"cl_tokenid",
"cl_useCurrentUserNameAsDefault",
"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",
"CV_r_AntialiasingModeEditor",
"cvDoVerboseWindowTitle",
"d3d11_CBUpdateStats",
"d3d11_debugBreakOnce",
"d3d11_debugBreakOnMsgID",
"d3d11_debugMuteMsgID",
"d3d11_debugMuteSeverity",
"d3d11_debugruntime",
"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_dialogAudio",
"drs_dialogBinaryFileFormat",
"drs_dialogEntityRtpcName",
"drs_dialogGlobalRtpcName",
"drs_dialogsDefaultTalkAnimation",
"drs_dialogsLipsyncAnimationLayer",
"drs_dialogsLipsyncTransitionTime",
"drs_dialogsSamePriorityCancels",
"drs_dialogSubtitles",
"drs_fileFormat",
"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_DissolveDistband",
"e_DissolveDistMax",
"e_DissolveDistMin",
"e_DissolveSpriteDistRatio",
"e_DissolveSpriteMinDist",
"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_GsmViewSpace",
"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_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_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_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_sketch_mode",
"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_svoMaxAreaSize",
"e_svoMaxBricksOnCPU",
"e_svoMaxBrickUpdates",
"e_svoMaxNodeSize",
"e_svoMaxStreamRequests",
"e_svoMinNodeSize",
"e_svoRender",
"e_svoTI_Active",
"e_svoTI_AnalyticalGI",
"e_svoTI_AnalyticalOccluders",
"e_svoTI_AnalyticalOccludersRange",
"e_svoTI_AnalyticalOccludersSoftness",
"e_svoTI_Apply",
"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_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_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_svoVoxDistRatio",
"e_svoVoxelPoolResolution",
"e_svoVoxGenRes",
"e_svoVoxNodeRatio",
"e_Terrain",
"e_TerrainBBoxes",
"e_TerrainDeformations",
"e_TerrainDetailMaterials",
"e_TerrainDetailMaterialsDebug",
"e_TerrainDetailMaterialsViewDistXY",
"e_TerrainDetailMaterialsViewDistZ",
"e_TerrainDrawThisSectorOnly",
"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_texeldensity",
"e_TimeOfDay",
"e_TimeOfDayDebug",
"e_TimeOfDaySpeed",
"e_UseConsoleMtl",
"e_Vegetation",
"e_VegetationBending",
"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_backgroundUpdatePeriod",
"ed_highlightGeometry",
"ed_indexfiles",
"ed_keepEditorActive",
"ed_killmemory_size",
"ed_logFileChanges",
"ed_lowercasepaths",
"ed_MissingAssetResolver",
"ed_PhysToolHitExplPress0",
"ed_PhysToolHitExplPress1",
"ed_PhysToolHitExplR",
"ed_PhysToolHitProjMass",
"ed_PhysToolHitProjVel0",
"ed_PhysToolHitProjVel1",
"ed_PhysToolHitVelMax",
"ed_PhysToolHitVelMin",
"ed_popupMissingAssetResolver",
"ed_showErrorDialogOnLoad",
"ed_showFrozenHelpers",
"ed_useDevManager",
"es_activateEntity",
"es_bboxes",
"es_CharZOffsetSpeed",
"es_deactivateEntity",
"es_DebrisLifetimeScale",
"es_debug",
"es_debug_not_seen_timeout",
"es_debugDrawEntityIDs",
"es_debugEntityLifetime",
"es_DebugEntityUsage",
"es_DebugEntityUsageFilter",
"es_DebugEvents",
"es_DebugFindEntity",
"es_DebugTimers",
"es_DisableTriggers",
"es_DrawAreaDebug",
"es_DrawAreaGrid",
"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_updateType",
"es_UsePhysVisibilityChecks",
"es_VisCheckForUpdate",
"ExitOnQuit",
"fe_fbx_savetempfile",
"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_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_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",
"gamezero_cam_fov",
"gamezero_controller_sensitivity",
"gamezero_mouse_sensitivity",
"gamezero_pl_boostMultiplier",
"gamezero_pl_movementSpeed",
"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_driver",
"hmd_dynamic_prediction",
"hmd_info",
"hmd_ipd",
"hmd_low_persistence",
"hmd_perf_hud",
"hmd_post_inject_camera",
"hmd_projection",
"hmd_projection_screen_dist",
"hmd_quad_absolute",
"hmd_quad_distance",
"hmd_quad_width",
"hmd_queue_ahead",
"hmd_reference_point",
"hmd_social_screen",
"hmd_social_screen_keep_aspect",
"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",
"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_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_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_AntialiasingModeSCull",
"r_AntialiasingTAAFalloffHiFreq",
"r_AntialiasingTAAFalloffLowFreq",
"r_AntialiasingTAAPattern",
"r_AntialiasingTAASharpening",
"r_ArmourPulseSpeedMultiplier",
"r_auxGeom",
"r_Batching",
"r_BatchType",
"r_Beams",
"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_CloudsDebug",
"r_CloudsUpdateAlways",
"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_ConsoleBackbufferHeight",
"r_ConsoleBackbufferWidth",
"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_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_ImposterRatio",
"r_ImpostersDraw",
"r_ImpostersUpdatePerFrame",
"r_LightsSinglePass",
"r_Log",
"r_LogShaders",
"r_LogTexStreaming",
"r_LogVBuffers",
"r_LogVidMem",
"r_MaterialsBatching",
"r_MaxSuitPulseSpeedMultiplier",
"r_MeasureOverdraw",
"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_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_ShadowBlur",
"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_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_TexturesStreamingResidencyEnabled",
"r_TexturesStreamingResidencyThrottle",
"r_TexturesStreamingResidencyTime",
"r_TexturesStreamingResidencyTimeTestLimit",
"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_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_AudioPrimaryPoolSize",
"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_OcclusionRayLengthOffset",
"s_PositionUpdateThreshold",
"s_SDLMixerPrimaryPoolSize",
"s_SDLMixerStandaloneFileExtension",
"s_ShowActiveAudioObjectsOnly",
"s_TickWithMainThread",
"s_VelocityTrackingThreshold",
"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_forceGlobalInSWForNewAI",
"sw_gridSize",
"sys_affinity",
"sys_AI",
"sys_asserts",
"sys_audio_disable",
"sys_bp_frames",
"sys_bp_frames_threshold",
"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_DeactivateConsole",
"sys_debug_plugins",
"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_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_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_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_version",
"sys_vr_support",
"sys_vtune",
"sys_warnings",
"sys_WER",
"t_Debug",
"t_FixedStep",
"t_MaxStep",
"t_Scale",
"t_Smoothing",
"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",
"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_goto",
"ed_killmemory",
"ed_randomize_variations",
"eqp_DumpPacks",
"es_AudioListenerOffset",
"es_compile_area_grid",
"es_debugAnim",
"es_dump_entities",
"es_dump_entity_classes_in_use",
"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",
"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",
"quit",
"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",
"Screenshot",
"so_reload",
"status",
"stopdemo",
"stoprecording",
"sw",
"sys_crashtest",
"sys_crashtest_thread",
"sys_job_system_dump_job_list",
"sys_LvlRes_finalstep",
"sys_LvlRes_findunused",
"sys_reload_plugin",
"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.52.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.2"]
},
"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"
}
|
bitbucket-pipelines.schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://bitbucket.org/pipelines.json",
"definitions": {
"image_name": {
"type": "string",
"description": "Name of the Docker image which may or may not include registry URL, tag, and digest value",
"default": "atlassian/default-image:latest",
"minLength": 1
},
"run_as_user": {
"type": "number",
"description": "Overrides image's default user, specified user UID must be an existing user in the image with a valid home directory"
},
"complex_image": {
"type": "object",
"oneOf": [
{
"properties": {
"name": {
"$ref": "#/definitions/image_name"
},
"run-as-user": {
"$ref": "#/definitions/run_as_user"
}
},
"required": [
"name"
],
"additionalProperties": false
},
{
"properties": {
"name": {
"$ref": "#/definitions/image_name"
},
"run-as-user": {
"$ref": "#/definitions/run_as_user"
},
"username": {
"type": "string",
"description": "Username to use to fetch the Docker image",
"minLength": 1
},
"password": {
"type": "string",
"description": "Password to use to fetch the Docker image",
"minLength": 1
},
"email": {
"type": "string",
"description": "Email to use to fetch the Docker image",
"minLength": 1
}
},
"required": [
"name",
"username",
"password"
],
"additionalProperties": false
},
{
"properties": {
"name": {
"$ref": "#/definitions/image_name"
},
"run-as-user": {
"$ref": "#/definitions/run_as_user"
},
"aws": {
"type": "object",
"oneOf": [
{
"properties": {
"access-key": {
"type": "string",
"description": "AWS access key for Amazon Elastic Container Registry (AWS ECR)",
"minLength": 1
},
"secret-key": {
"type": "string",
"description": "AWS secret key for Amazon Elastic Container Registry (AWS ECR)",
"minLength": 1
}
},
"required": [
"access-key",
"secret-key"
],
"additionalProperties": false
},
{
"properties": {
"oidc-role": {
"type": "string",
"description": "Provides Pipeline with access to private Docker images hosted in an Amazon Elastic Container Registry (AWS ECR)",
"minLength": 1
}
},
"required": [
"oidc-role"
],
"additionalProperties": false
}
]
}
},
"required": [
"aws",
"name"
],
"additionalProperties": false
}
]
},
"image": {
"oneOf": [
{
"$ref": "#/definitions/image_name"
},
{
"$ref": "#/definitions/complex_image"
}
]
},
"max_time": {
"type": "number",
"description": "Maximum amount of minutes a step can execute",
"exclusiveMinimum": 0,
"maximum": 120,
"default": 120
},
"size": {
"type": "string",
"description": "Multiplier of the resources allocated to a pipeline step",
"enum": [
"1x",
"2x"
],
"default": "1x"
},
"clone_properties": {
"type": "object",
"description": "Contains settings to clone the repository into a container",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enables cloning of the repository before a step in a pipeline",
"default": true
},
"lfs": {
"type": "boolean",
"description": "Enables the download of LFS files in the clone (supported only for Git repositories)",
"default": false
},
"depth": {
"description": "Depth of Git clone (supported only for Git repositories)",
"oneOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"const": "full"
}
],
"default": 50
},
"skip-ssl-verify": {
"type": "boolean",
"description": "Disables SSL verification during git clone, allowing the use of self-signed certificates",
"default": false
}
}
},
"artifact_list": {
"type": "array",
"description": "Files produced by a step to share with a following step",
"items": {
"type": "string",
"description": "Glob pattern for the path to the artifacts"
},
"minItems": 1
},
"complex_artifacts": {
"type": "object",
"properties": {
"download": {
"type": "boolean",
"description": "Enables downloading of all available artifacts at the start of a step",
"default": true
},
"paths": {
"$ref": "#/definitions/artifact_list"
}
}
},
"fail_fast": {
"type": "boolean"
},
"runner_label": {
"type": "string",
"description": "Any label assigned to a self-hosted repository or workspace Pipeline runner",
"minLength": 1,
"maxLength": 50
},
"trigger": {
"type": "string",
"enum": [
"automatic",
"manual"
],
"default": "automatic"
},
"condition": {
"type": "object",
"properties": {
"changesets": {
"type": "object",
"description": "Condition on the changesets involved in a pipeline",
"properties": {
"includePaths": {
"type": "array",
"description": "Condition which holds only if any of the modified files match any of the defined patterns",
"items": {
"type": "string",
"description": "Glob pattern to match the file path",
"minLength": 1
},
"minItems": 1
}
},
"required": [
"includePaths"
],
"additionalProperties": false
}
},
"required": [
"changesets"
],
"additionalProperties": false
},
"step": {
"type": "object",
"properties": {
"step": {
"type": "object",
"description": "Build execution unit",
"properties": {
"after-script": {
"$ref": "#/definitions/script",
"description": "Commands to execute after the step succeeds or fails"
},
"artifacts": {
"anyOf": [
{
"$ref": "#/definitions/artifact_list"
},
{
"$ref": "#/definitions/complex_artifacts"
}
]
},
"caches": {
"type": "array",
"description": "Caches enabled for the step",
"items": {
"type": "string",
"description": "Name of the cache"
},
"minItems": 1
},
"clone": {
"$ref": "#/definitions/clone_properties"
},
"condition": {
"$ref": "#/definitions/condition",
"description": "Condition to execute the step"
},
"deployment": {
"type": "string",
"description": "Type of environment for the deployment step, used in the Deployments dashboard",
"minLength": 1
},
"fail-fast": {
"$ref": "#/definitions/fail_fast",
"description": "A flag reflecting whether other steps in a parallel group should be force stopped if this step fails"
},
"image": {
"$ref": "#/definitions/image"
},
"max-time": {
"$ref": "#/definitions/max_time"
},
"name": {
"type": "string",
"description": "Name of the step",
"minLength": 1
},
"oidc": {
"type": "boolean",
"description": "Enable the use of OpenID Connect to connect a pipeline step to a resource server"
},
"runs-on": {
"oneOf": [
{
"$ref": "#/definitions/runner_label"
},
{
"type": "array",
"description": "List of labels assigned to Pipeline runner",
"items": {
"$ref": "#/definitions/runner_label"
},
"minItems": 1
}
]
},
"script": {
"$ref": "#/definitions/script",
"description": "Commands to execute in the step"
},
"services": {
"type": "array",
"description": "Services enabled for the step",
"items": {
"type": "string",
"description": "Name of the service"
},
"minItems": 1,
"maxItems": 5
},
"size": {
"$ref": "#/definitions/size"
},
"trigger": {
"$ref": "#/definitions/trigger",
"description": "Specifies if a step runs automatically or only when manually triggered by a user"
}
},
"required": [
"script"
]
}
},
"additionalProperties": false
},
"stage": {
"type": "object",
"properties": {
"stage": {
"type": "object",
"properties": {
"condition": {
"$ref": "#/definitions/condition",
"description": "Condition to execute the stage"
},
"deployment": {
"type": "string",
"description": "Type of environment for the deployment stage, used in the Deployments dashboard",
"minLength": 1
},
"name": {
"type": "string",
"description": "Name of the stage",
"minLength": 1
},
"steps": {
"type": "array",
"description": "List of steps in a stage",
"items": {
"$ref": "#/definitions/step"
},
"minItems": 1
},
"trigger": {
"$ref": "#/definitions/trigger",
"description": "Specifies if the stage runs automatically or only when manually triggered by a user"
}
},
"required": [
"steps"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"parallel_steps": {
"type": "array",
"description": "Set of steps to run concurrently",
"items": {
"$ref": "#/definitions/step"
},
"minItems": 2
},
"step_or_stage_or_parallel_item": {
"oneOf": [
{
"$ref": "#/definitions/step"
},
{
"$ref": "#/definitions/stage"
},
{
"type": "object",
"properties": {
"parallel": {
"oneOf": [
{
"$ref": "#/definitions/parallel_steps"
},
{
"type": "object",
"properties": {
"fail-fast": {
"$ref": "#/definitions/fail_fast",
"description": "A flag reflecting whether all steps in a parallel group should be force stopped if any of its steps fails."
},
"steps": {
"$ref": "#/definitions/parallel_steps"
}
},
"required": [
"steps"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
]
},
"actions_list": {
"type": "array",
"items": {
"$ref": "#/definitions/step_or_stage_or_parallel_item"
},
"minItems": 1
},
"named_pipelines": {
"type": "object",
"patternProperties": {
"^.*$": {
"$ref": "#/definitions/actions_list"
}
}
},
"script": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"description": "Command to execute"
},
{
"$ref": "#/definitions/pipe"
}
]
},
"minItems": 1
},
"pipe": {
"type": "object",
"description": "Pipe to execute",
"properties": {
"pipe": {
"type": "string",
"description": "Pipe identifier"
},
"variables": {
"type": "object",
"description": "Environment variables passed to the pipe",
"patternProperties": {
"^.*$": {
"oneOf": [
{
"type": "string",
"description": "Variable value"
},
{
"type": "array",
"items": {
"type": "string",
"description": "Array variable item value"
},
"minItems": 1
}
]
}
},
"minProperties": 1
}
},
"required": [
"pipe"
]
},
"cache_path": {
"type": "string",
"description": "Path to the directory to be cached, can be absolute or relative to the clone directory"
},
"cache_with_key": {
"type": "object",
"description": "Cache definition declaring a set of files as a key and path to the directory to be cached",
"properties": {
"key": {
"type": "object",
"description": "Cache key definition",
"properties": {
"files": {
"type": "array",
"items": {
"type": "string",
"description": "Path to a file or glob pattern of files in the repository which form the cache key"
},
"minItems": 1
}
},
"required": [
"files"
],
"additionalProperties": false
},
"path": {
"$ref": "#/definitions/cache_path"
}
},
"required": [
"key",
"path"
],
"additionalProperties": false
}
},
"type": "object",
"properties": {
"clone": {
"$ref": "#/definitions/clone_properties"
},
"definitions": {
"type": "object",
"description": "Defines resources used elsewhere in the pipeline configuration",
"properties": {
"caches": {
"type": "object",
"description": "Defines custom caches to be used by pipelines",
"patternProperties": {
"^[a-z0-9]([-a-z0-9]{0,48}[a-z0-9])?$": {
"oneOf": [
{
"$ref": "#/definitions/cache_path"
},
{
"$ref": "#/definitions/cache_with_key"
}
]
}
},
"not": {
"required": [
"docker"
]
},
"additionalProperties": false
},
"services": {
"type": "object",
"description": "Defines services that run in separate Docker containers",
"patternProperties": {
"^.*$": {
"type": "object",
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"memory": {
"type": "number",
"description": "Memory limit for the service container, in megabytes",
"minimum": 128,
"default": 1024
},
"variables": {
"type": "object",
"description": "Environment variables passed to the service container",
"patternProperties": {
"^.*$": {
"type": "string"
}
},
"minProperties": 1
}
}
}
},
"additionalProperties": false
}
}
},
"image": {
"$ref": "#/definitions/image"
},
"options": {
"type": "object",
"properties": {
"docker": {
"type": "boolean",
"description": "A flag to add Docker to all build steps in all pipelines"
},
"max-time": {
"$ref": "#/definitions/max_time"
},
"size": {
"$ref": "#/definitions/size"
}
}
},
"pipelines": {
"type": "object",
"properties": {
"default": {
"$ref": "#/definitions/actions_list"
},
"branches": {
"$ref": "#/definitions/named_pipelines",
"description": "Branch-specific build pipelines"
},
"custom": {
"type": "object",
"description": "Pipelines that can only be triggered manually or scheduled from the Bitbucket Cloud interface",
"patternProperties": {
"^.*$": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"variables": {
"type": "array",
"description": "List of variables for the custom pipeline",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of a variable for the custom pipeline",
"minLength": 1
},
"default": {
"type": "string",
"description": "Default value for the variable, used unless the value is manually set when the pipeline is run"
},
"allowed-values": {
"type": "array",
"description": "A list of values that are allowed for the variable",
"items": {
"type": "string",
"description": "Allowed value for the variable"
},
"minItems": 1
},
"description": {
"type": "string",
"description": "Description of the variable",
"minLength": 1
}
},
"required": [
"name"
],
"additionalProperties": false
},
"minItems": 1
}
},
"additionalProperties": false
},
{
"$ref": "#/definitions/step_or_stage_or_parallel_item"
}
]
},
"minItems": 1
}
}
},
"pull-requests": {
"$ref": "#/definitions/named_pipelines",
"description": "Pull-request-specific build pipelines"
},
"tags": {
"$ref": "#/definitions/named_pipelines",
"description": "Tag-specific build pipelines"
}
},
"additionalProperties": false
}
},
"required": [
"pipelines"
]
}
|
base.json | {
"$id": "https://json.schemastore.org/base.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"nullable-array": {
"$id": "nullable-array",
"type": ["array", "null"]
},
"nullable-boolean": {
"$id": "nullable-boolean",
"type": ["boolean", "null"]
},
"nullable-integer": {
"$id": "nullable-integer",
"type": ["integer", "null"]
},
"nullable-number": {
"$id": "nullable-number",
"type": ["number", "null"]
},
"nullable-object": {
"$id": "nullable-object",
"type": ["object", "null"]
},
"nullable-string": {
"$id": "nullable-string",
"type": ["string", "null"]
},
"path": {
"$id": "path",
"type": "string",
"minLength": 1
},
"nullable-path": {
"$id": "nullable-path",
"oneOf": [
{
"$ref": "#/definitions/path"
},
{
"type": "null"
}
]
},
"editor": {
"$id": "editor",
"type": "string",
"oneOf": [
{
"enum": ["/usr/bin/nano", "/usr/bin/vim", "/usr/bin/emacs"]
},
{}
]
},
"nullable-editor": {
"$id": "nullable-editor",
"oneOf": [
{
"$ref": "#/definitions/editor"
},
{
"type": "null"
}
]
},
"timezone": {
"$id": "timezone",
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/ComodRivadavia",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Atka",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Buenos_Aires",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Coral_Harbour",
"America/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Ensenada",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Jujuy",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Knox_IN",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Louisville",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montreal",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Acre",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Rosario",
"America/Santa_Isabel",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Shiprock",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Virgin",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/South_Pole",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Ashkhabad",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Calcutta",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Colombo",
"Asia/Dacca",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Harbin",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kashgar",
"Asia/Kathmandu",
"Asia/Katmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macao",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Riyadh",
"Asia/Saigon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Tel_Aviv",
"Asia/Thimbu",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ujung_Pandang",
"Asia/Ulaanbaatar",
"Asia/Ulan_Bator",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faeroe",
"Atlantic/Faroe",
"Atlantic/Jan_Mayen",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/ACT",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Canberra",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/LHI",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/North",
"Australia/NSW",
"Australia/Perth",
"Australia/Queensland",
"Australia/South",
"Australia/Sydney",
"Australia/Tasmania",
"Australia/Victoria",
"Australia/West",
"Australia/Yancowinna",
"Brazil/Acre",
"Brazil/DeNoronha",
"Brazil/East",
"Brazil/West",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Canada/Saskatchewan",
"Canada/Yukon",
"Chile/Continental",
"Chile/EasterIsland",
"Cuba",
"Egypt",
"Eire",
"Etc/GMT",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT-0",
"Etc/GMT-1",
"Etc/GMT-10",
"Etc/GMT-11",
"Etc/GMT-12",
"Etc/GMT-13",
"Etc/GMT-14",
"Etc/GMT-2",
"Etc/GMT-3",
"Etc/GMT-4",
"Etc/GMT-5",
"Etc/GMT-6",
"Etc/GMT-7",
"Etc/GMT-8",
"Etc/GMT-9",
"Etc/GMT0",
"Etc/Greenwich",
"Etc/UCT",
"Etc/Universal",
"Etc/UTC",
"Etc/Zulu",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belfast",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Nicosia",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Tiraspol",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GB",
"GB-Eire",
"Hongkong",
"Iceland",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Iran",
"Israel",
"Jamaica",
"Japan",
"Kwajalein",
"Libya",
"Mexico/BajaNorte",
"Mexico/BajaSur",
"Mexico/General",
"Navajo",
"NZ",
"NZ-CHAT",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Ponape",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Samoa",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Truk",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Yap",
"Poland",
"Portugal",
"PRC",
"ROC",
"Singapore",
"US/Alaska",
"US/Aleutian",
"US/Arizona",
"US/Central",
"US/East-Indiana",
"US/Eastern",
"US/Hawaii",
"US/Indiana-Starke",
"US/Michigan",
"US/Mountain",
"US/Pacific",
"US/Samoa"
]
},
"nullable-timezone": {
"$id": "nullable-timezone",
"oneOf": [
{
"$ref": "#/definitions/timezone"
},
{
"type": "null"
}
]
}
},
"title": "Common types for all schemas"
}
|
bettercodehub.json | {
"$comment": "https://www.bettercodehub.com/docs/configuration-manual",
"$id": "https://json.schemastore.org/bettercodehub.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"supportedProgrammingLanguage": {
"type": "string",
"enum": [
"csharp",
"cpp",
"go",
"groovy",
"java",
"javascript",
"objectivec",
"perl",
"php",
"python",
"ruby",
"scala",
"script",
"solidity",
"swift",
"typescript",
"kotlin"
]
},
"excludeFileFilter": {
"title": "Exclude",
"type": "array",
"items": {
"title": "Pattern",
"description": "A regular expression for the path(s) to exclude.",
"type": "string"
}
},
"fileFilter": {
"type": "object",
"additionalProperties": false,
"properties": {
"include": {
"title": "Include",
"type": "array",
"items": {
"title": "Pattern",
"description": "A regular expression for the path(s) to include.",
"type": "string"
}
},
"exclude": {
"$ref": "#/definitions/excludeFileFilter"
}
}
}
},
"description": "Configuration file for Better Code Hub to override the default configuration.",
"properties": {
"component_depth": {
"title": "Component Depth",
"type": "integer",
"default": 1
},
"languages": {
"title": "Languages",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/supportedProgrammingLanguage"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"$ref": "#/definitions/supportedProgrammingLanguage"
},
"production": {
"title": "Production",
"$ref": "#/definitions/fileFilter"
},
"test": {
"title": "Test",
"$ref": "#/definitions/fileFilter"
}
}
}
]
}
},
"exclude": {
"$ref": "#/definitions/excludeFileFilter"
}
},
"title": "Better Code Hub",
"type": "object"
}
|
netlify.json | {
"$id": "https://json.schemastore.org/netlify.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"collectionItems": {
"properties": {
"fields": {
"$ref": "#/definitions/fields"
},
"label": {
"description": "label for the collection in the editor UI; defaults to the value of name",
"type": "string"
},
"label_singular": {
"description": "singular label for certain elements in the editor; defaults to the value of label"
},
"folder": {
"description": "Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. \nNote: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection \"must have a field that is a valid entry identifier\".",
"type": "string"
},
"files": {
"$ref": "#/definitions/files"
},
"path": {
"description": "Path",
"type": "string"
},
"format": {
"description": "determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.",
"type": "string",
"enum": [
"yml",
"yaml",
"toml",
"json",
"frontmatter",
"yaml-frontmatter",
"toml-frontmatter",
"json-frontmatter"
]
},
"slug": {
"description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date",
"type": "string"
},
"create": {
"description": "for folder collections only; allows users to create new items in the collection",
"type": "boolean",
"default": false
},
"hide": {
"description": "hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.",
"type": "boolean",
"default": false
},
"delete": {
"description": "prevents users from deleting items in a collection; defaults to true",
"type": "boolean",
"default": true
},
"name": {
"description": "unique identifier for the collection, used as the key when referenced in other contexts",
"type": "string"
},
"filter": {
"description": "optional filter for folder collections"
},
"description": {
"description": "optional text, displayed below the label when viewing a collection",
"type": "string"
},
"extension": {
"description": "the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items",
"type": "string"
}
},
"required": ["name"],
"oneOf": [
{
"required": ["files"]
},
{
"required": ["folder"]
}
]
},
"fields": {
"type": "array",
"description": "The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.",
"items": {
"properties": {
"name": {
"type": "string",
"description": "unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)"
},
"label": {
"type": "string",
"description": "label for the field in the editor UI; defaults to the value of name"
},
"widget": {
"$ref": "#/definitions/widget"
},
"default": {
"description": "specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type."
},
"required": {
"type": "boolean",
"default": true,
"description": "makes a field required; defaults to true"
},
"pattern": {
"type": "array",
"description": "add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)"
},
"fields": {
"$ref": "#/definitions/fields"
}
},
"required": ["name"]
}
},
"widget": {
"properties": {
"required": {
"type": "boolean",
"description": "Defaults to True"
},
"hint": {
"description": "optionally add helper text directly below a widget.",
"type": "string"
},
"pattern": {
"description": "add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets",
"type": "array"
}
}
},
"files": {
"type": "array",
"items": {
"properties": {
"name": {
"description": "unique identifier for the file",
"type": "string"
},
"label": {
"description": "file label",
"type": "string"
},
"file": {
"description": "unique filepath (relative to the base of the repo).",
"type": "string"
},
"fields": {
"$ref": "#/definitions/fields"
}
}
}
}
},
"dependencies": {},
"description": "Config file for Netlify CMS",
"properties": {
"backend": {
"type": "object",
"description": "specifies how to access the content for your site, including authentication"
},
"local_backend": {
"type": "boolean",
"description": "Set this property to connect Netlify to a local Git repo instead of a live one"
},
"publish_mode": {},
"media_folder": {
"type": "string",
"description": "specifies the folder path where uploaded files should be saved, relative to the base of the repo."
},
"public_folder": {
"type": "string",
"description": "specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included."
},
"media_library": {
"description": "Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"config": {
"type": "object"
}
},
"required": ["name"]
},
"site_url": {
"description": "should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content.",
"type": "string"
},
"display_url": {
"description": "When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).\nDefaults to site_url.",
"type": "string"
},
"logo_url": {
"type": "string",
"description": "Logo at the top of the login page. Assumed to be a URL to an image file"
},
"locale": {
"type": "string",
"default": "en"
},
"show_preview_links": {
"description": "shows Deploy Preview Links",
"type": "boolean"
},
"slug": {
"type": "object",
"description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).\n \nThe slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.\n \nAvailable template tags:\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date",
"properties": {
"encoding": {
"description": "\nunicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.\nascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).",
"enum": ["unicode", "ascii"],
"default": "unicode"
},
"clean_accents": {
"type": "boolean",
"description": "Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding."
},
"sanitize_replacement": {
"type": "string",
"description": "The replacement string used to substitute unsafe characters; defaults to -"
}
}
},
"collections": {
"description": "The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.",
"type": "array",
"items": {
"$ref": "#/definitions/collectionItems"
}
},
"editor": {
"description": "This setting changes options for the editor view of the collection. It has one option so far: preview",
"type": "object",
"properties": {
"preview": {
"type": "boolean",
"description": "Enable preview pane for this collection; defaults to true",
"default": true
}
}
},
"summary": {
"description": "This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field\nTemplate tags are the same as those for slug, with the following additions: \n\n \n{{filename}} The file name without the extension part. \n{{extension}} The file extension. \n{{commit_date}} The file commit date on supported backends (git based backends). \n{{commit_author}} The file author date on supported backends (git based backends).",
"type": "string"
},
"sortableFields": {
"type": "array",
"description": "An optional list of sort fields to show in the UI.\nDefaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.\nWhen author field can't be inferred commit author will be used."
},
"view_filters": {
"type": "array",
"description": "An optional list of predefined view filters to show in the UI.\nDefaults to an empty list."
}
},
"required": ["backend", "media_folder", "collections"],
"title": "Netlify config schema",
"type": "object"
}
|
reference.json | {
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "ServerlessFrameworkConfiguration",
"description": "Schema for serverless framework configuration files",
"fileMatch": ["serverless.yml", "serverless.yaml"],
"definitions": {
"Transform": {
"type": "object",
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"properties": {
"Name": {
"type": "string",
"enum": [
"AWS::Include"
]
},
"Parameters": {
"type": "object",
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"type": "string",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
]
}
]
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"type": "string",
"enum": ["HEADER", "AUTHORIZER"]
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"minimumCompressionSize": {
"type": "number",
"minimum": 0,
"maximum": 10485760
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"websocketApiId": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"apiKeys": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"description": {
"type": "string"
},
"customerId": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
}
}
}
]
}
},
"metrics": {
"type": "boolean"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"type": "object",
"properties": {
"quota": {
"type": "object",
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
}
},
"throttle": {
"type": "object",
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
}
}
}
}
},
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"memorySize": {
"type": ["string", "number"]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": ["string", "number"]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"name": {
"type": "string"
},
"workingDirectory": {
"type": "string"
},
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"type": "array",
"items": {
"type": "string"
}
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"snapStart": {
"type": "boolean",
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"properties": {
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
}
},
"additionalProperties": true,
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": ["string", "number"]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"anyOf": [
{
"$ref": "components/events.json#/AwsSqs"
},
{
"type": "string"
}
]
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"title": "AwsEventBridge",
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"eventBus": {
"type": "string",
"minLength": 1
},
"schedule": {
"type": "string",
"pattern": "^(?:cron|rate)\\(.+\\)$"
},
"name": {
"type": "string",
"pattern": "[a-zA-Z0-9-_.]+",
"minLength": 1,
"maxLength": 64
},
"enabled": {
"type": "boolean",
"default": true
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"input": {
"type": "object"
},
"inputPath": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"retryPolicy": {
"type": "object",
"properties": {
"maximumEventAge": {
"type": "number",
"minimum": 60,
"maximum": 86400
},
"maximumRetryAttempts": {
"type": "number",
"minimum": 0,
"maximum": 185
}
}
}
},
"type": "object",
"anyOf": [
{ "required": ["pattern"] },
{ "required": ["schedule"] }
]
},
"AwsFunctions": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
}
},
{
"type": "string",
"minLength": 1
},
{
"type": "array",
"items": {
"$ref": "#/definitions/ServerlessFilePath"
}
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"type": "string",
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
]
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"type": "string",
"minLength": 1
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"title": "AwsHttpIamAuthorizerShort",
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"type": "string",
"enum": ["aws_iam"]
},
{
"title": "AwsHttpIamAuthorizer",
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["aws_iam"]
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"title": "AwsHttpCognitoAuthorizer",
"properties": {
"arn": {
"type": "string",
"description": "The arn of the cognito user pool"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"claims": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"enum": [
"COGNITO_USER_POOLS"
]
},
"identitySource": {
"type": "string",
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"type": "number",
"minimum": 0,
"maximum": 3600
}
},
"required": [
"type",
"arn"
],
"additionalProperties": false
},
{
"title": "AwsHttpLambdaAuthorizer",
"type": "object",
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"type": "string",
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"type": "number",
"minimum": 0,
"maximum": 3600
},
"type": {
"type": "string",
"enum": ["request", "token", "REQUEST", "TOKEN"],
"default": "token"
}
},
"required": [
"name"
],
"additionalProperties": false
},
{
"title": "AwsHttpExistingAuthorizer",
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["CUSTOM"]
},
"authorizerId": {
"type": "string",
"description": "The Id of the existing authorizer"
}
},
"required": [
"type",
"authorizerId"
],
"additionalProperties": false
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"title": "AwsProvider",
"description": "Configuration for Serverless AWS ",
"type": "object",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"ecr": {
"type": "object",
"properties": {
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
},
"images": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "object",
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
},
"file": {
"type": "string",
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')"
},
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentPrefix": {
"type": "string"
},
"endpointType": {
"enum": ["EDGE", "PRIVATE", "REGIONAL"],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iam": {
"$ref": "components/iam.json#/AwsIamConfiguration"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logRetentionInDays": {
"type": ["string", "number"]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"type": "number",
"minimum": 128,
"maximum": 10240
}
],
"type": ["string", "number"]
},
"name": {
"enum": ["aws"],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": ["string", "number"]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": ["string", "number"]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"type": "string",
"enum": ["direct", "changesets"]
},
"disableRollback": {
"type": "boolean",
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments."
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
}
},
"required": ["name"]
},
"AwsQuota": {
"properties": {
"limit": {
"type": ["string", "number"]
},
"offset": {
"type": ["string", "number"]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": ["Allow", "Deny"],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"title": "ServerlessFrameworkResourceConfiguration",
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Mappings": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"additionalProperties": false
},
"Conditions": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html",
"$ref": "components/conditions.json#/properties/Conditions"
},
"Parameters": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html",
"$ref": "components/parameters.json#/properties/Parameters"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"type": "string",
"enum": [
"2010-09-09"
]
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"type": "string",
"maxLength": 1024
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Transform": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html",
"$ref": "#/definitions/Transform"
}
},
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessFilePath": {
"type": "string",
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}"
},
"AwsRestApiLogs": {
"title": "AwsRestApiLogs",
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": ["string", "number"]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"type": "string",
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"minLength": 3,
"maxLength": 63,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"title": "ServerlessServiceConfiguration",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": ["string", "number"]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": ["string", "number"]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": ["string", "number"]
},
"rateLimit": {
"type": ["string", "number"]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"type": "object",
"required": ["securityGroupIds", "subnetIds"]
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"level": {
"type": "string",
"enum": ["INFO", "ERROR"]
},
"format": {
"type": "string",
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html"
},
"accessLogging": {
"type": "boolean",
"description": "Enables HTTP access logs (default: true)"
},
"executionLogging": {
"type": "boolean",
"description": "Enable execution logging (default: true)"
},
"fullExecutionData": {
"type": "boolean",
"description": "Log full requests/responses for execution logging (default: true)"
}
},
"type": "object"
}
},
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"title": "LocalPlugin",
"type": "object",
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"tenant": {
"type": "string"
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
}
},
"type": "object",
"required": ["provider", "service"]
}
|
compile-commands.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"commandObject": {
"properties": {
"directory": {
"description": "The working directory of the compilation. All paths specified in the command or file fields must be either absolute or relative to this directory.",
"type": "string"
},
"file": {
"description": "The main translation unit source processed by this compilation step. This is used by tools as the key into the compilation database. There can be multiple command objects for the same file, for example if the same source file is compiled with different configurations.",
"type": "string"
},
"command": {
"description": "The compile command executed. After JSON unescaping, this must be a valid command to rerun the exact compilation step for the translation unit in the environment the build system uses. Parameters use shell quoting and shell escaping of quotes, with '\"' and '\\' being the only special characters. Shell expansion is not supported.",
"type": "string"
},
"arguments": {
"description": "The compile command executed as list of strings.",
"type": "array",
"items": {
"type": "string"
}
},
"output": {
"description": "The name of the output created by this compilation step. This field is optional. It can be used to distinguish different processing modes of the same input file.",
"type": "string"
}
},
"anyOf": [
{
"required": ["directory", "file", "command"]
},
{
"required": ["directory", "file", "arguments"]
}
]
}
},
"description": "Describes a format for specifying how to replay single compilations independently of the build system",
"id": "https://json.schemastore.org/compile-commands.json",
"items": {
"$ref": "#/definitions/commandObject"
},
"title": "LLVM compilation database",
"type": "array"
}
|
typings.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"id": "https://json.schemastore.org/typings.json",
"properties": {
"main": {
"description": "The entry point to the definition (canonical to `\"main\"` in NPM's `package.json`).",
"type": "string"
},
"browser": {
"description": "A string, or map of paths, to override during resolution. See spec: https://github.com/defunctzombie/package-browser-field-spec",
"type": ["object", "string"]
},
"version": {
"description": "The semver range this definition is typed for",
"type": "string"
},
"homepage": {
"description": "Homepage url of the source package",
"type": "string"
},
"resolution": {
"description": "Map of resolutions to install",
"type": ["object", "string"]
},
"files": {
"description": "Used as an alternative or to complement `main`, specify an array of files that are exported but aren't already part of the resolution from `main`.",
"type": "array",
"items": {
"type": "string"
}
},
"global": {
"description": "Denote that this definition _must_ be installed as global.",
"type": "boolean"
},
"postmessage": {
"description": "A message to emit to users after typings installation.",
"type": "string"
},
"name": {
"description": "The name of the definition",
"type": "string"
},
"dependencies": {
"description": "A map of dependencies required by the project.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"devDependencies": {
"description": "A map of dependencies required by the project during development.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"peerDependencies": {
"description": "A map of dependencies expected in the parent project for this dependency to work.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"globalDependencies": {
"description": "A map of global dependencies required by the project.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"globalDevDependencies": {
"description": "A map of global dependencies required by the project during development.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"title": "JSON schema for Typings TypeScript definitions manager",
"type": "object"
}
|
zinoma-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Project",
"description": "Schema of the build flow configuration file `zinoma.yml`.\n\nIn order to use Žinoma with your project, you need to create a file named `zinoma.yml`. We recommend putting this file in the root directory of your project.\n\nThis struct describes the schema expected for this file. It assumes prior knowledge of the Yaml format.\n\n__Example__\n\n`zinoma.yml`:\n\n```yaml targets: download_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install\n\ntest: input: - download_dependencies.output - paths: [package.json, src, test] build: npm test\n\nlint: input: - download_dependencies.output - paths: [package.json, src, test] build: npm run lint\n\ncheck: dependencies: [test, lint]\n\nstart: input: - download_dependencies.output - paths: [package.json, src] service: exec npm run start\n\nbuild: dependencies: [check] input: - paths: - Dockerfile - package.json - package-lock.json - src output: - paths: [lambda.zip] build: | docker build -t build-my-project:latest . docker create -ti --name build-my-project build-my-project:latest bash docker cp build-my-project:/var/task/lambda.zip ./ docker rm -f build-my-project ```\n\nIn this example:\n\n- `zinoma check` will ensure the code complies to the test suites and the coding standards. - `zinoma start --watch` will run the application and restart it whenever the sources are updated. - `zinoma --clean build` will generate a clean artifact, ready to be deployed.\n\nA fully functional and more advanced example project is available in [fbecart/zinoma-node-example](https://github.com/fbecart/zinoma-node-example).",
"type": "object",
"properties": {
"imports": {
"description": "Import definitions from other Žinoma projects.\n\n`imports` should be an object, the keys being the project names and the values their respective paths.\n\nBefore importing a project, you should make sure this project has its name defined. You should use the same name as key in the `imports` object.\n\nOnce a project is imported, targets from that project can be referenced by specifying their fully qualified name: `imported_project_name::target_name`.\n\n__Example__\n\n`packages/api/zinoma.yml`:\n\n```yaml name: api\n\ntargets: test: build: cargo test ```\n\n`packages/webapp/zinoma.yml`:\n\n```yaml name: webapp\n\ntargets: test: build: cargo test ```\n\n`./zinoma.yml`:\n\n```yaml imports: api: packages/api webapp: packages/webapp\n\ntargets: test_all: dependencies: [api::test, webapp::test] ```\n\nIn this example, the target `test_all` depend from targets defined in different projects.",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"description": "Name of the project.\n\nA project name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.\n\nProject names should be unique. Two projects cannot have the same name.\n\n__Example__\n\n```yaml name: my_project ```",
"default": null,
"type": [
"string",
"null"
]
},
"targets": {
"description": "Targets (aka tasks) of this project.\n\n[`Targets`] represent commands and scripts to execute in your build flow.\n\n[`Targets`]: struct.Target.html\n\nTargets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.\n\n[`dependencies`]: enum.Target.html#variant.Build.field.dependencies\n\nEach target must have a unique name inside the project. The target name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.\n\n__Example__\n\n```yaml targets: speak_cow: build: echo 'Moo' speak_dog: build: echo 'Woof!' ```\n\nIn this example:\n\n- `zinoma speak_cow` will print `Moo` - `zinoma speak_dog` will print `Woof!` - `zinoma speak_cow speak_dog` will print both `Moo` and `Woof!` (not necessarily in this order)",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Target"
}
}
},
"additionalProperties": false,
"definitions": {
"Dependencies": {
"description": "List of [`targets`] that must complete successfully before this target can be built.\n\n[`targets`]: enum.Target.html\n\nIt should be an array of strings.\n\nIf any of the dependencies fails to complete, this target will not be executed.\n\n__Example__\n\n```yaml targets: target1: dependencies: [] target2: dependencies: [target1] target3: dependencies: [target2] ```\n\nIn this example, `target1` must complete successfully before `target2` begins, while `target3` waits for `target2` to complete.\n\n`zinoma target2` will run sequentially `target1` and `target2`.\n\n`zinoma target3` will run sequentially `target1`, `target2` and `target3`.",
"type": "array",
"items": {
"type": "string"
}
},
"InputResource": {
"anyOf": [
{
"description": "Output resources of another target.\n\nIt should be a string with the format `<project_name>::<target_name>.output`. If the other target is located in the same project, the project name can be skipped. The `input` would then have this format: `<target_name>.output`.\n\nWhen such an input is used:\n\n- all the output resources of the other target become input resources for this target; - the other target implicitly becomes a dependency to this target.\n\n__Example__\n\n```yaml targets: node_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install\n\ncompile: input: - node_dependencies.output - paths: [package.json, tsconfig.json, src] output: - paths: [dist] build: tsc\n\nrun: input: - node_dependencies.output - paths: [package.json] - compile.output service: node dist/index.js ```",
"type": "string"
},
{
"type": "object",
"required": [
"paths"
],
"properties": {
"extensions": {
"description": "Filter files resource by file extensions.\n\nIt should be an array of strings.\n\nIf `extensions` are specified, only files matching at least one of the extensions will be included in the resource.\n\n__Example__\n\n```yaml targets: fmt: input: - paths: [src, tests] extensions: [rs] build: exec cargo fmt --all -- --check",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"paths": {
"description": "Paths to files or directories.\n\nIt should be an array of strings.\n\nEach element of the array should be a path to a file or directory.\n\n__Example__\n\n```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"cmd_stdout"
],
"properties": {
"cmd_stdout": {
"description": "Shell script whose output identifies the state of a resource.\n\nIt should be a string.\n\n__Example__\n\n```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format \"{{.ID}}\"' output: - cmd_stdout: 'docker image ls webapp:latest --format \"{{.ID}}\"' build: docker build -t webapp . ```",
"type": "string"
}
},
"additionalProperties": false
}
]
},
"InputResources": {
"description": "List of artifacts that this target depends on.\n\n`input` should be an array of [`resources`].\n\n[`resources`]: enum.InputResource.html\n\nSpecifying a target's `input` enables the incremental build for this target. This means that, at the time of executing the target, Žinoma will skip its build if its input resources (and [`output`] resources, if any) have not changed since its last successful completion.\n\n[`output`]: struct.OutputResources.html\n\n__Example__\n\n```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] build: npm install ```\n\nIn this example, running `zinoma npm_install` once will execute `npm install`. Subsequent runs of `zinoma npm_install` will return immediately — until the content of `package.json` or `package-lock.json` is modified.",
"type": "array",
"items": {
"$ref": "#/definitions/InputResource"
}
},
"OutputResource": {
"anyOf": [
{
"type": "object",
"required": [
"paths"
],
"properties": {
"extensions": {
"description": "Filter files resource by file extensions.\n\nIt should be an array of strings.\n\nIf `extensions` are specified, only files matching at least one of the extensions will be included in the resource.\n\n__Example__\n\n```yaml targets: protoc: input: - paths: [protos] extensions: [proto] output: - paths: [protos] extensions: [go] build: | cd protos docker run -v `pwd`:/defs namely/protoc-all -d . -o . -l go",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"paths": {
"description": "Paths to files or directories.\n\nIt should be an array of strings. Each element of the array should be a path to a file or directory.\n\nIf the `--clean` flag is provided to `zinoma`, the files or directories specified in `paths` will be deleted before running the build flow.\n\n__Example__\n\n```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```\n\nIn this example, as the target specifies an `input`, `zinoma npm_install` is incremental. The script `npm install` will be skipped until `package.json`, `package-lock.json` or `node_modules` are modified.\n\nAdditionally:\n\n- the command `zinoma --clean` will delete `node_modules`; - the command `zinoma --clean npm_install` will delete `node_modules`, then run `npm install`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"cmd_stdout"
],
"properties": {
"cmd_stdout": {
"description": "Shell script whose output identifies the state of a resource.\n\nIt should be a string.\n\n__Example__\n\n```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format \"{{.ID}}\"' output: - cmd_stdout: 'docker image ls webapp:latest --format \"{{.ID}}\"' build: docker build -t webapp . ```",
"type": "string"
}
},
"additionalProperties": false
}
]
},
"OutputResources": {
"description": "List of artifacts produced by this target.\n\nIt should be an array of [`resources`].\n\n[`resources`]: enum.OutputResource.html\n\nThe incremental build takes in account the target `output`. Just like with [`input`], if any of the target output resources were altered since its previous successful execution, the target state will be invalidated and its build will be run again.\n\n[`input`]: struct.InputResources.html\n\n__Example__\n\n```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```\n\nIn this example, running `zinoma npm_install` will return immediately in case `package.json`, `package-lock.json` and `node_modules` were not modified since the last completion of the target.\n\nRunning `zinoma --clean npm_install` will start by deleting `node_modules`, then will run `npm install`.",
"type": "array",
"items": {
"$ref": "#/definitions/OutputResource"
}
},
"Target": {
"description": "A target is a command or a set of commands to run as part of your build flow.\n\nTargets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.\n\n[`dependencies`]: struct.Dependencies.html",
"anyOf": [
{
"description": "A build target represents a shell script to run as part of your build flow.\n\nThis build script is expected to eventually complete, as opposed to the run script of a [`service`] target.\n\n[`service`]: #variant.Service.field.service",
"type": "object",
"required": [
"build"
],
"properties": {
"build": {
"description": "The shell script to run in order to build this target.\n\nIt should be a string. This string can be multi-line, in case of scripts with multiple commands.\n\n__Example__\n\n```yaml targets: create_file_deep: build: | mkdir -p deep/dir touch deep/dir/file output: - paths: [deep/dir/file] ```\n\nIn this example, running `zinoma create_file_deep` will execute the commands `mkdir -p deep/dir` and `touch deep/dir/my_file` sequentially.",
"type": "string"
},
"dependencies": {
"description": "Dependencies of the target.",
"default": [],
"allOf": [
{
"$ref": "#/definitions/Dependencies"
}
]
},
"input": {
"description": "Input resources of the target.",
"default": [],
"allOf": [
{
"$ref": "#/definitions/InputResources"
}
]
},
"output": {
"description": "Output resources of the target.",
"default": [],
"allOf": [
{
"$ref": "#/definitions/OutputResources"
}
]
}
},
"additionalProperties": false
},
{
"description": "Service targets are useful to run scripts that do not complete.\n\nThey enable the execution of long-lasting commands, such as servers.",
"type": "object",
"required": [
"service"
],
"properties": {
"dependencies": {
"description": "Dependencies of the target.",
"default": [],
"allOf": [
{
"$ref": "#/definitions/Dependencies"
}
]
},
"input": {
"description": "Input resources of the target.",
"default": [],
"allOf": [
{
"$ref": "#/definitions/InputResources"
}
]
},
"service": {
"description": "Shell script starting a long-lasting service.\n\nIt should be a string.\n\nIf `zinoma` has no service target to run, it will automatically exit after all build targets ran to completion. On the contrary, if at least one service target is specified in the command line, `zinoma` will keep running even after all build targets completed, so that the services can remain alive.\n\nIn watch mode (when the `--watch` flag is passed to `zinoma`), services are restarted when the relevant paths are modified.\n\n__Example__\n\n```yaml targets: npm_server: input: - paths: [package.json, index.js] service: npm start ```\n\nIn this example, `zinoma npm_server --watch` will run `npm start`, and will restart this process every time `package.json` or `index.js` are updated.",
"type": "string"
}
},
"additionalProperties": false
},
{
"description": "Aggregates other targets.\n\n__Example__\n\n```yaml targets: fmt: build: cargo fmt -- --check lint: build: cargo clippy test: build: cargo test check: dependencies: [fmt, lint, test] ```\n\nIn this example, the target named `check` aggregates the 3 other targets. `zinoma check` is equivalent to running `zinoma fmt lint test`.",
"type": "object",
"required": [
"dependencies"
],
"properties": {
"dependencies": {
"description": "Dependencies of the target.",
"allOf": [
{
"$ref": "#/definitions/Dependencies"
}
]
}
},
"additionalProperties": false
}
]
}
}
} |
sourcehut-build-0.65.0.json | {
"$id": "https://json.schemastore.org/sourcehut-build-0.65.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A recipe for Sourcehut CI service. For details, see https://man.sr.ht/builds.sr.ht/manifest.md.",
"properties": {
"image": {
"description": "Which OS image to build in. A list of available build images can be found at https://man.sr.ht/builds.sr.ht/compatibility.md",
"type": "string",
"examples": ["archlinux", "alpine/latest"]
},
"arch": {
"description": "Which architecture to build for. See https://man.sr.ht/builds.sr.ht/compatibility.md for a list of available architectures.",
"type": "string",
"examples": ["aarch64", "x86_64"]
},
"packages": {
"description": "A list of packages to install on the image. For image-specific details, consult https://man.sr.ht/builds.sr.ht/compatibility.md",
"type": "array",
"items": {
"type": "string"
}
},
"repositories": {
"description": "A list of extra repositories to enable with the image's package manager. The specific format varies by base image, consult https://man.sr.ht/builds.sr.ht/compatibility.md for details.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"artifacts": {
"description": "A list of files to extract from the completed build environment and make available for downloading from the jobs page. Artifacts are only uploaded for successful jobs and are pruned after 90 days. \nNote that the file names are interpreted literally: do not use ~ or any shell code. If a relative path is used (e.g. example/my-artifact.tar.gz), it will be interpreted relative to the build user's home directory.",
"type": "array",
"items": {
"type": "string"
},
"examples": ["example/my-artifact.tar.gz"]
},
"shell": {
"description": "Whether to keep the build VM alive after all of the tasks have finished, even if it doesn't fail, so you can SSH in. You can also SSH in before the tasks have finished and tail the output of the build in your terminal. Learn more at https://man.sr.ht/builds.sr.ht/build-ssh.md",
"type": "boolean"
},
"sources": {
"description": "A list of repositories to clone into the home directory of the build user in the build environment. Optionally, prefix the protocol with the source control management scheme, to specify a protocol other than git. To specify a non-default git revision, append #commit-object to the repository.",
"type": "array",
"items": {
"type": "string",
"examples": [
"https://git.sr.ht/~sircmpwn/scdoc",
"https://git.sr.ht/~sircmpwn/scdoc#devel",
"[email protected]:~sircmpwn/scdoc",
"hg+https://hg.sr.ht/~sircmpwn/scdoc",
"hg+ssh://hg.sr.ht/~sircmpwn/scdoc"
]
}
},
"tasks": {
"description": "A list of scripts to execute in the build environment. \nTask names must use only lowercase alphanumeric characters, underscores or dashes and must be <=128 characters in length. Tasks are executed in the order specified. \nEach task is run in a separate login session, so if you modify the groups of the build user they will be effective starting from the subsequent task.",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"pattern": "^[a-z0-9_-]{1,128}$"
},
"examples": [
{
"package": "cd $site\ntar -cvz . > ../site.tar.gz"
}
]
}
},
"triggers": {
"description": "A list of triggers to execute post-build, which can be used to send emails or do other post-build tasks. \nLearn more at https://man.sr.ht/builds.sr.ht/triggers.md",
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"properties": {
"action": {
"description": "Trigger type",
"type": "string",
"enum": ["email", "webhook"]
},
"condition": {
"description": "When to execute this trigger",
"type": "string",
"enum": ["always", "failure", "success"]
}
},
"required": ["action", "condition"]
}
},
"environment": {
"description": "A list of key/value pairs for options to set in the build environment via ~/.buildenv",
"type": "object",
"additionalProperties": {
"type": "string"
},
"examples": [
{
"site": "your-username.srht.site"
}
]
},
"secrets": {
"description": "List of secret UUIDs to be added to the guest during the build. Learn more at https://man.sr.ht/builds.sr.ht/#secrets",
"type": "array",
"items": {
"type": "string",
"examples": ["46f739e5-4538-45dd-a79f-bf173b7a2ed9"]
}
},
"oauth": {
"description": "If present, and secrets are enabled for this build, an OAuth 2.0 bearer token is generated for this build with the given string as the list of grants. The acurl command may be used in the task scripts to perform authenticated GraphAL API requests (https://man.sr.ht/graphql.md).",
"type": "string",
"examples": ["pages.sr.ht/PAGES:RW"]
}
},
"required": ["image", "tasks"],
"title": "Sourcehut Build Manifest",
"type": "object"
}
|
renovate-schema.json | {
"title": "JSON schema for Renovate config files (https://renovatebot.com/)",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"addLabels": {
"description": "Labels to add to Pull Request.",
"type": "array",
"items": {
"type": "string"
}
},
"additionalBranchPrefix": {
"description": "Additional string value to be appended to `branchPrefix`.",
"type": "string",
"default": ""
},
"additionalReviewers": {
"description": "Additional reviewers for Pull Requests (in contrast to `reviewers`, this option adds to the existing reviewer list, rather than replacing it).",
"type": "array",
"items": {
"type": "string"
}
},
"allowCustomCrateRegistries": {
"description": "Set this to `true` to allow custom crate registries.",
"type": "boolean",
"default": false
},
"allowPlugins": {
"description": "Set this to `true` if repositories are allowed to run install plugins.",
"type": "boolean",
"default": false
},
"allowPostUpgradeCommandTemplating": {
"description": "Set this to `false` to disable template compilation for post-upgrade commands.",
"type": "boolean",
"default": true
},
"allowScripts": {
"description": "Set this to `true` if repositories are allowed to run install scripts.",
"type": "boolean",
"default": false
},
"allowedPostUpgradeCommands": {
"description": "A list of regular expressions that decide which post-upgrade tasks are allowed.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"ansible": {
"description": "Configuration object for the ansible manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)tasks/[^/]+\\.ya?ml$"
]
},
"$ref": "#"
},
"ansible-galaxy": {
"description": "Configuration object for the ansible-galaxy manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)requirements\\.ya?ml$",
"(^|/)galaxy\\.ya?ml$"
]
},
"$ref": "#"
},
"argocd": {
"description": "Configuration object for the argocd manager",
"type": "object",
"default": {
"fileMatch": []
},
"$ref": "#"
},
"asdf": {
"description": "Configuration object for the asdf manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.tool-versions$"
]
},
"$ref": "#"
},
"assignAutomerge": {
"description": "Assign reviewers and assignees even if the PR is to be automerged.",
"type": "boolean",
"default": false
},
"assignees": {
"description": "Assignees for Pull Request (either username or email address depending on the platform).",
"type": "array",
"items": {
"type": "string"
}
},
"assigneesFromCodeOwners": {
"description": "Determine assignees based on configured code owners and changes in PR.",
"type": "boolean",
"default": false
},
"assigneesSampleSize": {
"description": "Take a random sample of given size from `assignees`.",
"type": "integer",
"default": null
},
"autoApprove": {
"description": "Set to `true` to automatically approve PRs.",
"type": "boolean",
"default": false
},
"autoReplaceGlobalMatch": {
"description": "Control whether replacement regular expressions are global matches or only the first match.",
"type": "boolean",
"default": true
},
"autodiscover": {
"description": "Autodiscover all repositories.",
"type": "boolean",
"default": false
},
"autodiscoverFilter": {
"description": "Filter the list of autodiscovered repositories.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"default": null
},
"autodiscoverTopics": {
"description": "Filter the list of autodiscovered repositories by topics.",
"type": "array",
"items": {
"type": "string"
},
"default": null
},
"automerge": {
"description": "Whether to automerge branches/PRs automatically, without human intervention.",
"type": "boolean",
"default": false
},
"automergeComment": {
"description": "PR comment to add to trigger automerge. Only used if `automergeType=pr-comment`.",
"type": "string",
"default": "automergeComment"
},
"automergeSchedule": {
"description": "Limit automerge to these times of day or week.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"default": [
"at any time"
]
},
"automergeStrategy": {
"description": "The merge strategy to use when automerging PRs. Used only if `automergeType=pr`.",
"type": "string",
"enum": [
"auto",
"fast-forward",
"merge-commit",
"rebase",
"squash"
],
"default": "auto"
},
"automergeType": {
"description": "How to automerge, if enabled.",
"type": "string",
"enum": [
"branch",
"pr",
"pr-comment"
],
"default": "pr"
},
"azure-pipelines": {
"description": "Configuration object for the azure-pipelines manager",
"type": "object",
"default": {
"fileMatch": [
"azure.*pipelines?.*\\.ya?ml$"
],
"enabled": false
},
"$ref": "#"
},
"azureWorkItemId": {
"description": "The id of an existing work item on Azure Boards to link to each PR.",
"type": "integer",
"default": 0
},
"baseBranches": {
"description": "List of one or more custom base branches defined as exact strings and/or via regex expressions.",
"type": "array",
"items": {
"type": "string"
}
},
"baseDir": {
"description": "The base directory for Renovate to store local files, including repository files and cache. If left empty, Renovate will create its own temporary directory to use.",
"type": "string"
},
"batect": {
"description": "Configuration object for the batect manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)batect(-bundle)?\\.ya?ml$"
]
},
"$ref": "#"
},
"batect-wrapper": {
"description": "Configuration object for the batect-wrapper manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)batect$"
],
"versioning": "semver"
},
"$ref": "#"
},
"bazel": {
"description": "Configuration object for the bazel manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)WORKSPACE(|\\.bazel)$",
"\\.bzl$"
]
},
"$ref": "#"
},
"bazel-module": {
"description": "Configuration object for the bazel-module manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)MODULE\\.bazel$"
]
},
"$ref": "#"
},
"bazelisk": {
"description": "Configuration object for the bazelisk manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.bazelversion$"
],
"pinDigests": false,
"versioning": "semver"
},
"$ref": "#"
},
"bbUseDefaultReviewers": {
"description": "Use the default reviewers (Bitbucket only).",
"type": "boolean",
"default": true
},
"bbUseDevelopmentBranch": {
"description": "Use the repository's [development branch](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/#The-branching-model) as the repository's default branch.",
"type": "boolean",
"default": false
},
"bicep": {
"description": "Configuration object for the bicep manager",
"type": "object",
"default": {
"fileMatch": [
"\\.bicep$"
]
},
"$ref": "#"
},
"binarySource": {
"description": "Controls how third-party tools like npm or Gradle are called: directly, via Docker sidecar containers, or via dynamic install.",
"type": "string",
"enum": [
"global",
"docker",
"install",
"hermit"
],
"default": "install"
},
"bitbucket-pipelines": {
"description": "Configuration object for the bitbucket-pipelines manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.?bitbucket-pipelines\\.ya?ml$"
]
},
"$ref": "#"
},
"branchConcurrentLimit": {
"description": "Limit to a maximum of x concurrent branches. 0 means no limit, `null` (default) inherits value from `prConcurrentLimit`.",
"type": "integer",
"default": null
},
"branchName": {
"description": "Branch name template.",
"type": "string",
"default": "{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}"
},
"branchNameStrict": {
"description": "Whether to be strict about the use of special characters within the branch name.",
"type": "boolean",
"default": false
},
"branchPrefix": {
"description": "Prefix to use for all branch names.",
"type": "string",
"default": "renovate/"
},
"branchPrefixOld": {
"description": "Old branchPrefix value to check for existing PRs.",
"type": "string",
"default": "renovate/"
},
"branchTopic": {
"description": "Branch topic.",
"type": "string",
"default": "{{{depNameSanitized}}}-{{{newMajor}}}{{#if separateMinorPatch}}{{#if isPatch}}.{{{newMinor}}}{{/if}}{{/if}}.x{{#if isLockfileUpdate}}-lockfile{{/if}}"
},
"buildkite": {
"description": "Configuration object for the buildkite manager",
"type": "object",
"default": {
"fileMatch": [
"buildkite\\.ya?ml",
"\\.buildkite/.+\\.ya?ml$"
],
"commitMessageTopic": "buildkite plugin {{depName}}",
"commitMessageExtra": "to {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{{newValue}}}{{/if}}"
},
"$ref": "#"
},
"bumpVersion": {
"description": "Bump the version in the package file being updated.",
"type": "string",
"enum": [
"major",
"minor",
"patch",
"prerelease"
]
},
"bundler": {
"description": "Configuration object for the bundler manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)Gemfile$"
],
"versioning": "ruby"
},
"$ref": "#"
},
"cacheDir": {
"description": "The directory where Renovate stores its cache. If left empty, Renovate creates a subdirectory within the `baseDir`.",
"type": "string"
},
"cacheHardTtlMinutes": {
"description": "Maximum duration in minutes to keep datasource cache entries.",
"type": "integer",
"default": 1440
},
"cake": {
"description": "Configuration object for the cake manager",
"type": "object",
"default": {
"fileMatch": [
"\\.cake$"
]
},
"$ref": "#"
},
"cargo": {
"description": "Configuration object for the cargo manager",
"type": "object",
"default": {
"commitMessageTopic": "Rust crate {{depName}}",
"fileMatch": [
"(^|/)Cargo\\.toml$"
],
"versioning": "cargo"
},
"$ref": "#"
},
"cdnurl": {
"description": "Configuration object for the cdnurl manager",
"type": "object",
"default": {
"fileMatch": [],
"versioning": "semver"
},
"$ref": "#"
},
"checkedBranches": {
"description": "A list of branch names to mark for creation or rebasing as if it was selected in the Dependency Dashboard issue.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"circleci": {
"description": "Configuration object for the circleci manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.circleci/config\\.ya?ml$"
]
},
"$ref": "#"
},
"cloneSubmodules": {
"description": "Set to `true` to initialize submodules during repository clone.",
"type": "boolean",
"default": false
},
"cloudbuild": {
"description": "Configuration object for the cloudbuild manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)cloudbuild\\.ya?ml"
]
},
"$ref": "#"
},
"cocoapods": {
"description": "Configuration object for the cocoapods manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)Podfile$"
],
"versioning": "ruby"
},
"$ref": "#"
},
"commitBody": {
"description": "Commit message body template. Will be appended to commit message, separated by two line returns.",
"type": "string"
},
"commitBodyTable": {
"description": "If enabled, append a table in the commit message body describing all updates in the commit.",
"type": "boolean",
"default": false
},
"commitMessage": {
"description": "Message to use for commit messages and pull request titles.",
"type": "string",
"default": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}"
},
"commitMessageAction": {
"description": "Action verb to use in commit messages and PR titles.",
"type": "string",
"default": "Update"
},
"commitMessageExtra": {
"description": "Extra description used after the commit message topic - typically the version.",
"type": "string",
"default": "to {{#if isPinDigest}}{{{newDigestShort}}}{{else}}{{#if isMajor}}{{prettyNewMajor}}{{else}}{{#if isSingleVersion}}{{prettyNewVersion}}{{else}}{{#if newValue}}{{{newValue}}}{{else}}{{{newDigestShort}}}{{/if}}{{/if}}{{/if}}{{/if}}"
},
"commitMessageLowerCase": {
"description": "Lowercase PR- and commit titles.",
"type": "string",
"enum": [
"auto",
"never"
],
"default": "auto"
},
"commitMessagePrefix": {
"description": "Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if `semanticCommits` is enabled.",
"type": "string"
},
"commitMessageSuffix": {
"description": "Suffix to add to end of commit messages and PR titles.",
"type": "string"
},
"commitMessageTopic": {
"description": "The upgrade topic/noun used in commit messages and PR titles.",
"type": "string",
"default": "dependency {{depName}}"
},
"composer": {
"description": "Configuration object for the composer manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)([\\w-]*)composer\\.json$"
],
"versioning": "composer"
},
"$ref": "#"
},
"composerIgnorePlatformReqs": {
"description": "Configure use of `--ignore-platform-reqs` or `--ignore-platform-req` for the Composer package manager.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"conan": {
"description": "Configuration object for the conan manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)conanfile\\.(txt|py)$"
],
"datasource": "conan",
"versioning": "conan",
"enabled": false
},
"$ref": "#"
},
"confidential": {
"description": "If enabled, issues created by Renovate are set as confidential.",
"type": "boolean",
"default": false
},
"configMigration": {
"description": "Enable this to get config migration PRs when needed.",
"type": "boolean",
"default": false
},
"configWarningReuseIssue": {
"description": "Set this to `false` to make Renovate create a new issue for each config warning, instead of reopening or reusing an existing issue.",
"type": "boolean",
"default": true
},
"constraints": {
"description": "Configuration object to define language or manager version constraints.",
"type": "object",
"default": {},
"$ref": "#"
},
"constraintsFiltering": {
"description": "Perform release filtering based on language constraints.",
"type": "string",
"enum": [
"none",
"strict"
],
"default": "none"
},
"containerbaseDir": {
"description": "The directory where Renovate stores its containerbase cache. If left empty, Renovate creates a subdirectory within the `cacheDir`.",
"type": "string"
},
"cpanfile": {
"description": "Configuration object for the cpanfile manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)cpanfile$"
]
},
"$ref": "#"
},
"customDatasources": {
"description": "Defines custom datasources for usage by managers",
"type": "object",
"default": {},
"$ref": "#",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A custom description for this configuration object"
},
"defaultRegistryUrlTemplate": {
"description": "Template for generating a defaultRegistryUrl for custom datasource",
"type": "string",
"default": ""
},
"format": {
"description": "Format of the custom datasource",
"type": "string",
"enum": [
"json",
"plain"
],
"default": "json"
},
"transformTemplates": {
"description": "List of jsonata transformation rules",
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
}
]
}
},
"customEnvVariables": {
"description": "Custom environment variables for child processes and sidecar Docker containers.",
"type": "object",
"default": {},
"$ref": "#"
},
"customizeDashboard": {
"description": "Customize sections in the dependency dashboard issue.",
"type": "object",
"default": {},
"additionalProperties": {
"type": "string"
},
"$ref": "#"
},
"defaultRegistryUrls": {
"description": "List of registry URLs to use as the default for a datasource.",
"type": "array",
"items": {
"type": "string"
},
"default": null
},
"dependencyDashboard": {
"description": "Whether to create a \"Dependency Dashboard\" issue in the repository.",
"type": "boolean",
"default": false
},
"dependencyDashboardApproval": {
"description": "Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.",
"type": "boolean",
"default": false
},
"dependencyDashboardAutoclose": {
"description": "Set to `true` to let Renovate close the Dependency Dashboard issue if there are no more updates.",
"type": "boolean",
"default": false
},
"dependencyDashboardFooter": {
"description": "Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.",
"type": "string"
},
"dependencyDashboardHeader": {
"description": "Any text added here will be placed first in the Dependency Dashboard issue body.",
"type": "string",
"default": "This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more."
},
"dependencyDashboardLabels": {
"description": "These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.",
"type": "array",
"items": {
"type": "string"
},
"default": null
},
"dependencyDashboardOSVVulnerabilitySummary": {
"description": "Control if the Dependency Dashboard issue lists CVEs supplied by [osv.dev](https://osv.dev).",
"type": "string",
"enum": [
"none",
"all",
"unresolved"
],
"default": "none"
},
"dependencyDashboardTitle": {
"description": "Title for the Dependency Dashboard issue.",
"type": "string",
"default": "Dependency Dashboard"
},
"deps-edn": {
"description": "Configuration object for the deps-edn manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)(?:deps|bb)\\.edn$"
],
"versioning": "maven"
},
"$ref": "#"
},
"description": {
"description": "Plain text description for a config or preset.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"detectGlobalManagerConfig": {
"description": "If `true`, Renovate tries to detect global manager configuration from the file system.",
"type": "boolean",
"default": false
},
"detectHostRulesFromEnv": {
"description": "If `true`, Renovate tries to detect host rules from environment variables.",
"type": "boolean",
"default": false
},
"digest": {
"description": "Configuration to apply when updating a digest (no change in tag/version).",
"type": "object",
"default": {
"branchTopic": "{{{depNameSanitized}}}-digest",
"commitMessageExtra": "to {{newDigestShort}}",
"commitMessageTopic": "{{{depName}}} digest"
},
"$ref": "#"
},
"docker-compose": {
"description": "Configuration object for the docker-compose manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)(?:docker-)?compose[^/]*\\.ya?ml$"
]
},
"$ref": "#"
},
"dockerChildPrefix": {
"description": "Change this value to add a prefix to the Renovate Docker sidecar container names and labels.",
"type": "string",
"default": "renovate_"
},
"dockerCliOptions": {
"description": "Pass CLI flags to `docker run` command when `binarySource=docker`.",
"type": "string"
},
"dockerSidecarImage": {
"description": "Change this value to override the default Renovate sidecar image.",
"type": "string",
"default": "ghcr.io/containerbase/sidecar:9.17.1"
},
"dockerUser": {
"description": "Set the `UID` and `GID` for Docker-based binaries if you use `binarySource=docker`.",
"type": "string"
},
"dockerfile": {
"description": "Configuration object for the dockerfile manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$",
"(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$"
]
},
"$ref": "#"
},
"draftPR": {
"description": "If set to `true` then Renovate creates draft PRs, instead of normal status PRs.",
"type": "boolean",
"default": false
},
"droneci": {
"description": "Configuration object for the droneci manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.drone\\.yml$"
]
},
"$ref": "#"
},
"dryRun": {
"description": "If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs.",
"type": "string",
"enum": [
"extract",
"lookup",
"full"
],
"default": null
},
"enabled": {
"description": "Enable or disable Renovate bot.",
"type": "boolean"
},
"enabledManagers": {
"description": "A list of package managers to enable. Only managers on the list are enabled.",
"type": "array",
"items": {
"type": "string"
}
},
"encrypted": {
"description": "An object containing configuration encrypted with project key.",
"type": "object",
"default": null,
"$ref": "#"
},
"endpoint": {
"description": "Custom endpoint to use.",
"type": "string",
"default": null
},
"excludeCommitPaths": {
"description": "A file matching any of these glob patterns will not be committed, even if the file has been updated.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"executionTimeout": {
"description": "Default execution timeout in minutes for child processes Renovate creates.",
"type": "integer",
"default": 15
},
"exposeAllEnv": {
"description": "Set this to `true` to allow passing of all environment variables to package managers.",
"type": "boolean",
"default": false
},
"extends": {
"description": "Configuration presets to use or extend.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"extractVersion": {
"description": "A regex (`re2`) to extract a version from a datasource's raw version string.",
"type": "string",
"format": "regex"
},
"fetchReleaseNotes": {
"description": "Controls if and when release notes are fetched.",
"type": "string",
"enum": [
"off",
"branch",
"pr"
],
"default": "pr"
},
"fileMatch": {
"description": "RegEx (`re2`) pattern for matching manager files.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
{
"type": "string",
"format": "regex"
}
]
},
"filterUnavailableUsers": {
"description": "Filter reviewers and assignees based on their availability.",
"type": "boolean",
"default": false
},
"fleet": {
"description": "Configuration object for the fleet manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)fleet\\.ya?ml"
]
},
"$ref": "#"
},
"flux": {
"description": "Configuration object for the flux manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)flux-system/(?:.+/)?gotk-components\\.ya?ml$"
]
},
"$ref": "#"
},
"followTag": {
"description": "If defined, packages will follow this release tag exactly.",
"type": "string"
},
"force": {
"description": "Any configuration set in this object will force override existing settings.",
"type": "object",
"$ref": "#"
},
"forceCli": {
"description": "Decides if CLI configuration options are moved to the `force` config section.",
"type": "boolean",
"default": true
},
"forkModeDisallowMaintainerEdits": {
"description": "Disallow maintainers to push to Renovate pull requests when running in fork mode.",
"type": "boolean",
"default": false
},
"forkOrg": {
"description": "The preferred organization to create or find forked repositories, when in fork mode.",
"type": "string"
},
"forkProcessing": {
"description": "Whether to process forked repositories. By default, all forked repositories are skipped when in `autodiscover` mode.",
"type": "string",
"enum": [
"auto",
"enabled",
"disabled"
],
"default": "auto"
},
"forkToken": {
"description": "Set a personal access token here to enable \"fork mode\".",
"type": "string"
},
"fvm": {
"description": "Configuration object for the fvm manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.fvm/fvm_config\\.json$"
],
"versioning": "semver"
},
"$ref": "#"
},
"git-submodules": {
"description": "Configuration object for the git-submodules manager",
"type": "object",
"default": {
"enabled": false,
"versioning": "git",
"fileMatch": [
"(^|/)\\.gitmodules$"
]
},
"$ref": "#"
},
"gitAuthor": {
"description": "Author to use for Git commits. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).",
"type": "string"
},
"gitIgnoredAuthors": {
"description": "Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).",
"type": "array",
"items": {
"type": "string"
}
},
"gitLabIgnoreApprovals": {
"description": "Ignore approval rules for MRs created by Renovate, which is useful for automerge.",
"type": "boolean",
"default": false
},
"gitNoVerify": {
"description": "Which Git commands will be run with the `--no-verify` option.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"commit",
"push"
]
}
},
{
"type": "string",
"enum": [
"commit",
"push"
]
}
],
"default": [
"commit",
"push"
]
},
"gitPrivateKey": {
"description": "PGP key to use for signing Git commits.",
"type": "string"
},
"gitTimeout": {
"description": "Configure the timeout with a number of milliseconds to wait for a Git task.",
"type": "integer",
"default": 0
},
"gitUrl": {
"description": "Overrides the default resolution for Git remote, e.g. to switch GitLab from HTTPS to SSH-based.",
"type": "string",
"enum": [
"default",
"ssh",
"endpoint"
],
"default": "default"
},
"github-actions": {
"description": "Configuration object for the github-actions manager",
"type": "object",
"default": {
"fileMatch": [
"^(workflow-templates|\\.github/workflows)/[^/]+\\.ya?ml$",
"(^|/)action\\.ya?ml$"
]
},
"$ref": "#"
},
"githubTokenWarn": {
"description": "Display warnings about GitHub token not being set.",
"type": "boolean",
"default": true
},
"gitlabci": {
"description": "Configuration object for the gitlabci manager",
"type": "object",
"default": {
"fileMatch": [
"\\.gitlab-ci\\.ya?ml$"
]
},
"$ref": "#"
},
"gitlabci-include": {
"description": "Configuration object for the gitlabci-include manager",
"type": "object",
"default": {
"fileMatch": [
"\\.gitlab-ci\\.ya?ml$"
]
},
"$ref": "#"
},
"globalExtends": {
"description": "Configuration presets to use or extend for a self-hosted config.",
"type": "array",
"items": {
"type": "string"
}
},
"goGetDirs": {
"description": "Directory pattern to run `go get` on",
"type": "array",
"items": {
"type": "string"
},
"default": [
"./..."
]
},
"gomod": {
"description": "Configuration object for the gomod manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)go\\.mod$"
],
"pinDigests": false
},
"$ref": "#"
},
"gradle": {
"description": "Configuration object for the gradle manager",
"type": "object",
"default": {
"fileMatch": [
"\\.gradle(\\.kts)?$",
"(^|/)gradle\\.properties$",
"(^|/)gradle/.+\\.toml$",
"(^|/)buildSrc/.+\\.kt$",
"\\.versions\\.toml$",
"(^|/)versions.props$",
"(^|/)versions.lock$"
],
"timeout": 600,
"versioning": "gradle"
},
"$ref": "#"
},
"gradle-wrapper": {
"description": "Configuration object for the gradle-wrapper manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)gradle/wrapper/gradle-wrapper\\.properties$"
],
"versioning": "gradle"
},
"$ref": "#"
},
"group": {
"description": "Config if `groupName` is enabled.",
"type": "object",
"default": {
"branchTopic": "{{{groupSlug}}}",
"commitMessageTopic": "{{{groupName}}}"
},
"$ref": "#"
},
"groupName": {
"description": "Human understandable name for the dependency group.",
"type": "string",
"default": null
},
"groupSlug": {
"description": "Slug to use for group (e.g. in branch name). Slug is calculated from `groupName` if `null`.",
"type": "string",
"default": null
},
"hashedBranchLength": {
"description": "If enabled, branch names will use a hashing function to ensure each branch has that length.",
"type": "integer",
"default": null
},
"helm-requirements": {
"description": "Configuration object for the helm-requirements manager",
"type": "object",
"default": {
"registryAliases": {
"stable": "https://charts.helm.sh/stable"
},
"commitMessageTopic": "helm chart {{depName}}",
"fileMatch": [
"(^|/)requirements\\.ya?ml$"
]
},
"$ref": "#"
},
"helm-values": {
"description": "Configuration object for the helm-values manager",
"type": "object",
"default": {
"commitMessageTopic": "helm values {{depName}}",
"fileMatch": [
"(^|/)values\\.ya?ml$"
],
"pinDigests": false
},
"$ref": "#"
},
"helmfile": {
"description": "Configuration object for the helmfile manager",
"type": "object",
"default": {
"registryAliases": {
"stable": "https://charts.helm.sh/stable"
},
"commitMessageTopic": "helm chart {{depName}}",
"fileMatch": [
"(^|/)helmfile\\.ya?ml$"
]
},
"$ref": "#"
},
"helmsman": {
"description": "Configuration object for the helmsman manager",
"type": "object",
"default": {
"fileMatch": []
},
"$ref": "#"
},
"helmv3": {
"description": "Configuration object for the helmv3 manager",
"type": "object",
"default": {
"registryAliases": {
"stable": "https://charts.helm.sh/stable"
},
"commitMessageTopic": "helm chart {{depName}}",
"fileMatch": [
"(^|/)Chart\\.ya?ml$"
]
},
"$ref": "#"
},
"hermit": {
"description": "Configuration object for the hermit manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)bin/hermit$"
],
"excludeCommitPaths": [
"**/bin/hermit"
],
"versioning": "hermit"
},
"$ref": "#"
},
"homebrew": {
"description": "Configuration object for the homebrew manager",
"type": "object",
"default": {
"commitMessageTopic": "Homebrew Formula {{depName}}",
"fileMatch": [
"^Formula/[^/]+[.]rb$"
]
},
"$ref": "#"
},
"hostRules": {
"description": "Host rules/configuration including credentials.",
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A custom description for this configuration object"
},
"abortIgnoreStatusCodes": {
"description": "A list of HTTP status codes safe to ignore even when `abortOnError=true`.",
"type": "array",
"items": {
"type": "number"
}
},
"abortOnError": {
"description": "If enabled, Renovate aborts its run when HTTP request errors occur.",
"type": "boolean",
"default": false
},
"artifactAuth": {
"description": "A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`",
"type": "array",
"items": {
"type": "string",
"enum": [
"composer"
]
},
"default": null
},
"authType": {
"description": "Authentication type for HTTP header. e.g. `\"Bearer\"` or `\"Basic\"`. Use `\"Token-Only\"` to use only the token without an authorization type.",
"type": "string",
"default": "Bearer"
},
"concurrentRequestLimit": {
"description": "Limit concurrent requests per host.",
"type": "integer",
"default": null
},
"dnsCache": {
"description": "Enable got DNS cache.",
"type": "boolean",
"default": false
},
"enableHttp2": {
"description": "Enable got HTTP/2 support.",
"type": "boolean",
"default": false
},
"hostType": {
"description": "hostType for a package rule. Can be a platform name or a datasource name.",
"type": "string"
},
"insecureRegistry": {
"description": "Explicitly turn on insecure Docker registry access (HTTP).",
"type": "boolean"
},
"keepalive": {
"description": "Enable HTTP keepalives for hosts.",
"type": "boolean",
"default": false
},
"matchHost": {
"description": "A domain name, host name or base URL to match against.",
"type": "string"
},
"maxRequestsPerSecond": {
"description": "Limit requests rate per host.",
"type": "integer",
"default": 0
},
"timeout": {
"description": "Timeout (in milliseconds) for queries to external endpoints.",
"type": "integer"
}
}
}
]
},
"default": [
{
"timeout": 60000
}
]
},
"html": {
"description": "Configuration object for the html manager",
"type": "object",
"default": {
"fileMatch": [
"\\.html?$"
],
"versioning": "semver",
"digest": {
"enabled": false
},
"pinDigests": false
},
"$ref": "#"
},
"ignoreDeprecated": {
"description": "Avoid upgrading from a non-deprecated version to a deprecated one.",
"type": "boolean",
"default": true
},
"ignoreDeps": {
"description": "Dependencies to ignore.",
"type": "array",
"items": {
"type": "string"
}
},
"ignorePaths": {
"description": "Skip any package file whose path matches one of these. Can be a string or glob pattern.",
"type": "array",
"items": {
"type": "string"
},
"default": [
"**/node_modules/**",
"**/bower_components/**"
]
},
"ignorePlugins": {
"description": "Set this to `true` if `allowPlugins=true` but you wish to skip running plugins when updating lock files.",
"type": "boolean",
"default": false
},
"ignorePrAuthor": {
"description": "Set to `true` to fetch the entire list of PRs instead of only those authored by the Renovate user.",
"type": "boolean",
"default": false
},
"ignorePresets": {
"description": "A list of presets to ignore, including any that are nested inside an `extends` array.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"ignoreReviewers": {
"description": "Reviewers to be ignored in PR reviewers presence (either username or email address depending on the platform).",
"type": "array",
"items": {
"type": "string"
}
},
"ignoreScripts": {
"description": "Set this to `false` if `allowScripts=true` and you wish to run scripts when updating lock files.",
"type": "boolean",
"default": true
},
"ignoreTests": {
"description": "Set to `true` to enable automerging without tests.",
"type": "boolean",
"default": false
},
"ignoreUnstable": {
"description": "Ignore versions with unstable SemVer.",
"type": "boolean"
},
"includeMirrors": {
"description": "Whether to process repositories that are mirrors. By default, repositories that are mirrors are skipped.",
"type": "boolean",
"default": false
},
"includePaths": {
"description": "Include package files only within these defined paths.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"internalChecksAsSuccess": {
"description": "Whether to consider passing internal checks such as `minimumReleaseAge` when determining branch status.",
"type": "boolean",
"default": false
},
"internalChecksFilter": {
"description": "When and how to filter based on internal checks.",
"type": "string",
"enum": [
"strict",
"flexible",
"none"
],
"default": "strict"
},
"jenkins": {
"description": "Configuration object for the jenkins manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)plugins\\.(txt|ya?ml)$"
]
},
"$ref": "#"
},
"jsonnet-bundler": {
"description": "Configuration object for the jsonnet-bundler manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)jsonnetfile\\.json$"
],
"datasource": "git-tags"
},
"$ref": "#"
},
"kotlin-script": {
"description": "Configuration object for the kotlin-script manager",
"type": "object",
"default": {
"fileMatch": [
"^.+\\.main\\.kts$"
]
},
"$ref": "#"
},
"kubernetes": {
"description": "Configuration object for the kubernetes manager",
"type": "object",
"default": {
"fileMatch": []
},
"$ref": "#"
},
"kustomize": {
"description": "Configuration object for the kustomize manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)kustomization\\.ya?ml$"
],
"pinDigests": false
},
"$ref": "#"
},
"labels": {
"description": "Labels to set in Pull Request.",
"type": "array",
"items": {
"type": "string"
}
},
"leiningen": {
"description": "Configuration object for the leiningen manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)project\\.clj$"
],
"versioning": "maven"
},
"$ref": "#"
},
"lockFileMaintenance": {
"description": "Configuration for lock file maintenance.",
"type": "object",
"default": {
"enabled": false,
"recreateWhen": "always",
"rebaseStalePrs": true,
"branchTopic": "lock-file-maintenance",
"commitMessageAction": "Lock file maintenance",
"commitMessageTopic": null,
"commitMessageExtra": null,
"schedule": [
"before 4am on monday"
],
"groupName": null,
"prBodyDefinitions": {
"Change": "All locks refreshed"
}
},
"$ref": "#"
},
"logContext": {
"description": "Add a global or per-repo log context to each log entry.",
"type": "string",
"default": null
},
"logFile": {
"description": "Log file path.",
"type": "string"
},
"logFileLevel": {
"description": "Set the log file log level.",
"type": "string",
"default": "debug"
},
"major": {
"description": "Configuration to apply when an update type is `major`.",
"type": "object",
"default": {},
"$ref": "#"
},
"maven": {
"description": "Configuration object for the maven manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/|\\.)pom\\.xml$",
"^(((\\.mvn)|(\\.m2))/)?settings\\.xml$"
],
"versioning": "maven"
},
"$ref": "#"
},
"maven-wrapper": {
"description": "Configuration object for the maven-wrapper manager",
"type": "object",
"default": {
"fileMatch": [
"(^|\\/).mvn/wrapper/maven-wrapper.properties$"
],
"versioning": "maven"
},
"$ref": "#"
},
"meteor": {
"description": "Configuration object for the meteor manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)package\\.js$"
]
},
"$ref": "#"
},
"migratePresets": {
"description": "Define presets here which have been removed or renamed and should be migrated automatically.",
"type": "object",
"default": {},
"additionalProperties": {
"type": "string"
},
"$ref": "#"
},
"minimumReleaseAge": {
"description": "Time required before a new release is considered stable.",
"type": "string",
"default": null
},
"minor": {
"description": "Configuration to apply when an update type is `minor`.",
"type": "object",
"default": {},
"$ref": "#"
},
"mint": {
"description": "Configuration object for the mint manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)Mintfile$"
]
},
"$ref": "#"
},
"mix": {
"description": "Configuration object for the mix manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)mix\\.exs$"
],
"versioning": "hex"
},
"$ref": "#"
},
"nix": {
"description": "Configuration object for the nix manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)flake\\.nix$"
],
"commitMessageTopic": "nixpkgs",
"commitMessageExtra": "to {{newValue}}",
"enabled": false
},
"$ref": "#"
},
"nodenv": {
"description": "Configuration object for the nodenv manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.node-version$"
],
"versioning": "node"
},
"$ref": "#"
},
"npm": {
"description": "Configuration object for the npm manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)package\\.json$"
],
"versioning": "npm",
"digest": {
"prBodyDefinitions": {
"Change": "{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}"
}
},
"prBodyDefinitions": {
"Change": "[{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}})"
}
},
"$ref": "#"
},
"npmToken": {
"description": "npm token used to authenticate with the default registry.",
"type": "string"
},
"npmrc": {
"description": "String copy of `.npmrc` file. Use `\\n` instead of line breaks.",
"type": "string"
},
"npmrcMerge": {
"description": "Whether to merge `config.npmrc` with repo `.npmrc` content if both are found.",
"type": "boolean",
"default": false
},
"nuget": {
"description": "Configuration object for the nuget manager",
"type": "object",
"default": {
"fileMatch": [
"\\.(?:cs|fs|vb)proj$",
"\\.(?:props|targets)$",
"(^|/)dotnet-tools\\.json$",
"(^|/)global\\.json$"
]
},
"$ref": "#"
},
"nvm": {
"description": "Configuration object for the nvm manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.nvmrc$"
],
"versioning": "node",
"pinDigests": false
},
"$ref": "#"
},
"onboarding": {
"description": "Require a Configuration PR first.",
"type": "boolean"
},
"onboardingBranch": {
"description": "Change this value to override the default onboarding branch name.",
"type": "string",
"default": "renovate/configure"
},
"onboardingCommitMessage": {
"description": "Change this value to override the default onboarding commit message.",
"type": "string",
"default": null
},
"onboardingConfig": {
"description": "Configuration to use for onboarding PRs.",
"type": "object",
"default": {
"$schema": "https://docs.renovatebot.com/renovate-schema.json"
},
"$ref": "#"
},
"onboardingConfigFileName": {
"description": "Change this value to override the default onboarding config file name.",
"type": "string",
"default": "renovate.json"
},
"onboardingNoDeps": {
"description": "Onboard the repository even if no dependencies are found.",
"type": "boolean",
"default": false
},
"onboardingPrTitle": {
"description": "Change this value to override the default onboarding PR title.",
"type": "string",
"default": "Configure Renovate"
},
"onboardingRebaseCheckbox": {
"description": "Set to enable rebase/retry markdown checkbox for onboarding PRs.",
"type": "boolean",
"default": false
},
"optimizeForDisabled": {
"description": "Set to `true` to perform a check for disabled config prior to cloning.",
"type": "boolean",
"default": false
},
"osgi": {
"description": "Configuration object for the osgi manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)src/main/features/.+\\.json$"
]
},
"$ref": "#"
},
"osvVulnerabilityAlerts": {
"description": "Use vulnerability alerts from `osv.dev`.",
"type": "boolean",
"default": false
},
"packageRules": {
"description": "Rules for matching packages.",
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A custom description for this configuration object"
},
"allowedVersions": {
"description": "A version range or regex pattern capturing allowed versions for dependencies.",
"type": "string"
},
"customChangelogUrl": {
"description": "If set, Renovate will use this URL to fetch changelogs for a matched dependency. Valid only within a `packageRules` object.",
"type": "string"
},
"excludeDepNames": {
"description": "Dep names to exclude. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"excludeDepPatterns": {
"description": "Dep name patterns to exclude. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
{
"type": "string",
"format": "regex"
}
]
},
"excludePackageNames": {
"description": "Package names to exclude. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"excludePackagePatterns": {
"description": "Package name patterns to exclude. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
{
"type": "string",
"format": "regex"
}
]
},
"excludePackagePrefixes": {
"description": "Package name prefixes to exclude. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"excludeRepositories": {
"description": "List of repositories to exclude (e.g. `[\"**/*-archived\"]`). Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchBaseBranches": {
"description": "List of strings containing exact matches (e.g. `[\"main\"]`) and/or regex expressions (e.g. `[\"/^release/.*/\"]`). Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchCategories": {
"description": "List of categories to match (for example: `[\"python\"]`). Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchConfidence": {
"description": "Merge confidence levels to match against (`low`, `neutral`, `high`, `very high`). Valid only within `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"low",
"neutral",
"high",
"very high"
]
}
},
{
"type": "string",
"enum": [
"low",
"neutral",
"high",
"very high"
]
}
]
},
"matchCurrentValue": {
"description": "A regex to match against the raw `currentValue` string of a dependency. Valid only within a `packageRules` object.",
"type": "string"
},
"matchCurrentVersion": {
"description": "A version or range of versions to match against the current version of a package. Valid only within a `packageRules` object.",
"type": "string"
},
"matchDatasources": {
"description": "List of datasources to match (e.g. `[\"orb\"]`). Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchDepNames": {
"description": "Dep names to match. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchDepPatterns": {
"description": "Dep name patterns to match. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
{
"type": "string",
"format": "regex"
}
]
},
"matchDepTypes": {
"description": "List of depTypes to match (e.g. [`peerDependencies`]). Valid only within `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchFileNames": {
"description": "List of strings to do an exact match against package and lock files with full path. Only works inside a `packageRules` object.",
"type": "array",
"items": {
"type": "string"
}
},
"matchManagers": {
"description": "List of package managers to match (e.g. `[\"pipenv\"]`). Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchPackageNames": {
"description": "Package names to match. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchPackagePatterns": {
"description": "Package name patterns to match. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
{
"type": "string",
"format": "regex"
}
]
},
"matchPackagePrefixes": {
"description": "Package name prefixes to match. Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchRepositories": {
"description": "List of repositories to match (e.g. `[\"**/*-archived\"]`). Valid only within a `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchSourceUrlPrefixes": {
"description": "A list of source URL prefixes to match against, commonly used to group monorepos or packages from the same organization.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchSourceUrls": {
"description": "A list of source URLs to exact match against.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"matchUpdateTypes": {
"description": "Update types to match against (`major`, `minor`, `pin`, `pinDigest`, etc). Valid only within `packageRules` object.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"major",
"minor",
"patch",
"pin",
"pinDigest",
"digest",
"lockFileMaintenance",
"rollback",
"bump",
"replacement"
]
}
},
{
"type": "string",
"enum": [
"major",
"minor",
"patch",
"pin",
"pinDigest",
"digest",
"lockFileMaintenance",
"rollback",
"bump",
"replacement"
]
}
]
},
"replacementName": {
"description": "The name of the new dependency that replaces the old deprecated dependency.",
"type": "string"
},
"replacementNameTemplate": {
"description": "Controls what the replacement package name.",
"type": "string",
"default": "{{{packageName}}}"
},
"replacementVersion": {
"description": "The version of the new dependency that replaces the old deprecated dependency.",
"type": "string"
}
}
}
]
}
},
"password": {
"description": "Password for authentication.",
"type": "string"
},
"patch": {
"description": "Configuration to apply when an update type is `patch`.",
"type": "object",
"default": {},
"$ref": "#"
},
"pep621": {
"description": "Configuration object for the pep621 manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)pyproject\\.toml$"
]
},
"$ref": "#"
},
"persistRepoData": {
"description": "If set to `true`: keep repository data between runs instead of deleting the data.",
"type": "boolean",
"default": false
},
"pin": {
"description": "Configuration to apply when an update type is `pin`.",
"type": "object",
"default": {
"rebaseWhen": "behind-base-branch",
"groupName": "Pin Dependencies",
"groupSlug": "pin-dependencies",
"commitMessageAction": "Pin",
"group": {
"commitMessageTopic": "dependencies",
"commitMessageExtra": ""
}
},
"$ref": "#"
},
"pinDigest": {
"description": "Configuration to apply when pinning a digest (no change in tag/version).",
"type": "object",
"default": {
"groupName": "Pin Dependencies",
"groupSlug": "pin-dependencies",
"commitMessageAction": "Pin",
"group": {
"commitMessageTopic": "dependencies",
"commitMessageExtra": ""
}
},
"$ref": "#"
},
"pinDigests": {
"description": "Whether to add digests to Dockerfile source images.",
"type": "boolean",
"default": false
},
"pip-compile": {
"description": "Configuration object for the pip-compile manager",
"type": "object",
"default": {
"fileMatch": [],
"lockFileMaintenance": {
"enabled": true,
"branchTopic": "pip-compile-refresh",
"commitMessageAction": "Refresh pip-compile outputs"
}
},
"$ref": "#"
},
"pip_requirements": {
"description": "Configuration object for the pip_requirements manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)[\\w-]*requirements(-\\w+)?\\.(txt|pip)$"
]
},
"$ref": "#"
},
"pip_setup": {
"description": "Configuration object for the pip_setup manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)setup\\.py$"
]
},
"$ref": "#"
},
"pipenv": {
"description": "Configuration object for the pipenv manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)Pipfile$"
]
},
"$ref": "#"
},
"platform": {
"description": "Platform type of repository.",
"type": "string",
"enum": [
"azure",
"bitbucket",
"bitbucket-server",
"codecommit",
"gitea",
"github",
"gitlab",
"local"
],
"default": "github"
},
"platformAutomerge": {
"description": "Controls if platform-native auto-merge is used.",
"type": "boolean",
"default": true
},
"platformCommit": {
"description": "Use platform API to perform commits instead of using Git directly.",
"type": "boolean",
"default": false
},
"poetry": {
"description": "Configuration object for the poetry manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)pyproject\\.toml$"
]
},
"$ref": "#"
},
"postUpdateOptions": {
"description": "Enable post-update options to be run after package/artifact updating.",
"type": "array",
"items": {
"type": "string",
"enum": [
"bundlerConservative",
"gomodMassage",
"gomodTidy",
"gomodTidy1.17",
"gomodTidyE",
"gomodUpdateImportPaths",
"helmUpdateSubChartArchives",
"npmDedupe",
"pnpmDedupe",
"yarnDedupeFewer",
"yarnDedupeHighest"
]
},
"default": []
},
"postUpgradeTasks": {
"description": "Post-upgrade tasks that are executed before a commit is made by Renovate.",
"type": "object",
"default": {
"commands": [],
"fileFilters": [],
"executionMode": "update"
},
"$ref": "#",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A custom description for this configuration object"
},
"commands": {
"description": "A list of post-upgrade commands that are executed before a commit is made by Renovate.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"executionMode": {
"description": "Controls when the post upgrade tasks run: on every update, or once per upgrade branch.",
"type": "string",
"enum": [
"update",
"branch"
],
"default": "update"
},
"fileFilters": {
"description": "Files that match the glob pattern will be committed after running a post-upgrade task.",
"type": "array",
"items": {
"type": "string"
},
"default": [
"**/*"
]
}
}
}
]
}
},
"prBodyColumns": {
"description": "List of columns to use in PR bodies.",
"type": "array",
"items": {
"type": "string"
},
"default": [
"Package",
"Type",
"Update",
"Change",
"Pending"
]
},
"prBodyDefinitions": {
"description": "Table column definitions to use in PR tables.",
"type": "object",
"default": {
"Package": "{{{depNameLinked}}}",
"Type": "{{{depType}}}",
"Update": "{{{updateType}}}",
"Current value": "{{{currentValue}}}",
"New value": "{{{newValue}}}",
"Change": "`{{{displayFrom}}}` -> `{{{displayTo}}}`",
"Pending": "{{{displayPending}}}",
"References": "{{{references}}}",
"Package file": "{{{packageFile}}}",
"Age": "[](https://docs.renovatebot.com/merge-confidence/)",
"Adoption": "[](https://docs.renovatebot.com/merge-confidence/)",
"Passing": "[](https://docs.renovatebot.com/merge-confidence/)",
"Confidence": "[](https://docs.renovatebot.com/merge-confidence/)"
}
},
"prBodyNotes": {
"description": "List of extra notes or templates to include in the Pull Request body.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"default": []
},
"prBodyTemplate": {
"description": "Pull Request body template. Controls which sections are rendered in the body of the pull request.",
"type": "string",
"default": "{{{header}}}{{{table}}}{{{warnings}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}"
},
"prCommitsPerRunLimit": {
"description": "Set the maximum number of commits per Renovate run. By default there is no limit.",
"type": "integer",
"default": 0
},
"prConcurrentLimit": {
"description": "Limit to a maximum of x concurrent branches/PRs. 0 means no limit.",
"type": "integer",
"default": 10
},
"prCreation": {
"description": "When to create the PR for a branch.",
"type": "string",
"enum": [
"immediate",
"not-pending",
"status-success",
"approval"
],
"default": "immediate"
},
"prFooter": {
"description": "Text added here will be placed last in the PR body, with a divider separator before it.",
"type": "string",
"default": "This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate)."
},
"prHeader": {
"description": "Text added here will be placed first in the PR body.",
"type": "string"
},
"prHourlyLimit": {
"description": "Rate limit PRs to maximum x created per hour. 0 means no limit.",
"type": "integer",
"default": 2
},
"prNotPendingHours": {
"description": "Timeout in hours for when `prCreation=not-pending`.",
"type": "integer",
"default": 25
},
"prPriority": {
"description": "Set sorting priority for PR creation. PRs with higher priority are created first, negative priority last.",
"type": "integer",
"default": 0
},
"prTitle": {
"description": "Pull Request title template (deprecated). Inherits from `commitMessage` if null.",
"type": "string",
"default": null
},
"prTitleStrict": {
"description": "Whether to bypass appending extra context to the Pull Request title.",
"type": "boolean",
"default": false
},
"pre-commit": {
"description": "Configuration object for the pre-commit manager",
"type": "object",
"default": {
"commitMessageTopic": "pre-commit hook {{depName}}",
"enabled": false,
"fileMatch": [
"(^|/)\\.pre-commit-config\\.ya?ml$"
],
"prBodyNotes": [
"Note: The `pre-commit` manager in Renovate is not supported by the `pre-commit` maintainers or community. Please do not report any problems there, instead [create a Discussion in the Renovate repository](https://github.com/renovatebot/renovate/discussions/new) if you have any questions."
]
},
"$ref": "#"
},
"printConfig": {
"description": "If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets.",
"type": "boolean",
"default": false
},
"privateKey": {
"description": "Server-side private key.",
"type": "string"
},
"privateKeyOld": {
"description": "Secondary or old private key to try.",
"type": "string"
},
"privateKeyPath": {
"description": "Path to the Server-side private key.",
"type": "string"
},
"privateKeyPathOld": {
"description": "Path to the Server-side old private key.",
"type": "string"
},
"productLinks": {
"description": "Links which are used in PRs, issues and comments.",
"type": "object",
"default": {
"documentation": "https://docs.renovatebot.com/",
"help": "https://github.com/renovatebot/renovate/discussions",
"homepage": "https://github.com/renovatebot/renovate"
},
"additionalProperties": {
"type": "string",
"format": "uri"
},
"$ref": "#"
},
"pruneBranchAfterAutomerge": {
"description": "Set to `true` to enable branch pruning after automerging.",
"type": "boolean",
"default": true
},
"pruneStaleBranches": {
"description": "Set to `false` to disable pruning stale branches.",
"type": "boolean",
"default": true
},
"pub": {
"description": "Configuration object for the pub manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)pubspec\\.ya?ml$"
],
"versioning": "npm"
},
"$ref": "#"
},
"puppet": {
"description": "Configuration object for the puppet manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)Puppetfile$"
]
},
"$ref": "#"
},
"pyenv": {
"description": "Configuration object for the pyenv manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.python-version$"
],
"versioning": "docker"
},
"$ref": "#"
},
"rangeStrategy": {
"description": "Determines how to modify or update existing ranges.",
"type": "string",
"enum": [
"auto",
"pin",
"bump",
"replace",
"widen",
"update-lockfile",
"in-range-only"
],
"default": "auto"
},
"rebaseLabel": {
"description": "Label to request a rebase from Renovate bot.",
"type": "string",
"default": "rebase"
},
"rebaseWhen": {
"description": "Controls when Renovate rebases an existing branch.",
"type": "string",
"enum": [
"auto",
"never",
"conflicted",
"behind-base-branch"
],
"default": "auto"
},
"recreateWhen": {
"description": "Recreate PRs even if same ones were closed previously.",
"type": "string",
"enum": [
"auto",
"always",
"never"
],
"default": "auto"
},
"redisUrl": {
"description": "If set, this Redis URL will be used for caching instead of the file system.",
"type": "string"
},
"regex": {
"description": "Configuration object for the regex manager",
"type": "object",
"default": {
"pinDigests": false
},
"$ref": "#"
},
"regexManagers": {
"description": "Custom managers using regex matching.",
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A custom description for this configuration object"
},
"autoReplaceStringTemplate": {
"description": "Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"currentValueTemplate": {
"description": "Optional `currentValue` for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"customType": {
"description": "Custom manager to use. Valid only within a `regexManagers` object.",
"type": "string",
"enum": [
"regex"
]
},
"datasourceTemplate": {
"description": "Optional datasource for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"depNameTemplate": {
"description": "Optional depName for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"depTypeTemplate": {
"description": "Optional `depType` for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"extractVersionTemplate": {
"description": "Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"matchStrings": {
"description": "Regex capture rule to use. Valid only within a `regexManagers` object.",
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
"matchStringsStrategy": {
"description": "Strategy how to interpret matchStrings.",
"type": "string",
"enum": [
"any",
"recursive",
"combination"
],
"default": "any"
},
"packageNameTemplate": {
"description": "Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `regexManagers` object.",
"type": "string"
},
"registryUrlTemplate": {
"description": "Optional registry URL for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
},
"versioningTemplate": {
"description": "Optional versioning for extracted dependencies. Valid only within a `regexManagers` object.",
"type": "string"
}
}
}
]
},
"default": []
},
"registryAliases": {
"description": "Aliases for registries.",
"type": "object",
"default": {},
"additionalProperties": {
"type": "string",
"format": "uri"
},
"$ref": "#"
},
"registryUrls": {
"description": "List of URLs to try for dependency lookup. Package manager specific.",
"type": "array",
"items": {
"type": "string"
},
"default": null
},
"replacement": {
"description": "Configuration to apply when replacing a dependency.",
"type": "object",
"default": {
"branchTopic": "{{{depNameSanitized}}}-replacement",
"commitMessageAction": "Replace",
"commitMessageExtra": "with {{newName}} {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{#if isSingleVersion}}{{{prettyNewVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
"prBodyNotes": [
"This is a special PR that replaces `{{{depNameSanitized}}}` with the community suggested minimal stable replacement version."
]
},
"$ref": "#"
},
"repositories": {
"description": "List of Repositories.",
"type": "array",
"items": {
"type": "string"
}
},
"repositoryCache": {
"description": "This option decides if Renovate uses a JSON cache to speed up extractions.",
"type": "string",
"enum": [
"disabled",
"enabled",
"reset"
],
"default": "disabled"
},
"repositoryCacheType": {
"description": "Set the type of renovate repository cache if `repositoryCache` is enabled.",
"type": "string",
"default": "local"
},
"requireConfig": {
"description": "Controls Renovate's behavior regarding repository config files such as `renovate.json`.",
"type": "string",
"enum": [
"required",
"optional",
"ignored"
],
"default": "required"
},
"respectLatest": {
"description": "Ignore versions newer than npm \"latest\" version.",
"type": "boolean"
},
"reviewers": {
"description": "Requested reviewers for Pull Requests (either username or email address depending on the platform).",
"type": "array",
"items": {
"type": "string"
}
},
"reviewersFromCodeOwners": {
"description": "Determine reviewers based on configured code owners and changes in PR.",
"type": "boolean",
"default": false
},
"reviewersSampleSize": {
"description": "Take a random sample of given size from `reviewers`.",
"type": "integer",
"default": null
},
"rollback": {
"description": "Configuration to apply when rolling back a version.",
"type": "object",
"default": {
"branchTopic": "{{{depNameSanitized}}}-rollback",
"commitMessageAction": "Roll back",
"semanticCommitType": "fix"
},
"$ref": "#"
},
"rollbackPrs": {
"description": "Create PRs to roll back versions if the current version is not found in the registry.",
"type": "boolean",
"default": false
},
"ruby-version": {
"description": "Configuration object for the ruby-version manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.ruby-version$"
],
"versioning": "ruby"
},
"$ref": "#"
},
"sbt": {
"description": "Configuration object for the sbt manager",
"type": "object",
"default": {
"fileMatch": [
"\\.sbt$",
"project/[^/]*\\.scala$",
"project/build\\.properties$"
],
"versioning": "ivy"
},
"$ref": "#"
},
"schedule": {
"description": "Limit branch creation to these times of day or week.",
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"default": [
"at any time"
]
},
"secrets": {
"description": "Object which holds secret name/value pairs.",
"type": "object",
"default": {},
"additionalProperties": {
"type": "string"
},
"$ref": "#"
},
"semanticCommitScope": {
"description": "Commit scope to use if Semantic Commits are enabled.",
"type": "string",
"default": "deps"
},
"semanticCommitType": {
"description": "Commit type to use if Semantic Commits is enabled.",
"type": "string",
"default": "chore"
},
"semanticCommits": {
"description": "Enable Semantic Commit prefixes for commits and PR titles.",
"type": "string",
"enum": [
"auto",
"enabled",
"disabled"
],
"default": "auto"
},
"separateMajorMinor": {
"description": "If set to `false`, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.",
"type": "boolean"
},
"separateMinorPatch": {
"description": "If set to `true`, Renovate will separate `minor` and `patch` updates into separate branches.",
"type": "boolean",
"default": false
},
"separateMultipleMajor": {
"description": "If set to `true`, PRs will be raised separately for each available `major` upgrade version.",
"type": "boolean",
"default": false
},
"setup-cfg": {
"description": "Configuration object for the setup-cfg manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)setup\\.cfg$"
],
"versioning": "pep440"
},
"$ref": "#"
},
"skipInstalls": {
"description": "Skip installing modules/dependencies if lock file updating is possible without a full install.",
"type": "boolean",
"default": null
},
"stopUpdatingLabel": {
"description": "Label to make Renovate stop updating a PR.",
"type": "string",
"default": "stop-updating"
},
"suppressNotifications": {
"description": "Options to suppress various types of warnings and other notifications.",
"type": "array",
"items": {
"type": "string",
"enum": [
"artifactErrors",
"branchAutomergeFailure",
"configErrorIssue",
"dependencyLookupWarnings",
"deprecationWarningIssues",
"lockFileErrors",
"missingCredentialsError",
"onboardingClose",
"prEditedNotification",
"prIgnoreNotification"
]
},
"default": [
"deprecationWarningIssues"
]
},
"swift": {
"description": "Configuration object for the swift manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)Package\\.swift"
],
"versioning": "swift",
"pinDigests": false
},
"$ref": "#"
},
"tekton": {
"description": "Configuration object for the tekton manager",
"type": "object",
"default": {
"fileMatch": []
},
"$ref": "#"
},
"terraform": {
"description": "Configuration object for the terraform manager",
"type": "object",
"default": {
"commitMessageTopic": "Terraform {{depName}}",
"fileMatch": [
"\\.tf$"
],
"pinDigests": false
},
"$ref": "#"
},
"terraform-version": {
"description": "Configuration object for the terraform-version manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.terraform-version$"
],
"versioning": "hashicorp",
"extractVersion": "^v(?<version>.*)$"
},
"$ref": "#"
},
"terragrunt": {
"description": "Configuration object for the terragrunt manager",
"type": "object",
"default": {
"commitMessageTopic": "Terragrunt dependency {{depName}}",
"fileMatch": [
"(^|/)terragrunt\\.hcl$"
]
},
"$ref": "#"
},
"terragrunt-version": {
"description": "Configuration object for the terragrunt-version manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.terragrunt-version$"
],
"versioning": "hashicorp",
"extractVersion": "^v(?<version>.+)$"
},
"$ref": "#"
},
"tflint-plugin": {
"description": "Configuration object for the tflint-plugin manager",
"type": "object",
"default": {
"commitMessageTopic": "TFLint plugin {{depName}}",
"fileMatch": [
"\\.tflint\\.hcl$"
],
"extractVersion": "^v(?<version>.*)$"
},
"$ref": "#"
},
"timezone": {
"description": "[IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)",
"type": "string"
},
"token": {
"description": "Repository Auth Token.",
"type": "string"
},
"transitiveRemediation": {
"description": "Enable remediation of transitive dependencies.",
"type": "boolean",
"default": false
},
"travis": {
"description": "Configuration object for the travis manager",
"type": "object",
"default": {
"fileMatch": [
"^\\.travis\\.ya?ml$"
],
"major": {
"enabled": false
},
"versioning": "node"
},
"$ref": "#"
},
"unicodeEmoji": {
"description": "Enable or disable Unicode emoji.",
"type": "boolean",
"default": true
},
"updateInternalDeps": {
"description": "Whether to update internal dep versions in a monorepo. Works on Lerna or Yarn Workspaces.",
"type": "boolean",
"default": false
},
"updateLockFiles": {
"description": "Set to `false` to disable lock file updating.",
"type": "boolean"
},
"updateNotScheduled": {
"description": "Whether to update branches when not scheduled. Renovate will not create branches outside of the schedule.",
"type": "boolean"
},
"updatePinnedDependencies": {
"description": "Whether to update pinned (single version) dependencies or not.",
"type": "boolean",
"default": true
},
"useBaseBranchConfig": {
"description": "Whether to read configuration from `baseBranches` instead of only the default branch.",
"type": "string",
"enum": [
"merge",
"none"
],
"default": "none"
},
"userStrings": {
"description": "User-facing strings for the Renovate comment when a PR is closed.",
"type": "object",
"default": {
"ignoreTopic": "Renovate Ignore Notification",
"ignoreMajor": "Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for *any* future {{{newMajor}}}.x releases. But if you manually upgrade to {{{newMajor}}}.x then Renovate will re-enable `minor` and `patch` updates automatically.",
"ignoreDigest": "Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for the `{{{depName}}}` `{{{newDigestShort}}}` update again.",
"ignoreOther": "Because you closed this PR without merging, Renovate will ignore this update ({{{newValue}}}). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the `ignoreDeps` array of your Renovate config."
}
},
"username": {
"description": "Username for authentication.",
"type": "string"
},
"velaci": {
"description": "Configuration object for the velaci manager",
"type": "object",
"default": {
"fileMatch": [
"(^|/)\\.vela\\.ya?ml$"
]
},
"$ref": "#"
},
"versioning": {
"description": "Versioning to use for filtering and comparisons.",
"type": "string",
"oneOf": [
{
"enum": [
"aws-machine-image",
"azure-rest-api",
"bazel-module",
"cargo",
"composer",
"conan",
"deb",
"debian",
"docker",
"git",
"go-mod-directive",
"gradle",
"hashicorp",
"helm",
"hermit",
"hex",
"ivy",
"kubernetes-api",
"loose",
"maven",
"nixpkgs",
"node",
"npm",
"nuget",
"pep440",
"perl",
"poetry",
"python",
"redhat",
"regex",
"rez",
"ruby",
"semver",
"semver-coerced",
"swift",
"ubuntu"
]
},
{
"type": "string",
"pattern": "^regex:"
}
]
},
"vulnerabilityAlerts": {
"description": "Config to apply when a PR is needed due to a vulnerability in the existing package version.",
"type": "object",
"default": {
"groupName": null,
"schedule": [],
"dependencyDashboardApproval": false,
"minimumReleaseAge": null,
"rangeStrategy": "update-lockfile",
"commitMessageSuffix": "[SECURITY]",
"branchTopic": "{{{datasource}}}-{{{depName}}}-vulnerability",
"prCreation": "immediate"
},
"$ref": "#"
},
"woodpecker": {
"description": "Configuration object for the woodpecker manager",
"type": "object",
"default": {
"fileMatch": [
"^\\.woodpecker(?:/[^/]+)?\\.ya?ml$"
]
},
"$ref": "#"
},
"writeDiscoveredRepos": {
"description": "Writes discovered repositories to a JSON file and then exit.",
"type": "string"
}
}
}
|
esmrc.json | {
"$id": "https://json.schemastore.org/esmrc.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cjs": {
"description": "A boolean or object for toggling CJS features in ESM",
"default": true,
"oneOf": [
{
"type": "boolean",
"default": true
},
{
"type": "object",
"properties": {
"cache": {
"type": "boolean",
"description": "A boolean for storing ES modules in require.cache",
"default": true
},
"esModule": {
"type": "boolean",
"description": "A boolean for __esModule interoperability",
"default": true
},
"extensions": {
"type": "boolean",
"description": "A boolean for respecting require.extensions in ESM",
"default": true
},
"mutableNamespace": {
"type": "boolean",
"description": "A boolean for importing named exports of CJS modules",
"$comment": "https://ponyfoo.com/articles/es6-modules-in-depth#import-all-the-things",
"default": true
},
"namedExports": {
"type": "boolean",
"description": "A boolean for importing named exports of CJS modules",
"$comment": "https://ponyfoo.com/articles/es6-modules-in-depth#importing-named-exports",
"default": true
},
"paths": {
"type": "boolean",
"description": "A boolean for following CJS path rules in ESM",
"$comment": "https://github.com/nodejs/node-eps/blob/master/002-es-modules.md#432-removal-of-non-local-dependencies",
"default": true
},
"vars": {
"type": "boolean",
"description": "A boolean for __dirname, __filename, and require in ESM",
"default": true
},
"dedefault": {
"type": "boolean",
"description": "A boolean for requiring ES modules without the dangling require().default",
"default": false
},
"topLevelReturn": {
"type": "boolean",
"description": "A boolean for top-level return support",
"default": false
}
}
}
]
},
"mainFields": {
"type": "array",
"description": "An array of fields checked when importing a package",
"default": ["main"],
"uniqueItems": true,
"items": {
"type": "string",
"description": "Fields from package.json"
}
},
"mode": {
"type": "string",
"description": "A string describing the mode in which to detect ESM module files",
"default": "auto",
"oneOf": [
{
"const": "auto",
"description": "'auto' detect files with import, import.meta, export, 'use module', or .mjs as ESM",
"$comment": "https://github.com/tc39/proposal-modules-pragma"
},
{
"const": "all",
"description": "'all' files besides those with 'use script' or .cjs are treated as ESM"
},
{
"const": "strict",
"description": "'strict to treat only .mjs files as ESM"
}
]
},
"await": {
"type": "boolean",
"description": "A boolean for top-level await in modules without ESM exports. (Node 10+)",
"$comment": "https://github.com/tc39/proposal-top-level-await",
"default": false
},
"force": {
"type": "boolean",
"description": "A boolean to apply these options to all module loads",
"default": false
},
"wasm": {
"type": "boolean",
"description": "A boolean for WebAssembly module support. (Node 8+)",
"$comment": "https://nodejs.org/api/globals.html#globals_webassembly",
"default": false
},
"cache": {
"type": "boolean",
"description": "[dev] A boolean for toggling cache creation or a cache directory path",
"default": true
},
"sourceMap": {
"type": "boolean",
"description": "[dev] A boolean for including inline source maps",
"default": false
}
},
"title": "Configuration files for the esm module/package in Node.js"
}
|
host-meta.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"property": {
"type": "object",
"additionalProperties": {
"type": ["null", "string"]
}
},
"link": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"type": {
"type": "string"
},
"href": {
"type": "string"
},
"template": {
"type": "string",
"format": "uri"
},
"titles": {
"type": "object",
"properties": {
"default": {
"type": "string"
}
},
"additionalProperties": {
"type": "string"
}
},
"properties": {
"$ref": "#/definitions/property"
}
}
}
},
"id": "https://json.schemastore.org/host-meta.json",
"properties": {
"subject": {
"type": "string",
"format": "uri"
},
"expires": {
"type": "string",
"format": "date-time"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"$ref": "#/definitions/property"
},
"links": {
"type": "array",
"items": {
"$ref": "#/definitions/link"
}
}
},
"required": ["subject"],
"title": "JSON schema for host-meta files",
"type": "object"
}
|
devspace-schema.json | {
"$schema": "http://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/loft-sh/devspace/pkg/devspace/config/versions/latest/config",
"$defs": {
"Attach": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enabled can be used to enable attaching to a container"
},
"disableReplace": {
"type": "boolean",
"description": "DisableReplace prevents DevSpace from actually replacing the pod with modifications so that\nthe pod starts up correctly."
},
"disableTTY": {
"type": "boolean",
"description": "DisableTTY is used to tell DevSpace to not use a TTY connection for attaching"
}
},
"type": "object"
},
"BandwidthLimits": {
"properties": {
"download": {
"type": "integer",
"description": "Download is the download limit in kilo bytes per second"
},
"upload": {
"type": "integer",
"description": "Upload is the upload limit in kilo bytes per second"
}
},
"type": "object",
"description": "BandwidthLimits defines the struct for specifying the sync bandwidth limits"
},
"BuildKitConfig": {
"properties": {
"inCluster": {
"$ref": "#/$defs/BuildKitInClusterConfig",
"description": "InCluster if specified, DevSpace will use BuildKit to build the image within the cluster"
},
"preferMinikube": {
"type": "boolean",
"description": "PreferMinikube if false, will not try to use the minikube docker daemon to build the image"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args are additional arguments to call docker buildx build with"
},
"command": {
"items": {
"type": "string"
},
"type": "array",
"description": "Command to override the base command to create a builder and build images. Defaults to [\"docker\", \"buildx\"]"
}
},
"type": "object",
"description": "BuildKitConfig tells the DevSpace CLI to"
},
"BuildKitInClusterConfig": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name of the builder to use. If omitted, DevSpace will try to create\nor reuse a builder in the form devspace-$NAMESPACE"
},
"namespace": {
"type": "string",
"description": "Namespace where to create the builder deployment in. Defaults to the current\nactive namespace."
},
"rootless": {
"type": "boolean",
"description": "Rootless if enabled will create a rootless builder deployment."
},
"image": {
"type": "string",
"description": "Image is the docker image to use for the BuildKit deployment"
},
"nodeSelector": {
"type": "string",
"description": "NodeSelector is the node selector to use for the BuildKit deployment"
},
"noCreate": {
"type": "boolean",
"description": "NoCreate. By default, DevSpace will try to create a new builder if it cannot be found.\nIf this is true, DevSpace will fail if the specified builder cannot be found."
},
"noRecreate": {
"type": "boolean",
"description": "NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration\nin the devspace.yaml differs from the actual builder configuration. If this is\ntrue, DevSpace will not try to do that."
},
"noLoad": {
"type": "boolean",
"description": "NoLoad if enabled, DevSpace will not try to load the built image into the local docker\ndaemon if skip push is defined"
},
"createArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "CreateArgs are additional args to create the builder with."
}
},
"type": "object",
"description": "BuildKitInClusterConfig holds the buildkit builder config"
},
"ChartConfig": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name of the helm chart to deploy. Can also be a local path or an oci url",
"group": "repo",
"group_name": "Source: Helm Repository"
},
"version": {
"type": "string",
"description": "Version is the version of the helm chart to deploy",
"group": "repo"
},
"repo": {
"type": "string",
"description": "RepoURL is the url of the repo to deploy the chart from",
"group": "repo"
},
"username": {
"type": "string",
"description": "Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth",
"group": "repo"
},
"password": {
"type": "string",
"description": "Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth",
"group": "repo"
},
"path": {
"type": "string",
"description": "Path is the local path where DevSpace can find the artifact.\nThis option is mutually exclusive with the git option.",
"group": "path",
"group_name": "Source: Local Filesystem"
},
"git": {
"type": "string",
"description": "Git is the remote repository to download the artifact from. You can either use\nhttps projects or ssh projects here, but need to make sure git can pull the project.\nThis option is mutually exclusive with the path option.",
"group": "git",
"group_name": "Source: Git Repository"
},
"subPath": {
"type": "string",
"description": "SubPath is a path within the git repository where the artifact lies in",
"group": "git"
},
"branch": {
"type": "string",
"description": "Branch is the git branch to pull",
"group": "git"
},
"tag": {
"type": "string",
"description": "Tag is the tag to pull",
"group": "git"
},
"revision": {
"type": "string",
"description": "Revision is the git revision to pull",
"group": "git"
},
"cloneArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "CloneArgs are additional arguments that should be supplied to the git CLI",
"group": "git"
},
"disableShallow": {
"type": "boolean",
"description": "DisableShallow can be used to turn off shallow clones as these are the default used\nby devspace",
"group": "git"
},
"disablePull": {
"type": "boolean",
"description": "DisablePull will disable pulling every time DevSpace is reevaluating this source",
"group": "git"
}
},
"type": "object",
"description": "ChartConfig defines the helm chart options"
},
"CommandConfig": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name of a command that is used via `devspace run NAME`"
},
"section": {
"type": "string",
"description": "Section can be used to group similar commands together in `devspace list commands`"
},
"command": {
"type": "string",
"description": "Command is the command that should be executed. For example: 'echo 123'"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args are optional and if defined, command is not executed within a shell\nand rather directly."
},
"appendArgs": {
"type": "boolean",
"description": "AppendArgs will append arguments passed to the DevSpace command automatically to\nthe specified command."
},
"description": {
"type": "string",
"description": "Description describes what the command is doing and can be seen in `devspace list commands`"
},
"internal": {
"type": "boolean",
"description": "Internal commands are not show in list and are usable through run_command"
},
"after": {
"type": "string",
"description": "After is executed after the command was run. It is executed also when\nthe command was interrupted which will set the env variable COMMAND_INTERRUPT\nto true as well as when the command errored which will set the error string to\nCOMMAND_ERROR."
}
},
"type": "object",
"required": [
"command"
],
"description": "CommandConfig defines the command specification"
},
"CustomConfig": {
"properties": {
"command": {
"type": "string",
"description": "Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}\nto reference the image and tag that should get built."
},
"onChange": {
"items": {
"type": "string"
},
"type": "array",
"description": "OnChange will determine when the command should be rerun"
}
},
"type": "object",
"description": "CustomConfig tells the DevSpace CLI to build with a custom build script"
},
"DependencyConfig": {
"properties": {
"name": {
"type": "string",
"description": "Name is used internally"
},
"disabled": {
"type": "boolean",
"description": "Disabled excludes this dependency from variable resolution and pipeline runs"
},
"path": {
"type": "string",
"description": "Path is the local path where DevSpace can find the artifact.\nThis option is mutually exclusive with the git option.",
"group": "path",
"group_name": "Source: Local Filesystem"
},
"git": {
"type": "string",
"description": "Git is the remote repository to download the artifact from. You can either use\nhttps projects or ssh projects here, but need to make sure git can pull the project.\nThis option is mutually exclusive with the path option.",
"group": "git",
"group_name": "Source: Git Repository"
},
"subPath": {
"type": "string",
"description": "SubPath is a path within the git repository where the artifact lies in",
"group": "git"
},
"branch": {
"type": "string",
"description": "Branch is the git branch to pull",
"group": "git"
},
"tag": {
"type": "string",
"description": "Tag is the tag to pull",
"group": "git"
},
"revision": {
"type": "string",
"description": "Revision is the git revision to pull",
"group": "git"
},
"cloneArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "CloneArgs are additional arguments that should be supplied to the git CLI",
"group": "git"
},
"disableShallow": {
"type": "boolean",
"description": "DisableShallow can be used to turn off shallow clones as these are the default used\nby devspace",
"group": "git"
},
"disablePull": {
"type": "boolean",
"description": "DisablePull will disable pulling every time DevSpace is reevaluating this source",
"group": "git"
},
"pipeline": {
"type": "string",
"description": "Pipeline is the pipeline to deploy by default. Defaults to 'deploy'",
"default": "deploy",
"group": "execution",
"group_name": "Execution"
},
"vars": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Vars are variables that should be passed to the dependency",
"group": "execution"
},
"overwriteVars": {
"type": "boolean",
"description": "OverwriteVars specifies if DevSpace should pass the parent variables to the dependency",
"group": "execution"
},
"ignoreDependencies": {
"type": "boolean",
"description": "IgnoreDependencies defines if dependencies of the dependency should be excluded",
"group": "execution"
},
"namespace": {
"type": "string",
"description": "Namespace specifies the namespace this dependency should be deployed to",
"group": "execution"
}
},
"type": "object",
"description": "DependencyConfig defines the devspace dependency"
},
"DeploymentConfig": {
"properties": {
"name": {
"type": "string",
"description": "Name of the deployment"
},
"helm": {
"$ref": "#/$defs/HelmConfig",
"description": "Helm tells DevSpace to deploy this deployment via helm"
},
"kubectl": {
"$ref": "#/$defs/KubectlConfig",
"description": "Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize"
},
"updateImageTags": {
"type": "boolean",
"description": "UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the\nimages section with their most recent built tag."
},
"namespace": {
"type": "string",
"description": "Namespace where to deploy this deployment"
}
},
"type": "object",
"description": "DeploymentConfig defines the configuration how the devspace should be deployed"
},
"DevContainer": {
"properties": {
"container": {
"type": "string",
"description": "Container is the container name these services should get started.",
"group": "selector",
"group_name": "Selector"
},
"arch": {
"type": "string",
"description": "Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but\ndevspace tries to find out the architecture by itself by looking at the node this container runs on.",
"group": "selector"
},
"devImage": {
"type": "string",
"description": "DevImage is the image to use for this container and will replace the existing image\nif necessary.",
"group": "modifications",
"group_name": "Modifications"
},
"command": {
"items": {
"type": "string"
},
"type": "array",
"description": "Command can be used to override the entrypoint of the container",
"group": "modifications"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args can be used to override the args of the container",
"group": "modifications"
},
"workingDir": {
"type": "string",
"description": "WorkingDir can be used to override the working dir of the container",
"group": "modifications"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array",
"description": "Env can be used to add environment variables to the container. DevSpace will\nnot replace existing environment variables if an environment variable is defined here.",
"group": "modifications"
},
"resources": {
"$ref": "#/$defs/PodResources",
"description": "Resources can be used to override the resource definitions of the container",
"group": "modifications"
},
"reversePorts": {
"items": {
"$ref": "#/$defs/PortMapping"
},
"type": "array",
"description": "ReversePorts are port mappings to make local ports available inside the container",
"group": "ports",
"group_name": "Port Forwarding"
},
"sync": {
"items": {
"$ref": "#/$defs/SyncConfig"
},
"type": "array",
"description": "Sync allows you to sync certain local paths with paths inside the container",
"group": "sync",
"group_name": "File Sync"
},
"persistPaths": {
"items": {
"$ref": "#/$defs/PersistentPath"
},
"type": "array",
"description": "PersistPaths allows you to persist certain paths within this container with a persistent volume claim"
},
"terminal": {
"$ref": "#/$defs/Terminal",
"description": "Terminal allows you to tell DevSpace to open a terminal with screen support to this container",
"group": "workflows",
"group_name": "Foreground Dev Workflows"
},
"logs": {
"$ref": "#/$defs/Logs",
"description": "Logs allows you to tell DevSpace to stream logs from this container to the console",
"group": "workflows"
},
"attach": {
"$ref": "#/$defs/Attach",
"description": "Attach allows you to tell DevSpace to attach to this container",
"group": "workflows"
},
"ssh": {
"$ref": "#/$defs/SSH",
"description": "SSH allows you to create an SSH tunnel to this container"
},
"proxyCommands": {
"items": {
"$ref": "#/$defs/ProxyCommand"
},
"type": "array",
"description": "ProxyCommands allow you to proxy certain local commands to the container",
"group": "workflows_background"
},
"restartHelper": {
"$ref": "#/$defs/RestartHelper",
"description": "RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of\nthe container and restarting it and is injected via an annotation in the replaced pod.",
"group": "workflows_background"
}
},
"type": "object",
"description": "DevContainer holds options for dev services that should get started within a certain container of the selected pod"
},
"DevPod": {
"properties": {
"name": {
"type": "string",
"description": "Name of the dev configuration"
},
"imageSelector": {
"type": "string",
"description": "ImageSelector to select a pod",
"group": "selector"
},
"labelSelector": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "LabelSelector to select a pod",
"group": "selector"
},
"namespace": {
"type": "string",
"description": "Namespace where to select the pod",
"group": "selector"
},
"container": {
"type": "string",
"description": "Container is the container name these services should get started.",
"group": "selector",
"group_name": "Selector"
},
"arch": {
"type": "string",
"description": "Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but\ndevspace tries to find out the architecture by itself by looking at the node this container runs on.",
"group": "selector"
},
"devImage": {
"type": "string",
"description": "DevImage is the image to use for this container and will replace the existing image\nif necessary.",
"group": "modifications",
"group_name": "Modifications"
},
"command": {
"items": {
"type": "string"
},
"type": "array",
"description": "Command can be used to override the entrypoint of the container",
"group": "modifications"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args can be used to override the args of the container",
"group": "modifications"
},
"workingDir": {
"type": "string",
"description": "WorkingDir can be used to override the working dir of the container",
"group": "modifications"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array",
"description": "Env can be used to add environment variables to the container. DevSpace will\nnot replace existing environment variables if an environment variable is defined here.",
"group": "modifications"
},
"resources": {
"$ref": "#/$defs/PodResources",
"description": "Resources can be used to override the resource definitions of the container",
"group": "modifications"
},
"reversePorts": {
"items": {
"$ref": "#/$defs/PortMapping"
},
"type": "array",
"description": "ReversePorts are port mappings to make local ports available inside the container",
"group": "ports",
"group_name": "Port Forwarding"
},
"sync": {
"items": {
"$ref": "#/$defs/SyncConfig"
},
"type": "array",
"description": "Sync allows you to sync certain local paths with paths inside the container",
"group": "sync",
"group_name": "File Sync"
},
"persistPaths": {
"items": {
"$ref": "#/$defs/PersistentPath"
},
"type": "array",
"description": "PersistPaths allows you to persist certain paths within this container with a persistent volume claim"
},
"terminal": {
"$ref": "#/$defs/Terminal",
"description": "Terminal allows you to tell DevSpace to open a terminal with screen support to this container",
"group": "workflows",
"group_name": "Foreground Dev Workflows"
},
"logs": {
"$ref": "#/$defs/Logs",
"description": "Logs allows you to tell DevSpace to stream logs from this container to the console",
"group": "workflows"
},
"attach": {
"$ref": "#/$defs/Attach",
"description": "Attach allows you to tell DevSpace to attach to this container",
"group": "workflows"
},
"ssh": {
"$ref": "#/$defs/SSH",
"description": "SSH allows you to create an SSH tunnel to this container"
},
"proxyCommands": {
"items": {
"$ref": "#/$defs/ProxyCommand"
},
"type": "array",
"description": "ProxyCommands allow you to proxy certain local commands to the container",
"group": "workflows_background"
},
"restartHelper": {
"$ref": "#/$defs/RestartHelper",
"description": "RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of\nthe container and restarting it and is injected via an annotation in the replaced pod.",
"group": "workflows_background"
},
"ports": {
"items": {
"$ref": "#/$defs/PortMapping"
},
"type": "array",
"description": "Ports defines port mappings from the remote pod that should be forwarded to your local\ncomputer",
"group": "ports"
},
"persistenceOptions": {
"$ref": "#/$defs/PersistenceOptions",
"description": "PersistenceOptions are additional options for persisting paths within this pod",
"group": "modifications"
},
"patches": {
"items": {
"$ref": "#/$defs/PatchConfig"
},
"type": "array",
"description": "Patches are additional changes to the pod spec that should be applied",
"group": "modifications"
},
"open": {
"items": {
"$ref": "#/$defs/OpenConfig"
},
"type": "array",
"description": "Open defines urls that should be opened as soon as they are reachable",
"group": "workflows_background",
"group_name": "Background Dev Workflows"
},
"containers": {
"patternProperties": {
".*": {
"$ref": "#/$defs/DevContainer"
}
},
"type": "object",
"group": "selector"
}
},
"type": "object",
"description": "DevPod holds configurations for selecting a pod and starting dev services for that pod"
},
"DockerConfig": {
"properties": {
"disableFallback": {
"type": "boolean",
"description": "DisableFallback allows you to turn off kaniko building if docker isn't installed"
},
"preferMinikube": {
"type": "boolean",
"description": "PreferMinikube allows you to turn off using the minikube docker daemon if the minikube\ncontext is used."
},
"useCli": {
"type": "boolean",
"description": "UseCLI specifies if DevSpace should use the docker cli for building"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args are additional arguments to pass to the docker cli"
}
},
"type": "object",
"description": "DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost"
},
"EnvVar": {
"properties": {
"name": {
"type": "string",
"description": "Name of the environment variable"
},
"value": {
"type": "string",
"description": "Value of the environment variable"
}
},
"type": "object",
"required": [
"name",
"value"
]
},
"HelmConfig": {
"properties": {
"releaseName": {
"type": "string",
"description": "ReleaseName of the helm configuration"
},
"chart": {
"$ref": "#/$defs/ChartConfig",
"description": "Chart holds the chart configuration and where DevSpace can find the chart"
},
"values": {
"type": "object",
"description": "Values are additional values that should get passed to deploying this chart"
},
"valuesFiles": {
"items": {
"type": "string"
},
"type": "array",
"description": "ValuesFiles are additional files that hold values for deploying this chart"
},
"displayOutput": {
"type": "boolean",
"description": "DisplayOutput allows you to display the helm output to the console"
},
"upgradeArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "UpgradeArgs are additional arguments to pass to `helm upgrade`"
},
"templateArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "TemplateArgs are additional arguments to pass to `helm template`"
},
"disableDependencyUpdate": {
"type": "boolean",
"description": "DisableDependencyUpdate disables helm dependencies update, default to false"
}
},
"type": "object",
"description": "HelmConfig defines the specific helm options used during deployment"
},
"Image": {
"properties": {
"name": {
"type": "string",
"description": "Name of the image, will be filled automatically"
},
"image": {
"type": "string",
"description": "Image is the complete image name including registry and repository\nfor example myregistry.com/mynamespace/myimage"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"description": "Tags is an array that specifies all tags that should be build during\nthe build process. If this is empty, devspace will generate a random tag"
},
"dockerfile": {
"type": "string",
"description": "Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile.",
"default": "./Dockerfile",
"group": "buildConfig"
},
"context": {
"type": "string",
"description": "Context is the context path to build with. Defaults to the current working directory",
"default": "./",
"group": "buildConfig"
},
"entrypoint": {
"items": {
"type": "string"
},
"type": "array",
"description": "Entrypoint specifies an entrypoint that will be appended to the dockerfile during\nimage build in memory. Example: [\"sleep\", \"99999\"]",
"group": "overwrites",
"group_name": "In-Memory Overwrites"
},
"cmd": {
"items": {
"type": "string"
},
"type": "array",
"description": "Cmd specifies the arguments for the entrypoint that will be appended\nduring build in memory to the dockerfile",
"group": "overwrites"
},
"appendDockerfileInstructions": {
"items": {
"type": "string"
},
"type": "array",
"description": "AppendDockerfileInstructions are instructions that will be appended to the Dockerfile that is build\nat the current build target and are appended before the entrypoint and cmd instructions",
"group": "overwrites"
},
"buildArgs": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "BuildArgs are the build args that are to the build",
"group": "buildConfig",
"group_name": "Build Configuration"
},
"target": {
"type": "string",
"description": "Target is the target that should get used during the build. Only works if the dockerfile supports this",
"group": "buildConfig"
},
"network": {
"type": "string",
"description": "Network is the network that should get used to build the image",
"group": "buildConfig"
},
"rebuildStrategy": {
"type": "string",
"enum": [
"default",
"always",
"ignoreContextChanges"
],
"description": "RebuildStrategy is used to determine when DevSpace should rebuild an image. By default, devspace will\nrebuild an image if one of the following conditions is true:\n- The dockerfile has changed\n- The configuration within the devspace.yaml for the image has changed\n- A file within the docker context (excluding .dockerignore rules) has changed\nThis option is ignored for custom builds.",
"group": "buildConfig"
},
"skipPush": {
"type": "boolean",
"description": "SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen\nas build method",
"group": "pushPull",
"group_name": "Push \u0026 Pull"
},
"createPullSecret": {
"type": "boolean",
"description": "CreatePullSecret specifies if a pull secret should be created for this image in the\ntarget namespace. Defaults to true",
"group": "pushPull"
},
"buildKit": {
"$ref": "#/$defs/BuildKitConfig",
"description": "BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit",
"group": "engines",
"group_name": "Build Engines"
},
"docker": {
"$ref": "#/$defs/DockerConfig",
"description": "Docker if docker is specified, DevSpace will build the image using the local docker daemon",
"group": "engines"
},
"kaniko": {
"$ref": "#/$defs/KanikoConfig",
"description": "Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko",
"group": "engines"
},
"custom": {
"$ref": "#/$defs/CustomConfig",
"description": "Custom if custom is specified, DevSpace will build the image with the help of\na custom script.",
"group": "engines"
}
},
"type": "object",
"required": [
"image"
],
"description": "Image defines the image specification"
},
"Import": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enabled specifies if the given import should be enabled"
},
"path": {
"type": "string",
"description": "Path is the local path where DevSpace can find the artifact.\nThis option is mutually exclusive with the git option.",
"group": "path",
"group_name": "Source: Local Filesystem"
},
"git": {
"type": "string",
"description": "Git is the remote repository to download the artifact from. You can either use\nhttps projects or ssh projects here, but need to make sure git can pull the project.\nThis option is mutually exclusive with the path option.",
"group": "git",
"group_name": "Source: Git Repository"
},
"subPath": {
"type": "string",
"description": "SubPath is a path within the git repository where the artifact lies in",
"group": "git"
},
"branch": {
"type": "string",
"description": "Branch is the git branch to pull",
"group": "git"
},
"tag": {
"type": "string",
"description": "Tag is the tag to pull",
"group": "git"
},
"revision": {
"type": "string",
"description": "Revision is the git revision to pull",
"group": "git"
},
"cloneArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "CloneArgs are additional arguments that should be supplied to the git CLI",
"group": "git"
},
"disableShallow": {
"type": "boolean",
"description": "DisableShallow can be used to turn off shallow clones as these are the default used\nby devspace",
"group": "git"
},
"disablePull": {
"type": "boolean",
"description": "DisablePull will disable pulling every time DevSpace is reevaluating this source",
"group": "git"
}
},
"type": "object",
"description": "Import specifies the source of the devspace config to merge"
},
"KanikoAdditionalMount": {
"properties": {
"secret": {
"$ref": "#/$defs/KanikoAdditionalMountSecret",
"description": "The secret that should be mounted"
},
"configMap": {
"$ref": "#/$defs/KanikoAdditionalMountConfigMap",
"description": "The configMap that should be mounted"
},
"readOnly": {
"type": "boolean",
"description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional"
},
"mountPath": {
"type": "string",
"description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'."
},
"subPath": {
"type": "string",
"description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional"
}
},
"type": "object",
"description": "KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like"
},
"KanikoAdditionalMountConfigMap": {
"properties": {
"name": {
"type": "string",
"description": "Name of the configmap\n+optional"
},
"items": {
"items": {
"$ref": "#/$defs/KanikoAdditionalMountKeyToPath"
},
"type": "array",
"description": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional"
},
"defaultMode": {
"type": "integer",
"description": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional"
}
},
"type": "object"
},
"KanikoAdditionalMountKeyToPath": {
"properties": {
"key": {
"type": "string",
"description": "The key to project."
},
"path": {
"type": "string",
"description": "The relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'."
},
"mode": {
"type": "integer",
"description": "Optional: mode bits to use on this file, must be a value between 0\nand 0777. If not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional"
}
},
"type": "object",
"required": [
"key",
"path"
]
},
"KanikoAdditionalMountSecret": {
"properties": {
"name": {
"type": "string",
"description": "Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional"
},
"items": {
"items": {
"$ref": "#/$defs/KanikoAdditionalMountKeyToPath"
},
"type": "array",
"description": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional"
},
"defaultMode": {
"type": "integer",
"description": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional"
}
},
"type": "object",
"required": [
"name"
]
},
"KanikoConfig": {
"properties": {
"cache": {
"type": "boolean",
"description": "Cache tells DevSpace if a cache repository should be used. defaults to false"
},
"snapshotMode": {
"type": "string",
"description": "SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time"
},
"image": {
"type": "string",
"description": "Image is the image name of the kaniko pod to use"
},
"initImage": {
"type": "string",
"description": "InitImage to override the init image of the kaniko pod"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args for additional arguments that should be passed to kaniko"
},
"command": {
"items": {
"type": "string"
},
"type": "array",
"description": "Command to replace the starting command for the kaniko container"
},
"namespace": {
"type": "string",
"description": "Namespace is the namespace where the kaniko pod should be run"
},
"insecure": {
"type": "boolean",
"description": "Insecure allows pushing to insecure registries"
},
"pullSecret": {
"type": "string",
"description": "PullSecret is the pull secret to mount by default"
},
"skipPullSecretMount": {
"type": "boolean",
"description": "SkipPullSecretMount will skip mounting the pull secret"
},
"nodeSelector": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "NodeSelector is the node selector to use for the kaniko pod"
},
"tolerations": {
"items": {
"$ref": "#/$defs/Toleration"
},
"type": "array",
"description": "Tolerations is a tolerations list to use for the kaniko pod"
},
"serviceAccount": {
"type": "string",
"description": "ServiceAccount the service account to use for the kaniko pod"
},
"generateName": {
"type": "string",
"description": "GenerateName is the optional prefix that will be set to the generateName field of the build pod"
},
"annotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Annotations are extra annotations that will be added to the build pod"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Labels are extra labels that will be added to the build pod"
},
"initEnv": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "InitEnv are extra environment variables that will be added to the build init container"
},
"env": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Env are extra environment variables that will be added to the build kaniko container\nWill populate the env.value field."
},
"envFrom": {
"patternProperties": {
".*": {
"type": "object"
}
},
"type": "object",
"description": "EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container\nWill populate the env.valueFrom field."
},
"additionalMounts": {
"items": {
"$ref": "#/$defs/KanikoAdditionalMount"
},
"type": "array",
"description": "AdditionalMounts are additional mounts that will be added to the build pod"
},
"resources": {
"$ref": "#/$defs/PodResources",
"description": "Resources are the resources that should be set on the kaniko pod"
}
},
"type": "object",
"description": "KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost"
},
"KubectlConfig": {
"properties": {
"manifests": {
"items": {
"type": "string"
},
"type": "array",
"description": "Manifests is a list of files or folders that will be deployed by DevSpace using kubectl\nor kustomize"
},
"applyArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "ApplyArgs are extra arguments for `kubectl apply`"
},
"createArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "CreateArgs are extra arguments for `kubectl create` which will be run before `kubectl apply`"
},
"kubectlBinaryPath": {
"type": "string",
"description": "KubectlBinaryPath is the optional path where to find the kubectl binary"
},
"inlineManifest": {
"type": "string",
"description": "InlineManifests is a block containing the manifest to deploy"
},
"kustomize": {
"type": "boolean",
"description": "Kustomize can be used to enable kustomize instead of kubectl",
"group": "kustomize",
"group_name": "Kustomize"
},
"kustomizeArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "KustomizeArgs are extra arguments for `kustomize build` which will be run before `kubectl apply`",
"group": "kustomize"
},
"kustomizeBinaryPath": {
"type": "string",
"description": "KustomizeBinaryPath is the optional path where to find the kustomize binary",
"group": "kustomize"
},
"patches": {
"items": {
"$ref": "#/$defs/PatchTarget"
},
"type": "array",
"description": "Patches are additional changes to the pod spec that should be applied",
"group": "modifications"
}
},
"type": "object",
"description": "KubectlConfig defines the specific kubectl options used during deployment"
},
"LocalRegistryConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enabled enables the local registry for pushing images.\nWhen unset the local registry will be used as a fallback if there are no push permissions for the registry.\nWhen `true` the local registry will always be used.\nWhen `false` the local registry will never be used."
},
"localbuild": {
"type": "boolean",
"description": "LocalBuild enables use of local docker builder instead of building in the cluster"
},
"namespace": {
"type": "string",
"description": "Namespace where the local registry is deployed. Default is the current context's namespace"
},
"name": {
"type": "string",
"description": "Name of the deployment and service of the local registry. Default is `registry`"
},
"image": {
"type": "string",
"description": "Image of the local registry. Default is `registry:2.8.1`"
},
"buildKitImage": {
"type": "string",
"description": "BuildKitImage of the buildkit sidecar. Default is `moby/buildkit:master-rootless`"
},
"port": {
"type": "integer",
"description": "Port that the registry image listens on. Default is `5000`"
},
"persistence": {
"$ref": "#/$defs/LocalRegistryPersistence",
"description": "Persistence settings for the local registry"
}
},
"type": "object",
"description": "LocalRegistryConfig holds the configuration of the local image registry"
},
"LocalRegistryPersistence": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable enables persistence for the local registry"
},
"size": {
"type": "string",
"description": "Size of the persistent volume for local docker registry storage. Default is `5Gi`"
},
"storageClassName": {
"type": "string",
"description": "StorageClassName of the persistent volume. Default is your cluster's configured default storage class"
}
},
"type": "object",
"description": "LocalRegistryPersistence configures persistence settings for the local registry"
},
"Logs": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enabled can be used to enable printing container logs"
},
"lastLines": {
"type": "integer",
"description": "LastLines is the amount of lines to print of the running container initially"
}
},
"type": "object"
},
"OpenConfig": {
"properties": {
"url": {
"type": "string",
"description": "URL is the url to open in the browser after it is available"
}
},
"type": "object",
"description": "OpenConfig defines what to open after services have been started"
},
"PatchConfig": {
"properties": {
"op": {
"type": "string",
"description": "Operation is the path operation to do. Can be either replace, add or remove"
},
"path": {
"type": "string",
"description": "Path is the config path to apply the patch to"
},
"value": {
"description": "Value is the value to use for this patch."
}
},
"type": "object",
"required": [
"op",
"path"
],
"description": "PatchConfig describes a config patch and how it should be applied"
},
"PatchTarget": {
"properties": {
"target": {
"$ref": "#/$defs/Target",
"description": "Target describes where to apply a config patch"
},
"op": {
"type": "string",
"description": "Operation is the path operation to do. Can be either replace, add or remove"
},
"path": {
"type": "string",
"description": "Path is the config path to apply the patch to"
},
"value": {
"description": "Value is the value to use for this patch."
}
},
"type": "object",
"required": [
"target",
"op",
"path"
],
"description": "PatchTarget describes a config patch and how it should be applied"
},
"PersistenceOptions": {
"properties": {
"size": {
"type": "string",
"description": "Size is the size of the created persistent volume in Kubernetes size notation like 5Gi"
},
"storageClassName": {
"type": "string",
"description": "StorageClassName is the storage type DevSpace should use for this persistent volume"
},
"accessModes": {
"items": {
"type": "string"
},
"type": "array",
"description": "AccessModes are the access modes DevSpace should use for the persistent volume"
},
"readOnly": {
"type": "boolean",
"description": "ReadOnly specifies if the volume should be read only"
},
"name": {
"type": "string",
"description": "Name is the name of the PVC that should be created. If a PVC with that name\nalready exists, DevSpace will use that PVC instead of creating one."
}
},
"type": "object",
"description": "PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration"
},
"PersistentPath": {
"properties": {
"path": {
"type": "string",
"description": "Path is the container path that should get persisted. By default, DevSpace will create an init container\nthat will copy over the contents of this folder from the existing image."
},
"volumePath": {
"type": "string",
"description": "VolumePath is the sub path on the volume that is mounted as persistent volume for this path"
},
"readOnly": {
"type": "boolean",
"description": "ReadOnly will make the persistent path read only to the user"
},
"skipPopulate": {
"type": "boolean",
"description": "SkipPopulate will not create an init container to copy over the existing contents if true"
},
"initContainer": {
"$ref": "#/$defs/PersistentPathInitContainer",
"description": "InitContainer holds additional options for the persistent path init container"
}
},
"type": "object",
"description": "PersistentPath holds options to configure persistence for DevSpace"
},
"PersistentPathInitContainer": {
"properties": {
"resources": {
"$ref": "#/$defs/PodResources",
"description": "Resources are the resources used by the persistent path init container"
}
},
"type": "object",
"description": "PersistentPathInitContainer defines additional options for the persistent path init container"
},
"Pipeline": {
"properties": {
"name": {
"type": "string",
"enum": [
"dev",
"deploy",
"build",
"purge",
".*"
],
"description": "Name of the pipeline, will be filled automatically"
},
"run": {
"type": "string",
"description": "Run is the actual shell command that should be executed during this pipeline"
},
"flags": {
"items": {
"$ref": "#/$defs/PipelineFlag"
},
"type": "array",
"description": "Flags are extra flags that can be used for running the pipeline via\ndevspace run-pipeline."
},
"continueOnError": {
"type": "boolean",
"description": "ContinueOnError will not fail the whole job and pipeline if\na call within the step fails."
}
},
"type": "object",
"description": "Pipeline defines what DevSpace should do."
},
"PipelineFlag": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name of the flag"
},
"short": {
"type": "string",
"description": "Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'"
},
"type": {
"type": "string",
"enum": [
"bool",
"int",
"string",
"stringArray"
],
"description": "Type is the type of the flag. Defaults to `bool`"
},
"default": {
"description": "Default is the default value for this flag"
},
"description": {
"type": "string",
"description": "Description is the description as shown in `devspace run-pipeline my-pipe -h`"
}
},
"type": "object",
"description": "PipelineFlag defines an extra pipeline flag"
},
"PodResources": {
"properties": {
"requests": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Requests are the requests part of the resources"
},
"limits": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Limits are the limits part of the resources"
}
},
"type": "object",
"description": "PodResources describes the resources section of the started kaniko pod"
},
"PortMapping": {
"properties": {
"port": {
"type": "string",
"description": "Port is a port mapping that maps the localPort:remotePort. So if\nyou port forward the remote port will be available at the local port.\nIf you do reverse port forwarding, the local port will be available\nat the remote port in the container. If only port is specified, local and\nremote port are the same."
},
"bindAddress": {
"type": "string",
"description": "BindAddress is the address DevSpace should listen on. Optional and defaults\nto localhost."
}
},
"type": "object",
"required": [
"port"
],
"description": "PortMapping defines the ports for a PortMapping"
},
"ProxyCommand": {
"properties": {
"gitCredentials": {
"type": "boolean",
"description": "GitCredentials configures a git credentials helper inside the container that proxies local git credentials"
},
"command": {
"type": "string",
"description": "Command is the name of the command that should be available in the remote container. DevSpace\nwill create a small script for that inside the container that redirect command execution to\nthe local computer."
},
"localCommand": {
"type": "string",
"description": "LocalCommand can be used to run a different command than specified via the command option. By\ndefault, this will be assumed to be the same as command."
},
"skipContainerEnv": {
"type": "boolean",
"description": "SkipContainerEnv will not forward the container environment variables to the local command"
},
"env": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Env are extra environment variables to set for the command"
}
},
"type": "object"
},
"PullSecretConfig": {
"properties": {
"name": {
"type": "string",
"description": "Name is the pull secret name to deploy"
},
"registry": {
"type": "string",
"description": "The registry to create the image pull secret for.\nEmpty string == docker hub\ne.g. gcr.io"
},
"username": {
"type": "string",
"description": "The username of the registry. If this is empty, devspace will try\nto receive the auth data from the local docker"
},
"password": {
"type": "string",
"description": "The password to use for the registry. If this is empty, devspace will\ntry to receive the auth data from the local docker"
},
"email": {
"type": "string",
"description": "The optional email to use"
},
"secret": {
"type": "string",
"description": "The secret to create"
},
"serviceAccounts": {
"items": {
"type": "string"
},
"type": "array",
"description": "The service account to add the secret to"
}
},
"type": "object",
"description": "PullSecretConfig defines a pull secret that should be created by DevSpace"
},
"RequireCommand": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name of the command that should be installed"
},
"versionArgs": {
"items": {
"type": "string"
},
"type": "array",
"description": "VersionArgs are the arguments to retrieve the version of the command"
},
"versionRegEx": {
"type": "string",
"description": "VersionRegEx is the regex that is used to parse the version"
},
"version": {
"type": "string",
"description": "Version constraint of the command that should be installed"
}
},
"type": "object",
"required": [
"name"
]
},
"RequireConfig": {
"properties": {
"devspace": {
"type": "string",
"description": "DevSpace specifies the DevSpace version constraint that is needed to use this config"
},
"commands": {
"items": {
"$ref": "#/$defs/RequireCommand"
},
"type": "array",
"description": "Commands specifies an array of commands that need to be installed locally to use this config"
},
"plugins": {
"items": {
"$ref": "#/$defs/RequirePlugin"
},
"type": "array",
"description": "Plugins specifies an array of plugins that need to be installed locally"
}
},
"type": "object"
},
"RequirePlugin": {
"properties": {
"name": {
"type": "string",
"description": "Name of the plugin that should be installed"
},
"version": {
"type": "string",
"description": "Version constraint of the plugin that should be installed"
}
},
"type": "object",
"required": [
"name",
"version"
]
},
"RestartHelper": {
"properties": {
"path": {
"type": "string",
"description": "Path defines the path to the restart helper that might be used if certain config\noptions are enabled"
},
"inject": {
"type": "boolean",
"description": "Inject signals DevSpace to inject the restart helper"
}
},
"type": "object"
},
"SSH": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enabled can be used to enable the ssh server within the container. By default,\nDevSpace will generate the required keys and create an entry in your ~/.ssh/config\nfor this container that can be used via `ssh dev-config-name.dev-project-name.devspace`"
},
"localHostname": {
"type": "string",
"description": "LocalHostname is the local ssh host to write to the ~/.ssh/config"
},
"localPort": {
"type": "integer",
"description": "LocalPort is the local port to forward from, if empty will be random"
},
"remoteAddress": {
"type": "string",
"description": "RemoteAddress is the address to listen to inside the container"
},
"useInclude": {
"type": "boolean",
"description": "UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace\nwill also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,\nbut unfortunately not all SSH clients support this."
}
},
"type": "object"
},
"SyncConfig": {
"properties": {
"path": {
"type": "string",
"description": "Path is the path to sync. This can be defined in the form localPath:remotePath. You can also use '.'\nto specify either the local or remote working directory. This is valid for example: .:."
},
"excludePaths": {
"items": {
"type": "string"
},
"type": "array",
"description": "ExcludePaths is an array of file patterns in gitignore format to exclude.",
"group": "exclude",
"group_name": "Exclude Paths From File Sync"
},
"excludeFile": {
"type": "string",
"description": "ExcludeFile loads the file patterns to exclude from a file.",
"group": "exclude"
},
"downloadExcludePaths": {
"items": {
"type": "string"
},
"type": "array",
"description": "DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading",
"group": "exclude"
},
"downloadExcludeFile": {
"type": "string",
"description": "DownloadExcludeFile loads the file patterns to exclude from downloading from a file.",
"group": "exclude"
},
"uploadExcludePaths": {
"items": {
"type": "string"
},
"type": "array",
"description": "UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading",
"group": "exclude"
},
"uploadExcludeFile": {
"type": "string",
"description": "UploadExcludeFile loads the file patterns to exclude from uploading from a file.",
"group": "exclude"
},
"startContainer": {
"type": "boolean",
"description": "StartContainer will start the container after initial sync is done. This will\ninject a devspacehelper into the pod and you need to define dev.*.command for\nthis to work.",
"group": "actions",
"group_name": "Sync-Triggered Actions"
},
"onUpload": {
"$ref": "#/$defs/SyncOnUpload",
"description": "OnUpload can be used to execute certain commands on uploading either in the container or locally as\nwell as restart the container after a file changed has happened.",
"group": "actions"
},
"initialSync": {
"type": "string",
"description": "InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal",
"group": "initial_sync",
"group_name": "Initial Sync"
},
"waitInitialSync": {
"type": "boolean",
"description": "WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done",
"group": "initial_sync"
},
"initialSyncCompareBy": {
"type": "string",
"description": "InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible",
"group": "initial_sync"
},
"disableDownload": {
"type": "boolean",
"description": "DisableDownload will disable downloading completely",
"group": "one_direction",
"group_name": "One-Directional Sync"
},
"disableUpload": {
"type": "boolean",
"description": "DisableUpload will disable uploading completely",
"group": "one_direction"
},
"bandwidthLimits": {
"$ref": "#/$defs/BandwidthLimits",
"description": "BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this\nsync configuration"
},
"polling": {
"type": "boolean",
"description": "Polling will tell the remote container to use polling instead of inotify"
},
"noWatch": {
"type": "boolean",
"description": "NoWatch will terminate the sync after the initial sync is done"
},
"file": {
"type": "boolean",
"description": "File signals DevSpace that this is a single file that should get synced instead of a whole directory"
}
},
"type": "object",
"description": "SyncConfig defines the paths for a SyncFolder"
},
"SyncExec": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name to show for this exec in the logs"
},
"command": {
"type": "string",
"description": "Command is the command to execute. If no args are specified this is executed\nwithin a shell."
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args are arguments to pass to the command"
},
"failOnError": {
"type": "boolean",
"description": "FailOnError specifies if the sync should fail if the command fails"
},
"local": {
"type": "boolean",
"description": "Local specifies if the command should be executed locally instead of within the\ncontainer"
},
"once": {
"type": "boolean",
"description": "Once executes this command only once in the container's life. Can be used to initialize\na container before starting it, but after everything was synced."
},
"onChange": {
"items": {
"type": "string"
},
"type": "array",
"description": "OnChange is an array of file patterns that trigger this command execution"
}
},
"type": "object"
},
"SyncOnUpload": {
"properties": {
"restartContainer": {
"type": "boolean",
"description": "If true restart container will try to restart the container after a change has been made. Make sure that\nimages.*.injectRestartHelper is enabled for the container that should be restarted or the devspace-restart-helper\nscript is present in the container root folder."
},
"exec": {
"items": {
"$ref": "#/$defs/SyncExec"
},
"type": "array",
"description": "Exec will execute the given commands in order after a sync operation"
}
},
"type": "object",
"description": "SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded"
},
"Target": {
"properties": {
"apiVersion": {
"type": "string",
"description": "ApiVersion is the Kubernetes api of the target resource"
},
"kind": {
"type": "string",
"description": "Kind is the kind of the target resource (eg: Deployment, Service ...)"
},
"name": {
"type": "string",
"description": "Name is the name of the target resource"
}
},
"type": "object",
"required": [
"apiVersion",
"kind",
"name"
],
"description": "Target describes where to apply a config patch"
},
"Terminal": {
"properties": {
"command": {
"type": "string",
"description": "Command is the command that should be executed on terminal start.\nThis command is executed within a shell."
},
"workDir": {
"type": "string",
"description": "WorkDir is the working directory that is used to execute the command in."
},
"enabled": {
"type": "boolean",
"description": "If enabled is true, DevSpace will use the terminal. Can be also\nused to disable the terminal if set to false. DevSpace makes sure\nthat within a pipeline only one dev configuration can open a terminal\nat a time and subsequent dev terminals will fail."
},
"disableReplace": {
"type": "boolean",
"description": "DisableReplace tells DevSpace to not replace the pod or adjust its settings\nto make sure the pod is sleeping when opening a terminal"
},
"disableScreen": {
"type": "boolean",
"description": "DisableScreen will disable screen which is used by DevSpace by default to preserve\nsessions if connections interrupt or the session is lost."
},
"disableTTY": {
"type": "boolean",
"description": "DisableTTY will disable a tty shell for terminal command execution"
}
},
"type": "object",
"description": "Terminal describes the terminal options"
},
"Toleration": {
"properties": {
"Key": {
"type": "string"
},
"Operator": {
"type": "string"
},
"Value": {
"type": "string"
},
"Effect": {
"type": "string"
},
"TolerationSeconds": {
"type": "integer"
}
},
"type": "object",
"required": [
"Key",
"Operator",
"Value",
"Effect",
"TolerationSeconds"
]
},
"Variable": {
"properties": {
"name": {
"type": "string",
"description": "Name is the name of the variable"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
],
"description": "Value is a shortcut for using source: none and default: my-value",
"group": "static",
"group_name": "Static Value"
},
"question": {
"type": "string",
"description": "Question can be used to define a custom question if the variable was not yet used",
"group": "question",
"group_name": "Value From Input (Question)"
},
"default": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
],
"description": "Default is the default value the variable should have if not set by the user",
"group": "question"
},
"options": {
"items": {
"type": "string"
},
"type": "array",
"description": "Options are options that can be selected when the variable question is asked",
"group": "question"
},
"password": {
"type": "boolean",
"description": "Password signals that this variable should not be visible if entered",
"group": "question"
},
"validationPattern": {
"type": "string",
"description": "ValidationPattern can be used to verify the user input",
"group": "question"
},
"validationMessage": {
"type": "string",
"description": "ValidationMessage can be used to tell the user the format of the variable value",
"group": "question"
},
"noCache": {
"type": "boolean",
"description": "NoCache can be used to prompt the user on every run for this variable",
"group": "question"
},
"command": {
"type": "string",
"description": "Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell\ncommand.",
"group": "execution",
"group_name": "Value From Command"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args are optional args that will be used for the command",
"group": "execution"
},
"commands": {
"items": {
"$ref": "#/$defs/VariableCommand"
},
"type": "array",
"description": "Commands are additional commands that can be used to run a different command on a different operating\nsystem.",
"group": "execution"
},
"alwaysResolve": {
"type": "boolean",
"description": "AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false."
},
"source": {
"type": "string",
"enum": [
"all",
"env",
"input",
"command",
"none"
],
"description": "Source defines where the variable should be taken from"
}
},
"type": "object",
"description": "Variable describes the var definition"
},
"VariableCommand": {
"properties": {
"os": {
"type": "string",
"description": "OperatingSystem is optional and defines the operating system this\ncommand should be executed on"
},
"command": {
"type": "string",
"description": "Command is the command to use to retrieve the value for this variable. If no\nargs are specified the command is run within a pseudo shell."
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Args are optional arguments for the command"
}
},
"type": "object"
}
},
"properties": {
"version": {
"type": "string",
"description": "Version holds the config version. DevSpace will always convert older configs to the current latest\nconfig version, which makes it possible to use the newest DevSpace version also with older config\nversions."
},
"name": {
"type": "string",
"description": "Name specifies the name of the DevSpace project and uniquely identifies a project.\nDevSpace will not allow multiple active projects with the same name in the same Kubernetes namespace.\nIf not provided, DevSpace will use the name of the current working directory."
},
"imports": {
"items": {
"$ref": "#/$defs/Import"
},
"type": "array",
"description": "Imports merges specified config files into this one. This is very useful to split up your DevSpace configuration\ninto multiple files and reuse those through git, a remote url or common local path."
},
"functions": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object",
"description": "Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by\nimports."
},
"pipelines": {
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/Pipeline"
}
},
"type": "object"
},
{
"type": "object"
}
],
"type": "object",
"description": "Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge\nis called. Pipelines are defined through a special POSIX script that allows you to use special commands\nsuch as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute\na specific functionality. The pipelines dev, build, deploy and purge are special and will override\nthe default functionality of the respective command if defined. All other pipelines can be either run\nvia the devspace run-pipeline command or used within another pipeline through run_pipelines."
},
"images": {
"patternProperties": {
".*": {
"$ref": "#/$defs/Image"
}
},
"type": "object",
"description": "Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images.\nIf you are using a custom pipeline, you can dynamically define which image is built at which time during the\nexecution."
},
"deployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/DeploymentConfig"
}
},
"type": "object",
"description": "Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments.\nIf you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the\nexecution."
},
"dev": {
"patternProperties": {
".*": {
"$ref": "#/$defs/DevPod"
}
},
"type": "object",
"description": "Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod\nor even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint.\nDev allows you to:\n- sync local folders to the Kubernetes pod\n- port forward remote ports to your local computer\n- forward local ports into the Kubernetes pod\n- configure an ssh tunnel to the Kubernetes pod\n- proxy local commands to the container\n- restart the container on file changes"
},
"vars": {
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/Variable"
}
},
"type": "object"
},
{
"type": "object"
}
],
"type": "object",
"description": "Vars are config variables that can be used inside other config sections to replace certain values dynamically"
},
"commands": {
"anyOf": [
{
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
{
"patternProperties": {
".*": {
"$ref": "#/$defs/CommandConfig"
}
},
"type": "object"
},
{
"type": "object"
}
],
"type": "object",
"description": "Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash\nthat also allows executing special commands such as run_watch or is_equal."
},
"dependencies": {
"patternProperties": {
".*": {
"$ref": "#/$defs/DependencyConfig"
}
},
"type": "object",
"description": "Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed\nfrom within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects\nthat typically lie including source code in a different folder and can be used to compose a full microservice\napplication that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use\nthe same project multiple times, make sure to use a different name for each of those instances."
},
"pullSecrets": {
"patternProperties": {
".*": {
"$ref": "#/$defs/PullSecretConfig"
}
},
"type": "object",
"description": "PullSecrets are image pull secrets that will be created by devspace in the target namespace\nduring devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single\none or the one specified."
},
"require": {
"$ref": "#/$defs/RequireConfig",
"description": "Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not\nfulfilled, DevSpace will fail."
},
"localRegistry": {
"$ref": "#/$defs/LocalRegistryConfig",
"description": "LocalRegistry specifies the configuration for a local image registry"
}
},
"type": "object",
"required": [
"version",
"name"
],
"description": "Config defines the configuration"
} |
typingsrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"id": "https://json.schemastore.org/typingsrc.json",
"properties": {
"ca": {
"type": ["array", "string"],
"description": "A string or array of strings of trusted certificates in PEM format",
"items": {
"type": "string"
}
},
"cert": {
"type": "string",
"description": "Public x509 certificate to use"
},
"defaultSource": {
"type": "string",
"description": "Override the default installation source (e.g., when doing 'typings install debug')",
"default": "npm",
"enum": ["file", "npm", "github", "bitbucket", "bower", "http", "https"]
},
"githubToken": {
"type": "string",
"description": "Set your GitHub for resolving 'github:' locations"
},
"httpProxy": {
"type": "string",
"description": "The proxy to use for HTTP requests"
},
"httpsProxy": {
"type": "string",
"description": "The proxy to use for HTTPS requests"
},
"key": {
"type": "string",
"description": "Private key to use for SSL"
},
"noProxy": {
"type": "string",
"description": "A string of space-separated hosts to not proxy"
},
"proxy": {
"type": "string",
"description": "A HTTP(s) proxy URI for outgoing requests"
},
"registryURL": {
"type": "string",
"description": "Override the registry URL"
},
"rejectUnauthorized": {
"type": "boolean",
"description": "Reject invalid SSL certificates",
"default": true
},
"userAgent": {
"type": "string",
"description": "Set the User-Agent for HTTP requests"
}
},
"title": "JSON schema for .typingsrc files",
"type": "object"
}
|
expo-46.0.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://json.schemastore.org/expo-46.0.0.json",
"properties": {
"expo": {
"definitions": {
"Android": {
"description": "Configuration that is specific to the Android platform.",
"type": "object",
"properties": {
"publishManifestPath": {
"description": "The manifest for the Android version of your app will be written to this path during publish.",
"type": "string"
},
"publishBundlePath": {
"description": "The bundle for the Android version of your app will be written to this path during publish.",
"type": "string"
},
"package": {
"description": "The package name for your Android standalone app. You make it up, but it needs to be unique on the Play Store. See [this StackOverflow question](http://stackoverflow.com/questions/6273892/android-package-name-convention).",
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*(\\.[a-zA-Z][a-zA-Z0-9_]*)+$"
},
"versionCode": {
"description": "Version number required by Google Play. Increment by one for each release. Must be a positive integer. [Learn more](https://developer.android.com/studio/publish/versioning.html)",
"type": "integer",
"minimum": 0,
"maximum": 2100000000
},
"backgroundColor": {
"description": "The background color for your Android app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"userInterfaceStyle": {
"description": "Configuration to force the app to always use the light or dark user-interface appearance, such as \"dark mode\", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.",
"type": "string",
"enum": ["light", "dark", "automatic"]
},
"useNextNotificationsApi": {
"description": "@deprecated A Boolean value that indicates whether the app should use the new notifications API.",
"type": "boolean"
},
"icon": {
"description": "Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` key. We recommend that you use a 1024x1024 png file (transparency is recommended for the Google Play Store). This icon will appear on the home screen and within the Expo app.",
"type": "string"
},
"adaptiveIcon": {
"description": "Settings for an Adaptive Launcher Icon on Android. [Learn more](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive)",
"type": "object",
"properties": {
"foregroundImage": {
"description": "Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` and the `android.icon` keys. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen.",
"type": "string"
},
"backgroundImage": {
"description": "Local path or remote URL to a background image for your app's Adaptive Icon on Android. If specified, this overrides the `backgroundColor` key. Must have the same dimensions as foregroundImage`, and has no effect if `foregroundImage` is not specified. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive).",
"type": "string"
},
"backgroundColor": {
"description": "Color to use as the background for your app's Adaptive Icon on Android. Defaults to white, `#FFFFFF`. Has no effect if `foregroundImage` is not specified.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
}
},
"additionalProperties": false
},
"playStoreUrl": {
"description": "URL to your app on the Google Play Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.",
"pattern": "^https://play\\.google\\.com/",
"type": ["string"]
},
"permissions": {
"description": "List of permissions used by the standalone app. \n\n To use ONLY the following minimum necessary permissions and none of the extras supported by Expo in a default managed app, set `permissions` to `[]`. The minimum necessary permissions do not require a Privacy Policy when uploading to Google Play Store and are: \n• receive data from Internet \n• view network connections \n• full network access \n• change your audio settings \n• prevent device from sleeping \n\n To use ALL permissions supported by Expo by default, do not specify the `permissions` key. \n\n To use the minimum necessary permissions ALONG with certain additional permissions, specify those extras in `permissions`, e.g.\n\n `[ \"CAMERA\", \"ACCESS_FINE_LOCATION\" ]`.\n\n You can specify the following permissions depending on what you need:\n\n- `ACCESS_COARSE_LOCATION`\n- `ACCESS_FINE_LOCATION`\n- `ACCESS_BACKGROUND_LOCATION`\n- `CAMERA`\n- `RECORD_AUDIO`\n- `READ_CONTACTS`\n- `WRITE_CONTACTS`\n- `READ_CALENDAR`\n- `WRITE_CALENDAR`\n- `READ_EXTERNAL_STORAGE`\n- `WRITE_EXTERNAL_STORAGE`\n- `USE_FINGERPRINT`\n- `USE_BIOMETRIC`\n- `WRITE_SETTINGS`\n- `VIBRATE`\n- `READ_PHONE_STATE`\n- `com.anddoes.launcher.permission.UPDATE_COUNT`\n- `com.android.launcher.permission.INSTALL_SHORTCUT`\n- `com.google.android.c2dm.permission.RECEIVE`\n- `com.google.android.gms.permission.ACTIVITY_RECOGNITION`\n- `com.google.android.providers.gsf.permission.READ_GSERVICES`\n- `com.htc.launcher.permission.READ_SETTINGS`\n- `com.htc.launcher.permission.UPDATE_SHORTCUT`\n- `com.majeur.launcher.permission.UPDATE_BADGE`\n- `com.sec.android.provider.badge.permission.READ`\n- `com.sec.android.provider.badge.permission.WRITE`\n- `com.sonyericsson.home.permission.BROADCAST_BADGE`\n",
"type": "array",
"items": {
"type": "string"
}
},
"googleServicesFile": {
"description": "[Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. Including this key automatically enables FCM in your standalone app.",
"type": "string"
},
"config": {
"type": "object",
"description": "Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.",
"properties": {
"branch": {
"description": "[Branch](https://branch.io/) key to hook up Branch linking services.",
"type": "object",
"properties": {
"apiKey": {
"description": "Your Branch API key",
"type": "string"
}
},
"additionalProperties": false
},
"googleMaps": {
"description": "[Google Maps Android SDK](https://developers.google.com/maps/documentation/android-api/signup) configuration for your standalone app.",
"type": "object",
"properties": {
"apiKey": {
"description": "Your Google Maps Android SDK API key",
"type": "string"
}
},
"additionalProperties": false
},
"googleMobileAdsAppId": {
"description": "[Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID. ",
"type": "string"
},
"googleMobileAdsAutoInit": {
"description": "A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Client and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)",
"type": "boolean"
},
"googleSignIn": {
"description": "@deprecated Use `googleServicesFile` instead. [Google Sign-In Android SDK](https://developers.google.com/identity/sign-in/android/start-integrating) keys for your standalone app.",
"type": "object",
"properties": {
"apiKey": {
"description": "The Android API key. Can be found in the credentials section of the developer console or in `google-services.json`.",
"type": "string"
},
"certificateHash": {
"description": "The SHA-1 hash of the signing certificate used to build the APK without any separator (`:`). Can be found in `google-services.json`. https://developers.google.com/android/guides/client-auth",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"splash": {
"description": "Configuration for loading and splash screen for managed and standalone Android apps.",
"type": "object",
"properties": {
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`.",
"enum": ["cover", "contain", "native"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
},
"mdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Natural sized image (baseline)`",
"type": "string"
},
"hdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 1.5x`",
"type": "string"
},
"xhdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 2x`",
"type": "string"
},
"xxhdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 3x`",
"type": "string"
},
"xxxhdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 4x`",
"type": "string"
}
}
},
"intentFilters": {
"description": "Configuration for setting an array of custom intent filters in Android manifest. [Learn more](https://developer.android.com/guide/components/intents-filters)",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"autoVerify": {
"description": "You may also use an intent filter to set your app as the default handler for links (without showing the user a dialog with options). To do so use `true` and then configure your server to serve a JSON file verifying that you own the domain. [Learn more](developer.android.com/training/app-links)",
"type": "boolean"
},
"action": {
"type": "string"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"scheme": {
"description": "the scheme of the URL, e.g. `https`",
"type": "string"
},
"host": {
"description": "the hostname, e.g. `myapp.io`",
"type": "string"
},
"port": {
"description": "the port, e.g. `3000`",
"type": "string"
},
"path": {
"description": "an exact path for URLs that should be matched by the filter, e.g. `/records`",
"type": "string"
},
"pathPattern": {
"description": " a regex for paths that should be matched by the filter, e.g. `.*`",
"type": "string"
},
"pathPrefix": {
"description": "a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`",
"type": "string"
},
"mimeType": {
"description": "a MIME type for URLs that should be matched by the filter",
"type": "string"
}
},
"additionalProperties": false
},
{
"type": ["array"],
"items": {
"type": "object",
"properties": {
"scheme": {
"description": "the scheme of the URL, e.g. `https`",
"type": "string"
},
"host": {
"description": "the hostname, e.g. `myapp.io`",
"type": "string"
},
"port": {
"description": "the port, e.g. `3000`",
"type": "string"
},
"path": {
"description": "an exact path for URLs that should be matched by the filter, e.g. `/records`",
"type": "string"
},
"pathPattern": {
"description": " a regex for paths that should be matched by the filter, e.g. `.*`",
"type": "string"
},
"pathPrefix": {
"description": "a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`",
"type": "string"
},
"mimeType": {
"description": "a MIME type for URLs that should be matched by the filter",
"type": "string"
}
},
"additionalProperties": false
}
}
]
},
"category": {
"anyOf": [
{
"type": ["string"]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": ["action"]
}
},
"allowBackup": {
"description": "Allows your user's app data to be automatically backed up to their Google Drive. If this is set to false, no backup or restore of the application will ever be performed (this is useful if your app deals with sensitive information). Defaults to the Android default, which is `true`.",
"type": "boolean"
},
"softwareKeyboardLayoutMode": {
"description": "Determines how the software keyboard will impact the layout of your application. This maps to the `android:windowSoftInputMode` property. Defaults to `resize`. Valid values: `resize`, `pan`.",
"enum": ["resize", "pan"],
"type": "string"
},
"jsEngine": {
"description": "Specifies the JavaScript engine. Supported only on EAS Build. Defaults to `jsc`. Valid values: `hermes`, `jsc`.",
"type": "string",
"enum": ["hermes", "jsc"]
}
},
"additionalProperties": false
},
"AndroidIntentFiltersData": {
"type": "object",
"properties": {
"scheme": {
"description": "the scheme of the URL, e.g. `https`",
"type": "string"
},
"host": {
"description": "the hostname, e.g. `myapp.io`",
"type": "string"
},
"port": {
"description": "the port, e.g. `3000`",
"type": "string"
},
"path": {
"description": "an exact path for URLs that should be matched by the filter, e.g. `/records`",
"type": "string"
},
"pathPattern": {
"description": " a regex for paths that should be matched by the filter, e.g. `.*`",
"type": "string"
},
"pathPrefix": {
"description": "a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`",
"type": "string"
},
"mimeType": {
"description": "a MIME type for URLs that should be matched by the filter",
"type": "string"
}
},
"additionalProperties": false
},
"IOS": {
"description": "Configuration that is specific to the iOS platform.",
"type": "object",
"properties": {
"publishManifestPath": {
"description": "The manifest for the iOS version of your app will be written to this path during publish.",
"type": "string"
},
"publishBundlePath": {
"description": "The bundle for the iOS version of your app will be written to this path during publish.",
"type": "string"
},
"bundleIdentifier": {
"description": "The bundle identifier for your iOS standalone app. You make it up, but it needs to be unique on the App Store. See [this StackOverflow question](http://stackoverflow.com/questions/11347470/what-does-bundle-identifier-mean-in-the-ios-project).",
"type": "string",
"pattern": "^[a-zA-Z0-9.-]+$"
},
"buildNumber": {
"description": "Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). (Note: Transporter will pull the value for `Version Number` from `expo.version` and NOT from `expo.ios.buildNumber`.)",
"type": "string",
"pattern": "^[A-Za-z0-9\\.]+$"
},
"backgroundColor": {
"description": "The background color for your iOS app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"icon": {
"description": "Local path or remote URL to an image to use for your app's icon on iOS. If specified, this overrides the top-level `icon` key. Use a 1024x1024 icon which follows Apple's interface guidelines for icons, including color profile and transparency. \n\n Expo will generate the other required sizes. This icon will appear on the home screen and within the Expo app.",
"type": "string"
},
"merchantId": {
"description": "Merchant ID for use with Apple Pay in your standalone app.",
"type": "string"
},
"appStoreUrl": {
"description": "URL to your app on the Apple App Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.",
"pattern": "^https://(itunes|apps)\\.apple\\.com/.*?\\d+",
"type": ["string"]
},
"config": {
"type": "object",
"description": "Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.",
"properties": {
"branch": {
"description": "[Branch](https://branch.io/) key to hook up Branch linking services.",
"type": "object",
"properties": {
"apiKey": {
"description": "Your Branch API key",
"type": "string"
}
},
"additionalProperties": false
},
"usesNonExemptEncryption": {
"description": "Sets `ITSAppUsesNonExemptEncryption` in the standalone ipa's Info.plist to the given boolean value.",
"type": "boolean"
},
"googleMapsApiKey": {
"description": "[Google Maps iOS SDK](https://developers.google.com/maps/documentation/ios-sdk/start) key for your standalone app.",
"type": "string"
},
"googleMobileAdsAppId": {
"description": "[Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID. ",
"type": "string"
},
"googleMobileAdsAutoInit": {
"description": "A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Go and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`.](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)",
"type": "boolean"
},
"googleSignIn": {
"description": "[Google Sign-In iOS SDK](https://developers.google.com/identity/sign-in/ios/start-integrating) keys for your standalone app.",
"type": "object",
"properties": {
"reservedClientId": {
"description": "The reserved client ID URL scheme. Can be found in `GoogleService-Info.plist`.",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"googleServicesFile": {
"description": "[Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase.",
"type": "string"
},
"supportsTablet": {
"description": "Whether your standalone iOS app supports tablet screen sizes. Defaults to `false`.",
"type": "boolean"
},
"isTabletOnly": {
"description": "If true, indicates that your standalone iOS app does not support handsets, and only supports tablets.",
"type": "boolean"
},
"requireFullScreen": {
"description": "If true, indicates that your standalone iOS app does not support Slide Over and Split View on iPad. Defaults to `true` currently, but will change to `false` in a future SDK version.",
"type": "boolean"
},
"userInterfaceStyle": {
"description": "Configuration to force the app to always use the light or dark user-interface appearance, such as \"dark mode\", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.",
"type": "string",
"enum": ["light", "dark", "automatic"]
},
"infoPlist": {
"description": "Dictionary of arbitrary configuration to add to your standalone app's native Info.plist. Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"entitlements": {
"description": "Dictionary of arbitrary configuration to add to your standalone app's native *.entitlements (plist). Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"associatedDomains": {
"description": "An array that contains Associated Domains for the standalone app. [Learn more](https://developer.apple.com/documentation/safariservices/supporting_associated_domains).",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"usesIcloudStorage": {
"description": "A boolean indicating if the app uses iCloud Storage for `DocumentPicker`. See `DocumentPicker` docs for details.",
"type": "boolean"
},
"usesAppleSignIn": {
"description": "A boolean indicating if the app uses Apple Sign-In. See `AppleAuthentication` docs for details.",
"type": "boolean"
},
"accessesContactNotes": {
"description": "A Boolean value that indicates whether the app may access the notes stored in contacts. You must [receive permission from Apple](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes) before you can submit your app for review with this capability.",
"type": "boolean"
},
"splash": {
"description": "Configuration for loading and splash screen for standalone iOS apps.",
"type": "object",
"properties": {
"xib": {
"description": "@deprecated Apple has deprecated `.xib` splash screens in favor of `.storyboard` files. Local path to a XIB file as the loading screen. It overrides other loading screen options. Note: This will only be used in the standalone app (i.e., after you build the app). It will not be used in the Expo Go.",
"type": "string"
},
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.",
"enum": ["cover", "contain"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
},
"tabletImage": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
}
}
}
},
"additionalProperties": false
},
"Splash": {
"description": "Configuration for loading and splash screen for standalone apps.",
"type": "object",
"properties": {
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.",
"enum": ["cover", "contain"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
}
}
},
"PublishHook": {
"type": "object",
"additionalProperties": true,
"properties": {
"file": {
"type": "string"
},
"config": {
"type": "object",
"additionalProperties": true,
"properties": {}
}
}
},
"Web": {
"description": "Configuration that is specific to the web platform.",
"type": "object",
"additionalProperties": true,
"properties": {
"favicon": {
"description": "Relative path of an image to use for your app's favicon.",
"type": "string"
},
"name": {
"description": "Defines the title of the document, defaults to the outer level name",
"type": "string"
},
"shortName": {
"description": "A short version of the app's name, 12 characters or fewer. Used in app launcher and new tab pages. Maps to `short_name` in the PWA manifest.json. Defaults to the `name` property.",
"type": "string"
},
"lang": {
"description": "Specifies the primary language for the values in the name and short_name members. This value is a string containing a single language tag.",
"type": "string"
},
"scope": {
"description": "Defines the navigation scope of this website's context. This restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it returns to a normal web page inside a browser tab/window. If the scope is a relative URL, the base URL will be the URL of the manifest.",
"type": "string"
},
"themeColor": {
"description": "Defines the color of the Android tool bar, and may be reflected in the app's preview in task switchers.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"description": {
"description": "Provides a general description of what the pinned website does.",
"type": "string"
},
"dir": {
"description": "Specifies the primary text direction for the name, short_name, and description members. Together with the lang member, it helps the correct display of right-to-left languages.",
"enum": ["auto", "ltr", "rtl"],
"type": "string"
},
"display": {
"description": "Defines the developers' preferred display mode for the website.",
"enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
"type": "string"
},
"startUrl": {
"description": "The URL that loads when a user launches the application (e.g., when added to home screen), typically the index. Note: This has to be a relative URL, relative to the manifest URL.",
"type": "string"
},
"orientation": {
"description": "Defines the default orientation for all the website's top level browsing contexts.",
"enum": [
"any",
"natural",
"landscape",
"landscape-primary",
"landscape-secondary",
"portrait",
"portrait-primary",
"portrait-secondary"
],
"type": "string"
},
"backgroundColor": {
"description": "Defines the expected \"background color\" for the website. This value repeats what is already available in the site's CSS, but can be used by browsers to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded. This creates a smooth transition between launching the web application and loading the site's content.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"barStyle": {
"description": "If content is set to default, the status bar appears normal. If set to black, the status bar has a black background. If set to black-translucent, the status bar is black and translucent. If set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar.",
"enum": ["default", "black", "black-translucent"],
"type": "string"
},
"preferRelatedApplications": {
"description": "Hints for the user agent to indicate to the user that the specified native applications (defined in expo.ios and expo.android) are recommended over the website.",
"type": "boolean"
},
"dangerous": {
"description": "Experimental features. These will break without deprecation notice.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"splash": {
"description": "Configuration for PWA splash screens.",
"type": "object",
"properties": {
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.",
"enum": ["cover", "contain"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
}
}
},
"config": {
"description": "Firebase web configuration. Used by the expo-firebase packages on both web and native. [Learn more](https://firebase.google.com/docs/reference/js/firebase.html#initializeapp)",
"type": "object",
"properties": {
"firebase": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"authDomain": {
"type": "string"
},
"databaseURL": {
"type": "string"
},
"projectId": {
"type": "string"
},
"storageBucket": {
"type": "string"
},
"messagingSenderId": {
"type": "string"
},
"appId": {
"type": "string"
},
"measurementId": {
"type": "string"
}
}
}
}
}
}
}
},
"type": "object",
"properties": {
"name": {
"description": "The name of your app as it appears both within Expo Go and on your home screen as a standalone app.",
"type": "string"
},
"description": {
"description": "A short description of what your app is and why it is great.",
"type": "string"
},
"slug": {
"description": "The friendly URL name for publishing. For example, `myAppName` will refer to the `expo.io/@project-owner/myAppName` project.",
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-]+$"
},
"owner": {
"description": "The Expo account name of the team owner, only applicable if you are enrolled in the EAS Priority Plan. If not provided, defaults to the username of the current user.",
"type": "string",
"minLength": 1
},
"currentFullName": {
"description": "The auto generated Expo account name and slug used for display purposes. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value may change when a project is transferred between accounts or renamed.",
"type": "string"
},
"originalFullName": {
"description": "The auto generated Expo account name and slug used for services like Notifications and AuthSession proxy. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value will not change when a project is transferred between accounts or renamed.",
"type": "string"
},
"privacy": {
"description": "Defaults to `unlisted`. `unlisted` hides the project from search results. `hidden` restricts access to the project page to only the owner and other users that have been granted access. Valid values: `public`, `unlisted`, `hidden`.",
"enum": ["public", "unlisted", "hidden"],
"type": "string"
},
"sdkVersion": {
"description": "The Expo sdkVersion to run the project on. This should line up with the version specified in your package.json.",
"type": "string",
"pattern": "^(\\d+\\.\\d+\\.\\d+)|(UNVERSIONED)$"
},
"runtimeVersion": {
"description": "Runtime versions are a property that guarantees compatibility between a build's native code and an update. When a project is made into a build, the build will contain some native code that cannot be changed with an update. Therefore, an update must be compatible with a build's native code to run on the build.",
"anyOf": [
{
"type": "string",
"pattern": "^[0-9.]+$"
},
{
"type": "object",
"properties": {
"policy": {
"type": "string",
"enum": ["appVersion", "nativeVersion", "sdkVersion"]
}
},
"required": ["policy"]
}
]
},
"version": {
"description": "Your app version. In addition to this field, you'll also use `ios.buildNumber` and `android.versionCode` — read more about how to version your app [here](https://docs.expo.io/distribution/app-stores/#versioning-your-app). On iOS this corresponds to `CFBundleShortVersionString`, and on Android, this corresponds to `versionName`. The required format can be found [here](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring).",
"type": "string"
},
"platforms": {
"description": "Platforms that your project explicitly supports. If not specified, it defaults to `[\"ios\", \"android\"]`.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": ["android", "ios", "web"]
}
},
"githubUrl": {
"description": "If you would like to share the source code of your app on Github, enter the URL for the repository here and it will be linked to from your Expo project page.",
"pattern": "^https://github\\.com/",
"type": ["string"]
},
"orientation": {
"description": "Locks your app to a specific orientation with portrait or landscape. Defaults to no lock. Valid values: `default`, `portrait`, `landscape`",
"enum": ["default", "portrait", "landscape"],
"type": "string"
},
"userInterfaceStyle": {
"description": "Configuration to force the app to always use the light or dark user-interface appearance, such as \"dark mode\", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.",
"type": "string",
"enum": ["light", "dark", "automatic"]
},
"backgroundColor": {
"description": "The background color for your app, behind any of your React views. This is also known as the root view background color.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"primaryColor": {
"description": "On Android, this will determine the color of your app in the multitasker. Currently this is not used on iOS, but it may be used for other purposes in the future.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"icon": {
"description": "Local path or remote URL to an image to use for your app's icon. We recommend that you use a 1024x1024 png file. This icon will appear on the home screen and within the Expo app.",
"type": "string"
},
"notification": {
"description": "Configuration for remote (push) notifications.",
"type": "object",
"properties": {
"icon": {
"description": "(Android only) Local path or remote URL to an image to use as the icon for push notifications. 96x96 png grayscale with transparency. We recommend following [Google's design guidelines](https://material.io/design/iconography/product-icons.html#design-principles). If not provided, defaults to your app icon.",
"type": "string"
},
"color": {
"description": "(Android only) Tint color for the push notification image when it appears in the notification tray. Defaults to `#ffffff`",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"iosDisplayInForeground": {
"description": "Whether or not to display notifications when the app is in the foreground on iOS. `_displayInForeground` option in the individual push notification message overrides this option. [Learn more.](https://docs.expo.io/push-notifications/receiving-notifications/#foreground-notification-behavior) Defaults to `false`.",
"type": "boolean"
},
"androidMode": {
"description": "Show each push notification individually (`default`) or collapse into one (`collapse`).",
"enum": ["default", "collapse"],
"type": "string"
},
"androidCollapsedTitle": {
"description": "If `androidMode` is set to `collapse`, this title is used for the collapsed notification message. For example, `'#{unread_notifications} new interactions'`.",
"type": "string"
}
},
"additionalProperties": false
},
"appKey": {
"description": "By default, Expo looks for the application registered with the AppRegistry as `main`. If you would like to change this, you can specify the name in this property.",
"type": "string"
},
"androidStatusBar": {
"description": "Configuration for the status bar on Android. For more details please navigate to [Configuring StatusBar](https://docs.expo.io/guides/configuring-statusbar/).",
"type": "object",
"properties": {
"barStyle": {
"description": "Configures the status bar icons to have a light or dark color. Valid values: `light-content`, `dark-content`. Defaults to `dark-content`",
"type": "string",
"enum": ["light-content", "dark-content"]
},
"backgroundColor": {
"description": "Specifies the background color of the status bar. Defaults to `#00000000` (transparent) for `dark-content` bar style and `#00000088` (semi-transparent black) for `light-content` bar style",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"hidden": {
"description": "Instructs the system whether the status bar should be visible or not. Defaults to `false`",
"type": "boolean"
},
"translucent": {
"description": "Sets `android:windowTranslucentStatus` in `styles.xml`. When false, the system status bar pushes the content of your app down (similar to `position: relative`). When true, the status bar floats above the content in your app (similar to `position: absolute`). Defaults to `true` to match the iOS status bar behavior (which can only float above content).",
"type": "boolean"
}
},
"additionalProperties": false
},
"androidNavigationBar": {
"description": "Configuration for the bottom navigation bar on Android.",
"type": "object",
"properties": {
"visible": {
"description": "Determines how and when the navigation bar is shown. [Learn more](https://developer.android.com/training/system-ui/immersive). Valid values: `leanback`, `immersive`, `sticky-immersive` \n\n `leanback` results in the navigation bar being hidden until the first touch gesture is registered. \n\n `immersive` results in the navigation bar being hidden until the user swipes up from the edge where the navigation bar is hidden. \n\n `sticky-immersive` is identical to `'immersive'` except that the navigation bar will be semi-transparent and will be hidden again after a short period of time",
"type": "string",
"enum": ["leanback", "immersive", "sticky-immersive"]
},
"barStyle": {
"description": "Configure the navigation bar icons to have a light or dark color. Supported on Android Oreo and newer. Valid values: `'light-content'`, `'dark-content'`",
"type": "string",
"enum": ["light-content", "dark-content"]
},
"backgroundColor": {
"description": "Specifies the background color of the navigation bar.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
}
},
"additionalProperties": false
},
"developmentClient": {
"description": "Settings that apply specifically to running this app in a development client",
"type": "object",
"properties": {
"silentLaunch": {
"description": "If true, the app will launch in a development client with no additional dialogs or progress indicators, just like in a standalone app.",
"type": "boolean"
}
},
"additionalProperties": false
},
"scheme": {
"description": "**Standalone Apps Only**. URL scheme to link into your app. For example, if we set this to `'demo'`, then demo:// URLs would open your app when tapped.",
"type": "string",
"pattern": "^[a-z][a-z0-9+.-]*$"
},
"entryPoint": {
"description": "The relative path to your main JavaScript file.",
"type": "string"
},
"extra": {
"description": "Any extra fields you want to pass to your experience. Values are accessible via `Expo.Constants.manifest.extra` ([Learn more](https://docs.expo.io/versions/latest/sdk/constants/#constantsmanifest))",
"type": "object",
"properties": {},
"additionalProperties": true
},
"packagerOpts": {
"description": "@deprecated Use a `metro.config.js` file instead. [Learn more](https://docs.expo.io/guides/customizing-metro/)",
"type": "object",
"properties": {},
"additionalProperties": true
},
"updates": {
"description": "Configuration for how and when the app should request OTA JavaScript updates",
"type": "object",
"properties": {
"enabled": {
"description": "If set to false, your standalone app will never download any code, and will only use code bundled locally on the device. In that case, all updates to your app must be submitted through app store review. Defaults to true. (Note: This will not work out of the box with ExpoKit projects)",
"type": "boolean"
},
"checkAutomatically": {
"description": "By default, Expo will check for updates every time the app is loaded. Set this to `ON_ERROR_RECOVERY` to disable automatic checking unless recovering from an error. Must be one of `ON_LOAD` or `ON_ERROR_RECOVERY`",
"enum": ["ON_ERROR_RECOVERY", "ON_LOAD"],
"type": "string"
},
"fallbackToCacheTimeout": {
"description": "How long (in ms) to allow for fetching OTA updates before falling back to a cached version of the app. Defaults to 0. Must be between 0 and 300000 (5 minutes).",
"type": "number",
"minimum": 0,
"maximum": 300000
},
"url": {
"description": "URL from which expo-updates will fetch update manifests",
"type": "string"
}
},
"additionalProperties": false
},
"locales": {
"description": "Provide overrides by locale for System Dialog prompts like Permissions Boxes",
"type": "object",
"properties": {},
"additionalProperties": {
"type": ["string", "object"]
}
},
"facebookAppId": {
"description": "Used for all Facebook libraries. Set up your Facebook App ID at https://developers.facebook.com.",
"type": "string",
"pattern": "^[0-9]+$"
},
"facebookAutoInitEnabled": {
"description": "Whether the Facebook SDK should be initialized automatically. The default in Expo (Client and in standalone apps) is `false`.",
"type": "boolean"
},
"facebookAutoLogAppEventsEnabled": {
"description": "Whether the Facebook SDK log app events automatically. If you don't set this property, Facebook's default will be used. (Applicable only to standalone apps.) Note: The Facebook SDK must be initialized for app events to work. You may autoinitialize Facebook SDK by setting `facebookAutoInitEnabled` to `true`",
"type": "boolean"
},
"facebookAdvertiserIDCollectionEnabled": {
"description": "Whether the Facebook SDK should collect advertiser ID properties, like the Apple IDFA and Android Advertising ID, automatically. If you don't set this property, Facebook's default policy will be used. (Applicable only to standalone apps.)",
"type": "boolean"
},
"facebookDisplayName": {
"description": "Used for native Facebook login.",
"type": "string"
},
"facebookScheme": {
"description": "Used for Facebook native login. Starts with 'fb' and followed by a string of digits, like 'fb1234567890'. You can find your scheme [here](https://developers.facebook.com/docs/facebook-login/ios)in the 'Configuring Your info.plist' section (only applicable to standalone apps and custom Expo Go apps).",
"type": "string",
"pattern": "^fb[0-9]+[A-Za-z]*$"
},
"isDetached": {
"description": "Is app detached",
"type": "boolean"
},
"detach": {
"description": "Extra fields needed by detached apps",
"type": "object",
"properties": {},
"additionalProperties": true
},
"assetBundlePatterns": {
"description": "An array of file glob strings which point to assets that will be bundled within your standalone app binary. Read more in the [Offline Support guide](https://docs.expo.io/guides/offline-support/)",
"type": "array",
"items": {
"type": "string"
}
},
"plugins": {
"description": "Config plugins for adding extra functionality to your project. [Learn more](https://docs.expo.io/guides/config-plugins/).",
"type": "array",
"items": {
"anyOf": [
{
"type": ["string"]
},
{
"type": "array",
"items": [
{
"type": ["string"]
},
{}
],
"additionalItems": false
}
]
}
},
"splash": {
"description": "Configuration for loading and splash screen for standalone apps.",
"type": "object",
"properties": {
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.",
"enum": ["cover", "contain"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
}
}
},
"ios": {
"description": "Configuration that is specific to the iOS platform.",
"type": "object",
"properties": {
"publishManifestPath": {
"description": "The manifest for the iOS version of your app will be written to this path during publish.",
"type": "string"
},
"publishBundlePath": {
"description": "The bundle for the iOS version of your app will be written to this path during publish.",
"type": "string"
},
"bundleIdentifier": {
"description": "The bundle identifier for your iOS standalone app. You make it up, but it needs to be unique on the App Store. See [this StackOverflow question](http://stackoverflow.com/questions/11347470/what-does-bundle-identifier-mean-in-the-ios-project).",
"type": "string",
"pattern": "^[a-zA-Z0-9.-]+$"
},
"buildNumber": {
"description": "Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). (Note: Transporter will pull the value for `Version Number` from `expo.version` and NOT from `expo.ios.buildNumber`.)",
"type": "string",
"pattern": "^[A-Za-z0-9\\.]+$"
},
"backgroundColor": {
"description": "The background color for your iOS app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"icon": {
"description": "Local path or remote URL to an image to use for your app's icon on iOS. If specified, this overrides the top-level `icon` key. Use a 1024x1024 icon which follows Apple's interface guidelines for icons, including color profile and transparency. \n\n Expo will generate the other required sizes. This icon will appear on the home screen and within the Expo app.",
"type": "string"
},
"merchantId": {
"description": "Merchant ID for use with Apple Pay in your standalone app.",
"type": "string"
},
"appStoreUrl": {
"description": "URL to your app on the Apple App Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.",
"pattern": "^https://(itunes|apps)\\.apple\\.com/.*?\\d+",
"type": ["string"]
},
"config": {
"type": "object",
"description": "Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.",
"properties": {
"branch": {
"description": "[Branch](https://branch.io/) key to hook up Branch linking services.",
"type": "object",
"properties": {
"apiKey": {
"description": "Your Branch API key",
"type": "string"
}
},
"additionalProperties": false
},
"usesNonExemptEncryption": {
"description": "Sets `ITSAppUsesNonExemptEncryption` in the standalone ipa's Info.plist to the given boolean value.",
"type": "boolean"
},
"googleMapsApiKey": {
"description": "[Google Maps iOS SDK](https://developers.google.com/maps/documentation/ios-sdk/start) key for your standalone app.",
"type": "string"
},
"googleMobileAdsAppId": {
"description": "[Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID. ",
"type": "string"
},
"googleMobileAdsAutoInit": {
"description": "A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Go and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`.](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)",
"type": "boolean"
},
"googleSignIn": {
"description": "[Google Sign-In iOS SDK](https://developers.google.com/identity/sign-in/ios/start-integrating) keys for your standalone app.",
"type": "object",
"properties": {
"reservedClientId": {
"description": "The reserved client ID URL scheme. Can be found in `GoogleService-Info.plist`.",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"googleServicesFile": {
"description": "[Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase.",
"type": "string"
},
"supportsTablet": {
"description": "Whether your standalone iOS app supports tablet screen sizes. Defaults to `false`.",
"type": "boolean"
},
"isTabletOnly": {
"description": "If true, indicates that your standalone iOS app does not support handsets, and only supports tablets.",
"type": "boolean"
},
"requireFullScreen": {
"description": "If true, indicates that your standalone iOS app does not support Slide Over and Split View on iPad. Defaults to `true` currently, but will change to `false` in a future SDK version.",
"type": "boolean"
},
"userInterfaceStyle": {
"description": "Configuration to force the app to always use the light or dark user-interface appearance, such as \"dark mode\", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.",
"type": "string",
"enum": ["light", "dark", "automatic"]
},
"infoPlist": {
"description": "Dictionary of arbitrary configuration to add to your standalone app's native Info.plist. Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"entitlements": {
"description": "Dictionary of arbitrary configuration to add to your standalone app's native *.entitlements (plist). Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"associatedDomains": {
"description": "An array that contains Associated Domains for the standalone app. [Learn more](https://developer.apple.com/documentation/safariservices/supporting_associated_domains).",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"usesIcloudStorage": {
"description": "A boolean indicating if the app uses iCloud Storage for `DocumentPicker`. See `DocumentPicker` docs for details.",
"type": "boolean"
},
"usesAppleSignIn": {
"description": "A boolean indicating if the app uses Apple Sign-In. See `AppleAuthentication` docs for details.",
"type": "boolean"
},
"accessesContactNotes": {
"description": "A Boolean value that indicates whether the app may access the notes stored in contacts. You must [receive permission from Apple](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes) before you can submit your app for review with this capability.",
"type": "boolean"
},
"splash": {
"description": "Configuration for loading and splash screen for standalone iOS apps.",
"type": "object",
"properties": {
"xib": {
"description": "@deprecated Apple has deprecated `.xib` splash screens in favor of `.storyboard` files. Local path to a XIB file as the loading screen. It overrides other loading screen options. Note: This will only be used in the standalone app (i.e., after you build the app). It will not be used in the Expo Go.",
"type": "string"
},
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.",
"enum": ["cover", "contain"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
},
"tabletImage": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
}
}
}
},
"additionalProperties": false
},
"android": {
"description": "Configuration that is specific to the Android platform.",
"type": "object",
"properties": {
"publishManifestPath": {
"description": "The manifest for the Android version of your app will be written to this path during publish.",
"type": "string"
},
"publishBundlePath": {
"description": "The bundle for the Android version of your app will be written to this path during publish.",
"type": "string"
},
"package": {
"description": "The package name for your Android standalone app. You make it up, but it needs to be unique on the Play Store. See [this StackOverflow question](http://stackoverflow.com/questions/6273892/android-package-name-convention).",
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*(\\.[a-zA-Z][a-zA-Z0-9_]*)+$"
},
"versionCode": {
"description": "Version number required by Google Play. Increment by one for each release. Must be a positive integer. [Learn more](https://developer.android.com/studio/publish/versioning.html)",
"type": "integer",
"minimum": 0,
"maximum": 2100000000
},
"backgroundColor": {
"description": "The background color for your Android app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"userInterfaceStyle": {
"description": "Configuration to force the app to always use the light or dark user-interface appearance, such as \"dark mode\", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.",
"type": "string",
"enum": ["light", "dark", "automatic"]
},
"useNextNotificationsApi": {
"description": "@deprecated A Boolean value that indicates whether the app should use the new notifications API.",
"type": "boolean"
},
"icon": {
"description": "Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` key. We recommend that you use a 1024x1024 png file (transparency is recommended for the Google Play Store). This icon will appear on the home screen and within the Expo app.",
"type": "string"
},
"adaptiveIcon": {
"description": "Settings for an Adaptive Launcher Icon on Android. [Learn more](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive)",
"type": "object",
"properties": {
"foregroundImage": {
"description": "Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` and the `android.icon` keys. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen.",
"type": "string"
},
"backgroundImage": {
"description": "Local path or remote URL to a background image for your app's Adaptive Icon on Android. If specified, this overrides the `backgroundColor` key. Must have the same dimensions as foregroundImage`, and has no effect if `foregroundImage` is not specified. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive).",
"type": "string"
},
"backgroundColor": {
"description": "Color to use as the background for your app's Adaptive Icon on Android. Defaults to white, `#FFFFFF`. Has no effect if `foregroundImage` is not specified.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
}
},
"additionalProperties": false
},
"playStoreUrl": {
"description": "URL to your app on the Google Play Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.",
"pattern": "^https://play\\.google\\.com/",
"type": ["string"]
},
"permissions": {
"description": "List of permissions used by the standalone app. \n\n To use ONLY the following minimum necessary permissions and none of the extras supported by Expo in a default managed app, set `permissions` to `[]`. The minimum necessary permissions do not require a Privacy Policy when uploading to Google Play Store and are: \n• receive data from Internet \n• view network connections \n• full network access \n• change your audio settings \n• prevent device from sleeping \n\n To use ALL permissions supported by Expo by default, do not specify the `permissions` key. \n\n To use the minimum necessary permissions ALONG with certain additional permissions, specify those extras in `permissions`, e.g.\n\n `[ \"CAMERA\", \"ACCESS_FINE_LOCATION\" ]`.\n\n You can specify the following permissions depending on what you need:\n\n- `ACCESS_COARSE_LOCATION`\n- `ACCESS_FINE_LOCATION`\n- `ACCESS_BACKGROUND_LOCATION`\n- `CAMERA`\n- `RECORD_AUDIO`\n- `READ_CONTACTS`\n- `WRITE_CONTACTS`\n- `READ_CALENDAR`\n- `WRITE_CALENDAR`\n- `READ_EXTERNAL_STORAGE`\n- `WRITE_EXTERNAL_STORAGE`\n- `USE_FINGERPRINT`\n- `USE_BIOMETRIC`\n- `WRITE_SETTINGS`\n- `VIBRATE`\n- `READ_PHONE_STATE`\n- `com.anddoes.launcher.permission.UPDATE_COUNT`\n- `com.android.launcher.permission.INSTALL_SHORTCUT`\n- `com.google.android.c2dm.permission.RECEIVE`\n- `com.google.android.gms.permission.ACTIVITY_RECOGNITION`\n- `com.google.android.providers.gsf.permission.READ_GSERVICES`\n- `com.htc.launcher.permission.READ_SETTINGS`\n- `com.htc.launcher.permission.UPDATE_SHORTCUT`\n- `com.majeur.launcher.permission.UPDATE_BADGE`\n- `com.sec.android.provider.badge.permission.READ`\n- `com.sec.android.provider.badge.permission.WRITE`\n- `com.sonyericsson.home.permission.BROADCAST_BADGE`\n",
"type": "array",
"items": {
"type": "string"
}
},
"googleServicesFile": {
"description": "[Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. Including this key automatically enables FCM in your standalone app.",
"type": "string"
},
"config": {
"type": "object",
"description": "Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.",
"properties": {
"branch": {
"description": "[Branch](https://branch.io/) key to hook up Branch linking services.",
"type": "object",
"properties": {
"apiKey": {
"description": "Your Branch API key",
"type": "string"
}
},
"additionalProperties": false
},
"googleMaps": {
"description": "[Google Maps Android SDK](https://developers.google.com/maps/documentation/android-api/signup) configuration for your standalone app.",
"type": "object",
"properties": {
"apiKey": {
"description": "Your Google Maps Android SDK API key",
"type": "string"
}
},
"additionalProperties": false
},
"googleMobileAdsAppId": {
"description": "[Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID. ",
"type": "string"
},
"googleMobileAdsAutoInit": {
"description": "A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Client and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)",
"type": "boolean"
},
"googleSignIn": {
"description": "@deprecated Use `googleServicesFile` instead. [Google Sign-In Android SDK](https://developers.google.com/identity/sign-in/android/start-integrating) keys for your standalone app.",
"type": "object",
"properties": {
"apiKey": {
"description": "The Android API key. Can be found in the credentials section of the developer console or in `google-services.json`.",
"type": "string"
},
"certificateHash": {
"description": "The SHA-1 hash of the signing certificate used to build the APK without any separator (`:`). Can be found in `google-services.json`. https://developers.google.com/android/guides/client-auth",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"splash": {
"description": "Configuration for loading and splash screen for managed and standalone Android apps.",
"type": "object",
"properties": {
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`.",
"enum": ["cover", "contain", "native"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
},
"mdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Natural sized image (baseline)`",
"type": "string"
},
"hdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 1.5x`",
"type": "string"
},
"xhdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 2x`",
"type": "string"
},
"xxhdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 3x`",
"type": "string"
},
"xxxhdpi": {
"description": "Local path or remote URL to an image to fill the background of the loading screen in \"native\" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) \n\n `Scale 4x`",
"type": "string"
}
}
},
"intentFilters": {
"description": "Configuration for setting an array of custom intent filters in Android manifest. [Learn more](https://developer.android.com/guide/components/intents-filters)",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"autoVerify": {
"description": "You may also use an intent filter to set your app as the default handler for links (without showing the user a dialog with options). To do so use `true` and then configure your server to serve a JSON file verifying that you own the domain. [Learn more](developer.android.com/training/app-links)",
"type": "boolean"
},
"action": {
"type": "string"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"scheme": {
"description": "the scheme of the URL, e.g. `https`",
"type": "string"
},
"host": {
"description": "the hostname, e.g. `myapp.io`",
"type": "string"
},
"port": {
"description": "the port, e.g. `3000`",
"type": "string"
},
"path": {
"description": "an exact path for URLs that should be matched by the filter, e.g. `/records`",
"type": "string"
},
"pathPattern": {
"description": " a regex for paths that should be matched by the filter, e.g. `.*`",
"type": "string"
},
"pathPrefix": {
"description": "a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`",
"type": "string"
},
"mimeType": {
"description": "a MIME type for URLs that should be matched by the filter",
"type": "string"
}
},
"additionalProperties": false
},
{
"type": ["array"],
"items": {
"type": "object",
"properties": {
"scheme": {
"description": "the scheme of the URL, e.g. `https`",
"type": "string"
},
"host": {
"description": "the hostname, e.g. `myapp.io`",
"type": "string"
},
"port": {
"description": "the port, e.g. `3000`",
"type": "string"
},
"path": {
"description": "an exact path for URLs that should be matched by the filter, e.g. `/records`",
"type": "string"
},
"pathPattern": {
"description": " a regex for paths that should be matched by the filter, e.g. `.*`",
"type": "string"
},
"pathPrefix": {
"description": "a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`",
"type": "string"
},
"mimeType": {
"description": "a MIME type for URLs that should be matched by the filter",
"type": "string"
}
},
"additionalProperties": false
}
}
]
},
"category": {
"anyOf": [
{
"type": ["string"]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false,
"required": ["action"]
}
},
"allowBackup": {
"description": "Allows your user's app data to be automatically backed up to their Google Drive. If this is set to false, no backup or restore of the application will ever be performed (this is useful if your app deals with sensitive information). Defaults to the Android default, which is `true`.",
"type": "boolean"
},
"softwareKeyboardLayoutMode": {
"description": "Determines how the software keyboard will impact the layout of your application. This maps to the `android:windowSoftInputMode` property. Defaults to `resize`. Valid values: `resize`, `pan`.",
"enum": ["resize", "pan"],
"type": "string"
},
"jsEngine": {
"description": "Specifies the JavaScript engine. Supported only on EAS Build. Defaults to `jsc`. Valid values: `hermes`, `jsc`.",
"type": "string",
"enum": ["hermes", "jsc"]
}
},
"additionalProperties": false
},
"web": {
"description": "Configuration that is specific to the web platform.",
"type": "object",
"additionalProperties": true,
"properties": {
"favicon": {
"description": "Relative path of an image to use for your app's favicon.",
"type": "string"
},
"name": {
"description": "Defines the title of the document, defaults to the outer level name",
"type": "string"
},
"shortName": {
"description": "A short version of the app's name, 12 characters or fewer. Used in app launcher and new tab pages. Maps to `short_name` in the PWA manifest.json. Defaults to the `name` property.",
"type": "string"
},
"lang": {
"description": "Specifies the primary language for the values in the name and short_name members. This value is a string containing a single language tag.",
"type": "string"
},
"scope": {
"description": "Defines the navigation scope of this website's context. This restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it returns to a normal web page inside a browser tab/window. If the scope is a relative URL, the base URL will be the URL of the manifest.",
"type": "string"
},
"themeColor": {
"description": "Defines the color of the Android tool bar, and may be reflected in the app's preview in task switchers.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"description": {
"description": "Provides a general description of what the pinned website does.",
"type": "string"
},
"dir": {
"description": "Specifies the primary text direction for the name, short_name, and description members. Together with the lang member, it helps the correct display of right-to-left languages.",
"enum": ["auto", "ltr", "rtl"],
"type": "string"
},
"display": {
"description": "Defines the developers' preferred display mode for the website.",
"enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
"type": "string"
},
"startUrl": {
"description": "The URL that loads when a user launches the application (e.g., when added to home screen), typically the index. Note: This has to be a relative URL, relative to the manifest URL.",
"type": "string"
},
"orientation": {
"description": "Defines the default orientation for all the website's top level browsing contexts.",
"enum": [
"any",
"natural",
"landscape",
"landscape-primary",
"landscape-secondary",
"portrait",
"portrait-primary",
"portrait-secondary"
],
"type": "string"
},
"backgroundColor": {
"description": "Defines the expected \"background color\" for the website. This value repeats what is already available in the site's CSS, but can be used by browsers to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded. This creates a smooth transition between launching the web application and loading the site's content.",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"barStyle": {
"description": "If content is set to default, the status bar appears normal. If set to black, the status bar has a black background. If set to black-translucent, the status bar is black and translucent. If set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar.",
"enum": ["default", "black", "black-translucent"],
"type": "string"
},
"preferRelatedApplications": {
"description": "Hints for the user agent to indicate to the user that the specified native applications (defined in expo.ios and expo.android) are recommended over the website.",
"type": "boolean"
},
"dangerous": {
"description": "Experimental features. These will break without deprecation notice.",
"type": "object",
"properties": {},
"additionalProperties": true
},
"splash": {
"description": "Configuration for PWA splash screens.",
"type": "object",
"properties": {
"backgroundColor": {
"description": "Color to fill the loading screen background",
"type": "string",
"pattern": "^(?:#|(#))[0-9a-fA-F]{6}$"
},
"resizeMode": {
"description": "Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.",
"enum": ["cover", "contain"],
"type": "string"
},
"image": {
"description": "Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.",
"type": "string"
}
}
},
"config": {
"description": "Firebase web configuration. Used by the expo-firebase packages on both web and native. [Learn more](https://firebase.google.com/docs/reference/js/firebase.html#initializeapp)",
"type": "object",
"properties": {
"firebase": {
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"authDomain": {
"type": "string"
},
"databaseURL": {
"type": "string"
},
"projectId": {
"type": "string"
},
"storageBucket": {
"type": "string"
},
"messagingSenderId": {
"type": "string"
},
"appId": {
"type": "string"
},
"measurementId": {
"type": "string"
}
}
}
}
}
}
},
"hooks": {
"description": "Configuration for scripts to run to hook into the publish process",
"type": "object",
"additionalProperties": false,
"properties": {
"postPublish": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"properties": {
"file": {
"type": "string"
},
"config": {
"type": "object",
"additionalProperties": true,
"properties": {}
}
}
}
},
"postExport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"properties": {
"file": {
"type": "string"
},
"config": {
"type": "object",
"additionalProperties": true,
"properties": {}
}
}
}
}
}
},
"experiments": {
"description": "Enable experimental features that may be unstable, unsupported, or removed without deprecation notices.",
"type": "object",
"additionalProperties": false,
"properties": {
"turboModules": {
"description": "Enables Turbo Modules, which are a type of native modules that use a different way of communicating between JS and platform code. When installing a Turbo Module you will need to enable this experimental option (the library still needs to be a part of Expo SDK already, like react-native-reanimated v2). Turbo Modules do not support remote debugging and enabling this option will disable remote debugging.",
"type": "boolean"
}
}
},
"jsEngine": {
"description": "Sets the JS Engine that will interpret your code",
"type": "string",
"enum": ["hermes", "jsc"]
},
"_internal": {
"description": "Internal properties for developer tools",
"type": "object",
"properties": {
"pluginHistory": {
"description": "List of plugins already run on the config",
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": false,
"required": ["name", "slug"]
}
},
"required": ["expo"],
"title": "JSON schema for Expo SDK 46 app manifest",
"type": "object"
}
|
replit.json | {
"$id": "https://json.schemastore.org/replit.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "https://docs.replit.com/programming-ide/configuring-repl",
"properties": {
"run": {
"description": "Command to run REPL",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"language": {
"description": "Language name used in REPL",
"type": "string",
"$comment": "List is taken from https://replit.com/talk/learn/How-to-Get-a-List-of-All-Replit-Langauges/34411",
"enum": [
"clojure",
"haskell",
"kotlin",
"qbasic",
"forth",
"lolcode",
"brainf***",
"emoticon",
"bloop",
"react_native",
"unlambda",
"javascript",
"babel",
"coffeescript",
"scheme",
"apl",
"lua",
"python",
"ruby",
"roy",
"php",
"python3",
"nodejs",
"enzyme",
"go",
"java",
"cpp",
"cpp11",
"c",
"csharp",
"fsharp",
"web_project",
"html",
"rust",
"swift",
"python_turtle",
"basic",
"jest",
"django",
"express",
"sinatra",
"rails",
"rlang",
"nextjs",
"gatsbyjs",
"reactjs",
"reactts",
"reactre",
"flow",
"bash",
"quil",
"polygott",
"crystal",
"julia",
"perl6",
"elixir",
"nim",
"dart",
"gatsbyjsv2",
"reason_nodejs",
"tcl",
"erlang",
"typescript",
"ocaml",
"pygame",
"love2d",
"reason",
"Tkinter",
"tkinter",
"java_swing",
"php_server",
"nodejs_prybar",
"elisp",
"php7",
"sqlite",
"java10",
"php_cli",
"nodejs_beta",
"pyxel",
"static",
"go_beta",
"nodejs_static",
"python3_beta",
"raku",
"testj",
"wasm",
"java10_beta",
"python_beta",
"html_beta",
"testj_beta",
"scala",
"riddlejs",
"java_maven"
]
},
"audio": {
"description": "Enable/disable system-wide audio in REPL",
"type": "boolean"
},
"packager": {
"description": "Universal Package Manager (UPM) configuration",
"type": "object",
"properties": {
"afterInstall": {
"description": "Command to run on new package install",
"type": "string"
},
"ignoredPaths": {
"description": "List of ignored path",
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true,
"minItems": 1
},
"ignoredPackages": {
"description": "List of ignored packages",
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true,
"minItems": 1
},
"language": {
"description": "Language name",
"type": "string",
"enum": [
"python-python3-poetry",
"python-python2-poetry",
"nodejs-npm",
"nodejs-yarn",
"ruby-bundler",
"elisp-cask",
"dart-pub",
"java-maven",
"rlang",
"dotnet",
"rust"
]
},
"features": {
"description": "Universal Package Manager (UPM) features",
"type": "object",
"properties": {
"packageSearch": {
"description": "Enable/disable package search panel",
"type": "boolean"
},
"guessImports": {
"description": "Enable/disable guessing required packages",
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"languages": {
"description": "Language configuration",
"type": "object",
"patternProperties": {
".": {
"description": "Language configuration",
"type": "object",
"properties": {
"glob": {
"description": "Glob for language files",
"type": "string",
"minLength": 1
},
"languageServer": {
"description": "Language Server Protocol (LSP) configuration",
"type": "object",
"properties": {
"start": {
"description": "Command to run server",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"title": "Repl.it config schema (.replit)",
"type": "object",
"x-taplo-info": {
"authors": ["Emily Grace Seville (https://github.com/EmilySeville7cfg)"],
"patterns": ["\\.replit(?:\\.toml)?$"]
}
}
|
red_cog.schema.json | {
"$id": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/V3/develop/schema/red_cog.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Red-DiscordBot Сog metadata file",
"type": "object",
"properties": {
"author": {
"type": "array",
"description": "List of names of authors of the cog",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "A long description of the cog or repo. For cogs, this is displayed when a user executes [p]cog info."
},
"install_msg": {
"type": "string",
"description": "The message that gets displayed when a cog is installed or a repo is added"
},
"short": {
"type": "string",
"description": "A short description of the cog or repo. For cogs, this info is displayed when a user executes [p]cog list"
},
"end_user_data_statement": {
"type": "string",
"description": "A statement explaining what end user data the cog is storing. This is displayed when a user executes [p]cog info. If the statement has changed since last update, user will be informed during the update."
},
"min_bot_version": {
"type": "string",
"description": "Min version number of Red in the format MAJOR.MINOR.MICRO",
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)((a|b|rc)(0|[1-9][0-9]*))?(\\.post(0|[1-9][0-9]*))?(\\.dev(0|[1-9][0-9]*))?$"
},
"max_bot_version": {
"type": "string",
"description": "Max version number of Red in the format MAJOR.MINOR.MICRO, if min_bot_version is newer than max_bot_version, max_bot_version will be ignored",
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)((a|b|rc)(0|[1-9][0-9]*))?(\\.post(0|[1-9][0-9]*))?(\\.dev(0|[1-9][0-9]*))?$"
},
"min_python_version": {
"type": "array",
"description": "Min version number of Python in the format [MAJOR, MINOR, PATCH]",
"minItems": 3,
"maxItems": 3,
"items": {
"type": "integer"
}
},
"hidden": {
"type": "boolean",
"description": "Determines if a cog is visible in the cog list for a repo."
},
"disabled": {
"type": "boolean",
"description": "Determines if a cog is available for install."
},
"required_cogs": {
"type": "object",
"description": "A dict of required cogs that this cog depends on in the format {cog_name : repo_url}. Downloader will not deal with this functionality but it may be useful for other cogs.",
"$ref": "#/definitions/required_cog"
},
"requirements": {
"type": "array",
"description": "List of required libraries that are passed to pip on cog install.",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"description": "A list of strings that are related to the functionality of the cog. Used to aid in searching.",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Optional, defaults to COG. Must be either COG or SHARED_LIBRARY. If SHARED_LIBRARY then hidden will be True.",
"enum": [
"COG",
"SHARED_LIBRARY"
]
}
},
"definitions": {
"required_cog": {
"type": "object",
"patternProperties": {
".+": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
}
}
|
solidaritySchema.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"cli": {
"description": "CLI Rule",
"type": "object",
"properties": {
"rule": {
"enum": ["cli"]
},
"binary": {
"type": "string"
},
"semver": {
"type": "string"
},
"version": {
"type": "string"
},
"line": {
"type": ["string", "integer"]
},
"matchIndex": {
"type": "integer"
},
"platform": {
"enum": [
"darwin",
"macos",
"freebsd",
"linux",
"sunos",
"win32",
"windows"
]
},
"error": {
"type": "string"
},
"ci": {
"type": "boolean"
}
},
"required": ["rule", "binary"]
},
"dir": {
"description": "Dir Rule",
"type": "object",
"properties": {
"rule": {
"enum": ["dir", "directory"]
},
"platform": {
"enum": [
"darwin",
"macos",
"freebsd",
"linux",
"sunos",
"win32",
"windows"
]
},
"error": {
"type": "string"
},
"ci": {
"type": "boolean"
}
},
"required": ["rule", "location"]
},
"file": {
"description": "File Rule",
"type": "object",
"properties": {
"rule": {
"enum": ["file"]
},
"platform": {
"enum": [
"darwin",
"macos",
"freebsd",
"linux",
"sunos",
"win32",
"windows"
]
},
"error": {
"type": "string"
},
"ci": {
"type": "boolean"
}
},
"required": ["rule", "location"]
},
"env": {
"description": "ENV Rule",
"type": "object",
"properties": {
"rule": {
"enum": ["env"]
},
"platform": {
"enum": [
"darwin",
"macos",
"freebsd",
"linux",
"sunos",
"win32",
"windows"
]
},
"error": {
"type": "string"
},
"ci": {
"type": "boolean"
}
},
"required": ["rule", "variable"]
},
"shell": {
"description": "Shell Rule",
"type": "object",
"properties": {
"rule": {
"enum": ["shell"]
},
"platform": {
"enum": [
"darwin",
"macos",
"freebsd",
"linux",
"sunos",
"win32",
"windows"
]
},
"error": {
"type": "string"
},
"ci": {
"type": "boolean"
},
"match": {
"type": "string",
"description": "A regexp to search the output."
}
},
"required": ["rule", "match"]
},
"custom": {
"description": "Custom Rule",
"type": "object",
"additionalProperties": true,
"properties": {
"rule": {
"enum": ["custom"]
},
"plugin": {
"type": "string"
},
"name": {
"type": "string"
},
"platform": {
"enum": [
"darwin",
"macos",
"freebsd",
"linux",
"sunos",
"win32",
"windows"
]
},
"error": {
"type": "string"
},
"ci": {
"type": "boolean"
},
"match": {
"type": "string",
"description": "A regexp to search the output."
}
},
"required": ["rule", "plugin", "name"]
}
},
"description": "A rule-set and config for the Solidarity JSON checker",
"id": "https://json.schemastore.org/solidaritySchema.json",
"properties": {
"config": {
"type": "object",
"properties": {
"output": {
"description": "Identify what kind output should happen when a check is called",
"type": "string",
"enum": ["moderate", "verbose", "silent"]
}
}
},
"requirements": {
"description": "List of requirement rules for your particular environment",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/cli"
},
{
"$ref": "#/definitions/dir"
},
{
"$ref": "#/definitions/file"
},
{
"$ref": "#/definitions/env"
},
{
"$ref": "#/definitions/shell"
},
{
"$ref": "#/definitions/custom"
}
]
},
"minItems": 1,
"uniqueItems": true
}
}
},
"required": ["requirements"],
"title": "Solidarity",
"type": "object"
}
|
github-funding.json | {
"$comment": "https://docs.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository",
"$id": "https://json.schemastore.org/github-funding.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"github_username": {
"type": "string",
"maxLength": 39,
"pattern": "^[a-zA-Z0-9](-?[a-zA-Z0-9])*$",
"examples": ["SampleUserName"]
},
"nullable_string": {
"type": ["string", "null"]
}
},
"description": "You can add a sponsor button in your repository to increase the visibility of funding options for your open source project.",
"properties": {
"community_bridge": {
"title": "CommunityBridge",
"description": "Project name on CommunityBridge.",
"$ref": "#/definitions/nullable_string",
"minLength": 1
},
"github": {
"title": "GitHub Sponsors",
"description": "Username or usernames on GitHub.",
"oneOf": [
{
"$ref": "#/definitions/github_username"
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/github_username"
}
}
]
},
"issuehunt": {
"title": "IssueHunt",
"description": "Username on IssueHunt.",
"$ref": "#/definitions/nullable_string",
"minLength": 1
},
"ko_fi": {
"title": "Ko-fi",
"description": "Username on Ko-fi.",
"$ref": "#/definitions/nullable_string",
"minLength": 1
},
"liberapay": {
"title": "Liberapay",
"description": "Username on Liberapay.",
"$ref": "#/definitions/nullable_string",
"minLength": 1
},
"open_collective": {
"title": "Open Collective",
"description": "Username on Open Collective.",
"$ref": "#/definitions/nullable_string",
"minLength": 1
},
"otechie": {
"title": "Otechie",
"description": "Username on Otechie.",
"$ref": "#/definitions/nullable_string",
"minLength": 1
},
"patreon": {
"title": "Patreon",
"description": "Username on Pateron.",
"$ref": "#/definitions/nullable_string",
"minLength": 1,
"maxLength": 100
},
"tidelift": {
"title": "Tidelift",
"description": "Platform and package on Tidelift.",
"$ref": "#/definitions/nullable_string",
"pattern": "^(npm|pypi|rubygems|maven|packagist|nuget)/.+$"
},
"custom": {
"title": "Custom URL",
"description": "Link or links where funding is accepted on external locations.",
"type": ["string", "array", "null"],
"format": "uri-reference",
"items": {
"title": "Link",
"description": "Link to an external location.",
"type": "string",
"format": "uri-reference"
},
"uniqueItems": true
}
},
"title": "GitHub Funding",
"type": "object"
}
|
bitrise-step.json | {
"$ref": "#/definitions/StepModel",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"AptGetDepModel": {
"properties": {
"name": {
"type": "string"
},
"bin_name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"BashStepToolkitModel": {
"properties": {
"entry_file": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"BrewDepModel": {
"properties": {
"name": {
"type": "string"
},
"bin_name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"CheckOnlyDepModel": {
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"DependencyModel": {
"properties": {
"manager": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"DepsModel": {
"properties": {
"brew": {
"items": {
"$ref": "#/definitions/BrewDepModel"
},
"type": "array"
},
"apt_get": {
"items": {
"$ref": "#/definitions/AptGetDepModel"
},
"type": "array"
},
"check_only": {
"items": {
"$ref": "#/definitions/CheckOnlyDepModel"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"GoStepToolkitModel": {
"required": ["package_name"],
"properties": {
"package_name": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"StepModel": {
"properties": {
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"description": {
"type": "string"
},
"website": {
"type": "string"
},
"source_code_url": {
"type": "string"
},
"support_url": {
"type": "string"
},
"published_at": {
"type": "string",
"format": "date-time"
},
"source": {
"$ref": "#/definitions/StepSourceModel"
},
"asset_urls": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"host_os_tags": {
"items": {
"type": "string"
},
"type": "array"
},
"project_type_tags": {
"items": {
"type": "string"
},
"type": "array"
},
"type_tags": {
"items": {
"type": "string"
},
"type": "array"
},
"dependencies": {
"items": {
"$ref": "#/definitions/DependencyModel"
},
"type": "array"
},
"toolkit": {
"$ref": "#/definitions/StepToolkitModel"
},
"deps": {
"$ref": "#/definitions/DepsModel"
},
"is_requires_admin_user": {
"type": "boolean"
},
"is_always_run": {
"type": "boolean"
},
"is_skippable": {
"type": "boolean"
},
"run_if": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"meta": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"inputs": {
"items": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"type": "array"
},
"outputs": {
"items": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"StepSourceModel": {
"properties": {
"git": {
"type": "string"
},
"commit": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
},
"StepToolkitModel": {
"properties": {
"bash": {
"$ref": "#/definitions/BashStepToolkitModel"
},
"go": {
"$ref": "#/definitions/GoStepToolkitModel"
}
},
"additionalProperties": false,
"type": "object"
}
},
"id": "https://json.schemastore.org/bitrise-step.json"
}
|
azure-deviceupdate-update-manifest-5.json | {
"$id": "https://json.schemastore.org/azure-deviceupdate-update-manifest-5.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"miniUpdateManifest": {
"type": "object",
"title": "Mini update manifest",
"description": "Manifest containing metadata of the detached, downloadable, complete update manifest.",
"properties": {
"detachedManifestFileId": {
"$ref": "#/definitions/fileId"
},
"files": {
"type": "object",
"title": "Update manifest file",
"description": "Map of '#/definitions/fileId' to file metadata.",
"additionalProperties": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file"
},
"minProperties": 1,
"maxProperties": 1
}
},
"required": ["detachedManifestFileId", "files"]
},
"fullUpdateManifest": {
"type": "object",
"title": "Complete update manifest.",
"description": "Full update manifest containing metadata of the update being deployed.",
"properties": {
"compatibility": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/compatibility"
},
"instructions": {
"type": "object",
"title": "Installation instructions",
"properties": {
"steps": {
"type": "array",
"title": "Installation steps",
"items": {
"anyOf": [
{
"$ref": "#/definitions/inlineStep"
},
{
"$ref": "#/definitions/referenceStep"
}
]
},
"minItems": 1,
"maxItems": 10
}
},
"required": ["steps"]
},
"files": {
"type": "object",
"title": "Update files",
"description": "Map of '#/definitions/fileId' to file metadata.",
"additionalProperties": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file"
},
"minProperties": 1,
"maxProperties": 20
},
"createdDateTime": {
"type": "string",
"title": "Created date & time",
"description": "Date & time update was created in ISO 8601 format.",
"examples": ["2020-10-02T22:18:04.9446744Z"]
}
},
"required": ["compatibility", "instructions", "files", "createdDateTime"]
},
"fileId": {
"type": "string",
"title": "Update file id",
"description": "Server generated file identifier to be used for retrieving file metadata and download URL.",
"minLength": 1
},
"inlineStep": {
"type": "object",
"title": "Inline installation step",
"description": "Installation instruction step that performs code execution.",
"properties": {
"type": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepType"
},
"handler": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandler"
},
"files": {
"type": "array",
"title": "Step update files",
"description": "'fileId' of update files that agent will pass to handler.",
"items": {
"$ref": "#/definitions/fileId"
},
"minItems": 1,
"maxItems": 10
},
"handlerProperties": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandlerProperties"
}
},
"additionalProperties": false,
"required": ["handler", "files"]
},
"referenceStep": {
"type": "object",
"title": "Reference installation step",
"description": "Installation instruction step that installs another update.",
"properties": {
"type": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/referenceStepType"
},
"detachedManifestFileId": {
"$ref": "#/definitions/fileId"
}
},
"additionalProperties": false,
"required": ["type", "detachedManifestFileId"]
}
},
"description": "JSON schema of update manifest sent by Device Update for IoT Hub to device agent during deployment.",
"examples": [
{
"manifestVersion": "4",
"updateId": {
"provider": "Microsoft",
"name": "Toaster",
"version": "1.0"
},
"compatibility": [
{
"deviceManufacturer": "Microsoft",
"deviceModel": "Toaster"
}
],
"instructions": {
"steps": [
{
"handler": "microsoft/script:1",
"handlerProperties": {
"arguments": "--pre-install"
},
"files": ["fileId0"]
},
{
"type": "reference",
"detachedManifestFileId": "fileId1"
}
]
},
"files": {
"fileId0": {
"filename": "configure.sh",
"sizeInBytes": 718,
"hashes": {
"sha256": "mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="
},
"relatedFiles": [
{
"filename": "in1_in2_deltaupdate.dat",
"sizeInBytes": 102910752,
"hashes": {
"sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
},
"properties": {
"microsoft.sourceFileHashAlgorithm": "sha256",
"microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
}
}
],
"downloadHandler": {
"id": "microsoft/delta:1"
}
},
"fileId1": {
"filename": "microsoft.sensor.1.0.updatemanifest.json",
"sizeInBytes": 2048,
"hashes": {
"sha256": "789s9PDfX4uA9wFUubyC30BWkLFbgmpkpmz1fEdqo2U="
}
}
},
"createdDateTime": "2021-09-28T18:32:01.8404544Z"
}
],
"oneOf": [
{
"$ref": "#/definitions/miniUpdateManifest"
},
{
"$ref": "#/definitions/fullUpdateManifest"
}
],
"properties": {
"$schema": {
"type": "string",
"description": "JSON schema reference"
},
"updateId": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId"
},
"manifestVersion": {
"type": "string",
"title": "Update manifest schema version",
"const": "4"
}
},
"required": ["updateId", "manifestVersion"],
"title": "JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0",
"type": "object"
}
|
winget-pkgs-locale-1.0.0.json | {
"$id": "https://aka.ms/winget-manifest.locale.1.0.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"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"
}
},
"description": "A representation of a multiple-file manifest representing app metadata in other locale in the OWC. v1.0.0",
"properties": {
"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"
},
"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", "null"],
"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", "null"],
"minLength": 2,
"maxLength": 256,
"description": "The package name"
},
"PackageUrl": {
"$ref": "#/definitions/Url",
"description": "The package home page"
},
"License": {
"type": ["string", "null"],
"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", "null"],
"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"
},
"ManifestType": {
"type": "string",
"default": "locale",
"const": "locale",
"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",
"ManifestType",
"ManifestVersion"
],
"type": "object"
}
|
azure-deviceupdate-import-manifest-5.0.json | {
"$id": "https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"instructions": {
"type": "object",
"title": "Installation instructions",
"description": "Update installation instructions.",
"properties": {
"steps": {
"type": "array",
"title": "Installation steps",
"items": {
"anyOf": [
{
"$ref": "#/definitions/inlineStep"
},
{
"$ref": "#/definitions/referenceStep"
}
]
},
"minItems": 1,
"maxItems": 10
}
},
"additionalProperties": false,
"required": ["steps"]
},
"stepDescription": {
"type": "string",
"title": "Step description",
"description": "Optional instruction step description.",
"minLength": 1,
"maxLength": 64
},
"inlineStep": {
"type": "object",
"title": "Inline installation step",
"description": "Installation instruction step that performs code execution.",
"properties": {
"type": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepType"
},
"description": {
"$ref": "#/definitions/stepDescription"
},
"handler": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandler"
},
"files": {
"type": "array",
"title": "Step update files",
"description": "Names of update files that agent will pass to handler.",
"items": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/filename"
},
"minItems": 1,
"maxItems": 10
},
"handlerProperties": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandlerProperties"
}
},
"additionalProperties": false,
"required": ["handler", "files"]
},
"referenceStep": {
"type": "object",
"title": "Reference installation step",
"description": "Installation instruction step that installs another update.",
"properties": {
"type": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/referenceStepType"
},
"description": {
"$ref": "#/definitions/stepDescription"
},
"updateId": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId"
}
},
"additionalProperties": false,
"required": ["type", "updateId"]
}
},
"description": "Schema for import manifest used for importing an update to Device Update for IoT Hub.",
"examples": [
{
"updateId": {
"provider": "Microsoft",
"name": "Toaster",
"version": "1.0"
},
"description": "Example update",
"compatibility": [
{
"deviceManufacturer": "Microsoft",
"deviceModel": "Toaster"
}
],
"instructions": {
"steps": [
{
"description": "pre-install script",
"handler": "microsoft/script:1",
"handlerProperties": {
"arguments": "--pre-install"
},
"files": ["configure.sh"]
},
{
"type": "reference",
"updateId": {
"provider": "Microsoft",
"name": "Sensor",
"version": "1.0"
}
}
]
},
"files": [
{
"filename": "configure.sh",
"sizeInBytes": 718,
"hashes": {
"sha256": "mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="
},
"relatedFiles": [
{
"filename": "in1_in2_deltaupdate.dat",
"sizeInBytes": 102910752,
"hashes": {
"sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
},
"properties": {
"microsoft.sourceFileHashAlgorithm": "sha256",
"microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
}
}
],
"downloadHandler": {
"id": "microsoft/delta:1"
}
}
],
"manifestVersion": "5.0",
"createdDateTime": "2020-10-02T22:18:04.9446744Z"
}
],
"properties": {
"$schema": {
"type": "string",
"description": "JSON schema reference."
},
"updateId": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId"
},
"description": {
"type": "string",
"title": "Update description",
"description": "Optional update description.",
"minLength": 1,
"maxLength": 512
},
"compatibility": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/compatibility"
},
"instructions": {
"$ref": "#/definitions/instructions"
},
"files": {
"type": "array",
"title": "Update files",
"description": "List of update payload files. Sum of all file sizes may not exceed 2 GB. May be empty or null if all instruction steps are reference steps.",
"items": {
"$ref": "azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file"
},
"minItems": 0,
"maxItems": 10
},
"manifestVersion": {
"type": "string",
"title": "Import manifest schema version",
"description": "Import manifest schema version. Must be 5.0.",
"const": "5.0"
},
"createdDateTime": {
"type": "string",
"title": "Created date & time",
"description": "Date & time import manifest was created in ISO 8601 format.",
"examples": ["2020-10-02T22:18:04.9446744Z"]
}
},
"required": [
"updateId",
"compatibility",
"instructions",
"manifestVersion",
"createdDateTime"
],
"title": "JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0",
"type": "object"
}
|
server.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "dolittle.io/schemas/Runtime/Server/server.json",
"title": "Server Configuration",
"description": "The event horizon server configuration",
"type": "object",
"properties": {
"interaction": {
"description": "The configuration for the interaction server",
"type": "object",
"properties": {
"enabled": {
"description": "Whether or not the interaction server is enabled",
"type": "boolean"
},
"port": {
"description": "The port to use for exposing the interaction server",
"type": "number"
},
"unixSocket": {
"description": "The unix socket to use for exposing the interaction server on",
"type": "string",
"format": "uri-reference"
}
}
},
"management": {
"port": {
"description": "The port to use for exposing the management server",
"type": "number"
},
"unixSocket": {
"description": "The unix socket to use for exposing the management server on",
"type": "string",
"format": "uri-reference"
}
}
},
"required": [
"interaction",
"management"
]
} |
gateway-config-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://dwp.gov.uk/exchange/publishing-tools/gateway-config-schema.json",
"title": "Gateway configuration",
"type": "object",
"properties": {
"services": {
"title": "Services",
"type": "array",
"items":
{
"$ref": "service-schema.json"
}
}
},
"additionalProperties": false,
"required": [
"services"
]
}
|
drupal-permissions.json | {
"$id": "https://json.schemastore.org/drupal-permissions.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {
"title": "Permission definition",
"type": "object",
"required": ["title"],
"properties": {
"title": {
"title": "The human-readable name of the permission",
"type": "string"
},
"description": {
"title": "A description of what the permission does",
"type": "string"
},
"restrict access": {
"title": "Restrict access to this permission to trusted users",
"description": "This should be used for permissions that have inherent security risks across a variety of potential use cases (for example, the \"administer filters\" and \"bypass node access\" permissions provided by Drupal core).",
"type": "boolean"
}
},
"additionalProperties": false
},
"properties": {
"permission_callbacks": {
"title": "List of permission callbacks",
"type": "array",
"items": {
"title": "A callback that return array of permissions",
"type": "string"
},
"uniqueItems": true
}
},
"title": "JSON schema for Drupal permissions file",
"type": "object"
}
|
minecraft-texture-mcmeta.json | {
"$id": "https://json.schemastore.org/minecraft-texture-mcmeta.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A mcmeta file for an animated texture for a Minecraft resource pack config schema",
"properties": {
"animation": {
"description": "Animation",
"type": "object",
"properties": {
"interpolate": {
"type": "boolean",
"default": false
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"frametime": {
"type": "integer",
"default": 1
},
"frames": {
"type": "array",
"items": {
"oneOf": [
{
"type": "integer"
},
{
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"time": {
"type": "integer"
}
}
}
]
}
}
}
}
},
"required": ["animation"],
"title": "Minecraft Resource Pack Texture Mcmeta",
"type": "object"
}
|
shopware-extension-schema.json | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "shopware-cli",
"$ref": "#/definitions/Config",
"description": "shopware cli extension configuration definition file",
"definitions": {
"Config": {
"type": "object",
"title": ".shopware-extension.yml",
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/Build"
},
"store": {
"$ref": "#/definitions/Store"
},
"changelog": {
"$ref": "#/definitions/Changelog"
}
}
},
"Changelog": {
"type": "object",
"title": "changelog",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": false,
"description": "Enables the changelog generation."
},
"ai_enabled": {
"type": "boolean",
"default": false,
"description": "Enables the changelog generation with OpenAI (Requires OPENAI_TOKEN environment variable)."
},
"pattern": {
"type": "string",
"default": "",
"description": "Limit with RegEx which commits should be considered for the changelog generation."
},
"template": {
"type": "string",
"default": "",
"description": "Allows to override the Go template which renders the Changelog."
},
"variables": {
"type": "object",
"description": "Allows to write RegEx groups into variables which can be used in the template."
}
}
},
"Build": {
"type": "object",
"title": "build",
"additionalProperties": false,
"properties": {
"shopwareVersionConstraint": {
"type": "string",
"description": "Overrides the shopware version constraint in the composer.json/manifest.xml file."
},
"extraBundles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["path"],
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
}
}
}
},
"zip": {
"type": "object",
"additionalProperties": false,
"properties": {
"composer": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"before_hooks": {
"type": "array",
"items": {"type": "string"}
},
"after_hooks": {
"type": "array",
"items": {"type": "string"}
},
"excluded_packages": {
"type": "array",
"items": {"type": "string"}
}
}
},
"assets": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"before_hooks": {
"type": "array",
"items": {"type": "string"}
},
"after_hooks": {
"type": "array",
"items": {"type": "string"}
},
"enable_es_build_for_admin": {
"type": "boolean",
"default": false
},
"enable_es_build_for_storefront": {
"type": "boolean",
"default": false
}
}
},
"pack": {
"type": "object",
"additionalProperties": false,
"properties": {
"before_hooks": {
"type": "array",
"items": {"type": "string"}
},
"excludes": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"paths": {
"type": "array",
"items": {"type": "string"}
}
}
}
}
}
}
}
}
},
"Store": {
"type": "object",
"title": "store",
"additionalProperties": false,
"properties": {
"icon": {
"type": "string",
"description": "Specifies the Path to the icon (128x128 px) for store."
},
"availabilities": {
"type": "array",
"description": "Specifies the visibility in stores.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"German",
"International"
]
}
},
"localizations": {
"type": "array",
"description": "Specifies the languages the extension is translated.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"de_DE",
"en_GB",
"es_ES",
"fi_FI",
"fr_FR",
"it_IT",
"nb_NO",
"nl_NL",
"pl_PL",
"sv_SE",
"bg_BG",
"cs_CZ",
"pt_PT",
"hy",
"de_CH",
"tr",
"da_DK",
"ru_RU"
]
}
},
"categories": {
"type": "array",
"description": "Specifies the categories in which the extension can be found.",
"uniqueItems": true,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"Administration",
"SEOOptimierung",
"Bonitaetsprüfung",
"Rechtssicherheit",
"Auswertung",
"KommentarFeedback",
"Tracking",
"Integration",
"PreissuchmaschinenPortale",
"Warenwirtschaft",
"Versand",
"Bezahlung",
"StorefrontDetailanpassungen",
"Sprache",
"Suche",
"HeaderFooter",
"Detailseite",
"MenueKategorien",
"Bestellprozess",
"KundenkontoPersonalisierung",
"Sonderfunktionen",
"Themes",
"Branche",
"Home+Furnishings",
"FashionBekleidung",
"GartenNatur",
"KosmetikGesundheit",
"EssenTrinken",
"KinderPartyGeschenke",
"SportLifestyleReisen",
"TechnikIT",
"IndustrieGroßhandel",
"MigrationTools",
"Einkaufswelten",
"ConversionOptimierung",
"Extensions",
"MarketingTools",
"B2BExtensions",
"Blog",
"emailMarketing",
"promotionsAndVoucher",
"loyalityAndRewards",
"recommendations",
"otherMarketingCommercials",
"socialCommerce",
"middlewareAndConnectors",
"pim",
"dam",
"cms",
"crm",
"personalization"
]
}
},
"default_locale": {
"type": "string",
"enum": [
"en_GB",
"de_DE"
]
},
"type": {
"type": "string",
"description": "Specifies the type of this extension.",
"enum": [
"extension",
"theme"
]
},
"automatic_bugfix_version_compatibility": {
"type": "boolean",
"description": "Specifies whether the extension should automatically be set compatible with Shopware bugfix versions."
},
"videos": {
"type": "object",
"description": "Specifies the links of YouTube-Videos to show or describe the extension.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"de": {
"type": "array",
"maxItems": 2,
"items": {
"type": "string"
}
},
"en": {
"type": "array",
"maxItems": 2,
"items": {
"type": "string"
}
}
}
},
"tags": {
"type": "object",
"description": "Specifies the tags of the extension.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"de": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5
},
"en": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5
}
}
},
"highlights": {
"type": "object",
"description": "Specifies the highlights of the extension.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"de": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5
},
"en": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5
}
}
},
"features": {
"type": "object",
"description": "Specifies the features of the extension.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"de": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 15
},
"en": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 15
}
}
},
"faq": {
"type": "object",
"description": "Specifies Frequently Asked Questions for the extension.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"de": {
"type": "array",
"items": {
"$ref": "#/definitions/StoreInfoFaqQuestion"
}
},
"en": {
"type": "array",
"items": {
"$ref": "#/definitions/StoreInfoFaqQuestion"
}
}
}
},
"description": {
"type": "object",
"description": "Specifies the description of the extension in store.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"de": {
"type": "string",
"description": "Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_de.md`"
},
"en": {
"type": "string",
"description": "Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_en.md`"
}
}
},
"installation_manual": {
"type": "object",
"description": "Installation manual of the extension in store.",
"additionalProperties": false,
"properties": {
"de": {
"type": "string",
"description": "Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_de.md`"
},
"en": {
"type": "string",
"description": "Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_en.md`"
}
}
},
"images": {
"type": "array",
"description": "Specifies images for the extension in the store.",
"minItems": 1,
"items": {
"type": "object",
"required": ["file", "priority"],
"additionalProperties": false,
"properties": {
"file": {
"type": "string",
"description": "File path to image relative from root of the extension"
},
"activate": {
"type": "object",
"description": "Specifies whether the image is active in the language.",
"additionalProperties": false,
"properties": {
"en": {
"type": "boolean"
},
"de": {
"type": "boolean"
}
}
},
"preview": {
"type": "object",
"description": "Specifies whether the image is a preview in the language.",
"additionalProperties": false,
"properties": {
"en": {
"type": "boolean"
},
"de": {
"type": "boolean"
}
}
},
"priority": {
"description": "Specifies the order of the image ascending the given priority.",
"type": "integer",
"minimum": 0
}
}
}
}
}
},
"StoreInfoFaqQuestion": {
"type": "object",
"title": "StoreInfoFaqQuestion",
"additionalProperties": false,
"required": [
"question",
"answer"
],
"properties": {
"question": {
"type": "string"
},
"answer": {
"type": "string"
}
}
}
}
}
|
ifstate.conf.schema.json | {
"$id": "https://ifstate.net/schema/ifstate.conf.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ifstate.conf",
"description": "IfState 1.8.2 Configuration Schema",
"type": "object",
"required": [
"interfaces"
],
"$defs": {
"ignore-ipaddr": {
"description": "list of ip address prefixes to be ignored",
"type": "array",
"items": {
"description": "ip address with prefix length",
"type": "string",
"examples": [
"fe80::/10"
]
}
},
"ignore-ifname": {
"description": "interface names matching this list of regex will be ignored",
"type": "array",
"items": {
"description": "regex to match interface name",
"examples": [
"^br-[\\da-f]{12}",
"^docker\\d+",
"^lo$",
"^ppp\\d+$",
"^veth",
"^virbr\\d+",
"^vrrp\\d*\\.\\d+$"
],
"type": "string"
}
},
"ignore-routes": {
"description": "filter routes by options",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"dev": {
"type": [
"integer",
"string"
]
},
"proto": {
"type": [
"integer",
"string"
],
"default": "boot"
},
"realm": {
"type": [
"integer",
"string"
]
},
"scope": {
"type": [
"integer",
"string"
]
},
"table": {
"type": [
"integer",
"string"
],
"default": "main"
},
"to": {
"type": "string"
},
"via": {
"type": "string"
}
}
}
},
"ignore-rules": {
"description": "filter rules by options",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"action": {
"type": [
"integer",
"string"
],
"description": "the type of this rule",
"enum": [
"to_tbl",
"blackhole",
"unreachable",
"prohibit"
],
"default": "to_tbl"
},
"table": {
"type": [
"integer",
"string"
],
"minimum": 0,
"maximum": 255
},
"priority": {
"type": "integer",
"description": "the priority of this rule",
"minimum": 0,
"maximum": 4294967295
},
"from": {
"type": "string",
"description": "select the source prefix to match"
},
"to": {
"type": "string",
"description": "select the destination prefix to match"
},
"iif": {
"type": "string",
"description": "select the incoming device to match"
},
"oif": {
"type": "string",
"description": "select the outgoing device to match"
},
"proto": {
"type": [
"integer",
"string"
],
"default": "unspec",
"description": "routing protocol number (`/etc/iproute2/rt_protos`)"
},
"fwmark": {
"type": "integer",
"description": "select the *fwmark* value to match"
},
"ipproto": {
"type": [
"integer",
"string"
],
"description": "select the ip protocol to match"
}
}
}
},
"iface-name": {
"type": "string",
"pattern": "^[^/ ]{1,15}$"
},
"iface-link_address": {
"type": "string",
"description": "link mac address (xx:xx:xx:xx:xx:xx)",
"pattern": "^([a-f0-9]{2}:){5}[a-f0-9]{2}$"
},
"iface-link_group": {
"type": [
"integer",
"string"
],
"description": "specifies a device group name or index"
},
"iface-link_link": {
"type": [
"integer",
"string"
],
"description": "specifies a parent device name or index"
},
"iface-link_master": {
"type": [
"integer",
"string"
],
"description": "specifies a master device name or index"
},
"iface-link_mtu": {
"type": "integer",
"description": "change the mtu of the device",
"minimum": 68,
"maximum": 65536
},
"iface-link_state": {
"type": "string",
"description": "set device state",
"enum": [
"up",
"down"
]
},
"iface-link_txqlen": {
"type": "integer",
"description": "the transmit queue length of the device"
},
"iface-link_ifalias": {
"type": "string",
"description": "symbolic name for easy reference"
},
"iface-link_tun-remote4": {
"type": "string",
"description": "remote IPv4 address of the tunnel",
"format": "ipv4"
},
"iface-link_tun-local4": {
"type": "string",
"description": "local IPv4 address of the tunnel",
"format": "ipv4"
},
"iface-link_tun-remote6": {
"type": "string",
"description": "remote IPv4 address of the tunnel",
"format": "ipv6"
},
"iface-link_tun-local6": {
"type": "string",
"description": "local IPv4 address of the tunnel",
"format": "ipv6"
},
"iface-link_tun-dev": {
"$ref": "#/$defs/iface-link_link",
"description": "interface to use for tunnel endpoint communication"
},
"iface-sysctl": {
"type": "object",
"description": "configures [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt)",
"additionalProperties": false,
"properties": {
"ipv4": {
"type": "object",
"description": "settings in `/proc/sys/net/ipv4/*/conf/`",
"properties": {
"accept_local": {
"type": "integer"
},
"accept_redirects": {
"type": "integer"
},
"accept_source_route": {
"type": "integer"
},
"arp_accept": {
"type": "integer"
},
"arp_announce": {
"type": "integer"
},
"arp_filter": {
"type": "integer"
},
"arp_ignore": {
"type": "integer"
},
"arp_notify": {
"type": "integer"
},
"bc_forwarding": {
"type": "integer"
},
"bootp_relay": {
"type": "integer"
},
"disable_policy": {
"type": "integer"
},
"disable_xfrm": {
"type": "integer"
},
"drop_gratuitous_arp": {
"type": "integer"
},
"drop_unicast_in_l2_multicast": {
"type": "integer"
},
"force_igmp_version": {
"type": "integer"
},
"forwarding": {
"type": "integer"
},
"igmpv2_unsolicited_report_interval": {
"type": "integer"
},
"igmpv3_unsolicited_report_interval": {
"type": "integer"
},
"ignore_routes_with_linkdown": {
"type": "integer"
},
"log_martians": {
"type": "integer"
},
"mc_forwarding": {
"type": "integer"
},
"medium_id": {
"type": "integer"
},
"promote_secondaries": {
"type": "integer"
},
"proxy_arp": {
"type": "integer"
},
"proxy_arp_pvlan": {
"type": "integer"
},
"route_localnet": {
"type": "integer"
},
"rp_filter": {
"type": "integer"
},
"secure_redirects": {
"type": "integer"
},
"send_redirects": {
"type": "integer"
},
"shared_media": {
"type": "integer"
},
"src_valid_mark": {
"type": "integer"
},
"tag": {
"type": "integer"
}
}
},
"ipv6": {
"type": "object",
"description": "settings in `/proc/sys/net/ipv6/*/conf/`",
"additionalProperties": false,
"properties": {
"accept_dad": {
"type": "integer"
},
"accept_ra": {
"type": "integer"
},
"accept_ra_defrtr": {
"type": "integer"
},
"accept_ra_from_local": {
"type": "integer"
},
"accept_ra_min_hop_limit": {
"type": "integer"
},
"accept_ra_mtu": {
"type": "integer"
},
"accept_ra_pinfo": {
"type": "integer"
},
"accept_ra_rt_info_max_plen": {
"type": "integer"
},
"accept_ra_rt_info_min_plen": {
"type": "integer"
},
"accept_ra_rtr_pref": {
"type": "integer"
},
"accept_redirects": {
"type": "integer"
},
"accept_source_route": {
"type": "integer"
},
"addr_gen_mode": {
"type": "integer"
},
"autoconf": {
"type": "integer"
},
"dad_transmits": {
"type": "integer"
},
"disable_ipv6": {
"type": "integer"
},
"disable_policy": {
"type": "integer"
},
"drop_unicast_in_l2_multicast": {
"type": "integer"
},
"drop_unsolicited_na": {
"type": "integer"
},
"enhanced_dad": {
"type": "integer"
},
"force_mld_version": {
"type": "integer"
},
"force_tllao": {
"type": "integer"
},
"forwarding": {
"type": "integer"
},
"hop_limit": {
"type": "integer"
},
"ignore_routes_with_linkdown": {
"type": "integer"
},
"keep_addr_on_down": {
"type": "integer"
},
"max_addresses": {
"type": "integer"
},
"max_desync_factor": {
"type": "integer"
},
"mc_forwarding": {
"type": "integer"
},
"mldv1_unsolicited_report_interval": {
"type": "integer"
},
"mldv2_unsolicited_report_interval": {
"type": "integer"
},
"mtu": {
"type": "integer"
},
"ndisc_notify": {
"type": "integer"
},
"ndisc_tclass": {
"type": "integer"
},
"optimistic_dad": {
"type": "integer"
},
"proxy_ndp": {
"type": "integer"
},
"regen_max_retry": {
"type": "integer"
},
"router_probe_interval": {
"type": "integer"
},
"router_solicitation_delay": {
"type": "integer"
},
"router_solicitation_interval": {
"type": "integer"
},
"router_solicitation_max_interval": {
"type": "integer"
},
"router_solicitations": {
"type": "integer"
},
"seg6_enabled": {
"type": "integer"
},
"seg6_require_hmac": {
"type": "integer"
},
"stable_secret": {
"type": "string",
"format": "ipv6"
},
"suppress_frag_ndisc": {
"type": "integer"
},
"temp_prefered_lft": {
"type": "integer"
},
"temp_valid_lft": {
"type": "integer"
},
"use_oif_addrs_only": {
"type": "integer"
},
"use_optimistic": {
"type": "integer"
},
"use_tempaddr": {
"type": "integer"
}
}
}
}
},
"iface-ethtool_onoff": {
"type": [
"boolean",
"string"
],
"enum": [
"on",
"off",
true,
false
]
},
"iface-tc_qid": {
"type": "string",
"description": "qdisc id",
"format": "^(root|[0-9a-f]+:[0-9a-f]*)$"
},
"iface-tc_protocol": {
"type": [
"string",
"integer"
],
"description": "protocol selector",
"minLength": 2,
"minimum": 0,
"maximum": 255,
"default": 3
},
"iface-tc_prio": {
"type": "integer",
"description": "priority",
"minimum": 0,
"maximum": 65535
},
"iface-tc_qdisc": {
"description": "traffic control queueing discipline",
"type": "object",
"required": [
"handle"
],
"properties": {
"handle": {
"description": "unique id",
"$ref": "#/$defs/iface-tc_qid"
}
},
"oneOf": [
{
"description": "generic classless qdisc",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"description": "qdisk type",
"enum": [
"gred",
"hhf",
"mqprio",
"multiq",
"netem",
"pfifo_fast",
"pie",
"red",
"sfb",
"sfq",
"tbf"
]
}
}
},
{
"$ref": "#/$defs/tc-cake"
},
{
"description": "[choke](https://man7.org/linux/man-pages/man8/tc-choke.8.html) - choose and keep scheduler",
"required": [
"kind",
"limit",
"min",
"max",
"avpkt",
"burst",
"probability"
],
"properties": {
"kind": {
"const": "choke",
"description": "qdisk type"
}
}
},
{
"description": "[CoDel](https://man7.org/linux/man-pages/man8/tc-codel.8.html) - Controlled-Delay Active Queue Management algorithm",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "codel",
"description": "qdisk type"
}
}
},
{
"description": "[bfifo](https://man7.org/linux/man-pages/man8/tc-bfifo.8.html) - Byte limited First In, First Out queue; [pfifo](https://man7.org/linux/man-pages/man8/tc-pfifo.8.html) - Packet limited First In, First Out queue",
"required": [
"kind"
],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "qdisk type",
"enum": [
"bfifo",
"pfifo"
]
},
"limit": {
"type": "number",
"description": "queue size in bytes or packets"
}
}
},
{
"description": "[fq](https://man7.org/linux/man-pages/man8/tc-fq.8.html) - Fair Queue traffic policing",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "fq",
"description": "qdisk type"
},
"limit": {
"type": "number",
"description": "hard limit on the real queue size (number of packets)"
},
"flow_limit": {
"type": "number",
"description": "hard limit on the max number of packets per flow"
}
}
},
{
"description": "[fq_codel](https://man7.org/linux/man-pages/man8/tc-fq_codel.8.html) - Fair Queuing (FQ) with Controlled Delay (CoDel)",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "fq_codel",
"description": "qdisk type"
},
"limit": {
"type": "number",
"description": "hard limit on the real queue size (number of packets)"
},
"flows": {
"type": "number",
"description": "number of flows"
}
}
},
{
"description": "generic classful qdisc",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"description": "qdisk type",
"enum": [
"atm",
"cbq",
"drr",
"dsmark",
"hfsc",
"htb",
"prio",
"qfq"
]
}
}
},
{
"description": "classful multiqueue dummy scheduler",
"required": [
"kind",
"children"
],
"properties": {
"kind": {
"const": "mq",
"description": "qdisk type"
},
"children": {
"description": "list child qdiscs for each device TX queue",
"type": "array",
"items": {
"description": "child qdiscs for the nth device TX queue",
"$ref": "#/$defs/iface-tc_qdisc"
}
}
}
}
]
},
"tc-cake": {
"description": "[cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) - common applications kept enhanced (CAKE)",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "cake",
"description": "qdisk type"
},
"handle": {
"description": "unique id",
"$ref": "#/$defs/iface-tc_qid"
},
"ack_filter": {
"description": "ACKnowledge filter",
"type": [
"boolean",
"string"
],
"enum": [
"aggressive",
true,
false
]
},
"atm_mode": {
"description": "ATM mode",
"type": [
"boolean",
"string"
],
"enum": [
"ptm",
true,
false
]
},
"autorate": {
"type": "boolean",
"description": "autorate-ingress"
},
"diffserv_mode": {
"type": "string",
"description": "diffserv mode",
"enum": [
"diffserv3",
"diffserv4",
"diffserv8",
"besteffort",
"precedence"
]
},
"ingress": {
"description": "ingress",
"type": "boolean"
},
"overhead": {
"description": "overhead",
"type": "integer",
"minimum": -64,
"maximum": 256
},
"flow_mode": {
"description": "flow mode",
"type": "string",
"enum": [
"flowblind",
"srchost",
"dsthost",
"hosts",
"flows",
"dual-srchost",
"dual-dsthost",
"triple-isolated"
]
},
"fwmark": {
"description": "fwmark",
"type": "integer",
"minimum": 0
},
"memlimit": {
"description": "memlimit",
"type": "integer",
"minimum": 0
},
"mpu": {
"description": "MPU",
"type": "integer",
"minimum": 0,
"maximum": 256
},
"nat": {
"description": "NAT",
"type": "boolean"
},
"raw": {
"description": "RAW",
"type": "boolean"
},
"rtt": {
"oneOf": [
{
"type": "string",
"description": "well-known RTT",
"enum": [
"datacentre",
"lan",
"metro",
"regional",
"internet",
"oceanic",
"satellite",
"interplanetary"
]
},
{
"type": "integer",
"description": "manually specify an RTT (us)",
"minimum": 1
}
]
},
"split_gso": {
"description": "split GSO",
"type": "boolean"
},
"target": {
"type": "integer",
"description": "target",
"minimum": 1
},
"wash": {
"description": "wash",
"type": "boolean"
}
}
},
"iface-tc_action": {
"description": "traffic control filter action",
"type": "array",
"items": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "mirred"
}
},
"oneOf": [
{
"description": "[mirred](https://man7.org/linux/man-pages/man8/tc-mirred.8.html) - mirror/redirect action",
"additionalProperties": false,
"required": [
"direction",
"action",
"dev"
],
"properties": {
"kind": {
"const": "mirred"
},
"direction": {
"description": "packet direction",
"type": "string",
"enum": [
"ingress",
"egress"
]
},
"action": {
"description": "copy (`mirror`) or move (`redirect`) packets to the destination interface",
"type": "string",
"enum": [
"mirror",
"redirect"
]
},
"dev": {
"description": "destination interface where packets are redirected or mirrored to",
"$ref": "#/$defs/iface-link_link"
},
"index": {
"description": "unique action ID",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
}
}
]
}
},
"xdp_mode": {
"mode": {
"oneOf": [
{
"description": "force attach mode of the XDP program (`auto`: let the kernel choose, `xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)",
"type": "string",
"enum": [
"auto",
"xdp",
"xdpgeneric",
"xdpoffload"
],
"default": "auto"
},
{
"description": "allowed attach modes of the XDP program (`xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)",
"type": "array",
"items": {
"type": "string",
"enum": [
"xdp",
"xdpgeneric",
"xdpoffload"
]
}
}
]
}
}
},
"additionalProperties": false,
"properties": {
"options": {
"description": "global configuration settings",
"type": "object",
"additionalProperties": false,
"properties": {
"sysctl": {
"type": "object",
"properties": {
"all": {
"description": "overrides [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/all/`",
"$ref": "#/$defs/iface-sysctl"
},
"default": {
"description": "default [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/default/`",
"$ref": "#/$defs/iface-sysctl"
}
}
}
}
},
"ignore": {
"description": "ignore patterns to skip interface, ip address or routing objects",
"type": "object",
"additionalProperties": false,
"properties": {
"ipaddr_builtin": {
"$ref": "#/$defs/ignore-ipaddr"
},
"ipaddr": {
"$ref": "#/$defs/ignore-ipaddr"
},
"ipaddr_dynamic": {
"description": "ignore dynamic assigned ip addresses",
"type": "boolean",
"default": true
},
"ifname_builtin": {
"$ref": "#/$defs/ignore-ifname"
},
"ifname": {
"$ref": "#/$defs/ignore-ifname"
},
"routes_builtin": {
"$ref": "#/$defs/ignore-routes"
},
"routes": {
"$ref": "#/$defs/ignore-routes"
},
"rules_builtin": {
"$ref": "#/$defs/ignore-rules"
},
"rules": {
"$ref": "#/$defs/ignore-rules"
}
}
},
"bpf": {
"description": "load and pin eBPF programs (i.e. for XDP)",
"type": "object",
"patternProperties": {
"": {
"description": "BPF program",
"type": "object",
"additionalProperties": false,
"required": [
"object",
"section"
],
"properties": {
"object": {
"description": "BPF ELF file to load",
"type": "string"
},
"section": {
"description": "BPF program's section name",
"type": "string"
}
}
}
}
},
"cshaper": {
"description": "cshaper templates",
"type": "object",
"patternProperties": {
"": {
"description": "cshaper profile",
"type": "object",
"additionalProperties": false,
"required": [
"egress_qdisc",
"ingress_qdisc",
"ingress_ifname"
],
"properties": {
"egress_qdisc": {
"$ref": "#/$defs/tc-cake"
},
"ingress_qdisc": {
"$ref": "#/$defs/tc-cake"
},
"ingress_ifname": {
"description": "build a ifb ifname using a regex on the ifname",
"type": "object",
"additionalProperties": false,
"required": [
"search",
"replace"
],
"properties": {
"search": {
"description": "pattern to search",
"type": "string"
},
"replace": {
"description": "replace pattern by string",
"type": "string"
}
}
}
}
}
},
"required": [
"default"
]
},
"interfaces": {
"description": "list of interface settings (link settings and ip addresses)",
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/$defs/iface-name",
"description": "name of the interface"
},
"addresses": {
"description": "ip addresses of the interface",
"type": "array",
"items": {
"type": "string",
"examples": [
"192.0.2.1",
"192.168.0.1/24",
"2001:db8::1/64"
]
}
},
"brport": {
"description": "settings for bridge ports",
"type": "object",
"additionalProperties": false,
"properties": {
"priority": {
"description": "set port priority",
"type": "integer",
"minimum": 0,
"maximum": 63
},
"cost": {
"description": "set port cost",
"minimum": 1,
"maximum": 65535
},
"guard": {
"description": "filter BPDU packets",
"type": "boolean"
},
"mode": {
"description": "enable hairpin mode",
"type": "boolean"
},
"fast_leave": {
"description": "enable multicast fast leave",
"type": "boolean"
},
"protect": {
"description": "prevent to become a root port",
"type": "boolean"
},
"learning": {
"description": "allow MAC address learning",
"type": "boolean"
},
"unicast_flood": {
"description": "flood unknown unicasts",
"type": "boolean"
},
"bcast_flood": {
"description": "flood broadcasts",
"type": "boolean"
},
"mcast_flood": {
"description": "flood multicasts",
"type": "boolean"
},
"mcast_to_ucast": {
"description": "clone multicast packets into unicasts",
"type": "boolean"
},
"proxyarp": {
"description": "enable proxy ARP",
"type": "boolean"
},
"proxyarp_wifi": {
"description": "enable proxy ARP (IEEE 802.11 and Hotspot 2.0)",
"type": "boolean"
},
"neigh_suppress": {
"description": "ARP and ND suppression",
"type": "boolean"
},
"vlan_tunnel": {
"description": "VLAN to tunnel mapping",
"type": "boolean"
},
"backup_port": {
"description": "backup bridge port on loss carrier",
"$ref": "#/$defs/iface-link_link"
},
"isolated": {
"description": "isolated port, can communicate only with non-isolated ports",
"type": "boolean"
}
}
},
"vrrp": {
"description": "interface depending on vrrp status",
"type": "object",
"required": [
"name",
"type",
"states"
],
"additionalProperties": false,
"properties": {
"name": {
"description": "related vrrp INSTANCE or GROUP name",
"type": "string"
},
"type": {
"description": "failover type",
"type": "string",
"enum": [
"instance",
"group"
]
},
"states": {
"description": "states at which the interface should be configured",
"type": "array",
"items": [
{
"type": "string",
"enum": [
"unknown",
"fault",
"backup",
"master"
]
}
]
}
}
},
"link": {
"description": "link settings of the interface",
"type": "object",
"oneOf": [
{
"description": "Intermediate Functional Block device",
"required": [
"kind"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "ifb",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Virtual tunnel interface IPv4|IPv6 over IPv6",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "ip6tnl",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "IP over Infiniband device",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "ipoib",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Interface for L3 (IPv6/IPv4) based VLANs",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "ipvlan",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Virtual interface base on link layer address (MAC)",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "macvlan",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Virtual interface based on link layer address (MAC) and TAP",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "macvtap",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Team network device",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "team",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Virtual software device (TUN/TAP)",
"required": [
"kind",
"tun_type"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "tun",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"tun_type": {
"description": "device mode (Ethernet headers)",
"default": "tap",
"enum": [
1,
"tun",
2,
"tap"
]
},
"tun_pi": {
"description": "provide packet information",
"type": [
"boolean",
"integer"
],
"default": false,
"enum": [
0,
false,
1,
true
]
},
"tun_persist": {
"description": "persistent device; non-persistent devices cannot be created",
"type": [
"boolean",
"integer"
],
"default": false,
"enum": [
0,
false,
1,
true
]
},
"tun_vnet_hdr": {
"description": "prepend frames with struct virtio_net_hdr",
"default": false,
"enum": [
0,
false,
1,
true
]
},
"tun_multi_queue": {
"description": "enable multiqueue tuntap",
"type": [
"boolean",
"integer"
],
"default": false,
"enum": [
0,
false,
1,
true
]
},
"tun_owner": {
"description": "device owner",
"type": [
"integer",
"string"
]
},
"tun_group": {
"description": "device group",
"type": [
"integer",
"string"
]
}
}
},
{
"description": "Virtual Routing and Forwarding device",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "vrf",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Virtual tunnel interface over IPv4",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "vti",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Virtual tunnel interface over IPv6",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "vti6",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Bonding network interface",
"required": [
"kind"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "bond",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"bond_mode": {
"enum": [
0,
"balance-rr",
1,
"active-backup",
2,
"balance-xor",
3,
"broadcast",
4,
"802.3ad",
5,
"balance-tlb",
6,
"balance-alb"
],
"default": "balance-rr",
"description": "the bonding policy"
},
"bond_miimon": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "MII link monitoring frequency in milliseconds"
},
"bond_updelay": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "time, in milliseconds, to wait before enabling a slave after a link recovery has been detected"
},
"bond_downdelay": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "time, in milliseconds, to wait before disabling a slave after a link failure has been detected"
},
"bond_use_carrier": {
"enum": [
0,
1
],
"default": 1,
"description": "use MII or ETHTOOL ioctls vs. netif_carrier_ok() to determine the link status"
},
"bond_arp_interval": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "ARP link monitoring frequency in milliseconds"
},
"bond_arp_validate": {
"enum": [
0,
"none",
1,
"active",
2,
"backup",
3,
"all",
4,
"filter",
5,
"filter_active",
6,
"filter_backup"
],
"default": "none",
"description": "arp validation for arp monitoring"
},
"bond_arp_all_targets": {
"enum": [
0,
"any",
1,
"all"
],
"default": "any",
"description": "quantity of arp_ip_targets that must be reachable"
},
"bond_primary_reselect": {
"enum": [
0,
"always",
1,
"better",
2,
"failure"
],
"default": "always",
"description": "reselection policy for the primary slave"
},
"bond_fail_over_mac": {
"enum": [
0,
"none",
1,
"active",
2,
"follow"
],
"default": "none",
"description": "slave mac address selection"
},
"bond_xmit_hash_policy": {
"enum": [
0,
"layer2",
1,
"layer3+4",
2,
"layer2+3",
3,
"encap2+3",
4,
"encap3+4",
5,
"vlan+srcmac"
],
"default": "layer2",
"description": "transmit hash policy to use for slave selection"
},
"bond_resend_igmp": {
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 1,
"description": "number of IGMP membership reports to be issued after a failover event"
},
"bond_num_peer_notif": {
"type": "integer",
"minimum": 0,
"default": 1
},
"bond_all_slaves_active": {
"enum": [
0,
1
],
"default": 1,
"description": "dropped (0) or delivered (1) duplicate frames"
},
"bond_min_links": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "number of links that must be active before asserting carrier"
},
"bond_lp_interval": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
"default": 1,
"description": "number of seconds between instances where the bonding driver sends learning packets to each slaves peer switch"
},
"bond_packets_per_slave": {
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 1,
"description": "number of packets to transmit through a slave before moving to the next one"
},
"bond_ad_lacp_rate": {
"enum": [
0,
"slow",
1,
"fast"
],
"default": "slow",
"description": "requested LACPDU packet rate in 802.3ad mode"
},
"bond_ad_select": {
"enum": [
0,
"stable",
1,
"bandwidth",
2,
"count"
],
"default": "stable",
"description": "802.3ad aggregation selection logic to use"
},
"bond_tlb_dynamic_lb": {
"enum": [
0,
1
],
"default": 1,
"description": "dynamic shuffling of flows in tlb mode"
}
}
},
{
"description": "Bridge network interface",
"required": [
"kind"
],
"properties": {
"kind": {
"const": "bridge",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"br_ageing_time": {
"type": "integer",
"minimum": 0,
"default": 30000,
"description": "FDB entry ageing time in milliseconds"
},
"br_vlan_protocol": {
"enum": [
33024,
"802.1q",
34984,
"802.1ad"
],
"default": "802.1q",
"description": "802.1q or 802.1ad (Q-in-Q)"
}
}
},
{
"description": "Physical network interface",
"required": [
"kind"
],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "link type",
"enum": [
"physical"
]
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"permaddr": {
"description": "select interface by permanent address [ethtool -P]",
"$ref": "#/$defs/iface-link_address"
},
"businfo": {
"description": "select interface by bus info [ethtool -i]",
"type": "string",
"maxLength": 32
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "Dummy network interface",
"required": [
"kind"
],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "link type",
"enum": [
"dummy"
]
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "VETH/VXCAN interface",
"required": [
"kind",
"peer"
],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "link type",
"enum": [
"veth",
"vxcan"
]
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"peer": {
"$ref": "#/$defs/iface-link_link"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "VLAN interface",
"required": [
"kind",
"link",
"vlan_id"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "vlan",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"link": {
"$ref": "#/$defs/iface-link_link"
},
"vlan_id": {
"type": [
"integer"
],
"minimum": 0,
"maximum": 4094,
"description": "specifies the VLAN identifier to use"
},
"vlan_protocol": {
"enum": [
33024,
"802.1q",
34984,
"802.1ad"
],
"default": "802.1q",
"description": "802.1q or 802.1ad (Q-in-Q)"
}
}
},
{
"description": "VXLAN interface",
"required": [
"kind",
"vxlan_id",
"vxlan_link"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "vxlan",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"vxlan_id": {
"type": [
"integer"
],
"minimum": 0,
"maximum": 16777215,
"description": "specifies the VNI"
},
"vxlan_link": {
"$ref": "#/$defs/iface-link_tun-dev"
}
}
},
{
"description": "IPIP interface",
"required": [
"kind",
"ipip_remote",
"ipip_local"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "ipip",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"ipip_remote": {
"$ref": "#/$defs/iface-link_tun-remote4"
},
"ipip_local": {
"$ref": "#/$defs/iface-link_tun-local4"
}
}
},
{
"description": "SIT interface",
"required": [
"kind",
"sit_remote",
"sit_local"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "sit",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"sit_remote": {
"$ref": "#/$defs/iface-link_tun-remote4"
},
"sit_local": {
"$ref": "#/$defs/iface-link_tun-local4"
}
}
},
{
"description": "GRE, GRETAP interface",
"required": [
"kind",
"gre_remote",
"gre_local"
],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "link type",
"enum": [
"gre",
"gretap"
]
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"gre_remote": {
"$ref": "#/$defs/iface-link_tun-remote4"
},
"gre_local": {
"$ref": "#/$defs/iface-link_tun-local4"
},
"gre_link": {
"$ref": "#/$defs/iface-link_tun-dev"
}
}
},
{
"description": "IP6GRE, IP6GRETAP interface",
"required": [
"kind",
"ip6gre_remote",
"ip6gre_local"
],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "link type",
"enum": [
"ip6gre",
"ip6gretap"
]
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"ip6gre_remote": {
"$ref": "#/$defs/iface-link_tun-remote4"
},
"ip6gre_local": {
"$ref": "#/$defs/iface-link_tun-local4"
},
"ip6gre_link": {
"$ref": "#/$defs/iface-link_tun-dev"
}
}
},
{
"description": "GENEVE interface over IPv4",
"additionalProperties": false,
"required": [
"kind",
"geneve_id",
"geneve_remote"
],
"properties": {
"kind": {
"const": "geneve",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"geneve_id": {
"type": [
"integer"
],
"minimum": 0,
"maximum": 16777215,
"description": "specifies the VNI to use"
},
"geneve_remote": {
"$ref": "#/$defs/iface-link_tun-remote4"
}
}
},
{
"description": "GENEVE interface over IPv6",
"additionalProperties": false,
"required": [
"kind",
"geneve_id",
"geneve_remote6"
],
"properties": {
"kind": {
"const": "geneve",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"geneve_id": {
"type": [
"integer"
],
"minimum": 0,
"maximum": 16777215,
"description": "specifies the VNI to use"
},
"geneve_remote6": {
"$ref": "#/$defs/iface-link_tun-remote6"
}
}
},
{
"description": "WireGuard interface; WireGuard settings can be configured using a `wireguard` block",
"required": [
"kind"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "wireguard",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
}
}
},
{
"description": "XFRM interface",
"required": [
"kind",
"xfrm_link"
],
"additionalProperties": false,
"properties": {
"kind": {
"const": "xfrm",
"description": "link type"
},
"address": {
"$ref": "#/$defs/iface-link_address"
},
"group": {
"$ref": "#/$defs/iface-link_group"
},
"state": {
"$ref": "#/$defs/iface-link_state"
},
"master": {
"$ref": "#/$defs/iface-link_master"
},
"mtu": {
"$ref": "#/$defs/iface-link_mtu"
},
"txqlen": {
"$ref": "#/$defs/iface-link_txqlen"
},
"ifalias": {
"$ref": "#/$defs/iface-link_ifalias"
},
"xfrm_link": {
"$ref": "#/$defs/iface-link_tun-dev",
"description": "underlying interface used to send and receive the transformed traffic"
},
"xfrm_if_id": {
"type": [
"integer"
],
"minimum": 0,
"maximum": 4294967295,
"default": 0,
"description": "lookup key to match xfrm policies"
}
}
}
]
},
"neighbours": {
"description": "static ARP or NDISC cache entries",
"type": "array",
"items": {
"type": "object",
"required": [
"dst"
],
"additionalProperties": false,
"properties": {
"dst": {
"description": "protocol address of the neighbour",
"type": "string",
"format": "ipv4"
},
"lladdr": {
"description": "link layer address of the neighbour",
"$ref": "#/$defs/iface-link_address",
"default": null
}
}
}
},
"sysctl": {
"description": "[interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/{IFACE}/`",
"$ref": "#/$defs/iface-sysctl"
},
"ethtool": {
"description": "network driver and hardware settings via [ethtool(8)](https://man7.org/linux/man-pages/man8/ethtool.8.html)",
"type": "object",
"additionalProperties": false,
"properties": {
"pause": {
"type": "object",
"additionalProperties": false,
"description": "pause parameters",
"properties": {
"autoneg": {
"description": "enable pause autonegotiation",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"rx": {
"description": "enable Rx pause",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"tx": {
"description": "enable Tx pause",
"$ref": "#/$defs/iface-ethtool_onoff"
}
}
},
"coalesce": {
"type": "object",
"additionalProperties": false,
"description": "interrupt coalescing",
"properties": {
"adaptive-rx": {
"$ref": "#/$defs/iface-ethtool_onoff"
},
"adaptive-tx": {
"$ref": "#/$defs/iface-ethtool_onoff"
},
"rx-usecs": {
"type": "integer"
},
"rx-frames": {
"type": "integer"
},
"rx-usecs-irq": {
"type": "integer"
},
"rx-frames-irq": {
"type": "integer"
},
"tx-usecs": {
"type": "integer"
},
"tx-frames": {
"type": "integer"
},
"tx-usecs-irq": {
"type": "integer"
},
"tx-frames-irq": {
"type": "integer"
},
"stats-block-usecs": {
"type": "integer"
},
"pkt-rate-low": {
"type": "integer"
},
"rx-usecs-low": {
"type": "integer"
},
"rx-frames-low": {
"type": "integer"
},
"tx-usecs-low": {
"type": "integer"
},
"tx-frames-low": {
"type": "integer"
},
"pkt-rate-high": {
"type": "integer"
},
"rx-usecs-high": {
"type": "integer"
},
"rx-frames-high": {
"type": "integer"
},
"tx-usecs-high": {
"type": "integer"
},
"tx-frames-high": {
"type": "integer"
},
"sample-interval": {
"type": "integer"
}
}
},
"ring": {
"type": "object",
"additionalProperties": false,
"description": "rx/tx ring parameters",
"properties": {
"rx": {
"description": "number of ring entries for the Rx ring",
"type": "integer"
},
"rx-mmini": {
"description": "number of ring entries for the Rx Mini ring",
"type": "integer"
},
"rx-jumbo": {
"description": "number of ring entries for the Rx Jumbo ring",
"type": "integer"
},
"tx": {
"description": "number of ring entries for the Tx ring",
"type": "integer"
}
}
},
"features": {
"type": "object",
"additionalProperties": false,
"description": "offload parameters and other features",
"properties": {
"rx": {
"description": "enable RX checksumming",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"tx": {
"description": "enable TX checksumming",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"sg": {
"description": "enable scatter-gather",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"tso": {
"description": "enable TCP segmentation offload",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"ufo": {
"description": "enable UDP fragmentation offload",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"gso": {
"description": "enable generic segmentation offload",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"gro": {
"description": "enable generic receive offload",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"lro": {
"description": "enable large receive offload",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"rxvlan": {
"description": "enable RX VLAN acceleration",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"txvlan": {
"description": "enable TX VLAN acceleration",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"ntuple": {
"description": "enable Rx ntuple filters and actions",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"rxhash": {
"description": "enable receive hashing offload",
"$ref": "#/$defs/iface-ethtool_onoff"
}
}
},
"change": {
"type": "object",
"additionalProperties": false,
"description": "device settings",
"properties": {
"speed": {
"description": "speed in Mbps",
"type": "integer"
},
"duplex": {
"description": "full or half duplex mode",
"type": "string",
"enum": [
"half",
"full"
]
},
"port": {
"description": "device port selection",
"type": "string",
"enum": [
"tp",
"aui",
"bnc",
"mii"
]
},
"mdix": {
"description": "MDI-X mode for port",
"type": [
"boolean",
"string"
],
"enum": [
"auto",
"on",
"off",
true,
false
]
},
"autoneg": {
"description": "enable autonegotation",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"advertise": {
"description": "speed and duplex advertised by autonegotation",
"type": "integer"
},
"phyad": {
"description": "PHY address",
"type": "integer"
},
"xcvr": {
"description": "transceiver type",
"type": "string",
"enum": [
"internal",
"external"
]
},
"wol": {
"description": "Wake-on-LAN options",
"type": "string",
"pattern": "^[pumbagsfd]+$"
},
"sopass": {
"description": "SecureOn™ password",
"type": "string",
"pattern": "^[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}$"
},
"msglvl": {
"description": "driver message flags",
"oneOf": [
{
"description": "driver message flags by number",
"type": "integer"
},
{
"description": "driver message flags by name",
"type": "array",
"items": [
{
"description": "flag name",
"type": "string",
"enum": [
"drv",
"probe",
"link",
"timer",
"ifdown",
"ifup",
"rx_err",
"tx_err",
"tx_queued",
"intr",
"tx_done",
"rx_status",
"pktdata",
"hw",
"wol"
]
},
{
"description": "enable flag",
"$ref": "#/$defs/iface-ethtool_onoff"
}
]
}
]
}
}
},
"channels": {
"type": "object",
"additionalProperties": false,
"description": "number of channels",
"properties": {
"rx": {
"description": "number of channels with only receive queues",
"type": "integer"
},
"tx": {
"description": "number of channels with only transmit queues",
"type": "integer"
},
"other": {
"description": "number of channels used only for other purposes",
"type": "integer"
},
"combined": {
"description": "number of multi-purpose channels",
"type": "integer"
}
}
},
"eee": {
"type": "object",
"additionalProperties": false,
"description": "Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)",
"properties": {
"eee": {
"description": "enable EEE support",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"tx-lpi": {
"description": "assert Tx LPI",
"$ref": "#/$defs/iface-ethtool_onoff"
},
"advertise": {
"description": "sets the speed for which EEE should be enabled (see also `change.advertise`)",
"type": "integer"
},
"tx-timer": {
"description": "amount of idle time prior asserting Tx LPI (in microseconds)",
"type": "integer"
}
}
},
"phy-tunable": {
"type": "object",
"additionalProperties": false,
"description": "PHY tunable parameters",
"properties": {
"downshift": {
"description": "enable downshift",
"oneOf": [
{
"description": "enable downshift",
"$ref": "#/$defs/iface-ethtool_onoff"
},
{
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "enable downshift",
"$ref": "#/$defs/iface-ethtool_onoff"
},
{
"description": "*REQUIRED*",
"type": "string",
"enum": [
"count"
]
},
{
"description": "PHY downshift re-tries count",
"type": "integer"
}
]
}
]
},
"fast-link-down": {
"description": "enable Fast Link Down",
"oneOf": [
{
"description": "enable Fast Link Down",
"$ref": "#/$defs/iface-ethtool_onoff"
},
{
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "enable Fast Link Down",
"$ref": "#/$defs/iface-ethtool_onoff"
},
{
"description": "*REQUIRED*",
"type": "string",
"enum": [
"msec"
]
},
{
"description": "period after which the link is reported as down",
"type": "integer"
}
]
}
]
},
"energy-detect-power-down": {
"description": "enable Energy Detect Power Down (EDPD)",
"oneOf": [
{
"description": "enable EDPD",
"$ref": "#/$defs/iface-ethtool_onoff"
},
{
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"description": "enable EDPD",
"$ref": "#/$defs/iface-ethtool_onoff"
},
{
"description": "*REQUIRED*",
"type": "string",
"enum": [
"msec"
]
},
{
"description": "wake-up interval for Tx pulses",
"type": "integer"
}
]
}
]
}
}
},
"priv-flags": {
"type": "object",
"description": "private flags"
},
"fec": {
"type": "object",
"additionalProperties": false,
"description": "Forward Error Correction",
"properties": {
"encoding": {
"description": "FEC encoding",
"type": [
"string",
"array"
],
"enum": [
"auto",
"off",
"RS",
"BaseR",
"LLRS"
],
"items": {
"type": "string",
"enum": [
"auto",
"RS",
"BaseR",
"LLRS"
]
}
}
}
}
}
},
"cshaper": {
"description": "simple shaper setup based on the [cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) queue discipline; replaces any tc settings",
"type": "object",
"additionalProperties": false,
"properties": {
"ingress": {
"description": "target ingress bandwidth",
"type": "string",
"default": "unlimited"
},
"egress": {
"description": "target egress bandwidth",
"type": "string",
"default": "unlimited"
},
"profile": {
"description": "cshaper profile",
"type": "string",
"default": "default"
}
}
},
"tc": {
"description": "settings for traffic control",
"type": "object",
"additionalProperties": false,
"properties": {
"ingress": {
"description": "enable the ingress qdisc for policing and shaping in ingress",
"type": "boolean"
},
"qdisc": {
"description": "root queueing disciplines",
"$ref": "#/$defs/iface-tc_qdisc"
},
"filter": {
"description": "filter used by qdiscs",
"type": "array",
"items": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"description": "filter type",
"enum": [
"basic",
"flow",
"fw",
"matchall"
]
}
},
"oneOf": [
{
"description": "[basic](https://man7.org/linux/man-pages/man8/tc-basic.8.html) - basic traffic control filter",
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"enum": [
"basic"
]
},
"protocol": {
"$ref": "#/$defs/iface-tc_protocol"
},
"prio": {
"$ref": "#/$defs/iface-tc_prio"
},
"action": {
"$ref": "#/$defs/iface-tc_action"
},
"match": {
"description": "match packets using the [extended match infrastructure](https://man7.org/linux/man-pages/man8/tc-ematch.8.html)",
"type": "object"
}
}
},
{
"description": "[flow](https://man7.org/linux/man-pages/man8/tc-flow.8.html) - flow based traffic control filter",
"properties": {
"kind": {
"type": "string",
"enum": [
"flow"
]
},
"protocol": {
"$ref": "#/$defs/iface-tc_protocol"
},
"prio": {
"$ref": "#/$defs/iface-tc_prio"
},
"action": {
"$ref": "#/$defs/iface-tc_action"
},
"baseclass": {
"description": "offset for the class ID calculation",
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 1
},
"divisor": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"or": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"and": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"xor": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"rshift": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"addend": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"oneOf": [
{
"required": [
"kind",
"mode",
"key"
],
"properties": {
"mode": {
"description": "filter mode",
"type": "string",
"enum": [
"map"
]
},
"key": {
"description": "map to class ID by key",
"type": "string",
"enum": [
"src",
"dst",
"proto",
"proto-src",
"proto-dst",
"iif",
"priority",
"mark",
"nfct",
"nfct-src",
"nfct-dst",
"nfct-proto-src",
"nfct-proto-dst",
"rt-classid",
"sk-uid",
"sk-gid",
"vlan-tag",
"rxhash"
]
}
}
},
{
"required": [
"kind",
"mode",
"keys"
],
"properties": {
"mode": {
"description": "filter mode",
"type": "string",
"enum": [
"hash"
]
},
"keys": {
"description": "hash over keys for class ID calculation",
"type": "array",
"items": {
"type": "string",
"enum": [
"src",
"dst",
"proto",
"proto-src",
"proto-dst",
"iif",
"priority",
"mark",
"nfct",
"nfct-src",
"nfct-dst",
"nfct-proto-src",
"nfct-proto-dst",
"rt-classid",
"sk-uid",
"sk-gid",
"vlan-tag",
"rxhash"
]
}
},
"perturb": {
"description": "rehashing interval (in seconds)",
"type": "integer",
"minimum": 0,
"maximum": 294967295
}
}
}
]
},
{
"description": "[fw](https://man7.org/linux/man-pages/man8/tc-fw.8.html) - fwmark traffic control filter",
"additionalProperties": false,
"required": [
"kind",
"handle"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"fw"
]
},
"protocol": {
"$ref": "#/$defs/iface-tc_protocol"
},
"prio": {
"$ref": "#/$defs/iface-tc_prio"
},
"action": {
"$ref": "#/$defs/iface-tc_action"
},
"handle": {
"description": "fwmark (iptables) to match",
"type": "integer",
"minimum": 0
}
}
},
{
"description": "[matchall](https://man7.org/linux/man-pages/man8/tc-matchall.8.html) - traffic control filter that matches every packet",
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"enum": [
"matchall"
]
},
"parent": {
"$ref": "#/$defs/iface-tc_qid"
},
"protocol": {
"$ref": "#/$defs/iface-tc_protocol"
},
"prio": {
"$ref": "#/$defs/iface-tc_prio"
},
"action": {
"$ref": "#/$defs/iface-tc_action"
},
"classid": {
"description": "push matching packets into class",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"flags": {
"description": "process flags (1: SKIP_HW, 2: SKIP_SW)",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
}
}
]
}
}
}
},
"wireguard": {
"description": "settings for WireGuard interfaces",
"type": "object",
"additionalProperties": false,
"required": [
"private_key"
],
"properties": {
"private_key": {
"description": "local private key (consider to use the `!include` tag to read the key from file)",
"type": "string"
},
"listen_port": {
"description": "port for listening",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"fwmark": {
"description": "fwmark for outgoing packets",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"peers": {
"description": "list of peer definitions",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"public_key"
],
"properties": {
"public_key": {
"description": "the peer's public key",
"type": "string"
},
"preshared_key": {
"description": "preshared key for post-quantum resistance (consider to use the `!include` tag to read the key from file)",
"type": "string"
},
"endpoint": {
"description": "initial endpoint IP or hostname",
"type": "string"
},
"persistent_keepalive_interval": {
"description": "keepalive interval seconds",
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"allowedips": {
"description": "list of prefixes in CIDR notation",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"xdp": {
"description": "settings for XDP (\"eXpress Data Path\") BPF program",
"oneOf": [
{
"description": "remove attached XDP program",
"type": "boolean",
"enum": [
false
]
},
{
"description": "attach already pinned XDP program",
"type": "object",
"additionalProperties": false,
"required": [
"pinned"
],
"properties": {
"mode": {
"$ref": "#/$defs/xdp_mode"
},
"pinned": {
"description": "path to already pinned XDP program",
"type": "string",
"format": "^/sys/fs/bfd/."
}
}
},
{
"description": "BPF program from ifstate's bpf config section",
"type": "object",
"additionalProperties": false,
"required": [
"bpf"
],
"properties": {
"mode": {
"$ref": "#/$defs/xdp_mode"
},
"bpf": {
"description": "BPF program (key in bpf config section)",
"type": "string"
}
}
}
]
}
}
}
},
"routing": {
"type": "object",
"additionalProperties": false,
"properties": {
"routes": {
"type": "array",
"items": {
"type": "object",
"required": [
"to"
],
"additionalProperties": false,
"properties": {
"type": {
"description": "the type of this route",
"type": [
"integer",
"string"
],
"enum": [
"unicast",
"local",
"broadcast",
"anycast",
"multicast",
"blackhole",
"unreachable",
"prohibit",
"throw",
"nat",
"xresolve"
],
"minimum": 1,
"maximum": 11,
"default": "unicast"
},
"dev": {
"description": "the output device name",
"type": [
"integer",
"string"
]
},
"proto": {
"description": "the routing protool identifier of this route",
"type": [
"integer",
"string"
],
"default": "boot"
},
"realm": {
"description": "the realm to which this route is assigned",
"type": [
"integer",
"string"
]
},
"scope": {
"description": "the scope of the destinations covered by the route prefix",
"type": [
"integer",
"string"
]
},
"table": {
"description": "the table to add this route to",
"type": [
"integer",
"string"
],
"default": "main"
},
"to": {
"description": "the destination prefix of the route",
"type": "string"
},
"via": {
"description": "address of the nexthop router",
"type": "string",
"oneOf": [
{
"format": "ipv4"
},
{
"format": "ipv6"
}
]
},
"src": {
"description": "the source address to prefer",
"type": "string",
"oneOf": [
{
"format": "ipv4"
},
{
"format": "ipv6"
}
]
},
"preference": {
"description": "preference of the route",
"type": "integer",
"minimum": 0,
"maximum": 4294967295,
"default": 0
}
}
}
},
"rules": {
"type": "array",
"items": {
"type": "object",
"if": {
"properties": {
"action": {
"const": "to_tbl"
}
}
},
"then": {
"required": [
"table",
"priority"
]
},
"else": {
"required": [
"priority"
]
},
"additionalProperties": false,
"properties": {
"action": {
"type": [
"integer",
"string"
],
"description": "the type of this rule",
"enum": [
"to_tbl",
"blackhole",
"unreachable",
"prohibit"
],
"default": "to_tbl"
},
"table": {
"type": [
"integer",
"string"
],
"minimum": 0,
"maximum": 255
},
"priority": {
"type": "integer",
"description": "the priority of this rule",
"minimum": 0,
"maximum": 4294967295
},
"from": {
"type": "string",
"description": "select the source prefix to match"
},
"to": {
"type": "string",
"description": "select the destination prefix to match"
},
"iif": {
"type": "string",
"description": "select the incoming device to match"
},
"oif": {
"type": "string",
"description": "select the outgoing device to match"
},
"proto": {
"type": [
"integer",
"string"
],
"default": "unspec",
"description": "routing protocol number (`/etc/iproute2/rt_protos`)"
},
"fwmark": {
"type": "integer",
"description": "select the *fwmark* value to match"
},
"ipproto": {
"type": [
"integer",
"string"
],
"description": "select the ip protocol to match"
}
}
}
}
}
}
}
} |
phraseapp.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"project_id": {
"description": "ID of the project",
"type": "string"
},
"file_format": {
"description": "File format name. See the format guide in the documentation for all supported file formats.",
"type": "string",
"default": "yml"
},
"locale_id": {
"description": "Locale that should be downloaded. Locale ID or locale name are valid options",
"type": "string"
},
"encoding": {
"description": "Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\"",
"type": "string",
"default": "UTF-8"
}
},
"id": "https://json.schemastore.org/phraseapp.json",
"properties": {
"phraseapp": {
"description": "Root element of the PhraseApp config",
"type": "object",
"properties": {
"defaults": {
"description": "Default configuration for API endpoints",
"type": "object",
"properties": {
"keys/list": {
"type": "object",
"properties": {
"sort": {
"type": "string",
"default": "updated_at"
},
"order": {
"type": "string",
"default": "desc"
}
}
}
}
},
"host": {
"description": "API host URL. Only needs to be changed for OnPremise usage",
"type": "string"
},
"access_token": {
"description": "Access Token for authorization. Can be created in the user profile",
"type": "string"
},
"file_format": {
"$ref": "#/definitions/file_format"
},
"project_id": {
"$ref": "#/definitions/project_id"
},
"push": {
"type": "object",
"properties": {
"sources": {
"description": "Source files that will be uploaded on push",
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"file": {
"description": "Translation file which will be uploaded",
"type": "string",
"default": "<locale_name>.yml"
},
"params": {
"description": "Locale upload parameter",
"type": "object",
"properties": {
"branch": {
"description": "Branch name",
"type": "string"
},
"file_format": {
"$ref": "#/definitions/file_format"
},
"locale_id": {
"$ref": "#/definitions/locale_id"
},
"tags": {
"description": "List of tags separated by comma to be associated with the new keys contained in the upload",
"type": "string"
},
"update_translations": {
"description": "Indicates whether existing translations should be updated with the file content",
"type": "boolean",
"default": false
},
"update_descriptions": {
"description": "Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions",
"type": "boolean",
"default": false
},
"convert_emoji": {
"description": "Indicates whether the file contains Emoji symbols that should be converted",
"type": "boolean",
"default": false
},
"skip_upload_tags": {
"description": "Indicates whether the upload should not create upload tags",
"type": "boolean",
"default": false
},
"skip_unverification": {
"description": "Indicates whether the upload should unverify updated translations",
"type": "boolean",
"default": false
},
"file_encoding": {
"$ref": "#/definitions/encoding"
},
"format_options": {
"description": "Additional options available for specific formats. See our format guide for complete list",
"type": "object",
"properties": {
"column_separator": {
"description": "Colum separator character",
"type": "string",
"default": ";"
}
}
}
}
}
}
}
}
}
},
"pull": {
"type": "object",
"properties": {
"targets": {
"description": "List of files that will be downloaded on pull",
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"file": {
"description": "Translation file which will be downloaded",
"type": "string",
"default": "<locale_name>.yml"
},
"project_id": {
"$ref": "#/definitions/project_id"
},
"params": {
"description": "Locale download parameter",
"type": "object",
"properties": {
"branch": {
"description": "Branch name",
"type": "string"
},
"file_format": {
"$ref": "#/definitions/file_format"
},
"tag": {
"description": "Limit result to keys tagged with the given tag (identified by its name)",
"type": "string",
"default": ""
},
"locale_id": {
"$ref": "#/definitions/locale_id"
},
"include_empty_translations": {
"description": "Indicates whether keys without translations should be included in the output as well",
"type": "boolean",
"default": false
},
"keep_notranslate_tags": {
"description": "Indicates whether [NOTRANSLATE] tags should be kept",
"type": "boolean",
"default": false
},
"convert_emoji": {
"description": "Indicates whether Emoji symbols should be converted to actual Emojis",
"type": "boolean",
"default": false
},
"encoding": {
"$ref": "#/definitions/encoding"
},
"skip_unverified_translations": {
"description": "Indicates whether the locale file should skip all unverified translations",
"type": "boolean",
"default": false
},
"fallback_locale_id": {
"description": "If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true",
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"title": "JSON schema for PhraseApp configuration files"
}
|
artifacts.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "dolittle.io/schemas/DotNET.SDK/Artifacts.Configuration/artifacts.json",
"title": "Artifacts Configuration",
"description": "The artifacts configuration",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactsByTypeDefinition"
},
"definitions": {
"artifactsByTypeDefinition": {
"description": "The artifacts by type definition",
"type": "object",
"properties": {
"commands": {
"description": "The command artifacts of a Feature",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactDefinition"
}
},
"events": {
"description": "The event artifacts of a Feature",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactDefinition"
}
},
"eventSources": {
"description": "The event source artifacts of a Feature",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactDefinition"
}
},
"readModels": {
"description": "The read model artifacts of a Feature",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactDefinition"
}
},
"queries": {
"description": "The query artifacts of a Feature",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactDefinition"
}
}
},
"required": ["commands", "events", "eventSources", "readModels", "queries"]
},
"artifactDefinition": {
"description": "The definition of an artifact",
"type": "object",
"properties": {
"generation": {
"description": "The artifact generation",
"type": "number"
},
"type": {
"description": "The CLR Type represented by the artifact ",
"type": "string"
}
},
"required": ["generation", "type"]
}
}
} |
bamboo-spec.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": {
"$ref": "#/definitions/job"
},
"definitions": {
"deployment": {
"type": "object",
"title": "Deployment projects",
"description": "A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed",
"properties": {
"name": {
"type": "string"
},
"source-plan": {
"type": "string"
}
}
},
"docker": {
"title": "Docker",
"description": "Builds and deployments are normally run on the Bamboo agent's native operating system",
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"image": {
"type": "string"
},
"volumes": {
"type": "object",
"default": {}
},
"use-default-volumes": {
"type": "boolean",
"default": false
},
"docker-run-arguments": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["image"]
}
]
},
"events": {
"type": "string",
"enum": [
"plan-failed",
"plan-completed",
"plan-status-changed",
"plan-comment-added",
"plan-responsibility-changed",
"job-completed",
"job-status-changed",
"job-failed",
"job-error",
"job-first-failed",
"job-hung",
"job-queue-timeout",
"job-queued-without-capable-agents"
]
},
"job": {
"title": "Job",
"description": "A job is a single build unit within a plan and is made up of one or more tasks.",
"definitions": {
"artifact": {
"type": "object",
"title": "Artifact",
"description": "Artifacts are files created by a job build (e.g. JAR files)",
"properties": {
"location": {
"description": "The relative path to find your artifact; it's a path relative to the workspace directory; do not use absolute paths.",
"type": "string"
},
"name": {
"description": "Name of the artifact; in case artifact is shared, name must be unique within the plan.",
"type": "string"
},
"pattern": {
"description": "Name or Ant pattern of file(s) to keep.",
"type": "string"
},
"required": {
"type": "boolean"
},
"shared": {
"type": "boolean",
"description": "You can share an artifact among other jobs or plans.",
"default": false
}
}
},
"task": {
"description": "A task is a small unit of work, such as source code checkout, or running a script",
"type": "object",
"properties": {
"interpreter": {
"type": "string"
},
"clean": {
"type": "object"
},
"checkout": {
"type": "object",
"properties": {
"repository": {
"type": "string"
},
"path": {
"type": "string"
},
"force-clean-build": {
"type": "string",
"default": false
}
}
},
"inject-variables": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"scope": {
"type": "string"
},
"namespace": {
"type": "string"
}
}
}
]
},
"test-parser": {
"description": "The Test Results Parser task in Bamboo parses test data",
"anyOf": [
{
"$ref": "#/definitions/testParser"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/testParser"
},
"ignore-time": {
"type": "boolean"
},
"test-results": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["type"]
}
]
},
"scripts": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/script"
}
}
}
}
},
"type": "object",
"properties": {
"docker": {
"$ref": "#/definitions/docker"
},
"final-tasks": {
"type": "array"
},
"key": {
"type": "string"
},
"other": {
"type": "object",
"properties": {
"clean-working-dir": {
"type": "boolean"
}
}
},
"requirements": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"patternProperties": {
".": {
"type": "string"
}
}
}
]
}
},
"tasks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/predefinedTask"
},
{
"$ref": "#/definitions/script"
},
{
"$ref": "#/definitions/job/definitions/task"
}
]
}
}
}
},
"keyValue": {
"description": "Variables can be used to make values available when building plans in Bamboo.",
"type": "object",
"patternProperties": {
"[a-zA-Z0-9_]": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
}
}
},
"notification": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"anyOf": [
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"events": {
"type": "array",
"minLength": 1,
"items": {
"$ref": "#/definitions/events"
}
}
}
},
"permission": {
"type": "object",
"description": "Plan permissions allow a user to control access to the functions of the build plan.",
"definitions": {
"permission": {
"description": "Plan permissions allow a user to control access to the functions of the build plan",
"type": "string",
"enum": ["view", "edit", "build", "admin", "clone", "deploy"]
}
},
"properties": {
"groups": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"permissions": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/permission/definitions/permission"
}
},
{
"$ref": "#/definitions/permission/definitions/permission"
}
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"plan": {
"description": "A plan defines everything about your continuous integration build process in Bamboo.",
"type": "object",
"properties": {
"project-key": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"predefinedTask": {
"type": "string",
"enum": ["inject-variables", "clean", "checkout", "artifact-download"]
},
"releaseNaming": {
"type": "object",
"properties": {
"next-version-name": {
"type": "string"
},
"applies-to-branches": {
"type": "boolean"
},
"auto-increment": {
"type": "boolean"
},
"auto-increment-variables": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
"script": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"script": {
"type": "string"
}
}
}
]
},
"stage": {
"title": "Stage",
"description": "Stages group jobs to individual steps within a plan's build process.",
"type": "object",
"additionalProperties": false,
"properties": {
"manual": {
"description": "Will await for execution by user",
"type": "boolean"
},
"final": {
"description": "Will be executed regardless of other stages state (pass or fail)",
"type": "boolean"
},
"jobs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"task": {
"description": "A task is a small unit of work, such as source code checkout, or running a script.",
"type": "object",
"definitions": {
"trigger": {
"anyOf": [
{
"type": "object",
"properties": {
"stage": {
"type": "string"
},
"branch": {
"type": "string"
}
}
},
{
"type": "object",
"patternProperties": {
"[a-zA-Z0-9\\s+_-]": {
"type": "string"
}
}
}
]
}
},
"properties": {
"source-plan": {
"type": "string"
},
"artifacts": {
"type": "array",
"items": {
"$ref": "#/definitions/job/definitions/artifact"
}
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"patternProperties": {
"(build|stage|environment)-success": {
"$ref": "#/definitions/task/definitions/trigger"
}
}
}
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/definitions/notification"
}
}
}
},
"testParser": {
"type": "string",
"enum": ["junit", "mstest", "nunit", "mocha", "testng"]
},
"triggers": {
"type": "array",
"definitions": {
"polling": {
"type": "object",
"additionalProperties": false,
"properties": {
"polling": {
"anyOf": [
{
"type": "integer"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"period": {
"type": "integer"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9\\s+_-]": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
}
}
}
]
}
}
},
"remote": {
"type": "object",
"additionalProperties": false,
"properties": {
"remote": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"ip": {
"type": "string"
}
}
}
]
}
}
},
"cron": {
"type": "object",
"description": "Execute deployment by schedule.",
"additionalProperties": false,
"properties": {
"cron": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"expression": {
"type": "string"
}
}
}
]
}
}
}
},
"items": {
"anyOf": [
{
"$ref": "#/definitions/triggers/definitions/polling"
},
{
"$ref": "#/definitions/triggers/definitions/cron"
},
{
"$ref": "#/definitions/triggers/definitions/remote"
},
{
"type": "string"
}
]
}
}
},
"description": "Full spec reference: https://docs.atlassian.com/bamboo-specs-docs/7.2.4/specs.html",
"id": "https://json.schemastore.org/bamboo-spec.json",
"properties": {
"default-environment-permissions": {
"title": "Default Environment Permissions",
"description": "These permissions apply to all environments defined in this deployment project",
"type": "array",
"items": {
"$ref": "#/definitions/permission"
}
},
"deployment": {
"title": "Deployment",
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/deployment"
}
]
},
"deployment-permissions": {
"title": "Deployment Permissions",
"description": "These permissions apply to the deployment project",
"type": "array",
"items": {
"$ref": "#/definitions/permission"
}
},
"docker": {
"$ref": "#/definitions/docker"
},
"environment-permissions": {
"title": "Environment Permissions",
"description": "Permissions specific to an environment",
"type": "array",
"items": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9\\s+_-]": {
"type": "array",
"items": {
"$ref": "#/definitions/permission"
}
}
}
}
},
"environments": {
"description": "An environment represents the servers or groups of servers where the software release has been deployed to, and the tasks that are needed for the deployment to work smoothly",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"notifications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "string"
}
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
},
"events": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/events"
},
{
"type": "object"
}
]
}
}
}
}
},
"plan": {
"$ref": "#/definitions/plan"
},
"plan-permissions": {
"title": "Plan Permissions",
"type": "array",
"items": {
"$ref": "#/definitions/permission"
}
},
"release-naming": {
"description": "You can define how releases should be named when they are created by Bamboo",
"anyOf": [
{
"$ref": "#/definitions/releaseNaming"
},
{
"type": "string"
}
]
},
"repositories": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"patternProperties": {
"[a-zA-Z0-9_]": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["project", "global"]
},
"type": {
"type": "string"
},
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"branch": {
"type": "string"
},
"viewer": {
"type": "string"
},
"ssh-key": {
"type": "string"
},
"ssh-key-passphrase": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"shared-credentials": {
"type": "string"
},
"lfs": {
"type": "boolean"
},
"use-shallow-clones": {
"type": "boolean"
},
"submodules": {
"type": "boolean"
},
"change-detection": {
"type": "object",
"properties": {
"quiet-period": {
"type": "object",
"properties": {
"quiet-period-seconds": {
"type": "integer"
},
"max-retries": {
"type": "integer"
}
}
},
"exclude-changeset-pattern": {
"type": "string"
},
"file-filter-type": {
"type": "string"
},
"file-filter-pattern": {
"type": "string"
}
}
}
}
}
}
}
]
}
},
"stages": {
"description": "Stages group jobs to individual steps within a plan's build process.",
"type": "array",
"items": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9\\s+_-]": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"$ref": "#/definitions/stage"
}
]
}
}
}
},
"triggers": {
"$ref": "#/definitions/triggers"
},
"variables": {
"$ref": "#/definitions/keyValue"
},
"version": {
"type": "integer",
"default": 2
},
"other": {
"type": "object"
}
},
"title": "Bamboo CI Specification",
"type": "object"
}
|
aurora-1.0.json | {
"$comment": "https://docs.aurorajs.dev/",
"$id": "https://json.schemastore.org/aurora-1.0.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"property": {
"type": "object",
"required": ["name", "type"],
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "The name of property, in camelCase",
"minLength": 2
},
"type": {
"type": "string",
"description": "The type of property",
"enum": [
"bigint.unsigned",
"bigint",
"blob.long",
"blob.medium",
"blob.tiny",
"blob",
"boolean",
"char",
"date",
"decimal",
"enum",
"float",
"id",
"int.unsigned",
"int",
"json",
"manyToMany",
"password",
"relationship",
"smallint.unsigned",
"smallint",
"text",
"timestamp",
"tinyint.unsigned",
"tinyint",
"varchar"
]
},
"length": {
"type": "number",
"description": "Set max length to property",
"minimum": 1
},
"maxLength": {
"type": "number",
"description": "Set max length to property",
"minimum": 1
},
"nullable": {
"type": "boolean",
"description": "Set property to nullable"
},
"primaryKey": {
"type": "boolean",
"description": "Set property to primary key"
},
"index": {
"type": "string",
"description": "To define property like a index",
"enum": ["index", "unique"]
},
"indexName": {
"type": "string",
"description": "The name of index, if there are various indexes with the same name, they will be grouped",
"minLength": 2
},
"enumOptions": {
"type": "array",
"description": "Values for enum type",
"items": {
"type": "string",
"minLength": 1
}
},
"defaultValue": {
"type": ["number", "string", "boolean"],
"description": "Default value for property"
},
"example": {
"type": ["number", "string", "boolean"],
"description": "Example value for property, this value will be used in swagger documentation"
},
"decimals": {
"type": "array",
"description": "Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].",
"items": {
"type": "number",
"minimum": 1
}
},
"autoIncrement": {
"type": "boolean",
"description": "Set number property as auto increment"
},
"relationship": {
"$ref": "#/definitions/relationship"
},
"webComponent": {
"$ref": "#/definitions/webComponent"
}
}
},
"apiDefinition": {
"type": "object",
"required": ["path", "resolverType", "httpMethod"],
"properties": {
"path": {
"type": "string",
"description": "Path to access api",
"minLength": 2
},
"resolverType": {
"type": "string",
"description": "Type of resolver, query or mutation",
"enum": ["query", "mutation"]
},
"httpMethod": {
"type": "string",
"description": "Verb of api rest",
"enum": ["get", "post", "put", "delete", "patch"]
}
}
},
"relationship": {
"type": "object",
"additionalProperties": false,
"description": "Relationship definition for this property",
"properties": {
"type": {
"type": "string",
"description": "The type of web component",
"enum": [
"many-to-many",
"many-to-one",
"none",
"one-to-many",
"one-to-one"
]
},
"singularName": {
"type": "string",
"description": "Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book",
"minLength": 2
},
"aggregate": {
"type": "string",
"description": "Aggregate referring to this relationship, example: LibraryAuthor",
"minLength": 2
},
"modulePath": {
"type": "string",
"description": "Path to the module that refers to this relationship, example: library/author",
"minLength": 2
},
"key": {
"type": "string",
"description": "Property key that refers to this relationship, only for many-to-one relationship, example: id",
"minLength": 2
},
"field": {
"type": "string",
"description": "Field to obtain the relationship data, example: author",
"minLength": 2
},
"avoidConstraint": {
"type": "boolean",
"description": "Avoid constraint rules for this relationship"
},
"packageName": {
"type": "string",
"description": "Path to packageName where is the relationship, example: @aurora-ts/core",
"minLength": 2
},
"isDenormalized": {
"type": "boolean",
"description": "Set many-to-many relationship as denormalized, creating a field to store the selected ids"
},
"pivot": {
"$ref": "#/definitions/pivotTable"
}
}
},
"webComponent": {
"type": "object",
"additionalProperties": false,
"description": "Web Component that wil be rendered for this property",
"properties": {
"type": {
"type": "string",
"description": "The type of web component",
"enum": ["grid-select-element", "grid-elements-manager", "select"]
}
}
},
"pivotTable": {
"type": "object",
"additionalProperties": false,
"description": "Relationship pivot table definition for this relationship",
"properties": {
"aggregate": {
"type": "string",
"description": "AggregateName of Pivot table, example: IamRolesAccounts",
"minLength": 2
},
"modulePath": {
"type": "string",
"description": "Module path where table model file will be saved, example: iam/role",
"minLength": 2
},
"fileName": {
"type": "string",
"description": "Filename of pivot table model file, example: roles-accounts",
"minLength": 2
}
}
}
},
"description": "Make agile applications without technical debt",
"properties": {
"version": {
"type": "string",
"description": "Schema version",
"default": "0.0.1",
"minLength": 2
},
"boundedContextName": {
"type": "string",
"description": "The name of the bounded context, singular in kebab-case",
"minLength": 2
},
"moduleName": {
"type": "string",
"description": "The name of the module, singular in kebab-case",
"minLength": 2
},
"moduleNames": {
"type": "string",
"description": "The name of the module, plural in kebab-case",
"minLength": 2
},
"aggregateName": {
"type": "string",
"description": "The name of the aggregateName, singular in PascalCase",
"minLength": 2
},
"hasOAuth": {
"type": "boolean",
"description": "Enabled authentication for this module",
"default": false
},
"hasTenant": {
"type": "boolean",
"description": "Enabled tenant for this module",
"default": false
},
"hasAuditing": {
"type": "boolean",
"description": "Enabled auditing for this module",
"default": false
},
"aggregateProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/property"
}
},
"aggregateI18nProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/property"
}
},
"additionalApis": {
"type": "array",
"items": {
"$ref": "#/definitions/apiDefinition"
}
}
},
"required": [
"boundedContextName",
"moduleName",
"moduleNames",
"aggregateName"
],
"title": "Aurora Agile Meta Framework",
"type": "object"
}
|
workflow.json | {
"$id": "https://serverlessworkflow.io/schemas/0.8/workflow.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Serverless Workflow specification - workflow schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Workflow unique identifier",
"minLength": 1
},
"key": {
"type": "string",
"description": "Domain-specific workflow identifier",
"minLength": 1
},
"name": {
"type": "string",
"description": "Workflow name",
"minLength": 1
},
"description": {
"type": "string",
"description": "Workflow description"
},
"version": {
"type": "string",
"description": "Workflow version",
"minLength": 1,
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"annotations": {
"type": "array",
"description": "List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities",
"minItems": 1,
"items": {
"type": "string"
},
"additionalItems": false
},
"dataInputSchema": {
"$ref": "#/definitions/validationSchema"
},
"dataOutputSchema": {
"$ref": "#/definitions/validationSchema"
},
"secrets": {
"$ref": "secrets.json#/secrets"
},
"constants": {
"oneOf": [
{
"type": "string",
"format": "uri",
"description": "URI to a resource containing constants data (json or yaml)"
},
{
"type": "object",
"description": "Workflow constants data (object type)"
}
]
},
"start": {
"$ref": "#/definitions/startdef"
},
"specVersion": {
"type": "string",
"description": "Serverless Workflow schema version",
"minLength": 1
},
"expressionLang": {
"type": "string",
"description": "Identifies the expression language used for workflow expressions. Default is 'jq'",
"default": "jq",
"minLength": 1
},
"timeouts": {
"$ref": "timeouts.json#/timeouts"
},
"errors": {
"$ref": "errors.json#/errors"
},
"keepActive": {
"type": "boolean",
"default": false,
"description": "If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
},
"events": {
"$ref": "events.json#/events"
},
"functions": {
"$ref": "functions.json#/functions"
},
"autoRetries": {
"type": "boolean",
"default": false,
"description": "If set to true, actions should automatically be retried on unchecked errors. Default is false"
},
"retries": {
"$ref": "retries.json#/retries"
},
"auth": {
"$ref": "auth.json#/auth"
},
"extensions": {
"$ref": "extensions.json#/extensions"
},
"states": {
"type": "array",
"description": "State definitions",
"items": {
"anyOf": [
{
"title": "Sleep State",
"$ref": "#/definitions/sleepstate"
},
{
"title": "Event State",
"$ref": "#/definitions/eventstate"
},
{
"title": "Operation State",
"$ref": "#/definitions/operationstate"
},
{
"title": "Parallel State",
"$ref": "#/definitions/parallelstate"
},
{
"title": "Switch State",
"$ref": "#/definitions/switchstate"
},
{
"title": "Inject State",
"$ref": "#/definitions/injectstate"
},
{
"title": "ForEach State",
"$ref": "#/definitions/foreachstate"
},
{
"title": "Callback State",
"$ref": "#/definitions/callbackstate"
}
]
},
"additionalItems": false,
"minItems": 1
}
},
"oneOf": [
{
"required": [
"id",
"specVersion",
"states"
]
},
{
"required": [
"key",
"specVersion",
"states"
]
}
],
"definitions": {
"sleep": {
"type": "object",
"properties": {
"before": {
"type": "string",
"description": "Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation. Does not apply if 'eventRef' is defined."
},
"after": {
"type": "string",
"description": "Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation. Does not apply if 'eventRef' is defined."
}
},
"anyOf": [
{
"required": [
"before"
]
},
{
"required": [
"after"
]
},
{
"required": [
"before",
"after"
]
}
]
},
"crondef": {
"oneOf": [
{
"type": "string",
"description": "Cron expression defining when workflow instances should be created (automatically)",
"minLength": 1
},
{
"type": "object",
"properties": {
"expression": {
"type": "string",
"description": "Repeating interval (cron expression) describing when the workflow instance should be created",
"minLength": 1
},
"validUntil": {
"type": "string",
"description": "Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid"
}
},
"additionalProperties": false,
"required": [
"expression"
]
}
]
},
"continueasdef": {
"oneOf": [
{
"type": "string",
"description": "Unique id of the workflow to be continue execution as. Entire state data is passed as data input to next execution",
"minLength": 1
},
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"description": "Unique id of the workflow to continue execution as"
},
"version": {
"type": "string",
"description": "Version of the workflow to continue execution as",
"minLength": 1,
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"data": {
"type": [
"string",
"object"
],
"description": "If string type, an expression which selects parts of the states data output to become the workflow data input of continued execution. If object type, a custom object to become the workflow data input of the continued execution"
},
"workflowExecTimeout": {
"$ref": "timeouts.json#/definitions/workflowExecTimeout",
"description": "Workflow execution timeout to be used by the workflow continuing execution. Overwrites any specific settings set by that workflow"
}
},
"required": [
"workflowId"
]
}
]
},
"transition": {
"oneOf": [
{
"type": "string",
"description": "Name of state to transition to",
"minLength": 1
},
{
"type": "object",
"description": "Function Reference",
"properties": {
"nextState": {
"type": "string",
"description": "Name of state to transition to",
"minLength": 1
},
"produceEvents": {
"type": "array",
"description": "Array of events to be produced before the transition happens",
"items": {
"type": "object",
"$ref": "#/definitions/produceeventdef"
},
"additionalItems": false
},
"compensate": {
"type": "boolean",
"default": false,
"description": "If set to true, triggers workflow compensation when before this transition is taken. Default is false"
}
},
"additionalProperties": false,
"required": [
"nextState"
]
}
]
},
"error": {
"type": "object",
"properties": {
"errorRef": {
"type": "string",
"description": "Reference to a unique workflow error definition. Used of errorRefs is not used",
"minLength": 1
},
"errorRefs": {
"type": "array",
"description": "References one or more workflow error definitions. Used if errorRef is not used",
"minItems": 1,
"items": {
"type": "string"
},
"additionalItems": false
},
"transition": {
"description": "Transition to next state to handle the error.",
"$ref": "#/definitions/transition"
},
"end": {
"description": "End workflow execution in case of this error.",
"$ref": "#/definitions/end"
}
},
"additionalProperties": false,
"oneOf": [
{
"required": [
"errorRef",
"transition"
]
},
{
"required": [
"errorRef",
"end"
]
},
{
"required": [
"errorRefs",
"transition"
]
},
{
"required": [
"errorRefs",
"end"
]
}
]
},
"onevents": {
"type": "object",
"properties": {
"eventRefs": {
"type": "array",
"description": "References one or more unique event names in the defined workflow events",
"minItems": 1,
"items": {
"type": "string"
},
"uniqueItems": true,
"additionalItems": false
},
"actionMode": {
"type": "string",
"enum": [
"sequential",
"parallel"
],
"description": "Specifies how actions are to be performed (in sequence or in parallel)",
"default": "sequential"
},
"actions": {
"type": "array",
"description": "Actions to be performed if expression matches",
"items": {
"type": "object",
"$ref": "#/definitions/action"
},
"additionalItems": false
},
"eventDataFilter": {
"description": "Event data filter",
"$ref": "#/definitions/eventdatafilter"
}
},
"additionalProperties": false,
"required": [
"eventRefs"
]
},
"action": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Unique action definition name"
},
"functionRef": {
"description": "References a function to be invoked",
"$ref": "#/definitions/functionref"
},
"eventRef": {
"description": "References a `produce` and `consume` reusable event definitions",
"$ref": "#/definitions/eventref"
},
"subFlowRef": {
"description": "References a sub-workflow to invoke",
"$ref": "#/definitions/subflowref"
},
"sleep": {
"description": "Defines time periods workflow execution should sleep before / after function execution",
"$ref": "#/definitions/sleep"
},
"retryRef": {
"type": "string",
"description": "References a defined workflow retry definition. If not defined the default retry policy is assumed"
},
"nonRetryableErrors": {
"type": "array",
"description": "List of unique references to defined workflow errors for which the action should not be retried. Used only when `autoRetries` is set to `true`",
"minItems": 1,
"items": {
"type": "string"
},
"additionalItems": false
},
"retryableErrors": {
"type": "array",
"description": "List of unique references to defined workflow errors for which the action should be retried. Used only when `autoRetries` is set to `false`",
"minItems": 1,
"items": {
"type": "string"
},
"additionalItems": false
},
"actionDataFilter": {
"description": "Action data filter",
"$ref": "#/definitions/actiondatafilter"
},
"condition": {
"description": "Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"oneOf": [
{
"required": [
"functionRef"
]
},
{
"required": [
"eventRef"
]
},
{
"required": [
"subFlowRef"
]
}
]
},
"functionref": {
"oneOf": [
{
"type": "string",
"description": "Name of the referenced function",
"minLength": 1
},
{
"type": "object",
"description": "Function Reference",
"properties": {
"refName": {
"type": "string",
"description": "Name of the referenced function"
},
"arguments": {
"type": "object",
"description": "Function arguments/inputs"
},
"selectionSet": {
"type": "string",
"description": "Only used if function type is 'graphql'. A string containing a valid GraphQL selection set"
},
"invoke": {
"type": "string",
"enum": [
"sync",
"async"
],
"description": "Specifies if the function should be invoked sync or async",
"default": "sync"
}
},
"additionalProperties": false,
"required": [
"refName"
]
}
]
},
"eventref": {
"type": "object",
"description": "Event References",
"properties": {
"produceEventRef": {
"type": "string",
"description": "Reference to the unique name of a 'produced' event definition"
},
"consumeEventRef": {
"type": "string",
"description": "Reference to the unique name of a 'consumed' event definition"
},
"consumeEventTimeout": {
"type": "string",
"description": "Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout"
},
"data": {
"type": [
"string",
"object"
],
"description": "If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'produceEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'produceEventRef'."
},
"contextAttributes": {
"type": "object",
"description": "Add additional extension context attributes to the produced event",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"produceEventRef"
]
},
"subflowref": {
"oneOf": [
{
"type": "string",
"description": "Unique id of the sub-workflow to be invoked",
"minLength": 1
},
{
"type": "object",
"description": "Specifies a sub-workflow to be invoked",
"properties": {
"workflowId": {
"type": "string",
"description": "Unique id of the sub-workflow to be invoked"
},
"version": {
"type": "string",
"description": "Version of the sub-workflow to be invoked",
"minLength": 1,
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"onParentComplete": {
"type": "string",
"enum": [
"continue",
"terminate"
],
"description": "If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate'",
"default": "terminate"
},
"invoke": {
"type": "string",
"enum": [
"sync",
"async"
],
"description": "Specifies if the subflow should be invoked sync or async",
"default": "sync"
}
},
"required": [
"workflowId"
]
}
]
},
"branch": {
"type": "object",
"description": "Branch Definition",
"properties": {
"name": {
"type": "string",
"description": "Branch name"
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"actionExecTimeout": {
"$ref": "timeouts.json#/definitions/actionExecTimeout"
},
"branchExecTimeout": {
"$ref": "timeouts.json#/definitions/branchExecTimeout"
}
},
"required": []
},
"actions": {
"type": "array",
"description": "Actions to be executed in this branch",
"items": {
"type": "object",
"$ref": "#/definitions/action"
},
"additionalItems": false
}
},
"additionalProperties": false,
"required": [
"name",
"actions"
]
},
"sleepstate": {
"type": "object",
"description": "Causes the workflow execution to sleep for a specified duration",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "sleep",
"description": "State type"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"duration": {
"type": "string",
"description": "Duration (ISO 8601 duration format) to sleep"
},
"transition": {
"description": "Next transition of the workflow after the workflow sleep",
"$ref": "#/definitions/transition"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"type",
"duration",
"end"
]
},
{
"required": [
"name",
"type",
"duration",
"transition"
]
}
]
},
"eventstate": {
"type": "object",
"description": "This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "event",
"description": "State type"
},
"exclusive": {
"type": "boolean",
"default": true,
"description": "If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed"
},
"onEvents": {
"type": "array",
"description": "Define the events to be consumed and optional actions to be performed",
"items": {
"type": "object",
"$ref": "#/definitions/onevents"
},
"additionalItems": false
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
},
"actionExecTimeout": {
"$ref": "timeouts.json#/definitions/actionExecTimeout"
},
"eventTimeout": {
"$ref": "timeouts.json#/definitions/eventTimeout"
}
},
"required": []
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"transition": {
"description": "Next transition of the workflow after all the actions have been performed",
"$ref": "#/definitions/transition"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"type",
"onEvents",
"end"
]
},
{
"required": [
"name",
"type",
"onEvents",
"transition"
]
}
]
},
"operationstate": {
"type": "object",
"description": "Defines actions be performed. Does not wait for incoming events",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "operation",
"description": "State type"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"actionMode": {
"type": "string",
"enum": [
"sequential",
"parallel"
],
"description": "Specifies whether actions are performed in sequence or in parallel",
"default": "sequential"
},
"actions": {
"type": "array",
"description": "Actions to be performed",
"items": {
"type": "object",
"$ref": "#/definitions/action"
}
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
},
"actionExecTimeout": {
"$ref": "timeouts.json#/definitions/actionExecTimeout"
}
},
"required": []
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"transition": {
"description": "Next transition of the workflow after all the actions have been performed",
"$ref": "#/definitions/transition"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"if": {
"properties": {
"usedForCompensation": {
"const": true
}
},
"required": [
"usedForCompensation"
]
},
"then": {
"required": [
"name",
"type",
"actions"
]
},
"else": {
"oneOf": [
{
"required": [
"name",
"type",
"actions",
"end"
]
},
{
"required": [
"name",
"type",
"actions",
"transition"
]
}
]
}
},
"parallelstate": {
"type": "object",
"description": "Consists of a number of states that are executed in parallel",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "parallel",
"description": "State type"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
},
"branchExecTimeout": {
"$ref": "timeouts.json#/definitions/branchExecTimeout"
}
},
"required": []
},
"branches": {
"type": "array",
"description": "Branch Definitions",
"items": {
"type": "object",
"$ref": "#/definitions/branch"
},
"additionalItems": false
},
"completionType": {
"type": "string",
"enum": [
"allOf",
"atLeast"
],
"description": "Option types on how to complete branch execution.",
"default": "allOf"
},
"numCompleted": {
"type": [
"number",
"string"
],
"minimum": 0,
"minLength": 0,
"description": "Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition."
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"transition": {
"description": "Next transition of the workflow after all branches have completed execution",
"$ref": "#/definitions/transition"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"if": {
"properties": {
"usedForCompensation": {
"const": true
}
},
"required": [
"usedForCompensation"
]
},
"then": {
"required": [
"name",
"type",
"branches"
]
},
"else": {
"oneOf": [
{
"required": [
"name",
"type",
"branches",
"end"
]
},
{
"required": [
"name",
"type",
"branches",
"transition"
]
}
]
}
},
"switchstate": {
"oneOf": [
{
"$ref": "#/definitions/databasedswitchstate"
},
{
"$ref": "#/definitions/eventbasedswitchstate"
}
]
},
"eventbasedswitchstate": {
"type": "object",
"description": "Permits transitions to other states based on events",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "switch",
"description": "State type"
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
},
"eventTimeout": {
"$ref": "timeouts.json#/definitions/eventTimeout"
}
},
"required": []
},
"eventConditions": {
"type": "array",
"description": "Defines conditions evaluated against events",
"items": {
"type": "object",
"$ref": "#/definitions/eventcondition"
},
"additionalItems": false
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"defaultCondition": {
"description": "Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition",
"$ref": "#/definitions/defaultconditiondef"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"required": [
"name",
"type",
"eventConditions",
"defaultCondition"
]
},
"databasedswitchstate": {
"type": "object",
"description": "Permits transitions to other states based on data conditions",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "switch",
"description": "State type"
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
}
},
"required": []
},
"dataConditions": {
"type": "array",
"description": "Defines conditions evaluated against state data",
"items": {
"type": "object",
"$ref": "#/definitions/datacondition"
},
"additionalItems": false
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"defaultCondition": {
"description": "Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition",
"$ref": "#/definitions/defaultconditiondef"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"required": [
"name",
"type",
"dataConditions",
"defaultCondition"
]
},
"defaultconditiondef": {
"type": "object",
"description": "DefaultCondition definition. Can be either a transition or end definition",
"properties": {
"name": {
"type": "string",
"description": "The optional name of the default condition, used solely for display purposes"
},
"transition": {
"$ref": "#/definitions/transition"
},
"end": {
"$ref": "#/definitions/end"
}
},
"additionalProperties": false,
"oneOf": [
{
"required": [
"transition"
]
},
{
"required": [
"end"
]
}
]
},
"eventcondition": {
"oneOf": [
{
"$ref": "#/definitions/transitioneventcondition"
},
{
"$ref": "#/definitions/endeventcondition"
}
]
},
"transitioneventcondition": {
"type": "object",
"description": "Switch state data event condition",
"properties": {
"name": {
"type": "string",
"description": "Event condition name"
},
"eventRef": {
"type": "string",
"description": "References an unique event name in the defined workflow events"
},
"transition": {
"description": "Next transition of the workflow if there is valid matches",
"$ref": "#/definitions/transition"
},
"eventDataFilter": {
"description": "Event data filter definition",
"$ref": "#/definitions/eventdatafilter"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"required": [
"eventRef",
"transition"
]
},
"endeventcondition": {
"type": "object",
"description": "Switch state data event condition",
"properties": {
"name": {
"type": "string",
"description": "Event condition name"
},
"eventRef": {
"type": "string",
"description": "References an unique event name in the defined workflow events"
},
"end": {
"$ref": "#/definitions/end",
"description": "Explicit transition to end"
},
"eventDataFilter": {
"description": "Event data filter definition",
"$ref": "#/definitions/eventdatafilter"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"required": [
"eventRef",
"end"
]
},
"datacondition": {
"oneOf": [
{
"$ref": "#/definitions/transitiondatacondition"
},
{
"$ref": "#/definitions/enddatacondition"
}
]
},
"transitiondatacondition": {
"type": "object",
"description": "Switch state data based condition",
"properties": {
"name": {
"type": "string",
"description": "Data condition name"
},
"condition": {
"type": "string",
"description": "Workflow expression evaluated against state data. Must evaluate to true or false"
},
"transition": {
"description": "Workflow transition if condition is evaluated to true",
"$ref": "#/definitions/transition"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"required": [
"condition",
"transition"
]
},
"enddatacondition": {
"type": "object",
"description": "Switch state data based condition",
"properties": {
"name": {
"type": "string",
"description": "Data condition name"
},
"condition": {
"type": "string",
"description": "Workflow expression evaluated against state data. Must evaluate to true or false"
},
"end": {
"$ref": "#/definitions/end",
"description": "Workflow end definition"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"required": [
"condition",
"end"
]
},
"injectstate": {
"type": "object",
"description": "Inject static data into state data. Does not perform any actions",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "inject",
"description": "State type"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"data": {
"type": "object",
"description": "JSON object which can be set as states data input and can be manipulated via filters"
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"transition": {
"description": "Next transition of the workflow after injection has completed",
"$ref": "#/definitions/transition"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"if": {
"properties": {
"usedForCompensation": {
"const": true
}
},
"required": [
"usedForCompensation"
]
},
"then": {
"required": [
"name",
"type",
"data"
]
},
"else": {
"oneOf": [
{
"required": [
"name",
"type",
"data",
"end"
]
},
{
"required": [
"name",
"type",
"data",
"transition"
]
}
]
}
},
"foreachstate": {
"type": "object",
"description": "Execute a set of defined actions or workflows for each element of a data array",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "foreach",
"description": "State type"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"inputCollection": {
"type": "string",
"description": "Workflow expression selecting an array element of the states data"
},
"outputCollection": {
"type": "string",
"description": "Workflow expression specifying an array element of the states data to add the results of each iteration"
},
"iterationParam": {
"type": "string",
"description": "Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration, this param should contain an unique element of the inputCollection array"
},
"batchSize": {
"type": [
"number",
"string"
],
"minimum": 0,
"minLength": 0,
"description": "Specifies how many iterations may run in parallel at the same time. Used if 'mode' property is set to 'parallel' (default)"
},
"actions": {
"type": "array",
"description": "Actions to be executed for each of the elements of inputCollection",
"items": {
"type": "object",
"$ref": "#/definitions/action"
},
"additionalItems": false
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
},
"actionExecTimeout": {
"$ref": "timeouts.json#/definitions/actionExecTimeout"
}
},
"required": []
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"transition": {
"description": "Next transition of the workflow after state has completed",
"$ref": "#/definitions/transition"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"mode": {
"type": "string",
"enum": [
"sequential",
"parallel"
],
"description": "Specifies how iterations are to be performed (sequentially or in parallel)",
"default": "parallel"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"if": {
"properties": {
"usedForCompensation": {
"const": true
}
},
"required": [
"usedForCompensation"
]
},
"then": {
"required": [
"name",
"type",
"inputCollection",
"actions"
]
},
"else": {
"oneOf": [
{
"required": [
"name",
"type",
"inputCollection",
"actions",
"end"
]
},
{
"required": [
"name",
"type",
"inputCollection",
"actions",
"transition"
]
}
]
}
},
"callbackstate": {
"type": "object",
"description": "This state performs an action, then waits for the callback event that denotes completion of the action",
"properties": {
"name": {
"type": "string",
"description": "State name"
},
"type": {
"type": "string",
"const": "callback",
"description": "State type"
},
"action": {
"description": "Defines the action to be executed",
"$ref": "#/definitions/action"
},
"eventRef": {
"type": "string",
"description": "References an unique callback event name in the defined workflow events"
},
"timeouts": {
"type": "object",
"description": "State specific timeouts",
"properties": {
"stateExecTimeout": {
"$ref": "timeouts.json#/definitions/stateExecTimeout"
},
"actionExecTimeout": {
"$ref": "timeouts.json#/definitions/actionExecTimeout"
},
"eventTimeout": {
"$ref": "timeouts.json#/definitions/eventTimeout"
}
},
"required": []
},
"eventDataFilter": {
"description": "Event data filter",
"$ref": "#/definitions/eventdatafilter"
},
"stateDataFilter": {
"description": "State data filter",
"$ref": "#/definitions/statedatafilter"
},
"onErrors": {
"type": "array",
"description": "States error handling definitions",
"items": {
"type": "object",
"$ref": "#/definitions/error"
},
"additionalItems": false
},
"transition": {
"description": "Next transition of the workflow after all the actions have been performed",
"$ref": "#/definitions/transition"
},
"end": {
"$ref": "#/definitions/end",
"description": "State end definition"
},
"compensatedBy": {
"type": "string",
"minLength": 1,
"description": "Unique Name of a workflow state which is responsible for compensation of this state"
},
"usedForCompensation": {
"type": "boolean",
"default": false,
"description": "If true, this state is used to compensate another state. Default is false"
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"additionalProperties": false,
"if": {
"properties": {
"usedForCompensation": {
"const": true
}
},
"required": [
"usedForCompensation"
]
},
"then": {
"required": [
"name",
"type",
"action",
"eventRef"
]
},
"else": {
"oneOf": [
{
"required": [
"name",
"type",
"action",
"eventRef",
"end"
]
},
{
"required": [
"name",
"type",
"action",
"eventRef",
"transition"
]
}
]
}
},
"startdef": {
"oneOf": [
{
"type": "string",
"description": "Name of the starting workflow state",
"minLength": 1
},
{
"type": "object",
"description": "Workflow start definition",
"properties": {
"stateName": {
"type": "string",
"description": "Name of the starting workflow state",
"minLength": 1
},
"schedule": {
"description": "Define the time/repeating intervals or cron at which workflow instances should be automatically started.",
"$ref": "#/definitions/schedule"
}
},
"additionalProperties": false,
"required": [
"schedule"
]
}
]
},
"schedule": {
"oneOf": [
{
"type": "string",
"description": "Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed)",
"minLength": 1
},
{
"type": "object",
"description": "Start state schedule definition",
"properties": {
"interval": {
"type": "string",
"description": "Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.",
"minLength": 1
},
"cron": {
"$ref": "#/definitions/crondef"
},
"timezone": {
"type": "string",
"description": "Timezone name used to evaluate the interval & cron-expression. (default: UTC)"
}
},
"additionalProperties": false,
"oneOf": [
{
"required": [
"interval"
]
},
{
"required": [
"cron"
]
}
]
}
]
},
"end": {
"oneOf": [
{
"type": "boolean",
"description": "State end definition",
"default": true
},
{
"type": "object",
"description": "State end definition",
"properties": {
"terminate": {
"type": "boolean",
"default": false,
"description": "If true, completes all execution flows in the given workflow instance"
},
"produceEvents": {
"type": "array",
"description": "Defines events that should be produced",
"items": {
"type": "object",
"$ref": "#/definitions/produceeventdef"
},
"additionalItems": false
},
"compensate": {
"type": "boolean",
"default": false,
"description": "If set to true, triggers workflow compensation. Default is false"
},
"continueAs": {
"$ref": "#/definitions/continueasdef"
}
},
"additionalProperties": false,
"required": []
}
]
},
"produceeventdef": {
"type": "object",
"description": "Produce an event and set its data",
"properties": {
"eventRef": {
"type": "string",
"description": "References a name of a defined event"
},
"data": {
"type": [
"string",
"object"
],
"description": "If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event."
},
"contextAttributes": {
"type": "object",
"description": "Add additional event extension context attributes",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"eventRef"
]
},
"statedatafilter": {
"type": "object",
"properties": {
"input": {
"type": "string",
"description": "Workflow expression to filter the state data input"
},
"output": {
"type": "string",
"description": "Workflow expression that filters the state data output"
}
},
"additionalProperties": false,
"required": []
},
"eventdatafilter": {
"type": "object",
"properties": {
"useData": {
"type": "boolean",
"description": "If set to false, event payload is not added/merged to state data. In this case 'data' and 'toStateData' should be ignored. Default is true.",
"default": true
},
"data": {
"type": "string",
"description": "Workflow expression that filters the received event payload (default: '${ . }')"
},
"toStateData": {
"type": "string",
"description": " Workflow expression that selects a state data element to which the filtered event should be added/merged into. If not specified, denotes, the top-level state data element."
}
},
"additionalProperties": false,
"required": []
},
"actiondatafilter": {
"type": "object",
"properties": {
"fromStateData": {
"type": "string",
"description": "Workflow expression that selects state data that the state action can use"
},
"useResults": {
"type": "boolean",
"description": "If set to false, action data results are not added/merged to state data. In this case 'results' and 'toStateData' should be ignored. Default is true.",
"default": true
},
"results": {
"type": "string",
"description": "Workflow expression that filters the actions data results"
},
"toStateData": {
"type": "string",
"description": "Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element"
}
},
"additionalProperties": false,
"required": []
},
"validationSchema" : {
"oneOf": [
{
"type": "string",
"description": "URI of the JSON Schema used to validate the workflow",
"minLength": 1
},
{
"type": "object",
"description": "Workflow data input schema definition",
"properties": {
"schema": {
"oneof":[
{
"type": "string",
"description": "URI of the JSON Schema used to validate the workflow",
"minLength": 1
},
{
"type": "object",
"description": "The JSON Schema object used to validate the workflow",
"$schema": "http://json-schema.org/draft-07/schema#"
}
]
},
"failOnValidationErrors": {
"type": "boolean",
"default": true,
"description": "Determines if error should be thrown if there are validation errors"
}
},
"additionalProperties": false,
"required": [
"schema"
]
}
]
}
}
}
|
Butane-Schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/Butane-Schema.json#",
"$comment": "Sources: https://github.com/Relativ-IT/Butane-Schemas/tree/Release",
"title": "Fedora Coreos Butane Schema",
"type": "object",
"required": ["variant", "version"],
"properties": {
"variant": {
"$id": "#/properties/variant",
"type": "string",
"title": "variant (string):",
"description": "Used to differentiate configs for different operating systems. Must be fcos for this specification.",
"enum": ["fcos"],
"default": "fcos"
},
"version": {
"$id": "#/properties/version",
"type": "string",
"title": "version (string):",
"enum": ["1.4.0", "1.5.0"],
"default": "1.5.0"
}
},
"oneOf": [
{
"allOf": [
{
"properties": {
"version": {
"const": "1.4.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.4.0/butane-v1.4.0.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.5.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.5.0/butane-v1.5.0.json"
}
]
}
]
} |
schema-table.json | {
"title": "JSON schema for Outblocks database table files",
"$schema": "http://json-schema.org/draft-04/schema",
"$ref": "#/definitions/OutblocksTable",
"definitions": {
"OutblocksTable": {
"title": "OutblocksTable",
"type": "object",
"additionalProperties": false,
"properties": {
"fields": {
"$ref": "#/definitions/Fields"
}
}
},
"Fields": {
"title": "Fields",
"type": "object",
"additionalProperties": true,
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"type": "object",
"properties": {
"type": {
"description": "The type of the field.",
"type": "string"
},
"default": {
"description": "Default value of the field."
}
},
"required": [
"type"
]
}
}
}
}
} |
bpkg.json | {
"$id": "https://json.schemastore.org/bpkg.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"description": "Where the dependency is located in `deps/`.\n\nSee more: https://github.com/bpkg/bpkg#name",
"type": "string",
"default": ""
},
"version": {
"description": "The current version of the dependency.\n\nSee more: https://github.com/bpkg/bpkg#version-optional",
"type": "string",
"default": "v0.1.0"
},
"description": {
"description": "Human-readable description of the functionality of the package.\n\nSee more: https://github.com/bpkg/bpkg#description",
"type": "string",
"examples": ["Terminal utility functions"]
},
"global": {
"type": "string",
"default": "",
"description": "Whether the package is only intended be installed as a global script. Allows the omission of the `--global` flag when installing.\n\nSee more: https://github.com/bpkg/bpkg#global",
"examples": ["true"]
},
"install": {
"type": "string",
"description": "Shell script used to invoke in the install script. Required if package is being installed as a global script.\n\nSee more: https://github.com/bpkg/bpkg#install-1",
"default": "make install",
"examples": ["make install"]
},
"scripts": {
"description": "An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts",
"type": "array",
"items": {
"type": "string",
"examples": ["script.sh"]
}
},
"files": {
"description": "An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional",
"type": "array",
"items": {
"type": "string"
}
},
"dependencies": {
"description": "Hash of dependencies of this project. Use either a tagged release identifier or `master`.\n\nSee more: https://github.com/bpkg/bpkg#dependencies-optional",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"dependencies-dev": {
"description": "Hash of development dependencies of this project. Use either a tagged release identifier or `master`.\n\nSee more: https://github.com/bpkg/bpkg#dependencies-dev-optional",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"commands": {
"description": "A hash of runnable commands for `bpkg run`.\n\nSee more: https://github.com/bpkg/bpkg#commands-optional",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"commands-description": {
"description": "A hash of descriptions for each command in `commands`.\n\nSee more: https://github.com/bpkg/bpkg#commands-description-optional",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["name", "description", "global", "install", "scripts"],
"type": "object"
}
|
strings.json | {
"$schema": "http://json-schema.org/draft-07/schema",
"title": "strings",
"description": "Strings of the current application\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "object",
"properties": {
"usage": {
"title": "usage",
"description": "A usage caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Usage:"
},
"options": {
"title": "options",
"description": "An option caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Options:"
},
"arguments": {
"title": "arguments",
"description": "An argument caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Arguments:"
},
"commands": {
"title": "commands",
"description": "A command caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Commands:"
},
"examples": {
"title": "examples",
"description": "An example caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Examples:"
},
"environment_variables": {
"title": "environment variables",
"description": "An environment variable caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Environment Variables:"
},
"group": {
"title": "group",
"description": "A group caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "%{group} Commands:"
},
"command_alias": {
"title": "command alias",
"description": "An alias helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Alias: %{alias}"
},
"default_command_summary": {
"title": "default command summary",
"description": "A default command summary helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "%{summary} (default)"
},
"required": {
"title": "required",
"description": "A required helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "(required)"
},
"repeatable": {
"title": "repeatable",
"description": "A repeatable helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "(repeatable)"
},
"default": {
"title": "default",
"description": "A default helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Default: %{value}"
},
"allowed": {
"title": "allowed",
"description": "An allowed helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Allowed: %{values}"
},
"help_flag_text": {
"title": "help flag text",
"description": "A help flag of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Show this help"
},
"version_flag_text": {
"title": "version flag text",
"description": "A version flag of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "Show version number"
},
"flag_requires_an_argument": {
"title": "flag requires an argument",
"description": "A missing flag argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "%{name} requires an argument: %{usage}"
},
"invalid_argument": {
"title": "invalid argument",
"description": "An invalid argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "invalid argument: %s"
},
"invalid_flag": {
"title": "invalid flag",
"description": "An invalid option error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "invalid option: %s"
},
"invalid_command": {
"title": "invalid command",
"description": "An invalid command error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "invalid command: %s"
},
"conflicting_flags": {
"title": "conflicting flags",
"description": "A conflicting options error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "conflicting options: %s cannot be used with %s"
},
"missing_required_argument": {
"title": "missing required argument",
"description": "A missing required argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "missing required argument: %{arg}\\nusage: %{usage}"
},
"missing_required_flag": {
"title": "missing required flag",
"description": "A missing required flag error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "missing required flag: %{usage}"
},
"missing_required_environment_variable": {
"title": "missing required environment variable",
"description": "A missing required environment variable error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "missing required environment variable: %{var}"
},
"missing_dependency": {
"title": "missing dependency",
"description": "A missing dependency error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "missing dependency: %{dependency}"
},
"disallowed_flag": {
"title": "disallowed flag",
"description": "A forbidden flag error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "%{name} must be one of: %{allowed}"
},
"disallowed_argument": {
"title": "disallowed argument",
"description": "A forbidden argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "%{name} must be one of: %{allowed}"
},
"unsupported_bash_version": {
"title": "unsupported bash version",
"description": "An unsupported Bash version error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "bash version 4 or higher is required"
},
"validation_error": {
"title": "validation error",
"description": "A validation error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
"type": "string",
"minLength": 1,
"default": "validation error in %s:\\n%s"
}
},
"additionalProperties": false
} |
swa-cli.config.json | {
"$id": "https://json.schemastore.org/swa-cli.config.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"configurations": {
"additionalProperties": {
"allOf": [
{
"properties": {
"apiLocation": {
"description": "API folder or Azure Functions emulator address",
"type": "string"
},
"apiPort": {
"description": "API backend port",
"type": "number"
},
"apiPrefix": {
"enum": ["api"],
"type": "string"
},
"appArtifactLocation": {
"description": "Location of the build output directory relative to the appLocation",
"type": "string"
},
"appLocation": {
"description": "Location for the static app source code",
"type": "string"
},
"build": {
"type": "boolean"
},
"customUrlScheme": {
"type": "string"
},
"devserverTimeout": {
"description": "Time to wait(in ms) for the dev server to start",
"type": "number"
},
"host": {
"description": "CLI host address",
"type": "string"
},
"overridableErrorCode": {
"items": {
"type": "number"
},
"type": "array"
},
"port": {
"description": "set the cli port",
"type": "number"
},
"run": {
"description": "Run a command at startup",
"type": "string"
},
"ssl": {
"description": "Serve the app and API over HTTPS",
"type": "boolean"
},
"sslCert": {
"description": "SSL certificate (.crt) to use for serving HTTPS",
"type": "string"
},
"sslKey": {
"description": "SSL key (.key) to use for serving HTTPS",
"type": "string"
},
"swaConfigFilename": {
"enum": ["staticwebapp.config.json"],
"type": "string"
},
"swaConfigFilenameLegacy": {
"enum": ["routes.json"],
"type": "string"
},
"swaConfigLocation": {
"type": "string"
},
"verbose": {
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"context": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
}
},
"type": "object"
}
|
epr-manifest.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"behavior": {
"type": "string",
"enum": ["block", "allow", "noAuth"]
},
"rule": {
"type": "object",
"properties": {
"path": {
"description": "Relative path to resource.",
"type": "string"
},
"regex": {
"description": "A regular expression for identifying paths to resources.",
"type": "string"
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"navigation",
"image",
"stylesheet",
"script",
"xhr",
"other"
]
}
},
"allowData": {
"description": "Determines if data is allowed at this path.",
"type": "boolean"
}
}
}
},
"id": "https://json.schemastore.org/epr-manifest.json",
"properties": {
"site": {
"description": "A fully qualified URL of your website.",
"type": "string",
"format": "uri"
},
"maxAge": {
"description": "Set the max age HTTP cache expiration.",
"type": "integer"
},
"reportUrl": {
"type": "string",
"format": "uri"
},
"defaultNavBehavior": {
"$ref": "#/definitions/behavior"
},
"defaultResBehavior": {
"$ref": "#/definitions/behavior"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/rule"
}
}
},
"required": ["rules"],
"title": "JSON schema for Entry Point Regulation manifest files",
"type": "object"
}
|
tenants.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "dolittle.io/schemas/Runtime/Tenancy/tenants.json",
"title": "Tenants Configuration",
"description": "The tenants configuration",
"type": "object",
"additionalProperties": {
"description": "The configuration of a tenant",
"type": "object"
}
} |
nest-cli.json | {
"$comment": "https://docs.nestjs.com/cli/monorepo#cli-properties",
"$id": "#Configuration",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"CompilerOptions": {
"type": "object",
"description": "A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details",
"$comment": "https://docs.nestjs.com/cli/monorepo#global-compiler-options",
"default": {},
"properties": {
"tsConfigPath": {
"default": "tsconfig.build.json",
"type": "string",
"description": "(monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file.",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/lib/compiler/defaults/webpac-defaults.ts"
},
"builder": {
"default": "tsc",
"type": "string",
"enum": ["tsc", "webpack", "swc"],
"description": "Builder to be used (tsc, webpack, swc). For details on how to configure `SWC` see https://docs.nestjs.com/recipes/swc#getting-started",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/commands/build.command.ts"
},
"typeCheck": {
"default": false,
"type": "boolean",
"description": "If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details.",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/commands/build.command.ts"
},
"webpack": {
"default": false,
"type": "boolean",
"description": "If true, use webpack compiler (deprecated option, use `builder` instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details.",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/commands/build.command.ts"
},
"webpackConfigPath": {
"default": "webpack.config.js",
"type": "string",
"description": "Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js.",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/commands/build.command.ts"
},
"plugins": {
"default": [],
"$comment": "https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin",
"type": "array",
"items": {
"$ref": "#/definitions/PluginItems"
}
},
"assets": {
"default": [],
"type": "array",
"items": {
"$ref": "#/definitions/AssetsOptions"
},
"description": "Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details.",
"$comment": "https://docs.nestjs.com/cli/monorepo#assets"
},
"watchAssets": {
"default": false,
"type": "boolean",
"description": "If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property."
},
"deleteOutDir": {
"type": "boolean",
"default": false,
"description": "If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist)."
},
"manualRestart": {
"type": "boolean",
"default": false,
"description": "If true, enables the shortcut `rs` to manually restart the server."
}
},
"additionalProperties": false
},
"AssetsOptions": {
"type": ["string", "object"],
"$comment": "https://docs.nestjs.com/cli/monorepo#assets",
"description": "For finer control, the element can be object.",
"properties": {
"include": {
"type": "string",
"description": "Glob-like file specifications for the assets to be distributed."
},
"exclude": {
"type": "string",
"description": "Glob-like file specifications for the assets to be excluded from the include list."
},
"outDir": {
"type": "string",
"description": "A string specifying the path (relative to the root folder) where the assets should be distributed. Defaults to the same output directory configured for compiler output."
},
"watchAssets": {
"type": "boolean",
"description": "If true, run in watch mode watching specified assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property."
}
},
"additionalProperties": false
},
"GenerateOptions": {
"type": "object",
"description": "A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details",
"$comment": "https://docs.nestjs.com/cli/monorepo#global-generate-options",
"properties": {
"spec": {
"$ref": "#/definitions/GenerateSpecOptions"
},
"flat": {
"$ref": "#/definitions/GenerateFlatOptions"
},
"baseDir": {
"$ref": "#/definitions/GenerateBaseDirOptions"
}
},
"default": {},
"additionalProperties": false
},
"GenerateFlatOptions": {
"type": "boolean",
"default": false,
"description": "If true, all generate commands will generate a flat structure",
"$comment": "https://docs.nestjs.com/cli/monorepo#global-generate-options"
},
"GenerateSpecOptions": {
"type": ["boolean", "object"],
"description": "If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.",
"$comment": "https://docs.nestjs.com/cli/monorepo#global-generate-options",
"properties": {
"application": {
"type": "boolean",
"description": "Generate spec file for application schematics or not."
},
"class": {
"type": "boolean",
"description": "Disable spec file generation for class schematics."
},
"cl": {
"type": "boolean",
"description": "Alias for class"
},
"configuration": {
"type": "boolean",
"description": "Generate spec file for configuration schematics or not."
},
"config": {
"type": "boolean",
"description": "Alias for configuration"
},
"controller": {
"type": "boolean",
"description": "Generate spec file for controller schematics or not."
},
"co": {
"type": "boolean",
"description": "Alias for controller"
},
"decorator": {
"type": "boolean",
"description": "Generate spec file for decorator schematics or not."
},
"d": {
"type": "boolean",
"description": "Alias fro decorator"
},
"filter": {
"type": "boolean",
"description": "Generate spec file for filter schematics or not."
},
"f": {
"type": "boolean",
"description": "Alias for filter"
},
"gateway": {
"type": "boolean",
"description": "Generate spec file for gateway schematics or not."
},
"ga": {
"type": "boolean",
"description": "Alias for gateway"
},
"guard": {
"type": "boolean",
"description": "Generate spec file for guard schematics or not."
},
"gu": {
"type": "boolean",
"description": "Alias for guard"
},
"interceptor": {
"type": "boolean",
"description": "Generate spec file for interceptor schematics or not."
},
"in": {
"type": "boolean",
"description": "Alias for interceptor"
},
"interface": {
"type": "boolean",
"description": "Generate spec file for interface schematics or not."
},
"middleware": {
"type": "boolean",
"description": "Generate spec file for middleware schematics or not."
},
"mi": {
"type": "boolean",
"description": "Alias for middleware"
},
"module": {
"type": "boolean",
"description": "Generate spec file for module schematics or not."
},
"mo": {
"type": "boolean",
"description": "Alias for module"
},
"pipe": {
"type": "boolean",
"description": "Generate spec file for pipe schematics or not."
},
"pi": {
"type": "boolean",
"description": "Alias for pipe"
},
"provider": {
"type": "boolean",
"description": "Generate spec file for provider schematics or not."
},
"pr": {
"type": "boolean",
"description": "Alias for provider"
},
"resolver": {
"type": "boolean",
"description": "Generate spec file for resolver schematics or not."
},
"r": {
"type": "boolean",
"description": "Alias for resolver"
},
"service": {
"type": "boolean",
"description": "Generate spec file for service schematics or not."
},
"s": {
"type": "boolean",
"description": "Alias for resolver"
},
"library": {
"type": "boolean",
"description": "Generate spec file for library schematics or not."
},
"lib": {
"type": "boolean",
"description": "Alias for library"
},
"sub-app": {
"type": "boolean",
"description": "Generate spec file for sub-app schematics or not."
},
"app": {
"type": "boolean",
"description": "Alias for sub-app"
},
"resource": {
"type": "boolean",
"description": "Generate spec file for resource schematics or not."
},
"res": {
"type": "boolean",
"description": "Alias for resource"
}
},
"additionalProperties": false
},
"GenerateBaseDirOptions": {
"type": "string",
"default": "",
"description": "Base directory"
},
"ProjectConfiguration": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"root": {
"type": "string"
},
"entryFile": {
"type": "string"
},
"sourceRoot": {
"type": "string"
},
"compilerOptions": {
"$ref": "#/definitions/CompilerOptions"
},
"generateOptions": {
"$ref": "#/definitions/GenerateOptions"
}
},
"additionalProperties": false
},
"PluginItems": {
"$comment": "https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin",
"type": ["string", "object"],
"properties": {
"name": {
"type": "string",
"description": "The npm package name of the cli plugin, eg @nestjs/swagger."
},
"options": {
"anyOf": [
{
"$ref": "#/definitions/PluginOptions"
},
{
"$ref": "#/definitions/GraphQLPluginOptions"
},
{
"$ref": "#/definitions/SwaggerPluginOptions"
}
]
}
}
},
"PluginOptions": {
"type": "object",
"properties": {
"introspectComments": {
"type": "boolean",
"default": true,
"description": "If set to true, plugin will generate descriptions and example values for properties based on comments."
}
}
},
"GraphQLPluginOptions": {
"type": "object",
"$comment": "https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin",
"properties": {
"typeFileNameSuffix": {
"type": "array",
"default": [".input.ts", ".args.ts", ".entity.ts", ".model.ts"],
"description": "(GraphQL Only) GraphQL types files suffix. Default value: ['.input.ts', '.args.ts', '.entity.ts', '.model.ts']. See https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin for details."
}
}
},
"SwaggerPluginOptions": {
"type": "object",
"$comment": "https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin",
"properties": {
"dtoFileNameSuffix": {
"type": "array",
"items": {
"type": "string"
},
"default": [".dto.ts", ".entity.ts"],
"description": "(Swagger Only) DTO (Data Transfer Object) files suffix. Default value: ['.dto.ts', '.entity.ts']. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details"
},
"controllerFileNameSuffix": {
"type": "string",
"default": ".controller.ts",
"description": "(Swagger Only) Controller files suffix. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details"
},
"classValidatorShim": {
"type": "boolean",
"default": true,
"description": "(Swagger Only) If set to true, the module will reuse class-validator validation decorators (e.g. @Max(10) will add max: 10 to schema definition). See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details"
},
"dtoKeyOfComment": {
"type": "string",
"default": "description",
"description": "(Swagger Only) The property key to set the comment text to on ApiProperty. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details"
},
"controllerKeyOfComment": {
"type": "string",
"default": "description",
"description": "(Swagger Only) The property key to set the comment text to on ApiOperation. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details"
}
}
}
},
"properties": {
"language": {
"type": "string",
"default": "ts"
},
"collection": {
"type": "string",
"default": "@nestjs/schematics",
"description": "Points at the collection of schematics used to generate components. you generally should not change this value."
},
"sourceRoot": {
"type": "string",
"default": "src",
"description": "Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures.",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/actions/add.action.ts"
},
"entryFile": {
"type": "string",
"default": "main",
"description": "The entry file where 'nest start' work with. Default to 'main'.",
"$comment": "https://github.com/nestjs/nest-cli/blob/master/actions/start.action.ts"
},
"monorepo": {
"type": "boolean",
"description": "(monorepo only) For a monorepo mode structure, this value is always true.",
"default": false
},
"root": {
"type": "string",
"description": "(monorepo only) Points at the project root of the default project.",
"default": ""
},
"compilerOptions": {
"$ref": "#/definitions/CompilerOptions"
},
"generateOptions": {
"$ref": "#/definitions/GenerateOptions"
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ProjectConfiguration"
},
"default": {}
}
},
"title": "Nest CLI configuration",
"type": "object"
}
|
github-workflow.json | {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions",
"$id": "https://json.schemastore.org/github-workflow.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"architecture": {
"type": "string",
"enum": ["ARM32", "x64", "x86"]
},
"branch": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestbranchestags",
"$ref": "#/definitions/globs",
"description": "When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.\nThe branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.\nThe patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names.\n- tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again."
},
"concurrency": {
"type": "object",
"properties": {
"group": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-using-concurrency-to-cancel-any-in-progress-job-or-run-1",
"description": "When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled.",
"type": "string"
},
"cancel-in-progress": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-using-concurrency-to-cancel-any-in-progress-job-or-run-1",
"description": "To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
}
},
"required": ["group"],
"additionalProperties": false
},
"configuration": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configuration"
}
},
{
"type": "array",
"items": {
"$ref": "#/definitions/configuration"
}
}
]
},
"container": {
"type": "object",
"properties": {
"image": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerimage",
"description": "The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.",
"type": "string"
},
"credentials": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainercredentials",
"description": "If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"env": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerenv",
"$ref": "#/definitions/env",
"description": "Sets an array of environment variables in the container."
},
"ports": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerports",
"description": "Sets an array of ports to expose on the container.",
"type": "array",
"items": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minItems": 1
},
"volumes": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainervolumes",
"description": "Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.\nTo specify a volume, you specify the source and destination path: <source>:<destinationPath>\nThe <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[^:]+:[^:]+$"
},
"minItems": 1
},
"options": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontaineroptions",
"description": "Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.",
"type": "string"
}
},
"required": ["image"],
"additionalProperties": false
},
"defaults": {
"type": "object",
"properties": {
"run": {
"type": "object",
"properties": {
"shell": {
"$ref": "#/definitions/shell"
},
"working-directory": {
"$ref": "#/definitions/working-directory"
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"minProperties": 1,
"additionalProperties": false
},
"permissions": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions",
"description": "You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.",
"oneOf": [
{
"type": "string",
"enum": ["read-all", "write-all"]
},
{
"$ref": "#/definitions/permissions-event"
}
]
},
"permissions-event": {
"type": "object",
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/permissions-level"
},
"checks": {
"$ref": "#/definitions/permissions-level"
},
"contents": {
"$ref": "#/definitions/permissions-level"
},
"deployments": {
"$ref": "#/definitions/permissions-level"
},
"discussions": {
"$ref": "#/definitions/permissions-level"
},
"id-token": {
"$ref": "#/definitions/permissions-level"
},
"issues": {
"$ref": "#/definitions/permissions-level"
},
"packages": {
"$ref": "#/definitions/permissions-level"
},
"pages": {
"$ref": "#/definitions/permissions-level"
},
"pull-requests": {
"$ref": "#/definitions/permissions-level"
},
"repository-projects": {
"$ref": "#/definitions/permissions-level"
},
"security-events": {
"$ref": "#/definitions/permissions-level"
},
"statuses": {
"$ref": "#/definitions/permissions-level"
}
}
},
"permissions-level": {
"type": "string",
"enum": ["read", "write", "none"]
},
"env": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/environment-variables",
"description": "To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv",
"oneOf": [
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
{
"$ref": "#/definitions/stringContainingExpressionSyntax"
}
]
},
"environment": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment",
"description": "The environment that the job references",
"type": "object",
"properties": {
"name": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-using-a-single-environment-name",
"description": "The name of the environment configured in the repo.",
"type": "string"
},
"url": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-using-environment-name-and-url",
"description": "A deployment URL",
"type": "string"
}
},
"required": ["name"],
"additionalProperties": false
},
"event": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows",
"type": "string",
"enum": [
"branch_protection_rule",
"check_run",
"check_suite",
"create",
"delete",
"deployment",
"deployment_status",
"discussion",
"discussion_comment",
"fork",
"gollum",
"issue_comment",
"issues",
"label",
"member",
"milestone",
"page_build",
"project",
"project_card",
"project_column",
"public",
"pull_request",
"pull_request_review",
"pull_request_review_comment",
"pull_request_target",
"push",
"registry_package",
"release",
"status",
"watch",
"workflow_call",
"workflow_dispatch",
"workflow_run",
"repository_dispatch"
]
},
"eventObject": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"additionalProperties": true
},
"expressionSyntax": {
"type": "string",
"$comment": "escape `{` and `}` in pattern to be unicode compatible (#1360)",
"pattern": "^\\$\\{\\{(.|[\r\n])*\\}\\}$"
},
"stringContainingExpressionSyntax": {
"type": "string",
"$comment": "escape `{` and `}` in pattern to be unicode compatible (#1360)",
"pattern": "^.*\\$\\{\\{(.|[\r\n])*\\}\\}.*$"
},
"globs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"machine": {
"type": "string",
"enum": ["linux", "macos", "windows"]
},
"name": {
"type": "string",
"pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$"
},
"path": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths",
"$ref": "#/definitions/globs",
"description": "When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.\nThe paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths."
},
"ref": {
"properties": {
"branches": {
"$ref": "#/definitions/branch"
},
"branches-ignore": {
"$ref": "#/definitions/branch"
},
"tags": {
"$ref": "#/definitions/branch"
},
"tags-ignore": {
"$ref": "#/definitions/branch"
},
"paths": {
"$ref": "#/definitions/path"
},
"paths-ignore": {
"$ref": "#/definitions/path"
}
},
"oneOf": [
{
"type": "object",
"allOf": [
{
"not": {
"required": ["branches", "branches-ignore"]
}
},
{
"not": {
"required": ["tags", "tags-ignore"]
}
},
{
"not": {
"required": ["paths", "paths-ignore"]
}
}
]
},
{
"type": "null"
}
]
},
"shell": {
"$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell",
"description": "You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.",
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#custom-shell",
"enum": ["bash", "pwsh", "python", "sh", "cmd", "powershell"]
}
]
},
"types": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onevent_nametypes",
"description": "Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.\nYou can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.",
"type": "array",
"minItems": 1
},
"working-directory": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun",
"description": "Using the working-directory keyword, you can specify the working directory of where to run the command.",
"type": "string"
},
"jobNeeds": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idneeds",
"description": "Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/name"
},
"minItems": 1
},
{
"$ref": "#/definitions/name"
}
]
},
"reusableWorkflowCallJob": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#calling-a-reusable-workflow",
"description": "Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"type": "object",
"properties": {
"name": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname",
"description": "The name of the job displayed on GitHub.",
"type": "string"
},
"needs": {
"$ref": "#/definitions/jobNeeds"
},
"permissions": {
"$ref": "#/definitions/permissions-event"
},
"if": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif",
"description": "You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": ["boolean", "number", "string"]
},
"uses": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_iduses",
"description": "The location and version of a reusable workflow file to run as a job, of the form './{path/to}/{localfile}.yml' or '{owner}/{repo}/{path}/{filename}@{ref}'. {ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.",
"type": "string",
"pattern": "^(.+/)+(.+)\\.(ya?ml)(@.+)?$"
},
"with": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith",
"description": "A map of inputs that are passed to the called workflow. Any inputs that you pass must match the input specifications defined in the called workflow. Unlike 'jobs.<job_id>.steps[*].with', the inputs you pass with 'jobs.<job_id>.with' are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the inputs context.",
"$ref": "#/definitions/env"
},
"secrets": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idsecrets",
"description": "When a job is used to call a reusable workflow, you can use 'secrets' to provide a map of secrets that are passed to the called workflow. Any secrets that you pass must match the names defined in the called workflow.",
"oneOf": [
{
"$ref": "#/definitions/env"
},
{
"type": "string",
"enum": ["inherit"]
}
]
},
"strategy": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy",
"description": "A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.",
"type": "object",
"properties": {
"matrix": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix",
"description": "A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.\nYou can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.\nWhen you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"oneOf": [
{
"type": "object"
},
{
"$ref": "#/definitions/expressionSyntax"
}
],
"patternProperties": {
"^(in|ex)clude$": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#example-including-configurations-in-a-matrix-build",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configuration"
}
},
"minItems": 1
}
},
"additionalProperties": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/configuration"
},
"minItems": 1
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"minProperties": 1
},
"fail-fast": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast",
"description": "When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true",
"type": "boolean",
"default": true
},
"max-parallel": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel",
"description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.",
"type": ["number", "string"]
}
},
"required": ["matrix"],
"additionalProperties": false
},
"concurrency": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/concurrency"
}
]
}
},
"required": ["uses"],
"additionalProperties": false
},
"normalJob": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_id",
"description": "Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"type": "object",
"properties": {
"name": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname",
"description": "The name of the job displayed on GitHub.",
"type": "string"
},
"needs": {
"$ref": "#/definitions/jobNeeds"
},
"permissions": {
"$ref": "#/definitions/permissions"
},
"runs-on": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idruns-on",
"description": "The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.",
"oneOf": [
{
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#github-hosted-runners",
"type": "string",
"enum": [
"macos-10.15",
"macos-11",
"macos-12",
"macos-12-xl",
"macos-13",
"macos-13-xl",
"macos-latest",
"macos-latest-xl",
"self-hosted",
"ubuntu-18.04",
"ubuntu-20.04",
"ubuntu-22.04",
"ubuntu-latest",
"ubuntu-latest-4-cores",
"ubuntu-latest-8-cores",
"ubuntu-latest-16-cores",
"windows-2019",
"windows-2022",
"windows-latest",
"windows-latest-8-cores"
]
},
{
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#self-hosted-runners",
"type": "array",
"anyOf": [
{
"items": [
{
"const": "self-hosted"
}
],
"minItems": 1,
"additionalItems": {
"type": "string"
}
},
{
"items": [
{
"const": "self-hosted"
},
{
"$ref": "#/definitions/machine"
}
],
"minItems": 2,
"additionalItems": {
"type": "string"
}
},
{
"items": [
{
"const": "self-hosted"
},
{
"$ref": "#/definitions/architecture"
}
],
"minItems": 2,
"additionalItems": {
"type": "string"
}
},
{
"items": [
{
"const": "self-hosted"
},
{
"$ref": "#/definitions/machine"
},
{
"$ref": "#/definitions/architecture"
}
],
"minItems": 3,
"additionalItems": {
"type": "string"
}
},
{
"items": [
{
"const": "self-hosted"
},
{
"$ref": "#/definitions/architecture"
},
{
"$ref": "#/definitions/machine"
}
],
"minItems": 3,
"additionalItems": {
"type": "string"
}
},
{
"items": [
{
"const": "linux"
}
],
"minItems": 2,
"maxItems": 2,
"additionalItems": {
"type": "string"
}
},
{
"items": [
{
"const": "windows"
}
],
"minItems": 2,
"maxItems": 2,
"additionalItems": {
"type": "string"
}
}
]
},
{
"$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-runners-in-a-group",
"type": "object",
"properties": {
"group": {
"type": "string"
},
"labels": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
{
"$ref": "#/definitions/stringContainingExpressionSyntax"
}
]
},
"environment": {
"$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment",
"description": "The environment that the job references.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/environment"
}
]
},
"outputs": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjobs_idoutputs",
"description": "A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"minProperties": 1
},
"env": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idenv",
"$ref": "#/definitions/env",
"description": "A map of environment variables that are available to all steps in the job."
},
"defaults": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_iddefaults",
"$ref": "#/definitions/defaults",
"description": "A map of default settings that will apply to all steps in the job."
},
"if": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif",
"description": "You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": ["boolean", "number", "string"]
},
"steps": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps",
"description": "A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.\nMust contain either `uses` or `run`\n",
"type": "array",
"items": {
"allOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"uses": {
"type": "string"
}
},
"required": ["uses"]
},
{
"type": "object",
"properties": {
"run": {
"type": "string"
}
},
"required": ["run"]
}
]
},
{
"type": "object",
"properties": {
"id": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid",
"description": "A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": "string"
},
"if": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsif",
"description": "You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"type": ["boolean", "number", "string"]
},
"name": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsname",
"description": "A name for your step to display on GitHub.",
"type": "string"
},
"uses": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsuses",
"description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/).\nWe strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.\n- Using the commit SHA of a released action version is the safest for stability and security.\n- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.\n- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.\nSome actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.\nActions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions.",
"type": "string"
},
"run": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsrun",
"description": "Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command.\nCommands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell.\nEach run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.",
"type": "string"
},
"working-directory": {
"$ref": "#/definitions/working-directory"
},
"shell": {
"$ref": "#/definitions/shell"
},
"with": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswith",
"$ref": "#/definitions/env",
"description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.",
"properties": {
"args": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithargs",
"type": "string"
},
"entrypoint": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithentrypoint",
"type": "string"
}
}
},
"env": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv",
"$ref": "#/definitions/env",
"description": "Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job."
},
"continue-on-error": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error",
"description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/expressionSyntax"
}
],
"default": false
},
"timeout-minutes": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepstimeout-minutes",
"description": "The maximum number of minutes to run the step before killing the process.",
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
}
},
"dependencies": {
"working-directory": ["run"],
"shell": ["run"]
},
"additionalProperties": false
}
]
},
"minItems": 1
},
"timeout-minutes": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes",
"description": "The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360",
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/expressionSyntax"
}
],
"default": 360
},
"strategy": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy",
"description": "A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.",
"type": "object",
"properties": {
"matrix": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix",
"description": "A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.\nYou can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.\nWhen you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.",
"oneOf": [
{
"type": "object"
},
{
"$ref": "#/definitions/expressionSyntax"
}
],
"patternProperties": {
"^(in|ex)clude$": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#example-including-configurations-in-a-matrix-build",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configuration"
}
},
"minItems": 1
}
},
"additionalProperties": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/configuration"
},
"minItems": 1
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"minProperties": 1
},
"fail-fast": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast",
"description": "When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true",
"type": "boolean",
"default": true
},
"max-parallel": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel",
"description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.",
"type": ["number", "string"]
}
},
"required": ["matrix"],
"additionalProperties": false
},
"continue-on-error": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error",
"description": "Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/expressionSyntax"
}
]
},
"container": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainer",
"description": "A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.\nIf you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/container"
}
]
},
"services": {
"$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idservices",
"description": "Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.\nWhen you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network.\nWhen both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/container"
}
},
"concurrency": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/concurrency"
}
]
}
},
"required": ["runs-on"],
"additionalProperties": false
}
},
"properties": {
"name": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#name",
"description": "The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename.",
"type": "string"
},
"on": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#on",
"description": "The name of the GitHub event that triggers the workflow. You can provide a single event string, array of events, array of event types, or an event configuration map that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows.",
"oneOf": [
{
"$ref": "#/definitions/event"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/event"
},
"minItems": 1
},
{
"type": "object",
"properties": {
"branch_protection_rule": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#branch_protection_rule",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]
}
}
},
"check_run": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#check-run-event-check_run",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/runs.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"created",
"rerequested",
"completed",
"requested_action"
]
},
"default": [
"created",
"rerequested",
"completed",
"requested_action"
]
}
}
},
"check_suite": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#check-suite-event-check_suite",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["completed", "requested", "rerequested"]
},
"default": ["completed", "requested", "rerequested"]
}
}
},
"create": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#create-event-create",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference."
},
"delete": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#delete-event-delete",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference."
},
"deployment": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#deployment-event-deployment",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/."
},
"deployment_status": {
"$comment": "https://docs.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status."
},
"discussion": {
"$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#discussion",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"created",
"edited",
"deleted",
"transferred",
"pinned",
"unpinned",
"labeled",
"unlabeled",
"locked",
"unlocked",
"category_changed",
"answered",
"unanswered"
]
},
"default": [
"created",
"edited",
"deleted",
"transferred",
"pinned",
"unpinned",
"labeled",
"unlabeled",
"locked",
"unlocked",
"category_changed",
"answered",
"unanswered"
]
}
}
},
"discussion_comment": {
"$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#discussion_comment",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]
}
}
},
"fork": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#fork-event-fork",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see https://developer.github.com/v3/repos/forks/#create-a-fork."
},
"gollum": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#gollum-event-gollum",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event."
},
"issue_comment": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#issue-comment-event-issue_comment",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]
}
}
},
"issues": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#issues-event-issues",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the issues event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"opened",
"edited",
"deleted",
"transferred",
"pinned",
"unpinned",
"closed",
"reopened",
"assigned",
"unassigned",
"labeled",
"unlabeled",
"locked",
"unlocked",
"milestoned",
"demilestoned"
]
},
"default": [
"opened",
"edited",
"deleted",
"transferred",
"pinned",
"unpinned",
"closed",
"reopened",
"assigned",
"unassigned",
"labeled",
"unlabeled",
"locked",
"unlocked",
"milestoned",
"demilestoned"
]
}
}
},
"label": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#label-event-label",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the label event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/labels/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]
}
}
},
"member": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#member-event-member",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the member event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/collaborators/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["added", "edited", "deleted"]
},
"default": ["added", "edited", "deleted"]
}
}
},
"merge_group": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#merge_group",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group. For information about the merge queue, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue .",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["checks_requested"]
},
"default": ["checks_requested"]
}
}
},
"milestone": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#milestone-event-milestone",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the milestone event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/milestones/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "closed", "opened", "edited", "deleted"]
},
"default": [
"created",
"closed",
"opened",
"edited",
"deleted"
]
}
}
},
"page_build": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#page-build-event-page_build",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see https://developer.github.com/v3/repos/pages/."
},
"project": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#project-event-project",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the project event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"created",
"updated",
"closed",
"reopened",
"edited",
"deleted"
]
},
"default": [
"created",
"updated",
"closed",
"reopened",
"edited",
"deleted"
]
}
}
},
"project_card": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#project-card-event-project_card",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/cards.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"created",
"moved",
"converted",
"edited",
"deleted"
]
},
"default": [
"created",
"moved",
"converted",
"edited",
"deleted"
]
}
}
},
"project_column": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#project-column-event-project_column",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the project_column event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "updated", "moved", "deleted"]
},
"default": ["created", "updated", "moved", "deleted"]
}
}
},
"public": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#public-event-public",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see https://developer.github.com/v3/repos/#edit."
},
"pull_request": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-event-pull_request",
"$ref": "#/definitions/ref",
"description": "Runs your workflow anytime the pull_request event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"assigned",
"unassigned",
"labeled",
"unlabeled",
"opened",
"edited",
"closed",
"reopened",
"synchronize",
"converted_to_draft",
"ready_for_review",
"locked",
"unlocked",
"review_requested",
"review_request_removed",
"auto_merge_enabled",
"auto_merge_disabled"
]
},
"default": ["opened", "synchronize", "reopened"]
}
},
"patternProperties": {
"^(branche|tag|path)s(-ignore)?$": {
"type": "array"
}
},
"additionalProperties": false
},
"pull_request_review": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-review-event-pull_request_review",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["submitted", "edited", "dismissed"]
},
"default": ["submitted", "edited", "dismissed"]
}
}
},
"pull_request_review_comment": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-review-comment-event-pull_request_review_comment",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/comments.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["created", "edited", "deleted"]
},
"default": ["created", "edited", "deleted"]
}
}
},
"pull_request_target": {
"$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target",
"$ref": "#/definitions/ref",
"description": "This event is similar to pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit. This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run. For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"assigned",
"unassigned",
"labeled",
"unlabeled",
"opened",
"edited",
"closed",
"reopened",
"synchronize",
"converted_to_draft",
"ready_for_review",
"locked",
"unlocked",
"review_requested",
"review_request_removed",
"auto_merge_enabled",
"auto_merge_disabled"
]
},
"default": ["opened", "synchronize", "reopened"]
}
},
"patternProperties": {
"^(branche|tag|path)s(-ignore)?$": {}
},
"additionalProperties": false
},
"push": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#push-event-push",
"$ref": "#/definitions/ref",
"description": "Runs your workflow when someone pushes to a repository branch, which triggers the push event.\nNote: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see https://developer.github.com/v3/repos/commits/#get-a-single-commit.",
"patternProperties": {
"^(branche|tag|path)s(-ignore)?$": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false
},
"registry_package": {
"$comment": "https://help.github.com/en/actions/reference/events-that-trigger-workflows#registry-package-event-registry_package",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime a package is published or updated. For more information, see https://help.github.com/en/github/managing-packages-with-github-packages.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["published", "updated"]
},
"default": ["published", "updated"]
}
}
},
"release": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#release-event-release",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the release event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": [
"published",
"unpublished",
"created",
"edited",
"deleted",
"prereleased",
"released"
]
},
"default": [
"published",
"unpublished",
"created",
"edited",
"deleted",
"prereleased",
"released"
]
}
}
},
"status": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#status-event-status",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see https://developer.github.com/v3/repos/statuses/."
},
"watch": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#watch-event-watch",
"$ref": "#/definitions/eventObject",
"description": "Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/."
},
"workflow_call": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_call",
"description": "Allows workflows to be reused by other workflows.",
"properties": {
"inputs": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs",
"description": "When using the workflow_call keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow.",
"type": "object",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_id",
"description": "A string identifier to associate with the input. The value of <input_id> is a map of the input's metadata. The <input_id> must be a unique identifier within the inputs object. The <input_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"type": "object",
"properties": {
"description": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_iddescription",
"description": "A string description of the input parameter.",
"type": "string"
},
"deprecationMessage": {
"description": "A string shown to users using the deprecated input.",
"type": "string"
},
"required": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_idrequired",
"description": "A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required.",
"type": "boolean"
},
"type": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onworkflow_callinput_idtype",
"description": "Required if input is defined for the on.workflow_call keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: boolean, number, or string.",
"type": "string",
"enum": ["boolean", "number", "string"]
},
"default": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_iddefault",
"description": "The default value is used when an input parameter isn't specified in a workflow file.",
"type": ["boolean", "number", "string"]
}
},
"required": ["type"],
"additionalProperties": false
}
},
"additionalProperties": false
},
"secrets": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onworkflow_callsecrets",
"description": "A map of the secrets that can be used in the called workflow. Within the called workflow, you can use the secrets context to refer to a secret.",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onworkflow_callsecretssecret_id",
"description": "A string identifier to associate with the secret.",
"properties": {
"description": {
"description": "A string description of the secret parameter.",
"type": "string"
},
"required": {
"$comment": "https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onworkflow_callsecretssecret_idrequired",
"description": "A boolean specifying whether the secret must be supplied.",
"type": "boolean"
}
},
"required": ["required"],
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"workflow_dispatch": {
"$comment": "https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/",
"description": "You can now create workflows that are manually triggered with the new workflow_dispatch event. You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.",
"properties": {
"inputs": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputs",
"description": "Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.",
"type": "object",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_id",
"description": "A string identifier to associate with the input. The value of <input_id> is a map of the input's metadata. The <input_id> must be a unique identifier within the inputs object. The <input_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.",
"type": "object",
"properties": {
"description": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_iddescription",
"description": "A string description of the input parameter.",
"type": "string"
},
"deprecationMessage": {
"description": "A string shown to users using the deprecated input.",
"type": "string"
},
"required": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_idrequired",
"description": "A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required.",
"type": "boolean"
},
"default": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_iddefault",
"description": "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file."
},
"type": {
"description": "A string representing the type of the input.",
"$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_dispatchinputsinput_idtype",
"type": "string",
"enum": [
"string",
"choice",
"boolean",
"number",
"environment"
]
},
"options": {
"$comment": "https://github.blog/changelog/2021-11-10-github-actions-input-types-for-manual-workflows",
"description": "The options of the dropdown list, if the type is a choice.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "string"
}
},
"required": ["type"]
},
"then": {
"properties": {
"default": {
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "boolean"
}
},
"required": ["type"]
},
"then": {
"properties": {
"default": {
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "number"
}
},
"required": ["type"]
},
"then": {
"properties": {
"default": {
"type": "number"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "environment"
}
},
"required": ["type"]
},
"then": {
"properties": {
"default": {
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "choice"
}
},
"required": ["type"]
},
"then": {
"required": ["options"]
}
}
],
"required": ["description"],
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"workflow_run": {
"$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_run",
"$ref": "#/definitions/eventObject",
"description": "This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request.",
"properties": {
"types": {
"$ref": "#/definitions/types",
"items": {
"type": "string",
"enum": ["requested", "completed"]
},
"default": ["requested", "completed"]
},
"workflows": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"patternProperties": {
"^branches(-ignore)?$": {}
}
},
"repository_dispatch": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#external-events-repository_dispatch",
"$ref": "#/definitions/eventObject",
"description": "You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event.\nTo trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event."
},
"schedule": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events-schedule",
"description": "You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07). Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.\nNote: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.\nYou can use crontab guru (https://crontab.guru/). to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples (https://crontab.guru/examples.html).",
"type": "array",
"items": {
"properties": {
"cron": {
"$comment": "https://stackoverflow.com/a/57639657/4044345",
"type": "string",
"pattern": "^(((\\d+,)+\\d+|((\\d+|\\*)/\\d+|((JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(-(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?))|(\\d+-\\d+)|\\d+(-\\d+)?/\\d+(-\\d+)?|\\d+|\\*|(MON|TUE|WED|THU|FRI|SAT|SUN)(-(MON|TUE|WED|THU|FRI|SAT|SUN))?) ?){5}$"
}
},
"additionalProperties": false
},
"minItems": 1
}
},
"additionalProperties": false
}
]
},
"env": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env",
"$ref": "#/definitions/env",
"description": "A map of environment variables that are available to all jobs and steps in the workflow."
},
"defaults": {
"$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#defaults",
"$ref": "#/definitions/defaults",
"description": "A map of default settings that will apply to all jobs in the workflow."
},
"concurrency": {
"$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency",
"description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/concurrency"
}
]
},
"jobs": {
"$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobs",
"description": "A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs.<job_id>.needs keyword.\nEach job runs in a fresh instance of the virtual environment specified by runs-on.\nYou can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#usage-limits.",
"type": "object",
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"oneOf": [
{
"$ref": "#/definitions/normalJob"
},
{
"$ref": "#/definitions/reusableWorkflowCallJob"
}
]
}
},
"minProperties": 1,
"additionalProperties": false
},
"run-name": {
"$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#run-name",
"description": "The name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs on your repository's 'Actions' tab.",
"type": "string"
},
"permissions": {
"$ref": "#/definitions/permissions"
}
},
"required": ["on", "jobs"],
"type": "object"
}
|
tldr.json | {
"$id": "https://json.schemastore.org/tldr.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"platform": {
"oneOf": [
{
"enum": ["linux"]
},
{
"type": "string"
}
]
},
"pagesRepository": {
"type": "string"
},
"repository": {
"type": "string"
},
"skipUpdateWhenPageNotFound": {
"type": "boolean"
},
"theme": {
"type": "string"
},
"themes": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"commandName": {
"type": "string"
},
"mainDescription": {
"type": "string"
},
"exampleDescription": {
"type": "string"
},
"exampleCode": {
"type": "string"
},
"exampleToken": {
"type": "string"
}
}
}
}
},
"type": "object"
}
|
jsonld.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"allOf": [
{
"$ref": "#/definitions/context"
},
{
"$ref": "#/definitions/graph"
},
{
"$ref": "#/definitions/common"
}
],
"definitions": {
"context": {
"additionalProperties": true,
"properties": {
"@context": {
"description": "Used to define the short-hand names that are used throughout a JSON-LD document.",
"type": ["object", "string", "array", "null"]
}
}
},
"graph": {
"additionalProperties": true,
"properties": {
"@graph": {
"description": "Used to express a graph.",
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/common"
}
},
{
"type": "object",
"$ref": "#/definitions/common"
}
]
}
}
},
"common": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/common"
}
]
},
"properties": {
"@id": {
"description": "Used to uniquely identify things that are being described in the document with IRIs or blank node identifiers.",
"type": "string",
"format": "uri"
},
"@value": {
"description": "Used to specify the data that is associated with a particular property in the graph.",
"type": ["string", "boolean", "number", "null"]
},
"@language": {
"description": "Used to specify the language for a particular string value or the default language of a JSON-LD document.",
"type": ["string", "null"]
},
"@type": {
"description": "Used to set the data type of a node or typed value.",
"type": ["string", "null", "array"]
},
"@container": {
"description": "Used to set the default container type for a term.",
"type": ["string", "null"],
"enum": ["@language", "@list", "@index", "@set"]
},
"@list": {
"description": "Used to express an ordered set of data."
},
"@set": {
"description": "Used to express an unordered set of data and to ensure that values are always represented as arrays."
},
"@reverse": {
"description": "Used to express reverse properties.",
"type": ["string", "object", "null"],
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/common"
}
]
}
},
"@base": {
"description": "Used to set the base IRI against which relative IRIs are resolved",
"type": ["string", "null"],
"format": "uri"
},
"@vocab": {
"description": "Used to expand properties and values in @type with a common prefix IRI",
"type": ["string", "null"],
"format": "uri"
}
}
}
},
"id": "https://json.schemastore.org/jsonld.json",
"title": "Schema for JSON-LD",
"type": ["object", "array"]
}
|
drupal-info.json | {
"$id": "https://json.schemastore.org/drupal-info.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "module"
}
}
},
"then": {
"properties": {
"configure": {
"title": "A route name of the configuration form",
"type": "string"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
}
},
"test_dependencies": {
"title": "Dependencies that are needed to run certain automated tests for this extension",
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "theme"
}
}
},
"then": {
"properties": {
"base theme": {
"title": "Base theme",
"default": "classy",
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"libraries": {
"title": "A list of libraries to add to all pages where the theme is active",
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9_]+/[a-z0-9_\\-.]+$"
}
},
"libraries-override": {
"title": "A collection of libraries and assets to override",
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "object"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
}
},
"libraries-extend": {
"title": "A collection of libraries and assets to add whenever a library is attached",
"type": "object",
"additionalProperties": {
"type": "array"
}
},
"engine": {
"title": "The theme engine",
"default": "twig",
"type": "string"
},
"logo": {
"title": "The path to logo relative to the theme's .info.yml",
"type": "string"
},
"screenshot": {
"title": "The path to screenshot relative to the theme's .info.yml file",
"type": "string"
},
"regions": {
"title": "A list of theme regions",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"regions_hidden": {
"title": "A list of inherited regions to remove",
"type": "array",
"uniqueItems": true
},
"features": {
"title": "A list of features to expose on the theme 'Settings' page",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"stylesheets-remove": {
"title": "A list of stylesheets from other modules or themes to remove from all pages where the theme is active",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"ckeditor_stylesheets": {
"title": "A list of stylesheets to add to the CKEditor frame",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "profile"
}
}
},
"then": {
"properties": {
"distribution": {
"title": "Declare the installation profile as a distribution",
"type": "object",
"properties": {
"name": {
"title": "The distribution name",
"type": "string"
},
"install": {
"type": "object",
"properties": {
"theme": {
"title": "The theme for the distribution installation",
"$ref": "#/definitions/machine_name"
}
}
},
"langcode": {
"type": "string"
}
}
},
"dependencies": {
"title": "Required modules",
"type": "array",
"items": {
"$ref": "#/definitions/machine_name"
},
"uniqueItems": true
},
"install": {
"title": "Modules to install to support the profile",
"type": "array",
"items": {
"$ref": "#/definitions/dependency"
},
"uniqueItems": true
},
"theme": {
"title": "List any themes that should be installed as part of the profile installation",
"type": "array",
"items": {
"$ref": "#/definitions/machine_name"
},
"uniqueItems": true
}
}
}
}
],
"definitions": {
"dependency": {
"title": "Extension dependency",
"type": "string",
"pattern": "^[a-z0-9_]+:[a-z0-9_]+( \\(.+\\))?$"
},
"machine_name": {
"title": "Machine name",
"type": "string",
"pattern": "^[a-z0-9_]+$"
}
},
"properties": {
"name": {
"title": "The human-readable name",
"type": "string"
},
"type": {
"type": "string",
"enum": ["module", "theme", "profile", "theme_engine"]
},
"core": {
"type": "string",
"pattern": "^\\d\\.x$"
},
"core_version_requirement": {
"title": "Semantic core version requirement",
"type": "string"
},
"description": {
"title": "Extension description",
"type": "string"
},
"package": {
"title": "A key that allows to group extension together an administrative pages",
"type": "string"
},
"version": {
"title": "The version of the extension",
"type": "string"
},
"project": {
"title": "The machine name of extension project on drupal.org",
"type": "string"
},
"datestamp": {
"title": "The date and time when the extension was packaged",
"type": "integer"
},
"hidden": {
"title": "Do not the extension in admin interface",
"type": "boolean"
},
"php": {
"title": "The minimal PHP version that is required for this extension",
"oneOf": [
{
"type": "string",
"pattern": "^\\d+\\.\\d+(\\.\\d+)$"
},
{
"type": "number"
}
]
}
},
"required": ["type", "core_version_requirement", "name"],
"title": "JSON schema for Drupal extension info file",
"type": "object"
}
|
meta-runtime.json | {
"$defs": {
"ActionGroup": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/Metadata"
}
]
},
"type": "array"
},
"Metadata": {
"properties": {
"metadata": {
"properties": {
"extend_group": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"Redirect": {
"properties": {
"redirect": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/meta-runtime.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "See https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#meta-directory",
"examples": ["**/meta/runtime.yml"],
"properties": {
"action_groups": {
"additionalProperties": {
"$ref": "#/$defs/ActionGroup"
},
"description": "A mapping of groups and the list of action plugin and module names they contain. They may also have a special ‘metadata’ dictionary in the list, which can be used to include actions from other groups.",
"title": "Action Groups",
"type": "object"
},
"import_redirection": {
"additionalProperties": {
"$ref": "#/$defs/Redirect"
},
"description": "A mapping of names for Python import statements and their redirected locations.",
"title": "Import Redirection",
"type": "object"
},
"plugin_routing": {
"markdownDescription": "Content in a collection that Ansible needs to load from another location or that has been deprecated/removed. The top level keys of plugin_routing are types of plugins, with individual plugin names as subkeys. To define a new location for a plugin, set the redirect field to another name. To deprecate a plugin, use the deprecation field to provide a custom warning message and the removal version or date. If the plugin has been renamed or moved to a new location, the redirect field should also be provided. If a plugin is being removed entirely, tombstone can be used for the fatal error message and removal version or date.",
"properties": {
"inventory": {},
"module_utils": {},
"modules": {}
},
"title": "Plugin Routing",
"type": "object"
},
"requires_ansible": {
"examples": [">=2.10,<2.11"],
"pattern": "^[^\\s]*$",
"title": "The version of Ansible Core (ansible-core) required to use the collection. Multiple versions can be separated with a comma.",
"type": "string"
}
},
"title": "Ansible Meta Runtime Schema",
"type": "object"
}
|
coffeelint.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"base": {
"type": "object",
"properties": {
"level": {
"description": "Determines the error level",
"type": "string",
"enum": ["error", "warn", "ignore"]
}
}
}
},
"id": "https://json.schemastore.org/coffeelint.json",
"properties": {
"arrow_spacing": {
"description": "This rule checks to see that there is spacing before and after the arrow operator that declares a function. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"braces_spacing": {
"description": "This rule checks to see that there is the proper spacing inside curly braces. The spacing amount is specified by `spaces`. The spacing amount for empty objects is specified by `empty_object_spaces`. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"empty_object_spaces": {
"type": "integer",
"enum": [0, 1]
},
"spaces": {
"type": "integer",
"enum": [0, 1]
}
}
},
"camel_case_classes": {
"description": "This rule mandates that all class names are CamelCased. Camel casing class names is a generally accepted way of distinguishing constructor functions - which require the `new` prefix to behave properly - from plain old functions. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"coffeescript_error": {
"description": "[default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"colon_assignment_spacing": {
"description": "This rule checks to see that there is spacing before and after the colon in a colon assignment (i.e., classes, objects). [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"spacing": {
"type": "object",
"properties": {
"left": {
"type": "integer",
"enum": [0, 1]
},
"right": {
"type": "integer",
"enum": [0, 1]
}
}
}
}
},
"cyclomatic_complexity": {
"description": "Examine the complexity of your application. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"value": {
"type": "integer"
}
}
},
"duplicate_key": {
"description": "Prevents defining duplicate keys in object literals and classes. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"empty_constructor_needs_parens": {
"description": "Requires constructors with no parameters to include the parens. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"ensure_comprehensions": {
"description": "This rule makes sure that parentheses are around comprehensions. [default level: warn]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"eol_last": {
"description": "Checks that the file ends with a single newline. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"indentation": {
"description": "This rule imposes a standard number of spaces to be used for indentation. Since whitespace is significant in CoffeeScript, it's critical that a project chooses a standard indentation format and stays consistent. Other roads lead to darkness. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"value": {
"type": "integer",
"enum": [2, 4]
}
}
},
"line_endings": {
"description": "This rule ensures your project uses only windows or unix line endings. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"value": {
"type": "string",
"enum": ["unix", "windows"]
}
}
},
"max_line_length": {
"description": "This rule imposes a maximum line length on your code. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"value": {
"type": "integer"
},
"limitComments": {
"type": "boolean"
}
}
},
"missing_fat_arrows": {
"description": "Warns when you use `this` inside a function that wasn't defined with a fat arrow. This rule does not apply to methods defined in a class, since they have `this` bound to the class instance (or the class itself, for class methods). [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"newlines_after_classes": {
"description": "Checks the number of newlines between classes and other code. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"value": {
"type": "integer"
}
}
},
"no_backticks": {
"description": "Backticks allow snippets of JavaScript to be embedded in CoffeeScript. While some folks consider backticks useful in a few niche circumstances, they should be avoided because so none of JavaScript's 'bad parts', like with and eval, sneak into CoffeeScript. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_debugger": {
"description": "This rule detects the `debugger` statement. [default level: warn]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_empty_functions": {
"description": "Disallows declaring empty functions. The goal of this rule is that unintentional empty callbacks can be detected. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_empty_param_list": {
"description": "This rule prohibits empty parameter lists in function definitions. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_implicit_braces": {
"description": "This rule prohibits implicit braces when declaring object literals. Implicit braces can make code more difficult to understand, especially when used in combination with optional parenthesis. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"strict": {
"type": "boolean"
}
}
},
"no_implicit_parens": {
"description": "This rule prohibits implicit parens on function calls. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_interpolation_in_single_quotes": {
"description": "This rule prohibits string interpolation in a single quoted string. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_nested_string_interpolation": {
"description": "This rule warns about nested string interpolation, as it tends to make code harder to read and understand. [default level: warn]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_plusplus": {
"description": "This rule forbids the increment and decrement arithmetic operators. Some people believe the `++` and `--` to be cryptic and the cause of bugs due to misunderstandings of their precedence rules. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_private_function_fat_arrows": {
"description": "Warns when you use the fat arrow for a private function inside a class definition scope. It is not necessary and it does not do anything. [default level: warn]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_stand_alone_at": {
"description": "This rule checks that no stand alone `@` are in use, they are discouraged. [default level: ignore]",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_tabs": {
"description": "This rule forbids tabs in indentation. Enough said. [default level: error]",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_this": {
"description": "This rule prohibits `this`. Use `@` instead. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_throwing_strings": {
"description": "This rule forbids throwing string literals or interpolations. While JavaScript (and CoffeeScript by extension) allow any expression to be thrown, it is best to only throw `Error` objects, because they contain valuable debugging information like the stack trace. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_trailing_semicolons": {
"description": "This rule prohibits trailing semicolons, since they are needless cruft in CoffeeScript. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_trailing_whitespace": {
"description": "This rule forbids trailing whitespace in your code, since it is needless cruft. [default level: error]",
"allOf": [
{
"$ref": "#/definitions/base"
}
],
"properties": {
"allowed_in_comments": {
"type": "boolean"
},
"allowed_in_empty_lines": {
"type": "boolean"
}
}
},
"no_unnecessary_double_quotes": {
"description": "This rule prohibits double quotes unless string interpolation is used or the string contains single quotes. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"no_unnecessary_fat_arrows": {
"description": "Disallows defining functions with fat arrows when `this` is not used within the function. [default level: warn]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"non_empty_constructor_needs_parens": {
"description": "Requires constructors with parameters to include the parens. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"prefer_english_operator": {
"description": "This rule prohibits `&&`, `||`, `==`, `!=` and `!`. Use `and`, `or`, `is`, `isnt`, and `not` instead. `!!` (for converting to a boolean) is ignored. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"space_operators": {
"description": "This rule enforces that operators have space around them. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"spacing_after_comma": {
"description": "This rule checks to make sure you have a space after commas. [default level: ignore]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
},
"transform_messes_up_line_numbers": {
"description": "This rule detects when changes are made by transform function, and warns that line numbers are probably incorrect. [default level: warn]",
"allOf": [
{
"$ref": "#/definitions/base"
}
]
}
},
"title": "JSON schema for coffeelint.json files",
"type": "object"
}
|
chart.json | {
"$id": "https://json.schemastore.org/chart.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"apiVersion": {
"description": "The apiVersion field should be v2 for Helm charts that require at least Helm 3. Charts supporting previous Helm versions have an apiVersion set to v1 and are still installable by Helm 3.",
"enum": ["v1", "v2"]
},
"name": {
"description": "The name of the chart",
"type": "string"
},
"version": {
"description": "A SemVer 2 version",
"type": "string"
},
"kubeVersion": {
"description": "The optional kubeVersion field can define semver constraints on supported Kubernetes versions. Helm will validate the version constraints when installing the chart and fail if the cluster runs an unsupported Kubernetes version.",
"type": "string"
},
"description": {
"description": "A single-sentence description of this project",
"type": "string"
},
"type": {
"description": "The type of the chart",
"default": "application",
"enum": ["application", "library"]
},
"keywords": {
"type": "array",
"description": "A list of keywords about this project",
"items": {
"type": "string"
}
},
"home": {
"description": "The URL of this projects home page",
"type": "string",
"format": "uri"
},
"sources": {
"type": "array",
"description": "A list of URLs to source code for this project",
"items": {
"type": "string",
"format": "uri"
}
},
"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"],
"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",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"pattern": "^@"
}
]
},
"condition": {
"description": "A yaml path that resolves to a boolean, used for enabling/disabling charts",
"type": "string"
},
"tags": {
"description": "Tags can be used to group charts for enabling/disabling together",
"type": "array",
"items": {
"type": "string"
}
},
"import-values": {
"description": "ImportValues holds the mapping of source values to parent key to be imported. Each item can be a string or pair of child/parent sublist items.",
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"required": ["parent", "child"],
"properties": {
"parent": {
"description": "The destination path in the parent chart's values",
"type": "string"
},
"child": {
"description": "The source key of the values to be imported",
"type": "string"
}
}
}
]
}
},
"alias": {
"description": "Alias to be used for the chart. Useful when you have to add the same chart multiple times",
"type": "string"
}
}
}
},
"maintainers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["name"],
"properties": {
"name": {
"description": "The maintainers name",
"type": "string"
},
"email": {
"description": "The maintainers email",
"type": "string",
"format": "email"
},
"url": {
"description": "A URL for the maintainer",
"type": "string",
"format": "uri"
}
}
}
},
"icon": {
"description": "A URL to an SVG or PNG image to be used as an icon",
"type": "string",
"format": "uri"
},
"appVersion": {
"description": "Note that the appVersion field is not related to the version field. It is a way of specifying the version of the application. For example, the drupal chart may have an appVersion: \"8.2.1\", indicating that the version of Drupal included in the chart (by default) is 8.2.1. This field is informational, and has no impact on chart version calculations. Wrapping the version in quotes is highly recommended. It forces the YAML parser to treat the version number as a string. Leaving it unquoted can lead to parsing issues in some cases. For example, YAML interprets 1.0 as a floating point value, and a git commit SHA like 1234e10 as scientific notation.",
"type": "string"
},
"deprecated": {
"description": "When managing charts in a Chart Repository, it is sometimes necessary to deprecate a chart. The optional deprecated field in Chart.yaml can be used to mark a chart as deprecated. If the latest version of a chart in the repository is marked as deprecated, then the chart as a whole is considered to be deprecated. The chart name can be later reused by publishing a newer version that is not marked as deprecated.",
"type": "boolean"
},
"annotations": {
"description": "A list of annotations keyed by name",
"type": "object",
"additionalProperties": {
"type": "string"
},
"properties": {
"artifacthub.io/changes": {
"description": "This annotation is used to provide some details about the changes introduced by a given chart version. Artifact Hub can generate and display a ChangeLog based on the entries in the changes field in all your chart versions.\nThis annotation can be provided using two different formats: using a plain list of strings with the description of the change or using a list of objects with some extra structured information (see example below). Please feel free to use the one that better suits your needs. The UI experience will be slightly different depending on the choice. When using the list of objects option the valid supported kinds are added, changed, deprecated, removed, fixed and security.",
"type": "string"
},
"artifacthub.io/containsSecurityUpdates": {
"description": "Use this annotation to indicate that this chart version contains security updates. When a package release contains security updates, a special message will be displayed in the Artifact Hub UI as well as in the new release email notification.",
"enum": ["true", "false"]
},
"artifacthub.io/crds": {
"description": "By default, Artifact Hub will try to extract the containers images used by Helm charts from the manifests generated from a dry-run install using the default values. If you prefer, you can also provide a list of containers images manually by using this annotation.\nContainers images will be scanned for security vulnerabilities. The security report generated will be available in the package detail view. It is possible to whitelist images so that they are not scanned by setting the whitelisted flag to true.",
"type": "string"
},
"artifacthub.io/images": {
"description": "This annotation can be used to list the operator's CRDs. They will be visible in the package's detail view as cards.",
"type": "string"
},
"artifacthub.io/crdsExamples": {
"description": "Use this annotation to provide a list of example CRs for the operator's CRDs. Each of the examples can be opened from the corresponding CRD card in the package's detail view.",
"type": "string"
},
"artifacthub.io/license": {
"description": "Use this annotation to indicate the chart's license. By default, Artifact Hub tries to read the chart's license from the LICENSE file in the chart, but it's possible to override or provide it with this annotation. It must be a valid SPDX identifier.",
"type": "string"
},
"artifacthub.io/links": {
"description": "This annotation allows including named links, which will be rendered nicely in Artifact Hub. You can use this annotation to include links not included previously in the Chart.yaml file, or you can use it to name links already present (in the sources section, for example).",
"type": "string"
},
"artifacthub.io/maintainers": {
"description": "This annotation can be used if you want to display a different name for a given user in Artifact Hub than the one used in the Chart.yaml file. If the email used matches, the name used in the annotations entry will be displayed in Artifact Hub. It's also possible to include maintainers that should only be listed in Artifact Hub by adding additional entries.",
"type": "string"
},
"artifacthub.io/operator": {
"description": "Use this annotation to indicate that your chart represents an operator. Artifact Hub at the moment also considers your chart to represent an operator if the word operator appears in the chart name.",
"enum": ["true", "false"]
},
"artifacthub.io/operatorCapabilities": {
"description": "Use this annotation to indicate the capabilities of the operator your chart provides. It must be one of the following options: Basic Install, Seamless Upgrades, Full Lifecycle, Deep Insights or Auto Pilot. For more information please see the capability level diagram.",
"enum": [
"Basic Install",
"Seamless Upgrades",
"Full Lifecycle",
"Deep Insights",
"Auto Pilot"
]
},
"artifacthub.io/prerelease": {
"description": "Use this annotation to indicate that this chart version is a pre-release. This status will be displayed in the UI's package view, as well as in new releases notifications emails.",
"enum": ["true", "false"]
},
"artifacthub.io/recommendations": {
"description": "This annotation allows recommending other related packages. Recommended packages will be featured in the package detail view in Artifact Hub.",
"type": "string"
},
"artifacthub.io/signKey": {
"description": "This annotation can be used to provide some information about the key used to sign a given chart version. This information will be displayed on the Artifact Hub UI, making it easier for users to get the information they need to verify the integrity and origin of your chart. The url field indicates where users can find the public key and it is mandatory when a sign key entry is provided.",
"type": "string"
}
}
}
},
"required": ["apiVersion", "name", "version"],
"title": "Helm Chart.yaml",
"type": "object"
}
|
jscpd.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"colorPreset": {
"enum": [
"green",
"blue",
"red",
"yellow",
"orange",
"purple",
"pink",
"grey",
"gray",
"cyan",
"black"
]
},
"colorHex": {
"type": "string",
"pattern": "([0-9a-fA-F]{3}){1,2}"
},
"color": {
"oneOf": [
{
"$ref": "#/definitions/colorPreset"
},
{
"$ref": "#/definitions/colorHex"
}
]
},
"format": {
"enum": [
"abap",
"actionscript",
"ada",
"apacheconf",
"apl",
"applescript",
"arduino",
"arff",
"asciidoc",
"asm6502",
"aspnet",
"autohotkey",
"autoit",
"bash",
"basic",
"batch",
"bison",
"brainfuck",
"bro",
"c",
"c-header",
"clike",
"clojure",
"coffeescript",
"comments",
"cpp",
"cpp-header",
"crystal",
"csharp",
"csp",
"css-extras",
"css",
"d",
"dart",
"diff",
"django",
"docker",
"eiffel",
"elixir",
"elm",
"erb",
"erlang",
"flow",
"fortran",
"fsharp",
"gedcom",
"gherkin",
"git",
"glsl",
"go",
"graphql",
"groovy",
"haml",
"handlebars",
"haskell",
"haxe",
"hpkp",
"hsts",
"http",
"ichigojam",
"icon",
"inform7",
"ini",
"io",
"j",
"java",
"javascript",
"jolie",
"json",
"jsx",
"julia",
"keymap",
"kotlin",
"latex",
"less",
"liquid",
"lisp",
"livescript",
"lolcode",
"lua",
"makefile",
"markdown",
"markup",
"matlab",
"mel",
"mizar",
"monkey",
"n4js",
"nasm",
"nginx",
"nim",
"nix",
"nsis",
"objectivec",
"ocaml",
"opencl",
"oz",
"parigp",
"pascal",
"perl",
"php",
"plsql",
"powershell",
"processing",
"prolog",
"properties",
"protobuf",
"pug",
"puppet",
"pure",
"python",
"q",
"qore",
"r",
"reason",
"renpy",
"rest",
"rip",
"roboconf",
"ruby",
"rust",
"sas",
"sass",
"scala",
"scheme",
"scss",
"smalltalk",
"smarty",
"soy",
"sql",
"stylus",
"swift",
"tap",
"tcl",
"textile",
"tsx",
"tt2",
"twig",
"typescript",
"vbnet",
"velocity",
"verilog",
"vhdl",
"vim",
"visual-basic",
"wasm",
"url",
"wiki",
"xeora",
"xojo",
"xquery",
"yaml"
]
}
},
"id": "https://json.schemastore.org/jscpd.json",
"properties": {
"minLines": {
"type": "integer",
"default": 5,
"description": "minimum size of code block in lines to check for duplication"
},
"maxLines": {
"type": "integer",
"default": 1000,
"description": "maximum size of source file in lines to check for duplication"
},
"maxSize": {
"anyOf": [
{
"type": "string",
"pattern": "^\\+?[0-9]+(\\.[0-9]+)? *[kKmMgGtTpP][bB]$"
},
{
"type": "integer"
}
],
"default": "100kb",
"description": "maximum size of source file in bytes to check for duplication (e.g.,: 1kb, 1mb, 120kb)"
},
"minTokens": {
"type": "integer",
"default": 50,
"description": "minimum size of code block in tokens to check for duplication"
},
"threshold": {
"type": "number",
"description": "maximum allowed duplicate lines expressed as a percentage; exit with error and exit code 1 when threshold exceeded"
},
"formatsExts": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"default": {},
"description": "custom mapping from formats to file extensions (default: https://github.com/kucherenko/jscpd/blob/master/packages/tokenizer/src/formats.ts); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md"
},
"output": {
"type": "string",
"default": "./report",
"description": "path to directory for non-console reports"
},
"path": {
"type": "array",
"items": {
"type": "string"
},
"description": "paths that should be included in duplicate detection (default: [process.cwd()])"
},
"pattern": {
"type": "string",
"default": "**/*",
"description": "glob pattern for files that should be included in duplicate detection (e.g., **/*.txt); only used to filter directories configured via path option"
},
"ignorePattern": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "ignore code blocks matching these regular expressions"
},
"mode": {
"enum": ["mild", "strict", "weak"],
"default": "mild",
"description": "mode of detection quality; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#mode"
},
"ignore": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "glob pattern for files that should be excluded from duplicate detection"
},
"format": {
"type": "array",
"items": {
"$ref": "#/definitions/format"
},
"description": "list of formats for which to detect duplication (default: all); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md"
},
"store": {
"enum": ["leveldb", "redis"],
"description": "store used to collect information about code (default: in-memory store); install @jscpd/leveldb-store and use leveldb for big repositories"
},
"reporters": {
"type": "array",
"items": {
"enum": [
"xml",
"json",
"csv",
"markdown",
"consoleFull",
"html",
"console",
"silent",
"threshold",
"xcode"
]
},
"default": ["console"],
"description": "a list of reporters to use to output information about duplication; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#reporters"
},
"blame": {
"type": "boolean",
"default": false,
"description": "get information about authors and dates of duplicated blocks from Git"
},
"silent": {
"type": "boolean",
"default": false,
"description": "do not write duplicate detection progress and result to console"
},
"verbose": {
"type": "boolean",
"default": false,
"description": "show full information during duplicate detection"
},
"absolute": {
"type": "boolean",
"default": false,
"description": "use absolute paths in reports"
},
"noSymLinks": {
"type": "boolean",
"default": false,
"description": "do not follow symlinks"
},
"skipLocal": {
"type": "boolean",
"default": false,
"description": "skip duplicates within folders; just detect cross-folder duplicates"
},
"ignoreCase": {
"type": "boolean",
"default": false,
"description": "ignore case of symbols in code (experimental)"
},
"gitignore": {
"type": "boolean",
"default": false,
"description": "ignore all files from .gitignore file"
},
"reportersOptions": {
"type": "object",
"default": {},
"additionalProperties": false,
"properties": {
"badge": {
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"type": "string",
"description": "output path for duplication level badge (default: path.join(output, 'jscpd-badge.svg'))"
},
"label": {
"type": "string",
"default": "Copy/Paste",
"description": "badge subject text (URL-encoding needed for spaces or special characters)"
},
"labelColor": {
"$ref": "#/definitions/color",
"default": "555",
"description": "badge label color (name or RGB code without #); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts"
},
"status": {
"type": "string",
"description": "badge value text (URL-encoding needed for spaces or special characters, default: duplication %)"
},
"color": {
"$ref": "#/definitions/color",
"description": "badge color (name or RGB code without #, default: green if beneath threshold, red if above threshold, grey if threshold not set); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts"
},
"style": {
"enum": ["flat", "classic"],
"default": "classic",
"description": "badge look: flat or classic"
},
"icon": {
"type": "string",
"description": "URL for icon to display in front of badge subject text (e.g., data:image/svg+xml;base64,...)"
},
"iconWidth": {
"type": "number",
"default": 13,
"description": "SVG width of icon to display in front of badge subject text; set this if icon is not square"
},
"scale": {
"type": "number",
"default": 1,
"description": "size of badge relative to default of 1"
}
}
}
}
},
"exitCode": {
"type": "integer",
"default": 0,
"description": "exit code to use when at least one duplicate code block is detected but threshold is not exceeded"
}
},
"type": "object"
}
|
sarif-1.0.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"annotatedCodeLocation": {
"description": "An annotation used to express code flows through a method or other locations that are related to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "OBSOLETE (use \"step\" instead): An identifier for the location, unique within the scope of the code flow within which it occurs.",
"type": ["integer", "string"],
"pattern": "^[1-9][0-9]*$",
"minimum": 1
},
"step": {
"description": "The 0-based sequence number of the location in the code flow within which it occurs.",
"type": "integer",
"minimum": 0
},
"physicalLocation": {
"description": "A file location to which this annotation refers.",
"$ref": "#/definitions/physicalLocation"
},
"fullyQualifiedLogicalName": {
"description": "The fully qualified name of the method or function that is executing.",
"type": "string"
},
"logicalLocationKey": {
"description": "A key used to retrieve the annotation's logicalLocation from the logicalLocations dictionary.",
"type": "string"
},
"module": {
"description": "The name of the module that contains the code that is executing.",
"type": "string"
},
"threadId": {
"description": "The thread identifier of the code that is executing.",
"type": "integer"
},
"message": {
"description": "A message relevant to this annotation.",
"type": "string"
},
"kind": {
"description": "Categorizes the location.",
"enum": [
"alias",
"assignment",
"branch",
"call",
"callReturn",
"continuation",
"declaration",
"functionEnter",
"functionExit",
"functionReturn",
"usage"
]
},
"taintKind": {
"description": "Classifies state transitions in code locations relevant to a taint analysis.",
"enum": ["source", "sink", "sanitizer"]
},
"target": {
"description": "The fully qualified name of the target on which this location operates. For an annotation of kind 'call', for example, the target refers to the fully qualified logical name of the function called from this location.",
"type": "string"
},
"values": {
"description": "An ordered set of strings that comprise input or return values for the current operation. For an annotation of kind 'call', for example, this property may hold the ordered list of arguments passed to the callee.",
"type": "array",
"default": [],
"items": {
"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"
},
"targetKey": {
"description": "A key used to retrieve the target's logicalLocation from the logicalLocations dictionary.",
"type": "string"
},
"essential": {
"description": "OBSOLETE (use \"importance\" instead): True if this location is essential to understanding the code flow in which it occurs.",
"type": "boolean"
},
"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"]
},
"snippet": {
"description": "The source code at the specified location.",
"type": "string"
},
"annotations": {
"description": "A set of messages relevant to the current annotated code location.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/annotation"
}
},
"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"
}
}
}
}
}
},
"annotation": {
"type": "object",
"properties": {
"message": {
"description": "A message relevant to a code location",
"type": "string"
},
"locations": {
"description": "An array of 'physicalLocation' objects associated with the annotation.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/physicalLocation"
}
}
},
"required": ["message", "locations"]
},
"codeFlow": {
"type": "object",
"properties": {
"message": {
"description": "A message relevant to the code flow",
"type": "string"
},
"locations": {
"description": "An array of 'annotatedCodeLocation' objects, each of which describes a single location visited by the tool in the course of producing the result.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/annotatedCodeLocation"
}
},
"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": ["locations"]
},
"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 string 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"
}
}
}
},
"fileChange": {
"description": "A change to a single file.",
"additionalProperties": false,
"type": "object",
"properties": {
"uri": {
"description": "A string that represents the location of the file to change as a valid URI.",
"type": "string",
"format": "uri"
},
"uriBaseId": {
"description": "A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.",
"type": "string"
},
"replacements": {
"description": "An array of replacement objects, each of which represents the replacement of a single range of bytes in a single file specified by 'uri'.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/replacement"
}
}
},
"required": ["uri", "replacements"],
"dependencies": {
"uriBaseId": ["uri"]
}
},
"file": {
"description": "A single file. In some cases, this file might be nested within another file.",
"additionalProperties": false,
"type": "object",
"properties": {
"uri": {
"description": "The path to the file within its containing file.",
"type": "string",
"format": "uri"
},
"uriBaseId": {
"description": "A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.",
"type": "string"
},
"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"
},
"mimeType": {
"description": "The MIME type (RFC 2045) of the file.",
"type": "string",
"pattern": "[^/]+/.+"
},
"contents": {
"description": "The contents of the file, expressed as a MIME Base64-encoded byte sequence.",
"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 algorithm used to compute the hash.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/hash"
}
},
"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"
}
}
}
}
},
"dependencies": {
"uriBaseId": ["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 string that describes the proposed fix, enabling viewers to present a proposed change to an end user.",
"type": "string"
},
"fileChanges": {
"description": "One or more file changes that comprise a fix for a result.",
"type": "array",
"items": {
"$ref": "#/definitions/fileChange"
}
}
},
"required": ["description", "fileChanges"]
},
"formattedRuleMessage": {
"description": "Contains information that can be used to construct a formatted message that describes a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"formatId": {
"description": "A string that identifies the message format used to format the message that describes this result. The value of formatId must correspond to one of the names in the set of name/value pairs contained in the 'messageFormats' property of the rule object whose 'id' property matches the 'ruleId' property of this result.",
"type": "string"
},
"arguments": {
"description": "An array of strings that will be used, in combination with a message format, to construct a result message.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["formatId"]
},
"hash": {
"description": "A hash value of some file or collection of files, together with the algorithm 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 algorithm named in the 'algorithm' property.",
"type": "string"
},
"algorithm": {
"description": "The name of the algorithm used to compute the hash value specified in the 'value' property.",
"enum": [
"authentihash",
"blake256",
"blake512",
"ecoh",
"fsb",
"gost",
"groestl",
"has160",
"haval",
"jh",
"md2",
"md4",
"md5",
"md6",
"radioGatun",
"ripeMD",
"ripeMD128",
"ripeMD160",
"ripeMD320",
"sdhash",
"sha1",
"sha224",
"sha256",
"sha384",
"sha512",
"sha3",
"skein",
"snefru",
"spectralHash",
"ssdeep",
"swifft",
"tiger",
"tlsh",
"whirlpool"
]
}
},
"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"
},
"responseFiles": {
"description": "The contents of any response files specified on the tool's command line.",
"type": "object",
"additionalProperties": true
},
"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"
},
"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"
},
"fileName": {
"description": "The fully qualified path to the analysis tool.",
"type": "string"
},
"workingDirectory": {
"description": "The working directory for the analysis rool run.",
"type": "string"
},
"environmentVariables": {
"description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.",
"type": "object",
"additionalProperties": true,
"default": {}
},
"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.",
"type": "array",
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
}
}
},
"location": {
"description": "The location where an analysis tool produced a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"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/physicalLocation"
},
"resultFile": {
"description": "Identifies the file where the analysis tool produced the result.",
"$ref": "#/definitions/physicalLocation"
},
"fullyQualifiedLogicalName": {
"description": "The human-readable fully qualified name of the logical location where the analysis tool produced the result. If 'logicalLocationKey' is not specified, this member is can used to retrieve the location logicalLocation from the logicalLocations dictionary, if one exists.",
"type": "string"
},
"logicalLocationKey": {
"description": "A key used to retrieve the location logicalLocation from the logicalLocations dictionary, when the string specified by 'fullyQualifiedLogicalName' is not unique.",
"type": "string"
},
"decoratedName": {
"description": "The machine-readable fully qualified name for the logical location where the analysis tool produced the result, such as the mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.",
"type": "string"
},
"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"
},
"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', 'resource', or 'type', if any of those accurately describe the construct.",
"type": "string"
}
}
},
"notification": {
"type": "object",
"description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.",
"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. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
"type": "string"
},
"ruleKey": {
"description": "A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.",
"type": "string"
},
"physicalLocation": {
"description": "The file and region relevant to this notification.",
"$ref": "#/definitions/physicalLocation"
},
"message": {
"description": "A string that describes the condition that was encountered.",
"type": "string"
},
"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": {
"uri": {
"description": "The location of the file as a valid URI.",
"type": "string",
"format": "uri"
},
"uriBaseId": {
"description": "A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.",
"type": "string"
},
"region": {
"description": "The region within the file where the result was detected.",
"$ref": "#/definitions/region"
}
},
"dependencies": {
"uriBaseId": ["uri"]
}
},
"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 last character in the region.",
"type": "integer",
"minimum": 1
},
"offset": {
"description": "The zero-based offset from the beginning of the file of the first byte or character in the region.",
"type": "integer",
"minimum": 0
},
"length": {
"description": "The length of the region in bytes or characters.",
"type": "integer",
"minimum": 0
}
}
},
"replacement": {
"description": "The replacement of a single range of bytes in a file. Specifies the location within the file where the replacement is to be made, the number of bytes to remove at that location, and a sequence of bytes to insert at that location.",
"additionalProperties": false,
"type": "object",
"properties": {
"offset": {
"description": "A non-negative integer specifying the offset in bytes from the beginning of the file at which bytes are to be removed, inserted or both. An offset of 0 shall denote the first byte in the file.",
"type": "integer",
"minimum": 0
},
"deletedLength": {
"description": "The number of bytes to delete, starting at the byte offset specified by offset, measured from the beginning of the file.",
"type": "integer",
"minimum": 1
},
"insertedBytes": {
"description": "The MIME Base64-encoded byte sequence to be inserted at the byte offset specified by the 'offset' property, measured from the beginning of the file.",
"type": "string"
}
},
"required": ["offset"]
},
"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. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
"type": "string"
},
"ruleKey": {
"description": "A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.",
"type": "string"
},
"level": {
"description": "A value specifying the severity level of the result. If this property is not present, its implied value is 'warning'.",
"default": "warning",
"enum": ["notApplicable", "pass", "note", "warning", "error"]
},
"message": {
"description": "A string that describes the result. The first sentence of the message only will be displayed when visible space is limited.",
"type": "string"
},
"formattedRuleMessage": {
"description": "A 'formattedRuleMessage' object that can be used to construct a formatted message that describes the result. If the 'formattedMessage' property is present on a result, the 'fullMessage' property shall not be present. If the 'fullMessage' property is present on an result, the 'formattedMessage' property shall not be present",
"$ref": "#/definitions/formattedRuleMessage"
},
"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"
}
},
"snippet": {
"description": "A source code or other file fragment that illustrates the result.",
"type": "string"
},
"id": {
"description": "A unique identifier for the result.",
"type": "string"
},
"toolFingerprintContribution": {
"description": "A string that contributes to the unique identity of the result.",
"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"
}
},
"relatedLocations": {
"description": "A grouped set of locations and messages, if available, that represent code areas that are related to this result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/annotatedCodeLocation"
}
},
"suppressionStates": {
"type": "array",
"items": {
"description": "A flag value indicating one or more suppression conditions.",
"enum": ["suppressedInSource", "suppressedExternally"]
}
},
"baselineState": {
"description": "The state of a result relative to a baseline of a previous run.",
"enum": ["new", "existing", "absent"]
},
"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.",
"type": "string"
},
"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.",
"type": "string"
},
"fullDescription": {
"description": "A string that describes the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
"type": "string"
},
"messageFormats": {
"description": "A set of name/value pairs with arbitrary names. The value within each name/value pair shall consist of plain text interspersed with placeholders, which can be used to format a message in combination with an arbitrary number of additional string arguments.",
"type": "object"
},
"defaultLevel": {
"description": "A value specifying the default severity level of the result.",
"default": "warning",
"enum": ["note", "warning", "error"]
},
"helpUri": {
"description": "A URI where the primary documentation for the rule can be found.",
"type": "string",
"format": "uri"
},
"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"]
},
"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"
},
"invocation": {
"description": "Describes the runtime environment, including parameterization, of the analysis tool run.",
"$ref": "#/definitions/invocation"
},
"files": {
"description": "A dictionary, each of whose keys is a URI and each of whose values is an array of file objects representing the location of a single file scanned during the run.",
"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"
}
},
"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) in the event that a log file represents an actual scan.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/result"
}
},
"toolNotifications": {
"description": "A list of runtime conditions detected by the tool in the course of 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"
}
},
"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"
}
},
"id": {
"description": "An identifier for the run.",
"type": "string"
},
"stableId": {
"description": "A stable identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same stableId.",
"type": "string"
},
"automationId": {
"description": "A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.",
"type": "string"
},
"baselineId": {
"description": "The 'id' property of a separate (potentially external) SARIF 'run' instance 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"
}
},
"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.",
"type": "string"
},
"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": {
"message": {
"description": "A message relevant to this stack frame.",
"type": "string"
},
"uri": {
"description": "The uri of the source code file to which this stack frame refers.",
"type": "string",
"format": "uri"
},
"uriBaseId": {
"description": "A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.",
"type": "string"
},
"line": {
"description": "The line of the location to which this stack frame refers.",
"type": "integer"
},
"column": {
"description": "The line of the location to which this stack frame refers.",
"type": "integer"
},
"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"
},
"fullyQualifiedLogicalName": {
"description": "The fully qualified name of the method or function that is executing.",
"type": "string"
},
"logicalLocationKey": {
"description": "A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.",
"type": "string"
},
"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"
}
}
}
}
},
"required": ["fullyQualifiedLogicalName"],
"dependencies": {
"uriBaseId": ["uri"],
"line": ["uri"],
"column": ["line"]
}
},
"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}"
},
"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"
},
"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"]
}
},
"description": "Static Analysis Results Format (SARIF) Version 1.0.0 JSON Schema: a standard format for the output of static analysis and other tools.",
"id": "https://json.schemastore.org/sarif-1.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": ["1.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 1.0.0 JSON Schema",
"type": "object"
}
|
schema-catalog.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://json.schemastore.org/schema-catalog.json",
"properties": {
"schemas": {
"type": "array",
"description": "A list of JSON schema references.",
"items": {
"type": "object",
"required": ["name", "url", "description"],
"additionalProperties": false,
"properties": {
"fileMatch": {
"description": "A Minimatch glob expression for matching up file names with a schema.",
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"description": "An absolute URL to the schema location",
"type": "string",
"format": "uri",
"pattern": "^https://"
},
"name": {
"description": "The name of the schema",
"type": "string"
},
"description": {
"description": "A description of the schema",
"type": "string"
},
"versions": {
"type": "object",
"description": "A set of specific version to schema mappings",
"additionalProperties": {
"type": "string",
"format": "uri",
"pattern": "^https://"
}
}
}
}
},
"version": {
"description": "The schema version of the catalog",
"type": "number"
},
"$schema": {
"description": "Link to https://json.schemastore.org/schema-catalog.json",
"type": "string",
"enum": ["https://json.schemastore.org/schema-catalog.json"]
}
},
"required": ["schemas", "version", "$schema"],
"title": "JSON schema for SchemaStore.org catalog files",
"type": "object"
}
|
pathfinder-policy-yml-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/transcend-io/cli/main/pathfinder-policy-yml-schema.json",
"title": "pathfinderPolicy.yml",
"description": "Define the schema for the the Transcend AI Proxy service.",
"type": "object",
"properties": {
"enabledIntegrations": {
"type": "object",
"properties": {
"openAI": {
"type": "object",
"required": ["enabledRoutes"],
"properties": {
"enabledRoutes": {
"type": "array",
"items": {
"type": "object",
"required": ["routeName", "enabledPolicies"],
"properties": {
"routeName": {
"anyOf": [
{
"const": "/v1/chat/completions"
},
{
"const": "/v1/embeddings"
}
]
},
"enabledPolicies": {
"type": "array",
"items": {
"anyOf": [
{
"const": "redactEmail"
},
{
"const": "log"
}
]
}
}
}
}
}
}
}
}
}
}
}
|
opspec-io-0.1.7.json | {
"$id": "https://opspec.io/0.1.7/op.yml.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Defines an op",
"properties": {
"name": {
"description": "Name of the op",
"type": "string"
},
"description": {
"description": "Description of the op",
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"inputs": {
"additionalProperties": false,
"description": "Parameter of an op",
"patternProperties": {
"[-_.a-zA-Z0-9]+": {
"oneOf": [
{
"required": ["array"]
},
{
"required": ["boolean"]
},
{
"required": ["dir"]
},
{
"required": ["file"]
},
{
"required": ["number"]
},
{
"required": ["object"]
},
{
"required": ["socket"]
},
{
"required": ["string"]
}
],
"properties": {
"array": {
"additionalProperties": false,
"title": "arrayParam",
"description": "Array parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"default": {
"type": "array"
},
"isSecret": {
"description": "If the array is secret",
"type": "boolean"
},
"constraints": {
"title": "arrayConstraints",
"type": "object",
"properties": {
"additionalItems": {
"description": "JSON Schema [additionalItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.10)",
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints/properties/properties/additionalProperties"
},
"items": {
"description": "JSON Schema [items keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.9)",
"anyOf": [
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints/properties/properties/additionalProperties"
},
{
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints/properties/properties/additionalProperties"
}
}
]
},
"maxItems": {
"description": "JSON Schema [maxItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.10)",
"type": "integer",
"minimum": 0
},
"minItems": {
"description": "JSON Schema [minItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.11)",
"type": "integer",
"minimum": 0
},
"uniqueItems": {
"description": "JSON Schema [uniqueItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13)",
"type": "boolean"
}
},
"additionalProperties": false
}
},
"type": "object"
},
"boolean": {
"additionalProperties": false,
"title": "booleanParam",
"description": "Boolean parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"default": {
"description": "Default value",
"type": "boolean"
}
},
"type": "object"
},
"dir": {
"additionalProperties": false,
"title": "dirParam",
"description": "Directory parameter of an op",
"properties": {
"description": {
"title": "markdown",
"description": "Markdown in [v0.28 CommonMark syntax](http://spec.commonmark.org/0.28/) including GFM table extension",
"type": "string"
},
"default": {
"description": "Default value; an absolute path rooted at dir containing op.yml or, a relative path interpreted from where the op is started",
"type": "string"
},
"isSecret": {
"description": "If the directory is secret",
"type": "boolean"
}
},
"type": "object"
},
"file": {
"additionalProperties": false,
"title": "fileParam",
"description": "File parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"default": {
"description": "Default value; an absolute path rooted at dir containing op.yml or, a relative path interpreted from where the op is started",
"type": "string"
},
"isSecret": {
"description": "If the file is secret",
"type": "boolean"
}
},
"type": "object"
},
"number": {
"additionalProperties": false,
"title": "numberParam",
"description": "Number parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"default": {
"type": "number"
},
"isSecret": {
"description": "If the number is secret",
"type": "boolean"
},
"constraints": {
"title": "numberConstraints",
"type": "object",
"properties": {
"allOf": {
"description": "JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/number/properties/constraints"
}
},
"anyOf": {
"description": "JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/number/properties/constraints"
}
},
"enum": {
"description": "JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)",
"type": "array",
"items": {
"type": "number"
}
},
"format": {
"oneOf": [
{
"title": "integer",
"description": "Requires the number be an integer",
"type": "string",
"enum": ["integer"]
}
]
},
"maximum": {
"description": "JSON Schema [maximum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.2)",
"type": "number"
},
"minimum": {
"description": "JSON Schema [minimum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.4)",
"type": "number"
},
"multipleOf": {
"description": "JSON Schema [multipleOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.1)",
"type": "number"
},
"not": {
"description": "JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)",
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/number/properties/constraints"
},
"oneOf": {
"description": "JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/number/properties/constraints"
}
}
},
"additionalProperties": false
}
},
"type": "object"
},
"object": {
"additionalProperties": false,
"title": "objectParam",
"description": "Object parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"default": {
"type": "object"
},
"isSecret": {
"description": "If the object is secret",
"type": "boolean"
},
"constraints": {
"title": "objectConstraints",
"type": "object",
"properties": {
"additionalProperties": {
"description": "JSON Schema [additionalProperties keyword](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-6.5.6)",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints/properties/properties/additionalProperties"
}
]
},
"allOf": {
"description": "JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints"
}
},
"anyOf": {
"description": "JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints"
}
},
"dependencies": {
"description": "JSON Schema [dependencies keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.19)",
"oneOf": [
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints/properties/properties/additionalProperties"
},
{
"items": {
"type": "string"
}
}
]
},
"enum": {
"description": "JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)",
"type": "array",
"items": {
"type": ["null", "object"]
}
},
"maxProperties": {
"description": "JSON Schema [maxProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.13)",
"type": "integer",
"minimum": 0
},
"minProperties": {
"description": "JSON Schema [minProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.14)",
"type": "integer",
"minimum": 0
},
"not": {
"description": "JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)",
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints"
},
"oneOf": {
"description": "JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints"
}
},
"properties": {
"description": "JSON Schema [properties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.16)",
"type": "object",
"additionalProperties": {
"title": "typeConstraints",
"description": "Parameter constraints",
"anyOf": [
{
"properties": {
"description": {
"description": "JSON Schema [description](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)",
"type": "string"
},
"title": {
"description": "JSON Schema [title](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)",
"type": "string"
},
"type": {
"description": "JSON Schema [type](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.21)",
"type": ["array", "string"]
},
"writeOnly": {
"description": "JSON Schema [writeOnly](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-10.3)",
"type": "boolean"
}
}
},
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/array/properties/constraints"
},
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/number/properties/constraints"
},
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints"
},
{
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/string/properties/constraints"
}
]
}
},
"patternProperties": {
"description": "JSON Schema [patternProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.17)",
"type": "object",
"additionalProperties": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/object/properties/constraints/properties/properties/additionalProperties"
}
},
"required": {
"description": "JSON Schema [required keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.15)",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"type": "object"
},
"socket": {
"additionalProperties": false,
"title": "socketParam",
"description": "Socket parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"isSecret": {
"description": "If the socket is secret",
"type": "boolean"
}
},
"type": "object"
},
"string": {
"additionalProperties": false,
"title": "stringParam",
"description": "String parameter of an op",
"properties": {
"description": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/dir/properties/description"
},
"default": {
"type": "string"
},
"isSecret": {
"description": "If the string is secret",
"type": "boolean"
},
"constraints": {
"title": "stringConstraints",
"type": "object",
"properties": {
"allOf": {
"description": "JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/string/properties/constraints"
}
},
"anyOf": {
"description": "JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/string/properties/constraints"
}
},
"enum": {
"description": "JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)",
"type": "array",
"items": {
"type": "string"
}
},
"format": {
"description": "Superset of JSON Schema [format keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7)",
"oneOf": [
{
"title": "date-time",
"description": "JSON Schema [date-time format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.1)",
"type": "string",
"enum": ["date-time"]
},
{
"title": "docker-image-ref",
"description": "A docker image reference as defined by [github.com/docker/distribution/reference](https://github.com/docker/distribution/tree/docker/1.13/reference)",
"type": "string",
"enum": ["docker-image-ref"]
},
{
"title": "email",
"description": "JSON Schema [email format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.2)",
"type": "string",
"enum": ["email"]
},
{
"title": "hostname",
"description": "JSON Schema [hostname format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.3)",
"type": "string",
"enum": ["hostname"]
},
{
"title": "ipv4",
"description": "JSON Schema [ipv4 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.4)",
"type": "string",
"enum": ["ipv4"]
},
{
"title": "ipv6",
"description": "JSON Schema [ipv6 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.5)",
"type": "string",
"enum": ["ipv6"]
},
{
"title": "uri",
"description": "JSON Schema [uri format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.6)",
"type": "string",
"enum": ["uri"]
},
{
"title": "semver",
"description": "A semantic version as defined by [semver.org](http://semver.org/)",
"type": "string",
"enum": ["semver"]
}
]
},
"maxLength": {
"description": "JSON Schema [maxLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.6)",
"type": "integer",
"minimum": 1
},
"minLength": {
"description": "JSON Schema [minLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.7)",
"type": "integer",
"minimum": 0,
"default": 0
},
"not": {
"description": "JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)",
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/string/properties/constraints"
},
"oneOf": {
"description": "JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)",
"type": "array",
"items": {
"$ref": "#/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/properties/string/properties/constraints"
}
},
"pattern": {
"description": "JSON Schema [pattern keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.8)",
"type": "string",
"format": "regex"
}
},
"additionalProperties": false
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"outputs": {
"$ref": "#/properties/inputs"
},
"run": {
"additionalProperties": false,
"description": "A single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)",
"oneOf": [
{
"required": ["container"]
},
{
"required": ["op"]
},
{
"required": ["parallel"]
},
{
"required": ["parallelLoop"]
},
{
"required": ["serial"]
},
{
"required": ["serialLoop"]
}
],
"properties": {
"container": {
"title": "containerCall",
"type": "object",
"properties": {
"cmd": {
"description": "Command run by a container; overrides any set at the image level",
"type": "array",
"items": {
"description": "Expression coercible to string value",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
}
},
"dirs": {
"type": "object",
"description": "Directories in the container",
"patternProperties": {
"^([a-zA-Z]:)?[-_.\\/a-zA-Z0-9]+$": {
"oneOf": [
{
"description": "(will be bound to same path in op)",
"type": "null"
},
{
"description": "Expression coercible to dir value &/or scope ref to set upon exit",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
}
]
}
},
"additionalProperties": false
},
"envVars": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^[^=]+$": {
"oneOf": [
{
"description": "(will be bound to in scope ref w/ same name)",
"type": "null"
},
{
"description": "Expression coercible to string value",
"$ref": "#/properties/run/properties/container/properties/name"
}
]
}
},
"type": "object"
},
{
"description": "Reference to a value",
"type": "string",
"pattern": "^\\$\\(.+\\)$"
}
],
"description": "Environment variables in the container"
},
"files": {
"type": "object",
"description": "Files in the container",
"patternProperties": {
"^([a-zA-Z]:)?[-_.\\/a-zA-Z0-9]+$": {
"oneOf": [
{
"description": "(will be bound to same path in op)",
"type": "null"
},
{
"description": "Expression coercible to file value &/or scope ref to set upon exit",
"$ref": "#/properties/run/properties/container/properties/name"
}
]
}
},
"additionalProperties": false
},
"image": {
"type": "object",
"properties": {
"ref": {
"description": "Reference to an image",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
},
"pullCreds": {
"$ref": "#/properties/run/properties/op/properties/pullCreds"
}
},
"required": ["ref"],
"additionalProperties": false
},
"name": {
"description": "Name the container can be referenced by from other containers",
"type": ["array", "boolean", "number", "object", "string"]
},
"ports": {
"description": "Ports bound from the container to the host",
"type": "object",
"patternProperties": {
"[0-9]+(-[0-9]+)?(tcp|udp)?": {
"description": "Host port(s) to bind to",
"type": ["string", "number"],
"pattern": "[0-9]+(-[0-9]+)?"
}
},
"additionalProperties": false
},
"sockets": {
"type": "object",
"patternProperties": {
"[:a-zA-Z0-9]+": {
"description": "Container socket address mapped to a socket ref",
"type": "string"
}
},
"additionalProperties": false
},
"workDir": {
"description": "Working directory path (overrides any defined by image)",
"type": "string"
}
},
"required": ["image"],
"additionalProperties": false
},
"if": {
"description": "If any predicate evaluates to false, the call will be skipped.",
"type": "array",
"items": {
"description": "Condition which evaluates to true or false",
"oneOf": [
{
"required": ["eq"]
},
{
"required": ["exists"]
},
{
"required": ["ne"]
},
{
"required": ["notExists"]
}
],
"properties": {
"eq": {
"description": "True if all items are equal",
"type": "array",
"items": {
"description": "Expression coercible to string value",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
}
},
"exists": {
"description": "True if value exists w/ reference",
"type": "string",
"pattern": "^\\$\\(.+\\)$"
},
"ne": {
"description": "True if any items aren't equal",
"type": "array",
"items": {
"description": "Expression coercible to string value",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
}
},
"notExists": {
"description": "True if no value exists w/ reference",
"type": "string",
"pattern": "^\\$\\(.+\\)$"
}
},
"type": "object"
}
},
"op": {
"type": "object",
"properties": {
"inputs": {
"description": "Initializes INPUT_NAME from VALUE in format 'INPUT_NAME: VALUE'. If VALUE is null, it MUST be assumed VALUE == $(INPUT_NAME)",
"type": "object",
"patternProperties": {
"[-_.a-zA-Z0-9]+": {
"oneOf": [
{
"type": "null"
},
{
"description": "Expression which evaluates to a value",
"type": ["array", "boolean", "number", "object", "string"]
}
]
}
},
"additionalProperties": false
},
"outputs": {
"description": "Initializes NAME from OUTPUT_NAME in format 'NAME: OUTPUT_NAME'. If OUTPUT_NAME is null, it MUST be assumed NAME == OUTPUT_NAME",
"type": "object",
"patternProperties": {
"[-_.a-zA-Z0-9]+": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
}
]
}
},
"additionalProperties": false
},
"pullCreds": {
"type": "object",
"description": "Credentials used during authentication with the source of an image or op",
"properties": {
"username": {
"description": "Expression coercible to string value",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
},
"password": {
"description": "Expression coercible to string value",
"$ref": "#/properties/run/properties/op/properties/inputs/patternProperties/%5B-_.a-zA-Z0-9%5D%2B/oneOf/1"
}
},
"required": ["username", "password"],
"additionalProperties": false
},
"ref": {
"description": "Reference to an op",
"type": "string",
"format": "uri-reference"
}
},
"required": ["ref"],
"additionalProperties": false
},
"parallel": {
"title": "parallelCall",
"type": "array",
"items": {
"$ref": "#/properties/run"
}
},
"parallelLoop": {
"additionalProperties": false,
"description": "Loop in which all iterations are called simultaneously.",
"properties": {
"range": {
"$ref": "#/properties/run/properties/serialLoop/properties/range"
},
"run": {
"description": "What gets run on each iteration of the loop",
"$ref": "#/properties/run"
},
"vars": {
"$ref": "#/properties/run/properties/serialLoop/properties/vars"
}
},
"required": ["range", "run"],
"type": "object"
},
"serial": {
"title": "serialCall",
"type": "array",
"items": {
"$ref": "#/properties/run"
}
},
"serialLoop": {
"additionalProperties": false,
"description": "Loop in which each iteration gets called sequentially.",
"oneOf": [
{
"required": ["range", "run"]
},
{
"required": ["until", "run"]
}
],
"properties": {
"range": {
"description": "Range of the loop, i.e. the value to loop over",
"type": ["array", "object", "string"]
},
"run": {
"description": "What gets run on each iteration of the loop",
"$ref": "#/properties/run"
},
"until": {
"description": "Exit condition of the loop; evaluated before each iteration.",
"type": "array",
"items": {
"$ref": "#/properties/run/properties/if/items"
}
},
"vars": {
"additionalProperties": false,
"description": "Variables added to scope on each iteration",
"properties": {
"index": {
"description": "Variable each iterations associated index will be made available through",
"$ref": "#/properties/run/properties/serialLoop/properties/vars/properties/key"
},
"key": {
"description": "Variable each iterations associated key will be made available through",
"type": "string",
"pattern": "^[-_.a-zA-Z0-9]+$"
},
"value": {
"description": "Variable each iterations associated value will be made available through",
"$ref": "#/properties/run/properties/serialLoop/properties/vars/properties/key"
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "call"
},
"version": {
"description": "Version of the op",
"$ref": "#/properties/opspec"
},
"opspec": {
"description": "Version of [opspec](https://opspec.io) used by the op",
"title": "semVer",
"type": "string",
"pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:(-[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-\\-\\.]+)?$"
}
},
"required": ["name"],
"title": "Op File"
}
|
strmprivacy.api.entities.v1.DataContract.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract",
"definitions": {
"strmprivacy.api.entities.v1.SchemaType": {
"enum": [
"SCHEMA_TYPE_UNSPECIFIED",
0,
"AVRO",
1,
"JSONSCHEMA",
2
],
"markdownEnumDescriptions": [
"(or 0) ",
"(or \"SCHEMA_TYPE_UNSPECIFIED\") ",
"(or 1) ",
"(or \"AVRO\") ",
"(or 2) ",
"(or \"JSONSCHEMA\") "
]
},
"strmprivacy.api.entities.v1.Schema.State": {
"enum": [
"STATE_UNSPECIFIED",
0,
"DRAFT",
1,
"ACTIVE",
2,
"ARCHIVED",
3,
"IN_REVIEW",
4,
"INCOMPLETE",
5,
"APPROVED",
6
],
"markdownEnumDescriptions": [
"(or 0) ",
"(or \"STATE_UNSPECIFIED\") ",
"(or 1) This schema is valid and complete, but has not been accepted yet, can still be modified and also deleted.",
"(or \"DRAFT\") This schema is valid and complete, but has not been accepted yet, can still be modified and also deleted.",
"(or 2) This schema is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.",
"(or \"ACTIVE\") This schema is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.",
"(or 3) This schema is valid and complete has been active, but no more events can be sent using this schema. In-flight events are still processed.",
"(or \"ARCHIVED\") This schema is valid and complete has been active, but no more events can be sent using this schema. In-flight events are still processed.",
"(or 4) This schema is in review. It can be used once it has been approved.",
"(or \"IN_REVIEW\") This schema is in review. It can be used once it has been approved.",
"(or 5) This schema is still under construction.",
"(or \"INCOMPLETE\") This schema is still under construction.",
"(or 6) This schema is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.",
"(or \"APPROVED\") This schema is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted."
]
},
"strmprivacy.api.entities.v1.DataContract.State": {
"enum": [
"STATE_UNSPECIFIED",
0,
"DRAFT",
1,
"IN_REVIEW",
2,
"ACTIVE",
3,
"ARCHIVED",
4,
"INCOMPLETE",
5,
"APPROVED",
6
],
"markdownEnumDescriptions": [
"(or 0) ",
"(or \"STATE_UNSPECIFIED\") ",
"(or 1) This data contract is valid and complete, but has not been accepted yet, can still be modified and also deleted.",
"(or \"DRAFT\") This data contract is valid and complete, but has not been accepted yet, can still be modified and also deleted.",
"(or 2) This data contract is in review. It can be used once it has been approved.",
"(or \"IN_REVIEW\") This data contract is in review. It can be used once it has been approved.",
"(or 3) This data contract is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.",
"(or \"ACTIVE\") This data contract is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.",
"(or 4) This data contract is valid and complete has been active, but no more events can be sent using this data contract. In-flight events are still processed.",
"(or \"ARCHIVED\") This data contract is valid and complete has been active, but no more events can be sent using this data contract. In-flight events are still processed.",
"(or 5) This data contract is still under construction.",
"(or \"INCOMPLETE\") This data contract is still under construction.",
"(or 6) This data contract is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.",
"(or \"APPROVED\") This data contract is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted."
]
},
"strmprivacy.api.entities.v1.Validation": {
"type": "object",
"properties": {
"field": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Validation/definitions/field"
},
"type": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Validation/definitions/type"
},
"value": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Validation/definitions/value"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"field": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string field = 1;",
"description": "constraint: valid field path, follows avro constraints + slashes",
"default": ""
},
"type": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string type = 2;",
"description": "constraint: one of the validator types. handled by code\nThis should become an enum",
"default": ""
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string value = 3;",
"description": "constraint: a type specific definition",
"default": ""
}
}
},
"strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig.NullHandlingType": {
"enum": [
"NULL_HANDLING_TYPE_UNSPECIFIED",
0,
"DROP_RECORD",
1,
"DEFAULT_VALUE",
2
],
"markdownEnumDescriptions": [
"(or 0) ",
"(or \"NULL_HANDLING_TYPE_UNSPECIFIED\") ",
"(or 1) ",
"(or \"DROP_RECORD\") ",
"(or 2) ",
"(or \"DEFAULT_VALUE\") "
]
},
"google.protobuf.Timestamp": {
"type": "string",
"format": "date-time",
"default": ""
},
"strmprivacy.api.entities.v1.SchemaMetadata": {
"type": "object",
"properties": {
"createTime": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/create_time"
},
"description": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/description"
},
"domains": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/domains"
},
"iconUri": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/icon_uri"
},
"industries": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/industries"
},
"labels": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/labels"
},
"title": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/title"
}
},
"patternProperties": {
"^create_time$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/create_time"
},
"^icon_uri$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata/definitions/icon_uri"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"create_time": {
"oneOf": [
{
"$ref": "#/definitions/google.protobuf.Timestamp"
},
{
"type": "null"
}
],
"title": "google.protobuf.Timestamp create_time = 3;",
"description": "The timestamp when this Schema was created."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string description = 2;",
"description": "The description of this Schema. Used in the Portal. Markdown syntax is supported. This field can be modified.",
"default": ""
},
"domains": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"title": "string"
}
},
{
"type": "null"
}
],
"title": "repeated string domains = 6;",
"default": null
},
"icon_uri": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string icon_uri = 4;",
"description": "The URI to the icon used with this Schema. This always an absolute URI, with the https scheme. Used in the Portal.",
"default": ""
},
"industries": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"title": "string"
}
},
{
"type": "null"
}
],
"title": "repeated string industries = 7;",
"default": null
},
"labels": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Label",
"title": "strmprivacy.api.entities.v1.Label",
"default": {
}
}
},
{
"type": "null"
}
],
"title": "repeated strmprivacy.api.entities.v1.Label labels = 5;",
"description": "Generic (key/value) labels for this Schema.",
"default": [
{
}
]
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string title = 1;",
"description": "The human readable title of this Schema. Used in the Portal. Defaults to the Schema name. This field can be modified.",
"default": ""
}
}
},
"strmprivacy.api.entities.v1.DataContractMetadata": {
"type": "object",
"properties": {
"createTime": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/create_time"
},
"description": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/description"
},
"domains": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/domains"
},
"industries": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/industries"
},
"labels": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/labels"
},
"title": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/title"
}
},
"patternProperties": {
"^create_time$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata/definitions/create_time"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"create_time": {
"oneOf": [
{
"$ref": "#/definitions/google.protobuf.Timestamp"
},
{
"type": "null"
}
],
"title": "google.protobuf.Timestamp create_time = 3;",
"description": "The timestamp when this Data Contract was created."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string description = 2;",
"description": "The description of this Data Contract. Used in the Portal. Markdown syntax is supported. This field can be modified.",
"default": ""
},
"domains": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"title": "string"
}
},
{
"type": "null"
}
],
"title": "repeated string domains = 6;",
"default": null
},
"industries": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"title": "string"
}
},
{
"type": "null"
}
],
"title": "repeated string industries = 7;",
"default": null
},
"labels": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Label",
"title": "strmprivacy.api.entities.v1.Label",
"default": {
}
}
},
{
"type": "null"
}
],
"title": "repeated strmprivacy.api.entities.v1.Label labels = 5;",
"description": "Generic (key/value) labels for this Data Contract.",
"default": [
{
}
]
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string title = 1;",
"description": "The human readable title of this Data Contract. Used in the Portal. Defaults to the Data Contract name if left unspecified. This field can be modified.",
"default": ""
}
}
},
"strmprivacy.api.entities.v1.FieldMetadata": {
"type": "object",
"properties": {
"fieldName": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/field_name"
},
"nullHandlingConfig": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/null_handling_config"
},
"ordinalValues": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/ordinal_values"
},
"personalDataConfig": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/personal_data_config"
},
"statisticalDataType": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/statistical_data_type"
}
},
"patternProperties": {
"^field_name$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/field_name"
},
"^null_handling_config$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/null_handling_config"
},
"^ordinal_values$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/ordinal_values"
},
"^personal_data_config$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/personal_data_config"
},
"^statistical_data_type$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata/definitions/statistical_data_type"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"field_name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string field_name = 1;",
"description": "Full reference to a (nested) field. For non-top-level fields (i.e. nested fields), each level should be separated by a forward slash. E.g. customer/id.",
"default": ""
},
"null_handling_config": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig null_handling_config = 5;",
"description": "How null values should generally be dealt with for a field.",
"default": {
}
},
"ordinal_values": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"title": "string"
}
},
{
"type": "null"
}
],
"title": "repeated string ordinal_values = 4;",
"description": "If a field is of ordinal values, defines the possible values and their order.",
"default": null
},
"personal_data_config": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig personal_data_config = 2;",
"description": "Metadata on the type of personal data this field may contain.",
"default": {
}
},
"statistical_data_type": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.StatisticalDataType"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.StatisticalDataType statistical_data_type = 3;",
"description": "The statistical data type of the field, e.g. nominal, ordinal, numerical.",
"default": "STATISTICAL_DATA_TYPE_UNSPECIFIED"
}
}
},
"strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig": {
"type": "object",
"properties": {
"defaultValue": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig/definitions/default_value"
},
"type": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig/definitions/type"
}
},
"patternProperties": {
"^default_value$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig/definitions/default_value"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"default_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string default_value = 2;",
"description": "If the type is DEFAULT_VALUE, the desired default value must be specified.",
"default": ""
},
"type": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig.NullHandlingType"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig.NullHandlingType type = 1;",
"default": "NULL_HANDLING_TYPE_UNSPECIFIED"
}
}
},
"strmprivacy.api.entities.v1.SimpleSchemaNode": {
"type": "object",
"properties": {
"avroName": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/avro_name"
},
"doc": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/doc"
},
"name": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/name"
},
"nodes": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/nodes"
},
"repeated": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/repeated"
},
"required": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/required"
},
"type": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/type"
}
},
"patternProperties": {
"^avro_name$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode/definitions/avro_name"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"avro_name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string avro_name = 7;",
"description": "avro compatible name set by creator OR derived from name",
"default": ""
},
"doc": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string doc = 6;",
"description": "constraints:\nsize < 5000",
"default": ""
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string name = 2;",
"description": "constraints: same as SimpleSchemaDefinition",
"default": ""
},
"nodes": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode",
"title": "strmprivacy.api.entities.v1.SimpleSchemaNode",
"default": {
}
}
},
{
"type": "null"
}
],
"title": "repeated strmprivacy.api.entities.v1.SimpleSchemaNode nodes = 5;",
"default": [
{
}
]
},
"repeated": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "bool repeated = 3;",
"default": false
},
"required": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "bool required = 4;",
"default": false
},
"type": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNodeType"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.SimpleSchemaNodeType type = 1;",
"default": "SIMPLE_SCHEMA_NODE_TYPE_UNSPECIFIED"
}
}
},
"strmprivacy.api.entities.v1.Schema": {
"type": "object",
"properties": {
"definition": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/definition"
},
"fingerprint": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/fingerprint"
},
"id": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/id"
},
"isPublic": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/is_public"
},
"metadata": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/metadata"
},
"ref": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/ref"
},
"simpleSchema": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/simple_schema"
},
"state": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/state"
}
},
"patternProperties": {
"^is_public$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/is_public"
},
"^simple_schema$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema/definitions/simple_schema"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"definition": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string definition = 4;",
"description": "constraints: is no longer required provided simple_schema is not empty.",
"default": ""
},
"fingerprint": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string fingerprint = 5;",
"default": ""
},
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string id = 8;",
"description": "The UUID of this schema",
"default": ""
},
"is_public": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "bool is_public = 3;",
"description": "(-- 'is' is intentional here (see https://google.aip.dev/140#booleans) --)",
"default": false
},
"metadata": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaMetadata"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.SchemaMetadata metadata = 6;",
"default": {
}
},
"ref": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaRef"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.SchemaRef ref = 1;",
"default": {
}
},
"simple_schema": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition simple_schema = 7;",
"default": {
}
},
"state": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.State"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.Schema.State state = 2;",
"default": "STATE_UNSPECIFIED"
}
}
},
"strmprivacy.api.entities.v1.SchemaRef": {
"type": "object",
"properties": {
"handle": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaRef/definitions/handle"
},
"name": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaRef/definitions/name"
},
"schemaType": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaRef/definitions/schema_type"
},
"version": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaRef/definitions/version"
}
},
"patternProperties": {
"^schema_type$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaRef/definitions/schema_type"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"handle": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string handle = 1;",
"description": "constraints: generic name constraint",
"default": ""
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string name = 2;",
"description": "constraints: generic name constraint",
"default": ""
},
"schema_type": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.SchemaType"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.SchemaType schema_type = 4;",
"default": "SCHEMA_TYPE_UNSPECIFIED"
},
"version": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string version = 3;",
"description": "constraints: `\\d+\\.\\d+\\.\\d+",
"default": ""
}
}
},
"strmprivacy.api.entities.v1.DataContractRef": {
"type": "object",
"properties": {
"handle": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractRef/definitions/handle"
},
"name": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractRef/definitions/name"
},
"version": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractRef/definitions/version"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"handle": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string handle = 1;",
"description": "constraint: handle should already exist",
"default": ""
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string name = 2;",
"description": "constraints: generic name constraint, unique within handle",
"default": ""
},
"version": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string version = 3;",
"description": "constraints: semantic version, e.g. 1.12.3",
"default": ""
}
}
},
"strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig": {
"type": "object",
"properties": {
"gdprSpecialPersonalDataType": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/gdpr_special_personal_data_type"
},
"isPii": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/is_pii"
},
"isQuasiId": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/is_quasi_id"
},
"purposeLevel": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/purpose_level"
}
},
"patternProperties": {
"^gdpr_special_personal_data_type$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/gdpr_special_personal_data_type"
},
"^is_pii$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/is_pii"
},
"^is_quasi_id$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/is_quasi_id"
},
"^purpose_level$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig/definitions/purpose_level"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"gdpr_special_personal_data_type": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string gdpr_special_personal_data_type = 4;",
"description": "The special sensitive data type as defined by the GDPR https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32016R0679#d1e2051-1-1",
"default": ""
},
"is_pii": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "bool is_pii = 1;",
"description": "Currently, only string fields or repeated string fields can be marked as PII, since other data types cannot store an encrypted string.",
"default": false
},
"is_quasi_id": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "bool is_quasi_id = 2;",
"description": "A quasi identifier doesn't identify an individual directly, but combined with other QIs can result in a unique (direct) identifier.",
"default": false
},
"purpose_level": {
"oneOf": [
{
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
{
"type": "null"
}
],
"title": "int32 purpose_level = 3;",
"description": "The purpose level as defined in the purpose level mapping of an organization.",
"default": 0
}
}
},
"strmprivacy.api.entities.v1.StatisticalDataType": {
"enum": [
"STATISTICAL_DATA_TYPE_UNSPECIFIED",
0,
"NOMINAL",
1,
"ORDINAL",
2,
"NUMERICAL",
3
],
"markdownEnumDescriptions": [
"(or 0) ",
"(or \"STATISTICAL_DATA_TYPE_UNSPECIFIED\") ",
"(or 1) ",
"(or \"NOMINAL\") ",
"(or 2) ",
"(or \"ORDINAL\") ",
"(or 3) ",
"(or \"NUMERICAL\") "
]
},
"strmprivacy.api.entities.v1.DataContract": {
"type": "object",
"properties": {
"keyField": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/key_field"
},
"state": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/state"
},
"piiFields": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/pii_fields"
},
"ref": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/ref"
},
"schema": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/schema"
},
"creatorExternalUserId": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/creator_external_user_id"
},
"id": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/id"
},
"metadata": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/metadata"
},
"fieldMetadata": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/field_metadata"
},
"dataSubjectField": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/data_subject_field"
},
"projectId": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/project_id"
},
"validations": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/validations"
},
"isPublic": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/is_public"
}
},
"patternProperties": {
"^creator_external_user_id$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/creator_external_user_id"
},
"^data_subject_field$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/data_subject_field"
},
"^field_metadata$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/field_metadata"
},
"^is_public$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/is_public"
},
"^key_field$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/key_field"
},
"^pii_fields$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/pii_fields"
},
"^project_id$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract/definitions/project_id"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"is_public": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "bool is_public = 4;",
"description": "(-- 'is' is intentional here (see https://google.aip.dev/140#booleans) --)",
"default": false
},
"project_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string project_id = 11;",
"default": ""
},
"state": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContract.State"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.DataContract.State state = 3;",
"default": "STATE_UNSPECIFIED"
},
"ref": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractRef"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.DataContractRef ref = 2;",
"default": {
}
},
"schema": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.Schema schema = 9;",
"default": {
}
},
"field_metadata": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.FieldMetadata",
"title": "strmprivacy.api.entities.v1.FieldMetadata",
"default": {
}
}
},
{
"type": "null"
}
],
"title": "repeated strmprivacy.api.entities.v1.FieldMetadata field_metadata = 12;",
"default": [
{
}
]
},
"creator_external_user_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string creator_external_user_id = 13;",
"default": ""
},
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string id = 1;",
"default": ""
},
"metadata": {
"oneOf": [
{
"$ref": "#/definitions/strmprivacy.api.entities.v1.DataContractMetadata"
},
{
"type": "null"
}
],
"title": "strmprivacy.api.entities.v1.DataContractMetadata metadata = 8;",
"default": {
}
},
"data_subject_field": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string data_subject_field = 10;",
"default": ""
},
"pii_fields": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
{
"type": "null"
}
],
"title": "int32",
"default": 0
}
},
{
"type": "null"
}
],
"title": "map<string, int32> pii_fields = 6;",
"description": "PII Fields as a map, where the key is the field path (i.e. producerSessionId or customer/id) and the\n value is the purpose level, provided as an integer",
"default": {
},
"deprecationMessage": "Field \"pii_fields\" is marked as deprecated"
},
"validations": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Validation",
"title": "strmprivacy.api.entities.v1.Validation",
"default": {
}
}
},
{
"type": "null"
}
],
"title": "repeated strmprivacy.api.entities.v1.Validation validations = 7;",
"default": [
{
}
]
},
"key_field": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string key_field = 5;",
"default": ""
}
}
},
"strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition": {
"type": "object",
"properties": {
"avroName": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition/definitions/avro_name"
},
"doc": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition/definitions/doc"
},
"name": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition/definitions/name"
},
"namespace": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition/definitions/namespace"
},
"nodes": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition/definitions/nodes"
}
},
"patternProperties": {
"^avro_name$": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition/definitions/avro_name"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"avro_name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string avro_name = 5;",
"description": "avro compatible name set by creator OR derived from name (thus ignore_empty = true)",
"default": ""
},
"doc": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string doc = 3;",
"default": ""
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string name = 1;",
"description": "constraints: printable characters",
"default": ""
},
"namespace": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string namespace = 2;",
"description": "constraints:\ndot separated sequence of name constraints\nmust be Avro compatible. When absent becomes <handle>.<name>.v<version>",
"default": ""
},
"nodes": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.SimpleSchemaNode",
"title": "strmprivacy.api.entities.v1.SimpleSchemaNode",
"default": {
}
}
},
{
"type": "null"
}
],
"title": "repeated strmprivacy.api.entities.v1.SimpleSchemaNode nodes = 4;",
"default": [
{
}
]
}
},
"description": "constraints: overall size < 100000 TBD"
},
"strmprivacy.api.entities.v1.SimpleSchemaNodeType": {
"enum": [
"SIMPLE_SCHEMA_NODE_TYPE_UNSPECIFIED",
0,
"STRING",
1,
"BOOLEAN",
2,
"FLOAT",
3,
"INTEGER",
4,
"LONG",
5,
"NODE",
10
],
"markdownEnumDescriptions": [
"(or 0) ",
"(or \"SIMPLE_SCHEMA_NODE_TYPE_UNSPECIFIED\") ",
"(or 1) ",
"(or \"STRING\") ",
"(or 2) ",
"(or \"BOOLEAN\") ",
"(or 3) ",
"(or \"FLOAT\") ",
"(or 4) ",
"(or \"INTEGER\") ",
"(or 5) ",
"(or \"LONG\") ",
"(or 10) ",
"(or \"NODE\") "
]
},
"strmprivacy.api.entities.v1.Label": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Label/definitions/key"
},
"value": {
"$ref": "#/definitions/strmprivacy.api.entities.v1.Label/definitions/value"
}
},
"additionalProperties": {
"title": "Unknown field"
},
"definitions": {
"key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string key = 1;",
"description": "The key of the label.",
"default": ""
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "string value = 2;",
"description": "The value of the label. An empty string means there is no value.",
"default": ""
}
}
}
},
"title": "strmprivacy.api.entities.v1.DataContract"
} |
traefik-v2.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://json.schemastore.org/traefik-v2.json",
"properties": {
"accessLog": {
"type": "object",
"properties": {
"filePath": {
"type": "string"
},
"format": {
"type": "string"
},
"filters": {
"type": "object",
"properties": {
"statusCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"retryAttempts": {
"type": "boolean"
},
"minDuration": {
"type": "string"
}
}
},
"fields": {
"type": "object",
"properties": {
"defaultMode": {
"type": "string"
},
"names": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "string"
}
}
},
"headers": {
"type": "object",
"properties": {
"defaultMode": {
"type": "string"
},
"names": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "string"
}
}
}
}
}
}
},
"bufferingSize": {
"type": "integer"
}
},
"additionalProperties": false
},
"api": {
"type": "object",
"properties": {
"insecure": {
"type": "boolean"
},
"dashboard": {
"type": "boolean"
},
"debug": {
"type": "boolean"
}
},
"additionalProperties": false
},
"certificatesResolvers": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "object",
"properties": {
"acme": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"caServer": {
"type": "string"
},
"certificatesDuration": {
"type": "integer"
},
"preferredChain": {
"type": "string"
},
"storage": {
"type": "string"
},
"keyType": {
"type": "string"
},
"eab": {
"type": "object",
"properties": {
"kid": {
"type": "string"
},
"hmacEncoded": {
"type": "string"
}
}
},
"dnsChallenge": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"delayBeforeCheck": {
"type": "string"
},
"resolvers": {
"type": "array",
"items": {
"type": "string"
}
},
"disablePropagationCheck": {
"type": "boolean"
}
}
},
"httpChallenge": {
"type": "object",
"properties": {
"entryPoint": {
"type": "string"
}
}
},
"tlsChallenge": {
"type": "object"
}
}
}
},
"additionalProperties": false
}
}
},
"entryPoints": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"transport": {
"type": "object",
"properties": {
"lifeCycle": {
"type": "object",
"properties": {
"requestAcceptGraceTimeout": {
"type": "string"
},
"graceTimeOut": {
"type": "string"
}
}
},
"respondingTimeouts": {
"type": "object",
"properties": {
"readTimeout": {
"type": "string"
},
"writeTimeout": {
"type": "string"
},
"idleTimeout": {
"type": "string"
}
}
}
}
},
"proxyProtocol": {
"type": "object",
"properties": {
"insecure": {
"type": "boolean"
},
"trustedIPs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"forwardedHeaders": {
"type": "object",
"properties": {
"insecure": {
"type": "boolean"
},
"trustedIPs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"http": {
"type": "object",
"properties": {
"redirections": {
"type": "object",
"properties": {
"entryPoint": {
"type": "object",
"properties": {
"to": {
"type": "string"
},
"scheme": {
"type": "string"
},
"permanent": {
"type": "boolean"
},
"priority": {
"type": "integer"
}
}
}
}
},
"middlewares": {
"type": "array",
"items": {
"type": "string"
}
},
"tls": {
"type": "object",
"properties": {
"options": {
"type": "string"
},
"certResolver": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"main": {
"type": "string"
},
"sans": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
},
"http2": {
"type": "object",
"properties": {
"maxConcurrentStreams": {
"type": "integer"
}
}
},
"http3": {
"type": "object",
"properties": {
"advertisedPort": {
"type": "integer"
}
}
},
"udp": {
"type": "object",
"properties": {
"timeout": {
"type": "string"
}
}
}
},
"additionalProperties": false
}
}
},
"experimental": {
"type": "object",
"properties": {
"kubernetesGateway": {
"type": "boolean"
},
"http3": {
"type": "boolean"
},
"hub": {
"type": "boolean"
},
"plugins": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "object",
"properties": {
"moduleName": {
"type": "string"
},
"version": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"localPlugins": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "object",
"properties": {
"moduleName": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"additionalProperties": false
},
"global": {
"type": "object",
"properties": {
"checkNewVersion": {
"type": "boolean"
},
"sendAnonymousUsage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"hostResolver": {
"type": "object",
"properties": {
"cnameFlattening": {
"type": "boolean"
},
"resolvConfig": {
"type": "string"
},
"resolvDepth": {
"type": "integer"
}
},
"additionalProperties": false
},
"hub": {
"type": "object",
"properties": {
"tls": {
"type": "object",
"properties": {
"insecure": {
"type": "boolean"
},
"ca": {
"type": "string"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
}
}
}
},
"additionalProperties": false
},
"log": {
"type": "object",
"properties": {
"level": {
"type": "string"
},
"filePath": {
"type": "string"
},
"format": {
"type": "string"
}
},
"additionalProperties": false
},
"metrics": {
"type": "object",
"properties": {
"prometheus": {
"type": "object",
"properties": {
"buckets": {
"type": "array",
"items": {
"type": "number"
}
},
"addEntryPointsLabels": {
"type": "boolean"
},
"addRoutersLabels": {
"type": "boolean"
},
"addServicesLabels": {
"type": "boolean"
},
"entryPoint": {
"type": "string"
},
"manualRouting": {
"type": "boolean"
}
},
"additionalProperties": false
},
"datadog": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"pushInterval": {
"type": "string"
},
"addEntryPointsLabels": {
"type": "boolean"
},
"addRoutersLabels": {
"type": "boolean"
},
"addServicesLabels": {
"type": "boolean"
},
"prefix": {
"type": "string"
}
},
"additionalProperties": false
},
"statsD": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"pushInterval": {
"type": "string"
},
"addEntryPointsLabels": {
"type": "boolean"
},
"addRoutersLabels": {
"type": "boolean"
},
"addServicesLabels": {
"type": "boolean"
},
"prefix": {
"type": "string"
}
},
"additionalProperties": false
},
"influxDB": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"protocol": {
"type": "string"
},
"pushInterval": {
"type": "string"
},
"database": {
"type": "string"
},
"retentionPolicy": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"addEntryPointsLabels": {
"type": "boolean"
},
"addRoutersLabels": {
"type": "boolean"
},
"addServicesLabels": {
"type": "boolean"
},
"additionalLabels": {
"type": "object"
}
},
"additionalProperties": false
},
"influxDB2": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"token": {
"type": "string"
},
"pushInterval": {
"type": "string"
},
"org": {
"type": "string"
},
"bucket": {
"type": "string"
},
"addEntryPointsLabels": {
"type": "boolean"
},
"addRoutersLabels": {
"type": "boolean"
},
"addServicesLabels": {
"type": "boolean"
},
"additionalLabels": {
"type": "object"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"pilot": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"dashboard": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ping": {
"type": "object",
"properties": {
"entryPoint": {
"type": "string"
},
"manualRouting": {
"type": "boolean"
},
"terminatingStatusCode": {
"type": "integer"
}
},
"additionalProperties": false
},
"providers": {
"type": "object",
"properties": {
"providersThrottleDuration": {
"type": "string"
},
"docker": {
"type": "object",
"properties": {
"allowEmptyServices": {
"type": "boolean"
},
"constraints": {
"type": "string"
},
"defaultRule": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"exposedByDefault": {
"type": "boolean"
},
"httpClientTimeout": {
"type": "string"
},
"network": {
"type": "string"
},
"swarmMode": {
"type": "boolean"
},
"swarmModeRefreshSeconds": {
"type": "string"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
},
"useBindPortIP": {
"type": "boolean"
},
"watch": {
"type": "boolean"
}
},
"additionalProperties": false
},
"file": {
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"watch": {
"type": "boolean"
},
"filename": {
"type": "string"
},
"debugLogGeneratedTemplate": {
"type": "boolean"
}
},
"additionalProperties": false
},
"marathon": {
"type": "object",
"properties": {
"constraints": {
"type": "string"
},
"trace": {
"type": "boolean"
},
"watch": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"defaultRule": {
"type": "string"
},
"exposedByDefault": {
"type": "boolean"
},
"dcosToken": {
"type": "string"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
},
"dialerTimeout": {
"type": "string"
},
"responseHeaderTimeout": {
"type": "string"
},
"tlsHandshakeTimeout": {
"type": "string"
},
"keepAlive": {
"type": "string"
},
"forceTaskHostname": {
"type": "boolean"
},
"basic": {
"type": "object",
"properties": {
"httpBasicAuthUser": {
"type": "string"
},
"httpBasicPassword": {
"type": "string"
}
},
"additionalProperties": false
},
"respectReadinessChecks": {
"type": "boolean"
}
},
"additionalProperties": false
},
"kubernetesIngress": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"token": {
"type": "string"
},
"certAuthFilePath": {
"type": "string"
},
"namespaces": {
"type": "array",
"items": {
"type": "string"
}
},
"labelSelector": {
"type": "string"
},
"ingressClass": {
"type": "string"
},
"throttleDuration": {
"type": "string"
},
"allowEmptyServices": {
"type": "boolean"
},
"allowExternalNameServices": {
"type": "boolean"
},
"ingressEndpoint": {
"type": "object",
"properties": {
"ip": {
"type": "string"
},
"hostname": {
"type": "string"
},
"publishedService": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"kubernetesCRD": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"token": {
"type": "string"
},
"certAuthFilePath": {
"type": "string"
},
"namespaces": {
"type": "array",
"items": {
"type": "string"
}
},
"allowCrossNamespace": {
"type": "boolean"
},
"allowExternalNameServices": {
"type": "boolean"
},
"labelSelector": {
"type": "string"
},
"ingressClass": {
"type": "string"
},
"throttleDuration": {
"type": "string"
},
"allowEmptyServices": {
"type": "boolean"
}
},
"additionalProperties": false
},
"kubernetesGateway": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"token": {
"type": "string"
},
"certAuthFilePath": {
"type": "string"
},
"namespaces": {
"type": "array",
"items": {
"type": "string"
}
},
"labelSelector": {
"type": "string"
},
"throttleDuration": {
"type": "string"
}
},
"additionalProperties": false
},
"rest": {
"type": "object",
"properties": {
"insecure": {
"type": "boolean"
}
},
"additionalProperties": false
},
"rancher": {
"type": "object",
"properties": {
"constraints": {
"type": "string"
},
"watch": {
"type": "boolean"
},
"defaultRule": {
"type": "string"
},
"exposedByDefault": {
"type": "boolean"
},
"enableServiceHealthFilter": {
"type": "boolean"
},
"refreshSeconds": {
"type": "integer"
},
"intervalPoll": {
"type": "boolean"
},
"prefix": {
"type": "string"
}
},
"additionalProperties": false
},
"consulCatalog": {
"type": "object",
"properties": {
"constraints": {
"type": "string"
},
"prefix": {
"type": "string"
},
"refreshInterval": {
"type": "string"
},
"requireConsistent": {
"type": "boolean"
},
"stale": {
"type": "boolean"
},
"cache": {
"type": "boolean"
},
"exposedByDefault": {
"type": "boolean"
},
"defaultRule": {
"type": "string"
},
"connectAware": {
"type": "boolean"
},
"connectByDefault": {
"type": "boolean"
},
"serviceName": {
"type": "string"
},
"namespace": {
"type": "string"
},
"namespaces": {
"type": "array",
"items": {
"type": "string"
}
},
"watch": {
"type": "boolean"
},
"endpoint": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"scheme": {
"type": "string"
},
"datacenter": {
"type": "string"
},
"token": {
"type": "string"
},
"endpointWaitTime": {
"type": "string"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
},
"httpAuth": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"nomad": {
"type": "object",
"properties": {
"constraints": {
"type": "string"
},
"prefix": {
"type": "string"
},
"refreshInterval": {
"type": "string"
},
"stale": {
"type": "boolean"
},
"exposedByDefault": {
"type": "boolean"
},
"defaultRule": {
"type": "string"
},
"namespace": {
"type": "string"
},
"endpoint": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"region": {
"type": "string"
},
"token": {
"type": "string"
},
"endpointWaitTime": {
"type": "string"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ecs": {
"type": "object",
"properties": {
"constraints": {
"type": "string"
},
"exposedByDefault": {
"type": "boolean"
},
"ecsAnywhere": {
"type": "boolean"
},
"refreshSeconds": {
"type": "integer"
},
"defaultRule": {
"type": "string"
},
"clusters": {
"type": "array",
"items": {
"type": "string"
}
},
"autoDiscoverClusters": {
"type": "boolean"
},
"region": {
"type": "string"
},
"accessKeyID": {
"type": "string"
},
"secretAccessKey": {
"type": "string"
}
},
"additionalProperties": false
},
"consul": {
"type": "object",
"properties": {
"rootKey": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"type": "string"
},
"namespace": {
"type": "string"
},
"namespaces": {
"type": "array",
"items": {
"type": "string"
}
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"etcd": {
"type": "object",
"properties": {
"rootKey": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"zooKeeper": {
"type": "object",
"properties": {
"rootKey": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"additionalProperties": false
},
"redis": {
"type": "object",
"properties": {
"rootKey": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"db": {
"type": "integer"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"http": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"pollInterval": {
"type": "string"
},
"pollTimeout": {
"type": "string"
},
"tls": {
"type": "object",
"properties": {
"ca": {
"type": "string"
},
"caOptional": {
"type": "boolean"
},
"cert": {
"type": "string"
},
"key": {
"type": "string"
},
"insecureSkipVerify": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"plugin": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "object"
}
}
}
}
},
"serversTransport": {
"type": "object",
"properties": {
"insecureSkipVerify": {
"type": "boolean"
},
"rootCAs": {
"type": "array",
"items": {
"type": "string"
}
},
"maxIdleConnsPerHost": {
"type": "integer"
},
"forwardingTimeouts": {
"type": "object",
"properties": {
"dialTimeout": {
"type": "string"
},
"responseHeaderTimeout": {
"type": "string"
},
"idleConnTimeout": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tracing": {
"type": "object",
"properties": {
"serviceName": {
"type": "string"
},
"spanNameLimit": {
"type": "integer"
},
"jaeger": {
"type": "object",
"properties": {
"samplingServerURL": {
"type": "string"
},
"samplingType": {
"type": "string"
},
"samplingParam": {
"type": "integer"
},
"localAgentHostPort": {
"type": "string"
},
"gen128Bit": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"traceContextHeaderName": {
"type": "string"
},
"disableAttemptReconnecting": {
"type": "boolean"
},
"collector": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"user": {
"type": "string"
},
"password": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"zipkin": {
"type": "object",
"properties": {
"httpEndpoint": {
"type": "string"
},
"sameSpan": {
"type": "boolean"
},
"id128Bit": {
"type": "boolean"
},
"sampleRate": {
"type": "integer"
}
},
"additionalProperties": false
},
"datadog": {
"type": "object",
"properties": {
"localAgentHostPort": {
"type": "string"
},
"globalTag": {
"type": "string"
},
"globalTags": {
"type": "object",
"description": "Sets a list of key:value tags on all spans.",
"patternProperties": {
"[a-zA-Z0-9-_]+": {
"type": "string"
}
}
},
"debug": {
"type": "boolean"
},
"prioritySampling": {
"type": "boolean"
},
"traceIDHeaderName": {
"type": "string"
},
"parentIDHeaderName": {
"type": "string"
},
"samplingPriorityHeaderName": {
"type": "string"
},
"bagagePrefixHeaderName": {
"type": "string"
}
},
"additionalProperties": false
},
"instana": {
"type": "object",
"properties": {
"localAgentHost": {
"type": "string"
},
"localAgentPort": {
"type": "integer"
},
"logLevel": {
"type": "string"
},
"enableAutoProfile": {
"type": "boolean"
}
},
"additionalProperties": false
},
"haystack": {
"type": "object",
"properties": {
"localAgentHost": {
"type": "string"
},
"localAgentPort": {
"type": "integer"
},
"globalTag": {
"type": "string"
},
"traceIDHeaderName": {
"type": "string"
},
"parentIDHeaderName": {
"type": "string"
},
"spanIDHeaderName": {
"type": "string"
},
"baggagePrefixHeaderName": {
"type": "string"
}
},
"additionalProperties": false
},
"elastic": {
"type": "object",
"properties": {
"serverURL": {
"type": "string"
},
"secretToken": {
"type": "string"
},
"serviceEnvironment": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"type": "object"
}
|
vega-lite.json | {
"$ref": "#/definitions/TopLevelExtendedSpec",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"Aggregate": {
"anyOf": [
{
"$ref": "#/definitions/AggregateOp"
}
]
},
"AggregateOp": {
"enum": [
"argmax",
"argmin",
"average",
"count",
"distinct",
"max",
"mean",
"median",
"min",
"missing",
"q1",
"q3",
"ci0",
"ci1",
"stdev",
"stdevp",
"sum",
"valid",
"values",
"variance",
"variancep"
],
"type": "string"
},
"AggregateTransform": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "Array of objects that define fields to aggregate.",
"items": {
"$ref": "#/definitions/AggregatedFieldDef"
},
"type": "array"
},
"groupby": {
"description": "The data fields to group by. If not specified, a single group containing all data objects will be used.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": ["aggregate"],
"type": "object"
},
"AggregatedFieldDef": {
"additionalProperties": false,
"properties": {
"as": {
"description": "The output field names to use for each aggregated field.",
"type": "string"
},
"field": {
"description": "The data field for which to compute aggregate function.",
"type": "string"
},
"op": {
"$ref": "#/definitions/AggregateOp",
"description": "The aggregation operations to apply to the fields, such as sum, average or count.\nSee the [full list of supported aggregation operations](https://vega.github.io/vega-lite/docs/aggregate.html#supported-aggregation-operations)\nfor more information."
}
},
"required": ["op", "field", "as"],
"type": "object"
},
"Anchor": {
"enum": ["start", "middle", "end"],
"type": "string"
},
"AnyMark": {
"anyOf": [
{
"$ref": "#/definitions/Mark"
},
{
"$ref": "#/definitions/MarkDef"
}
]
},
"AutoSizeParams": {
"additionalProperties": false,
"properties": {
"contains": {
"description": "Determines how size calculation should be performed, one of `\"content\"` or `\"padding\"`. The default setting (`\"content\"`) interprets the width and height settings as the data rectangle (plotting) dimensions, to which padding is then added. In contrast, the `\"padding\"` setting includes the padding within the view size calculations, such that the width and height settings indicate the **total** intended size of the view.\n\n__Default value__: `\"content\"`",
"enum": ["content", "padding"],
"type": "string"
},
"resize": {
"description": "A boolean flag indicating if autosize layout should be re-calculated on every view update.\n\n__Default value__: `false`",
"type": "boolean"
},
"type": {
"$ref": "#/definitions/AutosizeType",
"description": "The sizing format type. One of `\"pad\"`, `\"fit\"` or `\"none\"`. See the [autosize type](https://vega.github.io/vega-lite/docs/size.html#autosize) documentation for descriptions of each.\n\n__Default value__: `\"pad\"`"
}
},
"type": "object"
},
"AutosizeType": {
"enum": ["pad", "fit", "none"],
"type": "string"
},
"Axis": {
"additionalProperties": false,
"properties": {
"domain": {
"description": "A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.\n\n__Default value:__ `true`",
"type": "boolean"
},
"format": {
"description": "The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.\n\nSee the [format documentation](format.html) for more information.\n\n__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.",
"type": "string"
},
"grid": {
"description": "A boolean flag indicating if grid lines should be included as part of the axis\n\n__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.",
"type": "boolean"
},
"labelAngle": {
"description": "The rotation angle of the axis labels.\n\n__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.",
"maximum": 360,
"minimum": -360,
"type": "number"
},
"labelBound": {
"description": "Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.\n\n__Default value:__ `false`.",
"type": ["boolean", "number"]
},
"labelFlush": {
"description": "Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.\n\n__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.",
"type": ["boolean", "number"]
},
"labelOverlap": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": ["parity"],
"type": "string"
},
{
"enum": ["greedy"],
"type": "string"
}
],
"description": "The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `\"parity\"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `\"greedy\"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).\n\n__Default value:__ `true` for non-nominal fields with non-log scales; `\"greedy\"` for log scales; otherwise `false`."
},
"labelPadding": {
"description": "The padding, in pixels, between axis and text labels.",
"type": "number"
},
"labels": {
"description": "A boolean flag indicating if labels should be included as part of the axis.\n\n__Default value:__ `true`.",
"type": "boolean"
},
"maxExtent": {
"description": "The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.\n\n__Default value:__ `undefined`.",
"type": "number"
},
"minExtent": {
"description": "The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.\n\n__Default value:__ `30` for y-axis; `undefined` for x-axis.",
"type": "number"
},
"offset": {
"description": "The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.\n\n__Default value:__ derived from the [axis config](config.html#facet-scale-config)'s `offset` (`0` by default)",
"type": "number"
},
"orient": {
"$ref": "#/definitions/AxisOrient",
"description": "The orientation of the axis. One of `\"top\"`, `\"bottom\"`, `\"left\"` or `\"right\"`. The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart).\n\n__Default value:__ `\"bottom\"` for x-axes and `\"left\"` for y-axes."
},
"position": {
"description": "The anchor position of the axis in pixels. For x-axis with top or bottom orientation, this sets the axis group x coordinate. For y-axis with left or right orientation, this sets the axis group y coordinate.\n\n__Default value__: `0`",
"type": "number"
},
"tickCount": {
"description": "A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are \"nice\" (multiples of 2, 5, 10) and lie within the underlying scale's range.",
"type": "number"
},
"tickSize": {
"description": "The size in pixels of axis ticks.",
"minimum": 0,
"type": "number"
},
"ticks": {
"description": "Boolean value that determines whether the axis should include ticks.",
"type": "boolean"
},
"title": {
"description": "A title for the field. If `null`, the title will be removed.\n\n__Default value:__ derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`). If the field has an aggregate function, the function is displayed as a part of the title (e.g., `\"Sum of Profit\"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `\"Profit (binned)\"`, `\"Transaction Date (year-month)\"`). Otherwise, the title is simply the field name.\n\n__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title).",
"type": ["string", "null"]
},
"titleMaxLength": {
"description": "Max length for axis title if the title is automatically generated from the field's description.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and axis.",
"type": "number"
},
"values": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"items": {
"$ref": "#/definitions/DateTime"
},
"type": "array"
}
],
"description": "Explicitly set the visible axis tick values."
},
"zindex": {
"description": "A non-positive integer indicating z-index of the axis.\nIf zindex is 0, axes should be drawn behind all chart elements.\nTo put them in front, use `\"zindex = 1\"`.\n\n__Default value:__ `1` (in front of the marks) for actual axis and `0` (behind the marks) for grids.",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"AxisConfig": {
"additionalProperties": false,
"properties": {
"bandPosition": {
"description": "An interpolation fraction indicating where, for `band` scales, axis ticks should be positioned. A value of `0` places ticks at the left edge of their bands. A value of `0.5` places ticks in the middle of their bands.",
"type": "number"
},
"domain": {
"description": "A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.\n\n__Default value:__ `true`",
"type": "boolean"
},
"domainColor": {
"description": "Color of axis domain line.\n\n__Default value:__ (none, using Vega default).",
"type": "string"
},
"domainWidth": {
"description": "Stroke width of axis domain line\n\n__Default value:__ (none, using Vega default).",
"type": "number"
},
"grid": {
"description": "A boolean flag indicating if grid lines should be included as part of the axis\n\n__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.",
"type": "boolean"
},
"gridColor": {
"description": "Color of gridlines.",
"type": "string"
},
"gridDash": {
"description": "The offset (in pixels) into which to begin drawing with the grid dash array.",
"items": {
"type": "number"
},
"type": "array"
},
"gridOpacity": {
"description": "The stroke opacity of grid (value between [0,1])\n\n__Default value:__ (`1` by default)",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"gridWidth": {
"description": "The grid width, in pixels.",
"minimum": 0,
"type": "number"
},
"labelAngle": {
"description": "The rotation angle of the axis labels.\n\n__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.",
"maximum": 360,
"minimum": -360,
"type": "number"
},
"labelBound": {
"description": "Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.\n\n__Default value:__ `false`.",
"type": ["boolean", "number"]
},
"labelColor": {
"description": "The color of the tick label, can be in hex color code or regular color name.",
"type": "string"
},
"labelFlush": {
"description": "Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.\n\n__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.",
"type": ["boolean", "number"]
},
"labelFont": {
"description": "The font of the tick label.",
"type": "string"
},
"labelFontSize": {
"description": "The font size of the label, in pixels.",
"minimum": 0,
"type": "number"
},
"labelLimit": {
"description": "Maximum allowed pixel width of axis tick labels.",
"type": "number"
},
"labelOverlap": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": ["parity"],
"type": "string"
},
{
"enum": ["greedy"],
"type": "string"
}
],
"description": "The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `\"parity\"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `\"greedy\"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).\n\n__Default value:__ `true` for non-nominal fields with non-log scales; `\"greedy\"` for log scales; otherwise `false`."
},
"labelPadding": {
"description": "The padding, in pixels, between axis and text labels.",
"type": "number"
},
"labels": {
"description": "A boolean flag indicating if labels should be included as part of the axis.\n\n__Default value:__ `true`.",
"type": "boolean"
},
"maxExtent": {
"description": "The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.\n\n__Default value:__ `undefined`.",
"type": "number"
},
"minExtent": {
"description": "The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.\n\n__Default value:__ `30` for y-axis; `undefined` for x-axis.",
"type": "number"
},
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.\n\n__Default value:__ `false`",
"type": "boolean"
},
"tickColor": {
"description": "The color of the axis's tick.",
"type": "string"
},
"tickRound": {
"description": "Boolean flag indicating if pixel position values should be rounded to the nearest integer.",
"type": "boolean"
},
"tickSize": {
"description": "The size in pixels of axis ticks.",
"minimum": 0,
"type": "number"
},
"tickWidth": {
"description": "The width, in pixels, of ticks.",
"minimum": 0,
"type": "number"
},
"ticks": {
"description": "Boolean value that determines whether the axis should include ticks.",
"type": "boolean"
},
"titleAlign": {
"description": "Horizontal text alignment of axis titles.",
"type": "string"
},
"titleAngle": {
"description": "Angle in degrees of axis titles.",
"type": "number"
},
"titleBaseline": {
"description": "Vertical text baseline for axis titles.",
"type": "string"
},
"titleColor": {
"description": "Color of the title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "Font of the title. (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"titleFontSize": {
"description": "Font size of the title.",
"minimum": 0,
"type": "number"
},
"titleFontWeight": {
"description": "Font weight of the title. (e.g., `\"bold\"`).",
"type": ["string", "number"]
},
"titleLimit": {
"description": "Maximum allowed pixel width of axis titles.",
"type": "number"
},
"titleMaxLength": {
"description": "Max length for axis title if the title is automatically generated from the field's description.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and axis.",
"type": "number"
},
"titleX": {
"description": "X-coordinate of the axis title relative to the axis group.",
"type": "number"
},
"titleY": {
"description": "Y-coordinate of the axis title relative to the axis group.",
"type": "number"
}
},
"type": "object"
},
"AxisConfigMixins": {
"additionalProperties": false,
"properties": {
"axis": {
"$ref": "#/definitions/AxisConfig",
"description": "Axis configuration, which determines default properties for all `x` and `y` [axes](axis.html). For a full list of axis configuration options, please see the [corresponding section of the axis documentation](axis.html#config)."
},
"axisBand": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for axes with \"band\" scales."
},
"axisBottom": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for x-axis along the bottom edge of the chart."
},
"axisLeft": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for y-axis along the left edge of the chart."
},
"axisRight": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for y-axis along the right edge of the chart."
},
"axisTop": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for x-axis along the top edge of the chart."
},
"axisX": {
"$ref": "#/definitions/VgAxisConfig",
"description": "X-axis specific config."
},
"axisY": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Y-axis specific config."
}
},
"type": "object"
},
"AxisOrient": {
"enum": ["top", "right", "left", "bottom"],
"type": "string"
},
"AxisResolveMap": {
"additionalProperties": false,
"properties": {
"x": {
"$ref": "#/definitions/ResolveMode"
},
"y": {
"$ref": "#/definitions/ResolveMode"
}
},
"type": "object"
},
"BarConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"binSpacing": {
"description": "Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).\n\n__Default value:__ `1`",
"minimum": 0,
"type": "number"
},
"color": {
"description": "Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "string"
},
"continuousBandSize": {
"description": "The default size of the bars on continuous scales.\n\n__Default value:__ `5`",
"minimum": 0,
"type": "number"
},
"discreteBandSize": {
"description": "The size of the bars. If unspecified, the default size is `bandSize-1`,\nwhich provides 1 pixel offset between bars.",
"minimum": 0,
"type": "number"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `true` for all marks except `point` and `false` for `point`.\n\n__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "The pixel area each the point/circle/square.\nFor example: in the case of circles, the radius is determined in part by the square root of the size value.\n\n__Default value:__ `30`",
"minimum": 0,
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
}
},
"type": "object"
},
"BaseBin": {
"additionalProperties": false,
"properties": {
"base": {
"description": "The number base to use for automatic bin determination (default is base 10).\n\n__Default value:__ `10`",
"type": "number"
},
"divide": {
"description": "Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.\n\n__Default value:__ `[5, 2]`",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
},
"maxbins": {
"description": "Maximum number of bins.\n\n__Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels",
"minimum": 2,
"type": "number"
},
"minstep": {
"description": "A minimum allowable step size (particularly useful for integer values).",
"type": "number"
},
"nice": {
"description": "If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.",
"type": "boolean"
},
"step": {
"description": "An exact step size to use between bins.\n\n__Note:__ If provided, options such as maxbins will be ignored.",
"type": "number"
},
"steps": {
"description": "An array of allowable step sizes to choose from.",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"BaseSelectionDef": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
}
},
"type": "object"
},
"BaseSpec": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"type": "object"
},
"BinParams": {
"additionalProperties": false,
"description": "Binning properties or boolean flag for determining whether to bin data or not.",
"properties": {
"base": {
"description": "The number base to use for automatic bin determination (default is base 10).\n\n__Default value:__ `10`",
"type": "number"
},
"divide": {
"description": "Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.\n\n__Default value:__ `[5, 2]`",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
},
"extent": {
"description": "A two-element (`[min, max]`) array indicating the range of desired bin values.",
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"maxbins": {
"description": "Maximum number of bins.\n\n__Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels",
"minimum": 2,
"type": "number"
},
"minstep": {
"description": "A minimum allowable step size (particularly useful for integer values).",
"type": "number"
},
"nice": {
"description": "If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.",
"type": "boolean"
},
"step": {
"description": "An exact step size to use between bins.\n\n__Note:__ If provided, options such as maxbins will be ignored.",
"type": "number"
},
"steps": {
"description": "An array of allowable step sizes to choose from.",
"items": {
"type": "number"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"BinTransform": {
"additionalProperties": false,
"properties": {
"as": {
"description": "The output fields at which to write the start and end bin values.",
"type": "string"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "An object indicating bin properties, or simply `true` for using default bin parameters."
},
"field": {
"description": "The data field to bin.",
"type": "string"
}
},
"required": ["bin", "field", "as"],
"type": "object"
},
"BoxPlotConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"color": {
"description": "Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "string"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `true` for all marks except `point` and `false` for `point`.\n\n__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "Size of the box and mid tick of a box plot ",
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
}
},
"type": "object"
},
"BoxPlotConfigMixins": {
"additionalProperties": false,
"properties": {
"box": {
"$ref": "#/definitions/BoxPlotConfig",
"description": "Box Config "
},
"boxMid": {
"$ref": "#/definitions/MarkConfig"
},
"boxWhisker": {
"$ref": "#/definitions/MarkConfig"
}
},
"type": "object"
},
"BrushConfig": {
"additionalProperties": false,
"properties": {
"fill": {
"description": "The fill color of the interval mark.\n\n__Default value:__ `#333333`",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity of the interval mark (a value between 0 and 1).\n\n__Default value:__ `0.125`",
"type": "number"
},
"stroke": {
"description": "The stroke color of the interval mark.\n\n__Default value:__ `#ffffff`",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke and space lengths,\nfor creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) with which to begin drawing the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity of the interval mark (a value between 0 and 1).",
"type": "number"
},
"strokeWidth": {
"description": "The stroke width of the interval mark.",
"type": "number"
}
},
"type": "object"
},
"CalculateTransform": {
"additionalProperties": false,
"properties": {
"as": {
"description": "The field for storing the computed formula value.",
"type": "string"
},
"calculate": {
"description": "A string containing a Vega Expression. Use the variable `datum` to refer to the current data object.",
"type": "string"
}
},
"required": ["calculate", "as"],
"type": "object"
},
"CompositeMarkConfigMixins": {
"$ref": "#/definitions/BoxPlotConfigMixins"
},
"CompositeUnitSpec": {
"$ref": "#/definitions/CompositeUnitSpecAlias",
"description": "Unit spec that can have a composite mark."
},
"Conditional<MarkPropFieldDef>": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"legend": {
"anyOf": [
{
"$ref": "#/definitions/Legend"
},
{
"type": "null"
}
],
"description": "An object defining properties of the legend.\nIf `null`, the legend for the encoding channel will be removed.\n\n__Default value:__ If undefined, default [legend properties](legend.html) are applied."
},
"scale": {
"$ref": "#/definitions/Scale",
"description": "An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.\n\n__Default value:__ If undefined, default [scale properties](scale.html) are applied."
},
"selection": {
"$ref": "#/definitions/SelectionOperand",
"description": "A [selection name](selection.html), or a series of [composed selections](selection.html#compose)."
},
"sort": {
"anyOf": [
{
"$ref": "#/definitions/SortOrder"
},
{
"$ref": "#/definitions/SortField"
},
{
"type": "null"
}
],
"description": "Sort order for the encoded field.\nSupported `sort` values include `\"ascending\"`, `\"descending\"` and `null` (no sorting).\nFor fields with discrete domains, `sort` can also be a [sort field definition object](sort.html#sort-field).\n\n__Default value:__ `\"ascending\"`"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["selection", "type"],
"type": "object"
},
"Conditional<TextFieldDef>": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"format": {
"description": "The [formatting pattern](format.html) for a text field. If not defined, this will be determined automatically.",
"type": "string"
},
"selection": {
"$ref": "#/definitions/SelectionOperand",
"description": "A [selection name](selection.html), or a series of [composed selections](selection.html#compose)."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["selection", "type"],
"type": "object"
},
"Conditional<ValueDef>": {
"additionalProperties": false,
"properties": {
"selection": {
"$ref": "#/definitions/SelectionOperand",
"description": "A [selection name](selection.html), or a series of [composed selections](selection.html#compose)."
},
"value": {
"description": "A constant value in visual domain (e.g., `\"red\"` / \"#0099ff\" for color, values between `0` to `1` for opacity).",
"type": ["number", "string", "boolean"]
}
},
"required": ["selection", "value"],
"type": "object"
},
"Config": {
"additionalProperties": false,
"properties": {
"area": {
"$ref": "#/definitions/MarkConfig",
"description": "Area-Specific Config "
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"axis": {
"$ref": "#/definitions/AxisConfig",
"description": "Axis configuration, which determines default properties for all `x` and `y` [axes](axis.html). For a full list of axis configuration options, please see the [corresponding section of the axis documentation](axis.html#config)."
},
"axisBand": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for axes with \"band\" scales."
},
"axisBottom": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for x-axis along the bottom edge of the chart."
},
"axisLeft": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for y-axis along the left edge of the chart."
},
"axisRight": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for y-axis along the right edge of the chart."
},
"axisTop": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Specific axis config for x-axis along the top edge of the chart."
},
"axisX": {
"$ref": "#/definitions/VgAxisConfig",
"description": "X-axis specific config."
},
"axisY": {
"$ref": "#/definitions/VgAxisConfig",
"description": "Y-axis specific config."
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"bar": {
"$ref": "#/definitions/BarConfig",
"description": "Bar-Specific Config "
},
"circle": {
"$ref": "#/definitions/MarkConfig",
"description": "Circle-Specific Config "
},
"countTitle": {
"description": "Default axis and legend title for count fields.\n\n__Default value:__ `'Number of Records'`.",
"type": "string"
},
"fieldTitle": {
"description": "Defines how Vega-Lite generates title for fields. There are three possible styles:\n- `\"verbal\"` (Default) - displays function in a verbal style (e.g., \"Sum of field\", \"Year-month of date\", \"field (binned)\").\n- `\"function\"` - displays function using parentheses and capitalized texts (e.g., \"SUM(field)\", \"YEARMONTH(date)\", \"BIN(field)\").\n- `\"plain\"` - displays only the field name without functions (e.g., \"field\", \"date\", \"field\").",
"enum": ["verbal", "functional", "plain"],
"type": "string"
},
"invalidValues": {
"description": "Defines how Vega-Lite should handle invalid values (`null` and `NaN`).\n- If set to `\"filter\"` (default), all data items with null values are filtered.\n- If `null`, all data items are included. In this case, invalid values will be interpreted as zeroes.",
"enum": ["filter"],
"type": "string"
},
"legend": {
"$ref": "#/definitions/LegendConfig",
"description": "Legend configuration, which determines default properties for all [legends](legend.html). For a full list of legend configuration options, please see the [corresponding section of in the legend documentation](legend.html#config)."
},
"line": {
"$ref": "#/definitions/MarkConfig",
"description": "Line-Specific Config "
},
"mark": {
"$ref": "#/definitions/MarkConfig",
"description": "Mark Config "
},
"numberFormat": {
"description": "D3 Number format for axis labels and text tables. For example \"s\" for SI units. Use [D3's number format pattern](https://github.com/d3/d3-format#locale_format).",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"point": {
"$ref": "#/definitions/MarkConfig",
"description": "Point-Specific Config "
},
"range": {
"$ref": "#/definitions/RangeConfig",
"description": "An object hash that defines default range arrays or schemes for using with scales.\nFor a full list of scale range configuration options, please see the [corresponding section of the scale documentation](scale.html#config)."
},
"rect": {
"$ref": "#/definitions/MarkConfig",
"description": "Rect-Specific Config "
},
"rule": {
"$ref": "#/definitions/MarkConfig",
"description": "Rule-Specific Config "
},
"scale": {
"$ref": "#/definitions/ScaleConfig",
"description": "Scale configuration determines default properties for all [scales](scale.html). For a full list of scale configuration options, please see the [corresponding section of the scale documentation](scale.html#config)."
},
"selection": {
"$ref": "#/definitions/SelectionConfig",
"description": "An object hash for defining default properties for each type of selections. "
},
"square": {
"$ref": "#/definitions/MarkConfig",
"description": "Square-Specific Config "
},
"stack": {
"$ref": "#/definitions/StackOffset",
"description": "Default stack offset for stackable mark. "
},
"style": {
"$ref": "#/definitions/StyleConfigIndex",
"description": "An object hash that defines key-value mappings to determine default properties for marks with a given [style](mark.html#mark-def). The keys represent styles names; the value are valid [mark configuration objects](mark.html#config). "
},
"text": {
"$ref": "#/definitions/TextConfig",
"description": "Text-Specific Config "
},
"tick": {
"$ref": "#/definitions/TickConfig",
"description": "Tick-Specific Config "
},
"timeFormat": {
"description": "Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use [D3's time format pattern](https://github.com/d3/d3-time-format#locale_format).\n\n__Default value:__ `'%b %d, %Y'`.",
"type": "string"
},
"title": {
"$ref": "#/definitions/VgTitleConfig",
"description": "Title configuration, which determines default properties for all [titles](title.html). For a full list of title configuration options, please see the [corresponding section of the title documentation](title.html#config)."
},
"view": {
"$ref": "#/definitions/ViewConfig",
"description": "Default properties for [single view plots](spec.html#single). "
}
},
"type": "object"
},
"CsvDataFormat": {
"additionalProperties": false,
"properties": {
"parse": {
"anyOf": [
{
"enum": ["auto"],
"type": "string"
},
{
"type": "object"
}
],
"description": "If set to auto (the default), perform automatic type inference to determine the desired data types.\nAlternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `\"number\"`, `\"boolean\"` or `\"date\"`).\nFor example, `\"parse\": {\"modified_on\": \"date\"}` parses the `modified_on` field in each input record a Date value.\n\nFor `\"date\"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).\nFor Specific date formats can be provided (e.g., `{foo: 'date:\"%m%d%Y\"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:\"%m%d%Y\"'}`). See more about [UTC time](timeunit.html#utc)"
},
"type": {
"description": "Type of input data: `\"json\"`, `\"csv\"`, `\"tsv\"`.\nThe default format type is determined by the extension of the file URL.\nIf no extension is detected, `\"json\"` will be used by default.",
"enum": ["csv", "tsv"],
"type": "string"
}
},
"type": "object"
},
"Data": {
"anyOf": [
{
"$ref": "#/definitions/UrlData"
},
{
"$ref": "#/definitions/InlineData"
},
{
"$ref": "#/definitions/NamedData"
}
]
},
"DataFormat": {
"anyOf": [
{
"$ref": "#/definitions/CsvDataFormat"
},
{
"$ref": "#/definitions/JsonDataFormat"
},
{
"$ref": "#/definitions/TopoDataFormat"
}
]
},
"DataFormatBase": {
"additionalProperties": false,
"properties": {
"parse": {
"anyOf": [
{
"enum": ["auto"],
"type": "string"
},
{
"type": "object"
}
],
"description": "If set to auto (the default), perform automatic type inference to determine the desired data types.\nAlternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `\"number\"`, `\"boolean\"` or `\"date\"`).\nFor example, `\"parse\": {\"modified_on\": \"date\"}` parses the `modified_on` field in each input record a Date value.\n\nFor `\"date\"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).\nFor Specific date formats can be provided (e.g., `{foo: 'date:\"%m%d%Y\"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:\"%m%d%Y\"'}`). See more about [UTC time](timeunit.html#utc)"
},
"type": {
"$ref": "#/definitions/DataFormatType",
"description": "Type of input data: `\"json\"`, `\"csv\"`, `\"tsv\"`.\nThe default format type is determined by the extension of the file URL.\nIf no extension is detected, `\"json\"` will be used by default."
}
},
"type": "object"
},
"DataFormatType": {
"enum": ["json", "csv", "tsv", "topojson"],
"type": "string"
},
"DateTime": {
"additionalProperties": false,
"description": "Object for defining datetime in Vega-Lite Filter.\nIf both month and quarter are provided, month has higher precedence.\n`day` cannot be combined with other date.\nWe accept string for month and day names.",
"properties": {
"date": {
"description": "Integer value representing the date from 1-31.",
"maximum": 31,
"minimum": 1,
"type": "number"
},
"day": {
"anyOf": [
{
"$ref": "#/definitions/Day"
},
{
"type": "string"
}
],
"description": "Value representing the day of a week. This can be one of: (1) integer value -- `1` represents Monday; (2) case-insensitive day name (e.g., `\"Monday\"`); (3) case-insensitive, 3-character short day name (e.g., `\"Mon\"`). <br/> **Warning:** A DateTime definition object with `day`** should not be combined with `year`, `quarter`, `month`, or `date`."
},
"hours": {
"description": "Integer value representing the hour of a day from 0-23.",
"maximum": 23,
"minimum": 0,
"type": "number"
},
"milliseconds": {
"description": "Integer value representing the millisecond segment of time.",
"maximum": 999,
"minimum": 0,
"type": "number"
},
"minutes": {
"description": "Integer value representing the minute segment of time from 0-59.",
"maximum": 59,
"minimum": 0,
"type": "number"
},
"month": {
"anyOf": [
{
"$ref": "#/definitions/Month"
},
{
"type": "string"
}
],
"description": "One of: (1) integer value representing the month from `1`-`12`. `1` represents January; (2) case-insensitive month name (e.g., `\"January\"`); (3) case-insensitive, 3-character short month name (e.g., `\"Jan\"`). "
},
"quarter": {
"description": "Integer value representing the quarter of the year (from 1-4).",
"maximum": 4,
"minimum": 1,
"type": "number"
},
"seconds": {
"description": "Integer value representing the second segment (0-59) of a time value",
"maximum": 59,
"minimum": 0,
"type": "number"
},
"utc": {
"description": "A boolean flag indicating if date time is in utc time. If false, the date time is in local time",
"type": "boolean"
},
"year": {
"description": "Integer value representing the year.",
"type": "number"
}
},
"type": "object"
},
"Day": {
"maximum": 7,
"minimum": 1,
"type": "number"
},
"Encoding": {
"additionalProperties": false,
"properties": {
"color": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "Color of the marks – either fill or stroke color based on mark type.\nBy default, `color` represents fill color for `\"area\"`, `\"bar\"`, `\"tick\"`,\n`\"text\"`, `\"circle\"`, and `\"square\"` / stroke color for `\"line\"` and `\"point\"`.\n\n__Default value:__ If undefined, the default color depends on [mark config](config.html#mark)'s `color` property.\n\n_Note:_ See the scale documentation for more information about customizing [color scheme](scale.html#scheme)."
},
"detail": {
"anyOf": [
{
"$ref": "#/definitions/FieldDef"
},
{
"items": {
"$ref": "#/definitions/FieldDef"
},
"type": "array"
}
],
"description": "Additional levels of detail for grouping data in aggregate views and\nin line and area marks without mapping data to a specific visual channel."
},
"opacity": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "Opacity of the marks – either can be a value or a range.\n\n__Default value:__ If undefined, the default opacity depends on [mark config](config.html#mark)'s `opacity` property."
},
"order": {
"anyOf": [
{
"$ref": "#/definitions/OrderFieldDef"
},
{
"items": {
"$ref": "#/definitions/OrderFieldDef"
},
"type": "array"
}
],
"description": "Stack order for stacked marks or order of data points in line marks for connected scatter plots.\n\n__Note__: In aggregate plots, `order` field should be `aggregate`d to avoid creating additional aggregation grouping."
},
"shape": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "The symbol's shape (only for `point` marks). The supported values are\n`\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`,\nor `\"triangle-down\"`, or else a custom SVG path string.\n__Default value:__ If undefined, the default shape depends on [mark config](config.html#point-config)'s `shape` property."
},
"size": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "Size of the mark.\n- For `\"point\"`, `\"square\"` and `\"circle\"`, – the symbol size, or pixel area of the mark.\n- For `\"bar\"` and `\"tick\"` – the bar and tick's size.\n- For `\"text\"` – the text's font size.\n- Size is currently unsupported for `\"line\"`, `\"area\"`, and `\"rect\"`."
},
"text": {
"anyOf": [
{
"$ref": "#/definitions/TextFieldDefWithCondition"
},
{
"$ref": "#/definitions/TextValueDefWithCondition"
}
],
"description": "Text of the `text` mark."
},
"tooltip": {
"anyOf": [
{
"$ref": "#/definitions/TextFieldDefWithCondition"
},
{
"$ref": "#/definitions/TextValueDefWithCondition"
}
],
"description": "The tooltip text to show upon mouse hover."
},
"x": {
"anyOf": [
{
"$ref": "#/definitions/PositionFieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "X coordinates of the marks, or width of horizontal `\"bar\"` and `\"area\"`."
},
"x2": {
"anyOf": [
{
"$ref": "#/definitions/FieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "X2 coordinates for ranged `\"area\"`, `\"bar\"`, `\"rect\"`, and `\"rule\"`."
},
"y": {
"anyOf": [
{
"$ref": "#/definitions/PositionFieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "Y coordinates of the marks, or height of vertical `\"bar\"` and `\"area\"`."
},
"y2": {
"anyOf": [
{
"$ref": "#/definitions/FieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "Y2 coordinates for ranged `\"area\"`, `\"bar\"`, `\"rect\"`, and `\"rule\"`."
}
},
"type": "object"
},
"EncodingWithFacet": {
"additionalProperties": false,
"properties": {
"color": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "Color of the marks – either fill or stroke color based on mark type.\nBy default, `color` represents fill color for `\"area\"`, `\"bar\"`, `\"tick\"`,\n`\"text\"`, `\"circle\"`, and `\"square\"` / stroke color for `\"line\"` and `\"point\"`.\n\n__Default value:__ If undefined, the default color depends on [mark config](config.html#mark)'s `color` property.\n\n_Note:_ See the scale documentation for more information about customizing [color scheme](scale.html#scheme)."
},
"column": {
"$ref": "#/definitions/FacetFieldDef",
"description": "Horizontal facets for trellis plots."
},
"detail": {
"anyOf": [
{
"$ref": "#/definitions/FieldDef"
},
{
"items": {
"$ref": "#/definitions/FieldDef"
},
"type": "array"
}
],
"description": "Additional levels of detail for grouping data in aggregate views and\nin line and area marks without mapping data to a specific visual channel."
},
"opacity": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "Opacity of the marks – either can be a value or a range.\n\n__Default value:__ If undefined, the default opacity depends on [mark config](config.html#mark)'s `opacity` property."
},
"order": {
"anyOf": [
{
"$ref": "#/definitions/OrderFieldDef"
},
{
"items": {
"$ref": "#/definitions/OrderFieldDef"
},
"type": "array"
}
],
"description": "Stack order for stacked marks or order of data points in line marks for connected scatter plots.\n\n__Note__: In aggregate plots, `order` field should be `aggregate`d to avoid creating additional aggregation grouping."
},
"row": {
"$ref": "#/definitions/FacetFieldDef",
"description": "Vertical facets for trellis plots."
},
"shape": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "The symbol's shape (only for `point` marks). The supported values are\n`\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`,\nor `\"triangle-down\"`, or else a custom SVG path string.\n__Default value:__ If undefined, the default shape depends on [mark config](config.html#point-config)'s `shape` property."
},
"size": {
"anyOf": [
{
"$ref": "#/definitions/MarkPropFieldDefWithCondition"
},
{
"$ref": "#/definitions/MarkPropValueDefWithCondition"
}
],
"description": "Size of the mark.\n- For `\"point\"`, `\"square\"` and `\"circle\"`, – the symbol size, or pixel area of the mark.\n- For `\"bar\"` and `\"tick\"` – the bar and tick's size.\n- For `\"text\"` – the text's font size.\n- Size is currently unsupported for `\"line\"`, `\"area\"`, and `\"rect\"`."
},
"text": {
"anyOf": [
{
"$ref": "#/definitions/TextFieldDefWithCondition"
},
{
"$ref": "#/definitions/TextValueDefWithCondition"
}
],
"description": "Text of the `text` mark."
},
"tooltip": {
"anyOf": [
{
"$ref": "#/definitions/TextFieldDefWithCondition"
},
{
"$ref": "#/definitions/TextValueDefWithCondition"
}
],
"description": "The tooltip text to show upon mouse hover."
},
"x": {
"anyOf": [
{
"$ref": "#/definitions/PositionFieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "X coordinates of the marks, or width of horizontal `\"bar\"` and `\"area\"`."
},
"x2": {
"anyOf": [
{
"$ref": "#/definitions/FieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "X2 coordinates for ranged `\"area\"`, `\"bar\"`, `\"rect\"`, and `\"rule\"`."
},
"y": {
"anyOf": [
{
"$ref": "#/definitions/PositionFieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "Y coordinates of the marks, or height of vertical `\"bar\"` and `\"area\"`."
},
"y2": {
"anyOf": [
{
"$ref": "#/definitions/FieldDef"
},
{
"$ref": "#/definitions/ValueDef"
}
],
"description": "Y2 coordinates for ranged `\"area\"`, `\"bar\"`, `\"rect\"`, and `\"rule\"`."
}
},
"type": "object"
},
"EqualFilter": {
"additionalProperties": false,
"properties": {
"equal": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"$ref": "#/definitions/DateTime"
}
],
"description": "The value that the field should be equal to."
},
"field": {
"description": "Field to be filtered.",
"type": "string"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit for the field to be filtered."
}
},
"required": ["field", "equal"],
"type": "object"
},
"FacetFieldDef": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"header": {
"$ref": "#/definitions/Header",
"description": "An object defining properties of a facet's header."
},
"sort": {
"$ref": "#/definitions/SortOrder",
"description": "Sort order for a facet field.\nThis can be `\"ascending\"`, `\"descending\"`."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"FacetMapping": {
"additionalProperties": false,
"properties": {
"column": {
"$ref": "#/definitions/FacetFieldDef",
"description": "Horizontal facets for trellis plots."
},
"row": {
"$ref": "#/definitions/FacetFieldDef",
"description": "Vertical facets for trellis plots."
}
},
"type": "object"
},
"FacetedUnitSpec": {
"$ref": "#/definitions/FacetedCompositeUnitSpecAlias",
"description": "Unit spec that can have a composite mark and row or column channels."
},
"FieldDef": {
"additionalProperties": false,
"description": "Definition object for a data field, its type and transformation of an encoding channel.",
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"FieldDefBase": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
}
},
"type": "object"
},
"MarkPropFieldDefWithCondition": {
"additionalProperties": false,
"description": "A FieldDef with Condition<ValueDef>\n{\n condition: {value: ...},\n field: ...,\n ...\n}",
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"condition": {
"anyOf": [
{
"$ref": "#/definitions/Conditional<ValueDef>"
},
{
"items": {
"$ref": "#/definitions/Conditional<ValueDef>"
},
"type": "array"
}
],
"description": "One or more value definition(s) with a selection predicate.\n\n__Note:__ A field definition's `condition` property can only contain [value definitions](encoding.html#value)\nsince Vega-Lite only allows at mosty one encoded field per encoding channel."
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"legend": {
"anyOf": [
{
"$ref": "#/definitions/Legend"
},
{
"type": "null"
}
],
"description": "An object defining properties of the legend.\nIf `null`, the legend for the encoding channel will be removed.\n\n__Default value:__ If undefined, default [legend properties](legend.html) are applied."
},
"scale": {
"$ref": "#/definitions/Scale",
"description": "An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.\n\n__Default value:__ If undefined, default [scale properties](scale.html) are applied."
},
"sort": {
"anyOf": [
{
"$ref": "#/definitions/SortOrder"
},
{
"$ref": "#/definitions/SortField"
},
{
"type": "null"
}
],
"description": "Sort order for the encoded field.\nSupported `sort` values include `\"ascending\"`, `\"descending\"` and `null` (no sorting).\nFor fields with discrete domains, `sort` can also be a [sort field definition object](sort.html#sort-field).\n\n__Default value:__ `\"ascending\"`"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"TextFieldDefWithCondition": {
"additionalProperties": false,
"description": "A FieldDef with Condition<ValueDef>\n{\n condition: {value: ...},\n field: ...,\n ...\n}",
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"condition": {
"anyOf": [
{
"$ref": "#/definitions/Conditional<ValueDef>"
},
{
"items": {
"$ref": "#/definitions/Conditional<ValueDef>"
},
"type": "array"
}
],
"description": "One or more value definition(s) with a selection predicate.\n\n__Note:__ A field definition's `condition` property can only contain [value definitions](encoding.html#value)\nsince Vega-Lite only allows at mosty one encoded field per encoding channel."
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"format": {
"description": "The [formatting pattern](format.html) for a text field. If not defined, this will be determined automatically.",
"type": "string"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"Filter": {
"anyOf": [
{
"$ref": "#/definitions/EqualFilter"
},
{
"$ref": "#/definitions/RangeFilter"
},
{
"$ref": "#/definitions/OneOfFilter"
},
{
"$ref": "#/definitions/SelectionFilter"
},
{
"type": "string"
}
]
},
"FilterTransform": {
"additionalProperties": false,
"properties": {
"filter": {
"$ref": "#/definitions/FilterOperand",
"description": "The `filter` property must be either (1) a filter object for [equal-filters](filter.html#equalfilter),\n[range-filters](filter.html#rangefilter), [one-of filters](filter.html#oneoffilter), or [selection filters](filter.html#selectionfilter);\n(2) a [Vega Expression](filter.html#expression) string,\nwhere `datum` can be used to refer to the current data object; or (3) an array of filters (either objects or expression strings) that must all be true for a datum to pass the filter and be included."
}
},
"required": ["filter"],
"type": "object"
},
"FontStyle": {
"enum": ["normal", "italic"],
"type": "string"
},
"FontWeight": {
"enum": ["normal", "bold"],
"type": "string"
},
"FontWeightNumber": {
"maximum": 900,
"minimum": 100,
"type": "number"
},
"FacetSpec": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"facet": {
"$ref": "#/definitions/FacetMapping",
"description": "An object that describes mappings between `row` and `column` channels and their field definitions."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for facets."
},
"spec": {
"anyOf": [
{
"$ref": "#/definitions/LayerSpec"
},
{
"$ref": "#/definitions/CompositeUnitSpec"
}
],
"description": "A specification of the view that gets faceted."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"required": ["facet", "spec"],
"type": "object"
},
"HConcatSpec": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"hconcat": {
"description": "A list of views that should be concatenated and put into a row.",
"items": {
"$ref": "#/definitions/Spec"
},
"type": "array"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for horizontally concatenated charts."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"required": ["hconcat"],
"type": "object"
},
"LayerSpec": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"height": {
"description": "The height of a visualization.\n\n__Default value:__\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).\n- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).\n- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.\n\n__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
},
"layer": {
"description": "Layer or single view specifications to be layered.\n\n__Note__: Specifications inside `layer` cannot use `row` and `column` channels as layering facet specifications is not allowed.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/LayerSpec"
},
{
"$ref": "#/definitions/CompositeUnitSpec"
}
]
},
"type": "array"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for layers."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"width": {
"description": "The width of a visualization.\n\n__Default value:__ This will be determined by the following rules:\n\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).\n- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).\n- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.\n\n__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
}
},
"required": ["layer"],
"type": "object"
},
"RepeatSpec": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"repeat": {
"$ref": "#/definitions/Repeat",
"description": "An object that describes what fields should be repeated into views that are laid out as a `row` or `column`."
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale and legend resolutions for repeated charts."
},
"spec": {
"$ref": "#/definitions/Spec"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"required": ["repeat", "spec"],
"type": "object"
},
"Spec": {
"anyOf": [
{
"$ref": "#/definitions/CompositeUnitSpec"
},
{
"$ref": "#/definitions/LayerSpec"
},
{
"$ref": "#/definitions/FacetSpec"
},
{
"$ref": "#/definitions/RepeatSpec"
},
{
"$ref": "#/definitions/VConcatSpec"
},
{
"$ref": "#/definitions/HConcatSpec"
}
]
},
"CompositeUnitSpecAlias": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"encoding": {
"$ref": "#/definitions/Encoding",
"description": "A key-value mapping between encoding channels and definition of fields."
},
"height": {
"description": "The height of a visualization.\n\n__Default value:__\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).\n- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).\n- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.\n\n__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
},
"mark": {
"$ref": "#/definitions/AnyMark",
"description": "A string describing the mark type (one of `\"bar\"`, `\"circle\"`, `\"square\"`, `\"tick\"`, `\"line\"`,\n`\"area\"`, `\"point\"`, `\"rule\"`, and `\"text\"`) or a [mark definition object](mark.html#mark-def)."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"selection": {
"additionalProperties": {
"$ref": "#/definitions/SelectionDef"
},
"description": "A key-value mapping between selection names and definitions.",
"type": "object"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"width": {
"description": "The width of a visualization.\n\n__Default value:__ This will be determined by the following rules:\n\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).\n- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).\n- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.\n\n__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
}
},
"required": ["mark", "encoding"],
"type": "object"
},
"FacetedCompositeUnitSpecAlias": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"encoding": {
"$ref": "#/definitions/EncodingWithFacet",
"description": "A key-value mapping between encoding channels and definition of fields."
},
"height": {
"description": "The height of a visualization.\n\n__Default value:__\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).\n- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).\n- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.\n\n__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
},
"mark": {
"$ref": "#/definitions/AnyMark",
"description": "A string describing the mark type (one of `\"bar\"`, `\"circle\"`, `\"square\"`, `\"tick\"`, `\"line\"`,\n`\"area\"`, `\"point\"`, `\"rule\"`, and `\"text\"`) or a [mark definition object](mark.html#mark-def)."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"selection": {
"additionalProperties": {
"$ref": "#/definitions/SelectionDef"
},
"description": "A key-value mapping between selection names and definitions.",
"type": "object"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"width": {
"description": "The width of a visualization.\n\n__Default value:__ This will be determined by the following rules:\n\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).\n- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).\n- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.\n\n__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
}
},
"required": ["mark", "encoding"],
"type": "object"
},
"VConcatSpec": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for vertically concatenated charts."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"vconcat": {
"description": "A list of views that should be concatenated and put into a column.",
"items": {
"$ref": "#/definitions/Spec"
},
"type": "array"
}
},
"required": ["vconcat"],
"type": "object"
},
"Guide": {
"additionalProperties": false,
"properties": {
"format": {
"description": "The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.\n\nSee the [format documentation](format.html) for more information.\n\n__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.",
"type": "string"
},
"title": {
"description": "A title for the field. If `null`, the title will be removed.\n\n__Default value:__ derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`). If the field has an aggregate function, the function is displayed as a part of the title (e.g., `\"Sum of Profit\"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `\"Profit (binned)\"`, `\"Transaction Date (year-month)\"`). Otherwise, the title is simply the field name.\n\n__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title).",
"type": ["string", "null"]
}
},
"type": "object"
},
"Header": {
"additionalProperties": false,
"description": "Headers of row / column channels for faceted plots.",
"properties": {
"format": {
"description": "The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.\n\n__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.",
"type": "string"
},
"title": {
"description": "A title for the axis. Shows field name and its function by default.\n\n__Default value:__ derived from the field's name and transformation function applied e.g, \"field_name\", \"SUM(field_name)\", \"BIN(field_name)\", \"YEAR(field_name)\".",
"type": "string"
}
},
"type": "object"
},
"HorizontalAlign": {
"enum": ["left", "right", "center"],
"type": "string"
},
"InlineData": {
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/definitions/DataFormat",
"description": "An object that specifies the format for parsing the data values."
},
"values": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "boolean"
},
"type": "array"
},
{
"items": {
"type": "object"
},
"type": "array"
},
{
"type": "string"
},
{
"type": "object"
}
],
"description": "The full data set, included inline. This can be an array of objects or primitive values or a string.\nArrays of primitive values are ingested as objects with a `data` property. Strings are parsed according to the specified format type."
}
},
"required": ["values"],
"type": "object"
},
"Interpolate": {
"enum": [
"linear",
"linear-closed",
"step",
"step-before",
"step-after",
"basis",
"basis-open",
"basis-closed",
"cardinal",
"cardinal-open",
"cardinal-closed",
"bundle",
"monotone"
],
"type": "string"
},
"InterpolateParams": {
"additionalProperties": false,
"properties": {
"gamma": {
"type": "number"
},
"type": {
"enum": ["rgb", "cubehelix", "cubehelix-long"],
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
"IntervalSelection": {
"additionalProperties": false,
"properties": {
"bind": {
"description": "Establishes a two-way binding between the interval selection and the scales\nused within the same view. This allows a user to interactively pan and\nzoom the view.",
"enum": ["scales"],
"type": "string"
},
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"mark": {
"$ref": "#/definitions/BrushConfig",
"description": "An interval selection also adds a rectangle mark to depict the\nextents of the interval. The `mark` property can be used to customize the\nappearance of the mark."
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
},
"translate": {
"description": "When truthy, allows a user to interactively move an interval selection\nback-and-forth. Can be `true`, `false` (to disable panning), or a\n[Vega event stream definition](https://vega.github.io/vega/docs/event-streams/)\nwhich must include a start and end event to trigger continuous panning.\n\n__Default value:__ `true`, which corresponds to\n`[mousedown, window:mouseup] > window:mousemove!` which corresponds to\nclicks and dragging within an interval selection to reposition it.",
"type": ["string", "boolean"]
},
"type": {
"enum": ["interval"],
"type": "string"
},
"zoom": {
"description": "When truthy, allows a user to interactively resize an interval selection.\nCan be `true`, `false` (to disable zooming), or a [Vega event stream\ndefinition](https://vega.github.io/vega/docs/event-streams/). Currently,\nonly `wheel` events are supported.\n\n\n__Default value:__ `true`, which corresponds to `wheel!`.",
"type": ["string", "boolean"]
}
},
"required": ["type"],
"type": "object"
},
"IntervalSelectionConfig": {
"additionalProperties": false,
"properties": {
"bind": {
"description": "Establishes a two-way binding between the interval selection and the scales\nused within the same view. This allows a user to interactively pan and\nzoom the view.",
"enum": ["scales"],
"type": "string"
},
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"mark": {
"$ref": "#/definitions/BrushConfig",
"description": "An interval selection also adds a rectangle mark to depict the\nextents of the interval. The `mark` property can be used to customize the\nappearance of the mark."
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
},
"translate": {
"description": "When truthy, allows a user to interactively move an interval selection\nback-and-forth. Can be `true`, `false` (to disable panning), or a\n[Vega event stream definition](https://vega.github.io/vega/docs/event-streams/)\nwhich must include a start and end event to trigger continuous panning.\n\n__Default value:__ `true`, which corresponds to\n`[mousedown, window:mouseup] > window:mousemove!` which corresponds to\nclicks and dragging within an interval selection to reposition it.",
"type": ["string", "boolean"]
},
"zoom": {
"description": "When truthy, allows a user to interactively resize an interval selection.\nCan be `true`, `false` (to disable zooming), or a [Vega event stream\ndefinition](https://vega.github.io/vega/docs/event-streams/). Currently,\nonly `wheel` events are supported.\n\n\n__Default value:__ `true`, which corresponds to `wheel!`.",
"type": ["string", "boolean"]
}
},
"type": "object"
},
"JsonDataFormat": {
"additionalProperties": false,
"properties": {
"parse": {
"anyOf": [
{
"enum": ["auto"],
"type": "string"
},
{
"type": "object"
}
],
"description": "If set to auto (the default), perform automatic type inference to determine the desired data types.\nAlternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `\"number\"`, `\"boolean\"` or `\"date\"`).\nFor example, `\"parse\": {\"modified_on\": \"date\"}` parses the `modified_on` field in each input record a Date value.\n\nFor `\"date\"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).\nFor Specific date formats can be provided (e.g., `{foo: 'date:\"%m%d%Y\"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:\"%m%d%Y\"'}`). See more about [UTC time](timeunit.html#utc)"
},
"property": {
"description": "The JSON property containing the desired data.\nThis parameter can be used when the loaded JSON file may have surrounding structure or meta-data.\nFor example `\"property\": \"values.features\"` is equivalent to retrieving `json.values.features`\nfrom the loaded JSON object.",
"type": "string"
},
"type": {
"description": "Type of input data: `\"json\"`, `\"csv\"`, `\"tsv\"`.\nThe default format type is determined by the extension of the file URL.\nIf no extension is detected, `\"json\"` will be used by default.",
"enum": ["json"],
"type": "string"
}
},
"type": "object"
},
"LayoutSizeMixins": {
"additionalProperties": false,
"properties": {
"height": {
"description": "The height of a visualization.\n\n__Default value:__\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).\n- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).\n- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.\n\n__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
},
"width": {
"description": "The width of a visualization.\n\n__Default value:__ This will be determined by the following rules:\n\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).\n- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).\n- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.\n\n__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
}
},
"type": "object"
},
"Legend": {
"additionalProperties": false,
"description": "Properties of a legend or boolean flag for determining whether to show it.",
"properties": {
"entryPadding": {
"description": "Padding (in pixels) between legend entries in a symbol legend.",
"type": "number"
},
"format": {
"description": "The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.\n\nSee the [format documentation](format.html) for more information.\n\n__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.",
"type": "string"
},
"offset": {
"description": "The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.\n\n__Default value:__ `0`",
"type": "number"
},
"orient": {
"$ref": "#/definitions/LegendOrient",
"description": "The orientation of the legend, which determines how the legend is positioned within the scene. One of \"left\", \"right\", \"top-left\", \"top-right\", \"bottom-left\", \"bottom-right\", \"none\".\n\n__Default value:__ `\"right\"`"
},
"padding": {
"description": "The padding, in pixels, between the legend and axis.",
"type": "number"
},
"tickCount": {
"description": "The desired number of tick values for quantitative legends.",
"type": "number"
},
"title": {
"description": "A title for the field. If `null`, the title will be removed.\n\n__Default value:__ derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`). If the field has an aggregate function, the function is displayed as a part of the title (e.g., `\"Sum of Profit\"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `\"Profit (binned)\"`, `\"Transaction Date (year-month)\"`). Otherwise, the title is simply the field name.\n\n__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title).",
"type": ["string", "null"]
},
"type": {
"description": "The type of the legend. Use `\"symbol\"` to create a discrete legend and `\"gradient\"` for a continuous color gradient.\n\n__Default value:__ `\"gradient\"` for non-binned quantitative fields and temporal fields; `\"symbol\"` otherwise.",
"enum": ["symbol", "gradient"],
"type": "string"
},
"values": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"$ref": "#/definitions/DateTime"
},
"type": "array"
}
],
"description": "Explicitly set the visible legend values."
},
"zindex": {
"description": "A non-positive integer indicating z-index of the legend.\nIf zindex is 0, legend should be drawn behind all chart elements.\nTo put them in front, use zindex = 1.",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"LegendConfig": {
"additionalProperties": false,
"properties": {
"cornerRadius": {
"description": "Corner radius for the full legend.",
"type": "number"
},
"entryPadding": {
"description": "Padding (in pixels) between legend entries in a symbol legend.",
"type": "number"
},
"fillColor": {
"description": "Background fill color for the full legend.",
"type": "string"
},
"gradientHeight": {
"description": "The height of the gradient, in pixels.",
"minimum": 0,
"type": "number"
},
"gradientLabelBaseline": {
"description": "Text baseline for color ramp gradient labels.",
"type": "string"
},
"gradientLabelLimit": {
"description": "The maximum allowed length in pixels of color ramp gradient labels.",
"type": "number"
},
"gradientLabelOffset": {
"description": "Vertical offset in pixels for color ramp gradient labels.",
"type": "number"
},
"gradientStrokeColor": {
"description": "The color of the gradient stroke, can be in hex color code or regular color name.",
"type": "string"
},
"gradientStrokeWidth": {
"description": "The width of the gradient stroke, in pixels.",
"minimum": 0,
"type": "number"
},
"gradientWidth": {
"description": "The width of the gradient, in pixels.",
"minimum": 0,
"type": "number"
},
"labelAlign": {
"description": "The alignment of the legend label, can be left, middle or right.",
"type": "string"
},
"labelBaseline": {
"description": "The position of the baseline of legend label, can be top, middle or bottom.",
"type": "string"
},
"labelColor": {
"description": "The color of the legend label, can be in hex color code or regular color name.",
"type": "string"
},
"labelFont": {
"description": "The font of the legend label.",
"type": "string"
},
"labelFontSize": {
"description": "The font size of legend label.\n\n__Default value:__ `10`.",
"minimum": 0,
"type": "number"
},
"labelLimit": {
"description": "Maximum allowed pixel width of axis tick labels.",
"type": "number"
},
"labelOffset": {
"description": "The offset of the legend label.",
"minimum": 0,
"type": "number"
},
"offset": {
"description": "The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.\n\n__Default value:__ `0`",
"type": "number"
},
"orient": {
"$ref": "#/definitions/LegendOrient",
"description": "The orientation of the legend, which determines how the legend is positioned within the scene. One of \"left\", \"right\", \"top-left\", \"top-right\", \"bottom-left\", \"bottom-right\", \"none\".\n\n__Default value:__ `\"right\"`"
},
"padding": {
"description": "The padding, in pixels, between the legend and axis.",
"type": "number"
},
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.\n\n__Default value:__ `false`",
"type": "boolean"
},
"strokeColor": {
"description": "Border stroke color for the full legend.",
"type": "string"
},
"strokeDash": {
"description": "Border stroke dash pattern for the full legend.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeWidth": {
"description": "Border stroke width for the full legend.",
"type": "number"
},
"symbolColor": {
"description": "The color of the legend symbol,",
"type": "string"
},
"symbolSize": {
"description": "The size of the legend symbol, in pixels.",
"minimum": 0,
"type": "number"
},
"symbolStrokeWidth": {
"description": "The width of the symbol's stroke.",
"minimum": 0,
"type": "number"
},
"symbolType": {
"description": "Default shape type (such as \"circle\") for legend symbols.",
"type": "string"
},
"titleAlign": {
"description": "Horizontal text alignment for legend titles.",
"type": "string"
},
"titleBaseline": {
"description": "Vertical text baseline for legend titles.",
"type": "string"
},
"titleColor": {
"description": "The color of the legend title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "The font of the legend title.",
"type": "string"
},
"titleFontSize": {
"description": "The font size of the legend title.",
"type": "number"
},
"titleFontWeight": {
"description": "The font weight of the legend title.",
"type": ["string", "number"]
},
"titleLimit": {
"description": "Maximum allowed pixel width of axis titles.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and legend.",
"type": "number"
}
},
"type": "object"
},
"LegendOrient": {
"enum": [
"left",
"right",
"top-left",
"top-right",
"bottom-left",
"bottom-right",
"none"
],
"type": "string"
},
"LegendResolveMap": {
"additionalProperties": false,
"properties": {
"color": {
"$ref": "#/definitions/ResolveMode"
},
"opacity": {
"$ref": "#/definitions/ResolveMode"
},
"shape": {
"$ref": "#/definitions/ResolveMode"
},
"size": {
"$ref": "#/definitions/ResolveMode"
}
},
"type": "object"
},
"LocalMultiTimeUnit": {
"enum": [
"yearquarter",
"yearquartermonth",
"yearmonth",
"yearmonthdate",
"yearmonthdatehours",
"yearmonthdatehoursminutes",
"yearmonthdatehoursminutesseconds",
"quartermonth",
"monthdate",
"hoursminutes",
"hoursminutesseconds",
"minutesseconds",
"secondsmilliseconds"
],
"type": "string"
},
"LocalSingleTimeUnit": {
"enum": [
"year",
"quarter",
"month",
"day",
"date",
"hours",
"minutes",
"seconds",
"milliseconds"
],
"type": "string"
},
"AndFilter": {
"additionalProperties": false,
"properties": {
"and": {
"items": {
"$ref": "#/definitions/FilterOperand"
},
"type": "array"
}
},
"required": ["and"],
"type": "object"
},
"SelectionAnd": {
"additionalProperties": false,
"properties": {
"and": {
"items": {
"$ref": "#/definitions/SelectionOperand"
},
"type": "array"
}
},
"required": ["and"],
"type": "object"
},
"NotFilter": {
"additionalProperties": false,
"properties": {
"not": {
"$ref": "#/definitions/FilterOperand"
}
},
"required": ["not"],
"type": "object"
},
"SelectionNot": {
"additionalProperties": false,
"properties": {
"not": {
"$ref": "#/definitions/SelectionOperand"
}
},
"required": ["not"],
"type": "object"
},
"FilterOperand": {
"anyOf": [
{
"$ref": "#/definitions/NotFilter"
},
{
"$ref": "#/definitions/AndFilter"
},
{
"$ref": "#/definitions/OrFilter"
},
{
"$ref": "#/definitions/Filter"
}
]
},
"SelectionOperand": {
"anyOf": [
{
"$ref": "#/definitions/SelectionNot"
},
{
"$ref": "#/definitions/SelectionAnd"
},
{
"$ref": "#/definitions/SelectionOr"
},
{
"type": "string"
}
]
},
"OrFilter": {
"additionalProperties": false,
"properties": {
"or": {
"items": {
"$ref": "#/definitions/FilterOperand"
},
"type": "array"
}
},
"required": ["or"],
"type": "object"
},
"SelectionOr": {
"additionalProperties": false,
"properties": {
"or": {
"items": {
"$ref": "#/definitions/SelectionOperand"
},
"type": "array"
}
},
"required": ["or"],
"type": "object"
},
"LookupData": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/definitions/Data",
"description": "Secondary data source to lookup in."
},
"fields": {
"description": "Fields in foreign data to lookup.\nIf not specified, the entire object is queried.",
"items": {
"type": "string"
},
"type": "array"
},
"key": {
"description": "Key in data to lookup.",
"type": "string"
}
},
"required": ["data", "key"],
"type": "object"
},
"LookupTransform": {
"additionalProperties": false,
"properties": {
"as": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The field or fields for storing the computed formula value.\nIf `from.fields` is specified, the transform will use the same names for `as`.\nIf `from.fields` is not specified, `as` has to be a string and we put the whole object into the data under the specified name."
},
"default": {
"description": "The default value to use if lookup fails.\n\n__Default value:__ `null`",
"type": "string"
},
"from": {
"$ref": "#/definitions/LookupData",
"description": "Secondary data reference."
},
"lookup": {
"description": "Key in primary data source.",
"type": "string"
}
},
"required": ["lookup", "from"],
"type": "object"
},
"Mark": {
"description": "All types of primitive marks.",
"enum": [
"area",
"bar",
"line",
"point",
"text",
"tick",
"rect",
"rule",
"circle",
"square"
],
"type": "string"
},
"MarkConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"color": {
"description": "Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "string"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `true` for all marks except `point` and `false` for `point`.\n\n__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "The pixel area each the point/circle/square.\nFor example: in the case of circles, the radius is determined in part by the square root of the size value.\n\n__Default value:__ `30`",
"minimum": 0,
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
}
},
"type": "object"
},
"MarkConfigMixins": {
"additionalProperties": false,
"properties": {
"area": {
"$ref": "#/definitions/MarkConfig",
"description": "Area-Specific Config "
},
"bar": {
"$ref": "#/definitions/BarConfig",
"description": "Bar-Specific Config "
},
"circle": {
"$ref": "#/definitions/MarkConfig",
"description": "Circle-Specific Config "
},
"line": {
"$ref": "#/definitions/MarkConfig",
"description": "Line-Specific Config "
},
"mark": {
"$ref": "#/definitions/MarkConfig",
"description": "Mark Config "
},
"point": {
"$ref": "#/definitions/MarkConfig",
"description": "Point-Specific Config "
},
"rect": {
"$ref": "#/definitions/MarkConfig",
"description": "Rect-Specific Config "
},
"rule": {
"$ref": "#/definitions/MarkConfig",
"description": "Rule-Specific Config "
},
"square": {
"$ref": "#/definitions/MarkConfig",
"description": "Square-Specific Config "
},
"text": {
"$ref": "#/definitions/TextConfig",
"description": "Text-Specific Config "
},
"tick": {
"$ref": "#/definitions/TickConfig",
"description": "Tick-Specific Config "
}
},
"type": "object"
},
"MarkDef": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"clip": {
"description": "Whether a mark be clipped to the enclosing group's width and height.",
"type": "boolean"
},
"color": {
"description": "Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "string"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `true` for all marks except `point` and `false` for `point`.\n\n__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "The pixel area each the point/circle/square.\nFor example: in the case of circles, the radius is determined in part by the square root of the size value.\n\n__Default value:__ `30`",
"minimum": 0,
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"style": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the [style configuration](mark.html#style-config). If style is an array, later styles will override earlier styles. Any [mark properties](encoding.html#mark-prop) explicitly defined within the `encoding` will override a style default.\n\n__Default value:__ The mark's name. For example, a bar mark will have style `\"bar\"` by default.\n__Note:__ Any specified style will augment the default style. For example, a bar mark with `\"style\": \"foo\"` will receive from `config.style.bar` and `config.style.foo` (the specified style `\"foo\"` has higher precedence)."
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
},
"type": {
"$ref": "#/definitions/Mark",
"description": "The mark type.\nOne of `\"bar\"`, `\"circle\"`, `\"square\"`, `\"tick\"`, `\"line\"`,\n`\"area\"`, `\"point\"`, `\"rule\"`, and `\"text\"`."
}
},
"required": ["type"],
"type": "object"
},
"MarkPropFieldDef": {
"additionalProperties": false,
"description": "Field definition of a mark property, which can contain a legend.",
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"legend": {
"anyOf": [
{
"$ref": "#/definitions/Legend"
},
{
"type": "null"
}
],
"description": "An object defining properties of the legend.\nIf `null`, the legend for the encoding channel will be removed.\n\n__Default value:__ If undefined, default [legend properties](legend.html) are applied."
},
"scale": {
"$ref": "#/definitions/Scale",
"description": "An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.\n\n__Default value:__ If undefined, default [scale properties](scale.html) are applied."
},
"sort": {
"anyOf": [
{
"$ref": "#/definitions/SortOrder"
},
{
"$ref": "#/definitions/SortField"
},
{
"type": "null"
}
],
"description": "Sort order for the encoded field.\nSupported `sort` values include `\"ascending\"`, `\"descending\"` and `null` (no sorting).\nFor fields with discrete domains, `sort` can also be a [sort field definition object](sort.html#sort-field).\n\n__Default value:__ `\"ascending\"`"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"Month": {
"maximum": 12,
"minimum": 1,
"type": "number"
},
"MultiSelection": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"nearest": {
"description": "When true, an invisible voronoi diagram is computed to accelerate discrete\nselection. The data value _nearest_ the mouse cursor is added to the selection.\n\nSee the [nearest transform](nearest.html) documentation for more information.",
"type": "boolean"
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
},
"toggle": {
"description": "Controls whether data values should be toggled or only ever inserted into\nmulti selections. Can be `true`, `false` (for insertion only), or a\n[Vega expression](https://vega.github.io/vega/docs/expressions/).\n\n__Default value:__ `true`, which corresponds to `event.shiftKey` (i.e.,\ndata values are toggled when a user interacts with the shift-key pressed).\n\nSee the [toggle transform](toggle.html) documentation for more information.",
"type": ["string", "boolean"]
},
"type": {
"enum": ["multi"],
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
"MultiSelectionConfig": {
"additionalProperties": false,
"properties": {
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"nearest": {
"description": "When true, an invisible voronoi diagram is computed to accelerate discrete\nselection. The data value _nearest_ the mouse cursor is added to the selection.\n\nSee the [nearest transform](nearest.html) documentation for more information.",
"type": "boolean"
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
},
"toggle": {
"description": "Controls whether data values should be toggled or only ever inserted into\nmulti selections. Can be `true`, `false` (for insertion only), or a\n[Vega expression](https://vega.github.io/vega/docs/expressions/).\n\n__Default value:__ `true`, which corresponds to `event.shiftKey` (i.e.,\ndata values are toggled when a user interacts with the shift-key pressed).\n\nSee the [toggle transform](toggle.html) documentation for more information.",
"type": ["string", "boolean"]
}
},
"type": "object"
},
"MultiTimeUnit": {
"anyOf": [
{
"$ref": "#/definitions/LocalMultiTimeUnit"
},
{
"$ref": "#/definitions/UtcMultiTimeUnit"
}
]
},
"NamedData": {
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/definitions/DataFormat",
"description": "An object that specifies the format for parsing the data."
},
"name": {
"description": "Provide a placeholder name and bind data at runtime.",
"type": "string"
}
},
"required": ["name"],
"type": "object"
},
"NiceTime": {
"enum": ["second", "minute", "hour", "day", "week", "month", "year"],
"type": "string"
},
"OneOfFilter": {
"additionalProperties": false,
"properties": {
"field": {
"description": "Field to be filtered",
"type": "string"
},
"oneOf": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "number"
},
"type": "array"
},
{
"items": {
"type": "boolean"
},
"type": "array"
},
{
"items": {
"$ref": "#/definitions/DateTime"
},
"type": "array"
}
],
"description": "A set of values that the `field`'s value should be a member of,\nfor a data item included in the filtered data."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "time unit for the field to be filtered."
}
},
"required": ["field", "oneOf"],
"type": "object"
},
"OrderFieldDef": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"sort": {
"$ref": "#/definitions/SortOrder",
"description": "The sort order. One of `\"ascending\"` (default) or `\"descending\"`."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"Orient": {
"enum": ["horizontal", "vertical"],
"type": "string"
},
"Padding": {
"anyOf": [
{
"type": "number"
},
{
"additionalProperties": false,
"properties": {
"bottom": {
"type": "number"
},
"left": {
"type": "number"
},
"right": {
"type": "number"
},
"top": {
"type": "number"
}
},
"type": "object"
}
],
"minimum": 0
},
"PositionFieldDef": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"axis": {
"anyOf": [
{
"$ref": "#/definitions/Axis"
},
{
"type": "null"
}
],
"description": "An object defining properties of axis's gridlines, ticks and labels.\nIf `null`, the axis for the encoding channel will be removed.\n\n__Default value:__ If undefined, default [axis properties](axis.html) are applied."
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"scale": {
"$ref": "#/definitions/Scale",
"description": "An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.\n\n__Default value:__ If undefined, default [scale properties](scale.html) are applied."
},
"sort": {
"anyOf": [
{
"$ref": "#/definitions/SortOrder"
},
{
"$ref": "#/definitions/SortField"
},
{
"type": "null"
}
],
"description": "Sort order for the encoded field.\nSupported `sort` values include `\"ascending\"`, `\"descending\"` and `null` (no sorting).\nFor fields with discrete domains, `sort` can also be a [sort field definition object](sort.html#sort-field).\n\n__Default value:__ `\"ascending\"`"
},
"stack": {
"anyOf": [
{
"$ref": "#/definitions/StackOffset"
},
{
"type": "null"
}
],
"description": "Type of stacking offset if the field should be stacked.\n`stack` is only applicable for `x` and `y` channels with continuous domains.\nFor example, `stack` of `y` can be used to customize stacking for a vertical bar chart.\n\n`stack` can be one of the following values:\n- `\"zero\"`: stacking with baseline offset at zero value of the scale (for creating typical stacked [bar](stack.html#bar) and [area](stack.html#area) chart).\n- `\"normalize\"` - stacking with normalized domain (for creating [normalized stacked bar and area charts](stack.html#normalized). <br/>\n-`\"center\"` - stacking with center baseline (for [streamgraph](stack.html#streamgraph)).\n- `null` - No-stacking. This will produce layered [bar](stack.html#layered-bar-chart) and area chart.\n\n__Default value:__ `zero` for plots with all of the following conditions are true:\n(1) the mark is `bar` or `area`;\n(2) the stacked measure channel (x or y) has a linear scale;\n(3) At least one of non-position channels mapped to an unaggregated field that is different from x and y. Otherwise, `null` by default."
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"RangeConfig": {
"additionalProperties": {
"$ref": "#/definitions/RangeConfigValue"
},
"properties": {
"category": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/definitions/VgScheme"
}
],
"description": "Default range for _nominal_ (categorical) fields."
},
"diverging": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/definitions/VgScheme"
}
],
"description": "Default range for diverging _quantitative_ fields."
},
"heatmap": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/definitions/VgScheme"
}
],
"description": "Default range for _quantitative_ heatmaps."
},
"ordinal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/definitions/VgScheme"
}
],
"description": "Default range for _ordinal_ fields."
},
"ramp": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/definitions/VgScheme"
}
],
"description": "Default range for _quantitative_ and _temporal_ fields."
},
"symbol": {
"description": "Default range palette for the `shape` channel.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RangeConfigValue": {
"anyOf": [
{
"items": {
"type": ["number", "string"]
},
"type": "array"
},
{
"$ref": "#/definitions/VgScheme"
},
{
"additionalProperties": false,
"properties": {
"step": {
"type": "number"
}
},
"required": ["step"],
"type": "object"
}
]
},
"RangeFilter": {
"additionalProperties": false,
"properties": {
"field": {
"description": "Field to be filtered",
"type": "string"
},
"range": {
"description": "An array of inclusive minimum and maximum values\nfor a field value of a data item to be included in the filtered data.",
"items": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/DateTime"
}
]
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "time unit for the field to be filtered."
}
},
"required": ["field", "range"],
"type": "object"
},
"Repeat": {
"additionalProperties": false,
"properties": {
"column": {
"description": "Horizontal repeated views.",
"items": {
"type": "string"
},
"type": "array"
},
"row": {
"description": "Vertical repeated views.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RepeatRef": {
"additionalProperties": false,
"description": "Reference to a repeated value.",
"properties": {
"repeat": {
"enum": ["row", "column"],
"type": "string"
}
},
"required": ["repeat"],
"type": "object"
},
"Resolve": {
"additionalProperties": false,
"description": "Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from `scale`, `axis`, and `legend` to a mapping from channels to resolutions.",
"properties": {
"axis": {
"$ref": "#/definitions/AxisResolveMap"
},
"legend": {
"$ref": "#/definitions/LegendResolveMap"
},
"scale": {
"$ref": "#/definitions/ScaleResolveMap"
}
},
"type": "object"
},
"ResolveMode": {
"enum": ["independent", "shared"],
"type": "string"
},
"Scale": {
"additionalProperties": false,
"properties": {
"base": {
"description": "The logarithm base of the `log` scale (default `10`).",
"type": "number"
},
"clamp": {
"description": "If `true`, values that exceed the data domain are clamped to either the minimum or maximum range value\n\n__Default value:__ derived from the [scale config](config.html#scale-config)'s `clamp` (`true` by default).",
"type": "boolean"
},
"domain": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"type": "boolean"
},
"type": "array"
},
{
"items": {
"$ref": "#/definitions/DateTime"
},
"type": "array"
},
{
"enum": ["unaggregated"],
"type": "string"
},
{
"$ref": "#/definitions/SelectionDomain"
}
],
"description": "Customized domain values.\n\nFor _quantitative_ fields, `domain` can take the form of a two-element array with minimum and maximum values. [Piecewise scales](scale.html#piecewise) can be created by providing a `domain` with more than two entries.\nIf the input field is aggregated, `domain` can also be a string value `\"unaggregated\"`, indicating that the domain should include the raw data values prior to the aggregation.\n\nFor _temporal_ fields, `domain` can be a two-element array minimum and maximum values, in the form of either timestamps or the [DateTime definition objects](types.html#datetime).\n\nFor _ordinal_ and _nominal_ fields, `domain` can be an array that lists valid input values.\n\nThe `selection` property can be used to [interactively determine](selection.html#scale-domains) the scale domain."
},
"exponent": {
"description": "The exponent of the `pow` scale.",
"type": "number"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/definitions/Interpolate"
},
{
"$ref": "#/definitions/InterpolateParams"
}
],
"description": "The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include `rgb`, `hsl`, `hsl-long`, `lab`, `hcl`, `hcl-long`, `cubehelix` and `cubehelix-long` ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued _type_ property and an optional numeric _gamma_ property applicable to rgb and cubehelix interpolators. For more, see the [d3-interpolate documentation](https://github.com/d3/d3-interpolate)."
},
"nice": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "number"
},
{
"$ref": "#/definitions/NiceTime"
},
{
"additionalProperties": false,
"properties": {
"interval": {
"type": "string"
},
"step": {
"type": "number"
}
},
"required": ["interval", "step"],
"type": "object"
}
],
"description": "Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of _[0.201479…, 0.996679…]_, a nice domain might be _[0.2, 1.0]_.\n\nFor quantitative scales such as linear, `nice` can be either a boolean flag or a number. If `nice` is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.\n\nFor temporal fields with time and utc scales, the `nice` value can be a string indicating the desired time interval. Legal values are `\"millisecond\"`, `\"second\"`, `\"minute\"`, `\"hour\"`, `\"day\"`, `\"week\"`, `\"month\"`, and `\"year\"`. Alternatively, `time` and `utc` scales can accept an object-valued interval specifier of the form `{\"interval\": \"month\", \"step\": 3}`, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.\n\n__Default value:__ `true` for unbinned _quantitative_ fields; `false` otherwise."
},
"padding": {
"description": "For _[continuous](scale.html#continuous)_ scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.\n\nFor _[band](scale.html#band)_ scales, shortcut for setting `paddingInner` and `paddingOuter` to the same value.\n\nFor _[point](scale.html#point)_ scales, alias for `paddingOuter`.\n\n__Default value:__ For _continuous_ scales, derived from the [scale config](scale.html#config)'s `continuousPadding`.\nFor _band and point_ scales, see `paddingInner` and `paddingOuter`.",
"minimum": 0,
"type": "number"
},
"paddingInner": {
"description": "The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].\n\nFor point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).\n\n__Default value:__ derived from the [scale config](scale.html#config)'s `bandPaddingInner`.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"paddingOuter": {
"description": "The outer padding (spacing) at the ends of the range of band and point scales,\nas a fraction of the step size. This value must lie in the range [0,1].\n\n__Default value:__ derived from the [scale config](scale.html#config)'s `bandPaddingOuter` for band scales and `pointPadding` for point scales.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"range": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The range of the scale. One of:\n\n- A string indicating a [pre-defined named scale range](scale.html#range-config) (e.g., example, `\"symbol\"`, or `\"diverging\"`).\n\n- For [continuous scales](scale.html#continuous), two-element array indicating minimum and maximum values, or an array with more than two entries for specifying a [piecewise scale](scale.html#piecewise).\n\n- For [discrete](scale.html#discrete) and [discretizing](scale.html#discretizing) scales, an array of desired output values.\n\n__Notes:__\n\n1) For [sequential](scale.html#sequential), [ordinal](scale.html#ordinal), and discretizing color scales, you can also specify a color [`scheme`](scale.html#scheme) instead of `range`.\n\n2) Any directly specified `range` for `x` and `y` channels will be ignored. Range can be customized via the view's corresponding [size](size.html) (`width` and `height`) or via [range steps and paddings properties](#range-step) for [band](#band) and [point](#point) scales."
},
"rangeStep": {
"description": "The distance between the starts of adjacent bands or points in [band](scale.html#band) and [point](scale.html#point) scales.\n\nIf `rangeStep` is `null` or if the view contains the scale's corresponding [size](size.html) (`width` for `x` scales and `height` for `y` scales), `rangeStep` will be automatically determined to fit the size of the view.\n\n__Default value:__ derived the [scale config](config.html#scale-config)'s `textXRangeStep` (`90` by default) for x-scales of `text` marks and `rangeStep` (`21` by default) for x-scales of other marks and y-scales.\n\n__Warning__: If `rangeStep` is `null` and the cardinality of the scale's domain is higher than `width` or `height`, the rangeStep might become less than one pixel and the mark might not appear correctly.",
"minimum": 0,
"type": ["number", "null"]
},
"round": {
"description": "If `true`, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.\n\n__Default value:__ `false`.",
"type": "boolean"
},
"scheme": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/SchemeParams"
}
],
"description": "A string indicating a color [scheme](scale.html#scheme) name (e.g., `\"category10\"` or `\"viridis\"`) or a [scheme parameter object](scale.html#scheme-params).\n\nDiscrete color schemes may be used with [discrete](scale.html#discrete) or [discretizing](scale.html#discretizing) scales. Continuous color schemes are intended for use with [sequential](scales.html#sequential) scales.\n\nFor the full list of supported scheme, please refer to the [Vega Scheme](https://vega.github.io/vega/docs/schemes/#reference) reference."
},
"type": {
"$ref": "#/definitions/ScaleType",
"description": "The type of scale. Vega-Lite supports the following categories of scale types:\n\n1) [**Continuous Scales**](scale.html#continuous) -- mapping continuous domains to continuous output ranges ([`\"linear\"`](scale.html#linear), [`\"pow\"`](scale.html#pow), [`\"sqrt\"`](scale.html#sqrt), [`\"log\"`](scale.html#log), [`\"time\"`](scale.html#time), [`\"utc\"`](scale.html#utc), [`\"sequential\"`](scale.html#sequential)).\n\n2) [**Discrete Scales**](scale.html#discrete) -- mapping discrete domains to discrete ([`\"ordinal\"`](scale.html#ordinal)) or continuous ([`\"band\"`](scale.html#band) and [`\"point\"`](scale.html#point)) output ranges.\n\n3) [**Discretizing Scales**](scale.html#discretizing) -- mapping continuous domains to discrete output ranges ([`\"bin-linear\"`](scale.html#bin-linear) and [`\"bin-ordinal\"`](scale.html#bin-ordinal)).\n\n__Default value:__ please see the [scale type table](scale.html#type)."
},
"zero": {
"description": "If `true`, ensures that a zero baseline value is included in the scale domain.\n\n__Default value:__ `true` for x and y channels if the quantitative field is not binned and no custom `domain` is provided; `false` otherwise.\n\n__Note:__ Log, time, and utc scales do not support `zero`.",
"type": "boolean"
}
},
"type": "object"
},
"ScaleConfig": {
"additionalProperties": false,
"properties": {
"bandPaddingInner": {
"description": "Default inner padding for `x` and `y` band-ordinal scales.\n\n__Default value:__ `0.1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"bandPaddingOuter": {
"description": "Default outer padding for `x` and `y` band-ordinal scales.\nIf not specified, by default, band scale's paddingOuter is paddingInner/2.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"clamp": {
"description": "If true, values that exceed the data domain are clamped to either the minimum or maximum range value",
"type": "boolean"
},
"continuousPadding": {
"description": "Default padding for continuous scales.\n\n__Default:__ `5` for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; `0` otherwise.",
"minimum": 0,
"type": "number"
},
"maxBandSize": {
"description": "The default max value for mapping quantitative fields to bar's size/bandSize.\n\nIf undefined (default), we will use the scale's `rangeStep` - 1.",
"minimum": 0,
"type": "number"
},
"maxFontSize": {
"description": "The default max value for mapping quantitative fields to text's size/fontSize.\n\n__Default value:__ `40`",
"minimum": 0,
"type": "number"
},
"maxOpacity": {
"description": "Default max opacity for mapping a field to opacity.\n\n__Default value:__ `0.8`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"maxSize": {
"description": "Default max value for point size scale.",
"minimum": 0,
"type": "number"
},
"maxStrokeWidth": {
"description": "Default max strokeWidth for strokeWidth (or rule/line's size) scale.\n\n__Default value:__ `4`",
"minimum": 0,
"type": "number"
},
"minBandSize": {
"description": "The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.\n\n__Default value:__ `2`",
"minimum": 0,
"type": "number"
},
"minFontSize": {
"description": "The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false\n\n__Default value:__ `8`",
"minimum": 0,
"type": "number"
},
"minOpacity": {
"description": "Default minimum opacity for mapping a field to opacity.\n\n__Default value:__ `0.3`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"minSize": {
"description": "Default minimum value for point size scale with zero=false.\n\n__Default value:__ `9`",
"minimum": 0,
"type": "number"
},
"minStrokeWidth": {
"description": "Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.\n\n__Default value:__ `1`",
"minimum": 0,
"type": "number"
},
"pointPadding": {
"description": "Default outer padding for `x` and `y` point-ordinal scales.\n\n__Default value:__ `0.5`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"rangeStep": {
"description": "Default range step for band and point scales of (1) the `y` channel\nand (2) the `x` channel when the mark is not `text`.\n\n__Default value:__ `21`",
"minimum": 0,
"type": ["number", "null"]
},
"round": {
"description": "If true, rounds numeric output values to integers.\nThis can be helpful for snapping to the pixel grid.\n(Only available for `x`, `y`, and `size` scales.)",
"type": "boolean"
},
"textXRangeStep": {
"description": "Default range step for `x` band and point scales of text marks.\n\n__Default value:__ `90`",
"minimum": 0,
"type": "number"
},
"useUnaggregatedDomain": {
"description": "Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.\n\nThis is equivalent to setting `domain` to `\"unaggregate\"` for aggregated _quantitative_ fields by default.\n\nThis property only works with aggregate functions that produce values within the raw data domain (`\"mean\"`, `\"average\"`, `\"median\"`, `\"q1\"`, `\"q3\"`, `\"min\"`, `\"max\"`). For other aggregations that produce values outside of the raw data domain (e.g. `\"count\"`, `\"sum\"`), this property is ignored.\n\n__Default value:__ `false`",
"type": "boolean"
}
},
"type": "object"
},
"ScaleFieldDef": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"scale": {
"$ref": "#/definitions/Scale",
"description": "An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.\n\n__Default value:__ If undefined, default [scale properties](scale.html) are applied."
},
"sort": {
"anyOf": [
{
"$ref": "#/definitions/SortOrder"
},
{
"$ref": "#/definitions/SortField"
},
{
"type": "null"
}
],
"description": "Sort order for the encoded field.\nSupported `sort` values include `\"ascending\"`, `\"descending\"` and `null` (no sorting).\nFor fields with discrete domains, `sort` can also be a [sort field definition object](sort.html#sort-field).\n\n__Default value:__ `\"ascending\"`"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"ScaleResolveMap": {
"additionalProperties": false,
"properties": {
"color": {
"$ref": "#/definitions/ResolveMode"
},
"opacity": {
"$ref": "#/definitions/ResolveMode"
},
"shape": {
"$ref": "#/definitions/ResolveMode"
},
"size": {
"$ref": "#/definitions/ResolveMode"
},
"x": {
"$ref": "#/definitions/ResolveMode"
},
"y": {
"$ref": "#/definitions/ResolveMode"
}
},
"type": "object"
},
"ScaleType": {
"enum": [
"linear",
"bin-linear",
"log",
"pow",
"sqrt",
"time",
"utc",
"sequential",
"ordinal",
"bin-ordinal",
"point",
"band"
],
"type": "string"
},
"SchemeParams": {
"additionalProperties": false,
"properties": {
"extent": {
"description": "For sequential and diverging schemes only, determines the extent of the color range to use. For example `[0.2, 1]` will rescale the color scheme such that color values in the range _[0, 0.2)_ are excluded from the scheme.",
"items": {
"type": "number"
},
"type": "array"
},
"name": {
"description": "A color scheme name for sequential/ordinal scales (e.g., `\"category10\"` or `\"viridis\"`).\n\nFor the full list of supported scheme, please refer to the [Vega Scheme](https://vega.github.io/vega/docs/schemes/#reference) reference.",
"type": "string"
}
},
"required": ["name"],
"type": "object"
},
"SelectionConfig": {
"additionalProperties": false,
"properties": {
"interval": {
"$ref": "#/definitions/IntervalSelectionConfig",
"description": "The default definition for an [`interval`](selection.html#type) selection. All properties and transformations\nfor an interval selection definition (except `type`) may be specified here.\n\nFor instance, setting `interval` to `{\"translate\": false}` disables the ability to move\ninterval selections by default."
},
"multi": {
"$ref": "#/definitions/MultiSelectionConfig",
"description": "The default definition for a [`multi`](selection.html#type) selection. All properties and transformations\nfor a multi selection definition (except `type`) may be specified here.\n\nFor instance, setting `multi` to `{\"toggle\": \"event.altKey\"}` adds additional values to\nmulti selections when clicking with the alt-key pressed by default."
},
"single": {
"$ref": "#/definitions/SingleSelectionConfig",
"description": "The default definition for a [`single`](selection.html#type) selection. All properties and transformations\n for a single selection definition (except `type`) may be specified here.\n\nFor instance, setting `single` to `{\"on\": \"dblclick\"}` populates single selections on double-click by default."
}
},
"type": "object"
},
"SelectionDef": {
"anyOf": [
{
"$ref": "#/definitions/SingleSelection"
},
{
"$ref": "#/definitions/MultiSelection"
},
{
"$ref": "#/definitions/IntervalSelection"
}
]
},
"SelectionDomain": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"field": {
"description": "The field name to extract selected values for, when a selection is [projected](project.html)\nover multiple fields or encodings.",
"type": "string"
},
"selection": {
"description": "The name of a selection.",
"type": "string"
}
},
"required": ["selection"],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"encoding": {
"description": "The encoding channel to extract selected values for, when a selection is [projected](project.html)\nover multiple fields or encodings.",
"type": "string"
},
"selection": {
"description": "The name of a selection.",
"type": "string"
}
},
"required": ["selection"],
"type": "object"
}
]
},
"SelectionFilter": {
"additionalProperties": false,
"properties": {
"selection": {
"$ref": "#/definitions/SelectionOperand",
"description": "Filter using a selection name."
}
},
"required": ["selection"],
"type": "object"
},
"SelectionResolution": {
"enum": ["global", "union", "intersect"],
"type": "string"
},
"SingleDefChannel": {
"enum": [
"x",
"y",
"x2",
"y2",
"row",
"column",
"size",
"shape",
"color",
"opacity",
"text",
"tooltip"
],
"type": "string"
},
"SingleSelection": {
"additionalProperties": false,
"properties": {
"bind": {
"anyOf": [
{
"$ref": "#/definitions/VgBinding"
},
{
"additionalProperties": {
"$ref": "#/definitions/VgBinding"
},
"type": "object"
}
],
"description": "Establish a two-way binding between a single selection and input elements\n(also known as dynamic query widgets). A binding takes the form of\nVega's [input element binding definition](https://vega.github.io/vega/docs/signals/#bind)\nor can be a mapping between projected field/encodings and binding definitions.\n\nSee the [bind transform](bind.html) documentation for more information."
},
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"nearest": {
"description": "When true, an invisible voronoi diagram is computed to accelerate discrete\nselection. The data value _nearest_ the mouse cursor is added to the selection.\n\nSee the [nearest transform](nearest.html) documentation for more information.",
"type": "boolean"
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
},
"type": {
"enum": ["single"],
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
"SingleSelectionConfig": {
"additionalProperties": false,
"properties": {
"bind": {
"anyOf": [
{
"$ref": "#/definitions/VgBinding"
},
{
"additionalProperties": {
"$ref": "#/definitions/VgBinding"
},
"type": "object"
}
],
"description": "Establish a two-way binding between a single selection and input elements\n(also known as dynamic query widgets). A binding takes the form of\nVega's [input element binding definition](https://vega.github.io/vega/docs/signals/#bind)\nor can be a mapping between projected field/encodings and binding definitions.\n\nSee the [bind transform](bind.html) documentation for more information."
},
"empty": {
"description": "By default, all data values are considered to lie within an empty selection.\nWhen set to `none`, empty selections contain no data values.",
"enum": ["all", "none"],
"type": "string"
},
"encodings": {
"description": "An array of encoding channels. The corresponding data field values\nmust match for a data tuple to fall within the selection.",
"items": {
"$ref": "#/definitions/SingleDefChannel"
},
"type": "array"
},
"fields": {
"description": "An array of field names whose values must match for a data tuple to\nfall within the selection.",
"items": {
"type": "string"
},
"type": "array"
},
"nearest": {
"description": "When true, an invisible voronoi diagram is computed to accelerate discrete\nselection. The data value _nearest_ the mouse cursor is added to the selection.\n\nSee the [nearest transform](nearest.html) documentation for more information.",
"type": "boolean"
},
"on": {
"$ref": "#/definitions/VgEventStream",
"description": "A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.\nFor interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters)."
},
"resolve": {
"$ref": "#/definitions/SelectionResolution",
"description": "With layered and multi-view displays, a strategy that determines how\nselections' data queries are resolved when applied in a filter transform,\nconditional encoding rule, or scale domain."
}
},
"type": "object"
},
"SingleTimeUnit": {
"anyOf": [
{
"$ref": "#/definitions/LocalSingleTimeUnit"
},
{
"$ref": "#/definitions/UtcSingleTimeUnit"
}
]
},
"SortField": {
"additionalProperties": false,
"properties": {
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "The data [field](field.html) to sort by.\n\n__Default value:__ If unspecified, defaults to the field specified in the outer data reference."
},
"op": {
"$ref": "#/definitions/AggregateOp",
"description": "An [aggregate operation](aggregate.html#ops) to perform on the field prior to sorting (e.g., `\"count\"`, `\"mean\"` and `\"median\"`).\nThis property is required in cases where the sort field and the data reference field do not match.\nThe input data objects will be aggregated, grouped by the encoded data field.\n\nFor a full list of operations, please see the documentation for [aggregate](aggregate.html#ops)."
},
"order": {
"$ref": "#/definitions/SortOrder",
"description": "The sort order. One of `\"ascending\"` (default) or `\"descending\"`."
}
},
"required": ["op"],
"type": "object"
},
"SortOrder": {
"anyOf": [
{
"enum": ["ascending"],
"type": "string"
},
{
"enum": ["descending"],
"type": "string"
},
{
"type": "null"
}
]
},
"StackOffset": {
"enum": ["zero", "center", "normalize"],
"type": "string"
},
"StyleConfigIndex": {
"additionalProperties": {
"$ref": "#/definitions/VgMarkConfig"
},
"type": "object"
},
"TextConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"color": {
"description": "Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "string"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `true` for all marks except `point` and `false` for `point`.\n\n__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.",
"type": "boolean"
},
"size": {
"description": "The pixel area each the point/circle/square.\nFor example: in the case of circles, the radius is determined in part by the square root of the size value.\n\n__Default value:__ `30`",
"minimum": 0,
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
}
},
"type": "object"
},
"TextFieldDef": {
"additionalProperties": false,
"properties": {
"aggregate": {
"$ref": "#/definitions/Aggregate",
"description": "Aggregation function for the field\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).\n\n__Default value:__ `undefined` (None)"
},
"bin": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/BinParams"
}
],
"description": "A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).\nIf `true`, default [binning parameters](bin.html) will be applied.\n\n__Default value:__ `false`"
},
"field": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/RepeatRef"
}
],
"description": "__Required.__ A string defining the name of the field from which to pull a data value\nor an object defining iterated values from the [`repeat`](repeat.html) operator.\n\n__Note:__ `field` is not required if `aggregate` is `count`."
},
"format": {
"description": "The [formatting pattern](format.html) for a text field. If not defined, this will be determined automatically.",
"type": "string"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.\nor [a temporal field that gets casted as ordinal](type.html#cast).\n\n__Default value:__ `undefined` (None)"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, or `\"nominal\"`)."
}
},
"required": ["type"],
"type": "object"
},
"TickConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"bandSize": {
"description": "The width of the ticks.\n\n__Default value:__ 2/3 of rangeStep.",
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"color": {
"description": "Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "string"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `true` for all marks except `point` and `false` for `point`.\n\n__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.\n\n__Note:__ This property cannot be used in a [style config](mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "The pixel area each the point/circle/square.\nFor example: in the case of circles, the radius is determined in part by the square root of the size value.\n\n__Default value:__ `30`",
"minimum": 0,
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
},
"thickness": {
"description": "Thickness of the tick mark.\n\n__Default value:__ `1`",
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"TimeUnit": {
"anyOf": [
{
"$ref": "#/definitions/SingleTimeUnit"
},
{
"$ref": "#/definitions/MultiTimeUnit"
}
]
},
"TimeUnitTransform": {
"additionalProperties": false,
"properties": {
"as": {
"description": "The output field to write the timeUnit value.",
"type": "string"
},
"field": {
"description": "The data field to apply time unit.",
"type": "string"
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "The timeUnit."
}
},
"required": ["timeUnit", "field", "as"],
"type": "object"
},
"TitleBase": {
"additionalProperties": false,
"properties": {
"anchor": {
"$ref": "#/definitions/Anchor",
"description": "The anchor position for placing the title. One of `\"start\"`, `\"middle\"`, or `\"end\"`. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.\n\n__Default value:__ `\"middle\"` for [single](spec.html) and [layered](layer.html) views.\n`\"start\"` for other composite views.\n\n__Note:__ [For now](https://github.com/vega/vega-lite/issues/2875), `anchor` is only customizable only for [single](spec.html) and [layered](layer.html) views. For other composite views, `anchor` is always `\"start\"`."
},
"offset": {
"description": "The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.",
"type": "number"
},
"orient": {
"$ref": "#/definitions/TitleOrient",
"description": "The orientation of the title relative to the chart. One of `\"top\"` (the default), `\"bottom\"`, `\"left\"`, or `\"right\"`."
},
"style": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "A [mark style property](config.html#style) to apply to the title text mark.\n\n__Default value:__ `\"group-title\"`."
}
},
"type": "object"
},
"TitleOrient": {
"enum": ["top", "bottom", "left", "right"],
"type": "string"
},
"TitleParams": {
"additionalProperties": false,
"properties": {
"anchor": {
"$ref": "#/definitions/Anchor",
"description": "The anchor position for placing the title. One of `\"start\"`, `\"middle\"`, or `\"end\"`. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.\n\n__Default value:__ `\"middle\"` for [single](spec.html) and [layered](layer.html) views.\n`\"start\"` for other composite views.\n\n__Note:__ [For now](https://github.com/vega/vega-lite/issues/2875), `anchor` is only customizable only for [single](spec.html) and [layered](layer.html) views. For other composite views, `anchor` is always `\"start\"`."
},
"offset": {
"description": "The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.",
"type": "number"
},
"orient": {
"$ref": "#/definitions/TitleOrient",
"description": "The orientation of the title relative to the chart. One of `\"top\"` (the default), `\"bottom\"`, `\"left\"`, or `\"right\"`."
},
"style": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "A [mark style property](config.html#style) to apply to the title text mark.\n\n__Default value:__ `\"group-title\"`."
},
"text": {
"description": "The title text.",
"type": "string"
}
},
"required": ["text"],
"type": "object"
},
"TopLevel<FacetedUnitSpec>": {
"additionalProperties": false,
"properties": {
"$schema": {
"description": "URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.",
"format": "uri",
"type": "string"
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"config": {
"$ref": "#/definitions/Config",
"description": "Vega-Lite configuration object. This property can only be defined at the top-level of a specification."
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"encoding": {
"$ref": "#/definitions/EncodingWithFacet",
"description": "A key-value mapping between encoding channels and definition of fields."
},
"height": {
"description": "The height of a visualization.\n\n__Default value:__\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).\n- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).\n- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.\n\n__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
},
"mark": {
"$ref": "#/definitions/AnyMark",
"description": "A string describing the mark type (one of `\"bar\"`, `\"circle\"`, `\"square\"`, `\"tick\"`, `\"line\"`,\n`\"area\"`, `\"point\"`, `\"rule\"`, and `\"text\"`) or a [mark definition object](mark.html#mark-def)."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"selection": {
"additionalProperties": {
"$ref": "#/definitions/SelectionDef"
},
"description": "A key-value mapping between selection names and definitions.",
"type": "object"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"width": {
"description": "The width of a visualization.\n\n__Default value:__ This will be determined by the following rules:\n\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).\n- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).\n- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.\n\n__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
}
},
"required": ["encoding", "mark"],
"type": "object"
},
"TopLevel<FacetSpec>": {
"additionalProperties": false,
"properties": {
"$schema": {
"description": "URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.",
"format": "uri",
"type": "string"
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"config": {
"$ref": "#/definitions/Config",
"description": "Vega-Lite configuration object. This property can only be defined at the top-level of a specification."
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"facet": {
"$ref": "#/definitions/FacetMapping",
"description": "An object that describes mappings between `row` and `column` channels and their field definitions."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for facets."
},
"spec": {
"anyOf": [
{
"$ref": "#/definitions/LayerSpec"
},
{
"$ref": "#/definitions/CompositeUnitSpec"
}
],
"description": "A specification of the view that gets faceted."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"required": ["facet", "spec"],
"type": "object"
},
"TopLevel<HConcatSpec>": {
"additionalProperties": false,
"properties": {
"$schema": {
"description": "URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.",
"format": "uri",
"type": "string"
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"config": {
"$ref": "#/definitions/Config",
"description": "Vega-Lite configuration object. This property can only be defined at the top-level of a specification."
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"hconcat": {
"description": "A list of views that should be concatenated and put into a row.",
"items": {
"$ref": "#/definitions/Spec"
},
"type": "array"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for horizontally concatenated charts."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"required": ["hconcat"],
"type": "object"
},
"TopLevel<LayerSpec>": {
"additionalProperties": false,
"properties": {
"$schema": {
"description": "URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.",
"format": "uri",
"type": "string"
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"config": {
"$ref": "#/definitions/Config",
"description": "Vega-Lite configuration object. This property can only be defined at the top-level of a specification."
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"height": {
"description": "The height of a visualization.\n\n__Default value:__\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).\n- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).\n- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.\n\n__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
},
"layer": {
"description": "Layer or single view specifications to be layered.\n\n__Note__: Specifications inside `layer` cannot use `row` and `column` channels as layering facet specifications is not allowed.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/LayerSpec"
},
{
"$ref": "#/definitions/CompositeUnitSpec"
}
]
},
"type": "array"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for layers."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"width": {
"description": "The width of a visualization.\n\n__Default value:__ This will be determined by the following rules:\n\n- If a view's [`autosize`](size.html#autosize) type is `\"fit\"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).\n- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).\n- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.\n\n__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.\n\n__See also:__ The documentation for [width and height](size.html) contains more examples.",
"type": "number"
}
},
"required": ["layer"],
"type": "object"
},
"TopLevel<RepeatSpec>": {
"additionalProperties": false,
"properties": {
"$schema": {
"description": "URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.",
"format": "uri",
"type": "string"
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"config": {
"$ref": "#/definitions/Config",
"description": "Vega-Lite configuration object. This property can only be defined at the top-level of a specification."
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"repeat": {
"$ref": "#/definitions/Repeat",
"description": "An object that describes what fields should be repeated into views that are laid out as a `row` or `column`."
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale and legend resolutions for repeated charts."
},
"spec": {
"$ref": "#/definitions/Spec"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
}
},
"required": ["repeat", "spec"],
"type": "object"
},
"TopLevel<VConcatSpec>": {
"additionalProperties": false,
"properties": {
"$schema": {
"description": "URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.",
"format": "uri",
"type": "string"
},
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"config": {
"$ref": "#/definitions/Config",
"description": "Vega-Lite configuration object. This property can only be defined at the top-level of a specification."
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"description": {
"description": "Description of this mark for commenting purpose.",
"type": "string"
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
},
"resolve": {
"$ref": "#/definitions/Resolve",
"description": "Scale, axis, and legend resolutions for vertically concatenated charts."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/TitleParams"
}
],
"description": "Title for the plot."
},
"transform": {
"description": "An array of data transformations such as filter and new field calculation.",
"items": {
"$ref": "#/definitions/Transform"
},
"type": "array"
},
"vconcat": {
"description": "A list of views that should be concatenated and put into a column.",
"items": {
"$ref": "#/definitions/Spec"
},
"type": "array"
}
},
"required": ["vconcat"],
"type": "object"
},
"TopLevelExtendedSpec": {
"anyOf": [
{
"$ref": "#/definitions/TopLevel<FacetedUnitSpec>"
},
{
"$ref": "#/definitions/TopLevel<LayerSpec>"
},
{
"$ref": "#/definitions/TopLevel<FacetSpec>"
},
{
"$ref": "#/definitions/TopLevel<RepeatSpec>"
},
{
"$ref": "#/definitions/TopLevel<VConcatSpec>"
},
{
"$ref": "#/definitions/TopLevel<HConcatSpec>"
}
]
},
"TopLevelProperties": {
"additionalProperties": false,
"properties": {
"autosize": {
"anyOf": [
{
"$ref": "#/definitions/AutosizeType"
},
{
"$ref": "#/definitions/AutoSizeParams"
}
],
"description": "Sets how the visualization size should be determined. If a string, should be one of `\"pad\"`, `\"fit\"` or `\"none\"`.\nObject values can additionally specify parameters for content sizing and automatic resizing.\n`\"fit\"` is only supported for single and layered views that don't use `rangeStep`.\n\n__Default value__: `pad`"
},
"background": {
"description": "CSS color property to use as the background of visualization.\n\n__Default value:__ none (transparent)",
"type": "string"
},
"padding": {
"$ref": "#/definitions/Padding",
"description": "The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.\nIf an object, the value should have the format `{\"left\": 5, \"top\": 5, \"right\": 5, \"bottom\": 5}` to specify padding for each side of the visualization.\n\n__Default value__: `5`"
}
},
"type": "object"
},
"TopoDataFormat": {
"additionalProperties": false,
"properties": {
"feature": {
"description": "The name of the TopoJSON object set to convert to a GeoJSON feature collection.\nFor example, in a map of the world, there may be an object set named `\"countries\"`.\nUsing the feature property, we can extract this set and generate a GeoJSON feature object for each country.",
"type": "string"
},
"mesh": {
"description": "The name of the TopoJSON object set to convert to mesh.\nSimilar to the `feature` option, `mesh` extracts a named TopoJSON object set.\n Unlike the `feature` option, the corresponding geo data is returned as a single, unified mesh instance, not as individual GeoJSON features.\nExtracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties.",
"type": "string"
},
"parse": {
"anyOf": [
{
"enum": ["auto"],
"type": "string"
},
{
"type": "object"
}
],
"description": "If set to auto (the default), perform automatic type inference to determine the desired data types.\nAlternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `\"number\"`, `\"boolean\"` or `\"date\"`).\nFor example, `\"parse\": {\"modified_on\": \"date\"}` parses the `modified_on` field in each input record a Date value.\n\nFor `\"date\"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).\nFor Specific date formats can be provided (e.g., `{foo: 'date:\"%m%d%Y\"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:\"%m%d%Y\"'}`). See more about [UTC time](timeunit.html#utc)"
},
"type": {
"description": "Type of input data: `\"json\"`, `\"csv\"`, `\"tsv\"`.\nThe default format type is determined by the extension of the file URL.\nIf no extension is detected, `\"json\"` will be used by default.",
"enum": ["topojson"],
"type": "string"
}
},
"type": "object"
},
"Transform": {
"anyOf": [
{
"$ref": "#/definitions/FilterTransform"
},
{
"$ref": "#/definitions/CalculateTransform"
},
{
"$ref": "#/definitions/LookupTransform"
},
{
"$ref": "#/definitions/BinTransform"
},
{
"$ref": "#/definitions/TimeUnitTransform"
},
{
"$ref": "#/definitions/AggregateTransform"
}
]
},
"Type": {
"description": "Constants and utilities for data type \n Data type based on level of measurement ",
"enum": ["quantitative", "ordinal", "temporal", "nominal"],
"type": "string"
},
"UrlData": {
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/definitions/DataFormat",
"description": "An object that specifies the format for parsing the data file."
},
"url": {
"description": "An URL from which to load the data set. Use the `format.type` property\nto ensure the loaded data is correctly parsed.",
"type": "string"
}
},
"required": ["url"],
"type": "object"
},
"UtcMultiTimeUnit": {
"enum": [
"utcyearquarter",
"utcyearquartermonth",
"utcyearmonth",
"utcyearmonthdate",
"utcyearmonthdatehours",
"utcyearmonthdatehoursminutes",
"utcyearmonthdatehoursminutesseconds",
"utcquartermonth",
"utcmonthdate",
"utchoursminutes",
"utchoursminutesseconds",
"utcminutesseconds",
"utcsecondsmilliseconds"
],
"type": "string"
},
"UtcSingleTimeUnit": {
"enum": [
"utcyear",
"utcquarter",
"utcmonth",
"utcday",
"utcdate",
"utchours",
"utcminutes",
"utcseconds",
"utcmilliseconds"
],
"type": "string"
},
"VLOnlyConfig": {
"additionalProperties": false,
"properties": {
"countTitle": {
"description": "Default axis and legend title for count fields.\n\n__Default value:__ `'Number of Records'`.",
"type": "string"
},
"fieldTitle": {
"description": "Defines how Vega-Lite generates title for fields. There are three possible styles:\n- `\"verbal\"` (Default) - displays function in a verbal style (e.g., \"Sum of field\", \"Year-month of date\", \"field (binned)\").\n- `\"function\"` - displays function using parentheses and capitalized texts (e.g., \"SUM(field)\", \"YEARMONTH(date)\", \"BIN(field)\").\n- `\"plain\"` - displays only the field name without functions (e.g., \"field\", \"date\", \"field\").",
"enum": ["verbal", "functional", "plain"],
"type": "string"
},
"invalidValues": {
"description": "Defines how Vega-Lite should handle invalid values (`null` and `NaN`).\n- If set to `\"filter\"` (default), all data items with null values are filtered.\n- If `null`, all data items are included. In this case, invalid values will be interpreted as zeroes.",
"enum": ["filter"],
"type": "string"
},
"numberFormat": {
"description": "D3 Number format for axis labels and text tables. For example \"s\" for SI units. Use [D3's number format pattern](https://github.com/d3/d3-format#locale_format).",
"type": "string"
},
"scale": {
"$ref": "#/definitions/ScaleConfig",
"description": "Scale configuration determines default properties for all [scales](scale.html). For a full list of scale configuration options, please see the [corresponding section of the scale documentation](scale.html#config)."
},
"selection": {
"$ref": "#/definitions/SelectionConfig",
"description": "An object hash for defining default properties for each type of selections. "
},
"stack": {
"$ref": "#/definitions/StackOffset",
"description": "Default stack offset for stackable mark. "
},
"timeFormat": {
"description": "Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use [D3's time format pattern](https://github.com/d3/d3-time-format#locale_format).\n\n__Default value:__ `'%b %d, %Y'`.",
"type": "string"
},
"view": {
"$ref": "#/definitions/ViewConfig",
"description": "Default properties for [single view plots](spec.html#single). "
}
},
"type": "object"
},
"ValueDef": {
"additionalProperties": false,
"description": "Definition object for a constant value of an encoding channel.",
"properties": {
"value": {
"description": "A constant value in visual domain (e.g., `\"red\"` / \"#0099ff\" for color, values between `0` to `1` for opacity).",
"type": ["number", "string", "boolean"]
}
},
"required": ["value"],
"type": "object"
},
"MarkPropValueDefWithCondition": {
"additionalProperties": false,
"description": "A ValueDef with Condition<ValueDef | FieldDef>\n{\n condition: {field: ...} | {value: ...},\n value: ...,\n}",
"properties": {
"condition": {
"anyOf": [
{
"$ref": "#/definitions/Conditional<MarkPropFieldDef>"
},
{
"$ref": "#/definitions/Conditional<ValueDef>"
},
{
"items": {
"$ref": "#/definitions/Conditional<ValueDef>"
},
"type": "array"
}
],
"description": "A field definition or one or more value definition(s) with a selection predicate."
},
"value": {
"description": "A constant value in visual domain.",
"type": ["number", "string", "boolean"]
}
},
"type": "object"
},
"TextValueDefWithCondition": {
"additionalProperties": false,
"description": "A ValueDef with Condition<ValueDef | FieldDef>\n{\n condition: {field: ...} | {value: ...},\n value: ...,\n}",
"properties": {
"condition": {
"anyOf": [
{
"$ref": "#/definitions/Conditional<TextFieldDef>"
},
{
"$ref": "#/definitions/Conditional<ValueDef>"
},
{
"items": {
"$ref": "#/definitions/Conditional<ValueDef>"
},
"type": "array"
}
],
"description": "A field definition or one or more value definition(s) with a selection predicate."
},
"value": {
"description": "A constant value in visual domain.",
"type": ["number", "string", "boolean"]
}
},
"type": "object"
},
"VerticalAlign": {
"enum": ["top", "middle", "bottom"],
"type": "string"
},
"VgAxisBase": {
"additionalProperties": false,
"description": "Base object for Vega's Axis and Axis Config.\nAll of these properties are both properties of Vega's Axis and Axis Config.",
"properties": {
"domain": {
"description": "A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.\n\n__Default value:__ `true`",
"type": "boolean"
},
"grid": {
"description": "A boolean flag indicating if grid lines should be included as part of the axis\n\n__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.",
"type": "boolean"
},
"labelAngle": {
"description": "The rotation angle of the axis labels.\n\n__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.",
"maximum": 360,
"minimum": -360,
"type": "number"
},
"labelBound": {
"description": "Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.\n\n__Default value:__ `false`.",
"type": ["boolean", "number"]
},
"labelFlush": {
"description": "Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.\n\n__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.",
"type": ["boolean", "number"]
},
"labelOverlap": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": ["parity"],
"type": "string"
},
{
"enum": ["greedy"],
"type": "string"
}
],
"description": "The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `\"parity\"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `\"greedy\"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).\n\n__Default value:__ `true` for non-nominal fields with non-log scales; `\"greedy\"` for log scales; otherwise `false`."
},
"labelPadding": {
"description": "The padding, in pixels, between axis and text labels.",
"type": "number"
},
"labels": {
"description": "A boolean flag indicating if labels should be included as part of the axis.\n\n__Default value:__ `true`.",
"type": "boolean"
},
"maxExtent": {
"description": "The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.\n\n__Default value:__ `undefined`.",
"type": "number"
},
"minExtent": {
"description": "The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.\n\n__Default value:__ `30` for y-axis; `undefined` for x-axis.",
"type": "number"
},
"tickSize": {
"description": "The size in pixels of axis ticks.",
"minimum": 0,
"type": "number"
},
"ticks": {
"description": "Boolean value that determines whether the axis should include ticks.",
"type": "boolean"
},
"titleMaxLength": {
"description": "Max length for axis title if the title is automatically generated from the field's description.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and axis.",
"type": "number"
}
},
"type": "object"
},
"VgAxisConfig": {
"additionalProperties": false,
"properties": {
"bandPosition": {
"description": "An interpolation fraction indicating where, for `band` scales, axis ticks should be positioned. A value of `0` places ticks at the left edge of their bands. A value of `0.5` places ticks in the middle of their bands.",
"type": "number"
},
"domain": {
"description": "A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.\n\n__Default value:__ `true`",
"type": "boolean"
},
"domainColor": {
"description": "Color of axis domain line.\n\n__Default value:__ (none, using Vega default).",
"type": "string"
},
"domainWidth": {
"description": "Stroke width of axis domain line\n\n__Default value:__ (none, using Vega default).",
"type": "number"
},
"grid": {
"description": "A boolean flag indicating if grid lines should be included as part of the axis\n\n__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.",
"type": "boolean"
},
"gridColor": {
"description": "Color of gridlines.",
"type": "string"
},
"gridDash": {
"description": "The offset (in pixels) into which to begin drawing with the grid dash array.",
"items": {
"type": "number"
},
"type": "array"
},
"gridOpacity": {
"description": "The stroke opacity of grid (value between [0,1])\n\n__Default value:__ (`1` by default)",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"gridWidth": {
"description": "The grid width, in pixels.",
"minimum": 0,
"type": "number"
},
"labelAngle": {
"description": "The rotation angle of the axis labels.\n\n__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.",
"maximum": 360,
"minimum": -360,
"type": "number"
},
"labelBound": {
"description": "Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.\n\n__Default value:__ `false`.",
"type": ["boolean", "number"]
},
"labelColor": {
"description": "The color of the tick label, can be in hex color code or regular color name.",
"type": "string"
},
"labelFlush": {
"description": "Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.\n\n__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.",
"type": ["boolean", "number"]
},
"labelFont": {
"description": "The font of the tick label.",
"type": "string"
},
"labelFontSize": {
"description": "The font size of the label, in pixels.",
"minimum": 0,
"type": "number"
},
"labelLimit": {
"description": "Maximum allowed pixel width of axis tick labels.",
"type": "number"
},
"labelOverlap": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": ["parity"],
"type": "string"
},
{
"enum": ["greedy"],
"type": "string"
}
],
"description": "The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `\"parity\"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `\"greedy\"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).\n\n__Default value:__ `true` for non-nominal fields with non-log scales; `\"greedy\"` for log scales; otherwise `false`."
},
"labelPadding": {
"description": "The padding, in pixels, between axis and text labels.",
"type": "number"
},
"labels": {
"description": "A boolean flag indicating if labels should be included as part of the axis.\n\n__Default value:__ `true`.",
"type": "boolean"
},
"maxExtent": {
"description": "The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.\n\n__Default value:__ `undefined`.",
"type": "number"
},
"minExtent": {
"description": "The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.\n\n__Default value:__ `30` for y-axis; `undefined` for x-axis.",
"type": "number"
},
"tickColor": {
"description": "The color of the axis's tick.",
"type": "string"
},
"tickRound": {
"description": "Boolean flag indicating if pixel position values should be rounded to the nearest integer.",
"type": "boolean"
},
"tickSize": {
"description": "The size in pixels of axis ticks.",
"minimum": 0,
"type": "number"
},
"tickWidth": {
"description": "The width, in pixels, of ticks.",
"minimum": 0,
"type": "number"
},
"ticks": {
"description": "Boolean value that determines whether the axis should include ticks.",
"type": "boolean"
},
"titleAlign": {
"description": "Horizontal text alignment of axis titles.",
"type": "string"
},
"titleAngle": {
"description": "Angle in degrees of axis titles.",
"type": "number"
},
"titleBaseline": {
"description": "Vertical text baseline for axis titles.",
"type": "string"
},
"titleColor": {
"description": "Color of the title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "Font of the title. (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"titleFontSize": {
"description": "Font size of the title.",
"minimum": 0,
"type": "number"
},
"titleFontWeight": {
"description": "Font weight of the title. (e.g., `\"bold\"`).",
"type": ["string", "number"]
},
"titleLimit": {
"description": "Maximum allowed pixel width of axis titles.",
"type": "number"
},
"titleMaxLength": {
"description": "Max length for axis title if the title is automatically generated from the field's description.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and axis.",
"type": "number"
},
"titleX": {
"description": "X-coordinate of the axis title relative to the axis group.",
"type": "number"
},
"titleY": {
"description": "Y-coordinate of the axis title relative to the axis group.",
"type": "number"
}
},
"type": "object"
},
"VgBinding": {
"anyOf": [
{
"$ref": "#/definitions/VgCheckboxBinding"
},
{
"$ref": "#/definitions/VgRadioBinding"
},
{
"$ref": "#/definitions/VgSelectBinding"
},
{
"$ref": "#/definitions/VgRangeBinding"
},
{
"$ref": "#/definitions/VgGenericBinding"
}
]
},
"VgCheckboxBinding": {
"additionalProperties": false,
"properties": {
"element": {
"type": "string"
},
"input": {
"enum": ["checkbox"],
"type": "string"
}
},
"required": ["input"],
"type": "object"
},
"VgEventStream": {},
"VgGenericBinding": {
"additionalProperties": false,
"properties": {
"element": {
"type": "string"
},
"input": {
"type": "string"
}
},
"required": ["input"],
"type": "object"
},
"VgLegendBase": {
"additionalProperties": false,
"properties": {
"entryPadding": {
"description": "Padding (in pixels) between legend entries in a symbol legend.",
"type": "number"
},
"offset": {
"description": "The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.\n\n__Default value:__ `0`",
"type": "number"
},
"orient": {
"$ref": "#/definitions/LegendOrient",
"description": "The orientation of the legend, which determines how the legend is positioned within the scene. One of \"left\", \"right\", \"top-left\", \"top-right\", \"bottom-left\", \"bottom-right\", \"none\".\n\n__Default value:__ `\"right\"`"
},
"padding": {
"description": "The padding, in pixels, between the legend and axis.",
"type": "number"
}
},
"type": "object"
},
"VgLegendConfig": {
"additionalProperties": false,
"properties": {
"cornerRadius": {
"description": "Corner radius for the full legend.",
"type": "number"
},
"entryPadding": {
"description": "Padding (in pixels) between legend entries in a symbol legend.",
"type": "number"
},
"fillColor": {
"description": "Background fill color for the full legend.",
"type": "string"
},
"gradientHeight": {
"description": "The height of the gradient, in pixels.",
"minimum": 0,
"type": "number"
},
"gradientLabelBaseline": {
"description": "Text baseline for color ramp gradient labels.",
"type": "string"
},
"gradientLabelLimit": {
"description": "The maximum allowed length in pixels of color ramp gradient labels.",
"type": "number"
},
"gradientLabelOffset": {
"description": "Vertical offset in pixels for color ramp gradient labels.",
"type": "number"
},
"gradientStrokeColor": {
"description": "The color of the gradient stroke, can be in hex color code or regular color name.",
"type": "string"
},
"gradientStrokeWidth": {
"description": "The width of the gradient stroke, in pixels.",
"minimum": 0,
"type": "number"
},
"gradientWidth": {
"description": "The width of the gradient, in pixels.",
"minimum": 0,
"type": "number"
},
"labelAlign": {
"description": "The alignment of the legend label, can be left, middle or right.",
"type": "string"
},
"labelBaseline": {
"description": "The position of the baseline of legend label, can be top, middle or bottom.",
"type": "string"
},
"labelColor": {
"description": "The color of the legend label, can be in hex color code or regular color name.",
"type": "string"
},
"labelFont": {
"description": "The font of the legend label.",
"type": "string"
},
"labelFontSize": {
"description": "The font size of legend label.\n\n__Default value:__ `10`.",
"minimum": 0,
"type": "number"
},
"labelLimit": {
"description": "Maximum allowed pixel width of axis tick labels.",
"type": "number"
},
"labelOffset": {
"description": "The offset of the legend label.",
"minimum": 0,
"type": "number"
},
"offset": {
"description": "The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.\n\n__Default value:__ `0`",
"type": "number"
},
"orient": {
"$ref": "#/definitions/LegendOrient",
"description": "The orientation of the legend, which determines how the legend is positioned within the scene. One of \"left\", \"right\", \"top-left\", \"top-right\", \"bottom-left\", \"bottom-right\", \"none\".\n\n__Default value:__ `\"right\"`"
},
"padding": {
"description": "The padding, in pixels, between the legend and axis.",
"type": "number"
},
"strokeColor": {
"description": "Border stroke color for the full legend.",
"type": "string"
},
"strokeDash": {
"description": "Border stroke dash pattern for the full legend.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeWidth": {
"description": "Border stroke width for the full legend.",
"type": "number"
},
"symbolColor": {
"description": "The color of the legend symbol,",
"type": "string"
},
"symbolSize": {
"description": "The size of the legend symbol, in pixels.",
"minimum": 0,
"type": "number"
},
"symbolStrokeWidth": {
"description": "The width of the symbol's stroke.",
"minimum": 0,
"type": "number"
},
"symbolType": {
"description": "Default shape type (such as \"circle\") for legend symbols.",
"type": "string"
},
"titleAlign": {
"description": "Horizontal text alignment for legend titles.",
"type": "string"
},
"titleBaseline": {
"description": "Vertical text baseline for legend titles.",
"type": "string"
},
"titleColor": {
"description": "The color of the legend title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "The font of the legend title.",
"type": "string"
},
"titleFontSize": {
"description": "The font size of the legend title.",
"type": "number"
},
"titleFontWeight": {
"description": "The font weight of the legend title.",
"type": ["string", "number"]
},
"titleLimit": {
"description": "Maximum allowed pixel width of axis titles.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and legend.",
"type": "number"
}
},
"type": "object"
},
"VgMarkConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"minimum": 0,
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "The font weight (e.g., `\"bold\"`)."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"limit": {
"description": "The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "The default symbol shape to use. One of: `\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, or `\"triangle-down\"`, or a custom SVG path.\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "The pixel area each the point/circle/square.\nFor example: in the case of circles, the radius is determined in part by the square root of the size value.\n\n__Default value:__ `30`",
"minimum": 0,
"type": "number"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color\n\n__Default value:__ (None)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"text": {
"description": "Placeholder text if the `text` channel is not specified",
"type": "string"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
}
},
"type": "object"
},
"VgRadioBinding": {
"additionalProperties": false,
"properties": {
"element": {
"type": "string"
},
"input": {
"enum": ["radio"],
"type": "string"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": ["input", "options"],
"type": "object"
},
"VgRangeBinding": {
"additionalProperties": false,
"properties": {
"element": {
"type": "string"
},
"input": {
"enum": ["range"],
"type": "string"
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"step": {
"type": "number"
}
},
"required": ["input"],
"type": "object"
},
"VgScheme": {
"additionalProperties": false,
"properties": {
"count": {
"type": "number"
},
"extent": {
"items": {
"type": "number"
},
"type": "array"
},
"scheme": {
"type": "string"
}
},
"required": ["scheme"],
"type": "object"
},
"VgSelectBinding": {
"additionalProperties": false,
"properties": {
"element": {
"type": "string"
},
"input": {
"enum": ["select"],
"type": "string"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": ["input", "options"],
"type": "object"
},
"VgTitleConfig": {
"additionalProperties": false,
"properties": {
"anchor": {
"$ref": "#/definitions/Anchor",
"description": "The anchor position for placing the title. One of `\"start\"`, `\"middle\"`, or `\"end\"`. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.\n\n__Default value:__ `\"middle\"` for [single](spec.html) and [layered](layer.html) views.\n`\"start\"` for other composite views.\n\n__Note:__ [For now](https://github.com/vega/vega-lite/issues/2875), `anchor` is only customizable only for [single](spec.html) and [layered](layer.html) views. For other composite views, `anchor` is always `\"start\"`."
},
"angle": {
"description": "Angle in degrees of title text.",
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "Vertical text baseline for title text."
},
"color": {
"description": "Text color for title text.",
"type": "string"
},
"font": {
"description": "Font name for title text.",
"type": "string"
},
"fontSize": {
"description": "Font size in pixels for title text.\n\n__Default value:__ `10`.",
"minimum": 0,
"type": "number"
},
"fontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight"
},
{
"$ref": "#/definitions/FontWeightNumber"
}
],
"description": "Font weight for title text."
},
"limit": {
"description": "The maximum allowed length in pixels of legend labels.",
"minimum": 0,
"type": "number"
},
"offset": {
"description": "Offset in pixels of the title from the chart body and axes.",
"type": "number"
},
"orient": {
"$ref": "#/definitions/TitleOrient",
"description": "Default title orientation (\"top\", \"bottom\", \"left\", or \"right\")"
}
},
"type": "object"
},
"ViewConfig": {
"additionalProperties": false,
"properties": {
"clip": {
"description": "Whether the view should be clipped.",
"type": "boolean"
},
"fill": {
"description": "The fill color.\n\n__Default value:__ (none)",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ (none)",
"type": "number"
},
"height": {
"description": "The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with `rangeStep` = `null`.\n\n__Default value:__ `200`",
"type": "number"
},
"stroke": {
"description": "The stroke color.\n\n__Default value:__ (none)",
"type": "string"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.\n\n__Default value:__ (none)",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.\n\n__Default value:__ (none)",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ (none)",
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.\n\n__Default value:__ (none)",
"type": "number"
},
"width": {
"description": "The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with `rangeStep` = `null`.\n\n__Default value:__ `200`",
"type": "number"
}
},
"type": "object"
},
"VlOnlyGuideConfig": {
"additionalProperties": false,
"properties": {
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.\n\n__Default value:__ `false`",
"type": "boolean"
}
},
"type": "object"
}
},
"id": "https://json.schemastore.org/vega-lite.json"
}
|
pyrseas-0.8.json | {
"$id": "https://json.schemastore.org/pyrseas-0.8.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"onePriv": {
"oneOf": [
{
"type": "string",
"enum": [
"all",
"insert",
"delete",
"select",
"update",
"truncate",
"references",
"trigger",
"usage",
"execute",
"create"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"all": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"insert": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"delete": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"select": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"update": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"truncate": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"references": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"trigger": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"usage": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"execute": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"create": {
"additionalProperties": false,
"properties": {
"grantable": {
"type": "boolean"
}
}
}
}
}
]
},
"privileges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/definitions/onePriv"
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"grantor": {
"type": "string"
},
"privs": {
"type": "array",
"items": {
"$ref": "#/definitions/onePriv"
}
}
}
}
]
}
}
},
"db": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^schema ": {
"$ref": "#/definitions/schema"
},
"^cast ": {
"type": "object",
"additionalProperties": false,
"properties": {
"context": {
"type": "string"
},
"method": {
"type": "string"
},
"description": {
"type": "string"
},
"function": {
"type": "string"
},
"depends_on": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"^extension ": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"owner": {
"type": "string"
},
"schema": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"^event trigger ": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"type": "string"
},
"procedure": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"owner": {
"type": "string"
}
}
},
"^foreign data wrapper ": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"validator": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
},
"handler": {
"type": "string"
},
"owner": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
}
}
},
"^language ": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"trusted": {
"type": "boolean"
},
"owner": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
}
}
}
}
},
"schema": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^table ": {
"type": "object",
"additionalProperties": false,
"properties": {
"owner": {
"type": "string"
},
"description": {
"type": "string"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"default": {
"type": "string"
},
"not_null": {
"type": "boolean"
},
"inherited": {
"type": "boolean"
},
"collation": {
"type": "string"
},
"statistics": {
"type": "integer"
},
"identity": {
"type": "string",
"enum": ["always", "by default"]
},
"description": {
"type": "string"
}
}
}
}
},
"unique_constraints": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
}
}
}
},
"foreign_keys": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"on_delete": {
"type": "string"
},
"on_update": {
"type": "string"
},
"description": {
"type": "string"
},
"references": {
"type": "object",
"additionalProperties": false,
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"schema": {
"type": "string"
},
"table": {
"type": "string"
}
}
}
}
}
},
"check_constraints": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"expression": {
"type": "string"
},
"inherited": {
"type": "boolean"
},
"description": {
"type": "string"
}
}
}
},
"primary_key": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"cluster": {
"type": "boolean"
}
}
}
},
"indexes": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"keys": {
"type": "array",
"items": {
"type": "string"
}
},
"access_method": {
"type": "string"
},
"unique": {
"type": "boolean"
},
"description": {
"type": "string"
}
}
}
},
"triggers": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"level": {
"type": "string"
},
"procedure": {
"type": "string"
},
"timing": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"inherits": {
"type": "array",
"items": {
"type": "string"
}
},
"unlogged": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
},
"partition_bound_spec": {
"type": "string"
},
"partition_by": {
"type": "string"
},
"partition_cols": {
"type": "array",
"items": {
"type": "string"
}
},
"partition_exprs": {
"type": "string"
},
"tablespace": {
"type": "string"
},
"rules": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"actions": {
"type": "string"
},
"condition": {
"type": "string"
},
"event": {
"type": "string"
},
"instead": {
"type": "boolean"
},
"depends_on": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
}
}
}
},
"privileges": {
"$ref": "#/definitions/privileges"
},
"depends_on": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"^aggregate ": {
"type": "object",
"additionalProperties": false,
"properties": {
"owner": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
},
"sfunc": {
"type": "string"
},
"stype": {
"type": "string"
},
"sspace": {
"type": "integer"
},
"finalfunc": {
"type": "string"
},
"finalfunc_extra": {
"type": "boolean"
},
"initcond": {
"type": "string"
},
"sortop": {
"type": "string"
},
"msfunc": {
"type": "string"
},
"minvfunc": {
"type": "string"
},
"mstype": {
"type": "string"
},
"msspace": {
"type": "integer"
},
"mfinalfunc": {
"type": "string"
},
"mfinalfunc_extra": {
"type": "boolean"
},
"minitcond": {
"type": "string"
},
"kind": {
"type": "string"
},
"combinefunc": {
"type": "string"
},
"serialfunc": {
"type": "string"
},
"deseriafunc": {
"type": "string"
},
"parallel": {
"type": "string"
},
"arguments": {
"type": "string"
}
}
},
"^domain ": {
"type": "object",
"additionalProperties": false,
"properties": {
"owner": {
"type": "string"
},
"type": {
"type": "string"
},
"not_null": {
"type": "boolean"
},
"default": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"check_constraints": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"expression": {
"type": "string"
},
"depends_on": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"^function ": {
"type": "object",
"additionalProperties": false,
"properties": {
"language": {
"type": "string"
},
"owner": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
},
"returns": {
"type": "string"
},
"source": {
"type": "string"
},
"volatility": {
"type": "string"
},
"strict": {
"type": "boolean"
},
"security_definer": {
"type": "boolean"
},
"description": {
"type": "string"
},
"obj_file": {
"type": "string"
},
"link_symbol": {
"type": "string"
},
"configuration": {
"type": "array",
"items": {
"type": "string"
}
},
"arguments": {
"type": "string"
},
"cost": {
"type": "integer"
},
"rows": {
"type": "integer"
},
"leakproof": {
"type": "boolean"
}
}
},
"^sequence ": {
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"cache_value": {
"type": "integer"
},
"increment_by": {
"type": "integer"
},
"max_value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string",
"const": "null"
}
]
},
"min_value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string",
"const": "null"
}
]
},
"owner": {
"type": "string"
},
"start_value": {
"type": "integer"
},
"owner_table": {
"type": "string"
},
"owner_column": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
},
"data_type": {
"type": "string"
}
}
},
"^type ": {
"type": "object",
"additionalProperties": false,
"description": "5 types: Base Type, Composite, Enum, Domain, Range",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"owner": {
"type": "string"
},
"description": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"oldname": {
"type": "string"
}
}
}
}
},
"subtype": {
"type": "string"
},
"oldname": {
"type": "string"
},
"input": {
"type": "string"
},
"output": {
"type": "string"
},
"internallength": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"alignment": {
"type": "string"
},
"storage": {
"type": "string"
},
"category": {
"type": "string"
},
"subtype_diff": {
"type": "string"
},
"type": {
"type": "string"
},
"not_null": {
"type": "boolean"
},
"default": {
"type": "string"
},
"canonical": {
"type": "string"
},
"receive": {
"type": "string"
},
"send": {
"type": "string"
},
"typmod_in": {
"type": "string"
},
"typmod_out": {
"type": "string"
},
"analyze": {
"type": "string"
},
"delimiter": {
"type": "string"
},
"preferred": {
"type": "boolean"
}
}
},
"^view ": {
"type": "object",
"additionalProperties": false,
"properties": {
"definition": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "string"
},
"depends_on": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"^foreign table ": {
"type": "object",
"additionalProperties": false,
"properties": {
"owner": {
"type": "string"
},
"description": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
}
}
}
}
},
"server": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"^collation ": {
"type": "object",
"additionalProperties": false,
"properties": {
"lc_collate": {
"type": "string"
},
"lc_ctype": {
"type": "string"
},
"owner": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"properties": {
"owner": {
"type": "string"
},
"description": {
"type": "string"
},
"privileges": {
"$ref": "#/definitions/privileges"
}
}
}
},
"oneOf": [
{
"$ref": "#/definitions/db"
},
{
"$ref": "#/definitions/schema"
}
],
"title": "JSON schema for Pyrseas yaml files"
}
|
fulibWorkflows.schema.json | {
"$schema": "https://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/fujaba/fulibWorkflows/main/schemas/fulibWorkflows.schema.json",
"title": "JSON schema for fulibWorkflows ",
"description": "Schema for the generation file of fulibWorkflows",
"type": "array",
"additionalItems": false,
"$defs": {
"workflowItem": {
"description": "The title of your current workflow",
"type": "object",
"properties": {
"workflow": {
"type": "string"
}
},
"required": [
"workflow"
],
"additionalProperties": false
},
"externalSystemItem": {
"description": "Can be used to address data coming from another source",
"type": "object",
"properties": {
"externalSystem": {
"type": "string"
}
},
"required": [
"externalSystem"
],
"additionalProperties": false
},
"serviceItem": {
"description": "The service on which the following events are executed",
"type": "object",
"properties": {
"service": {
"type": "string"
}
},
"required": [
"service"
],
"additionalProperties": false
},
"commandItem": {
"description": "A command send by a user",
"type": "object",
"properties": {
"command": {
"type": "string"
}
},
"required": [
"command"
],
"additionalProperties": false
},
"eventItem": {
"description": "An event signalling that some system state is reached",
"type": "object",
"properties": {
"event": {
"type": "string"
}
},
"required": [
"event"
]
},
"policyItem": {
"description": "The following steps define the reaction of a service to some triggering command or event",
"type": "object",
"properties": {
"policy": {
"type": "string"
}
},
"required": [
"policy"
],
"additionalProperties": false
},
"userItem": {
"description": "Defines the user who is going to perform an action",
"type": "object",
"properties": {
"user": {
"type": "string"
}
},
"required": [
"user"
],
"additionalProperties": false
},
"dataItem": {
"description": "data object created within a service",
"type": "object",
"properties": {
"data": {
"type": "string"
}
},
"required": [
"data"
]
},
"pageItem": {
"description": "Defines a ui page",
"type": "object",
"properties": {
"page": {
"$ref": "page.schema.json"
}
},
"required": [
"page"
],
"additionalProperties": false
},
"problemItem": {
"description": "Shows a problem/question in the workflow",
"type": "object",
"properties": {
"problem": {
"type": "string"
}
},
"required": [
"problem"
],
"additionalProperties": false
},
"divItem": {
"description": "Defines a ui page",
"type": "object",
"properties": {
"div": {
"$ref": "div.schema.json"
}
},
"required": [
"div"
],
"additionalProperties": false
}
},
"items": {
"oneOf": [
{
"$ref": "#/$defs/workflowItem"
},
{
"$ref": "#/$defs/externalSystemItem"
},
{
"$ref": "#/$defs/serviceItem"
},
{
"$ref": "#/$defs/commandItem"
},
{
"$ref": "#/$defs/eventItem"
},
{
"$ref": "#/$defs/policyItem"
},
{
"$ref": "#/$defs/userItem"
},
{
"$ref": "#/$defs/dataItem"
},
{
"$ref": "#/$defs/pageItem"
},
{
"$ref": "#/$defs/problemItem"
},
{
"$ref": "#/$defs/divItem"
}
]
}
}
|
haystack-pipeline.schema.json | {
"$id": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline.schema.json",
"$schema": "http://json-schema.org/draft-07/schema",
"description": "Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions",
"oneOf": [
{
"allOf": [
{
"properties": {
"version": {
"const": "ignore"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-main.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.0.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.0.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.1.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.1.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.2.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.2.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.3.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.3.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.4.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.4.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.4.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.4.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.4.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.4.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.5.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.5.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.5.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.5.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.6.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.6.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.7.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.7.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.7.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack/master/haystack/json-schemas/haystack-pipeline-1.7.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.7.2"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.7.2.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.8.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.8.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.9.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.9.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.9.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.9.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.10.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.10.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.11.0rc0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-1.11.0rc0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.11.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.11.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.12.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.12.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.12.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.12.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.12.2"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.12.2.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.13.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.13.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.13.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.13.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.13.2"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.13.2.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.14.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.14.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.15.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.15.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.15.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.15.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.16.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.16.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.16.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.16.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.17.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.17.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.17.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.17.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.17.2"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.17.2.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.18.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.18.0.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.18.1"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.18.1.schema.json"
}
]
},
{
"allOf": [
{
"properties": {
"version": {
"const": "1.19.0"
}
}
},
{
"$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.19.0.schema.json"
}
]
}
],
"title": "Haystack Pipeline",
"type": "object"
} |
jsbeautifyrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"allOf": [
{
"$ref": "#/definitions/CHJProperties"
},
{
"$ref": "#/definitions/HJProperties"
},
{
"$ref": "#/definitions/CProperties"
},
{
"$ref": "#/definitions/HProperties"
},
{
"$ref": "#/definitions/JProperties"
}
],
"definitions": {
"CHJProperties": {
"type": "object",
"properties": {
"indent_size": {
"description": "Indent size. [JS,CSS,HTML]",
"type": "integer",
"default": 4
},
"indent_char": {
"description": "Indentation character. [JS,CSS,HTML]",
"type": "string",
"default": " ",
"maxLength": 1
},
"eol": {
"description": "Character(s) to use as line terminators. [JS,CSS,HTML]",
"type": "string",
"default": "\n"
},
"indent_with_tabs": {
"description": "Indent with tabs, overrides 'indent_size' and 'indent_char' [JS,CSS,HTML]",
"type": "boolean",
"default": false
},
"end_with_newline": {
"description": "Ensure newline at end of file. [JS,CSS,HTML]",
"type": "boolean",
"default": false
},
"preserve_newlines": {
"description": "Preserve line-breaks. [JS,CSS,HTML]",
"type": "boolean",
"default": true
}
}
},
"HJProperties": {
"type": "object",
"properties": {
"max_preserve_newlines": {
"description": "Number of line-breaks to be preserved in one chunk. [JS,HTML]",
"type": "integer",
"default": 10
},
"brace_style": {
"description": "[collapse|expand|end-expand|none][,preserve-inline] [JS,HTML]",
"type": "string",
"default": "collapse",
"enum": [
"collapse",
"expand",
"end-expand",
"none",
"collapse,preserve-inline",
"expand,preserve-inline",
"end-expand,preserve-inline",
"none,preserve-inline"
]
},
"wrap_line_length": {
"description": "Wrap lines at next opportunity after N characters. [JS,HTML]",
"type": "integer",
"default": 0
}
}
},
"CProperties": {
"type": "object",
"properties": {
"selector_separator_newline": {
"description": "Add a newline between multiple selectors. [CSS]",
"type": "boolean",
"default": true
},
"newline_between_rules": {
"description": "Add a newline between CSS rules. [CSS]",
"type": "boolean",
"default": false
},
"space_around_selector_separator": {
"description": "(Deprecated: use space_around_combinator) [CSS]",
"type": "boolean",
"default": false
},
"space_around_combinator": {
"description": "Ensure space around selector separators (>+~). [CSS]",
"type": "boolean",
"default": false
}
}
},
"HProperties": {
"type": "object",
"properties": {
"void_elements": {
"description": "HTLM void elements - aka self-closing tags. [HTML]",
"type": "array",
"items": {
"type": "string"
},
"default": [
"area",
"base",
"br",
"col",
"embed",
"hr",
"img",
"input",
"keygen",
"link",
"menuitem",
"meta",
"param",
"source",
"track",
"wbr",
"!doctype",
"?xml",
"?php",
"basefont",
"isindex"
]
},
"wrap_attributes": {
"description": "Wrap attributes to new lines. [HTML]",
"type": "string",
"default": "auto",
"enum": ["auto", "force", "force-aligned", "force-expand-multiline"]
},
"wrap_attributes_indent_size": {
"description": "Indent wrapped attributes to after N characters. Defaults to 'indent_size'. [HTML]",
"type": "number"
},
"indent_inner_html": {
"description": "Indent <head> and <body> sections. [HTML]",
"type": "boolean",
"default": false
},
"indent_scripts": {
"description": "[keep|separate|normal] [HTML]",
"type": "string",
"default": "normal",
"enum": ["keep", "separate", "normal"]
},
"unformatted": {
"description": "List of tags that should not be reformatted. [HTML]",
"type": "array",
"items": {
"type": "string"
},
"default": [
"a",
"abbr",
"area",
"audio",
"b",
"bdi",
"bdo",
"br",
"button",
"canvas",
"cite",
"code",
"data",
"datalist",
"del",
"dfn",
"em",
"embed",
"i",
"iframe",
"img",
"input",
"ins",
"kbd",
"keygen",
"label",
"map",
"mark",
"math",
"meter",
"noscript",
"object",
"output",
"progress",
"q",
"ruby",
"s",
"samp",
"select",
"small",
"span",
"strong",
"sub",
"sup",
"svg",
"template",
"textarea",
"time",
"u",
"var",
"video",
"wbr",
"text",
"acronym",
"address",
"big",
"dt",
"ins",
"strike",
"tt"
]
},
"content_unformatted": {
"description": "List of tags whose content should not be reformatted. [HTML]",
"type": "array",
"items": {
"type": "string"
},
"default": ["pre"]
},
"extra_liners": {
"description": "List of tags that should have an extra newline before them. [HTML]",
"type": "array",
"items": {
"type": "string"
},
"default": ["head", "body", "/html"]
},
"indent_body_inner_html": {
"description": "Indent elements within html <body> element. [HTML]",
"type": "boolean",
"default": true
},
"indent_head_inner_html": {
"description": "Indent elements within html <head> element. [HTML]",
"type": "boolean",
"default": true
},
"indent_handlebars": {
"description": "format and indent {{#foo}} and {{/foo}}. [HTML]",
"type": "boolean",
"default": false
}
}
},
"JProperties": {
"type": "object",
"properties": {
"indent_level": {
"description": "Initial indentation level. [JS]",
"type": "integer",
"default": 0
},
"space_in_paren": {
"description": "Add padding spaces within parentheses, ie. f( a, b ). [JS]",
"type": "boolean",
"default": false
},
"space_in_empty_paren": {
"description": "Leave space in empty parentheses, ie. f( ). [JS]",
"type": "boolean",
"default": false
},
"jslint_happy": {
"description": "Enable jslint-stricter mode. (Forces 'space_after_anon_function') [JS]",
"type": "boolean",
"default": false
},
"space_after_anon_function": {
"description": "Add a space before an anonymous function's parens, ie. function (). [JS]",
"type": "boolean",
"default": false
},
"break_chained_methods": {
"description": "Break chained method calls across subsequent lines. [JS]",
"type": "boolean",
"default": false
},
"keep_array_indentation": {
"description": "Preserve array indentation. [JS]",
"type": "boolean",
"default": false
},
"keep_function_indentation": {
"description": "Preserve function indentation. [JS]",
"type": "boolean",
"default": false
},
"space_before_conditional": {
"description": "Ensure a space before conditional statement. [JS]",
"type": "boolean",
"default": true
},
"unescape_strings": {
"description": "Decode printable characters encoded in xNN notation. [JS]",
"type": "boolean",
"default": false
},
"comma_first": {
"description": "Put commas at the beginning of new line instead of end. [JS]",
"type": "boolean",
"default": false
},
"operator_position": {
"description": "Move operators to before or after a new line, or keep as is. [JS]",
"type": "string",
"enum": ["before-newline", "after-newline", "preserve-newline"],
"default": "before-newline"
},
"e4x": {
"description": "Pass E4X xml literals through untouched. [JS]",
"type": "boolean",
"default": false
},
"unindent_chained_methods": {
"description": "Unindent chained methods. [JS]",
"type": "boolean",
"default": false
}
}
}
},
"id": "https://json.schemastore.org/jsbeautifyrc",
"title": "JSON schema for beautifyrc",
"type": "object"
}
|
crowdin.json | {
"$comment": "https://support.crowdin.com/configuration-file/",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configuration for Crowdin, a crowd-translation platform.",
"id": "https://json.schemastore.org/crowdin.json",
"properties": {
"project_id": {
"title": "Project ID",
"type": "string"
},
"project_id_env": {
"title": "Project ID Environment Variable",
"type": "string"
},
"api_token": {
"title": "API Token",
"type": "string"
},
"api_token_env": {
"title": "API Token Environment Variable",
"type": "string"
},
"base_path": {
"title": "Base Path",
"type": "string"
},
"base_path_env": {
"title": "Base Path Environment Variable",
"type": "string"
},
"base_url": {
"title": "Base URL",
"type": "string",
"format": "uri"
},
"base_url_env": {
"title": "Base URL Environment Variable",
"type": "string"
},
"preserve_hierarchy": {
"title": "Preserve Hierarchy",
"type": "boolean"
},
"commit_message": {
"title": "Commit Message",
"type": "string"
},
"append_commit_message": {
"title": "Append Commit Message",
"description": "Replace the default commit message with the one specified in commit_message.",
"type": "boolean"
},
"export_languages": {
"title": "Export Languages",
"description": "Specify a list of specific languages to export.",
"type": "array",
"items": {
"title": "Language",
"type": "string"
}
},
"files": {
"title": "Files",
"type": "array",
"items": {
"title": "File",
"type": "object",
"properties": {
"source": {
"title": "Source",
"type": "string"
},
"translation": {
"title": "Translation",
"type": "string"
},
"ignore": {
"title": "Ignore",
"type": "array",
"items": {
"type": "string"
}
},
"translation_replace": {
"title": "Translation Replace",
"additionalProperties": {
"type": "string"
}
},
"excluded_target_languages": {
"title": "Excluded Target Languages",
"type": "array",
"items": {
"title": "Excluded Target Language",
"type": "string"
}
},
"scheme": {
"title": "Scheme",
"type": "string"
},
"dest": {
"title": "Destination",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
},
"update_option": {
"title": "Update Option",
"enum": ["update_as_unapproved", "update_without_changes"]
},
"translate_content": {
"title": "Translate Content",
"description": "Defines whether to translate texts placed inside the tags.",
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 1
},
"translate_attributes": {
"title": "Translate Attributes",
"description": "Defines whether to translate tags' attributes.",
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 1
},
"content_segmentation": {
"title": "Content Segmentation",
"description": "Defines whether to split long texts into smaller text segments.",
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 1
},
"translatable_elements": {
"title": "Translatable Elements",
"description": "An array of strings, where each item is the XPaths to DOM element that should be imported. ",
"type": "array",
"items": {
"title": "Translatable Element",
"type": "string"
}
},
"skip_untranslated_strings": {
"title": "Skip Untranslated Strings",
"type": "boolean"
},
"skip_untranslated_files": {
"title": "Skip Untranslated Files",
"type": "boolean"
},
"export_only_approved": {
"title": "Export Only Approved",
"type": "boolean"
},
"escape_quotes": {
"title": "Escape Quotes",
"description": "Defines whether a single quote should be escaped by another single quote or backslash in exported translations.",
"type": "number",
"minimum": 0,
"maximum": 3,
"default": 3
},
"escape_special_characters": {
"title": "Escape Sepcial Characters",
"description": "Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.",
"type": "number",
"minimum": 0,
"maximum": 1,
"default": 1
},
"first_line_contains_header": {
"title": "First Line Contains Header",
"type": "boolean"
},
"languages_mapping": {
"title": "Language Mapping",
"properties": {
"two_letters_code": {
"additionalProperties": {
"type": "string"
}
},
"android_code": {
"additionalProperties": {
"type": "string"
}
}
}
},
"labels": {
"title": "Labels",
"type": "array",
"items": {
"title": "Label",
"type": "string"
}
}
}
}
}
},
"type": "object"
}
|
lego.json | {
"$defs": {
"file": {
"oneOf": [
{
"description": "This object or string represents the file format",
"type": "string"
},
{
"description": "This object or string represents the file format",
"type": "null"
},
{
"$ref": "#/$defs/fileFormat",
"description": "This object or string represents the file format"
}
]
},
"fileFormat": {
"description": "This object represents a file format",
"type": "object",
"properties": {
"name": {
"description": "Name of block file",
"type": "string"
},
"template": {
"description": "Path to file template",
"type": "string"
}
},
"required": ["name"]
}
},
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://json.schemastore.org/lego.json",
"properties": {
"blocks": {
"description": "An array of your app's blocks.",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "The name of the block type",
"type": "string"
},
"path": {
"description": "Path relative to root where the block will be stored",
"type": "string"
},
"isFile": {
"description": "Is this a file? or a folder? False by default.",
"type": "boolean"
},
"files": {
"description": "Files making up the block",
"type": "array",
"items": {
"$ref": "#/$defs/file"
}
},
"file": {
"$ref": "#/$defs/file"
}
},
"required": ["type", "path"]
}
},
"fileFormats": {
"description": "An object mapping file objects to strings",
"type": "object",
"patternProperties": {
".*": {
"$ref": "#/$defs/fileFormat"
}
}
}
},
"required": ["blocks"],
"type": "object"
}
|
project-1.0.0-rc1.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
},
"emitEntryPoint": {
"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
},
"useOssSigning": {
"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"]
},
"target": {
"type": "string",
"description": "Restrict this dependency to matching only a Project or a Package",
"enum": ["project", "package"]
}
}
}
},
"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-rc1.json",
"properties": {
"authors": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"packInclude": {
"description": "Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { \"tools/\": \"tools/**/*.*\" }",
"type": "object"
},
"publishExclude": {
"description": "Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["obj/**/*.*", "bin/**/*.*", "**/.*/**"]
},
"compile": {
"description": "Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**/*.cs"
},
"compileExclude": {
"description": "Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"compileFiles": {
"description": "Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"content": {
"description": "Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**/*"
},
"contentExclude": {
"description": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"contentFiles": {
"description": "Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"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": "Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ \"Folder1/*.ext\", \"Folder2/*.ext\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["compiler/resources/**/*", "**/*.resx"]
},
"resourceExclude": {
"description": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"resourceFiles": {
"description": "Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ \"Folder1/File1.ext\", \"Folder2/File2.ext\" ]",
"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": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
}
},
"excludeBuiltIn": {
"description": "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\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["bin/**", "obj/**", "**/*.xproj"]
},
"commands": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"configurations": {
"type": "object",
"description": "Configurations are named groups of compilation settings. There are two defaults built into the runtime: '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 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
},
"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": {
"description": "A space-delimited list of tags and keywords that describe the package.",
"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 project/package.",
"type": "string"
},
"frameworks": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configType"
}
},
"namedResource": {
"type": "object",
"description": "Overrides the generated resource names with custom ones.",
"additionalProperties": {
"type": "string"
}
},
"repository": {
"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"
}
},
"scripts": {
"type": "object",
"description": "Scripts to execute during the various stages.",
"properties": {
"prebuild": {
"$ref": "#/definitions/script"
},
"postbuild": {
"$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"
}
},
"title": "JSON schema for DNX project.json files",
"type": "object"
}
|
sponge-mixins.json | {
"$id": "https://json.schemastore.org/sponge-mixins.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"mixin_class": {
"type": "string",
"description": "The dot-separated path to the mixin class relative to the specified package. The class must be annotated with @Mixin"
},
"injector_options": {
"type": "object",
"description": "Injection options",
"properties": {
"defaultRequire": {
"type": "integer",
"minimum": 0,
"description": "Sets the default minimum of injections that must be successfully applied per injector",
"default": 0
},
"defaultGroup": {
"type": "string",
"description": "Sets the default injector group",
"default": "default"
},
"injectionPoints": {
"type": "array",
"description": "Registers injection points for this configuration",
"items": {
"type": "string"
}
},
"maxShiftBy": {
"type": "integer",
"minimum": 0,
"maximum": 5,
"default": 5,
"description": "Sets the maximum allowed number of opcodes that can be shifted in @At annotations. This is hard capped at 5"
}
}
},
"overwrite_options": {
"type": "object",
"description": "Overwrite options",
"properties": {
"conformVisibility": {
"type": "boolean",
"description": "Sets whether the visibility of overwritten methods should be conformed to the target class"
},
"requireAnnotations": {
"type": "boolean",
"default": true,
"description": "Sets whether overwriting methods must explicitly be declared through @Overwrite annotations"
}
}
}
},
"properties": {
"parent": {
"type": "string",
"description": "The name of a parent configuration that options get inherited from"
},
"target": {
"type": "string",
"description": "Target selector. Either the specifies the phase directly or use \"@env(PHASE)\" separated by '&', '\\', or ' '"
},
"minVersion": {
"type": "string",
"pattern": "^(\\d{1,5})(?:\\.(\\d{1,5})(?:\\.(\\d{1,5})(?:\\.(\\d{1,5}))?)?)?(-[a-zA-Z0-9_\\-]+)?$",
"description": "Minimum version of the mixin subsystem required for this configuration"
},
"compatibilityLevel": {
"type": "string",
"description": "Minimum compatibility level required for mixins in this set"
},
"required": {
"type": "boolean",
"description": "Determines whether mixin failures in this configuration are considered terminal and stop the game"
},
"priority": {
"type": "integer",
"description": "The priority of this configuration. Will be inherited if smaller than 0",
"default": -1
},
"mixinPriority": {
"type": "integer",
"description": "Default mixin priority for this configuration. Will be inherited if smaller than 0",
"default": -1
},
"package": {
"type": "string",
"description": "The target package where the mixin classes reside"
},
"mixins": {
"type": "array",
"description": "Mixin classes to load in all environments. Class names get prepended with the specified package",
"items": {
"$ref": "#/definitions/mixin_class"
}
},
"client": {
"type": "array",
"description": "Mixin classes to load ONLY on client. Class names get prepended with the specified package",
"items": {
"$ref": "#/definitions/mixin_class"
}
},
"server": {
"type": "array",
"description": "Mixin classes to load ONLY on server. Class names get prepended with the specified package",
"items": {
"$ref": "#/definitions/mixin_class"
}
},
"setSourceFile": {
"type": "boolean",
"description": "Sets whether targets' source files will be updated to the mixin source file"
},
"refmap": {
"type": "string",
"description": "The path to the reference map resource to use for this configuration"
},
"verbose": {
"type": "boolean",
"description": "Increases log detail level from DEBUG to INFO",
"default": false
},
"plugin": {
"type": "string",
"description": "Name of the mixin config plugin to use for this config"
},
"injectors": {
"$ref": "#/definitions/injector_options"
},
"overwrites": {
"$ref": "#/definitions/overwrite_options"
}
},
"required": ["package"],
"type": "object"
}
|
jshintrc.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://json.schemastore.org/jshintrc",
"properties": {
"bitwise": {
"description": "Prohibit the use of bitwise operators (&, |, ^, etc.)",
"type": "boolean",
"default": false
},
"curly": {
"description": "Requires you to always put curly braces around blocks in loops and conditionals",
"type": "boolean",
"default": false
},
"eqeqeq": {
"description": "Prohibits the use of `==` and `!=` in favor of `===` and `!==`",
"type": "boolean",
"default": false
},
"esversion": {
"description": "The ECMAScript version to which the code must adhere",
"type": "integer",
"default": 5,
"enum": [3, 5, 6, 7, 8, 9, 10, 11]
},
"forin": {
"description": "Requires all `for in` loops to filter object's items with obj.hasOwnProperty()",
"type": "boolean",
"default": false
},
"freeze": {
"description": "Prohibits overwriting prototypes of native objects such as Array, Date and so on",
"type": "boolean",
"default": false
},
"funcscope": {
"description": "Suppresses warnings about declaring variables inside of control structures while accessing them later from the outside",
"type": "boolean",
"default": false
},
"futurehostile": {
"description": "Enables warnings about the use of identifiers which are defined in future versions of JavaScript",
"type": "boolean",
"default": false
},
"iterator": {
"description": "Suppresses warnings about the __iterator__ property.",
"type": "boolean",
"default": false
},
"latedef": {
"description": "Prohibits the use of a variable before it was defined",
"enum": [true, false, "nofunc"],
"default": false
},
"leanswitch": {
"description": "Prohibits unnecessary clauses within `switch` statements",
"type": "boolean",
"default": false
},
"maxcomplexity": {
"description": "Max cyclomatic complexity per function",
"type": ["boolean", "integer"],
"default": false
},
"maxdepth": {
"description": "Max depth of nested blocks",
"type": ["boolean", "integer"],
"default": false
},
"maxerr": {
"description": "Maximum amount of warnings JSHint will produce before giving up",
"type": "integer",
"default": 50
},
"maxparams": {
"description": "Max number of formal parameters allowed per function",
"type": ["boolean", "integer"]
},
"maxstatements": {
"description": "Max number statements per function",
"type": ["boolean", "integer"],
"default": false
},
"noarg": {
"description": "Prohibits the use of `arguments.caller` and `arguments.callee`",
"type": "boolean",
"default": false
},
"nocomma": {
"description": "Prohibits the use of the comma operator",
"type": "boolean",
"default": false
},
"nonbsp": {
"description": "Warns about `non-breaking whitespace` characters",
"type": "boolean",
"default": false
},
"nonew": {
"description": "Prohibits the use of constructors for side-effects (without assignment)",
"type": "boolean",
"default": false
},
"notypeof": {
"description": "Suppresses warnings about invalid `typeof`operator values",
"type": "boolean",
"default": false
},
"noreturnawait": {
"description": "Async functions resolve on their return value. In most cases, this makes returning the result of an AwaitExpression (which is itself a Promise instance) unnecessary",
"type": "boolean",
"default": false
},
"regexpu": {
"description": "Enables warnings for regular expressions which do not include the 'u' flag",
"type": "boolean",
"default": false
},
"shadow": {
"description": "Suppresses warnings about variable shadowing. i.e. declaring a variable that had been already declared somewhere in the outer scope",
"type": ["boolean", "string"],
"default": false,
"enum": [true, false, "inner", "outer"]
},
"singleGroups": {
"description": "Prohibits the use of the grouping operator when it is not strictly required.",
"type": "boolean",
"default": false
},
"strict": {
"description": "Requires all code to run in ES5 strict mode",
"type": ["boolean", "string"],
"default": false,
"enum": [true, false, "implied", "global", "func"]
},
"trailingcomma": {
"description": "Warns when a comma is not placed after the last element in an array or object literal",
"type": "boolean",
"default": false
},
"undef": {
"description": "Prohibits the use of explicitly undeclared variables",
"type": "boolean",
"default": false
},
"unused": {
"description": "Warns when you define and never use your variables",
"type": ["boolean", "string"],
"default": false,
"enum": [true, false, "vars", "strict"]
},
"varstmt": {
"description": "Forbids the use of VariableStatements (`var`) in favor of `let` and `const`",
"type": "boolean",
"default": false
},
"asi": {
"description": "Suppresses warnings about missing semicolons",
"type": "boolean",
"default": false
},
"boss": {
"description": "Suppresses warnings about the use of assignments in cases where comparisons are expected",
"type": "boolean",
"default": false
},
"debug": {
"description": "Suppresses warnings about the `debugger` statements in your code",
"type": "boolean",
"default": false
},
"elision": {
"description": "Tells JSHint that your code uses ES3 array elision elements, or empty elements",
"type": "boolean",
"default": false
},
"eqnull": {
"description": "Suppresses warnings about `== null` comparisons",
"type": "boolean",
"default": false
},
"evil": {
"description": "Suppresses warnings about the use of `eval`",
"type": "boolean",
"default": false
},
"expr": {
"description": "Suppresses warnings about the use of expressions where normally you would expect to see assignments or function calls",
"type": "boolean",
"default": false
},
"lastsemic": {
"description": "Suppresses warnings about missing semicolons, but only when the semicolon is omitted for the last statement in a one-line block",
"type": "boolean",
"default": false
},
"loopfunc": {
"description": "Suppresses warnings about functions inside of loops",
"type": "boolean",
"default": false
},
"moz": {
"description": "Tells JSHint that your code uses Mozilla JavaScript extensions",
"type": "boolean",
"default": false
},
"noyield": {
"description": "Suppresses warnings about generator functions with no `yield` statement in them",
"type": "boolean",
"default": false
},
"plusplus": {
"description": "Prohibits the use of `++` and `--`",
"type": "boolean",
"default": false
},
"proto": {
"description": "Suppresses warnings about the `__proto__` property",
"type": "boolean",
"default": false
},
"scripturl": {
"description": "Suppresses warnings about the use of script-targeted URLs",
"type": "boolean",
"default": false
},
"supernew": {
"description": "Suppresses warnings about constructions like `new function () { ... };` and `new Object;`",
"type": "boolean",
"default": false
},
"validthis": {
"description": "Suppresses warnings about possible strict violations when the code is running in strict mode and you use `this` in a non-constructor function",
"type": "boolean",
"default": false
},
"withstmt": {
"description": "Suppresses warnings about the use of the `with` statement",
"type": "boolean",
"default": false
},
"browser": {
"description": "[Environment] Web Browser (window, document, etc)",
"type": "boolean",
"default": false
},
"browserify": {
"description": "[Environment] Browserify",
"type": "boolean",
"default": false
},
"couch": {
"description": "[Environment] CouchDB",
"type": "boolean",
"default": false
},
"devel": {
"description": "[Environment] Development/debugging (alert, confirm, etc)",
"type": "boolean",
"default": false
},
"dojo": {
"description": "[Environment] Dojo Toolkit",
"type": "boolean",
"default": false
},
"jasmine": {
"description": "[Environment] Jasmine unit testing framework",
"type": "boolean",
"default": false
},
"jquery": {
"description": "[Environment] jQuery",
"type": "boolean",
"default": false
},
"mocha": {
"description": "[Environment] Mocha unit testing framework",
"type": "boolean",
"default": false
},
"module": {
"description": "[Environment] ES6 module",
"type": "boolean",
"default": false
},
"mootools": {
"description": "[Environment] MooTools",
"type": "boolean",
"default": false
},
"node": {
"description": "[Environment] Node.js",
"type": "boolean",
"default": false
},
"nonstandard": {
"description": "[Environment] Widely adopted globals (escape, unescape, etc)",
"type": "boolean",
"default": false
},
"phantom": {
"description": "[Environment] PhantomJS runtime environment",
"type": "boolean",
"default": false
},
"prototypejs": {
"description": "[Environment] Prototype JavaScript framework",
"type": "boolean",
"default": false
},
"rhino": {
"description": "[Environment] Rhino",
"type": "boolean",
"default": false
},
"shelljs": {
"description": "[Environment] Defines globals exposed by the ShellJS library",
"type": "boolean",
"default": false
},
"typed": {
"description": "[Environment] Defines globals for typed array constructors",
"type": "boolean",
"default": false
},
"worker": {
"description": "[Environment] Web Workers",
"type": "boolean",
"default": false
},
"wsh": {
"description": "[Environment] Windows Scripting Host",
"type": "boolean",
"default": false
},
"yui": {
"description": "[Environment] Yahoo User Interface",
"type": "boolean",
"default": false
},
"globals": {
"description": "Specify a white list of global variables that are not formally defined in the source code",
"type": "object",
"additionalProperties": {
"description": "Name of the global. Set to `true` for read/write, `false` for read-only.",
"type": "boolean"
}
},
"extends": {
"description": "Specify the path to another configuration file to use as a base, relative to the current file",
"type": "string"
},
"overrides": {
"description": "Specify the options that should only be applied to files matching a given path pattern",
"type": "object",
"additionalProperties": {
"description": "The path pattern to apply the given options to",
"type": "object"
}
}
},
"title": "JSON schema for JSHint configuration files",
"type": "object"
}
|
liquibase-flow-file-latest.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Liquibase Flow File",
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/variable",
"description": "Include other properties files as global variables, accessible in any stage. The key value pairs in the included file are imported with a prefix appended; the prefix is specified here as the key."
},
"globalVariables": {
"$ref": "#/$defs/variable",
"description": "Variables which can be accessed in any stage. Variables can be used in the definition of other variables, and may be defined in any order."
},
"stages": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/stage"
}
},
"endStage": {
"$ref": "#/$defs/stage",
"description": "This stage runs after all of the stages in the stages block. The end stage is guaranteed to execute. If there is an exception in any stage, the end stage will still execute."
}
},
"additionalProperties": false,
"required": [
"stages"
],
"$defs": {
"variable": {
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"type": "string"
}
},
"additionalProperties": false
},
"stage": {
"type": ["object", "null"],
"properties": {
"globalArgs": {
"$ref": "#/$defs/variable"
},
"stageVariables": {
"$ref": "#/$defs/variable",
"description": "Variables which can be accessed only in this stage. Variables can be used in the definition of other variables, and may be defined in any order."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/$defs/action"
},
"description": "The actions to run in this stage."
},
"if": {
"type": ["string", "null"],
"description": "Conditional control of whether the stage is executed or skipped"
}
},
"required": [
"actions"
],
"additionalProperties": "false"
},
"action": {
"type": "object",
"properties": {
"type": {
"type": ["string", "null"],
"description": "Specify the type of the action. If omitted or left empty, it is assumed that the type is 'liquibase'."
},
"if": {
"type": ["string", "null"],
"description": "Conditional control of whether the stage is executed or skipped"
}
},
"additionalProperties": {
"type": [
"number",
"string",
"boolean",
"object",
"array",
"null"
]
}
}
}
} |
fabric.mod.json | {
"$id": "https://json.schemastore.org/fabric.mod.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"entrypoint": {
"oneOf": [
{
"type": "object",
"properties": {
"adapter": {
"type": "string",
"description": "The language adapter to use",
"default": "default"
},
"value": {
"type": "string",
"description": "The entrypoint function or class"
}
},
"required": ["value"]
},
{
"type": "string",
"description": "The entrypoint function or class"
}
]
},
"contactInfo": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Contact e-mail pertaining to the mod"
},
"irc": {
"type": "string",
"description": "IRC channel pertaining to the mod. Must be of a valid URL format"
},
"homepage": {
"type": "string",
"description": "Project or user homepage. Must be a valid HTTP/HTTPS address"
},
"issues": {
"type": "string",
"description": "Project issue tracker. Must be a valid HTTP/HTTPS address"
},
"sources": {
"type": "string",
"description": "Project source code repository. Must be a valid URL"
}
},
"additionalProperties": {
"type": "string",
"description": "Custom contact or profile informations"
}
},
"environment": {
"type": "string",
"enum": ["*", "client", "server"],
"description": "The environment where this mod will be loaded"
},
"nestedJar": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A string value pointing to a path from the root of the JAR to a nested JAR which should be loaded alongside the outer mod JAR"
}
},
"required": ["file"]
},
"person": {
"oneOf": [
{
"type": "string",
"description": "The name of the person"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person"
},
"contact": {
"description": "Contact information for the person",
"$ref": "#/definitions/contactInfo"
}
},
"required": ["name"]
}
]
},
"versionRanges": {
"oneOf": [
{
"$ref": "#/definitions/versionRange"
},
{
"type": "array",
"description": "Multiple version ranges that are combined with an \"OR\" relationship - only one of the ranges needs to match",
"items": {
"$ref": "#/definitions/versionRange"
}
}
]
},
"versionRange": {
"type": "string",
"description": "A version range that matches versions. The following variants are supported:\n\n- A single asterisk matches any version.\n- Ranges following NPM semver specification including >=, >, =, <, <=, X-ranges (1.x), tilde ranges (fixed minor) and caret ranges (fixed major).\n- Additionally exact string matches will always be performed.",
"x-intellij-html-description": "<p>A version range or an array of those that match versions. The following variants are supported:</p><ul><li><code>*</code> matches any version.</li><li>Ranges following <a href=\"https://docs.npmjs.com/about-semantic-versioning\">NPM semver specification</a>:<ul><li><code>>=</code>, <code>></code>, <code>=</code>, <code><</code> and <code><</code></li><li>X-ranges to specify variable components, e.g. <code>1.x</code></li><li>tilde ranges that allow patch version changes, e.g. <code>~1.2.3</code></li><li>caret ranges that allow up to minor version changes, e.g. <code>^1.2.3</code></li></ul></li><li>Exact string matches are always performed as well.</li></ul><p>If an array of ranges is used, they're treated as in an \"OR\" relationship - only one of the ranges needs to match.</p>",
"markdownDescription": "A version range or an array of those that match versions. The following variants are supported:\n\n- `*` matches any version.\n- Ranges following [NPM semver specification](https://docs.npmjs.com/about-semantic-versioning):\n - `>=`, `>`, `=`, `<` and `<=`\n - X-ranges to specify variable components, e.g. `1.x`\n - tilde ranges that allow patch version changes, e.g. `~1.2.3`\n - caret ranges that allow up to minor version changes, e.g. `^1.2.3`\n- Exact string matches are always performed as well.\n\nIf an array of ranges is used, they're treated as in an \"OR\" relationship - only one of the ranges needs to match."
}
},
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9-_]{1,63}$",
"description": "The mod identifier"
},
"version": {
"type": "string",
"description": "The mod version"
},
"schemaVersion": {
"type": "integer",
"description": "The version of the fabric.mod.json schema",
"const": 1
},
"environment": {
"$ref": "#/definitions/environment"
},
"entrypoints": {
"type": "object",
"properties": {
"main": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "The entrypoint for all environments (classes must implement ModInitializer)"
},
"client": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "The entrypoint for the client environment (classes must implement ClientModInitializer)"
},
"server": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "The entrypoint for the server environment (classes must implement DedicatedServerModInitializer)"
},
"preLaunch": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "The entrypoint called just before the game instance is created (classes must implement PreLaunchEntrypoint)"
},
"fabric-datagen": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "The entrypoint for the data generator environment (classes must implement DataGeneratorEntrypoint)"
},
"fabric-gametest": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "The entrypoint for the Game Test environment (classes must implement FabricGameTest)"
}
},
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/entrypoint"
},
"description": "Custom mod entrypoints"
},
"description": "The entrypoints used by this mod"
},
"jars": {
"type": "array",
"description": "Contains an array of nestedJar objects",
"items": {
"$ref": "#/definitions/nestedJar"
}
},
"languageAdapters": {
"type": "object",
"description": "A string→string dictionary, connecting namespaces to LanguageAdapter implementations",
"additionalProperties": {
"type": "string"
}
},
"mixins": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"description": "Path to mixin file from the root of the JAR"
},
{
"type": "object",
"properties": {
"config": {
"type": "string",
"description": "Path to mixin file from the root of the JAR"
},
"environment": {
"$ref": "#/definitions/environment"
}
}
}
]
}
},
"accessWidener": {
"type": "string",
"description": "Path to an access widener definition file"
},
"depends": {
"type": "object",
"description": "id→versionRange map for dependencies. Failure to meet these causes a hard failure",
"additionalProperties": {
"$ref": "#/definitions/versionRanges"
}
},
"recommends": {
"type": "object",
"description": "id→versionRange map for dependencies. Failure to meet these causes a soft failure (warning)",
"additionalProperties": {
"$ref": "#/definitions/versionRanges"
}
},
"suggests": {
"type": "object",
"description": "id→versionRange map for dependencies. Are not matched and are mainly used as metadata",
"additionalProperties": {
"$ref": "#/definitions/versionRanges"
}
},
"conflicts": {
"type": "object",
"description": "id→versionRange map for dependencies. A successful match causes a soft failure (warning)",
"additionalProperties": {
"$ref": "#/definitions/versionRanges"
}
},
"breaks": {
"type": "object",
"description": "id→versionRange map for dependencies. A successful match causes a hard failure",
"additionalProperties": {
"$ref": "#/definitions/versionRanges"
}
},
"name": {
"type": "string",
"description": "Name of the mod"
},
"description": {
"type": "string",
"description": "Description of the mod"
},
"authors": {
"type": "array",
"items": {
"$ref": "#/definitions/person"
},
"description": "The direct authorship information"
},
"contributors": {
"type": "array",
"items": {
"$ref": "#/definitions/person"
},
"description": "Contributors to this mod"
},
"contact": {
"$ref": "#/definitions/contactInfo",
"description": "Contact information for the mod"
},
"license": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The license the mod uses"
},
"icon": {
"oneOf": [
{
"type": "string",
"description": "The path to a single .PNG file from the root of the JAR"
},
{
"type": "object",
"description": "A string→string dictionary, where the keys conform to widths of each PNG file, and the values are said files' paths",
"propertyNames": {
"pattern": "^[1-9][0-9]*$"
},
"additionalProperties": {
"type": "string",
"description": "The path to a single .PNG file from the root of the JAR"
}
}
]
},
"custom": {
"type": "object",
"description": "A map of namespace:id→value for custom data fields."
}
},
"required": ["id", "version", "schemaVersion"],
"type": "object"
}
|
license-report-config.json | {
"$id": "https://json.schemastore.org/license-report-config.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"output": {
"default": "json",
"description": "license report output format",
"enum": ["json", "table", "csv", "html"],
"type": "string"
},
"html": {
"type": "object",
"description": "HTML output format",
"properties": {
"cssFile": {
"default": "path.resolve(__dirname, '..', 'defaultHtmlStyle.css')",
"type": "string"
},
"tableify": {
"description": "passed directly to tableify (see: https://github.com/kessler/node-tableify)",
"type": "object"
}
}
},
"delimiter": {
"default": ",",
"description": "CSV output format",
"type": "string"
},
"escapeCsvFields": {
"default": "false",
"description": "CSV output format: escape fields containing delimiter character",
"type": "boolean"
},
"only": {
"default": "null",
"description": "export deps. or deps/dev-/opt-/peer- deps. falsey -> output everything",
"type": "object"
},
"registry": {
"default": "https://registry.npmjs.org/",
"description": "NPM registry URL",
"type": "string"
},
"exclude": {
"description": "package names that will be excluded from the report",
"items": {
"type": "string"
},
"type": "array"
},
"fields": {
"description": "fields participating in the report and their order",
"items": {
"enum": [
"department",
"relatedTo",
"name",
"licensePeriod",
"material",
"licenseType",
"link",
"remoteVersion",
"installedVersion",
"author"
],
"type": "string"
},
"type": "array"
},
"comment": {
"description": "export deps. or deps/dev-/opt-/peer- deps. falsey -> output everything",
"properties": {
"label": {
"type": "string",
"default": "comment"
},
"value": {
"type": "string",
"default": ""
}
},
"type": "object"
},
"httpRetryOptions": {
"properties": {
"delay": {
"type": "number",
"default": 1000
},
"maxAttempts": {
"type": "number",
"default": 5
}
},
"type": "object"
},
"package": {
"description": "path to the package.json",
"default": "./package.json",
"type": "string"
}
},
"title": "JSON schema for license report tool configuration file",
"type": "object"
}
|
drupal-links-task.json | {
"$id": "https://json.schemastore.org/drupal-links-task.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {
"type": "object",
"properties": {
"title": {
"title": "The static title for the local task",
"type": "string"
},
"title_context": {
"title": "The translation context for the title value.",
"type": "string"
},
"route_name": {
"title": "The name of the route this task links to",
"type": "string"
},
"route_parameters": {
"title": "Parameters for route variables when generating a link",
"type": "object"
},
"base_route": {
"title": "The route name where the root tab appears",
"type": "string"
},
"parent_id": {
"title": "The plugin ID of the parent tab",
"type": "string"
},
"weight": {
"title": "The weight of the tab",
"type": "integer"
},
"options": {
"title": "Array of link options",
"type": "object"
},
"class": {
"title": "Class for task implementations",
"type": "string"
},
"deriver": {
"title": "Deriver class",
"type": "string"
},
"cache_tags": {
"title": "Cache tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"title": "JSON schema for Drupal task links file",
"type": "object"
}
|
box.schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"engine": {
"description": "CFML engine the package supports",
"type": "object",
"properties": {
"type": {
"title": "Engine Type",
"description": "The name of the engine",
"type": "string",
"enum": [
"railo",
"lucee",
"adobe"
]
},
"version": {
"title": "Engine Version",
"description": "The semantic version of the engine that is supported",
"type": "string",
"default": ""
}
}
},
"dependency": {
"title": "Dependency",
"description": "Dependencies are specified with a package name/slug to version range, local file path, URL, or Git/SVN endpoint. The version range is a string which has one or more space-separated descriptors.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"person": {
"description": "A person who has been involved in creating or maintaining this package",
"type": [
"object",
"string"
],
"required": [
"name"
],
"properties": {
"name": {
"description": "Name of the person",
"type": "string"
},
"url": {
"description": "URL for the person",
"type": "string",
"format": "uri"
},
"email": {
"description": "Email address of the person",
"type": "string",
"format": "email"
}
}
}
},
"title": "Package Manifest",
"description": "Configuration file for a CFML package",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The name of the package",
"type": "string",
"default": ""
},
"slug": {
"title": "Slug",
"description": "ForgeBox unique slug",
"type": "string",
"pattern": "^[\\w@-]*$",
"maxLength": 250,
"default": ""
},
"version": {
"title": "Version",
"description": "Semantic version of your package",
"type": "string",
"default": ""
},
"author": {
"title": "Author",
"description": "Author of this package",
"type": "string",
"default": ""
},
"location": {
"title": "Location",
"description": "Location of where to download the package. Overrides ForgeBox location",
"type": "string",
"default": ""
},
"directory": {
"title": "Directory",
"description": "Install directory where this package should be placed once installed. If not defined, it installs were the CommandBox command was executed.",
"type": "string",
"default": ""
},
"createPackageDirectory": {
"title": "Create Package Directory",
"description": "This determines if the container directory will contain a sub-directory according to the package slug name. The default is true",
"type": "boolean",
"default": true
},
"packageDirectory": {
"title": "Package Directory",
"description": "This name will be used for the package sub-directory instead of the slug name",
"type": "string",
"default": ""
},
"homepage": {
"title": "Homepage",
"description": "Project homepage URL",
"type": "string",
"format": "uri"
},
"documentation": {
"title": "Documentation",
"description": "Documentation URL",
"type": "string",
"format": "uri"
},
"repository": {
"title": "Repository",
"description": "Source repository",
"type": "object",
"properties": {
"type": {
"title": "Repository Type",
"description": "The version control system. Popular examples are git, svn, or mercurial",
"type": "string",
"default": ""
},
"url": {
"title": "Repository URL",
"description": "The URL at which the repository resides",
"type": "string",
"format": "uri"
}
}
},
"bugs": {
"title": "Bugs",
"description": "Bug issue management URL",
"type": "string",
"format": "uri"
},
"shortDescription": {
"title": "Short Description",
"description": "ForgeBox short description",
"type": "string",
"default": ""
},
"description": {
"title": "Description",
"description": "ForgeBox big description. If not set, it can be taken from a Readme.md, Readme, or Readme.txt",
"type": "string",
"default": ""
},
"instructions": {
"title": "Instructions",
"description": "Install instructions. If not set, it can be taken from a instructions.md, instructions, or instructions.txt",
"type": "string",
"default": ""
},
"changelog": {
"title": "Change Log",
"description": "Change log. If not set, it can be taken from a changelog.md, changelog, or changelog.txt",
"type": "string",
"default": ""
},
"type": {
"title": "Type",
"description": "ForgeBox contribution type",
"type": "string",
"enum": [
"caching",
"cf-engines",
"cfbuilder-extensions",
"cfwheels-plugins",
"cms",
"commandbox-commands",
"commandbox-modules",
"commandbox-recipes",
"contentbox-modules",
"contentbox-themes",
"contentbox-widgets",
"demos",
"di",
"interceptors",
"logging",
"lucee-extensions",
"messaging-queues",
"modules",
"mvc",
"nosql",
"plugins",
"preside-extensions",
"preside-skeletons",
"projects",
"testing",
"wirebox-aspects",
"wirebox-listeners"
]
},
"keywords": {
"title": "Keywords",
"description": "ForgeBox keywords",
"type": [
"array",
"string"
],
"items": {
"title": "Keyword",
"description": "ForgeBox keyword",
"type": "string"
},
"default": []
},
"private": {
"title": "Private",
"description": "Designates the package as a private ForgeBox package. Private packages are not publicly accessible, but still offer all the benefits of ForgeBox.",
"type": "boolean",
"default": false
},
"engines": {
"title": "Engines",
"description": "CFML engines the package supports",
"type": "array",
"items": {
"$ref": "#/definitions/engine"
},
"default": []
},
"defaultEngine": {
"description": "The name of the default CFML engine for the `start` command to use.",
"type": "string"
},
"defaultPort": {
"description": "Deprecated. The HTTP port the server will be started on when you use the start command. Use `port` in `server.json` instead.",
"type": "number"
},
"projectURL": {
"title": "Project URL",
"description": "Default project URL if not using CommandBox start server commands",
"type": "string",
"format": "uri"
},
"license": {
"title": "Licenses",
"description": "List of licenses the package can have",
"type": "array",
"items": {
"title": "License",
"description": "A license the package can have",
"type": "object",
"properties": {
"type": {
"title": "License Type",
"description": "The license type. For example, MIT.",
"type": "string",
"default": ""
},
"url": {
"title": "License URL",
"description": "The URL at which the license resides",
"type": "string",
"format": "uri"
}
}
},
"default": []
},
"contributors": {
"title": "Contributors",
"description": "Contributors to the package",
"type": "array",
"items": {
"$ref": "#/definitions/person"
},
"default": []
},
"dependencies": {
"$ref": "#/definitions/dependency"
},
"devDependencies": {
"$ref": "#/definitions/dependency"
},
"installPaths": {
"title": "Install Paths",
"description": "Tracks install locations so uninstall can work. The key is the package name/slug and the value is the path",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"scripts": {
"title": "Scripts",
"description": "Set of script commands that correspond to the interception points in CommandBox or arbitrary names that can be run with the `run-script` command",
"type": "object",
"properties": {
"preInstall": {
"description": "Run BEFORE the package is installed",
"type": "string"
},
"onInstall": {
"description": "Run WHILE the package is installed",
"type": "string"
},
"postInstall": {
"description": "Run AFTER the package is installed",
"type": "string"
},
"preUninstall": {
"description": "Run BEFORE the package is uninstalled",
"type": "string"
},
"postUninstall": {
"description": "Run AFTER the package is uninstalled",
"type": "string"
},
"preVersion": {
"description": "Run BEFORE bump the package version",
"type": "string"
},
"postVersion": {
"description": "Run AFTER bump the package version, but BEFORE Git repo is tagged",
"type": "string"
},
"onRelease": {
"description": "Run AFTER bump the package version and AFTER Git repo is tagged",
"type": "string"
},
"prePublish": {
"description": "Run BEFORE the package is published",
"type": "string"
},
"postPublish": {
"description": "Run AFTER the package is published",
"type": "string"
}
},
"additionalProperties": {
"type": "string"
},
"default": {}
},
"ignore": {
"title": "Ignore",
"description": "List of file globs to ignore when installing the package similar to .gitignore patterns",
"type": "array",
"items": {
"description": "Ignore glob pattern",
"type": "string"
},
"default": []
},
"testbox": {
"title": "TestBox",
"description": "TestBox integration",
"type": "object",
"properties": {
"runner": {
"title": "TestBox Runner",
"description": "The URI location of the test runner for an app or several with slug names",
"type": [
"string",
"array"
],
"items": {
"description": "The runner URIs mapped to slug names",
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uri"
}
},
"format": "uri"
},
"labels": {
"title": "Labels List",
"description": "A list of labels to only include when running the tests",
"type": [
"string",
"array"
],
"items": {
"description": "A label a spec must have to be ran",
"type": "string"
}
},
"excludes": {
"title": "Exclude List",
"description": "A list of labels to exclude when running the tests",
"type": [
"string",
"array"
],
"items": {
"description": "A label to be excluded from the test run",
"type": "string"
}
}
}
},
"cfmigrations": {
"title": "CF Migrations",
"description": "Configuration object for CF Migration database settings.",
"type": "object",
"properties": {
"migrationsDirectory": {
"title": "Migrations Directory",
"description": "Location of generated migration files that migration commands will use.",
"type": "string"
},
"schema": {
"title": "Database Schema",
"type": "string"
},
"connectionInfo": {
"title": "Migrations Directory",
"description": "Location of generated migration files that migration commands will use.",
"type": "object",
"properties": {
"password": {
"title": "Database Password",
"type": "string"
},
"connectionString": {
"title": "Database Connection String",
"type": "string"
},
"class": {
"title": "Database class",
"type": "string"
},
"username": {
"title": "Database Username",
"type": "string"
}
}
},
"defaultGrammar": {
"title": "Default Grammar",
"description": "Name of the qb service to use for grammar.",
"type": "string",
"enum": [
"AutoDiscover@qb",
"BaseGrammar@qb",
"MySQLGrammar@qb",
"OracleGrammar@qb",
"PostgresGrammar@qb",
"SqlServerGrammar@qb"
]
}
}
}
}
}
|
package-configuration-schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://oss-review-toolkit.org/package-configuration.yml",
"title": "ORT package configuration",
"description": "The OSS-Review-Toolkit (ORT) provides a possibility to define path excludes and license finding curations for a specific package (dependency) and provenance in a package configuration file. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-package-configuration-yml.md.",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"license_finding_curations": {
"items": {
"$ref": "#/definitions/licenseFindingCurations"
},
"type": "array"
},
"path_excludes": {
"items": {
"properties": {
"comment": {
"type": "string"
},
"pattern": {
"type": "string"
},
"reason": {
"$ref": "#/definitions/pathExcludeReason"
}
},
"required": [
"pattern",
"reason"
],
"type": "object"
},
"type": "array"
},
"vcs": {
"$ref": "#/definitions/vcsMatcher"
},
"source_artifact_url": {
"type": "string"
}
},
"definitions": {
"licenseFindingCurationReason": {
"enum": [
"CODE",
"DATA_OF",
"DOCUMENTATION_OF",
"INCORRECT",
"NOT_DETECTED",
"REFERENCE"
]
},
"licenseFindingCurations": {
"properties": {
"comment": {
"type": "string"
},
"concluded_license": {
"type": "string"
},
"detected_license": {
"type": "string"
},
"line_count": {
"type": "integer"
},
"path": {
"type": "string"
},
"reason": {
"$ref": "#/definitions/licenseFindingCurationReason"
},
"start_lines": {
"type": [
"integer",
"string"
]
}
},
"required": [
"path",
"concluded_license",
"reason"
],
"type": "object"
},
"pathExcludeReason": {
"enum": [
"BUILD_TOOL_OF",
"DATA_FILE_OF",
"DOCUMENTATION_OF",
"EXAMPLE_OF",
"OPTIONAL_COMPONENT_OF",
"OTHER",
"PROVIDED_BY",
"TEST_OF",
"TEST_TOOL_OF"
]
},
"vcsMatcher": {
"anyOf": [
{
"required": [
"type"
]
},
{
"required": [
"url"
]
},
{
"required": [
"revision"
]
},
{
"required": [
"path"
]
}
],
"properties": {
"path": {
"type": "string"
},
"revision": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id"
],
"oneOf": [
{
"required": [
"vcs"
]
},
{
"required": [
"source_artifact_url"
]
}
]
}
|
webhook.json | {
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Discord Webhook",
"description": "Discord Webhook JSON Schema",
"definitions": {
"string": {
"type": "string",
"default": ""
},
"boolean": {
"type": "boolean",
"default": false
},
"url": {
"$ref": "#/definitions/string",
"pattern": "^https?://"
},
"id": {
"$ref": "#/definitions/string",
"pattern": "^\\d+$"
}
},
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": ["content"]
},
{
"required": ["embeds"]
}
],
"properties": {
"$schema": {
"description": "Allow $schema because additionalProperties is false",
"$ref": "#/definitions/string"
},
"content": {
"description": "The message contents\nMax is 2000 characters",
"$ref": "#/definitions/string",
"maxLength": 2000
},
"username": {
"description": "Override the default username of the webhook\nName cannot contain \"clyde\"",
"$ref": "#/definitions/string",
"pattern": "^((?!(c|C)(l|L)(y|Y)(d|D)(e|E)).)*$",
"maxLength": 80
},
"avatar_url": {
"description": "Override the default avatar of the webhook",
"$ref": "#/definitions/url"
},
"tts": {
"description": "Whether or not this message will play in TTS\nDefault is false",
"$ref": "#/definitions/boolean"
},
"embeds": {
"description": "Embedded rich content\nMax is 6000 characters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"description": "Title of embed\nMax is 256 characters",
"$ref": "#/definitions/string",
"maxLength": 256
},
"description": {
"description": "Description of embed\nMax is 4096 characters",
"$ref": "#/definitions/string",
"maxLength": 4096
},
"url": {
"description": "URL of embed\nOnly support http / https",
"$ref": "#/definitions/url"
},
"timestamp": {
"description": "Timestamp of embed content\nISO8601 Timestamp",
"$ref": "#/definitions/string",
"format": "date-time"
},
"color": {
"description": "Color code of the embed\nOnly support color in decimal\nTo match embed background color, use 3092790\nDefault is 2105893",
"type": "integer",
"default": 2105893,
"minimum": 0,
"maximum": 16777215
},
"footer": {
"description": "Footer information",
"type": "object",
"additionalProperties": false,
"required": ["text"],
"properties": {
"text": {
"description": "Footer text\nMax is 2048 characters",
"type": "string",
"default": "",
"maxLength": 2048
},
"icon_url": {
"description": "URL of footer icon\nOnly support http / https",
"$ref": "#/definitions/url"
}
}
},
"image": {
"description": "Image information",
"type": "object",
"additionalProperties": false,
"required": ["url"],
"properties": {
"url": {
"description": "Source url of image\nOnly support http / https",
"$ref": "#/definitions/url"
}
}
},
"thumbnail": {
"description": "Thumbnail information",
"type": "object",
"additionalProperties": false,
"required": ["url"],
"properties": {
"url": {
"description": "Source url of thumbnail\nOnly support http / https",
"$ref": "#/definitions/url"
}
}
},
"author": {
"description": "Author information",
"type": "object",
"additionalProperties": false,
"required": ["name"],
"properties": {
"name": {
"description": "Name of author\nMax is 256 characters",
"$ref": "#/definitions/string",
"maxLength": 256
},
"url": {
"description": "URL of author\nOnly support http / https",
"$ref": "#/definitions/url"
},
"icon_url": {
"description": "URL of author icon\nOnly support http / https",
"$ref": "#/definitions/url"
}
}
},
"fields": {
"description": "Fields information",
"type": "array",
"items": {
"description": "Fields information",
"type": "object",
"additionalProperties": false,
"required": ["name", "value"],
"properties": {
"name": {
"description": "Name of the field\nREQUIRED Max is 256",
"$ref": "#/definitions/string",
"minLength": 1,
"maxLength": 256
},
"value": {
"description": "Value of the field\nREQUIRED Max is 1024",
"$ref": "#/definitions/string",
"minLength": 1,
"maxLength": 1024
},
"inline": {
"description": "Whether or not this field should display inline\nDefault is false",
"$ref": "#/definitions/boolean"
}
}
}
}
}
}
},
"allowed_mentions": {
"description": "Allowed mentions for the message",
"type": "object",
"minProperties": 1,
"additionalProperties": false,
"properties": {
"parse": {
"description": "An array of allowed mention types to parse from the content.",
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": ["roles", "users", "everyone"]
}
},
"roles": {
"description": "Array of role_ids to mention\nMax is 100 of role_ids\nMutually exclusive with parse roles",
"type": ["array", "null"],
"default": [],
"uniqueItems": true,
"maxItems": 100,
"items": {
"$ref": "#/definitions/id"
}
},
"users": {
"description": "Array of user_ids to mention\nMax is 100 of user_ids\nMutually exclusive with parse users",
"type": ["array", "null"],
"default": [],
"uniqueItems": true,
"maxItems": 100,
"items": {
"$ref": "#/definitions/id"
}
}
}
}
}
}
|
geojson.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"coordinates": {
"title": "Coordinates",
"type": "array",
"items": {
"oneOf": [
{
"type": "array"
},
{
"type": "number"
}
]
}
},
"geometry": {
"title": "Geometry",
"description": "A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.",
"properties": {
"type": {
"enum": [
"Point",
"MultiPoint",
"LineString",
"MultiLineString",
"Polygon",
"MultiPolygon",
"GeometryCollection"
]
}
}
},
"feature": {
"title": "Feature",
"description": "A GeoJSON object with the type `Feature` is a feature object.\n\n* A feature object must have a member with the name `geometry`. The value of the geometry member is a geometry object as defined above or a JSON null value.\n\n* A feature object must have a member with the name `properties`. The value of the properties member is an object (any JSON object or a JSON null value).\n\n* If a feature has a commonly used identifier, that identifier should be included as a member of the feature object with the name `id`.",
"required": ["geometry", "properties"],
"properties": {
"type": {
"enum": ["Feature"]
},
"geometry": {
"title": "Geometry",
"oneOf": [
{
"$ref": "#/definitions/geometry"
},
{
"type": "null"
}
]
},
"properties": {
"title": "Properties",
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"id": {}
}
},
"linearRingCoordinates": {
"title": "Linear Ring Coordinates",
"description": "A LinearRing is closed LineString with 4 or more positions. The first and last positions are equivalent (they represent equivalent points). Though a LinearRing is not explicitly represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.",
"allOf": [
{
"$ref": "#/definitions/lineStringCoordinates"
},
{
"minItems": 4
}
]
},
"lineStringCoordinates": {
"title": "Line String Coordinates",
"description": "For type `LineString`, the `coordinates` member must be an array of two or more positions.",
"allOf": [
{
"$ref": "#/definitions/coordinates"
},
{
"minLength": 2,
"items": {
"$ref": "#/definitions/position"
}
}
]
},
"polygonCoordinates": {
"title": "Polygon Coordinates",
"description": "For type `Polygon`, the `coordinates` member must be an array of LinearRing coordinate arrays. For Polygons with multiple rings, the first must be the exterior ring and any others must be interior rings or holes.",
"allOf": [
{
"$ref": "#/definitions/coordinates"
},
{
"items": {
"$ref": "#/definitions/linearRingCoordinates"
}
}
]
},
"position": {
"title": "Position",
"type": "array",
"description": "A position is the fundamental geometry construct. The `coordinates` member of a geometry object is composed of one position (in the case of a Point geometry), an array of positions (LineString or MultiPoint geometries), an array of arrays of positions (Polygons, MultiLineStrings), or a multidimensional array of positions (MultiPolygon).\n\nA position is represented by an array of numbers. There must be at least two elements, and may be more. The order of elements must follow x, y, z order (easting, northing, altitude for coordinates in a projected coordinate reference system, or longitude, latitude, altitude for coordinates in a geographic coordinate reference system). Any number of additional elements are allowed -- interpretation and meaning of additional elements is beyond the scope of this specification.",
"minItems": 2,
"items": {
"type": "number"
}
}
},
"description": "This object represents a geometry, feature, or collection of features.",
"id": "https://json.schemastore.org/geojson",
"oneOf": [
{
"title": "Point",
"description": "For type `Point`, the `coordinates` member must be a single position.",
"required": ["coordinates"],
"properties": {
"type": {
"enum": ["Point"]
},
"coordinates": {
"allOf": [
{
"$ref": "#/definitions/coordinates"
},
{
"$ref": "#/definitions/position"
}
]
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"title": "Multi Point Geometry",
"description": "For type `MultiPoint`, the `coordinates` member must be an array of positions.",
"required": ["coordinates"],
"properties": {
"type": {
"enum": ["MultiPoint"]
},
"coordinates": {
"allOf": [
{
"$ref": "#/definitions/coordinates"
},
{
"items": {
"$ref": "#/definitions/position"
}
}
]
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"title": "Line String",
"description": "For type `LineString`, the `coordinates` member must be an array of two or more positions.\n\nA LinearRing is closed LineString with 4 or more positions. The first and last positions are equivalent (they represent equivalent points). Though a LinearRing is not explicitly represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.",
"required": ["coordinates"],
"properties": {
"type": {
"enum": ["LineString"]
},
"coordinates": {
"$ref": "#/definitions/lineStringCoordinates"
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"title": "MultiLineString",
"description": "For type `MultiLineString`, the `coordinates` member must be an array of LineString coordinate arrays.",
"required": ["coordinates"],
"properties": {
"type": {
"enum": ["MultiLineString"]
},
"coordinates": {
"allOf": [
{
"$ref": "#/definitions/coordinates"
},
{
"items": {
"$ref": "#/definitions/lineStringCoordinates"
}
}
]
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"title": "Polygon",
"description": "For type `Polygon`, the `coordinates` member must be an array of LinearRing coordinate arrays. For Polygons with multiple rings, the first must be the exterior ring and any others must be interior rings or holes.",
"required": ["coordinates"],
"properties": {
"type": {
"enum": ["Polygon"]
},
"coordinates": {
"$ref": "#/definitions/polygonCoordinates"
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"title": "Multi-Polygon Geometry",
"description": "For type `MultiPolygon`, the `coordinates` member must be an array of Polygon coordinate arrays.",
"required": ["coordinates"],
"properties": {
"type": {
"enum": ["MultiPolygon"]
},
"coordinates": {
"allOf": [
{
"$ref": "#/definitions/coordinates"
},
{
"items": {
"$ref": "#/definitions/polygonCoordinates"
}
}
]
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"title": "Geometry Collection",
"description": "A GeoJSON object with type `GeometryCollection` is a geometry object which represents a collection of geometry objects.\n\nA geometry collection must have a member with the name `geometries`. The value corresponding to `geometries` is an array. Each element in this array is a GeoJSON geometry object.",
"required": ["geometries"],
"properties": {
"type": {
"enum": ["GeometryCollection"]
},
"geometries": {
"title": "Geometries",
"type": "array",
"items": {
"$ref": "#/definitions/geometry"
}
}
},
"allOf": [
{
"$ref": "#/definitions/geometry"
}
]
},
{
"$ref": "#/definitions/feature"
},
{
"title": "Feature Collection",
"description": "A GeoJSON object with the type `FeatureCollection` is a feature collection object.\n\nAn object of type `FeatureCollection` must have a member with the name `features`. The value corresponding to `features` is an array. Each element in the array is a feature object as defined above.",
"required": ["features"],
"properties": {
"type": {
"enum": ["FeatureCollection"]
},
"features": {
"title": "Features",
"type": "array",
"items": {
"$ref": "#/definitions/feature"
}
}
}
}
],
"properties": {
"type": {
"title": "Type",
"type": "string",
"description": "The type of GeoJSON object.",
"enum": [
"Point",
"MultiPoint",
"LineString",
"MultiLineString",
"Polygon",
"MultiPolygon",
"GeometryCollection",
"Feature",
"FeatureCollection"
]
},
"crs": {
"title": "Coordinate Reference System (CRS)",
"description": "The coordinate reference system (CRS) of a GeoJSON object is determined by its `crs` member (referred to as the CRS object below). If an object has no crs member, then its parent or grandparent object's crs member may be acquired. If no crs member can be so acquired, the default CRS shall apply to the GeoJSON object.\n\n* The default CRS is a geographic coordinate reference system, using the WGS84 datum, and with longitude and latitude units of decimal degrees.\n\n* The value of a member named `crs` must be a JSON object (referred to as the CRS object below) or JSON null. If the value of CRS is null, no CRS can be assumed.\n\n* The crs member should be on the top-level GeoJSON object in a hierarchy (in feature collection, feature, geometry order) and should not be repeated or overridden on children or grandchildren of the object.\n\n* A non-null CRS object has two mandatory members: `type` and `properties`.\n\n* The value of the type member must be a string, indicating the type of CRS object.\n\n* The value of the properties member must be an object.\n\n* CRS shall not change coordinate ordering.",
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"required": ["type", "properties"],
"properties": {
"type": {
"title": "CRS Type",
"type": "string",
"description": "The value of the type member must be a string, indicating the type of CRS object.",
"minLength": 1
},
"properties": {
"title": "CRS Properties",
"type": "object"
}
}
}
],
"not": {
"anyOf": [
{
"properties": {
"type": {
"enum": ["name"]
},
"properties": {
"not": {
"required": ["name"],
"properties": {
"name": {
"type": "string",
"minLength": 1
}
}
}
}
}
},
{
"properties": {
"type": {
"enum": ["link"]
},
"properties": {
"not": {
"title": "Link Object",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"title": "href",
"type": "string",
"description": "The value of the required `href` member must be a dereferenceable URI.",
"format": "uri"
},
"type": {
"title": "Link Object Type",
"type": "string",
"description": "The value of the optional `type` member must be a string that hints at the format used to represent CRS parameters at the provided URI. Suggested values are: `proj4`, `ogcwkt`, `esriwkt`, but others can be used."
}
}
}
}
}
}
]
}
},
"bbox": {
"title": "Bounding Box",
"type": "array",
"description": "To include information on the coordinate range for geometries, features, or feature collections, a GeoJSON object may have a member named `bbox`. The value of the bbox member must be a 2*n array where n is the number of dimensions represented in the contained geometries, with the lowest values for all axes followed by the highest values. The axes order of a bbox follows the axes order of geometries. In addition, the coordinate reference system for the bbox is assumed to match the coordinate reference system of the GeoJSON object of which it is a member.",
"minItems": 4,
"items": {
"type": "number"
}
}
},
"required": ["type"],
"title": "GeoJSON Object",
"type": "object"
}
|