@mozilla/nimbus-schemas 3001.0.0 → 3003.0.0

package/schemas/SdkNimbusExperiment.schema.json

@@ -4,56 +4,52 @@
   "description": "A Nimbus experiment for Nimbus SDK-based applications.",
   "type": "object",
   "properties": {
-    "schemaVersion": {
-      "description": "Version of the NimbusExperiment schema this experiment refers to",
-      "type": "string"
-    },
-    "slug": {
-      "description": "Unique identifier for the experiment",
-      "type": "string"
-    },
-    "id": {
-      "description": "Unique identifier for the experiiment. This is a duplicate of slug, but is required field for all Remote Settings records.",
+    "appId": {
+      "description": "The platform identifier for the targeted app. This should match app's identifier exactly as it appears in the relevant app store listing (for relevant platforms) or the app's Glean initialization (for other platforms). Examples are \"org.mozilla.firefox_beta\" and \"firefox-desktop\".",
       "type": "string"
     },
     "appName": {
       "description": "A slug identifying the targeted product of this experiment. It should be a lowercased_with_underscores name that is short and unambiguous and it should match the app_name found in https://probeinfo.telemetry.mozilla.org/glean/repositories. Examples are \"fenix\" and \"firefox_desktop\".",
       "type": "string"
     },
-    "appId": {
-      "description": "The platform identifier for the targeted app. This should match app's identifier exactly as it appears in the relevant app store listing (for relevant platforms) or the app's Glean initialization (for other platforms). Examples are \"org.mozilla.firefox_beta\" and \"firefox-desktop\".",
-      "type": "string"
+    "branches": {
+      "description": "Branch configuration for the SDK experiment.",
+      "items": {
+        "$ref": "#/$defs/SdkExperimentBranch"
+      },
+      "type": "array"
+    },
+    "bucketConfig": {
+      "$ref": "#/$defs/ExperimentBucketConfig",
+      "description": "Bucketing configuration."
     },
     "channel": {
       "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
       "type": "string"
     },
-    "userFacingName": {
-      "description": "Public name of the experiment that will be displayed on \"about:studies\".",
-      "type": "string"
-    },
-    "userFacingDescription": {
-      "description": "Short public description of the experiment that will be displayed on \"about:studies\".",
-      "type": "string"
-    },
-    "isEnrollmentPaused": {
-      "description": "When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.",
-      "type": "boolean"
-    },
-    "isRollout": {
-      "description": "When this property is set to true, treat this experiment as a rollout. Rollouts are currently handled as single-branch experiments separated from the bucketing namespace for normal experiments. See-also: https://mozilla-hub.atlassian.net/browse/SDK-405",
-      "type": "boolean"
-    },
-    "bucketConfig": {
-      "$ref": "#/$defs/ExperimentBucketConfig",
-      "description": "Bucketing configuration."
+    "endDate": {
+      "anyOf": [
+        {
+          "format": "date",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
     },
-    "outcomes": {
-      "description": "A list of outcomes relevant to the experiment analysis.",
-      "items": {
-        "$ref": "#/$defs/ExperimentOutcome"
-      },
-      "type": "array"
+    "enrollmentEndDate": {
+      "anyOf": [
+        {
+          "format": "date",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
     },
     "featureIds": {
       "description": "A list of featureIds the experiment contains configurations for.",
@@ -62,7 +58,7 @@
       },
       "type": "array"
     },
-    "targeting": {
+    "firefoxLabsDescription": {
       "anyOf": [
         {
           "type": "string"
@@ -71,43 +67,83 @@
           "type": "null"
         }
       ],
-      "description": "A JEXL targeting expression used to filter out experiments."
+      "description": "The description shown in Firefox Labs (Fluent ID or Resource ID)"
     },
-    "startDate": {
+    "firefoxLabsDescriptionLinks": {
       "anyOf": [
         {
-          "format": "date",
-          "type": "string"
+          "additionalProperties": {
+            "format": "uri",
+            "maxLength": 2083,
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "object"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
+      "description": "Links that will be used with the firefoxLabsDescription Fluent ID. May be null for Firefox Labs Opt-In recipes that do not use links."
     },
-    "enrollmentEndDate": {
+    "firefoxLabsTitle": {
       "anyOf": [
         {
-          "format": "date",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
+      "description": "The title shown in Firefox Labs (Fluent ID or Resource ID)"
     },
-    "endDate": {
+    "id": {
+      "description": "Unique identifier for the experiiment. This is a duplicate of slug, but is required field for all Remote Settings records.",
+      "type": "string"
+    },
+    "isEnrollmentPaused": {
+      "description": "When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.",
+      "type": "boolean"
+    },
+    "isFirefoxLabsOptIn": {
+      "description": "When this property is set to true, treat this experiment as a Firefox Labs experiment",
+      "type": "boolean"
+    },
+    "isRollout": {
+      "description": "When this property is set to true, treat this experiment as a rollout. Rollouts are currently handled as single-branch experiments separated from the bucketing namespace for normal experiments. See-also: https://mozilla-hub.atlassian.net/browse/SDK-405",
+      "type": "boolean"
+    },
+    "locales": {
       "anyOf": [
         {
-          "format": "date",
-          "type": "string"
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
+      "description": "The list of locale codes (e.g., \"en-US\" or \"fr\") that this experiment is targeting. If null, all locales are targeted."
+    },
+    "localizations": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/ExperimentLocalizations"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Per-locale localization substitutions."
+    },
+    "outcomes": {
+      "description": "A list of outcomes relevant to the experiment analysis.",
+      "items": {
+        "$ref": "#/$defs/ExperimentOutcome"
+      },
+      "type": "array"
     },
     "proposedDuration": {
       "description": "Duration of the experiment from the start date in days. Note that this property is only used during the analysis phase (i.e., not by the SDK).",
@@ -117,60 +153,71 @@
       "description": "This represents the number of days that we expect to enroll new users. Note that this property is only used during the analysis phase (i.e., not by the SDK).",
       "type": "integer"
     },
-    "referenceBranch": {
+    "publishedDate": {
       "anyOf": [
         {
+          "format": "date-time",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
+      "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
     },
-    "locales": {
+    "referenceBranch": {
       "anyOf": [
         {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
+          "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "The list of locale codes (e.g., \"en-US\" or \"fr\") that this experiment is targeting. If null, all locales are targeted."
+      "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
     },
-    "localizations": {
+    "requiresRestart": {
+      "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
+      "type": "boolean"
+    },
+    "schemaVersion": {
+      "description": "Version of the NimbusExperiment schema this experiment refers to",
+      "type": "string"
+    },
+    "slug": {
+      "description": "Unique identifier for the experiment",
+      "type": "string"
+    },
+    "startDate": {
       "anyOf": [
         {
-          "$ref": "#/$defs/ExperimentLocalizations"
+          "format": "date",
+          "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Per-locale localization substitutions."
+      "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
     },
-    "publishedDate": {
+    "targeting": {
       "anyOf": [
         {
-          "format": "date-time",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
+      "description": "A JEXL targeting expression used to filter out experiments."
     },
-    "branches": {
-      "description": "Branch configuration for the SDK experiment.",
-      "items": {
-        "$ref": "#/$defs/SdkExperimentBranch"
-      },
-      "type": "array"
+    "userFacingDescription": {
+      "description": "Short public description of the experiment that will be displayed on \"about:studies\".",
+      "type": "string"
+    },
+    "userFacingName": {
+      "description": "Public name of the experiment that will be displayed on \"about:studies\".",
+      "type": "string"
     }
   },
   "required": [
@@ -191,24 +238,48 @@
     "referenceBranch",
     "branches"
   ],
+  "dependentSchemas": {
+    "isFirefoxLabsOptIn": {
+      "if": {
+        "properties": {
+          "isFirefoxLabsOptIn": {
+            "const": true
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "isRollout": {
+            "const": true
+          }
+        },
+        "required": [
+          "firefoxLabsDescription",
+          "firefoxLabsTitle",
+          "isRollout"
+        ],
+        "type": "object"
+      }
+    }
+  },
   "$defs": {
     "ExperimentBucketConfig": {
       "properties": {
-        "randomizationUnit": {
-          "$ref": "#/$defs/RandomizationUnit"
+        "count": {
+          "description": "Number of buckets in the range.",
+          "type": "integer"
         },
         "namespace": {
           "description": "Additional inputs to the hashing function.",
           "type": "string"
         },
+        "randomizationUnit": {
+          "$ref": "#/$defs/RandomizationUnit"
+        },
         "start": {
           "description": "Index of the starting bucket of the range.",
           "type": "integer"
         },
-        "count": {
-          "description": "Number of buckets in the range.",
-          "type": "integer"
-        },
         "total": {
           "description": "The total number of buckets. You can assume this will always be 10000.",
           "type": "integer"
@@ -230,6 +301,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
@@ -252,13 +324,13 @@
     },
     "ExperimentOutcome": {
       "properties": {
-        "slug": {
-          "description": "Identifier for the outcome.",
-          "type": "string"
-        },
         "priority": {
           "description": "e.g., \"primary\" or \"secondary\".",
           "type": "string"
+        },
+        "slug": {
+          "description": "Identifier for the outcome.",
+          "type": "string"
         }
       },
       "required": [
@@ -280,20 +352,20 @@
     "SdkExperimentBranch": {
       "description": "The branch definition for SDK-based applications. Supported on Firefox for Android 96+, Firefox for iOS 39+, and all versions of Cirrus.",
       "properties": {
-        "slug": {
-          "description": "Identifier for the branch.",
-          "type": "string"
-        },
-        "ratio": {
-          "description": "Relative ratio of population for the branch. e.g., if branch A=1 and branch B=3, then branch A would get 25% of the population.",
-          "type": "integer"
-        },
         "features": {
           "description": "An array of feature configurations.",
           "items": {
             "$ref": "#/$defs/ExperimentFeatureConfig"
           },
           "type": "array"
+        },
+        "ratio": {
+          "description": "Relative ratio of population for the branch. e.g., if branch A=1 and branch B=3, then branch A would get 25% of the population.",
+          "type": "integer"
+        },
+        "slug": {
+          "description": "Identifier for the branch.",
+          "type": "string"
         }
       },
       "required": [