Added missing archivedAt to featureSchema (#1779)

* Added missing archivedAt to featureSchema

* Added archivedAt to feature toggle.
Added archived_at to db

* Add test

* Add test

* Bug fix

* Bug fix

* update archivedAt to date-time

* Code refactoring done

* Conver to static and remove unused methods

* Add tests

* Fixes

* Fix

* Removed docker file from linting

* Fix segment test

* Fix failing test

* Make fixes

Co-authored-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: andreas-unleash <104830839+andreas-unleash@users.noreply.github.com>

.github/workflows/build.yaml

@@ -29,6 +29,7 @@ jobs:
         options: >-
           --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
+
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/build_coverage.yaml

@@ -29,6 +29,7 @@ jobs:
         options: >-
           --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
+
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/build_prs_jest_report.yaml

@@ -24,6 +24,7 @@ jobs:
         options: >-
           --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
+
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}

src/lib/db/feature-strategy-store.ts

@@ -15,6 +15,7 @@ import {
 } from '../types/model';
 import { IFeatureStrategiesStore } from '../types/stores/feature-strategies-store';
 import { PartialSome } from '../types/partial';
+import FeatureToggleStore from './feature-toggle-store';
 import { ensureStringValue } from '../util/ensureStringValue';
 import { mapValues } from '../util/map-values';
 
@@ -246,7 +247,7 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
                 'environments.name',
             )
             .where('features.name', featureName)
