summaryrefslogtreecommitdiffstats
path: root/toolkit/mozapps/extensions/docs/AMRemoteSettings-JSONSchema.json
blob: 46d15bc56ed31ee2d2fcd3eb1af3e76e09eafe32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": {
      "type": "string",
      "default": "AddonManagerSettings",
      "description": "The default id should NOT be changed, unless there is a specific need to create separate collection entries which target or exclude specific Firefox versions."
    },
    "installTriggerDeprecation": {
      "$ref": "#/definitions/installTriggerDeprecation",
      "optional": true
    },
    "quarantinedDomains": {
      "$ref": "#/definitions/quarantinedDomains",
      "optional": true
    },
    "filter_expression": {
      "type": "string",
      "description": "This is NOT directly used by AMRemoteSettings, but has special functionality in Remote Settings.\nSee https://remote-settings.readthedocs.io/en/latest/target-filters.html#how",
      "optional": true
    }
  },
  "definitions": {
    "installTriggerDeprecation": {
      "type": "object",
      "properties": {
        "extensions.InstallTrigger.enabled": {
          "type": "boolean",
          "default": false,
          "description": "Show/Hide the InstallTrigger global completely (both the global and its methods will not be accessible anymore). IMPORTANT: The webcompat team should be consulted before turning this to false, because it may also potentially impact UA detection for some websites."
        },
        "extensions.InstallTriggerImpl.enabled": {
          "type": "boolean",
          "default": false,
          "description": "Show/Hide the InstallTrigger methods. The InstallTrigger global will remain visible but set to null."
        }
      },
      "description": "These settings control the visibility of the InstallTrigger global and its methods.",
      "additionalProperties": false
    },
    "quarantinedDomains": {
      "type": "object",
      "properties": {
        "extensions.quarantinedDomains.list": {
          "type": "string",
          "default": "",
          "maxLength": 1048576,
          "description": "Set of domains to be quarantined separated by a comma (e.g. 'domain1.org,domain2.com'). NOTE: this pref value should be set to a ASCII encoded string and its size smaller than 1MB"
        }
      },
      "description": "These settings provide a set of domain names to be quarantined (restricted by default to unverified extensions, which only the app or the user may grant back). IMPORTANT: The add-ons team should be consulted before introducing any new entry of this type.",
      "additionalProperties": false
    }
  }
}