@mozilla/nimbus-schemas 2024.11.5 → 2024.12.2

package/index.d.ts

@@ -160,17 +160,27 @@ export interface DesktopAllVersionsNimbusExperiment {
    */
   isFirefoxLabsOptIn?: boolean;
   /**
-   * An optional string containing the Fluent ID for the title of the opt-in
+   * The group this should appear under in Firefox Labs
+   */
+  firefoxLabsGroup?: string | null;
+  /**
+   * The title shown in Firefox Labs (Fluent ID)
    */
   firefoxLabsTitle?: string | null;
   /**
-   * An optional string containing the Fluent ID for the description of the opt-in
+   * The description shown in Firefox Labs (Fluent ID)
    */
   firefoxLabsDescription?: string | null;
   /**
    * Opt out of feature schema validation.
    */
   featureValidationOptOut?: boolean;
+  /**
+   * Does the experiment require a restart to take effect?
+   *
+   * Only used by Firefox Labs Opt-Ins.
+   */
+  requiresRestart?: boolean;
   localizations?: ExperimentLocalizations | null;
 }
 export interface ExperimentBucketConfig {
@@ -226,7 +236,7 @@ export interface DesktopAllVersionsExperimentBranch {
    */
   features: ExperimentFeatureConfig[];
   /**
-   * An optional string containing the title of the branch
+   * The branch title shown in Firefox Labs (Fluent ID)
    */
   firefoxLabsTitle?: string | null;
   feature: DesktopPre95FeatureConfig;
@@ -491,17 +501,27 @@ export interface DesktopNimbusExperiment {
    */
   isFirefoxLabsOptIn?: boolean;
   /**
-   * An optional string containing the Fluent ID for the title of the opt-in
+   * The group this should appear under in Firefox Labs
+   */
+  firefoxLabsGroup?: string | null;
+  /**
+   * The title shown in Firefox Labs (Fluent ID)
    */
   firefoxLabsTitle?: string | null;
   /**
-   * An optional string containing the Fluent ID for the description of the opt-in
+   * The description shown in Firefox Labs (Fluent ID)
    */
   firefoxLabsDescription?: string | null;
   /**
    * Opt out of feature schema validation.
    */
   featureValidationOptOut?: boolean;
+  /**
+   * Does the experiment require a restart to take effect?
+   *
+   * Only used by Firefox Labs Opt-Ins.
+   */
+  requiresRestart?: boolean;
   localizations?: ExperimentLocalizations | null;
 }
 /**
@@ -523,7 +543,7 @@ export interface DesktopExperimentBranch {
    */
   features: ExperimentFeatureConfig[];
   /**
-   * An optional string containing the title of the branch
+   * The branch title shown in Firefox Labs (Fluent ID)
    */
   firefoxLabsTitle?: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/nimbus-schemas",
-  "version": "2024.11.5",
+  "version": "2024.12.2",
   "description": "Schemas used by Mozilla Nimbus and related projects.",
   "main": "index.d.ts",
   "repository": {

package/schemas/DesktopAllVersionsNimbusExperiment.schema.json

@@ -165,6 +165,17 @@
       "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
       "type": "boolean"
     },
+    "firefoxLabsGroup": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The group this should appear under in Firefox Labs"
+    },
     "firefoxLabsTitle": {
       "anyOf": [
         {
@@ -174,7 +185,7 @@
           "type": "null"
         }
       ],
-      "description": "An optional string containing the Fluent ID for the title of the opt-in"
+      "description": "The title shown in Firefox Labs (Fluent ID)"
     },
     "firefoxLabsDescription": {
       "anyOf": [
@@ -185,12 +196,16 @@
           "type": "null"
         }
       ],
-      "description": "An optional string containing the Fluent ID for the description of the opt-in"
+      "description": "The description shown in Firefox Labs (Fluent ID)"
     },
     "featureValidationOptOut": {
       "description": "Opt out of feature schema validation.",
       "type": "boolean"
     },
+    "requiresRestart": {
+      "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
+      "type": "boolean"
+    },
     "localizations": {
       "anyOf": [
         {
@@ -239,17 +254,10 @@
             "isRollout"
           ]
         },
-        "properties": {
-          "firefoxLabsTitle": {
-            "type": "string"
-          },
-          "firefoxLabsDescription": {
-            "type": "string"
-          }
-        },
         "required": [
-          "firefoxLabsTitle",
-          "firefoxLabsDescription"
+          "firefoxLabsDescription",
+          "firefoxLabsGroup",
+          "firefoxLabsTitle"
         ],
         "then": {
           "properties": {
@@ -293,7 +301,7 @@
               "type": "null"
             }
           ],
-          "description": "An optional string containing the title of the branch"
+          "description": "The branch title shown in Firefox Labs (Fluent ID)"
         },
         "feature": {
           "$ref": "#/$defs/DesktopPre95FeatureConfig",

package/schemas/DesktopNimbusExperiment.schema.json

@@ -165,6 +165,17 @@
       "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
       "type": "boolean"
     },
+    "firefoxLabsGroup": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The group this should appear under in Firefox Labs"
+    },
     "firefoxLabsTitle": {
       "anyOf": [
         {
@@ -174,7 +185,7 @@
           "type": "null"
         }
       ],
-      "description": "An optional string containing the Fluent ID for the title of the opt-in"
+      "description": "The title shown in Firefox Labs (Fluent ID)"
     },
     "firefoxLabsDescription": {
       "anyOf": [
@@ -185,12 +196,16 @@
           "type": "null"
         }
       ],
-      "description": "An optional string containing the Fluent ID for the description of the opt-in"
+      "description": "The description shown in Firefox Labs (Fluent ID)"
     },
     "featureValidationOptOut": {
       "description": "Opt out of feature schema validation.",
       "type": "boolean"
     },
+    "requiresRestart": {
+      "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
+      "type": "boolean"
+    },
     "localizations": {
       "anyOf": [
         {
@@ -239,17 +254,10 @@
             "isRollout"
           ]
         },
-        "properties": {
-          "firefoxLabsTitle": {
-            "type": "string"
-          },
-          "firefoxLabsDescription": {
-            "type": "string"
-          }
-        },
         "required": [
-          "firefoxLabsTitle",
-          "firefoxLabsDescription"
+          "firefoxLabsDescription",
+          "firefoxLabsGroup",
+          "firefoxLabsTitle"
         ],
         "then": {
           "properties": {
@@ -293,7 +301,7 @@
               "type": "null"
             }
           ],
-          "description": "An optional string containing the title of the branch"
+          "description": "The branch title shown in Firefox Labs (Fluent ID)"
         }
       },
       "required": [