unleash-server 4.21.0-beta.21 → 4.21.0-beta.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/lib/openapi/index.d.ts +639 -9
  2. package/dist/lib/openapi/spec/client-features-schema.d.ts +15 -0
  3. package/dist/lib/openapi/spec/environment-schema.d.ts +15 -0
  4. package/dist/lib/openapi/spec/environment-schema.js +15 -0
  5. package/dist/lib/openapi/spec/environment-schema.js.map +1 -1
  6. package/dist/lib/openapi/spec/environments-schema.d.ts +15 -0
  7. package/dist/lib/openapi/spec/export-result-schema.d.ts +48 -0
  8. package/dist/lib/openapi/spec/feature-environment-schema.d.ts +12 -0
  9. package/dist/lib/openapi/spec/feature-environment-schema.js +12 -0
  10. package/dist/lib/openapi/spec/feature-environment-schema.js.map +1 -1
  11. package/dist/lib/openapi/spec/feature-schema.d.ts +36 -0
  12. package/dist/lib/openapi/spec/feature-schema.js +24 -0
  13. package/dist/lib/openapi/spec/feature-schema.js.map +1 -1
  14. package/dist/lib/openapi/spec/features-schema.d.ts +63 -0
  15. package/dist/lib/openapi/spec/group-schema.d.ts +1 -0
  16. package/dist/lib/openapi/spec/group-schema.js +1 -0
  17. package/dist/lib/openapi/spec/group-schema.js.map +1 -1
  18. package/dist/lib/openapi/spec/groups-schema.d.ts +1 -0
  19. package/dist/lib/openapi/spec/health-overview-schema.d.ts +82 -0
  20. package/dist/lib/openapi/spec/health-report-schema.d.ts +82 -0
  21. package/dist/lib/openapi/spec/profile-schema.d.ts +36 -0
  22. package/dist/lib/openapi/spec/project-overview-schema.d.ts +100 -0
  23. package/dist/lib/openapi/spec/project-overview-schema.js +18 -0
  24. package/dist/lib/openapi/spec/project-overview-schema.js.map +1 -1
  25. package/dist/lib/openapi/spec/project-schema.d.ts +16 -3
  26. package/dist/lib/openapi/spec/project-schema.js +16 -3
  27. package/dist/lib/openapi/spec/project-schema.js.map +1 -1
  28. package/dist/lib/openapi/spec/project-schema.test.js +0 -1
  29. package/dist/lib/openapi/spec/project-schema.test.js.map +1 -1
  30. package/dist/lib/openapi/spec/project-stats-schema.d.ts +19 -0
  31. package/dist/lib/openapi/spec/project-stats-schema.js +23 -0
  32. package/dist/lib/openapi/spec/project-stats-schema.js.map +1 -1
  33. package/dist/lib/openapi/spec/projects-schema.d.ts +18 -3
  34. package/dist/lib/openapi/spec/projects-schema.js +2 -0
  35. package/dist/lib/openapi/spec/projects-schema.js.map +1 -1
  36. package/dist/lib/openapi/spec/state-schema.d.ts +79 -3
  37. package/dist/lib/openapi/spec/users-groups-base-schema.d.ts +1 -0
  38. package/dist/lib/routes/admin-api/project/features.js +2 -2
  39. package/dist/lib/routes/admin-api/project/features.js.map +1 -1
  40. package/dist/lib/routes/admin-api/project/index.d.ts +2 -2
  41. package/dist/lib/routes/admin-api/project/index.js +1 -1
  42. package/dist/lib/routes/admin-api/project/index.js.map +1 -1
  43. package/dist/lib/services/openapi-service.d.ts +1 -0
  44. package/dist/lib/services/openapi-service.js +4 -0
  45. package/dist/lib/services/openapi-service.js.map +1 -1
  46. package/dist/lib/services/proxy-service.js +2 -1
  47. package/dist/lib/services/proxy-service.js.map +1 -1
  48. package/dist/lib/types/experimental.d.ts +1 -0
  49. package/dist/lib/types/experimental.js +1 -0
  50. package/dist/lib/types/experimental.js.map +1 -1
  51. package/dist/lib/types/model.d.ts +1 -1
  52. package/dist/lib/util/feature-evaluator/repository/index.d.ts +3 -1
  53. package/dist/lib/util/feature-evaluator/repository/index.js +7 -3
  54. package/dist/lib/util/feature-evaluator/repository/index.js.map +1 -1
  55. package/dist/lib/util/offline-unleash-client.test.js +1 -0
  56. package/dist/lib/util/offline-unleash-client.test.js.map +1 -1
  57. package/dist/test/e2e/api/admin/project/environments.e2e.test.js +7 -1
  58. package/dist/test/e2e/api/admin/project/environments.e2e.test.js.map +1 -1
  59. package/dist/test/e2e/api/admin/project/features.e2e.test.js +7 -1
  60. package/dist/test/e2e/api/admin/project/features.e2e.test.js.map +1 -1
  61. package/dist/test/e2e/api/admin/project/projects.e2e.test.js +7 -1
  62. package/dist/test/e2e/api/admin/project/projects.e2e.test.js.map +1 -1
  63. package/dist/test/e2e/api/admin/strategy.e2e.test.js +7 -1
  64. package/dist/test/e2e/api/admin/strategy.e2e.test.js.map +1 -1
  65. package/package.json +2 -2
