@itwin/core-backend/lib/cjs/assets/Settings/Schemas/Base.Schema.json

iTwin.js backend components

{
  "$comment": "This schema describes the meta-structure of an iTwin Settings Schema file. It is used to provide a guide for the schema files themselves.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "required": [
    "schemaPrefix",
    "description"
  ],
  "schemaPrefix": "itwin/core/base",
  "description": "meta-schema for all iTwin settings schemas",
  "properties": {
    "settingDefs": {
      "type": "object",
      "description": "A group of setting definitions."
    },
    "typeDefs": {
      "type": "object",
      "description": "A group of type definitions that can be extended in setting definitions."
    },
    "schemaPrefix": {
      "type": "string",
      "description": "The unique prefix of the schema."
    },
    "description": {
      "type": "string",
      "description": "A description of the schema."
    },
    "order": {
      "type": "integer",
      "description": "An integer value used to sort the schema in a user interface list of multiple schemas, where schemas of lower order are sorted before those with higher order."
    }
  }
}