-            .andWhere('features.archived', archived ? 1 : 0);
+            .modify(FeatureToggleStore.filterByArchived, archived);
         stopTimer();
         if (rows.length > 0) {
             const featureToggle = rows.reduce((acc, r) => {
@@ -318,7 +319,7 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
         archived: boolean = false,
     ): Promise<IFeatureOverview[]> {
         const rows = await this.db('features')
-            .where({ project: projectId, archived })
+            .where({ project: projectId })
             .select(
                 'features.name as feature_name',
                 'features.type as type',
@@ -330,6 +331,7 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
                 'environments.type as environment_type',
                 'environments.sort_order as environment_sort_order',
             )
+            .modify(FeatureToggleStore.filterByArchived, archived)
             .fullOuterJoin(
                 'feature_environments',
                 'feature_environments.feature_name',

src/lib/db/feature-toggle-client-store.ts

@@ -11,6 +11,7 @@ import { IFeatureToggleClientStore } from '../types/stores/feature-toggle-client
 import { DEFAULT_ENV } from '../util/constants';
 import { PartialDeep } from '../types/partial';
 import EventEmitter from 'events';
+import FeatureToggleStore from './feature-toggle-store';
 import { ensureStringValue } from '../util/ensureStringValue';
 import { mapValues } from '../util/map-values';
 
@@ -82,6 +83,7 @@ export default class FeatureToggleClientStore
 
         let query = this.db('features')
             .select(selectColumns)
+            .modify(FeatureToggleStore.filterByArchived, archived)
             .fullOuterJoin(
                 this.db('feature_strategies')
                     .select('*')
@@ -105,10 +107,6 @@ export default class FeatureToggleClientStore
             )
             .fullOuterJoin('segments', `segments.id`, `fss.segment_id`);
 
-        query = query.where({
-            archived,
-        });
-
         if (featureQuery) {
             if (featureQuery.tag) {
                 const tagQuery = this.db

src/lib/db/feature-toggle-store.ts

@@ -17,6 +17,7 @@ const FEATURE_COLUMNS = [
     'created_at',
     'impression_data',
     'last_seen_at',
+    'archived_at',
 ];
 
 export interface FeaturesTable {
@@ -29,6 +30,8 @@ export interface FeaturesTable {
     last_seen_at?: Date;
     created_at?: Date;
     impression_data: boolean;
+    archived?: boolean;
+    archived_at?: Date;
 }
 
 const TABLE = 'features';
@@ -57,10 +60,12 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
             stale?: boolean;
         } = { archived: false },
     ): Promise<number> {
+        const { archived, ...rest } = query;
         return this.db
             .from(TABLE)
             .count('*')
-            .where(query)
+            .where(rest)
+            .modify(FeatureToggleStore.filterByArchived, archived)
             .then((res) => Number(res[0].count));
     }
 
@@ -85,18 +90,12 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
             stale?: boolean;
         } = { archived: false },
     ): Promise<FeatureToggle[]> {
+        const { archived, ...rest } = query;
         const rows = await this.db
             .select(FEATURE_COLUMNS)
             .from(TABLE)
-            .where(query);
-        return rows.map(this.rowToFeature);
-    }
-
-    async getFeatures(archived: boolean): Promise<FeatureToggle[]> {
-        const rows = await this.db
-            .select(FEATURE_COLUMNS)
-            .from(TABLE)
-            .where({ archived });
+            .where(rest)
+            .modify(FeatureToggleStore.filterByArchived, archived);
         return rows.map(this.rowToFeature);
     }
 
@@ -126,15 +125,6 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
         return present;
     }
 
-    async getArchivedFeatures(): Promise<FeatureToggle[]> {
-        const rows = await this.db
-            .select(FEATURE_COLUMNS)
-            .from(TABLE)
-            .where({ archived: true })
-            .orderBy('name', 'asc');
-        return rows.map(this.rowToFeature);
-    }
-
     async setLastSeen(toggleNames: string[]): Promise<void> {
         const now = new Date();
         try {
@@ -153,6 +143,15 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
         }
     }
 
+    static filterByArchived: Knex.QueryCallbackWithArgs = (
+        queryBuilder: Knex.QueryBuilder,
+        archived: boolean,
+    ) => {
+        return archived
+            ? queryBuilder.whereNotNull('archived_at')
+            : queryBuilder.whereNull('archived_at');
+    };
+
     rowToFeature(row: FeaturesTable): FeatureToggle {
         if (!row) {
             throw new NotFoundError('No feature toggle found');
@@ -169,6 +168,8 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
             createdAt: row.created_at,
             lastSeenAt: row.last_seen_at,
             impressionData: row.impression_data,
+            archivedAt: row.archived_at,
+            archived: row.archived_at != null,
         };
     }
 
@@ -188,7 +189,7 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
             description: data.description,
             type: data.type,
             project,
-            archived: data.archived || false,
+            archived_at: data.archived ? new Date() : null,
             stale: data.stale,
             created_at: data.createdAt,
             impression_data: data.impressionData,
@@ -228,23 +229,25 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
     }
 
     async archive(name: string): Promise<FeatureToggle> {
+        const now = new Date();
         const row = await this.db(TABLE)
             .where({ name })
-            .update({ archived: true })
+            .update({ archived_at: now })
             .returning(FEATURE_COLUMNS);
         return this.rowToFeature(row[0]);
     }
 
     async delete(name: string): Promise<void> {
         await this.db(TABLE)
-            .where({ name, archived: true }) // Feature toggle must be archived to allow deletion
+            .where({ name }) // Feature toggle must be archived to allow deletion
+            .whereNotNull('archived_at')
             .del();
     }
 
     async revive(name: string): Promise<FeatureToggle> {
         const row = await this.db(TABLE)
             .where({ name })
-            .update({ archived: false })
+            .update({ archived_at: null })
             .returning(FEATURE_COLUMNS);
         return this.rowToFeature(row[0]);
     }

src/lib/openapi/spec/feature-schema.ts

@@ -41,6 +41,11 @@ export const featureSchema = {
             format: 'date-time',
             nullable: true,
         },
+        archivedAt: {
+            type: 'string',
+            format: 'date-time',
+            nullable: true,
+        },
         lastSeenAt: {
             type: 'string',
             format: 'date-time',

src/lib/types/model.ts

@@ -45,6 +45,7 @@ export interface FeatureToggleDTO {
     type?: string;
     stale?: boolean;
     archived?: boolean;
+    archivedAt?: Date;
     createdAt?: Date;
     impressionData?: boolean;
     variants?: IVariant[];

src/migrations/20220603081324-add-archive-at-to-feature-toggle.js

@@ -0,0 +1,38 @@
+'use strict';
+
+exports.up = function (db, callback) {
+    db.runSql(
+        `
+        ALTER TABLE features ADD archived_at TIMESTAMP WITH TIME ZONE;
+        UPDATE features f
+        SET    archived_at = res.archived_at
+            FROM   (SELECT f.name, e.created_at AS archived_at
+        FROM   features f
+               INNER JOIN events e
+                       ON e.feature_name = f.NAME
+                          AND e.created_at =
+                              (SELECT Max(created_at) date
+                               FROM   events
+                               WHERE  type = 'feature-archived'
+                                      AND e.feature_name = f.NAME)) res
+        WHERE  res.NAME = f.NAME;
+        UPDATE features
+        SET    archived_at = Now()
+        WHERE  archived = TRUE
+          AND archived_at IS NULL;
+        `,
+        callback,
+    );
+};
+
+exports.down = function (db, callback) {
+    db.runSql(
+        `
+        UPDATE features
+        SET    archived = TRUE
+        WHERE  archived_at IS NOT NULL;
+        ALTER TABLE features DROP COLUMN archived_at;
+        `,
+        callback,
+    );
+};

src/test/e2e/api/admin/feature-archive.e2e.test.ts

@@ -98,6 +98,19 @@ test('returns three archived toggles', async () => {
         });
 });
 
+test('returns three archived toggles with archivedAt', async () => {
+    expect.assertions(3);
+    return app.request
+        .get('/api/admin/archive/features')
+        .expect('Content-Type', /json/)
+        .expect(200)
+        .expect((res) => {
+            expect(res.body.features.length).toEqual(3);
+            expect(res.body.features.every((f) => f.archived)).toEqual(true);
+            expect(res.body.features.every((f) => f.archivedAt)).toEqual(true);
+        });
+});
+
 test('revives a feature by name', async () => {
     return app.request
         .post('/api/admin/archive/revive/featureArchivedX')

src/test/e2e/api/admin/feature.e2e.test.ts

@@ -25,7 +25,7 @@ beforeAll(async () => {
     app = await setupApp(db.stores);
 
     const createToggle = async (
-        toggle: Omit<FeatureSchema, 'createdAt'>,
+        toggle: Omit<FeatureSchema, 'archivedAt' | 'createdAt'>,
         strategy: Omit<FeatureStrategySchema, 'id'> = defaultStrategy,
         projectId: string = 'default',
         username: string = 'test',

src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap

@@ -1185,6 +1185,11 @@ Object {
           "archived": Object {
             "type": "boolean",
           },
+          "archivedAt": Object {
+            "format": "date-time",
+            "nullable": true,
+            "type": "string",
+          },
           "createdAt": Object {
             "format": "date-time",
             "nullable": true,

website/docs/api/admin/events-api.md

@@ -2,11 +2,10 @@
 id: events
 title: /api/admin/events
 ---
+
 import ApiRequest from '@site/src/components/ApiRequest'
 
-:::note
-In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token.
-:::
+:::note In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token. :::
 
 The Events API lets you retrieve events from your Unleash instance.
 
@@ -19,17 +18,16 @@ The Events API lets you retrieve events from your Unleash instance.
 #### Query parameters
 
 | Query parameter | Description | Required |
-|-----------------|----------------------------------------------------------------------------|----------|
+| --- | --- | --- |
 | `project` | When applied, the endpoint will only return events from the given project. | No |
 
 When called without any query parameters, the endpoint will return the **last 100 events** from the Unleash instance. When called with a `project` query parameter, it will return only events related to that project, but it will return **all the events**, and not just the last 100.
 
-
 #### Get events by project
 
 <ApiRequest verb="get" url="api/admin/events?project=<project-name>" title="Retrieve all events belonging to the given project."/>
 
-Use the `project` query parameter to make the API return *all* events pertaining to the given project.
+Use the `project` query parameter to make the API return _all_ events pertaining to the given project.
 
 #### Responses
 
@@ -42,7 +40,7 @@ The last 100 events from the Unleash server when called without a `project` quer
 
 When called with a `project` query parameter: all events related to that project.
 
-``` json title="Successful response; a list of events"
+```json title="Successful response; a list of events"
 {
   "version": 1,
   "events": [
@@ -91,7 +89,7 @@ Fetch all events related to a specified toggle.
 
 The list of events related to the given toggle.
 
-``` json title="Successful response; all events relating to the specified toggle"
+```json title="Successful response; all events relating to the specified toggle"
 {
   "toggleName": "my-constrained-toggle",
   "events": [
@@ -130,7 +128,6 @@ The list of events related to the given toggle.
 Unleash emits a large number of different events (described in more detail in the next sections). The exact fields an event contains varies from event to event, but they all conform to the following TypeScript interface before being transformed to JSON:
 
 ```ts
-
 interface IEvent {
   id: number;
   createdAt: Date;
@@ -148,7 +145,7 @@ interface IEvent {
 The event properties are described in short in the table below. For more info regarding specific event types, refer to the corresponding, following sections.
 
 | Property | Description |
-|---------------|-----------------------------------------------------------------------------------------------------------------------|
+| --- | --- |
 | `createdAt` | The time the event happened as a RFC 3339-conformant timestamp. |
 | `data` | Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable. |
 | `environment` | The feature toggle environment the event relates to, if applicable. |
@@ -159,7 +156,6 @@ The event properties are described in short in the table below. For more info re
 | `tags` | Any tags related to the event, if applicable. |
 | `type` | The event type, as described in the rest of this section. |
 
-
 ## Feature toggle events
 
 These events pertain to feature toggles and their life cycle.
@@ -168,7 +164,7 @@ These events pertain to feature toggles and their life cycle.
 
 This event fires when you create a feature. The `data` property contains the details for the new feature.
 
-``` json title="example event: feature-created"
+```json title="example event: feature-created"
 {
   "id": 899,
   "type": "feature-created",
@@ -195,14 +191,11 @@ This event fires when you create a feature. The `data` property contains the det
 
 ### `feature-updated`
 
-:::caution Deprecation notice
-This event type was replaced by more granular event types in Unleash 4.3. From Unleash 4.3 onwards, you'll need to use the events listed later in this section instead.
-:::
+:::caution Deprecation notice This event type was replaced by more granular event types in Unleash 4.3. From Unleash 4.3 onwards, you'll need to use the events listed later in this section instead. :::
 
 This event fires when a feature gets updated in some way. The `data` property contains the new state of the toggle. This is a legacy event, so it does not populate `preData` property.
 
-
-``` json title="example event: feature-updated"
+```json title="example event: feature-updated"
 {
   "id": 899,
   "type": "feature-updated",
@@ -231,7 +224,7 @@ This event fires when a feature gets updated in some way. The `data` property co
 
 This event fires when you delete a feature toggle. The `preData` property contains the deleted toggle data.
 
-``` json title="example event: feature-deleted"
+```json title="example event: feature-deleted"
 {
   "id": 903,
   "type": "feature-deleted",
@@ -260,7 +253,7 @@ This event fires when you delete a feature toggle. The `preData` property contai
 
 This event fires when you archive a toggle.
 
-``` json title="example event: feature-archived"
+```json title="example event: feature-archived"
 {
   "id": 902,
   "type": "feature-archived",
@@ -279,7 +272,7 @@ This event fires when you archive a toggle.
 
 This event fires when you revive an archived feature toggle (when you take a toggle out from the archive).
 
-``` json title="example-event: feature-revived"
+```json title="example-event: feature-revived"
 {
   "id": 914,
   "type": "feature-revived",
@@ -298,9 +291,9 @@ This event fires when you revive an archived feature toggle (when you take a tog
 
 This event fires when a feature's metadata (its description, toggle type, or impression data settings) are changed. The `data` property contains the new toggle data. The `preData` property contains the toggle's previous data.
 
-The below example changes the toggle's type from *release* to *experiment*.
+The below example changes the toggle's type from _release_ to _experiment_.
 
-``` json title="example event: feature-metadata-updated"
+```json title="example event: feature-metadata-updated"
 {
   "id": 901,
   "type": "feature-metadata-updated",
@@ -339,7 +332,7 @@ The below example changes the toggle's type from *release* to *experiment*.
 
 This event fires when you move a feature from one project to another. The `data` property contains the names of the old and the new project.
 
-``` json title="example event: feature-project-change"
+```json title="example event: feature-project-change"
 {
   "id": 11,
   "type": "feature-project-change",
@@ -357,12 +350,11 @@ This event fires when you move a feature from one project to another. The `data`
 }
 ```
 
-
 ### `feature-import`
 
 This event fires when you import a feature as part of an import process. The `data` property contains the feature data.
 
-``` json title="example event: feature-import"
+```json title="example event: feature-import"
 {
   "id": 26,
   "type": "feature-import",
@@ -391,7 +383,7 @@ This event fires when you import a feature as part of an import process. The `da
 
 This event fires when you add a tag to a feature. The `data` property contains the new tag.
 
-``` json title="example event: feature-tagged"
+```json title="example event: feature-tagged"
 {
   "id": 897,
   "type": "feature-tagged",
@@ -413,7 +405,7 @@ This event fires when you add a tag to a feature. The `data` property contains t
 
 This event fires when you remove a tag from a toggle. The `data` property contains the tag that was removed.
 
-``` json title="example event: feature-untagged"
+```json title="example event: feature-untagged"
 {
   "id": 893,
   "type": "feature-untagged",
@@ -435,7 +427,7 @@ This event fires when you remove a tag from a toggle. The `data` property contai
 
 This event fires when you import a tagged feature as part of an import job. The `data` property contains the name of the feature and the tag.
 
-``` json title="example event: feature-tag-import"
+```json title="example event: feature-tag-import"
 {
   "id": 43,
   "type": "feature-tag-import",
@@ -460,7 +452,7 @@ This event fires when you import a tagged feature as part of an import job. The
 
 This event fires when you add a strategy to a feature. The `data` property contains the configuration for the new strategy.
 
-``` json title="example event: feature-strategy-add"
+```json title="example event: feature-strategy-add"
 {
   "id": 919,
   "type": "feature-strategy-add",
@@ -488,7 +480,7 @@ This event fires when you add a strategy to a feature. The `data` property conta
 
 This event fires when you update a feature strategy. The `data` property contains the new strategy configuration. The `preData` property contains the previous strategy configuration.
 
-``` json title="example event: feature-strategy-update"
+```json title="example event: feature-strategy-update"
 {
   "id": 920,
   "type": "feature-strategy-update",
@@ -525,7 +517,7 @@ This event fires when you update a feature strategy. The `data` property contain
 
 This event fires when you remove a strategy from a feature. The `preData` contains the configuration of the strategy that was removed.
 
-``` json title="example event: feature-strategy-remove"
+```json title="example event: feature-strategy-remove"
 {
   "id": 918,
   "type": "feature-strategy-remove",
@@ -549,7 +541,7 @@ This event fires when you remove a strategy from a feature. The `preData` contai
 
 This event fires when you mark a feature as stale.
 
-``` json title="example event: feature-stale-on"
+```json title="example event: feature-stale-on"
 {
   "id": 926,
   "type": "feature-stale-on",
@@ -577,7 +569,7 @@ This event fires when you mark a feature as stale.
 
 This event fires when you mark a stale feature as no longer being stale.
 
-``` json title="example event: feature-stale-off"
+```json title="example event: feature-stale-off"
 {
   "id": 928,
   "type": "feature-stale-off",
@@ -605,7 +597,7 @@ This event fires when you mark a stale feature as no longer being stale.
 
 This event fires when you enable an environment for a feature. The `environment` property contains the name of the environment.
 
-``` json title="example event: feature-environment-enabled"
+```json title="example event: feature-environment-enabled"
 {
   "id": 930,
   "type": "feature-environment-enabled",
@@ -633,7 +625,7 @@ This event fires when you enable an environment for a feature. The `environment`
 
 This event fires when you disable an environment for a feature. The `environment` property contains the name of the environment.
 
-``` json title="example event: feature-environment-disabled"
+```json title="example event: feature-environment-disabled"
 {
   "id": 931,
   "type": "feature-environment-disabled",
@@ -659,10 +651,9 @@ This event fires when you disable an environment for a feature. The `environment
 
 ### `drop-features`
 
-This event fires when you delete existing features as part of an import job.
-The `data.name` property will always be `"all-features"`.
+This event fires when you delete existing features as part of an import job. The `data.name` property will always be `"all-features"`.
 
-``` json title="example event: drop-features"
+```json title="example event: drop-features"
 {
   "id": 25,
   "type": "drop-features",
@@ -679,13 +670,11 @@ The `data.name` property will always be `"all-features"`.
 }
 ```
 
-
 ### `drop-feature-tags`
 
-This event fires when you drop all existing tags as part of a configuration import.
-The `data.name` property will always be `"all-feature-tags"`.
+This event fires when you drop all existing tags as part of a configuration import. The `data.name` property will always be `"all-feature-tags"`.
 
-``` json title="example event: drop-feature-tags"
+```json title="example event: drop-feature-tags"
 {
   "id": 36,
   "type": "drop-feature-tags",
@@ -702,14 +691,13 @@ The `data.name` property will always be `"all-feature-tags"`.
 }
 ```
 
-
 ## Strategy events
 
 ### `strategy-created`
 
 This event fires when you create a strategy. The `data` property contains the strategy configuration.
 
-``` json title="example event: strategy-created"
+```json title="example event: strategy-created"
 {
   "id": 932,
   "type": "strategy-created",
@@ -732,10 +720,9 @@ This event fires when you create a strategy. The `data` property contains the st
 
 ### `strategy-updated`
 
-This event fires when you change a strategy's configuration.
-The `data` property contains the new strategy configuration.
+This event fires when you change a strategy's configuration. The `data` property contains the new strategy configuration.
 
-``` json title="example event: strategy-updated"
+```json title="example event: strategy-updated"
 {
   "id": 933,
   "type": "strategy-updated",
@@ -760,7 +747,7 @@ The `data` property contains the new strategy configuration.
 
 This event fires when you delete a strategy. The `data` property contains the name of the deleted strategy.
 
-``` json title="example event: strategy-deleted"
+```json title="example event: strategy-deleted"
 {
   "id": 936,
   "type": "strategy-deleted",
@@ -781,7 +768,7 @@ This event fires when you delete a strategy. The `data` property contains the na
 
 This event fires when you deprecate a strategy. The `data` property contains the name of the deprecated strategy.
 
-``` json title="example event: strategy-deprecated"
+```json title="example event: strategy-deprecated"
 {
   "id": 934,
   "type": "strategy-deprecated",
@@ -800,10 +787,9 @@ This event fires when you deprecate a strategy. The `data` property contains the
 
 ### `strategy-reactivated`
 
-This event fires when you bring reactivate a deprecated strategy.
-The `data` property contains the name of the reactivated strategy.
+This event fires when you bring reactivate a deprecated strategy. The `data` property contains the name of the reactivated strategy.
 
-``` json title="example event: strategy-reactivated"
+```json title="example event: strategy-reactivated"
 {
   "id": 935,
   "type": "strategy-reactivated",
@@ -824,7 +810,7 @@ The `data` property contains the name of the reactivated strategy.
 
 This event fires when you import a strategy as part of an import job. The `data` property contains the strategy's configuration.
 
-``` json title="example event: strategy-import"
+```json title="example event: strategy-import"
 {
   "id": 29,
   "type": "strategy-import",
@@ -859,11 +845,9 @@ This event fires when you import a strategy as part of an import job. The `data`
 
 ### `drop-strategies`
 
-This event fires when you delete existing strategies as part of an important job.
-The `data.name` property will always be `"all-strategies"`.
+This event fires when you delete existing strategies as part of an important job. The `data.name` property will always be `"all-strategies"`.
 
-
-``` json title="example event: drop-strategies"
+```json title="example event: drop-strategies"
 {
   "id": 28,
   "type": "drop-strategies",
@@ -880,16 +864,13 @@ The `data.name` property will always be `"all-strategies"`.
 }
 ```
 
-
-
 ## Context field events
 
 ### `context-field-created`
 
-This event fires when you create a context field.
-The `data` property contains the context field configuration.
+This event fires when you create a context field. The `data` property contains the context field configuration.
 
-``` json title="example event: context-field-created"
+```json title="example event: context-field-created"
 {
   "id": 937,
   "type": "context-field-created",
@@ -911,10 +892,9 @@ The `data` property contains the context field configuration.
 
 ### `context-field-updated`
 
-This event fires when you update a context field.
-The `data` property contains the new context field configuration.
+This event fires when you update a context field. The `data` property contains the new context field configuration.
 
-``` json title="example event: context-field-updated"
+```json title="example event: context-field-updated"
 {
   "id": 939,
   "type": "context-field-updated",
@@ -945,10 +925,9 @@ The `data` property contains the new context field configuration.
 
 ### `context-field-deleted`
 
-This event fires when you delete a context field.
-The `data` property contains the name of the deleted context field.
+This event fires when you delete a context field. The `data` property contains the name of the deleted context field.
 
-``` json title="example event: context-field-deleted"
+```json title="example event: context-field-deleted"
 {
   "id": 940,
   "type": "context-field-deleted",
@@ -965,17 +944,13 @@ The `data` property contains the name of the deleted context field.
 }
 ```
 
-
-
 ## Project events
 
 ### `project-created`
 
-This event fires when you create a project.
-The `data` property contains the project configuration.
+This event fires when you create a project. The `data` property contains the project configuration.
 
-
-``` json title="example event: project-created"
+```json title="example event: project-created"
 {
   "id": 905,
   "type": "project-created",
@@ -996,11 +971,9 @@ The `data` property contains the project configuration.
 
 ### `project-updated`
 
-This event fires when you update a project's configuration.
-The `data` property contains the new project configuration.
-The `preData` property contains the previous project configuration.
+This event fires when you update a project's configuration. The `data` property contains the new project configuration. The `preData` property contains the previous project configuration.
 
-``` json title="example event: project-updated"
+```json title="example event: project-updated"
 {
   "id": 941,
   "type": "project-updated",
@@ -1028,10 +1001,9 @@ The `preData` property contains the previous project configuration.
 
 ### `project-deleted`
 
-This event fires when you delete a project.
-The `project` property contains the name of the deleted project.
+This event fires when you delete a project. The `project` property contains the name of the deleted project.
 
-``` json title="example event: project-deleted"
+```json title="example event: project-deleted"
 {
   "id": 944,
   "type": "project-deleted",
@@ -1050,7 +1022,7 @@ The `project` property contains the name of the deleted project.
 
 This event fires when you import a project. The `data` property contains the project's configuration details.
 
-``` json title="example event: project-import"
+```json title="example event: project-import"
 {
   "id": 35,
   "type": "project-import",
@@ -1074,11 +1046,9 @@ This event fires when you import a project. The `data` property contains the pro
 
 ### `drop-projects`
 
-This event fires when you delete existing projects as part of an import job.
-The `data.name` property will always be `"all-projects"`.
+This event fires when you delete existing projects as part of an import job. The `data.name` property will always be `"all-projects"`.
 
-
-``` json title="example event: drop-projects"
+```json title="example event: drop-projects"
 {
   "id": 33,
   "type": "drop-projects",
@@ -1095,16 +1065,13 @@ The `data.name` property will always be `"all-projects"`.
 }
 ```
 
-
-
-
 ## Tag events
 
 ### `tag-created`
 
 This event fires when you create a new tag. The `data` property contains the tag that was created.
 
-``` json title="example event: tag-created"
+```json title="example event: tag-created"
 {
   "id": 959,
   "type": "feature-tagged",
@@ -1126,7 +1093,7 @@ This event fires when you create a new tag. The `data` property contains the tag
 
 This event fires when you delete a tag. The `data` property contains the tag that was deleted.
 
-``` json title="example event: tag-deleted"
+```json title="example event: tag-deleted"
 {
   "id": 957,
   "type": "tag-deleted",
@@ -1148,7 +1115,7 @@ This event fires when you delete a tag. The `data` property contains the tag tha
 
 This event fires when you import a tag as part of an import job. The `data` property contains the imported tag.
 
-``` json title="example event: tag-import"
+```json title="example event: tag-import"
 {
   "id": 41,
   "type": "tag-import",
@@ -1168,11 +1135,9 @@ This event fires when you import a tag as part of an import job. The `data` prop
 
 ### `drop-tags`
 
-This event fires when you delete existing tags as part of an import job.
-The `data.name` property will always be `"all-tags"`.
+This event fires when you delete existing tags as part of an import job. The `data.name` property will always be `"all-tags"`.
 
-
-``` json title="example event: drop-tags"
+```json title="example event: drop-tags"
 {
   "id": 37,
   "type": "drop-tags",
@@ -1189,16 +1154,13 @@ The `data.name` property will always be `"all-tags"`.
 }
 ```
 
-
-
 ## Tag type events
 
 ### `tag-type-created`
 
-This event fires when you create a new tag type.
-The `data` property contains the tag type configuration.
+This event fires when you create a new tag type. The `data` property contains the tag type configuration.
 
-``` json title="example event: tag-type-created"
+```json title="example event: tag-type-created"
 {
   "id": 945,
   "type": "tag-type-created",
@@ -1218,10 +1180,9 @@ The `data` property contains the tag type configuration.
 
 ### `tag-type-updated`
 
-This event fires when you update a tag type.
-The `data` property contains the new tag type configuration.
+This event fires when you update a tag type. The `data` property contains the new tag type configuration.
 
-``` json title="example event: tag-type-updated"
+```json title="example event: tag-type-updated"
 {
   "id": 946,
   "type": "tag-type-updated",
@@ -1241,11 +1202,9 @@ The `data` property contains the new tag type configuration.
 
 ### `tag-type-deleted`
 
-This event fires when you delete a tag type.
-The `data` property contains the name of the deleted tag type.
+This event fires when you delete a tag type. The `data` property contains the name of the deleted tag type.
 
-
-``` json title="example event: tag-type-deleted"
+```json title="example event: tag-type-deleted"
 {
   "id": 947,
   "type": "tag-type-deleted",
@@ -1266,7 +1225,7 @@ The `data` property contains the name of the deleted tag type.
 
 This event fires when you import a tag type as part of an import job. The `data` property contains the imported tag.
 
-``` json title="example event: tag-type-import"
+```json title="example event: tag-type-import"
 {
   "id": 40,
   "type": "tag-type-import",
@@ -1287,11 +1246,9 @@ This event fires when you import a tag type as part of an import job. The `data`
 
 ### `drop-tag-types`
 
-This event fires when you drop all existing tag types as part of a configuration import.
-The `data.name` property will always be `"all-tag-types"`.
+This event fires when you drop all existing tag types as part of a configuration import. The `data.name` property will always be `"all-tag-types"`.
 
-
-``` json title="example event: drop-tag-types"
+```json title="example event: drop-tag-types"
 {
   "id": 38,
   "type": "drop-tag-types",
@@ -1312,10 +1269,9 @@ The `data.name` property will always be `"all-tag-types"`.
 
 ### `addon-config-created`
 
-This event fires when you create an addon configuration.
-The `data` property contains the provider type.
+This event fires when you create an addon configuration. The `data` property contains the provider type.
 
-``` json title="example event: addon-config-created"
+```json title="example event: addon-config-created"
 {
   "id": 960,
   "type": "addon-config-created",
@@ -1334,10 +1290,9 @@ The `data` property contains the provider type.
 
 ### `addon-config-updated`
 
-This event fires when you update an addon configuration.
-The `data` property contains the addon's ID and provider type.
+This event fires when you update an addon configuration. The `data` property contains the addon's ID and provider type.
 
-``` json title="example event: addon-config-updated"
+```json title="example event: addon-config-updated"
 {
   "id": 961,
   "type": "addon-config-updated",
@@ -1357,10 +1312,9 @@ The `data` property contains the addon's ID and provider type.
 
 ### `addon-config-deleted`
 
-This event fires when you update an addon configuration.
-The `data` property contains the addon's ID.
+This event fires when you update an addon configuration. The `data` property contains the addon's ID.
 
-``` json title="example event: addon-config-deleted"
+```json title="example event: addon-config-deleted"
 {
   "id": 964,
   "type": "addon-config-deleted",
@@ -1377,15 +1331,13 @@ The `data` property contains the addon's ID.
 }
 ```
 
-
-
 ## User events
 
 ### `user-created`
 
 This event fires when you create a new user. The `data` property contains the user's information.
 
-``` json title="example event: user-created"
+```json title="example event: user-created"
 {
   "id": 965,
   "type": "user-created",
@@ -1408,7 +1360,7 @@ This event fires when you create a new user. The `data` property contains the us
 
 This event fires when you update a user. The `data` property contains the updated user information; the `preData` property contains the previous state of the user's information.
 
-``` json title="example event: user-updated"
+```json title="example event: user-updated"
 {
   "id": 967,
   "type": "user-updated",
@@ -1435,7 +1387,7 @@ This event fires when you update a user. The `data` property contains the update
 
 This event fires when you delete a user. The `preData` property contains the deleted user's information.
 
-``` json title="example event: user-deleted"
+```json title="example event: user-deleted"
 {
   "id": 968,
   "type": "user-deleted",
@@ -1454,15 +1406,13 @@ This event fires when you delete a user. The `preData` property contains the del
 }
 ```
 
-
-
 ## Environment events
 
 ### `environment-import`
 
 This event fires when you import an environment (custom or otherwise) as part of an import job. The `data` property contains the configuration of the imported environment.
 
-``` json title="example event: environment-import"
+```json title="example event: environment-import"
 {
   "id": 24,
   "type": "environment-import",
@@ -1483,14 +1433,11 @@ This event fires when you import an environment (custom or otherwise) as part of
 }
 ```
 
-
-
 ### `drop-environments`
 
-This event fires when you delete existing environments as part of an import job.
-The `data.name` property will always be `"all-environments"`.
+This event fires when you delete existing environments as part of an import job. The `data.name` property will always be `"all-environments"`.
 
-``` json title="example event: drop-environments"
+```json title="example event: drop-environments"
 {
   "id": 21,
   "type": "drop-environments",
@@ -1507,14 +1454,13 @@ The `data.name` property will always be `"all-environments"`.
 }
 ```
 
-
 ## Segment events
 
 ### `segment-created`
 
 This event fires when you create a segment. The `data` property contains the newly created segment.
 
-``` json title="example event: segment-created"
+```json title="example event: segment-created"
 {
   "id": 969,
   "type": "segment-created",
@@ -1526,11 +1472,7 @@ This event fires when you create a segment. The `data` property contains the new
     "description": "this segment is for events",
     "constraints": [
       {
-        "values": [
-          "appA",
-          "appB",
-          "appC"
-        ],
+        "values": ["appA", "appB", "appC"],
         "inverted": false,
         "operator": "IN",
         "contextName": "appName",
@@ -1552,7 +1494,7 @@ This event fires when you create a segment. The `data` property contains the new
 
 This event fires when you update a segment's configuration. The `data` property contains the new segment configuration; the `preData` property contains the previous segment configuration.
 
-``` json title="example event: segment-updated"
+```json title="example event: segment-updated"
 {
   "id": 970,
   "type": "segment-updated",
@@ -1573,11 +1515,7 @@ This event fires when you update a segment's configuration. The `data` property
     "createdBy": "user@company.com",
     "constraints": [
       {
-        "values": [
-          "appA",
-          "appB",
-          "appC"
-        ],
+        "values": ["appA", "appB", "appC"],
         "inverted": false,
         "operator": "IN",
         "contextName": "appName",
@@ -1597,7 +1535,7 @@ This event fires when you update a segment's configuration. The `data` property
 
 This event fires when you delete a segment.
 
-``` json title="example event: segment-deleted"
+```json title="example event: segment-deleted"
 {
   "id": 971,
   "type": "segment-deleted",

website/docs/sdks/python.md

@@ -52,7 +52,7 @@ client.is_enabled("my_toggle", fallback_function=lambda feature_name, context: T
 
 The fallback function **must** accept the feature name and context as positional arguments in that order.
 
-The client will evaluate the fallback function only if an exception occurs when calling the `is_enabled()` method. This happens when the client can't find the feature flag. The client *may* also throw other, general exceptions.
+The client will evaluate the fallback function only if an exception occurs when calling the `is_enabled()` method. This happens when the client can't find the feature flag. The client _may_ also throw other, general exceptions.
 
 ## Getting a variant {#getting-a-variant}