@mozilla/nimbus-schemas 3001.0.0 → 3003.0.0

package/schemas/ExperimentOutcome.schema.json

@@ -3,13 +3,13 @@
   "title": "ExperimentOutcome",
   "type": "object",
   "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": [

package/schemas/NimbusExperimentV7.schema.json

@@ -4,76 +4,49 @@
   "description": "A Nimbus experiment for V7.",
   "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.",
-      "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"
     },
-    "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\".",
+    "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"
     },
-    "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"
+    "branches": {
+      "description": "Branch configuration for the experiment.",
+      "items": {
+        "$ref": "#/$defs/BaseExperimentBranch"
+      },
+      "type": "array"
     },
     "bucketConfig": {
       "$ref": "#/$defs/ExperimentBucketConfig",
       "description": "Bucketing configuration."
     },
-    "outcomes": {
-      "description": "A list of outcomes relevant to the experiment analysis.",
-      "items": {
-        "$ref": "#/$defs/ExperimentOutcome"
-      },
-      "type": "array"
+    "channel": {
+      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
+      "type": "string"
     },
-    "featureIds": {
-      "description": "A list of featureIds the experiment contains configurations for.",
+    "documentationLinks": {
+      "description": "All documentation links associated with this experiment.",
       "items": {
-        "type": "string"
+        "$ref": "#/$defs/DocumentationLink"
       },
       "type": "array"
     },
-    "targeting": {
+    "endDate": {
       "anyOf": [
         {
+          "format": "date",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "A JEXL targeting expression used to filter out experiments."
+      "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
     },
-    "startDate": {
+    "enrollmentEndDate": {
       "anyOf": [
         {
           "format": "date",
@@ -83,41 +56,44 @@
           "type": "null"
         }
       ],
-      "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
+      "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
     },
-    "enrollmentEndDate": {
+    "featureIds": {
+      "description": "A list of featureIds the experiment contains configurations for.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "firefoxLabsDescription": {
       "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 description shown in Firefox Labs (Fluent ID or Resource ID)"
     },
-    "endDate": {
+    "firefoxLabsDescriptionLinks": {
       "anyOf": [
         {
-          "format": "date",
-          "type": "string"
+          "additionalProperties": {
+            "format": "uri",
+            "maxLength": 2083,
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "object"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
-    },
-    "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).",
-      "type": "integer"
-    },
-    "proposedEnrollment": {
-      "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"
+      "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."
     },
-    "referenceBranch": {
+    "firefoxLabsTitle": {
       "anyOf": [
         {
           "type": "string"
@@ -126,7 +102,23 @@
           "type": "null"
         }
       ],
-      "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
+      "description": "The title shown in Firefox Labs (Fluent ID or Resource ID)"
+    },
+    "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": [
@@ -153,6 +145,21 @@
       ],
       "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).",
+      "type": "integer"
+    },
+    "proposedEnrollment": {
+      "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"
+    },
     "publishedDate": {
       "anyOf": [
         {
@@ -165,19 +172,59 @@
       ],
       "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
     },
-    "branches": {
-      "description": "Branch configuration for the experiment.",
-      "items": {
-        "$ref": "#/$defs/BaseExperimentBranch"
-      },
-      "type": "array"
+    "referenceBranch": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
     },
-    "documentationLinks": {
-      "description": "All documentation links associated with this experiment.",
-      "items": {
-        "$ref": "#/$defs/DocumentationLink"
-      },
-      "type": "array"
+    "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": [
+        {
+          "format": "date",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
+    },
+    "targeting": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "A JEXL targeting expression used to filter out experiments."
+    },
+    "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": [
@@ -199,23 +246,40 @@
     "branches",
     "documentationLinks"
   ],
+  "dependentSchemas": {
+    "isFirefoxLabsOptIn": {
+      "if": {
+        "properties": {
+          "isFirefoxLabsOptIn": {
+            "const": true
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "firefoxLabsDescription",
+          "firefoxLabsTitle"
+        ]
+      }
+    }
+  },
   "$defs": {
     "BaseExperimentBranch": {
       "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": [
@@ -227,13 +291,13 @@
     },
     "DocumentationLink": {
       "properties": {
-        "title": {
-          "description": "The name associated with the link.",
-          "type": "string"
-        },
         "link": {
           "description": "The URL associated with the link.",
           "type": "string"
+        },
+        "title": {
+          "description": "The name associated with the link.",
+          "type": "string"
         }
       },
       "required": [
@@ -244,21 +308,21 @@
     },
     "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"
@@ -280,6 +344,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
@@ -302,13 +367,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": [

package/schemas/SdkFeatureManifest.schema.json

@@ -16,6 +16,13 @@
       ],
       "type": "string"
     },
+    "PrefBranch": {
+      "enum": [
+        "default",
+        "user"
+      ],
+      "type": "string"
+    },
     "SdkFeature": {
       "description": "A feature.",
       "if": {
@@ -26,28 +33,28 @@
         }
       },
       "properties": {
+        "allow-coenrollment": {
+          "description": "If true, clients can enroll in multiple experiments and rollouts that use this feature.",
+          "type": "boolean"
+        },
         "description": {
           "description": "The description of the feature.",
           "type": "string"
         },
-        "hasExposure": {
-          "description": "Whether or not this feature records exposure telemetry.",
-          "type": "boolean"
-        },
         "exposureDescription": {
           "description": "A description of the exposure telemetry collected by this feature. Only required if hasExposure is true.",
           "type": "string"
         },
+        "hasExposure": {
+          "description": "Whether or not this feature records exposure telemetry.",
+          "type": "boolean"
+        },
         "variables": {
           "additionalProperties": {
             "$ref": "#/$defs/SdkFeatureVariable"
           },
           "description": "The variables that this feature can set.",
           "type": "object"
-        },
-        "allow-coenrollment": {
-          "description": "If true, clients can enroll in multiple experiments and rollouts that use this feature.",
-          "type": "boolean"
         }
       },
       "required": [
@@ -78,16 +85,20 @@
           "description": "A description of the feature.",
           "type": "string"
         },
-        "type": {
-          "$ref": "#/$defs/FeatureVariableType",
-          "description": "The field type."
-        },
         "enum": {
           "description": "An optional list of possible string values. Only allowed when type is string.",
           "items": {
             "type": "string"
           },
           "type": "array"
+        },
+        "setPref": {
+          "$ref": "#/$defs/SetPref",
+          "description": "A pref that should be set to the value of this variable when enrolling. Only supported in Firefox for Android 152+. "
+        },
+        "type": {
+          "$ref": "#/$defs/FeatureVariableType",
+          "description": "The field type."
         }
       },
       "required": [
@@ -95,6 +106,23 @@
         "type"
       ],
       "type": "object"
+    },
+    "SetPref": {
+      "properties": {
+        "branch": {
+          "$ref": "#/$defs/PrefBranch",
+          "description": "The branch the pref will be set on. Prefs set on the user branch persists through restarts."
+        },
+        "pref": {
+          "description": "The name of the pref to set.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "branch",
+        "pref"
+      ],
+      "type": "object"
     }
   }
 }