mirror of
https://github.com/Unleash/unleash.git
synced 2025-04-10 01:16:39 +02:00
chore: update orval types after renaming (#7127)
This commit is contained in:
parent
b3dd460d2f
commit
a4c48a16a4
@ -19,7 +19,7 @@ export type _ExportParams = {
|
||||
*/
|
||||
strategies?: boolean | string | number;
|
||||
/**
|
||||
* Whether feature toggles should be included in the exported data.
|
||||
* Whether feature flags should be included in the exported data.
|
||||
*/
|
||||
featureToggles?: boolean | string | number;
|
||||
/**
|
||||
|
@ -8,7 +8,7 @@
|
||||
* Query parameters used to modify the list of features returned.
|
||||
*/
|
||||
export interface AdminFeaturesQuerySchema {
|
||||
/** A case-insensitive prefix filter for the names of feature toggles */
|
||||
/** A case-insensitive prefix filter for the names of feature flags */
|
||||
namePrefix?: string;
|
||||
/** Used to filter by tags. For each entry, a TAGTYPE:TAGVALUE is expected */
|
||||
tag?: string[];
|
||||
|
@ -9,10 +9,10 @@ import type { AdvancedPlaygroundEnvironmentFeatureSchemaVariant } from './advanc
|
||||
import type { VariantSchema } from './variantSchema';
|
||||
|
||||
/**
|
||||
* A simplified feature toggle model intended for the Unleash playground.
|
||||
* A simplified feature flag model intended for the Unleash playground.
|
||||
*/
|
||||
export interface AdvancedPlaygroundEnvironmentFeatureSchema {
|
||||
/** The context to use when evaluating toggles */
|
||||
/** The context to use when evaluating flags */
|
||||
context: SdkFlatContextSchema;
|
||||
/** The feature's environment. */
|
||||
environment: string;
|
||||
|
@ -17,7 +17,7 @@ export type AdvancedPlaygroundEnvironmentFeatureSchemaVariant = {
|
||||
enabled: boolean;
|
||||
/** Whether the feature is enabled or not. If the feature is disabled, this property will be `false` */
|
||||
feature_enabled?: boolean;
|
||||
/** The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled` */
|
||||
/** The variant's name. If there is no variant or if the flag is disabled, this will be `disabled` */
|
||||
name: string;
|
||||
/** An optional payload attached to the variant. */
|
||||
payload?: AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload;
|
||||
|
@ -6,7 +6,7 @@
|
||||
import type { AdvancedPlaygroundFeatureSchemaEnvironments } from './advancedPlaygroundFeatureSchemaEnvironments';
|
||||
|
||||
/**
|
||||
* A simplified feature toggle model intended for the Unleash playground.
|
||||
* A simplified feature flag model intended for the Unleash playground.
|
||||
*/
|
||||
export interface AdvancedPlaygroundFeatureSchema {
|
||||
/** The lists of features that have been evaluated grouped by environment. */
|
||||
|
@ -5,9 +5,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* A list of feature toggle names for batch operations
|
||||
* A list of feature flag names for batch operations
|
||||
*/
|
||||
export interface BatchFeaturesSchema {
|
||||
/** List of feature toggle names */
|
||||
/** List of feature flag names */
|
||||
features: string[];
|
||||
}
|
||||
|
@ -8,35 +8,35 @@ import type { FeatureStrategySchema } from './featureStrategySchema';
|
||||
import type { VariantSchema } from './variantSchema';
|
||||
|
||||
/**
|
||||
* Feature toggle configuration used by SDKs to evaluate state of a toggle
|
||||
* Feature flag configuration used by SDKs to evaluate state of a flag
|
||||
*/
|
||||
export interface ClientFeatureSchema {
|
||||
/** Feature dependencies for this toggle */
|
||||
/** Feature dependencies for this flag */
|
||||
dependencies?: DependentFeatureSchema[];
|
||||
/**
|
||||
* A description of the toggle
|
||||
* A description of the flag
|
||||
* @nullable
|
||||
*/
|
||||
description?: string | null;
|
||||
/** Whether the feature flag is enabled for the current API key or not. This is ANDed with the evaluation results of the strategies list, so if this is false, the evaluation result will always be false */
|
||||
enabled: boolean;
|
||||
/**
|
||||
* Set to true if SDKs should trigger [impression events](https://docs.getunleash.io/reference/impression-data) when this toggle is evaluated
|
||||
* Set to true if SDKs should trigger [impression events](https://docs.getunleash.io/reference/impression-data) when this flag is evaluated
|
||||
* @nullable
|
||||
*/
|
||||
impressionData?: boolean | null;
|
||||
/** The unique name of a feature toggle. Is validated to be URL safe on creation */
|
||||
/** The unique name of a feature flag. Is validated to be URL safe on creation */
|
||||
name: string;
|
||||
/** Which project this feature toggle belongs to */
|
||||
/** Which project this feature flag belongs to */
|
||||
project?: string;
|
||||
/** If this is true Unleash believes this feature toggle has been active longer than Unleash expects a toggle of this type to be active */
|
||||
/** If this is true Unleash believes this feature flag has been active longer than Unleash expects a flag of this type to be active */
|
||||
stale?: boolean;
|
||||
/** Evaluation strategies for this toggle. Each entry in this list will be evaluated and ORed together */
|
||||
/** Evaluation strategies for this flag. Each entry in this list will be evaluated and ORed together */
|
||||
strategies?: FeatureStrategySchema[];
|
||||
/** What kind of feature flag is this. Refer to the documentation on [feature toggle types](https://docs.getunleash.io/reference/feature-toggle-types) for more information */
|
||||
/** What kind of feature flag is this. Refer to the documentation on [feature flag types](https://docs.getunleash.io/reference/feature-toggle-types) for more information */
|
||||
type?: string;
|
||||
/**
|
||||
* [Variants](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) configured for this toggle
|
||||
* [Variants](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) configured for this flag
|
||||
* @nullable
|
||||
*/
|
||||
variants?: VariantSchema[] | null;
|
||||
|
@ -9,7 +9,7 @@
|
||||
*/
|
||||
export interface ClientFeaturesQuerySchema {
|
||||
/**
|
||||
* Strategies for the feature toggle configured for this environment are included. (DEPRECATED) - Handled by API tokens
|
||||
* Strategies for the feature flag configured for this environment are included. (DEPRECATED) - Handled by API tokens
|
||||
* @deprecated
|
||||
*/
|
||||
environment?: string;
|
||||
|
@ -11,7 +11,7 @@ import type { ClientSegmentSchema } from './clientSegmentSchema';
|
||||
* Configuration data for server-side SDKs for evaluating feature flags.
|
||||
*/
|
||||
export interface ClientFeaturesSchema {
|
||||
/** A list of feature toggles with their configuration */
|
||||
/** A list of feature flags with their configuration */
|
||||
features: ClientFeatureSchema[];
|
||||
/** A summary of filters and parameters sent to the endpoint. Used by the server to build the features and segments response */
|
||||
query?: ClientFeaturesQuerySchema;
|
||||
|
@ -5,7 +5,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Data used to create a new feature toggle.
|
||||
* Data used to create a new feature flag.
|
||||
*/
|
||||
export interface CreateFeatureSchema {
|
||||
/**
|
||||
@ -17,6 +17,6 @@ export interface CreateFeatureSchema {
|
||||
impressionData?: boolean;
|
||||
/** Unique feature name */
|
||||
name: string;
|
||||
/** The feature toggle's [type](https://docs.getunleash.io/reference/feature-toggle-types). One of experiment, kill-switch, release, operational, or permission */
|
||||
/** The feature flag's [type](https://docs.getunleash.io/reference/feature-toggle-types). One of experiment, kill-switch, release, operational, or permission */
|
||||
type?: string;
|
||||
}
|
||||
|
@ -10,7 +10,7 @@ import type { CreateStrategyVariantSchemaWeightType } from './createStrategyVari
|
||||
* This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.
|
||||
*/
|
||||
export interface CreateStrategyVariantSchema {
|
||||
/** The variant name. Must be unique for this feature toggle */
|
||||
/** The variant name. Must be unique for this feature flag */
|
||||
name: string;
|
||||
/** Extra data configured for this variant */
|
||||
payload?: CreateStrategyVariantSchemaPayload;
|
||||
|
@ -8,8 +8,8 @@
|
||||
* The representation of a dora time to production feature metric
|
||||
*/
|
||||
export interface DoraFeaturesSchema {
|
||||
/** The name of a feature toggle */
|
||||
/** The name of a feature flag */
|
||||
name: string;
|
||||
/** The average number of days it takes a feature toggle to get into production */
|
||||
/** The average number of days it takes a feature flag to get into production */
|
||||
timeToProduction: number;
|
||||
}
|
||||
|
@ -22,17 +22,17 @@ export interface EventSchema {
|
||||
*/
|
||||
createdByUserId?: number | null;
|
||||
/**
|
||||
* Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.
|
||||
* Extra associated data related to the event, such as feature flag state, segment configuration, etc., if applicable.
|
||||
* @nullable
|
||||
*/
|
||||
data?: EventSchemaData;
|
||||
/**
|
||||
* The feature toggle environment the event relates to, if applicable.
|
||||
* The feature flag environment the event relates to, if applicable.
|
||||
* @nullable
|
||||
*/
|
||||
environment?: string | null;
|
||||
/**
|
||||
* The name of the feature toggle the event relates to, if applicable.
|
||||
* The name of the feature flag the event relates to, if applicable.
|
||||
* @nullable
|
||||
*/
|
||||
featureName?: string | null;
|
||||
|
@ -5,7 +5,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.
|
||||
* Extra associated data related to the event, such as feature flag state, segment configuration, etc., if applicable.
|
||||
* @nullable
|
||||
*/
|
||||
export type EventSchemaData = { [key: string]: any } | null;
|
||||
|
@ -13,7 +13,7 @@ import type { ExportResultSchemaSegmentsItem } from './exportResultSchemaSegment
|
||||
import type { TagTypeSchema } from './tagTypeSchema';
|
||||
|
||||
/**
|
||||
* The result of the export operation, providing you with the feature toggle definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)
|
||||
* The result of the export operation, providing you with the feature flag definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)
|
||||
*/
|
||||
export interface ExportResultSchema {
|
||||
/** A list of all the context fields that are in use by any of the strategies in the `featureStrategies` list. */
|
||||
|
@ -7,15 +7,15 @@ import type { EventSchema } from './eventSchema';
|
||||
import type { FeatureEventsSchemaVersion } from './featureEventsSchemaVersion';
|
||||
|
||||
/**
|
||||
* One or more events happening to a specific feature toggle
|
||||
* One or more events happening to a specific feature flag
|
||||
*/
|
||||
export interface FeatureEventsSchema {
|
||||
/** The list of events */
|
||||
events: EventSchema[];
|
||||
/** The name of the feature toggle these events relate to */
|
||||
/** The name of the feature flag these events relate to */
|
||||
toggleName?: string;
|
||||
/**
|
||||
* How many events are there for this feature toggle
|
||||
* How many events are there for this feature flag
|
||||
* @minimum 0
|
||||
*/
|
||||
totalEvents?: number;
|
||||
|
@ -13,4 +13,6 @@ export type FeatureLifecycleSchemaItem = {
|
||||
enteredStageAt: string;
|
||||
/** The name of the lifecycle stage that got recorded for a given feature */
|
||||
stage: FeatureLifecycleSchemaItemStage;
|
||||
/** The name of the detailed status of a given stage. E.g. completed stage can be kept or discarded. */
|
||||
status?: string;
|
||||
};
|
||||
|
@ -11,7 +11,7 @@ import type { TagSchema } from './tagSchema';
|
||||
import type { VariantSchema } from './variantSchema';
|
||||
|
||||
/**
|
||||
* A feature toggle definition
|
||||
* A feature flag definition
|
||||
*/
|
||||
export interface FeatureSchema {
|
||||
/** `true` if the feature is archived */
|
||||
@ -67,7 +67,7 @@ export interface FeatureSchema {
|
||||
* @nullable
|
||||
*/
|
||||
tags?: TagSchema[] | null;
|
||||
/** Type of the toggle e.g. experiment, kill-switch, release, operational, permission */
|
||||
/** Type of the flag e.g. experiment, kill-switch, release, operational, permission */
|
||||
type?: string;
|
||||
/**
|
||||
* The list of feature variants
|
||||
|
@ -11,7 +11,7 @@ import type { TagSchema } from './tagSchema';
|
||||
import type { VariantSchema } from './variantSchema';
|
||||
|
||||
/**
|
||||
* A feature toggle definition
|
||||
* A feature flag definition
|
||||
*/
|
||||
export interface FeatureSearchResponseSchema {
|
||||
/** `true` if the feature is archived */
|
||||
@ -68,7 +68,7 @@ export interface FeatureSearchResponseSchema {
|
||||
* @nullable
|
||||
*/
|
||||
tags?: TagSchema[] | null;
|
||||
/** Type of the toggle e.g. experiment, kill-switch, release, operational, permission */
|
||||
/** Type of the flag e.g. experiment, kill-switch, release, operational, permission */
|
||||
type: string;
|
||||
/**
|
||||
* The list of feature variants
|
||||
|
@ -13,4 +13,9 @@ export type FeatureSearchResponseSchemaLifecycle = {
|
||||
enteredStageAt: string;
|
||||
/** The name of the current lifecycle stage */
|
||||
stage: FeatureSearchResponseSchemaLifecycleStage;
|
||||
/**
|
||||
* The name of the detailed status of a given stage. E.g. completed stage can be kept or discarded.
|
||||
* @nullable
|
||||
*/
|
||||
status?: string | null;
|
||||
};
|
||||
|
@ -5,19 +5,19 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* A [feature toggle type](https://docs.getunleash.io/reference/feature-toggle-types).
|
||||
* A [feature flag type](https://docs.getunleash.io/reference/feature-toggle-types).
|
||||
*/
|
||||
export interface FeatureTypeSchema {
|
||||
/** A description of what this feature toggle type is intended to be used for. */
|
||||
/** A description of what this feature flag type is intended to be used for. */
|
||||
description: string;
|
||||
/** The identifier of this feature toggle type. */
|
||||
/** The identifier of this feature flag type. */
|
||||
id: string;
|
||||
/**
|
||||
* How many days it takes before a feature toggle of this typed is flagged as [potentially stale](https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-toggles) by Unleash. If this value is `null`, Unleash will never mark it as potentially stale.
|
||||
* How many days it takes before a feature flag of this typed is flagged as [potentially stale](https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-toggles) by Unleash. If this value is `null`, Unleash will never mark it as potentially stale.
|
||||
* @minimum 0
|
||||
* @nullable
|
||||
*/
|
||||
lifetimeDays: number | null;
|
||||
/** The display name of this feature toggle type. */
|
||||
/** The display name of this feature flag type. */
|
||||
name: string;
|
||||
}
|
||||
|
@ -7,11 +7,11 @@ import type { FeatureTypeSchema } from './featureTypeSchema';
|
||||
import type { FeatureTypesSchemaVersion } from './featureTypesSchemaVersion';
|
||||
|
||||
/**
|
||||
* A list of [feature toggle types](https://docs.getunleash.io/reference/feature-toggle-types) and the schema version used to represent those feature types.
|
||||
* A list of [feature flag types](https://docs.getunleash.io/reference/feature-toggle-types) and the schema version used to represent those feature types.
|
||||
*/
|
||||
export interface FeatureTypesSchema {
|
||||
/** The list of feature toggle types. */
|
||||
/** The list of feature flag types. */
|
||||
types: FeatureTypeSchema[];
|
||||
/** The schema version used to describe the feature toggle types listed in the `types` property. */
|
||||
/** The schema version used to describe the feature flag types listed in the `types` property. */
|
||||
version: FeatureTypesSchemaVersion;
|
||||
}
|
||||
|
@ -5,7 +5,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* The schema version used to describe the feature toggle types listed in the `types` property.
|
||||
* The schema version used to describe the feature flag types listed in the `types` property.
|
||||
*/
|
||||
export type FeatureTypesSchemaVersion =
|
||||
(typeof FeatureTypesSchemaVersion)[keyof typeof FeatureTypesSchemaVersion];
|
||||
|
@ -6,7 +6,7 @@
|
||||
import type { FeatureEnvironmentMetricsSchema } from './featureEnvironmentMetricsSchema';
|
||||
|
||||
/**
|
||||
* How many applications have seen this feature toggle, as well as how this feature was evaluated the last hour
|
||||
* How many applications have seen this feature flag, as well as how this feature was evaluated the last hour
|
||||
*/
|
||||
export interface FeatureUsageSchema {
|
||||
/** The name of the feature */
|
||||
|
@ -6,10 +6,10 @@
|
||||
import type { VariantSchema } from './variantSchema';
|
||||
|
||||
/**
|
||||
* A versioned collection of feature toggle variants.
|
||||
* A versioned collection of feature flag variants.
|
||||
*/
|
||||
export interface FeatureVariantsSchema {
|
||||
/** All variants defined for a specific feature toggle. */
|
||||
/** All variants defined for a specific feature flag. */
|
||||
variants: VariantSchema[];
|
||||
/** The version of the feature variants schema. */
|
||||
version: number;
|
||||
|
@ -18,7 +18,7 @@ export type FrontendApiFeatureSchemaVariant = {
|
||||
* @deprecated
|
||||
*/
|
||||
featureEnabled?: boolean;
|
||||
/** The variants name. Is unique for this feature toggle */
|
||||
/** The variants name. Is unique for this feature flag */
|
||||
name: string;
|
||||
/** Extra data configured for this variant */
|
||||
payload?: FrontendApiFeatureSchemaVariantPayload;
|
||||
|
14
frontend/src/openapi/models/getOutdatedProjectSdks404.ts
Normal file
14
frontend/src/openapi/models/getOutdatedProjectSdks404.ts
Normal file
@ -0,0 +1,14 @@
|
||||
/**
|
||||
* Generated by Orval
|
||||
* Do not edit manually.
|
||||
* See `gen:api` script in package.json
|
||||
*/
|
||||
|
||||
export type GetOutdatedProjectSdks404 = {
|
||||
/** The ID of the error instance */
|
||||
id?: string;
|
||||
/** A description of what went wrong. */
|
||||
message?: string;
|
||||
/** The name of the error kind */
|
||||
name?: string;
|
||||
};
|
@ -10,10 +10,10 @@ import type { HealthReportSchemaMode } from './healthReportSchemaMode';
|
||||
import type { ProjectStatsSchema } from './projectStatsSchema';
|
||||
|
||||
/**
|
||||
* A report of the current health of the requested project, with datapoints like counters of currently active, stale, and potentially stale feature toggles.
|
||||
* A report of the current health of the requested project, with datapoints like counters of currently active, stale, and potentially stale feature flags.
|
||||
*/
|
||||
export interface HealthReportSchema {
|
||||
/** The number of active feature toggles. */
|
||||
/** The number of active feature flags. */
|
||||
activeCount: number;
|
||||
/**
|
||||
* When the project was last updated.
|
||||
@ -50,9 +50,9 @@ export interface HealthReportSchema {
|
||||
mode: HealthReportSchemaMode;
|
||||
/** The project's name */
|
||||
name: string;
|
||||
/** The number of potentially stale feature toggles. */
|
||||
/** The number of potentially stale feature flags. */
|
||||
potentiallyStaleCount: number;
|
||||
/** The number of stale feature toggles. */
|
||||
/** The number of stale feature flags. */
|
||||
staleCount: number;
|
||||
/** Project statistics */
|
||||
stats?: ProjectStatsSchema;
|
||||
|
@ -5,7 +5,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* A description of an error or warning pertaining to a feature toggle import job.
|
||||
* A description of an error or warning pertaining to a feature flag import job.
|
||||
*/
|
||||
export interface ImportTogglesValidateItemSchema {
|
||||
/** The items affected by this error message */
|
||||
|
@ -664,6 +664,7 @@ export * from './getMe401';
|
||||
export * from './getOidcSettings400';
|
||||
export * from './getOidcSettings401';
|
||||
export * from './getOidcSettings403';
|
||||
export * from './getOutdatedProjectSdks404';
|
||||
export * from './getOutdatedSdks404';
|
||||
export * from './getPats401';
|
||||
export * from './getPats403';
|
||||
|
@ -8,7 +8,7 @@ import type { PlaygroundFeatureSchemaVariant } from './playgroundFeatureSchemaVa
|
||||
import type { VariantSchema } from './variantSchema';
|
||||
|
||||
/**
|
||||
* A simplified feature toggle model intended for the Unleash playground.
|
||||
* A simplified feature flag model intended for the Unleash playground.
|
||||
*/
|
||||
export interface PlaygroundFeatureSchema {
|
||||
/** Whether the feature has a parent dependency that is not satisfied */
|
||||
|
@ -22,7 +22,7 @@ export type PlaygroundFeatureSchemaVariant = {
|
||||
* @deprecated
|
||||
*/
|
||||
featureEnabled?: boolean;
|
||||
/** The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled` */
|
||||
/** The variant's name. If there is no variant or if the flag is disabled, this will be `disabled` */
|
||||
name: string;
|
||||
/** An optional payload attached to the variant. */
|
||||
payload?: PlaygroundFeatureSchemaVariantPayload;
|
||||
|
@ -10,7 +10,7 @@ import type { PlaygroundStrategySchemaResult } from './playgroundStrategySchemaR
|
||||
import type { PlaygroundSegmentSchema } from './playgroundSegmentSchema';
|
||||
|
||||
/**
|
||||
* An evaluated feature toggle strategy as used by the Playground
|
||||
* An evaluated feature flag strategy as used by the Playground
|
||||
*/
|
||||
export interface PlaygroundStrategySchema {
|
||||
/** The strategy's constraints and their evaluation results. */
|
||||
|
@ -9,8 +9,8 @@ import type { DoraFeaturesSchema } from './doraFeaturesSchema';
|
||||
* A projects dora metrics
|
||||
*/
|
||||
export interface ProjectDoraMetricsSchema {
|
||||
/** An array of objects containing feature toggle name and timeToProduction values. The measurement unit of timeToProduction is days. */
|
||||
/** An array of objects containing feature flag name and timeToProduction values. The measurement unit of timeToProduction is days. */
|
||||
features: DoraFeaturesSchema[];
|
||||
/** The average time it takes a feature toggle to be enabled in production. The measurement unit is days. */
|
||||
/** The average time it takes a feature flag to be enabled in production. The measurement unit is days. */
|
||||
projectAverage?: number;
|
||||
}
|
||||
|
@ -8,12 +8,12 @@
|
||||
* Health summary of the project
|
||||
*/
|
||||
export type ProjectInsightsSchemaHealth = {
|
||||
/** The number of active feature toggles. */
|
||||
/** The number of active feature flags. */
|
||||
activeCount: number;
|
||||
/** The number of potentially stale feature toggles. */
|
||||
/** The number of potentially stale feature flags. */
|
||||
potentiallyStaleCount: number;
|
||||
/** An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100 */
|
||||
rating: number;
|
||||
/** The number of stale feature toggles. */
|
||||
/** The number of stale feature flags. */
|
||||
staleCount: number;
|
||||
};
|
||||
|
@ -12,15 +12,15 @@ Stats are divided into current and previous **windows**.
|
||||
- The **previous window** is the 30 days **before** the current window (from 60 to 30 days ago)
|
||||
*/
|
||||
export interface ProjectStatsSchema {
|
||||
/** The number of feature toggles that were archived during the current window */
|
||||
/** The number of feature flags that were archived during the current window */
|
||||
archivedCurrentWindow: number;
|
||||
/** The number of feature toggles that were archived during the previous window */
|
||||
/** The number of feature flags that were archived during the previous window */
|
||||
archivedPastWindow: number;
|
||||
/** The average time from when a feature was created to when it was enabled in the "production" environment during the current window */
|
||||
avgTimeToProdCurrentWindow: number;
|
||||
/** The number of feature toggles created during the current window */
|
||||
/** The number of feature flags created during the current window */
|
||||
createdCurrentWindow: number;
|
||||
/** The number of feature toggles created during the previous window */
|
||||
/** The number of feature flags created during the previous window */
|
||||
createdPastWindow: number;
|
||||
/** The number of project events that occurred during the current window */
|
||||
projectActivityCurrentWindow: number;
|
||||
|
@ -12,7 +12,7 @@ import type { SearchEventsSchemaType } from './searchEventsSchemaType';
|
||||
|
||||
*/
|
||||
export interface SearchEventsSchema {
|
||||
/** Find events by feature toggle name (case-sensitive). */
|
||||
/** Find events by feature flag name (case-sensitive). */
|
||||
feature?: string;
|
||||
/**
|
||||
* The maximum amount of events to return in the search result
|
||||
|
@ -10,7 +10,7 @@ import type { StrategyVariantSchemaWeightType } from './strategyVariantSchemaWei
|
||||
* This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.
|
||||
*/
|
||||
export interface StrategyVariantSchema {
|
||||
/** The variant name. Must be unique for this feature toggle */
|
||||
/** The variant name. Must be unique for this feature flag */
|
||||
name: string;
|
||||
/** Extra data configured for this variant */
|
||||
payload?: StrategyVariantSchemaPayload;
|
||||
|
@ -5,10 +5,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Data used for updating a feature toggle
|
||||
* Data used for updating a feature flag
|
||||
*/
|
||||
export interface UpdateFeatureSchema {
|
||||
/** If `true` the feature toggle will be moved to the [archive](https://docs.getunleash.io/reference/archived-toggles) with a property `archivedAt` set to current time */
|
||||
/** If `true` the feature flag will be moved to the [archive](https://docs.getunleash.io/reference/archived-toggles) with a property `archivedAt` set to current time */
|
||||
archived?: boolean;
|
||||
/** Detailed description of the feature */
|
||||
description?: string;
|
||||
@ -16,6 +16,6 @@ export interface UpdateFeatureSchema {
|
||||
impressionData?: boolean;
|
||||
/** `true` if the feature is archived */
|
||||
stale?: boolean;
|
||||
/** Type of the toggle e.g. experiment, kill-switch, release, operational, permission */
|
||||
/** Type of the flag e.g. experiment, kill-switch, release, operational, permission */
|
||||
type?: string;
|
||||
}
|
||||
|
@ -5,11 +5,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Data used when updating the lifetime of a [feature toggle type](https://docs.getunleash.io/reference/feature-toggle-types).
|
||||
* Data used when updating the lifetime of a [feature flag type](https://docs.getunleash.io/reference/feature-toggle-types).
|
||||
*/
|
||||
export interface UpdateFeatureTypeLifetimeSchema {
|
||||
/**
|
||||
* The new lifetime (in days) that you want to assign to the feature toggle type. If the value is `null` or `0`, then the feature toggles of that type will never be marked as potentially stale. Otherwise, they will be considered potentially stale after the number of days indicated by this property.
|
||||
* The new lifetime (in days) that you want to assign to the feature flag type. If the value is `null` or `0`, then the feature flags of that type will never be marked as potentially stale. Otherwise, they will be considered potentially stale after the number of days indicated by this property.
|
||||
* @minimum 0
|
||||
* @maximum 2147483647
|
||||
* @nullable
|
||||
|
@ -5,7 +5,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Data used to validate a feature toggle's name.
|
||||
* Data used to validate a feature flag's name.
|
||||
*/
|
||||
export interface ValidateFeatureSchema {
|
||||
/** The feature name to validate. */
|
||||
|
@ -11,7 +11,7 @@ import type { VariantSchemaWeightType } from './variantSchemaWeightType';
|
||||
* A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description
|
||||
*/
|
||||
export interface VariantSchema {
|
||||
/** The variants name. Is unique for this feature toggle */
|
||||
/** The variants name. Is unique for this feature flag */
|
||||
name: string;
|
||||
/** Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence. */
|
||||
overrides?: OverrideSchema[];
|
||||
|
Loading…
Reference in New Issue
Block a user