@@ -1303,33 +1303,48 @@ export declare const schemas: {
1303
1303
  readonly type: "object";
1304
1304
  readonly additionalProperties: false;
1305
1305
  readonly required: readonly ["name", "type", "enabled"];
1306
+ readonly description: "A definition of the project environment";
1306
1307
  readonly properties: {
1307
1308
  readonly name: {
1308
1309
  readonly type: "string";
1310
+ readonly example: "my-dev-env";
1311
+ readonly description: "The name of the environment";
1309
1312
  };
1310
1313
  readonly type: {
1311
1314
  readonly type: "string";
1315
+ readonly example: "development";
1316
+ readonly description: "The type of the environment";
1312
1317
  };
1313
1318
  readonly enabled: {
1314
1319
  readonly type: "boolean";
1320
+ readonly example: true;
1321
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
1315
1322
  };
1316
1323
  readonly protected: {
1317
1324
  readonly type: "boolean";
1318
1325
  };
1319
1326
  readonly sortOrder: {
1320
1327
  readonly type: "number";
1328
+ readonly example: 3;
1329
+ readonly description: "The sort order of the environment in the environments list";
1321
1330
  };
1322
1331
  readonly projectCount: {
1323
1332
  readonly type: "number";
1324
1333
  readonly nullable: true;
1334
+ readonly example: 10;
1335
+ readonly description: "The number of projects with this environment";
1325
1336
  };
1326
1337
  readonly apiTokenCount: {
1327
1338
  readonly type: "number";
1328
1339
  readonly nullable: true;
1340
+ readonly example: 6;
1341
+ readonly description: "The number of API tokens for the project environment";
1329
1342
  };
1330
1343
  readonly enabledToggleCount: {
1331
1344
  readonly type: "number";
1332
1345
  readonly nullable: true;
1346
+ readonly example: 10;
1347
+ readonly description: "The number of enabled toggles for the project environment";
1333
1348
  };
1334
1349
  };
1335
1350
  readonly components: {};
@@ -2085,33 +2100,48 @@ export declare const schemas: {
2085
2100
  readonly type: "object";
2086
2101
  readonly additionalProperties: false;
2087
2102
  readonly required: readonly ["name", "type", "enabled"];
2103
+ readonly description: "A definition of the project environment";
2088
2104
  readonly properties: {
2089
2105
  readonly name: {
2090
2106
  readonly type: "string";
2107
+ readonly example: "my-dev-env";
2108
+ readonly description: "The name of the environment";
2091
2109
  };
2092
2110
  readonly type: {
2093
2111
  readonly type: "string";
2112
+ readonly example: "development";
2113
+ readonly description: "The type of the environment";
2094
2114
  };
2095
2115
  readonly enabled: {
2096
2116
  readonly type: "boolean";
2117
+ readonly example: true;
2118
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
2097
2119
  };
2098
2120
  readonly protected: {
2099
2121
  readonly type: "boolean";
2100
2122
  };
2101
2123
  readonly sortOrder: {
2102
2124
  readonly type: "number";
2125
+ readonly example: 3;
2126
+ readonly description: "The sort order of the environment in the environments list";
2103
2127
  };
2104
2128
  readonly projectCount: {
2105
2129
  readonly type: "number";
2106
2130
  readonly nullable: true;
2131
+ readonly example: 10;
2132
+ readonly description: "The number of projects with this environment";
2107
2133
  };
2108
2134
  readonly apiTokenCount: {
2109
2135
  readonly type: "number";
2110
2136
  readonly nullable: true;
2137
+ readonly example: 6;
2138
+ readonly description: "The number of API tokens for the project environment";
2111
2139
  };
2112
2140
  readonly enabledToggleCount: {
2113
2141
  readonly type: "number";
2114
2142
  readonly nullable: true;
2143
+ readonly example: 10;
2144
+ readonly description: "The number of enabled toggles for the project environment";
2115
2145
  };
2116
2146
  };
2117
2147
  readonly components: {};
@@ -2171,33 +2201,48 @@ export declare const schemas: {
2171
2201
  readonly type: "object";
2172
2202
  readonly additionalProperties: false;
2173
2203
  readonly required: readonly ["name", "type", "enabled"];
2204
+ readonly description: "A definition of the project environment";
2174
2205
  readonly properties: {
2175
2206
  readonly name: {
2176
2207
  readonly type: "string";
2208
+ readonly example: "my-dev-env";
2209
+ readonly description: "The name of the environment";
2177
2210
  };
2178
2211
  readonly type: {
2179
2212
  readonly type: "string";
2213
+ readonly example: "development";
2214
+ readonly description: "The type of the environment";
2180
2215
  };
2181
2216
  readonly enabled: {
2182
2217
  readonly type: "boolean";
2218
+ readonly example: true;
2219
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
2183
2220
  };
2184
2221
  readonly protected: {
2185
2222
  readonly type: "boolean";
2186
2223
  };
2187
2224
  readonly sortOrder: {
2188
2225
  readonly type: "number";
2226
+ readonly example: 3;
2227
+ readonly description: "The sort order of the environment in the environments list";
2189
2228
  };
2190
2229
  readonly projectCount: {
2191
2230
  readonly type: "number";
2192
2231
  readonly nullable: true;
2232
+ readonly example: 10;
2233
+ readonly description: "The number of projects with this environment";
2193
2234
  };
2194
2235
  readonly apiTokenCount: {
2195
2236
  readonly type: "number";
2196
2237
  readonly nullable: true;
2238
+ readonly example: 6;
2239
+ readonly description: "The number of API tokens for the project environment";
2197
2240
  };
2198
2241
  readonly enabledToggleCount: {
2199
2242
  readonly type: "number";
2200
2243
  readonly nullable: true;
2244
+ readonly example: 10;
2245
+ readonly description: "The number of enabled toggles for the project environment";
2201
2246
  };
2202
2247
  };
2203
2248
  readonly components: {};
@@ -2494,57 +2539,80 @@ export declare const schemas: {
2494
2539
  readonly properties: {
2495
2540
  readonly name: {
2496
2541
  readonly type: "string";
2542
+ readonly example: "disable-comments";
2543
+ readonly description: "Unique feature name";
2497
2544
  };
2498
2545
  readonly type: {
2499
2546
  readonly type: "string";
2547
+ readonly example: "kill-switch";
2548
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
2500
2549
  };
2501
2550
  readonly description: {
2502
2551
  readonly type: "string";
2552
+ readonly nullable: true;
2553
+ readonly example: "Controls disabling of the comments section in case of an incident";
2554
+ readonly description: "Detailed description of the feature";
2503
2555
  };
2504
2556
  readonly archived: {
2505
2557
  readonly type: "boolean";
2558
+ readonly example: true;
2559
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
2506
2560
  };
2507
2561
  readonly project: {
2508
2562
  readonly type: "string";
2563
+ readonly example: "dx-squad";
2564
+ readonly description: "Name of the project the feature belongs to";
2509
2565
  };
2510
2566
  readonly enabled: {
2511
2567
  readonly type: "boolean";
2568
+ readonly example: true;
2512
2569
  };
2513
2570
  readonly stale: {
2514
2571
  readonly type: "boolean";
2572
+ readonly example: false;
2573
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
2515
2574
  };
2516
2575
  readonly favorite: {
2517
2576
  readonly type: "boolean";
2577
+ readonly example: true;
2578
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
2518
2579
  };
2519
2580
  readonly impressionData: {
2520
2581
  readonly type: "boolean";
2582
+ readonly example: false;
2583
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
2521
2584
  };
2522
2585
  readonly createdAt: {
2523
2586
  readonly type: "string";
2524
2587
  readonly format: "date-time";
2525
2588
  readonly nullable: true;
2589
+ readonly example: "2023-01-28T15:21:39.975Z";
2526
2590
  };
2527
2591
  readonly archivedAt: {
2528
2592
  readonly type: "string";
2529
2593
  readonly format: "date-time";
2530
2594
  readonly nullable: true;
2595
+ readonly example: "2023-01-29T15:21:39.975Z";
2531
2596
  };
2532
2597
  readonly lastSeenAt: {
2533
2598
  readonly type: "string";
2534
2599
  readonly format: "date-time";
2535
2600
  readonly nullable: true;
2601
+ readonly example: "2023-01-28T16:21:39.975Z";
2536
2602
  };
2537
2603
  readonly environments: {
2538
2604
  readonly type: "array";
2539
2605
  readonly items: {
2540
2606
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
2541
2607
  };
2608
+ readonly description: "The list of environments where the feature can be used";
2542
2609
  };
2543
2610
  readonly variants: {
2544
2611
  readonly type: "array";
2545
2612
  readonly items: {
2546
2613
  readonly $ref: "#/components/schemas/variantSchema";
2547
2614
  };
2615
+ readonly description: "The list of feature variants";
2548
2616
  };
2549
2617
  readonly tags: {
2550
2618
  readonly type: "array";
@@ -2552,6 +2620,7 @@ export declare const schemas: {
2552
2620
  readonly $ref: "#/components/schemas/tagSchema";
2553
2621
  };
2554
2622
  readonly nullable: true;
2623
+ readonly description: "The list of feature tags";
2555
2624
  };
2556
2625
  };
2557
2626
  readonly components: {
@@ -2602,24 +2671,34 @@ export declare const schemas: {
2602
2671
  readonly type: "object";
2603
2672
  readonly additionalProperties: false;
2604
2673
  readonly required: readonly ["name", "enabled"];
2674
+ readonly description: "A detailed description of the feature environment";
2605
2675
  readonly properties: {
2606
2676
  readonly name: {
2607
2677
  readonly type: "string";
2678
+ readonly example: "my-dev-env";
2679
+ readonly description: "The name of the environment";
2608
2680
  };
2609
2681
  readonly featureName: {
2610
2682
  readonly type: "string";
2683
+ readonly example: "disable-comments";
2611
2684
  };
2612
2685
  readonly environment: {
2613
2686
  readonly type: "string";
2614
2687
  };
2615
2688
  readonly type: {
2616
2689
  readonly type: "string";
2690
+ readonly example: "development";
2691
+ readonly description: "The type of the environment";
2617
2692
  };
2618
2693
  readonly enabled: {
2619
2694
  readonly type: "boolean";
2695
+ readonly example: true;
2696
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
2620
2697
  };
2621
2698
  readonly sortOrder: {
2622
2699
  readonly type: "number";
2700
+ readonly example: 3;
2701
+ readonly description: "The sort order of the feature environment in the feature environments list";
2623
2702
  };
2624
2703
  readonly variantCount: {
2625
2704
  readonly type: "number";
@@ -2629,12 +2708,14 @@ export declare const schemas: {
2629
2708
  readonly items: {
2630
2709
  readonly $ref: "#/components/schemas/featureStrategySchema";
2631
2710
  };
2711
+ readonly description: "A list of activation strategies for the feature environment";
2632
2712
  };
2633
2713
  readonly variants: {
2634
2714
  readonly type: "array";
2635
2715
  readonly items: {
2636
2716
  readonly $ref: "#/components/schemas/variantSchema";
2637
2717
  };
2718
+ readonly description: "A list of variants for the feature environment";
2638
2719
  };
2639
2720
  };
2640
2721
  readonly components: {
@@ -3124,24 +3205,34 @@ export declare const schemas: {
3124
3205
  readonly type: "object";
3125
3206
  readonly additionalProperties: false;
3126
3207
  readonly required: readonly ["name", "enabled"];
3208
+ readonly description: "A detailed description of the feature environment";
3127
3209
  readonly properties: {
3128
3210
  readonly name: {
3129
3211
  readonly type: "string";
3212
+ readonly example: "my-dev-env";
3213
+ readonly description: "The name of the environment";
3130
3214
  };
3131
3215
  readonly featureName: {
3132
3216
  readonly type: "string";
3217
+ readonly example: "disable-comments";
3133
3218
  };
3134
3219
  readonly environment: {
3135
3220
  readonly type: "string";
3136
3221
  };
3137
3222
  readonly type: {
3138
3223
  readonly type: "string";
3224
+ readonly example: "development";
3225
+ readonly description: "The type of the environment";
3139
3226
  };
3140
3227
  readonly enabled: {
3141
3228
  readonly type: "boolean";
3229
+ readonly example: true;
3230
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
3142
3231
  };
3143
3232
  readonly sortOrder: {
3144
3233
  readonly type: "number";
3234
+ readonly example: 3;
3235
+ readonly description: "The sort order of the feature environment in the feature environments list";
3145
3236
  };
3146
3237
  readonly variantCount: {
3147
3238
  readonly type: "number";
@@ -3151,12 +3242,14 @@ export declare const schemas: {
3151
3242
  readonly items: {
3152
3243
  readonly $ref: "#/components/schemas/featureStrategySchema";
3153
3244
  };
3245
+ readonly description: "A list of activation strategies for the feature environment";
3154
3246
  };
3155
3247
  readonly variants: {
3156
3248
  readonly type: "array";
3157
3249
  readonly items: {
3158
3250
  readonly $ref: "#/components/schemas/variantSchema";
3159
3251
  };
3252
+ readonly description: "A list of variants for the feature environment";
3160
3253
  };
3161
3254
  };
3162
3255
  readonly components: {
@@ -3814,24 +3907,34 @@ export declare const schemas: {
3814
3907
  readonly type: "object";
3815
3908
  readonly additionalProperties: false;
3816
3909
  readonly required: readonly ["name", "enabled"];
3910
+ readonly description: "A detailed description of the feature environment";
3817
3911
  readonly properties: {
3818
3912
  readonly name: {
3819
3913
  readonly type: "string";
3914
+ readonly example: "my-dev-env";
3915
+ readonly description: "The name of the environment";
3820
3916
  };
3821
3917
  readonly featureName: {
3822
3918
  readonly type: "string";
3919
+ readonly example: "disable-comments";
3823
3920
  };
3824
3921
  readonly environment: {
3825
3922
  readonly type: "string";
3826
3923
  };
3827
3924
  readonly type: {
3828
3925
  readonly type: "string";
3926
+ readonly example: "development";
3927
+ readonly description: "The type of the environment";
3829
3928
  };
3830
3929
  readonly enabled: {
3831
3930
  readonly type: "boolean";
3931
+ readonly example: true;
3932
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
3832
3933
  };
3833
3934
  readonly sortOrder: {
3834
3935
  readonly type: "number";
3936
+ readonly example: 3;
3937
+ readonly description: "The sort order of the feature environment in the feature environments list";
3835
3938
  };
3836
3939
  readonly variantCount: {
3837
3940
  readonly type: "number";
@@ -3841,12 +3944,14 @@ export declare const schemas: {
3841
3944
  readonly items: {
3842
3945
  readonly $ref: "#/components/schemas/featureStrategySchema";
3843
3946
  };
3947
+ readonly description: "A list of activation strategies for the feature environment";
3844
3948
  };
3845
3949
  readonly variants: {
3846
3950
  readonly type: "array";
3847
3951
  readonly items: {
3848
3952
  readonly $ref: "#/components/schemas/variantSchema";
3849
3953
  };
3954
+ readonly description: "A list of variants for the feature environment";
3850
3955
  };
3851
3956
  };
3852
3957
  readonly components: {
@@ -4218,57 +4323,80 @@ export declare const schemas: {
4218
4323
  readonly properties: {
4219
4324
  readonly name: {
4220
4325
  readonly type: "string";
4326
+ readonly example: "disable-comments";
4327
+ readonly description: "Unique feature name";
4221
4328
  };
4222
4329
  readonly type: {
4223
4330
  readonly type: "string";
4331
+ readonly example: "kill-switch";
4332
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
4224
4333
  };
4225
4334
  readonly description: {
4226
4335
  readonly type: "string";
4336
+ readonly nullable: true;
4337
+ readonly example: "Controls disabling of the comments section in case of an incident";
4338
+ readonly description: "Detailed description of the feature";
4227
4339
  };
4228
4340
  readonly archived: {
4229
4341
  readonly type: "boolean";
4342
+ readonly example: true;
4343
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
4230
4344
  };
4231
4345
  readonly project: {
4232
4346
  readonly type: "string";
4347
+ readonly example: "dx-squad";
4348
+ readonly description: "Name of the project the feature belongs to";
4233
4349
  };
4234
4350
  readonly enabled: {
4235
4351
  readonly type: "boolean";
4352
+ readonly example: true;
4236
4353
  };
4237
4354
  readonly stale: {
4238
4355
  readonly type: "boolean";
4356
+ readonly example: false;
4357
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
4239
4358
  };
4240
4359
  readonly favorite: {
4241
4360
  readonly type: "boolean";
4361
+ readonly example: true;
4362
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
4242
4363
  };
4243
4364
  readonly impressionData: {
4244
4365
  readonly type: "boolean";
4366
+ readonly example: false;
4367
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
4245
4368
  };
4246
4369
  readonly createdAt: {
4247
4370
  readonly type: "string";
4248
4371
  readonly format: "date-time";
4249
4372
  readonly nullable: true;
4373
+ readonly example: "2023-01-28T15:21:39.975Z";
4250
4374
  };
4251
4375
  readonly archivedAt: {
4252
4376
  readonly type: "string";
4253
4377
  readonly format: "date-time";
4254
4378
  readonly nullable: true;
4379
+ readonly example: "2023-01-29T15:21:39.975Z";
4255
4380
  };
4256
4381
  readonly lastSeenAt: {
4257
4382
  readonly type: "string";
4258
4383
  readonly format: "date-time";
4259
4384
  readonly nullable: true;
4385
+ readonly example: "2023-01-28T16:21:39.975Z";
4260
4386
  };
4261
4387
  readonly environments: {
4262
4388
  readonly type: "array";
4263
4389
  readonly items: {
4264
4390
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
4265
4391
  };
4392
+ readonly description: "The list of environments where the feature can be used";
4266
4393
  };
4267
4394
  readonly variants: {
4268
4395
  readonly type: "array";
4269
4396
  readonly items: {
4270
4397
  readonly $ref: "#/components/schemas/variantSchema";
4271
4398
  };
4399
+ readonly description: "The list of feature variants";
4272
4400
  };
4273
4401
  readonly tags: {
4274
4402
  readonly type: "array";
@@ -4276,6 +4404,7 @@ export declare const schemas: {
4276
4404
  readonly $ref: "#/components/schemas/tagSchema";
4277
4405
  };
4278
4406
  readonly nullable: true;
4407
+ readonly description: "The list of feature tags";
4279
4408
  };
4280
4409
  };
4281
4410
  readonly components: {
@@ -4326,24 +4455,34 @@ export declare const schemas: {
4326
4455
  readonly type: "object";
4327
4456
  readonly additionalProperties: false;
4328
4457
  readonly required: readonly ["name", "enabled"];
4458
+ readonly description: "A detailed description of the feature environment";
4329
4459
  readonly properties: {
4330
4460
  readonly name: {
4331
4461
  readonly type: "string";
4462
+ readonly example: "my-dev-env";
4463
+ readonly description: "The name of the environment";
4332
4464
  };
4333
4465
  readonly featureName: {
4334
4466
  readonly type: "string";
4467
+ readonly example: "disable-comments";
4335
4468
  };
4336
4469
  readonly environment: {
4337
4470
  readonly type: "string";
4338
4471
  };
4339
4472
  readonly type: {
4340
4473
  readonly type: "string";
4474
+ readonly example: "development";
4475
+ readonly description: "The type of the environment";
4341
4476
  };
4342
4477
  readonly enabled: {
4343
4478
  readonly type: "boolean";
4479
+ readonly example: true;
4480
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
4344
4481
  };
4345
4482
  readonly sortOrder: {
4346
4483
  readonly type: "number";
4484
+ readonly example: 3;
4485
+ readonly description: "The sort order of the feature environment in the feature environments list";
4347
4486
  };
4348
4487
  readonly variantCount: {
4349
4488
  readonly type: "number";
@@ -4353,12 +4492,14 @@ export declare const schemas: {
4353
4492
  readonly items: {
4354
4493
  readonly $ref: "#/components/schemas/featureStrategySchema";
4355
4494
  };
4495
+ readonly description: "A list of activation strategies for the feature environment";
4356
4496
  };
4357
4497
  readonly variants: {
4358
4498
  readonly type: "array";
4359
4499
  readonly items: {
4360
4500
  readonly $ref: "#/components/schemas/variantSchema";
4361
4501
  };
4502
+ readonly description: "A list of variants for the feature environment";
4362
4503
  };
4363
4504
  };
4364
4505
  readonly components: {
@@ -4819,33 +4960,48 @@ export declare const schemas: {
4819
4960
  readonly type: "object";
4820
4961
  readonly additionalProperties: false;
4821
4962
  readonly required: readonly ["name", "type", "enabled"];
4963
+ readonly description: "A definition of the project environment";
4822
4964
  readonly properties: {
4823
4965
  readonly name: {
4824
4966
  readonly type: "string";
4967
+ readonly example: "my-dev-env";
4968
+ readonly description: "The name of the environment";
4825
4969
  };
4826
4970
  readonly type: {
4827
4971
  readonly type: "string";
4972
+ readonly example: "development";
4973
+ readonly description: "The type of the environment";
4828
4974
  };
4829
4975
  readonly enabled: {
4830
4976
  readonly type: "boolean";
4977
+ readonly example: true;
4978
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
4831
4979
  };
4832
4980
  readonly protected: {
4833
4981
  readonly type: "boolean";
4834
4982
  };
4835
4983
  readonly sortOrder: {
4836
4984
  readonly type: "number";
4985
+ readonly example: 3;
4986
+ readonly description: "The sort order of the environment in the environments list";
4837
4987
  };
4838
4988
  readonly projectCount: {
4839
4989
  readonly type: "number";
4840
4990
  readonly nullable: true;
4991
+ readonly example: 10;
4992
+ readonly description: "The number of projects with this environment";
4841
4993
  };
4842
4994
  readonly apiTokenCount: {
4843
4995
  readonly type: "number";
4844
4996
  readonly nullable: true;
4997
+ readonly example: 6;
4998
+ readonly description: "The number of API tokens for the project environment";
4845
4999
  };
4846
5000
  readonly enabledToggleCount: {
4847
5001
  readonly type: "number";
4848
5002
  readonly nullable: true;
5003
+ readonly example: 10;
5004
+ readonly description: "The number of enabled toggles for the project environment";
4849
5005
  };
4850
5006
  };
4851
5007
  readonly components: {};
@@ -4858,57 +5014,80 @@ export declare const schemas: {
4858
5014
  readonly properties: {
4859
5015
  readonly name: {
4860
5016
  readonly type: "string";
5017
+ readonly example: "disable-comments";
5018
+ readonly description: "Unique feature name";
4861
5019
  };
4862
5020
  readonly type: {
4863
5021
  readonly type: "string";
5022
+ readonly example: "kill-switch";
5023
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
4864
5024
  };
4865
5025
  readonly description: {
4866
5026
  readonly type: "string";
5027
+ readonly nullable: true;
5028
+ readonly example: "Controls disabling of the comments section in case of an incident";
5029
+ readonly description: "Detailed description of the feature";
4867
5030
  };
4868
5031
  readonly archived: {
4869
5032
  readonly type: "boolean";
5033
+ readonly example: true;
5034
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
4870
5035
  };
4871
5036
  readonly project: {
4872
5037
  readonly type: "string";
5038
+ readonly example: "dx-squad";
5039
+ readonly description: "Name of the project the feature belongs to";
4873
5040
  };
4874
5041
  readonly enabled: {
4875
5042
  readonly type: "boolean";
5043
+ readonly example: true;
4876
5044
  };
4877
5045
  readonly stale: {
4878
5046
  readonly type: "boolean";
5047
+ readonly example: false;
5048
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
4879
5049
  };
4880
5050
  readonly favorite: {
4881
5051
  readonly type: "boolean";
5052
+ readonly example: true;
5053
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
4882
5054
  };
4883
5055
  readonly impressionData: {
4884
5056
  readonly type: "boolean";
5057
+ readonly example: false;
5058
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
4885
5059
  };
4886
5060
  readonly createdAt: {
4887
5061
  readonly type: "string";
4888
5062
  readonly format: "date-time";
4889
5063
  readonly nullable: true;
5064
+ readonly example: "2023-01-28T15:21:39.975Z";
4890
5065
  };
4891
5066
  readonly archivedAt: {
4892
5067
  readonly type: "string";
4893
5068
  readonly format: "date-time";
4894
5069
  readonly nullable: true;
5070
+ readonly example: "2023-01-29T15:21:39.975Z";
4895
5071
  };
4896
5072
  readonly lastSeenAt: {
4897
5073
  readonly type: "string";
4898
5074
  readonly format: "date-time";
4899
5075
  readonly nullable: true;
5076
+ readonly example: "2023-01-28T16:21:39.975Z";
4900
5077
  };
4901
5078
  readonly environments: {
4902
5079
  readonly type: "array";
4903
5080
  readonly items: {
4904
5081
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
4905
5082
  };
5083
+ readonly description: "The list of environments where the feature can be used";
4906
5084
  };
4907
5085
  readonly variants: {
4908
5086
  readonly type: "array";
4909
5087
  readonly items: {
4910
5088
  readonly $ref: "#/components/schemas/variantSchema";
4911
5089
  };
5090
+ readonly description: "The list of feature variants";
4912
5091
  };
4913
5092
  readonly tags: {
4914
5093
  readonly type: "array";
@@ -4916,6 +5095,7 @@ export declare const schemas: {
4916
5095
  readonly $ref: "#/components/schemas/tagSchema";
4917
5096
  };
4918
5097
  readonly nullable: true;
5098
+ readonly description: "The list of feature tags";
4919
5099
  };
4920
5100
  };
4921
5101
  readonly components: {
@@ -4966,24 +5146,34 @@ export declare const schemas: {
4966
5146
  readonly type: "object";
4967
5147
  readonly additionalProperties: false;
4968
5148
  readonly required: readonly ["name", "enabled"];
5149
+ readonly description: "A detailed description of the feature environment";
4969
5150
  readonly properties: {
4970
5151
  readonly name: {
4971
5152
  readonly type: "string";
5153
+ readonly example: "my-dev-env";
5154
+ readonly description: "The name of the environment";
4972
5155
  };
4973
5156
  readonly featureName: {
4974
5157
  readonly type: "string";
5158
+ readonly example: "disable-comments";
4975
5159
  };
4976
5160
  readonly environment: {
4977
5161
  readonly type: "string";
4978
5162
  };
4979
5163
  readonly type: {
4980
5164
  readonly type: "string";
5165
+ readonly example: "development";
5166
+ readonly description: "The type of the environment";
4981
5167
  };
4982
5168
  readonly enabled: {
4983
5169
  readonly type: "boolean";
5170
+ readonly example: true;
5171
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
4984
5172
  };
4985
5173
  readonly sortOrder: {
4986
5174
  readonly type: "number";
5175
+ readonly example: 3;
5176
+ readonly description: "The sort order of the feature environment in the feature environments list";
4987
5177
  };
4988
5178
  readonly variantCount: {
4989
5179
  readonly type: "number";
@@ -4993,12 +5183,14 @@ export declare const schemas: {
4993
5183
  readonly items: {
4994
5184
  readonly $ref: "#/components/schemas/featureStrategySchema";
4995
5185
  };
5186
+ readonly description: "A list of activation strategies for the feature environment";
4996
5187
  };
4997
5188
  readonly variants: {
4998
5189
  readonly type: "array";
4999
5190
  readonly items: {
5000
5191
  readonly $ref: "#/components/schemas/variantSchema";
5001
5192
  };
5193
+ readonly description: "A list of variants for the feature environment";
5002
5194
  };
5003
5195
  };
5004
5196
  readonly components: {
@@ -5418,24 +5610,34 @@ export declare const schemas: {
5418
5610
  readonly type: "object";
5419
5611
  readonly additionalProperties: false;
5420
5612
  readonly required: readonly ["name", "enabled"];
5613
+ readonly description: "A detailed description of the feature environment";
5421
5614
  readonly properties: {
5422
5615
  readonly name: {
5423
5616
  readonly type: "string";
5617
+ readonly example: "my-dev-env";
5618
+ readonly description: "The name of the environment";
5424
5619
  };
5425
5620
  readonly featureName: {
5426
5621
  readonly type: "string";
5622
+ readonly example: "disable-comments";
5427
5623
  };
5428
5624
  readonly environment: {
5429
5625
  readonly type: "string";
5430
5626
  };
5431
5627
  readonly type: {
5432
5628
  readonly type: "string";
5629
+ readonly example: "development";
5630
+ readonly description: "The type of the environment";
5433
5631
  };
5434
5632
  readonly enabled: {
5435
5633
  readonly type: "boolean";
5634
+ readonly example: true;
5635
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
5436
5636
  };
5437
5637
  readonly sortOrder: {
5438
5638
  readonly type: "number";
5639
+ readonly example: 3;
5640
+ readonly description: "The sort order of the feature environment in the feature environments list";
5439
5641
  };
5440
5642
  readonly variantCount: {
5441
5643
  readonly type: "number";
@@ -5445,12 +5647,14 @@ export declare const schemas: {
5445
5647
  readonly items: {
5446
5648
  readonly $ref: "#/components/schemas/featureStrategySchema";
5447
5649
  };
5650
+ readonly description: "A list of activation strategies for the feature environment";
5448
5651
  };
5449
5652
  readonly variants: {
5450
5653
  readonly type: "array";
5451
5654
  readonly items: {
5452
5655
  readonly $ref: "#/components/schemas/variantSchema";
5453
5656
  };
5657
+ readonly description: "A list of variants for the feature environment";
5454
5658
  };
5455
5659
  };
5456
5660
  readonly components: {
@@ -6202,6 +6406,7 @@ export declare const schemas: {
6202
6406
  };
6203
6407
  readonly description: {
6204
6408
  readonly type: "string";
6409
+ readonly nullable: true;
6205
6410
  };
6206
6411
  readonly mappingsSSO: {
6207
6412
  readonly type: "array";
@@ -6391,6 +6596,7 @@ export declare const schemas: {
6391
6596
  };
6392
6597
  readonly description: {
6393
6598
  readonly type: "string";
6599
+ readonly nullable: true;
6394
6600
  };
6395
6601
  readonly mappingsSSO: {
6396
6602
  readonly type: "array";
@@ -6860,33 +7066,48 @@ export declare const schemas: {
6860
7066
  readonly type: "object";
6861
7067
  readonly additionalProperties: false;
6862
7068
  readonly required: readonly ["name", "type", "enabled"];
7069
+ readonly description: "A definition of the project environment";
6863
7070
  readonly properties: {
6864
7071
  readonly name: {
6865
7072
  readonly type: "string";
7073
+ readonly example: "my-dev-env";
7074
+ readonly description: "The name of the environment";
6866
7075
  };
6867
7076
  readonly type: {
6868
7077
  readonly type: "string";
7078
+ readonly example: "development";
7079
+ readonly description: "The type of the environment";
6869
7080
  };
6870
7081
  readonly enabled: {
6871
7082
  readonly type: "boolean";
7083
+ readonly example: true;
7084
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
6872
7085
  };
6873
7086
  readonly protected: {
6874
7087
  readonly type: "boolean";
6875
7088
  };
6876
7089
  readonly sortOrder: {
6877
7090
  readonly type: "number";
7091
+ readonly example: 3;
7092
+ readonly description: "The sort order of the environment in the environments list";
6878
7093
  };
6879
7094
  readonly projectCount: {
6880
7095
  readonly type: "number";
6881
7096
  readonly nullable: true;
7097
+ readonly example: 10;
7098
+ readonly description: "The number of projects with this environment";
6882
7099
  };
6883
7100
  readonly apiTokenCount: {
6884
7101
  readonly type: "number";
6885
7102
  readonly nullable: true;
7103
+ readonly example: 6;
7104
+ readonly description: "The number of API tokens for the project environment";
6886
7105
  };
6887
7106
  readonly enabledToggleCount: {
6888
7107
  readonly type: "number";
6889
7108
  readonly nullable: true;
7109
+ readonly example: 10;
7110
+ readonly description: "The number of enabled toggles for the project environment";
6890
7111
  };
6891
7112
  };
6892
7113
  readonly components: {};
@@ -6899,57 +7120,80 @@ export declare const schemas: {
6899
7120
  readonly properties: {
6900
7121
  readonly name: {
6901
7122
  readonly type: "string";
7123
+ readonly example: "disable-comments";
7124
+ readonly description: "Unique feature name";
6902
7125
  };
6903
7126
  readonly type: {
6904
7127
  readonly type: "string";
7128
+ readonly example: "kill-switch";
7129
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
6905
7130
  };
6906
7131
  readonly description: {
6907
7132
  readonly type: "string";
7133
+ readonly nullable: true;
7134
+ readonly example: "Controls disabling of the comments section in case of an incident";
7135
+ readonly description: "Detailed description of the feature";
6908
7136
  };
6909
7137
  readonly archived: {
6910
7138
  readonly type: "boolean";
7139
+ readonly example: true;
7140
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
6911
7141
  };
6912
7142
  readonly project: {
6913
7143
  readonly type: "string";
7144
+ readonly example: "dx-squad";
7145
+ readonly description: "Name of the project the feature belongs to";
6914
7146
  };
6915
7147
  readonly enabled: {
6916
7148
  readonly type: "boolean";
7149
+ readonly example: true;
6917
7150
  };
6918
7151
  readonly stale: {
6919
7152
  readonly type: "boolean";
7153
+ readonly example: false;
7154
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
6920
7155
  };
6921
7156
  readonly favorite: {
6922
7157
  readonly type: "boolean";
7158
+ readonly example: true;
7159
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
6923
7160
  };
6924
7161
  readonly impressionData: {
6925
7162
  readonly type: "boolean";
7163
+ readonly example: false;
7164
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
6926
7165
  };
6927
7166
  readonly createdAt: {
6928
7167
  readonly type: "string";
6929
7168
  readonly format: "date-time";
6930
7169
  readonly nullable: true;
7170
+ readonly example: "2023-01-28T15:21:39.975Z";
6931
7171
  };
6932
7172
  readonly archivedAt: {
6933
7173
  readonly type: "string";
6934
7174
  readonly format: "date-time";
6935
7175
  readonly nullable: true;
7176
+ readonly example: "2023-01-29T15:21:39.975Z";
6936
7177
  };
6937
7178
  readonly lastSeenAt: {
6938
7179
  readonly type: "string";
6939
7180
  readonly format: "date-time";
6940
7181
  readonly nullable: true;
7182
+ readonly example: "2023-01-28T16:21:39.975Z";
6941
7183
  };
6942
7184
  readonly environments: {
6943
7185
  readonly type: "array";
6944
7186
  readonly items: {
6945
7187
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
6946
7188
  };
7189
+ readonly description: "The list of environments where the feature can be used";
6947
7190
  };
6948
7191
  readonly variants: {
6949
7192
  readonly type: "array";
6950
7193
  readonly items: {
6951
7194
  readonly $ref: "#/components/schemas/variantSchema";
6952
7195
  };
7196
+ readonly description: "The list of feature variants";
6953
7197
  };
6954
7198
  readonly tags: {
6955
7199
  readonly type: "array";
@@ -6957,6 +7201,7 @@ export declare const schemas: {
6957
7201
  readonly $ref: "#/components/schemas/tagSchema";
6958
7202
  };
6959
7203
  readonly nullable: true;
7204
+ readonly description: "The list of feature tags";
6960
7205
  };
6961
7206
  };
6962
7207
  readonly components: {
@@ -7007,24 +7252,34 @@ export declare const schemas: {
7007
7252
  readonly type: "object";
7008
7253
  readonly additionalProperties: false;
7009
7254
  readonly required: readonly ["name", "enabled"];
7255
+ readonly description: "A detailed description of the feature environment";
7010
7256
  readonly properties: {
7011
7257
  readonly name: {
7012
7258
  readonly type: "string";
7259
+ readonly example: "my-dev-env";
7260
+ readonly description: "The name of the environment";
7013
7261
  };
7014
7262
  readonly featureName: {
7015
7263
  readonly type: "string";
7264
+ readonly example: "disable-comments";
7016
7265
  };
7017
7266
  readonly environment: {
7018
7267
  readonly type: "string";
7019
7268
  };
7020
7269
  readonly type: {
7021
7270
  readonly type: "string";
7271
+ readonly example: "development";
7272
+ readonly description: "The type of the environment";
7022
7273
  };
7023
7274
  readonly enabled: {
7024
7275
  readonly type: "boolean";
7276
+ readonly example: true;
7277
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
7025
7278
  };
7026
7279
  readonly sortOrder: {
7027
7280
  readonly type: "number";
7281
+ readonly example: 3;
7282
+ readonly description: "The sort order of the feature environment in the feature environments list";
7028
7283
  };
7029
7284
  readonly variantCount: {
7030
7285
  readonly type: "number";
@@ -7034,12 +7289,14 @@ export declare const schemas: {
7034
7289
  readonly items: {
7035
7290
  readonly $ref: "#/components/schemas/featureStrategySchema";
7036
7291
  };
7292
+ readonly description: "A list of activation strategies for the feature environment";
7037
7293
  };
7038
7294
  readonly variants: {
7039
7295
  readonly type: "array";
7040
7296
  readonly items: {
7041
7297
  readonly $ref: "#/components/schemas/variantSchema";
7042
7298
  };
7299
+ readonly description: "A list of variants for the feature environment";
7043
7300
  };
7044
7301
  };
7045
7302
  readonly components: {
@@ -7441,24 +7698,34 @@ export declare const schemas: {
7441
7698
  readonly type: "object";
7442
7699
  readonly additionalProperties: false;
7443
7700
  readonly required: readonly ["name", "enabled"];
7701
+ readonly description: "A detailed description of the feature environment";
7444
7702
  readonly properties: {
7445
7703
  readonly name: {
7446
7704
  readonly type: "string";
7705
+ readonly example: "my-dev-env";
7706
+ readonly description: "The name of the environment";
7447
7707
  };
7448
7708
  readonly featureName: {
7449
7709
  readonly type: "string";
7710
+ readonly example: "disable-comments";
7450
7711
  };
7451
7712
  readonly environment: {
7452
7713
  readonly type: "string";
7453
7714
  };
7454
7715
  readonly type: {
7455
7716
  readonly type: "string";
7717
+ readonly example: "development";
7718
+ readonly description: "The type of the environment";
7456
7719
  };
7457
7720
  readonly enabled: {
7458
7721
  readonly type: "boolean";
7722
+ readonly example: true;
7723
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
7459
7724
  };
7460
7725
  readonly sortOrder: {
7461
7726
  readonly type: "number";
7727
+ readonly example: 3;
7728
+ readonly description: "The sort order of the feature environment in the feature environments list";
7462
7729
  };
7463
7730
  readonly variantCount: {
7464
7731
  readonly type: "number";
@@ -7468,12 +7735,14 @@ export declare const schemas: {
7468
7735
  readonly items: {
7469
7736
  readonly $ref: "#/components/schemas/featureStrategySchema";
7470
7737
  };
7738
+ readonly description: "A list of activation strategies for the feature environment";
7471
7739
  };
7472
7740
  readonly variants: {
7473
7741
  readonly type: "array";
7474
7742
  readonly items: {
7475
7743
  readonly $ref: "#/components/schemas/variantSchema";
7476
7744
  };
7745
+ readonly description: "A list of variants for the feature environment";
7477
7746
  };
7478
7747
  };
7479
7748
  readonly components: {
@@ -7857,33 +8126,52 @@ export declare const schemas: {
7857
8126
  readonly type: "object";
7858
8127
  readonly additionalProperties: false;
7859
8128
  readonly required: readonly ["avgTimeToProdCurrentWindow", "avgTimeToProdPastWindow", "createdCurrentWindow", "createdPastWindow", "archivedCurrentWindow", "archivedPastWindow", "projectActivityCurrentWindow", "projectActivityPastWindow", "projectMembersAddedCurrentWindow"];
8129
+ readonly description: "Statistics for a project, including the average time to production, number of features created, the project activity and more.\n\nStats are divided into current and previous **windows**.\n- The **current window** is the past 30 days.\n- The **previous window** is the 30 days **before** the current window (from 60 to 30 days ago)";
7860
8130
  readonly properties: {
7861
8131
  readonly avgTimeToProdCurrentWindow: {
7862
8132
  readonly type: "number";
8133
+ readonly example: 10;
8134
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the current window";
7863
8135
  };
7864
8136
  readonly avgTimeToProdPastWindow: {
7865
8137
  readonly type: "number";
8138
+ readonly example: 10;
8139
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the previous window";
7866
8140
  };
7867
8141
  readonly createdCurrentWindow: {
7868
8142
  readonly type: "number";
8143
+ readonly example: 15;
8144
+ readonly description: "The number of feature toggles created during the current window";
7869
8145
  };
7870
8146
  readonly createdPastWindow: {
7871
8147
  readonly type: "number";
8148
+ readonly example: 15;
8149
+ readonly description: "The number of feature toggles created during the previous window";
7872
8150
  };
7873
8151
  readonly archivedCurrentWindow: {
7874
8152
  readonly type: "number";
8153
+ readonly example: 5;
8154
+ readonly description: "The number of feature toggles that were archived during the current window";
7875
8155
  };
7876
8156
  readonly archivedPastWindow: {
7877
8157
  readonly type: "number";
8158
+ readonly example: 5;
8159
+ readonly description: "The number of feature toggles that were archived during the previous window";
7878
8160
  };
7879
8161
  readonly projectActivityCurrentWindow: {
7880
8162
  readonly type: "number";
8163
+ readonly example: 100;
8164
+ readonly description: "The number of project events that occurred during the current window";
7881
8165
  };
7882
8166
  readonly projectActivityPastWindow: {
7883
8167
  readonly type: "number";
8168
+ readonly example: 100;
8169
+ readonly description: "The number of project events that occurred during the previous window";
7884
8170
  };
7885
8171
  readonly projectMembersAddedCurrentWindow: {
7886
8172
  readonly type: "number";
8173
+ readonly example: 1;
8174
+ readonly description: "The number of members that were added to the project during the current window";
7887
8175
  };
7888
8176
  };
7889
8177
  readonly components: {};
@@ -7990,33 +8278,48 @@ export declare const schemas: {
7990
8278
  readonly type: "object";
7991
8279
  readonly additionalProperties: false;
7992
8280
  readonly required: readonly ["name", "type", "enabled"];
8281
+ readonly description: "A definition of the project environment";
7993
8282
  readonly properties: {
7994
8283
  readonly name: {
7995
8284
  readonly type: "string";
8285
+ readonly example: "my-dev-env";
8286
+ readonly description: "The name of the environment";
7996
8287
  };
7997
8288
  readonly type: {
7998
8289
  readonly type: "string";
8290
+ readonly example: "development";
8291
+ readonly description: "The type of the environment";
7999
8292
  };
8000
8293
  readonly enabled: {
8001
8294
  readonly type: "boolean";
8295
+ readonly example: true;
8296
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
8002
8297
  };
8003
8298
  readonly protected: {
8004
8299
  readonly type: "boolean";
8005
8300
  };
8006
8301
  readonly sortOrder: {
8007
8302
  readonly type: "number";
8303
+ readonly example: 3;
8304
+ readonly description: "The sort order of the environment in the environments list";
8008
8305
  };
8009
8306
  readonly projectCount: {
8010
8307
  readonly type: "number";
8011
8308
  readonly nullable: true;
8309
+ readonly example: 10;
8310
+ readonly description: "The number of projects with this environment";
8012
8311
  };
8013
8312
  readonly apiTokenCount: {
8014
8313
  readonly type: "number";
8015
8314
  readonly nullable: true;
8315
+ readonly example: 6;
8316
+ readonly description: "The number of API tokens for the project environment";
8016
8317
  };
8017
8318
  readonly enabledToggleCount: {
8018
8319
  readonly type: "number";
8019
8320
  readonly nullable: true;
8321
+ readonly example: 10;
8322
+ readonly description: "The number of enabled toggles for the project environment";
8020
8323
  };
8021
8324
  };
8022
8325
  readonly components: {};
@@ -8029,57 +8332,80 @@ export declare const schemas: {
8029
8332
  readonly properties: {
8030
8333
  readonly name: {
8031
8334
  readonly type: "string";
8335
+ readonly example: "disable-comments";
8336
+ readonly description: "Unique feature name";
8032
8337
  };
8033
8338
  readonly type: {
8034
8339
  readonly type: "string";
8340
+ readonly example: "kill-switch";
8341
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
8035
8342
  };
8036
8343
  readonly description: {
8037
8344
  readonly type: "string";
8345
+ readonly nullable: true;
8346
+ readonly example: "Controls disabling of the comments section in case of an incident";
8347
+ readonly description: "Detailed description of the feature";
8038
8348
  };
8039
8349
  readonly archived: {
8040
8350
  readonly type: "boolean";
8351
+ readonly example: true;
8352
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
8041
8353
  };
8042
8354
  readonly project: {
8043
8355
  readonly type: "string";
8356
+ readonly example: "dx-squad";
8357
+ readonly description: "Name of the project the feature belongs to";
8044
8358
  };
8045
8359
  readonly enabled: {
8046
8360
  readonly type: "boolean";
8361
+ readonly example: true;
8047
8362
  };
8048
8363
  readonly stale: {
8049
8364
  readonly type: "boolean";
8365
+ readonly example: false;
8366
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
8050
8367
  };
8051
8368
  readonly favorite: {
8052
8369
  readonly type: "boolean";
8370
+ readonly example: true;
8371
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
8053
8372
  };
8054
8373
  readonly impressionData: {
8055
8374
  readonly type: "boolean";
8375
+ readonly example: false;
8376
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
8056
8377
  };
8057
8378
  readonly createdAt: {
8058
8379
  readonly type: "string";
8059
8380
  readonly format: "date-time";
8060
8381
  readonly nullable: true;
8382
+ readonly example: "2023-01-28T15:21:39.975Z";
8061
8383
  };
8062
8384
  readonly archivedAt: {
8063
8385
  readonly type: "string";
8064
8386
  readonly format: "date-time";
8065
8387
  readonly nullable: true;
8388
+ readonly example: "2023-01-29T15:21:39.975Z";
8066
8389
  };
8067
8390
  readonly lastSeenAt: {
8068
8391
  readonly type: "string";
8069
8392
  readonly format: "date-time";
8070
8393
  readonly nullable: true;
8394
+ readonly example: "2023-01-28T16:21:39.975Z";
8071
8395
  };
8072
8396
  readonly environments: {
8073
8397
  readonly type: "array";
8074
8398
  readonly items: {
8075
8399
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
8076
8400
  };
8401
+ readonly description: "The list of environments where the feature can be used";
8077
8402
  };
8078
8403
  readonly variants: {
8079
8404
  readonly type: "array";
8080
8405
  readonly items: {
8081
8406
  readonly $ref: "#/components/schemas/variantSchema";
8082
8407
  };
8408
+ readonly description: "The list of feature variants";
8083
8409
  };
8084
8410
  readonly tags: {
8085
8411
  readonly type: "array";
@@ -8087,6 +8413,7 @@ export declare const schemas: {
8087
8413
  readonly $ref: "#/components/schemas/tagSchema";
8088
8414
  };
8089
8415
  readonly nullable: true;
8416
+ readonly description: "The list of feature tags";
8090
8417
  };
8091
8418
  };
8092
8419
  readonly components: {
@@ -8137,24 +8464,34 @@ export declare const schemas: {
8137
8464
  readonly type: "object";
8138
8465
  readonly additionalProperties: false;
8139
8466
  readonly required: readonly ["name", "enabled"];
8467
+ readonly description: "A detailed description of the feature environment";
8140
8468
  readonly properties: {
8141
8469
  readonly name: {
8142
8470
  readonly type: "string";
8471
+ readonly example: "my-dev-env";
8472
+ readonly description: "The name of the environment";
8143
8473
  };
8144
8474
  readonly featureName: {
8145
8475
  readonly type: "string";
8476
+ readonly example: "disable-comments";
8146
8477
  };
8147
8478
  readonly environment: {
8148
8479
  readonly type: "string";
8149
8480
  };
8150
8481
  readonly type: {
8151
8482
  readonly type: "string";
8483
+ readonly example: "development";
8484
+ readonly description: "The type of the environment";
8152
8485
  };
8153
8486
  readonly enabled: {
8154
8487
  readonly type: "boolean";
8488
+ readonly example: true;
8489
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
8155
8490
  };
8156
8491
  readonly sortOrder: {
8157
8492
  readonly type: "number";
8493
+ readonly example: 3;
8494
+ readonly description: "The sort order of the feature environment in the feature environments list";
8158
8495
  };
8159
8496
  readonly variantCount: {
8160
8497
  readonly type: "number";
@@ -8164,12 +8501,14 @@ export declare const schemas: {
8164
8501
  readonly items: {
8165
8502
  readonly $ref: "#/components/schemas/featureStrategySchema";
8166
8503
  };
8504
+ readonly description: "A list of activation strategies for the feature environment";
8167
8505
  };
8168
8506
  readonly variants: {
8169
8507
  readonly type: "array";
8170
8508
  readonly items: {
8171
8509
  readonly $ref: "#/components/schemas/variantSchema";
8172
8510
  };
8511
+ readonly description: "A list of variants for the feature environment";
8173
8512
  };
8174
8513
  };
8175
8514
  readonly components: {
@@ -8571,24 +8910,34 @@ export declare const schemas: {
8571
8910
  readonly type: "object";
8572
8911
  readonly additionalProperties: false;
8573
8912
  readonly required: readonly ["name", "enabled"];
8913
+ readonly description: "A detailed description of the feature environment";
8574
8914
  readonly properties: {
8575
8915
  readonly name: {
8576
8916
  readonly type: "string";
8917
+ readonly example: "my-dev-env";
8918
+ readonly description: "The name of the environment";
8577
8919
  };
8578
8920
  readonly featureName: {
8579
8921
  readonly type: "string";
8922
+ readonly example: "disable-comments";
8580
8923
  };
8581
8924
  readonly environment: {
8582
8925
  readonly type: "string";
8583
8926
  };
8584
8927
  readonly type: {
8585
8928
  readonly type: "string";
8929
+ readonly example: "development";
8930
+ readonly description: "The type of the environment";
8586
8931
  };
8587
8932
  readonly enabled: {
8588
8933
  readonly type: "boolean";
8934
+ readonly example: true;
8935
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
8589
8936
  };
8590
8937
  readonly sortOrder: {
8591
8938
  readonly type: "number";
8939
+ readonly example: 3;
8940
+ readonly description: "The sort order of the feature environment in the feature environments list";
8592
8941
  };
8593
8942
  readonly variantCount: {
8594
8943
  readonly type: "number";
@@ -8598,12 +8947,14 @@ export declare const schemas: {
8598
8947
  readonly items: {
8599
8948
  readonly $ref: "#/components/schemas/featureStrategySchema";
8600
8949
  };
8950
+ readonly description: "A list of activation strategies for the feature environment";
8601
8951
  };
8602
8952
  readonly variants: {
8603
8953
  readonly type: "array";
8604
8954
  readonly items: {
8605
8955
  readonly $ref: "#/components/schemas/variantSchema";
8606
8956
  };
8957
+ readonly description: "A list of variants for the feature environment";
8607
8958
  };
8608
8959
  };
8609
8960
  readonly components: {
@@ -8987,33 +9338,52 @@ export declare const schemas: {
8987
9338
  readonly type: "object";
8988
9339
  readonly additionalProperties: false;
8989
9340
  readonly required: readonly ["avgTimeToProdCurrentWindow", "avgTimeToProdPastWindow", "createdCurrentWindow", "createdPastWindow", "archivedCurrentWindow", "archivedPastWindow", "projectActivityCurrentWindow", "projectActivityPastWindow", "projectMembersAddedCurrentWindow"];
9341
+ readonly description: "Statistics for a project, including the average time to production, number of features created, the project activity and more.\n\nStats are divided into current and previous **windows**.\n- The **current window** is the past 30 days.\n- The **previous window** is the 30 days **before** the current window (from 60 to 30 days ago)";
8990
9342
  readonly properties: {
8991
9343
  readonly avgTimeToProdCurrentWindow: {
8992
9344
  readonly type: "number";
9345
+ readonly example: 10;
9346
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the current window";
8993
9347
  };
8994
9348
  readonly avgTimeToProdPastWindow: {
8995
9349
  readonly type: "number";
9350
+ readonly example: 10;
9351
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the previous window";
8996
9352
  };
8997
9353
  readonly createdCurrentWindow: {
8998
9354
  readonly type: "number";
9355
+ readonly example: 15;
9356
+ readonly description: "The number of feature toggles created during the current window";
8999
9357
  };
9000
9358
  readonly createdPastWindow: {
9001
9359
  readonly type: "number";
9360
+ readonly example: 15;
9361
+ readonly description: "The number of feature toggles created during the previous window";
9002
9362
  };
9003
9363
  readonly archivedCurrentWindow: {
9004
9364
  readonly type: "number";
9365
+ readonly example: 5;
9366
+ readonly description: "The number of feature toggles that were archived during the current window";
9005
9367
  };
9006
9368
  readonly archivedPastWindow: {
9007
9369
  readonly type: "number";
9370
+ readonly example: 5;
9371
+ readonly description: "The number of feature toggles that were archived during the previous window";
9008
9372
  };
9009
9373
  readonly projectActivityCurrentWindow: {
9010
9374
  readonly type: "number";
9375
+ readonly example: 100;
9376
+ readonly description: "The number of project events that occurred during the current window";
9011
9377
  };
9012
9378
  readonly projectActivityPastWindow: {
9013
9379
  readonly type: "number";
9380
+ readonly example: 100;
9381
+ readonly description: "The number of project events that occurred during the previous window";
9014
9382
  };
9015
9383
  readonly projectMembersAddedCurrentWindow: {
9016
9384
  readonly type: "number";
9385
+ readonly example: 1;
9386
+ readonly description: "The number of members that were added to the project during the current window";
9017
9387
  };
9018
9388
  };
9019
9389
  readonly components: {};
@@ -11564,57 +11934,80 @@ export declare const schemas: {
11564
11934
  readonly properties: {
11565
11935
  readonly name: {
11566
11936
  readonly type: "string";
11937
+ readonly example: "disable-comments";
11938
+ readonly description: "Unique feature name";
11567
11939
  };
11568
11940
  readonly type: {
11569
11941
  readonly type: "string";
11942
+ readonly example: "kill-switch";
11943
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
11570
11944
  };
11571
11945
  readonly description: {
11572
11946
  readonly type: "string";
11947
+ readonly nullable: true;
11948
+ readonly example: "Controls disabling of the comments section in case of an incident";
11949
+ readonly description: "Detailed description of the feature";
11573
11950
  };
11574
11951
  readonly archived: {
11575
11952
  readonly type: "boolean";
11953
+ readonly example: true;
11954
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
11576
11955
  };
11577
11956
  readonly project: {
11578
11957
  readonly type: "string";
11958
+ readonly example: "dx-squad";
11959
+ readonly description: "Name of the project the feature belongs to";
11579
11960
  };
11580
11961
  readonly enabled: {
11581
11962
  readonly type: "boolean";
11963
+ readonly example: true;
11582
11964
  };
11583
11965
  readonly stale: {
11584
11966
  readonly type: "boolean";
11967
+ readonly example: false;
11968
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
11585
11969
  };
11586
11970
  readonly favorite: {
11587
11971
  readonly type: "boolean";
11972
+ readonly example: true;
11973
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
11588
11974
  };
11589
11975
  readonly impressionData: {
11590
11976
  readonly type: "boolean";
11977
+ readonly example: false;
11978
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
11591
11979
  };
11592
11980
  readonly createdAt: {
11593
11981
  readonly type: "string";
11594
11982
  readonly format: "date-time";
11595
11983
  readonly nullable: true;
11984
+ readonly example: "2023-01-28T15:21:39.975Z";
11596
11985
  };
11597
11986
  readonly archivedAt: {
11598
11987
  readonly type: "string";
11599
11988
  readonly format: "date-time";
11600
11989
  readonly nullable: true;
11990
+ readonly example: "2023-01-29T15:21:39.975Z";
11601
11991
  };
11602
11992
  readonly lastSeenAt: {
11603
11993
  readonly type: "string";
11604
11994
  readonly format: "date-time";
11605
11995
  readonly nullable: true;
11996
+ readonly example: "2023-01-28T16:21:39.975Z";
11606
11997
  };
11607
11998
  readonly environments: {
11608
11999
  readonly type: "array";
11609
12000
  readonly items: {
11610
12001
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
11611
12002
  };
12003
+ readonly description: "The list of environments where the feature can be used";
11612
12004
  };
11613
12005
  readonly variants: {
11614
12006
  readonly type: "array";
11615
12007
  readonly items: {
11616
12008
  readonly $ref: "#/components/schemas/variantSchema";
11617
12009
  };
12010
+ readonly description: "The list of feature variants";
11618
12011
  };
11619
12012
  readonly tags: {
11620
12013
  readonly type: "array";
@@ -11622,6 +12015,7 @@ export declare const schemas: {
11622
12015
  readonly $ref: "#/components/schemas/tagSchema";
11623
12016
  };
11624
12017
  readonly nullable: true;
12018
+ readonly description: "The list of feature tags";
11625
12019
  };
11626
12020
  };
11627
12021
  readonly components: {
@@ -11672,24 +12066,34 @@ export declare const schemas: {
11672
12066
  readonly type: "object";
11673
12067
  readonly additionalProperties: false;
11674
12068
  readonly required: readonly ["name", "enabled"];
12069
+ readonly description: "A detailed description of the feature environment";
11675
12070
  readonly properties: {
11676
12071
  readonly name: {
11677
12072
  readonly type: "string";
12073
+ readonly example: "my-dev-env";
12074
+ readonly description: "The name of the environment";
11678
12075
  };
11679
12076
  readonly featureName: {
11680
12077
  readonly type: "string";
12078
+ readonly example: "disable-comments";
11681
12079
  };
11682
12080
  readonly environment: {
11683
12081
  readonly type: "string";
11684
12082
  };
11685
12083
  readonly type: {
11686
12084
  readonly type: "string";
12085
+ readonly example: "development";
12086
+ readonly description: "The type of the environment";
11687
12087
  };
11688
12088
  readonly enabled: {
11689
12089
  readonly type: "boolean";
12090
+ readonly example: true;
12091
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
11690
12092
  };
11691
12093
  readonly sortOrder: {
11692
12094
  readonly type: "number";
12095
+ readonly example: 3;
12096
+ readonly description: "The sort order of the feature environment in the feature environments list";
11693
12097
  };
11694
12098
  readonly variantCount: {
11695
12099
  readonly type: "number";
@@ -11699,12 +12103,14 @@ export declare const schemas: {
11699
12103
  readonly items: {
11700
12104
  readonly $ref: "#/components/schemas/featureStrategySchema";
11701
12105
  };
12106
+ readonly description: "A list of activation strategies for the feature environment";
11702
12107
  };
11703
12108
  readonly variants: {
11704
12109
  readonly type: "array";
11705
12110
  readonly items: {
11706
12111
  readonly $ref: "#/components/schemas/variantSchema";
11707
12112
  };
12113
+ readonly description: "A list of variants for the feature environment";
11708
12114
  };
11709
12115
  };
11710
12116
  readonly components: {
@@ -12145,24 +12551,38 @@ export declare const schemas: {
12145
12551
  readonly type: "object";
12146
12552
  readonly additionalProperties: false;
12147
12553
  readonly required: readonly ["id", "name"];
12554
+ readonly description: "A definition of the project used for projects listing purposes";
12148
12555
  readonly properties: {
12149
12556
  readonly id: {
12150
12557
  readonly type: "string";
12558
+ readonly example: "dx-squad";
12559
+ readonly description: "The id of this project";
12151
12560
  };
12152
12561
  readonly name: {
12153
12562
  readonly type: "string";
12563
+ readonly example: "DX-Squad";
12564
+ readonly description: "The name of this project";
12154
12565
  };
12155
12566
  readonly description: {
12156
12567
  readonly type: "string";
12568
+ readonly nullable: true;
12569
+ readonly example: "DX squad feature release";
12570
+ readonly description: "Additional information about the project";
12157
12571
  };
12158
12572
  readonly health: {
12159
12573
  readonly type: "number";
12574
+ readonly example: 50;
12575
+ readonly description: "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100";
12160
12576
  };
12161
12577
  readonly featureCount: {
12162
12578
  readonly type: "number";
12579
+ readonly example: 10;
12580
+ readonly description: "The number of features this project has";
12163
12581
  };
12164
12582
  readonly memberCount: {
12165
12583
  readonly type: "number";
12584
+ readonly example: 4;
12585
+ readonly description: "The number of members this project has";
12166
12586
  };
12167
12587
  readonly createdAt: {
12168
12588
  readonly type: "string";
@@ -12173,11 +12593,10 @@ export declare const schemas: {
12173
12593
  readonly format: "date-time";
12174
12594
  readonly nullable: true;
12175
12595
  };
12176
- readonly changeRequestsEnabled: {
12177
- readonly type: "boolean";
12178
- };
12179
12596
  readonly favorite: {
12180
12597
  readonly type: "boolean";
12598
+ readonly example: true;
12599
+ readonly description: "`true` if the project was favorited, otherwise `false`.";
12181
12600
  };
12182
12601
  };
12183
12602
  readonly components: {};
@@ -12187,6 +12606,7 @@ export declare const schemas: {
12187
12606
  readonly type: "object";
12188
12607
  readonly additionalProperties: false;
12189
12608
  readonly required: readonly ["version", "projects"];
12609
+ readonly description: "An overview of all the projects in the Unleash instance";
12190
12610
  readonly properties: {
12191
12611
  readonly version: {
12192
12612
  readonly type: "integer";
@@ -12196,6 +12616,7 @@ export declare const schemas: {
12196
12616
  readonly items: {
12197
12617
  readonly $ref: "#/components/schemas/projectSchema";
12198
12618
  };
12619
+ readonly description: "A list of projects in the Unleash instance";
12199
12620
  };
12200
12621
  };
12201
12622
  readonly components: {
@@ -12205,24 +12626,38 @@ export declare const schemas: {
12205
12626
  readonly type: "object";
12206
12627
  readonly additionalProperties: false;
12207
12628
  readonly required: readonly ["id", "name"];
12629
+ readonly description: "A definition of the project used for projects listing purposes";
12208
12630
  readonly properties: {
12209
12631
  readonly id: {
12210
12632
  readonly type: "string";
12633
+ readonly example: "dx-squad";
12634
+ readonly description: "The id of this project";
12211
12635
  };
12212
12636
  readonly name: {
12213
12637
  readonly type: "string";
12638
+ readonly example: "DX-Squad";
12639
+ readonly description: "The name of this project";
12214
12640
  };
12215
12641
  readonly description: {
12216
12642
  readonly type: "string";
12643
+ readonly nullable: true;
12644
+ readonly example: "DX squad feature release";
12645
+ readonly description: "Additional information about the project";
12217
12646
  };
12218
12647
  readonly health: {
12219
12648
  readonly type: "number";
12649
+ readonly example: 50;
12650
+ readonly description: "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100";
12220
12651
  };
12221
12652
  readonly featureCount: {
12222
12653
  readonly type: "number";
12654
+ readonly example: 10;
12655
+ readonly description: "The number of features this project has";
12223
12656
  };
12224
12657
  readonly memberCount: {
12225
12658
  readonly type: "number";
12659
+ readonly example: 4;
12660
+ readonly description: "The number of members this project has";
12226
12661
  };
12227
12662
  readonly createdAt: {
12228
12663
  readonly type: "string";
@@ -12233,11 +12668,10 @@ export declare const schemas: {
12233
12668
  readonly format: "date-time";
12234
12669
  readonly nullable: true;
12235
12670
  };
12236
- readonly changeRequestsEnabled: {
12237
- readonly type: "boolean";
12238
- };
12239
12671
  readonly favorite: {
12240
12672
  readonly type: "boolean";
12673
+ readonly example: true;
12674
+ readonly description: "`true` if the project was favorited, otherwise `false`.";
12241
12675
  };
12242
12676
  };
12243
12677
  readonly components: {};
@@ -12940,33 +13374,52 @@ export declare const schemas: {
12940
13374
  readonly type: "object";
12941
13375
  readonly additionalProperties: false;
12942
13376
  readonly required: readonly ["avgTimeToProdCurrentWindow", "avgTimeToProdPastWindow", "createdCurrentWindow", "createdPastWindow", "archivedCurrentWindow", "archivedPastWindow", "projectActivityCurrentWindow", "projectActivityPastWindow", "projectMembersAddedCurrentWindow"];
13377
+ readonly description: "Statistics for a project, including the average time to production, number of features created, the project activity and more.\n\nStats are divided into current and previous **windows**.\n- The **current window** is the past 30 days.\n- The **previous window** is the 30 days **before** the current window (from 60 to 30 days ago)";
12943
13378
  readonly properties: {
12944
13379
  readonly avgTimeToProdCurrentWindow: {
12945
13380
  readonly type: "number";
13381
+ readonly example: 10;
13382
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the current window";
12946
13383
  };
12947
13384
  readonly avgTimeToProdPastWindow: {
12948
13385
  readonly type: "number";
13386
+ readonly example: 10;
13387
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the previous window";
12949
13388
  };
12950
13389
  readonly createdCurrentWindow: {
12951
13390
  readonly type: "number";
13391
+ readonly example: 15;
13392
+ readonly description: "The number of feature toggles created during the current window";
12952
13393
  };
12953
13394
  readonly createdPastWindow: {
12954
13395
  readonly type: "number";
13396
+ readonly example: 15;
13397
+ readonly description: "The number of feature toggles created during the previous window";
12955
13398
  };
12956
13399
  readonly archivedCurrentWindow: {
12957
13400
  readonly type: "number";
13401
+ readonly example: 5;
13402
+ readonly description: "The number of feature toggles that were archived during the current window";
12958
13403
  };
12959
13404
  readonly archivedPastWindow: {
12960
13405
  readonly type: "number";
13406
+ readonly example: 5;
13407
+ readonly description: "The number of feature toggles that were archived during the previous window";
12961
13408
  };
12962
13409
  readonly projectActivityCurrentWindow: {
12963
13410
  readonly type: "number";
13411
+ readonly example: 100;
13412
+ readonly description: "The number of project events that occurred during the current window";
12964
13413
  };
12965
13414
  readonly projectActivityPastWindow: {
12966
13415
  readonly type: "number";
13416
+ readonly example: 100;
13417
+ readonly description: "The number of project events that occurred during the previous window";
12967
13418
  };
12968
13419
  readonly projectMembersAddedCurrentWindow: {
12969
13420
  readonly type: "number";
13421
+ readonly example: 1;
13422
+ readonly description: "The number of members that were added to the project during the current window";
12970
13423
  };
12971
13424
  };
12972
13425
  readonly components: {};
@@ -13427,57 +13880,80 @@ export declare const schemas: {
13427
13880
  readonly properties: {
13428
13881
  readonly name: {
13429
13882
  readonly type: "string";
13883
+ readonly example: "disable-comments";
13884
+ readonly description: "Unique feature name";
13430
13885
  };
13431
13886
  readonly type: {
13432
13887
  readonly type: "string";
13888
+ readonly example: "kill-switch";
13889
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
13433
13890
  };
13434
13891
  readonly description: {
13435
13892
  readonly type: "string";
13893
+ readonly nullable: true;
13894
+ readonly example: "Controls disabling of the comments section in case of an incident";
13895
+ readonly description: "Detailed description of the feature";
13436
13896
  };
13437
13897
  readonly archived: {
13438
13898
  readonly type: "boolean";
13899
+ readonly example: true;
13900
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
13439
13901
  };
13440
13902
  readonly project: {
13441
13903
  readonly type: "string";
13904
+ readonly example: "dx-squad";
13905
+ readonly description: "Name of the project the feature belongs to";
13442
13906
  };
13443
13907
  readonly enabled: {
13444
13908
  readonly type: "boolean";
13909
+ readonly example: true;
13445
13910
  };
13446
13911
  readonly stale: {
13447
13912
  readonly type: "boolean";
13913
+ readonly example: false;
13914
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
13448
13915
  };
13449
13916
  readonly favorite: {
13450
13917
  readonly type: "boolean";
13918
+ readonly example: true;
13919
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
13451
13920
  };
13452
13921
  readonly impressionData: {
13453
13922
  readonly type: "boolean";
13923
+ readonly example: false;
13924
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
13454
13925
  };
13455
13926
  readonly createdAt: {
13456
13927
  readonly type: "string";
13457
13928
  readonly format: "date-time";
13458
13929
  readonly nullable: true;
13930
+ readonly example: "2023-01-28T15:21:39.975Z";
13459
13931
  };
13460
13932
  readonly archivedAt: {
13461
13933
  readonly type: "string";
13462
13934
  readonly format: "date-time";
13463
13935
  readonly nullable: true;
13936
+ readonly example: "2023-01-29T15:21:39.975Z";
13464
13937
  };
13465
13938
  readonly lastSeenAt: {
13466
13939
  readonly type: "string";
13467
13940
  readonly format: "date-time";
13468
13941
  readonly nullable: true;
13942
+ readonly example: "2023-01-28T16:21:39.975Z";
13469
13943
  };
13470
13944
  readonly environments: {
13471
13945
  readonly type: "array";
13472
13946
  readonly items: {
13473
13947
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
13474
13948
  };
13949
+ readonly description: "The list of environments where the feature can be used";
13475
13950
  };
13476
13951
  readonly variants: {
13477
13952
  readonly type: "array";
13478
13953
  readonly items: {
13479
13954
  readonly $ref: "#/components/schemas/variantSchema";
13480
13955
  };
13956
+ readonly description: "The list of feature variants";
13481
13957
  };
13482
13958
  readonly tags: {
13483
13959
  readonly type: "array";
@@ -13485,6 +13961,7 @@ export declare const schemas: {
13485
13961
  readonly $ref: "#/components/schemas/tagSchema";
13486
13962
  };
13487
13963
  readonly nullable: true;
13964
+ readonly description: "The list of feature tags";
13488
13965
  };
13489
13966
  };
13490
13967
  readonly components: {
@@ -13535,24 +14012,34 @@ export declare const schemas: {
13535
14012
  readonly type: "object";
13536
14013
  readonly additionalProperties: false;
13537
14014
  readonly required: readonly ["name", "enabled"];
14015
+ readonly description: "A detailed description of the feature environment";
13538
14016
  readonly properties: {
13539
14017
  readonly name: {
13540
14018
  readonly type: "string";
14019
+ readonly example: "my-dev-env";
14020
+ readonly description: "The name of the environment";
13541
14021
  };
13542
14022
  readonly featureName: {
13543
14023
  readonly type: "string";
14024
+ readonly example: "disable-comments";
13544
14025
  };
13545
14026
  readonly environment: {
13546
14027
  readonly type: "string";
13547
14028
  };
13548
14029
  readonly type: {
13549
14030
  readonly type: "string";
14031
+ readonly example: "development";
14032
+ readonly description: "The type of the environment";
13550
14033
  };
13551
14034
  readonly enabled: {
13552
14035
  readonly type: "boolean";
14036
+ readonly example: true;
14037
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
13553
14038
  };
13554
14039
  readonly sortOrder: {
13555
14040
  readonly type: "number";
14041
+ readonly example: 3;
14042
+ readonly description: "The sort order of the feature environment in the feature environments list";
13556
14043
  };
13557
14044
  readonly variantCount: {
13558
14045
  readonly type: "number";
@@ -13562,12 +14049,14 @@ export declare const schemas: {
13562
14049
  readonly items: {
13563
14050
  readonly $ref: "#/components/schemas/featureStrategySchema";
13564
14051
  };
14052
+ readonly description: "A list of activation strategies for the feature environment";
13565
14053
  };
13566
14054
  readonly variants: {
13567
14055
  readonly type: "array";
13568
14056
  readonly items: {
13569
14057
  readonly $ref: "#/components/schemas/variantSchema";
13570
14058
  };
14059
+ readonly description: "A list of variants for the feature environment";
13571
14060
  };
13572
14061
  };
13573
14062
  readonly components: {
@@ -14027,24 +14516,38 @@ export declare const schemas: {
14027
14516
  readonly type: "object";
14028
14517
  readonly additionalProperties: false;
14029
14518
  readonly required: readonly ["id", "name"];
14519
+ readonly description: "A definition of the project used for projects listing purposes";
14030
14520
  readonly properties: {
14031
14521
  readonly id: {
14032
14522
  readonly type: "string";
14523
+ readonly example: "dx-squad";
14524
+ readonly description: "The id of this project";
14033
14525
  };
14034
14526
  readonly name: {
14035
14527
  readonly type: "string";
14528
+ readonly example: "DX-Squad";
14529
+ readonly description: "The name of this project";
14036
14530
  };
14037
14531
  readonly description: {
14038
14532
  readonly type: "string";
14533
+ readonly nullable: true;
14534
+ readonly example: "DX squad feature release";
14535
+ readonly description: "Additional information about the project";
14039
14536
  };
14040
14537
  readonly health: {
14041
14538
  readonly type: "number";
14539
+ readonly example: 50;
14540
+ readonly description: "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100";
14042
14541
  };
14043
14542
  readonly featureCount: {
14044
14543
  readonly type: "number";
14544
+ readonly example: 10;
14545
+ readonly description: "The number of features this project has";
14045
14546
  };
14046
14547
  readonly memberCount: {
14047
14548
  readonly type: "number";
14549
+ readonly example: 4;
14550
+ readonly description: "The number of members this project has";
14048
14551
  };
14049
14552
  readonly createdAt: {
14050
14553
  readonly type: "string";
@@ -14055,11 +14558,10 @@ export declare const schemas: {
14055
14558
  readonly format: "date-time";
14056
14559
  readonly nullable: true;
14057
14560
  };
14058
- readonly changeRequestsEnabled: {
14059
- readonly type: "boolean";
14060
- };
14061
14561
  readonly favorite: {
14062
14562
  readonly type: "boolean";
14563
+ readonly example: true;
14564
+ readonly description: "`true` if the project was favorited, otherwise `false`.";
14063
14565
  };
14064
14566
  };
14065
14567
  readonly components: {};
@@ -14157,24 +14659,34 @@ export declare const schemas: {
14157
14659
  readonly type: "object";
14158
14660
  readonly additionalProperties: false;
14159
14661
  readonly required: readonly ["name", "enabled"];
14662
+ readonly description: "A detailed description of the feature environment";
14160
14663
  readonly properties: {
14161
14664
  readonly name: {
14162
14665
  readonly type: "string";
14666
+ readonly example: "my-dev-env";
14667
+ readonly description: "The name of the environment";
14163
14668
  };
14164
14669
  readonly featureName: {
14165
14670
  readonly type: "string";
14671
+ readonly example: "disable-comments";
14166
14672
  };
14167
14673
  readonly environment: {
14168
14674
  readonly type: "string";
14169
14675
  };
14170
14676
  readonly type: {
14171
14677
  readonly type: "string";
14678
+ readonly example: "development";
14679
+ readonly description: "The type of the environment";
14172
14680
  };
14173
14681
  readonly enabled: {
14174
14682
  readonly type: "boolean";
14683
+ readonly example: true;
14684
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
14175
14685
  };
14176
14686
  readonly sortOrder: {
14177
14687
  readonly type: "number";
14688
+ readonly example: 3;
14689
+ readonly description: "The sort order of the feature environment in the feature environments list";
14178
14690
  };
14179
14691
  readonly variantCount: {
14180
14692
  readonly type: "number";
@@ -14184,12 +14696,14 @@ export declare const schemas: {
14184
14696
  readonly items: {
14185
14697
  readonly $ref: "#/components/schemas/featureStrategySchema";
14186
14698
  };
14699
+ readonly description: "A list of activation strategies for the feature environment";
14187
14700
  };
14188
14701
  readonly variants: {
14189
14702
  readonly type: "array";
14190
14703
  readonly items: {
14191
14704
  readonly $ref: "#/components/schemas/variantSchema";
14192
14705
  };
14706
+ readonly description: "A list of variants for the feature environment";
14193
14707
  };
14194
14708
  };
14195
14709
  readonly components: {
@@ -14399,33 +14913,48 @@ export declare const schemas: {
14399
14913
  readonly type: "object";
14400
14914
  readonly additionalProperties: false;
14401
14915
  readonly required: readonly ["name", "type", "enabled"];
14916
+ readonly description: "A definition of the project environment";
14402
14917
  readonly properties: {
14403
14918
  readonly name: {
14404
14919
  readonly type: "string";
14920
+ readonly example: "my-dev-env";
14921
+ readonly description: "The name of the environment";
14405
14922
  };
14406
14923
  readonly type: {
14407
14924
  readonly type: "string";
14925
+ readonly example: "development";
14926
+ readonly description: "The type of the environment";
14408
14927
  };
14409
14928
  readonly enabled: {
14410
14929
  readonly type: "boolean";
14930
+ readonly example: true;
14931
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
14411
14932
  };
14412
14933
  readonly protected: {
14413
14934
  readonly type: "boolean";
14414
14935
  };
14415
14936
  readonly sortOrder: {
14416
14937
  readonly type: "number";
14938
+ readonly example: 3;
14939
+ readonly description: "The sort order of the environment in the environments list";
14417
14940
  };
14418
14941
  readonly projectCount: {
14419
14942
  readonly type: "number";
14420
14943
  readonly nullable: true;
14944
+ readonly example: 10;
14945
+ readonly description: "The number of projects with this environment";
14421
14946
  };
14422
14947
  readonly apiTokenCount: {
14423
14948
  readonly type: "number";
14424
14949
  readonly nullable: true;
14950
+ readonly example: 6;
14951
+ readonly description: "The number of API tokens for the project environment";
14425
14952
  };
14426
14953
  readonly enabledToggleCount: {
14427
14954
  readonly type: "number";
14428
14955
  readonly nullable: true;
14956
+ readonly example: 10;
14957
+ readonly description: "The number of enabled toggles for the project environment";
14429
14958
  };
14430
14959
  };
14431
14960
  readonly components: {};
@@ -15343,6 +15872,7 @@ export declare const schemas: {
15343
15872
  };
15344
15873
  readonly description: {
15345
15874
  readonly type: "string";
15875
+ readonly nullable: true;
15346
15876
  };
15347
15877
  readonly mappingsSSO: {
15348
15878
  readonly type: "array";
@@ -16079,44 +16609,62 @@ export declare const schemas: {
16079
16609
  readonly type: "object";
16080
16610
  readonly additionalProperties: false;
16081
16611
  readonly required: readonly ["version", "name"];
16612
+ readonly description: "A high-level overview of a project. It contains information such as project statistics, the name of the project, what members and what features it contains, etc.";
16082
16613
  readonly properties: {
16083
16614
  readonly stats: {
16084
16615
  readonly $ref: "#/components/schemas/projectStatsSchema";
16616
+ readonly description: "Project statistics";
16085
16617
  };
16086
16618
  readonly version: {
16087
16619
  readonly type: "number";
16620
+ readonly example: 1;
16088
16621
  };
16089
16622
  readonly name: {
16090
16623
  readonly type: "string";
16624
+ readonly example: "dx-squad";
16625
+ readonly description: "The name of this project";
16091
16626
  };
16092
16627
  readonly description: {
16093
16628
  readonly type: "string";
16629
+ readonly nullable: true;
16630
+ readonly example: "DX squad feature release";
16631
+ readonly description: "Additional information about the project";
16094
16632
  };
16095
16633
  readonly members: {
16096
16634
  readonly type: "number";
16635
+ readonly example: 4;
16636
+ readonly description: "The number of members this project has";
16097
16637
  };
16098
16638
  readonly health: {
16099
16639
  readonly type: "number";
16640
+ readonly example: 50;
16641
+ readonly description: "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100";
16100
16642
  };
16101
16643
  readonly environments: {
16102
16644
  readonly type: "array";
16103
16645
  readonly items: {
16104
16646
  readonly type: "string";
16105
16647
  };
16648
+ readonly example: readonly ["development", "production"];
16649
+ readonly description: "The environments that are enabled for this project";
16106
16650
  };
16107
16651
  readonly features: {
16108
16652
  readonly type: "array";
16109
16653
  readonly items: {
16110
16654
  readonly $ref: "#/components/schemas/featureSchema";
16111
16655
  };
16656
+ readonly description: "The full list of features in this project (excluding archived features)";
16112
16657
  };
16113
16658
  readonly updatedAt: {
16114
16659
  readonly type: "string";
16115
16660
  readonly format: "date-time";
16116
16661
  readonly nullable: true;
16662
+ readonly example: "2023-02-10T08:36:35.262Z";
16117
16663
  };
16118
16664
  readonly favorite: {
16119
16665
  readonly type: "boolean";
16666
+ readonly example: true;
16667
+ readonly description: "`true` if the project was favorited, otherwise `false`.";
16120
16668
  };
16121
16669
  };
16122
16670
  readonly components: {
@@ -16167,33 +16715,48 @@ export declare const schemas: {
16167
16715
  readonly type: "object";
16168
16716
  readonly additionalProperties: false;
16169
16717
  readonly required: readonly ["name", "type", "enabled"];
16718
+ readonly description: "A definition of the project environment";
16170
16719
  readonly properties: {
16171
16720
  readonly name: {
16172
16721
  readonly type: "string";
16722
+ readonly example: "my-dev-env";
16723
+ readonly description: "The name of the environment";
16173
16724
  };
16174
16725
  readonly type: {
16175
16726
  readonly type: "string";
16727
+ readonly example: "development";
16728
+ readonly description: "The type of the environment";
16176
16729
  };
16177
16730
  readonly enabled: {
16178
16731
  readonly type: "boolean";
16732
+ readonly example: true;
16733
+ readonly description: "`true` if the environment is enabled for the project, otherwise `false`.";
16179
16734
  };
16180
16735
  readonly protected: {
16181
16736
  readonly type: "boolean";
16182
16737
  };
16183
16738
  readonly sortOrder: {
16184
16739
  readonly type: "number";
16740
+ readonly example: 3;
16741
+ readonly description: "The sort order of the environment in the environments list";
16185
16742
  };
16186
16743
  readonly projectCount: {
16187
16744
  readonly type: "number";
16188
16745
  readonly nullable: true;
16746
+ readonly example: 10;
16747
+ readonly description: "The number of projects with this environment";
16189
16748
  };
16190
16749
  readonly apiTokenCount: {
16191
16750
  readonly type: "number";
16192
16751
  readonly nullable: true;
16752
+ readonly example: 6;
16753
+ readonly description: "The number of API tokens for the project environment";
16193
16754
  };
16194
16755
  readonly enabledToggleCount: {
16195
16756
  readonly type: "number";
16196
16757
  readonly nullable: true;
16758
+ readonly example: 10;
16759
+ readonly description: "The number of enabled toggles for the project environment";
16197
16760
  };
16198
16761
  };
16199
16762
  readonly components: {};
@@ -16206,57 +16769,80 @@ export declare const schemas: {
16206
16769
  readonly properties: {
16207
16770
  readonly name: {
16208
16771
  readonly type: "string";
16772
+ readonly example: "disable-comments";
16773
+ readonly description: "Unique feature name";
16209
16774
  };
16210
16775
  readonly type: {
16211
16776
  readonly type: "string";
16777
+ readonly example: "kill-switch";
16778
+ readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
16212
16779
  };
16213
16780
  readonly description: {
16214
16781
  readonly type: "string";
16782
+ readonly nullable: true;
16783
+ readonly example: "Controls disabling of the comments section in case of an incident";
16784
+ readonly description: "Detailed description of the feature";
16215
16785
  };
16216
16786
  readonly archived: {
16217
16787
  readonly type: "boolean";
16788
+ readonly example: true;
16789
+ readonly description: "`true` if the feature is archived, otherwise `false`.";
16218
16790
  };
16219
16791
  readonly project: {
16220
16792
  readonly type: "string";
16793
+ readonly example: "dx-squad";
16794
+ readonly description: "Name of the project the feature belongs to";
16221
16795
  };
16222
16796
  readonly enabled: {
16223
16797
  readonly type: "boolean";
16798
+ readonly example: true;
16224
16799
  };
16225
16800
  readonly stale: {
16226
16801
  readonly type: "boolean";
16802
+ readonly example: false;
16803
+ readonly description: "`true` if the feature is stale based on the age and feature type, otherwise `false`.";
16227
16804
  };
16228
16805
  readonly favorite: {
16229
16806
  readonly type: "boolean";
16807
+ readonly example: true;
16808
+ readonly description: "`true` if the feature was favorited, otherwise `false`.";
16230
16809
  };
16231
16810
  readonly impressionData: {
16232
16811
  readonly type: "boolean";
16812
+ readonly example: false;
16813
+ readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
16233
16814
  };
16234
16815
  readonly createdAt: {
16235
16816
  readonly type: "string";
16236
16817
  readonly format: "date-time";
16237
16818
  readonly nullable: true;
16819
+ readonly example: "2023-01-28T15:21:39.975Z";
16238
16820
  };
16239
16821
  readonly archivedAt: {
16240
16822
  readonly type: "string";
16241
16823
  readonly format: "date-time";
16242
16824
  readonly nullable: true;
16825
+ readonly example: "2023-01-29T15:21:39.975Z";
16243
16826
  };
16244
16827
  readonly lastSeenAt: {
16245
16828
  readonly type: "string";
16246
16829
  readonly format: "date-time";
16247
16830
  readonly nullable: true;
16831
+ readonly example: "2023-01-28T16:21:39.975Z";
16248
16832
  };
16249
16833
  readonly environments: {
16250
16834
  readonly type: "array";
16251
16835
  readonly items: {
16252
16836
  readonly $ref: "#/components/schemas/featureEnvironmentSchema";
16253
16837
  };
16838
+ readonly description: "The list of environments where the feature can be used";
16254
16839
  };
16255
16840
  readonly variants: {
16256
16841
  readonly type: "array";
16257
16842
  readonly items: {
16258
16843
  readonly $ref: "#/components/schemas/variantSchema";
16259
16844
  };
16845
+ readonly description: "The list of feature variants";
16260
16846
  };
16261
16847
  readonly tags: {
16262
16848
  readonly type: "array";
@@ -16264,6 +16850,7 @@ export declare const schemas: {
16264
16850
  readonly $ref: "#/components/schemas/tagSchema";
16265
16851
  };
16266
16852
  readonly nullable: true;
16853
+ readonly description: "The list of feature tags";
16267
16854
  };
16268
16855
  };
16269
16856
  readonly components: {
@@ -16314,24 +16901,34 @@ export declare const schemas: {
16314
16901
  readonly type: "object";
16315
16902
  readonly additionalProperties: false;
16316
16903
  readonly required: readonly ["name", "enabled"];
16904
+ readonly description: "A detailed description of the feature environment";
16317
16905
  readonly properties: {
16318
16906
  readonly name: {
16319
16907
  readonly type: "string";
16908
+ readonly example: "my-dev-env";
16909
+ readonly description: "The name of the environment";
16320
16910
  };
16321
16911
  readonly featureName: {
16322
16912
  readonly type: "string";
16913
+ readonly example: "disable-comments";
16323
16914
  };
16324
16915
  readonly environment: {
16325
16916
  readonly type: "string";
16326
16917
  };
16327
16918
  readonly type: {
16328
16919
  readonly type: "string";
16920
+ readonly example: "development";
16921
+ readonly description: "The type of the environment";
16329
16922
  };
16330
16923
  readonly enabled: {
16331
16924
  readonly type: "boolean";
16925
+ readonly example: true;
16926
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
16332
16927
  };
16333
16928
  readonly sortOrder: {
16334
16929
  readonly type: "number";
16930
+ readonly example: 3;
16931
+ readonly description: "The sort order of the feature environment in the feature environments list";
16335
16932
  };
16336
16933
  readonly variantCount: {
16337
16934
  readonly type: "number";
@@ -16341,12 +16938,14 @@ export declare const schemas: {
16341
16938
  readonly items: {
16342
16939
  readonly $ref: "#/components/schemas/featureStrategySchema";
16343
16940
  };
16941
+ readonly description: "A list of activation strategies for the feature environment";
16344
16942
  };
16345
16943
  readonly variants: {
16346
16944
  readonly type: "array";
16347
16945
  readonly items: {
16348
16946
  readonly $ref: "#/components/schemas/variantSchema";
16349
16947
  };
16948
+ readonly description: "A list of variants for the feature environment";
16350
16949
  };
16351
16950
  };
16352
16951
  readonly components: {
@@ -16748,24 +17347,34 @@ export declare const schemas: {
16748
17347
  readonly type: "object";
16749
17348
  readonly additionalProperties: false;
16750
17349
  readonly required: readonly ["name", "enabled"];
17350
+ readonly description: "A detailed description of the feature environment";
16751
17351
  readonly properties: {
16752
17352
  readonly name: {
16753
17353
  readonly type: "string";
17354
+ readonly example: "my-dev-env";
17355
+ readonly description: "The name of the environment";
16754
17356
  };
16755
17357
  readonly featureName: {
16756
17358
  readonly type: "string";
17359
+ readonly example: "disable-comments";
16757
17360
  };
16758
17361
  readonly environment: {
16759
17362
  readonly type: "string";
16760
17363
  };
16761
17364
  readonly type: {
16762
17365
  readonly type: "string";
17366
+ readonly example: "development";
17367
+ readonly description: "The type of the environment";
16763
17368
  };
16764
17369
  readonly enabled: {
16765
17370
  readonly type: "boolean";
17371
+ readonly example: true;
17372
+ readonly description: "`true` if the feature is enabled for the environment, otherwise `false`.";
16766
17373
  };
16767
17374
  readonly sortOrder: {
16768
17375
  readonly type: "number";
17376
+ readonly example: 3;
17377
+ readonly description: "The sort order of the feature environment in the feature environments list";
16769
17378
  };
16770
17379
  readonly variantCount: {
16771
17380
  readonly type: "number";
@@ -16775,12 +17384,14 @@ export declare const schemas: {
16775
17384
  readonly items: {
16776
17385
  readonly $ref: "#/components/schemas/featureStrategySchema";
16777
17386
  };
17387
+ readonly description: "A list of activation strategies for the feature environment";
16778
17388
  };
16779
17389
  readonly variants: {
16780
17390
  readonly type: "array";
16781
17391
  readonly items: {
16782
17392
  readonly $ref: "#/components/schemas/variantSchema";
16783
17393
  };
17394
+ readonly description: "A list of variants for the feature environment";
16784
17395
  };
16785
17396
  };
16786
17397
  readonly components: {
@@ -17164,33 +17775,52 @@ export declare const schemas: {
17164
17775
  readonly type: "object";
17165
17776
  readonly additionalProperties: false;
17166
17777
  readonly required: readonly ["avgTimeToProdCurrentWindow", "avgTimeToProdPastWindow", "createdCurrentWindow", "createdPastWindow", "archivedCurrentWindow", "archivedPastWindow", "projectActivityCurrentWindow", "projectActivityPastWindow", "projectMembersAddedCurrentWindow"];
17778
+ readonly description: "Statistics for a project, including the average time to production, number of features created, the project activity and more.\n\nStats are divided into current and previous **windows**.\n- The **current window** is the past 30 days.\n- The **previous window** is the 30 days **before** the current window (from 60 to 30 days ago)";
17167
17779
  readonly properties: {
17168
17780
  readonly avgTimeToProdCurrentWindow: {
17169
17781
  readonly type: "number";
17782
+ readonly example: 10;
17783
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the current window";
17170
17784
  };
17171
17785
  readonly avgTimeToProdPastWindow: {
17172
17786
  readonly type: "number";
17787
+ readonly example: 10;
17788
+ readonly description: "The average time from when a feature was created to when it was enabled in the \"production\" environment during the previous window";
17173
17789
  };
17174
17790
  readonly createdCurrentWindow: {
17175
17791
  readonly type: "number";
17792
+ readonly example: 15;
17793
+ readonly description: "The number of feature toggles created during the current window";
17176
17794
  };
17177
17795
  readonly createdPastWindow: {
17178
17796
  readonly type: "number";
17797
+ readonly example: 15;
17798
+ readonly description: "The number of feature toggles created during the previous window";
17179
17799
  };
17180
17800
  readonly archivedCurrentWindow: {
17181
17801
  readonly type: "number";
17802
+ readonly example: 5;
17803
+ readonly description: "The number of feature toggles that were archived during the current window";
17182
17804
  };
17183
17805
  readonly archivedPastWindow: {
17184
17806
  readonly type: "number";
17807
+ readonly example: 5;
17808
+ readonly description: "The number of feature toggles that were archived during the previous window";
17185
17809
  };
17186
17810
  readonly projectActivityCurrentWindow: {
17187
17811
  readonly type: "number";
17812
+ readonly example: 100;
17813
+ readonly description: "The number of project events that occurred during the current window";
17188
17814
  };
17189
17815
  readonly projectActivityPastWindow: {
17190
17816
  readonly type: "number";
17817
+ readonly example: 100;
17818
+ readonly description: "The number of project events that occurred during the previous window";
17191
17819
  };
17192
17820
  readonly projectMembersAddedCurrentWindow: {
17193
17821
  readonly type: "number";
17822
+ readonly example: 1;
17823
+ readonly description: "The number of members that were added to the project during the current window";
17194
17824
  };
17195
17825
  };
17196
17826
  readonly components: {};