summaryrefslogtreecommitdiffstats
path: root/toolkit/components/normandy/schemas
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /toolkit/components/normandy/schemas
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/normandy/schemas')
-rw-r--r--toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json73
1 files changed, 73 insertions, 0 deletions
diff --git a/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json b/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json
new file mode 100644
index 0000000000..6915fc9b71
--- /dev/null
+++ b/toolkit/components/normandy/schemas/LegacyHeartbeat.schema.json
@@ -0,0 +1,73 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "title": "Legacy (Normandy) Heartbeat, via Nimbus",
+ "description": "The schema for the Legacy Heartbeat Nimbus feature.",
+ "type": "object",
+ "properties": {
+ "survey": {
+ "$comment": "Hearbeat arguments are nested under survey to prevent simultaneous rollouts and experiments from overriding eachothers optional variables",
+ "type": "object",
+ "properties": {
+ "repeatOption": {
+ "type": "string",
+ "enum": ["once", "xdays", "nag"],
+ "description": "Determines how often a prompt is shown executes.",
+ "default": "once"
+ },
+ "repeatEvery": {
+ "description": "For repeatOption=xdays, how often (in days) the prompt is displayed.",
+ "default": null,
+ "type": ["number", "null"]
+ },
+ "includeTelemetryUUID": {
+ "type": "boolean",
+ "description": "Include unique user ID in post-answer-url and Telemetry",
+ "default": false
+ },
+ "surveyId": {
+ "description": "Slug uniquely identifying this survey in telemetry",
+ "type": "string"
+ },
+ "message": {
+ "description": "Message to show to the user",
+ "type": "string"
+ },
+ "engagementButtonLabel": {
+ "description": "Text for the engagement button. If specified, this button will be shown instead of rating stars.",
+ "default": null,
+ "type": ["string", "null"]
+ },
+ "thanksMessage": {
+ "description": "Thanks message to show to the user after they've rated Firefox",
+ "type": "string"
+ },
+ "postAnswerUrl": {
+ "description": "URL to redirect the user to after rating Firefox or clicking the engagement button",
+ "default": null,
+ "type": ["string", "null"]
+ },
+ "learnMoreMessage": {
+ "description": "Message to show to the user to learn more",
+ "default": null,
+ "type": ["string", "null"]
+ },
+ "learnMoreUrl": {
+ "description": "URL to show to the user when they click Learn More",
+ "default": null,
+ "type": ["string", "null"]
+ }
+ },
+ "required": [
+ "surveyId",
+ "message",
+ "thanksMessage",
+ "postAnswerUrl",
+ "learnMoreMessage",
+ "learnMoreUrl"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "required": ["survey"],
+ "additionalProperties": false
+}