summaryrefslogtreecommitdiffstats
path: root/toolkit/components/nimbus/schemas/ExperimentFeatureRemote.schema.json
blob: a43d7d06af1015ca158b32335682498b3eb9398f (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$ref": "#/definitions/Feature",
  "definitions": {
    "RemoteFeatureConfigurations": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Feature name for which the defaults are provided."
        },
        "configurations": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "slug": {
                "type": "string",
                "description": "Configuration identifier that will be included in Telemetry."
              },
              "variables": {
                "type": "object",
                "description": "Key value pairs that should match the feature manifest definition.",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  }
                },
                "required": ["enabled"]
              },
              "targeting": {
                "type": "string",
                "description": "Target the configuration only to specific clients."
              },
              "bucketConfig": {
                "type": "object",
                "properties": {
                  "randomizationUnit": {
                    "type": "string",
                    "description": "A unique, stable identifier for the user used as an input to bucket hashing"
                  },
                  "namespace": {
                    "type": "string",
                    "description": "Additional inputs to the hashing function"
                  },
                  "start": {
                    "type": "number",
                    "description": "Index of start of the range of buckets"
                  },
                  "count": {
                    "type": "number",
                    "description": "Number of buckets to check"
                  },
                  "total": {
                    "type": "number",
                    "description": "Total number of buckets",
                    "default": 10000
                  }
                },
                "required": [
                  "randomizationUnit",
                  "namespace",
                  "start",
                  "count",
                  "total"
                ],
                "additionalProperties": false,
                "description": "Bucketing configuration"
              },
              "description": {
                "type": "string",
                "description": "Explanation for configuration and targeting"
              }
            },
            "required": ["variables", "targeting", "bucketConfig", "slug"],
            "additionalProperties": false
          }
        }
      },
      "required": ["id", "configurations"],
      "additionalProperties": false
    },
    "RemoteFeatureConfiguration": {
      "type": "object",
      "properties": {
        "slug": {
          "type": "string",
          "description": "Configuration identifier that will be included in Telemetry."
        },
        "isEarlyStartup": {
          "type": "boolean",
          "description": "If the feature values should be cached in prefs for fast early startup."
        },
        "variables": {
          "type": "object",
          "description": "Key value pairs that should match the feature manifest definition.",
          "properties": {
            "enabled": {
              "type": "boolean"
            }
          },
          "required": ["enabled"]
        },
        "targeting": {
          "type": "string",
          "description": "Target the configuration only to specific clients."
        },
        "bucketConfig": {
          "type": "object",
          "properties": {
            "randomizationUnit": {
              "type": "string",
              "description": "A unique, stable identifier for the user used as an input to bucket hashing"
            },
            "namespace": {
              "type": "string",
              "description": "Additional inputs to the hashing function"
            },
            "start": {
              "type": "number",
              "description": "Index of start of the range of buckets"
            },
            "count": {
              "type": "number",
              "description": "Number of buckets to check"
            },
            "total": {
              "type": "number",
              "description": "Total number of buckets",
              "default": 10000
            }
          },
          "required": [
            "randomizationUnit",
            "namespace",
            "start",
            "count",
            "total"
          ],
          "additionalProperties": false,
          "description": "Bucketing configuration"
        },
        "description": {
          "type": "string",
          "description": "Explanation for configuration and targeting"
        }
      },
      "required": ["variables", "targeting", "slug"],
      "additionalProperties": false
    }
  }
}