summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/content-src/asrouter/templates/OnboardingMessage/WhatsNewMessage.schema.json
blob: 565b78adc6e8a9d737d1b4250eac7d8c8fec7cea (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "file:///WhatsNewMessage.schema.json",
  "title": "WhatsNewMessage",
  "description": "A template for the messages that appear in the What's New panel.",
  "allOf": [
    { "$ref": "file:///FxMSCommon.schema.json#/$defs/Message" }
  ],
  "type": "object",
  "properties": {
    "content": {
      "type": "object",
      "properties": {
        "layout": {
          "description": "Different message layouts",
          "enum": [
            "tracking-protections"
          ]
        },
        "bucket_id": {
          "type": "string",
          "description": "A bucket identifier for the addon. This is used in order to anonymize telemetry for history-sensitive targeting."
        },
        "published_date": {
          "type": "integer",
          "description": "The date/time (number of milliseconds elapsed since January 1, 1970 00:00:00 UTC) the message was published."
        },
        "title": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "Id of localized string or message override of What's New message title"
        },
        "subtitle": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "Id of localized string or message override of What's New message subtitle"
        },
        "body": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "Id of localized string or message override of What's New message body"
        },
        "link_text": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "(optional) Id of localized string or message override of What's New message link text"
        },
        "cta_url": {
          "description": "Target URL for the What's New message.",
          "type": "string",
          "format": "moz-url-format"
        },
        "cta_type": {
          "description": "Type of url open action",
          "enum": [
            "OPEN_URL",
            "OPEN_ABOUT_PAGE",
            "OPEN_PROTECTION_REPORT"
          ]
        },
        "cta_where": {
          "description": "How to open the cta: new window, tab, focused, unfocused.",
          "enum": [
            "current",
            "tabshifted",
            "tab",
            "save",
            "window"
          ]
        },
        "icon_url": {
          "description": "(optional) URL for the What's New message icon.",
          "type": "string",
          "format": "uri"
        },
        "icon_alt": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "Alt text for image."
        }
      },
      "additionalProperties": true,
      "required": [
        "published_date",
        "title",
        "body",
        "cta_url",
        "bucket_id"
      ]
    },
    "template": {
      "type": "string",
      "const": "whatsnew_panel_message"
    }
  },
  "required": ["order"],
  "additionalProperties": true
}