@o3r/application/schemas/cms.schema.json

This module provides development help to monitor your Otter Application

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "CmsMetadataSchema",
  "type": "object",
  "title": "Schema of CMS application configuration",
  "description": "Schema used to indicate the configuration to the CMS when the application is loaded by it",
  "additionalProperties": false,
  "required": [
    "localisationsFolder"
  ],
  "properties": {
    "assetsFolder": {
      "type": "string",
      "description": "The relative path to the assets folder to import",
      "default": "dist/assets"
    },
    "localisationsFolder": {
      "type": "string",
      "description": "The relative path to the localizations (.json files) folder to import"
    },
    "placeholderCssFiles": {
      "type": "array",
      "description": "An array of the CSS files which are used by placeholders at runtime. These files will be used in the placeholder editor",
      "items": {
        "type": "string"
      },
      "default": []
    },
    "defaultLanguage": {
      "type": "string",
      "description": "The language code present in the localisation.metadata.json file",
      "default": "en"
    },
    "functionalContentsFolder": {
      "type": "string",
      "description": "The relative path to the functional contents metadata folder to import",
      "default": "functional-contents-metadata"
    },
    "features": {
      "type": "object",
      "description": "Set of additional CMS features that can be activated or deactivated for the application",
      "properties": {
        "themingCssOverrideEnabled": {
          "type": "boolean",
          "description": "Specifies that the blueprint supports theming CSS file customization",
          "default": false
        },
        "themingCssVariablesEnabled": {
          "type": "boolean",
          "description": "Specifies that the blueprint supports theming CSS variables customization",
          "default": true
        }
      }
    },
    "migrationScriptFolder": {
      "type": "string",
      "description": "The relative path to the migration scripts",
      "default": "migration-scripts"
    },
    "migrationScriptVersionDependency": {
      "type": "string",
      "description": "Name of the package dependency to get the current blueprint version from. If the dependency is not found, the field version in the package.json will be used instead if defined. If not defined, no migration script will be executed"
    }
  }
}