summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/content-src/asrouter/templates/OnboardingMessage/ProtectionsPanelMessage.schema.json
blob: 8ef9b802e1c14dfa86c365cb7f1a912da2bde1c9 (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
57
58
59
60
61
62
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "file:///ProtectionsPanelMessage.schema.json",
  "title": "ProtectionsPanelMessage",
  "description": "A message shown in the protections panel.",
  "allOf": [{ "$ref": "file:///FxMSCommon.schema.json#/$defs/Message" }],
  "type": "object",
  "properties": {
    "content": {
      "type": "object",
      "properties": {
        "title": {
          "description": "The message title.",
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText"
        },
        "body": {
          "description": "The body of the message.",
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText"
        },
        "link_text": {
          "description": "The text of the call to action link.",
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText"
        },
        "cta_type": {
          "description": "The type of URL open action.",
          "type": "string",
          "enum": ["OPEN_URL", "OPEN_PROTECTION_REPORT", "OPEN_ABOUT_PAGE"]
        },
        "cta_url": {
          "description": "The URL to open when the call to action is clicked",
          "type": "string",
          "format": "moz-url-format"
        },
        "cta_where": {
          "description": "How to open the cta.",
          "type": "string",
          "enum": ["current", "tabshifted", "tab", "save", "window"]
        }
      },
      "dependantSchemas": {
        "link_text": ["cta_type", "cta_url"],
        "cta_type": ["link_text"],
        "cta_url": ["link_text"],
        "cta_where": ["link_text"]
      },
      "additionalProperties": false,
      "required": ["title", "body"]
    },
    "template": {
      "type": "string",
      "const": "protections_panel"
    },
    "trigger": {
      "description": "An action to trigger potentially showing the message. The action ID `protectionsPanelOpen` is required.",
      "const": {
        "id": "protectionsPanelOpen"
      }
    }
  },
  "required": ["content", "template", "trigger"],
  "additionalProperties": true
}