app-config.schema.json

Go to the documentation of this file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://nvidia.com/dw/app-config.schema.json",
  "title": "DW Application Config Descriptor",
  "description": "The descriptor to override the configuration of a DriveWorks application. The keys in JSON should appear in the same order as the properties are documented in the schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "comment": {
      "description": "In a manually written JSON file this field can contain an arbitrary text. When the JSON file is generated, the tool should include its own name and optionally reference the authoritive source of information.",
      "type": "string"
    },
    "componentParameters": {
      "description": "The component parameters to override. The order should be alphabetical.",
      "type": "object",
      "additionalProperties": false,
      "patternProperties": {
        "^([a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*)?$": {
          "description": "The key is the fully qualified name of the subcomponent (in the form of 1 or multiple 'subcomponentInstanceName' separated by dots). The order should be alphabetical. The value contains a mapping from parameter names to parameter values.",
          "type": "object",
          "additionalProperties": false,
          "patternProperties": {
            "^[a-z][a-zA-Z0-9_]*(\\.[a-z][a-zA-Z0-9_]*)?$": {
              "description": "The key is the parameter name from the component. The value is the parameter value which must match the type of the parameter defined in the component descriptor. The order should be alphabetical.",
              "type": ["array", "boolean", "number", "string"]
            }
          }
        }
      }
    },
    "sensorLayouts": {
      "description": "The sensor layouts to override or update. The order should be alphabetical.",
      "type": "object",
      "additionalProperties": false,
      "patternProperties": {
        "^[a-zA-Z][a-zA-Z0-9 ._-]*$": {
          "description": "The key is the name of the sensor layout which must be unique within the collection of sensor layouts. The value is either an array of sensor names identified by their index or an object mapping an existing sensor name to a new name.",
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^([a-z0-9]+:)*[a-z0-9]+$"
              },
              "uniqueItems": true
            },
            {
              "type": "object",
              "additionalProperties": false,
              "patternProperties": {
                "^([a-z0-9]+:)*[a-z0-9]+$": {
                  "type": "string",
                  "pattern": "^([a-z0-9]+:)*[a-z0-9]+$"
                  }
              }
            }
          ]
        }
      }
    },
    "skipNodes": {
      "description": "The nodes to skip from being scheduled. The order should be alphabetical.",
      "type": "object",
      "additionalProperties": false,
      "patternProperties": {
        "^[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$": {
          "description": "The key is the fully qualified name of the node. Refering to a graphlet implicitly refers to all recursive nodes. The value identifies the 'stmSchedules' the skip applies to (and empty list means skipping the node in all schedules).",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "[a-z][a-zA-Z0-9_]*$"
          },
          "uniqueItems": true
        }
      }
    },
    "processes": {
      "description": "The process attributes to override (atm only 'argv' can be modified). The order should be alphabetical.",
      "type": "object",
      "additionalProperties": false,
      "patternProperties": {
        "^[a-zA-Z][a-zA-Z0-9_]*$": {
          "description": "The key is the name of the process (in snake_case). The value describes the process itself.",
          "additionalProperties": false,
          "properties": {
            "argv": {
              "description": "The command line arguments passed to the executable",
              "type": "object",
              "additionalProperties": false,
              "patternProperties": {
                "^[a-zA-Z0-9_-]+$": {
                  "description": "The key is one command line argument. The value is not used (if it is the boolean value true), a second argument (if it is a string), multiple additional arguments (if it is an array of strings). If the value is 'null' value the key is removed and not passed to the process.",
                  "anyOf": [
                    {
                      "type": "boolean",
                      "const": true
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "array",
                      "items": {
                        "type": ["string"]
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "extraInfo": {
      "description": "DEPRECATED! Override key-value pairs from the extraInfo JSON file",
      "type": "object"
    },
    "Recorder": {
      "description": "Parameters for the Recorder",
      "type": "object"
    },
    "RoadCastService": {
      "description": "Parameters for the RoadCast service",
      "type": "object"
    }
  }
}