mirror of
https://github.com/Unleash/unleash.git
synced 2025-10-13 11:17:26 +02:00
62 lines
2.3 KiB
TypeScript
62 lines
2.3 KiB
TypeScript
/**
|
|
* Generated by Orval
|
|
* Do not edit manually.
|
|
* See `gen:api` script in package.json
|
|
*/
|
|
import type { FeatureSchemaDependenciesItem } from './featureSchemaDependenciesItem';
|
|
import type { FeatureEnvironmentSchema } from './featureEnvironmentSchema';
|
|
import type { FeatureSchemaStrategiesItem } from './featureSchemaStrategiesItem';
|
|
import type { TagSchema } from './tagSchema';
|
|
import type { VariantSchema } from './variantSchema';
|
|
|
|
/**
|
|
* A feature toggle definition
|
|
*/
|
|
export interface FeatureSchema {
|
|
/** `true` if the feature is archived */
|
|
archived?: boolean;
|
|
/** The date the feature was archived */
|
|
archivedAt?: string | null;
|
|
/** The list of child feature names. This is an experimental field and may change. */
|
|
children?: string[];
|
|
/** The date the feature was created */
|
|
createdAt?: string | null;
|
|
/** The list of parent dependencies. This is an experimental field and may change. */
|
|
dependencies?: FeatureSchemaDependenciesItem[];
|
|
/** Detailed description of the feature */
|
|
description?: string | null;
|
|
/** `true` if the feature is enabled, otherwise `false`. */
|
|
enabled?: boolean;
|
|
/** The list of environments where the feature can be used */
|
|
environments?: FeatureEnvironmentSchema[];
|
|
/** `true` if the feature was favorited, otherwise `false`. */
|
|
favorite?: boolean;
|
|
/** `true` if the impression data collection is enabled for the feature, otherwise `false`. */
|
|
impressionData?: boolean;
|
|
/**
|
|
* The date when metrics where last collected for the feature. This field is deprecated, use the one in featureEnvironmentSchema
|
|
* @deprecated
|
|
*/
|
|
lastSeenAt?: string | null;
|
|
/** Unique feature name */
|
|
name: string;
|
|
/** Name of the project the feature belongs to */
|
|
project?: string;
|
|
/** `true` if the feature is stale based on the age and feature type, otherwise `false`. */
|
|
stale?: boolean;
|
|
/**
|
|
* This is a legacy field that will be deprecated
|
|
* @deprecated
|
|
*/
|
|
strategies?: FeatureSchemaStrategiesItem[];
|
|
/** The list of feature tags */
|
|
tags?: TagSchema[] | null;
|
|
/** Type of the toggle e.g. experiment, kill-switch, release, operational, permission */
|
|
type?: string;
|
|
/**
|
|
* The list of feature variants
|
|
* @deprecated
|
|
*/
|
|
variants?: VariantSchema[];
|
|
}
|