1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-09-05 17:53:12 +02:00

chore: new orval types

This commit is contained in:
Gastón Fournier 2025-03-05 15:04:03 +01:00
parent 6bc7c9db91
commit 70e4004065
No known key found for this signature in database
GPG Key ID: AF45428626E17A8E
1159 changed files with 4575 additions and 6036 deletions

View File

@ -10,14 +10,14 @@ import type { ActionDefinitionParameterSchemaType } from './actionDefinitionPara
* Defines a parameter for an action.
*/
export interface ActionDefinitionParameterSchema {
/** The label of the parameter. */
label: string;
/** The name of the parameter. */
name: ActionDefinitionParameterSchemaName;
/** The label of the parameter. */
label: string;
/** The parameter type. */
type: ActionDefinitionParameterSchemaType;
/** Whether the parameter is optional. */
optional?: boolean;
/** Lists of options to be used for the parameter. */
options?: string[];
/** The parameter type. */
type: ActionDefinitionParameterSchemaType;
}

View File

@ -9,14 +9,14 @@ import type { ActionDefinitionParameterSchema } from './actionDefinitionParamete
* Configuration of a single action and its parameters.
*/
export interface ActionDefinitionSchema {
/** The category of the action. */
category: string;
/** A description for the action. */
description: string;
/** The label of the action. */
label: string;
/** The parameters required to perform the action. */
parameters: ActionDefinitionParameterSchema[];
/** A description for the action. */
description: string;
/** The category of the action. */
category: string;
/** The permissions required to perform the action. */
permissions: string[];
/** The parameters required to perform the action. */
parameters: ActionDefinitionParameterSchema[];
}

View File

@ -9,8 +9,8 @@ import type { ActionDefinitionSchema } from './actionDefinitionSchema';
* Configuration of different actions and their parameters.
*/
export interface ActionDefinitionsConfigSchema {
TOGGLE_FEATURE_OFF?: ActionDefinitionSchema;
TOGGLE_FEATURE_ON?: ActionDefinitionSchema;
TOGGLE_FEATURES_OFF_BY_TAG?: ActionDefinitionSchema;
TOGGLE_FEATURE_OFF?: ActionDefinitionSchema;
TOGGLE_FEATURES_ON_BY_TAG?: ActionDefinitionSchema;
TOGGLE_FEATURES_OFF_BY_TAG?: ActionDefinitionSchema;
}

View File

@ -10,29 +10,29 @@ import type { ActionEventSchemaState } from './actionEventSchemaState';
* An object describing an action event.
*/
export interface ActionEventSchema {
/** The name of the action to execute */
action: string;
/** The date and time of when the action was created. */
createdAt: string;
/** The id of user that created this action set */
createdByUserId: number;
/**
* The details of the action event, if any.
* @nullable
*/
details?: string | null;
/** A map of parameters to pass to the action */
executionParams?: ActionEventSchemaExecutionParams;
/**
* The id of the action set
* @minimum 1
*/
id: number;
/** The date and time of when the action was created. */
createdAt: string;
/** The id of user that created this action set */
createdByUserId: number;
/** The name of the action to execute */
action: string;
/**
* The order in which the action should be executed
* @minimum 1
*/
sortOrder: number;
/** A map of parameters to pass to the action */
executionParams?: ActionEventSchemaExecutionParams;
/** The state of the action. Can be one of `not started`, `started`, `success`, or `failed`. */
state: ActionEventSchemaState;
/**
* The details of the action event, if any.
* @nullable
*/
details?: string | null;
}

View File

@ -9,22 +9,22 @@ import type { ActionSchemaExecutionParams } from './actionSchemaExecutionParams'
* Represents a single action response
*/
export interface ActionSchema {
/** The name of the action to execute */
action: string;
/** The date and time of when the action was created. */
createdAt: string;
/** The id of user that created this action set */
createdByUserId: number;
/** A map of parameters to pass to the action */
executionParams?: ActionSchemaExecutionParams;
/**
* The id of the action set
* @minimum 1
*/
id: number;
/** The date and time of when the action was created. */
createdAt: string;
/** The id of user that created this action set */
createdByUserId: number;
/** The name of the action to execute */
action: string;
/**
* The order in which the action should be executed
* @minimum 1
*/
sortOrder: number;
/** A map of parameters to pass to the action */
executionParams?: ActionSchemaExecutionParams;
}

View File

@ -3,29 +3,29 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionSetEventSchemaActionSet } from './actionSetEventSchemaActionSet';
import type { SignalSchema } from './signalSchema';
import type { ActionSetEventSchemaState } from './actionSetEventSchemaState';
import type { SignalSchema } from './signalSchema';
import type { ActionSetEventSchemaActionSet } from './actionSetEventSchemaActionSet';
/**
* An object describing an action event.
*/
export interface ActionSetEventSchema {
/** The action set this action set event belongs to, where the individual actions are decorated with the respective action states. */
actionSet: ActionSetEventSchemaActionSet;
/** The ID of the action set that the action set event belongs to. */
actionSetId: number;
/** The date and time of when the action set event was created. In other words, the date and time of when the action set started executing. */
createdAt: string;
/**
* The action set event's ID. Action set event IDs are incrementing integers. In other words, a more recently created action set event will always have a higher ID than an older one.
* @minimum 1
*/
id: number;
/** The signal that triggered this action set event. */
signal: SignalSchema;
/** The ID of the action set that the action set event belongs to. */
actionSetId: number;
/** The ID of the signal that triggered this action set event. */
signalId: number;
/** The date and time of when the action set event was created. In other words, the date and time of when the action set started executing. */
createdAt: string;
/** The state of the action set event. Can be one of `started`, `success`, or `failed`. */
state: ActionSetEventSchemaState;
/** The signal that triggered this action set event. */
signal: SignalSchema;
/** The action set this action set event belongs to, where the individual actions are decorated with the respective action states. */
actionSet: ActionSetEventSchemaActionSet;
}

View File

@ -10,33 +10,33 @@ import type { ActionSetEventSchemaActionSetMatch } from './actionSetEventSchemaA
* The action set this action set event belongs to, where the individual actions are decorated with the respective action states.
*/
export type ActionSetEventSchemaActionSet = {
/** The list of actions executed in sequential order when the action set was triggered, decorated with the individual action states. */
actions: ActionEventSchema[];
/**
* The id of the service account that will execute the action
* @minimum 1
*/
actorId: number;
/** The date and time of when the action set was created. */
createdAt: string;
/** The ID of the user that created this action set. */
createdByUserId: number;
/**
* The description of the action set
* @nullable
*/
description?: string | null;
/** Whether this action set is enabled or not */
enabled?: boolean;
/**
* The ID of the action set.
* @minimum 1
*/
id: number;
/** Defines a matching rule for the signal that will trigger the action set */
match: ActionSetEventSchemaActionSetMatch;
/** The name of the action set */
name: string;
/** The project that this action set belongs to. */
project: string;
/** The date and time of when the action set was created. */
createdAt: string;
/** The ID of the user that created this action set. */
createdByUserId: number;
/** The name of the action set */
name: string;
/**
* The description of the action set
* @nullable
*/
description?: string | null;
/**
* The id of the service account that will execute the action
* @minimum 1
*/
actorId: number;
/** Whether this action set is enabled or not */
enabled?: boolean;
/** The list of actions executed in sequential order when the action set was triggered, decorated with the individual action states. */
actions: ActionEventSchema[];
/** Defines a matching rule for the signal that will trigger the action set */
match: ActionSetEventSchemaActionSetMatch;
};

View File

@ -3,17 +3,17 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionSetEventSchemaActionSetMatchPayload } from './actionSetEventSchemaActionSetMatchPayload';
import type { ActionSetEventSchemaActionSetMatchSource } from './actionSetEventSchemaActionSetMatchSource';
import type { ActionSetEventSchemaActionSetMatchPayload } from './actionSetEventSchemaActionSetMatchPayload';
/**
* Defines a matching rule for the signal that will trigger the action set
*/
export type ActionSetEventSchemaActionSetMatch = {
/** Match the payload of the signal */
payload: ActionSetEventSchemaActionSetMatchPayload;
/** Match the source of the signal */
source: ActionSetEventSchemaActionSetMatchSource;
/** Match the source id of the signal */
sourceId: number;
/** Match the payload of the signal */
payload: ActionSetEventSchemaActionSetMatchPayload;
};

View File

@ -10,33 +10,33 @@ import type { ActionsSchemaMatch } from './actionsSchemaMatch';
* A response model with an identifiable action set.
*/
export interface ActionsSchema {
/** The list of actions to execute in sequential order when the action set is triggered. */
actions: ActionSchema[];
/**
* The id of the service account that will execute the action
* @minimum 1
*/
actorId: number;
/** The date and time of when the action set was created. */
createdAt: string;
/** The ID of the user that created this action set. */
createdByUserId: number;
/**
* The description of the action set
* @nullable
*/
description?: string | null;
/** Whether this action set is enabled or not */
enabled?: boolean;
/**
* The ID of the action set.
* @minimum 1
*/
id: number;
/** Defines a matching rule for the signal that will trigger the action set */
match: ActionsSchemaMatch;
/** The name of the action set */
name: string;
/** The project that this action set belongs to. */
project: string;
/** The date and time of when the action set was created. */
createdAt: string;
/** The ID of the user that created this action set. */
createdByUserId: number;
/** The name of the action set */
name: string;
/**
* The description of the action set
* @nullable
*/
description?: string | null;
/**
* The id of the service account that will execute the action
* @minimum 1
*/
actorId: number;
/** Whether this action set is enabled or not */
enabled?: boolean;
/** The list of actions to execute in sequential order when the action set is triggered. */
actions: ActionSchema[];
/** Defines a matching rule for the signal that will trigger the action set */
match: ActionsSchemaMatch;
}

View File

@ -3,17 +3,17 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionsSchemaMatchPayload } from './actionsSchemaMatchPayload';
import type { ActionsSchemaMatchSource } from './actionsSchemaMatchSource';
import type { ActionsSchemaMatchPayload } from './actionsSchemaMatchPayload';
/**
* Defines a matching rule for the signal that will trigger the action set
*/
export type ActionsSchemaMatch = {
/** Match the payload of the signal */
payload: ActionsSchemaMatchPayload;
/** Match the source of the signal */
source: ActionsSchemaMatchSource;
/** Match the source id of the signal */
sourceId: number;
/** Match the payload of the signal */
payload: ActionsSchemaMatchPayload;
};

View File

@ -7,8 +7,8 @@
export type AddAccessToProject400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddAccessToProject401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddAccessToProject403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddAccessToProject404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddAccessToProject415 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddDefaultStrategyToProjectEnvironment400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddEnvironmentToProject401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddEnvironmentToProject403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddEnvironmentToProject409 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFavoriteFeature401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFavoriteFeature404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFavoriteProject401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFavoriteProject404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFeatureDependency401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFeatureDependency403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFeatureDependency404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFeatureStrategy401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFeatureStrategy403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddFeatureStrategy404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -1,14 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type AddMilestoneToReleasePlanTemplate401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -1,14 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type AddMilestoneToReleasePlanTemplate403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -1,14 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type AddMilestoneToReleasePlanTemplate404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -7,8 +7,8 @@
export type AddPublicSignupTokenUser400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddPublicSignupTokenUser409 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleAccessToProject400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleAccessToProject401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleAccessToProject403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleAccessToProject404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleAccessToProject415 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleToUser401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleToUser403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddRoleToUser404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -1,14 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type AddStrategyToMilestone401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTag400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTag401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTag403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTag404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTagToFeatures401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTagToFeatures403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTagToFeatures404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type AddTagToFeatures415 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -9,18 +9,6 @@ import type { AddonCreateUpdateSchemaParameters } from './addonCreateUpdateSchem
* Data required to create or update an [Unleash addon](https://docs.getunleash.io/reference/addons) instance.
*/
export interface AddonCreateUpdateSchema {
/** A description of the addon. */
description?: string;
/** Whether the addon should be enabled or not. */
enabled: boolean;
/** The list of environments that this addon will listen to events from. An empty list means it will listen to events from **all** environments. */
environments?: string[];
/** The event types that will trigger this specific addon. */
events: string[];
/** Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. Consult the documentation for details. */
parameters: AddonCreateUpdateSchemaParameters;
/** The projects that this addon will listen to events from. An empty list means it will listen to events from **all** projects. */
projects?: string[];
/** The addon provider, such as "webhook" or "slack". This string is **case sensitive** and maps to the provider's `name` property.
The list of all supported providers and their parameters for a specific Unleash instance can be found by making a GET request to the `api/admin/addons` endpoint: the `providers` property of that response will contain all available providers.
@ -34,4 +22,16 @@ The default set of providers can be found in the [addons reference documentation
The provider you choose for your addon dictates what properties the `parameters` object needs. Refer to the documentation for each provider for more information.
*/
provider: string;
/** A description of the addon. */
description?: string;
/** Whether the addon should be enabled or not. */
enabled: boolean;
/** Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. Consult the documentation for details. */
parameters: AddonCreateUpdateSchemaParameters;
/** The event types that will trigger this specific addon. */
events: string[];
/** The projects that this addon will listen to events from. An empty list means it will listen to events from **all** projects. */
projects?: string[];
/** The list of environments that this addon will listen to events from. An empty list means it will listen to events from **all** environments. */
environments?: string[];
}

View File

@ -8,18 +8,18 @@
* An addon parameter definition.
*/
export interface AddonParameterSchema {
/** A description of the parameter. This should explain to the end user what the parameter is used for. */
description?: string;
/** The name of the parameter as it is shown to the end user in the Admin UI. */
displayName: string;
/** The name of the parameter as it is used in code. References to this parameter should use this value. */
name: string;
/** The name of the parameter as it is shown to the end user in the Admin UI. */
displayName: string;
/** The type of the parameter. Corresponds roughly to [HTML `input` field types](https://developer.mozilla.org/docs/Web/HTML/Element/Input#input_types). Multi-line inut fields are indicated as `textfield` (equivalent to the HTML `textarea` tag). */
type: string;
/** A description of the parameter. This should explain to the end user what the parameter is used for. */
description?: string;
/** The default value for this parameter. This value is used if no other value is provided. */
placeholder?: string;
/** Whether this parameter is required or not. If a parameter is required, you must give it a value when you create the addon. If it is not required it can be left out. It may receive a default value in those cases. */
required: boolean;
/** Indicates whether this parameter is **sensitive** or not. Unleash will not return sensitive parameters to API requests. It will instead use a number of asterisks to indicate that a value is set, e.g. "******". The number of asterisks does not correlate to the parameter's value. */
sensitive: boolean;
/** The type of the parameter. Corresponds roughly to [HTML `input` field types](https://developer.mozilla.org/docs/Web/HTML/Element/Input#input_types). Multi-line inut fields are indicated as `textfield` (equivalent to the HTML `textarea` tag). */
type: string;
}

View File

@ -9,6 +9,13 @@ import type { AddonSchemaParameters } from './addonSchemaParameters';
* An [addon](https://docs.getunleash.io/reference/addons) instance description. Contains data about what kind of provider it uses, whether it's enabled or not, what events it listens for, and more.
*/
export interface AddonSchema {
/**
* The addon's unique identifier.
* @minimum 1
*/
id: number;
/** The addon provider, such as "webhook" or "slack". */
provider: string;
/**
* A description of the addon. `null` if no description exists.
* @nullable
@ -16,19 +23,12 @@ export interface AddonSchema {
description: string | null;
/** Whether the addon is enabled or not. */
enabled: boolean;
/** The list of environments that this addon listens to events from. An empty list means it listens to events from **all** environments. */
environments?: string[];
/** The event types that trigger this specific addon. */
events: string[];
/**
* The addon's unique identifier.
* @minimum 1
*/
id: number;
/** Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. */
parameters: AddonSchemaParameters;
/** The event types that trigger this specific addon. */
events: string[];
/** The projects that this addon listens to events from. An empty list means it listens to events from **all** projects. */
projects?: string[];
/** The addon provider, such as "webhook" or "slack". */
provider: string;
/** The list of environments that this addon listens to events from. An empty list means it listens to events from **all** environments. */
environments?: string[];
}

View File

@ -3,35 +3,35 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AddonTypeSchemaAlertsItem } from './addonTypeSchemaAlertsItem';
import type { AddonTypeSchemaInstallation } from './addonTypeSchemaInstallation';
import type { AddonParameterSchema } from './addonParameterSchema';
import type { TagTypeSchema } from './tagTypeSchema';
import type { AddonParameterSchema } from './addonParameterSchema';
import type { AddonTypeSchemaInstallation } from './addonTypeSchemaInstallation';
import type { AddonTypeSchemaAlertsItem } from './addonTypeSchemaAlertsItem';
/**
* An addon provider. Defines a specific addon type and what the end user must configure when creating a new addon of that type.
*/
export interface AddonTypeSchema {
/** A list of alerts to display to the user when installing addons of this type. */
alerts?: AddonTypeSchemaAlertsItem[];
/** This should be used to inform the user that this addon type is deprecated and should not be used. Deprecated addons will show a badge with this information on the UI. */
deprecated?: string;
/** A description of the addon type. */
description: string;
/** The name of the addon type. When creating new addons, this goes in the payload's `type` field. */
name: string;
/** The addon type's name as it should be displayed in the admin UI. */
displayName: string;
/** A URL to where you can find more information about using this addon type. */
documentationUrl: string;
/** All the [event types](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#feature-toggle-events) that are available for this addon provider. */
events?: string[];
/** A description of the addon type. */
description: string;
/** A long description of how to use this addon type. This will be displayed on the top of configuration page. Can contain markdown. */
howTo?: string;
/** The installation configuration for this addon type. */
installation?: AddonTypeSchemaInstallation;
/** The name of the addon type. When creating new addons, this goes in the payload's `type` field. */
name: string;
/** A list of [Unleash tag types](https://docs.getunleash.io/reference/feature-toggles#tags) that this addon uses. These tags will be added to the Unleash instance when an addon of this type is created. */
tagTypes?: TagTypeSchema[];
/** The addon provider's parameters. Use these to configure an addon of this provider type. Items with `required: true` must be provided. */
parameters?: AddonParameterSchema[];
/** A list of [Unleash tag types](https://docs.getunleash.io/reference/tags#tag-types) that this addon uses. These tags will be added to the Unleash instance when an addon of this type is created. */
tagTypes?: TagTypeSchema[];
/** All the [event types](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#feature-toggle-events) that are available for this addon provider. */
events?: string[];
/** The installation configuration for this addon type. */
installation?: AddonTypeSchemaInstallation;
/** A list of alerts to display to the user when installing addons of this type. */
alerts?: AddonTypeSchemaAlertsItem[];
/** This should be used to inform the user that this addon type is deprecated and should not be used. Deprecated addons will show a badge with this information on the UI. */
deprecated?: string;
}

View File

@ -6,8 +6,8 @@
import type { AddonTypeSchemaAlertsItemType } from './addonTypeSchemaAlertsItemType';
export type AddonTypeSchemaAlertsItem = {
/** The text of the alert. This is what will be displayed to the user. */
text: string;
/** The type of alert. This determines the color of the alert. */
type: AddonTypeSchemaAlertsItemType;
/** The text of the alert. This is what will be displayed to the user. */
text: string;
};

View File

@ -8,10 +8,10 @@
* The installation configuration for this addon type.
*/
export type AddonTypeSchemaInstallation = {
/** The help text of the installation configuration. This will be displayed to the user when installing addons of this type. */
helpText?: string;
/** The title of the installation configuration. This will be displayed to the user when installing addons of this type. */
title?: string;
/** A URL to where the addon configuration should redirect to install addons of this type. */
url: string;
/** The title of the installation configuration. This will be displayed to the user when installing addons of this type. */
title?: string;
/** The help text of the installation configuration. This will be displayed to the user when installing addons of this type. */
helpText?: string;
};

View File

@ -8,10 +8,10 @@
* Contains total admin counts for an Unleash instance.
*/
export interface AdminCountSchema {
/** Total number of admins that do not have a password set. May be SSO, but may also be users that did not set a password yet. */
noPassword: number;
/** Total number of admins that have a password set. */
password: number;
/** Total number of admins that do not have a password set. May be SSO, but may also be users that did not set a password yet. */
noPassword: number;
/** Total number of service accounts that have the admin root role. */
service: number;
}

View File

@ -8,8 +8,8 @@
* Query parameters used to modify the list of features returned.
*/
export interface AdminFeaturesQuerySchema {
/** 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[];
/** A case-insensitive prefix filter for the names of feature flags */
namePrefix?: string;
}

View File

@ -8,14 +8,14 @@
* Describes a single permission
*/
export interface AdminPermissionSchema {
/** The name to display in listings of permissions */
displayName: string;
/** Which environment this permission applies to */
environment?: string;
/** The identifier for this permission */
id: number;
/** The name of this permission */
name: string;
/** The name to display in listings of permissions */
displayName: string;
/** What level this permission applies to. Either root, project or the name of the environment it applies to */
type: string;
/** Which environment this permission applies to */
environment?: string;
}

View File

@ -3,17 +3,17 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AdminPermissionsSchemaPermissionsEnvironmentsItem } from './adminPermissionsSchemaPermissionsEnvironmentsItem';
import type { AdminPermissionSchema } from './adminPermissionSchema';
import type { AdminPermissionsSchemaPermissionsEnvironmentsItem } from './adminPermissionsSchemaPermissionsEnvironmentsItem';
/**
* Returns permissions available at all three levels (root|project|environment)
*/
export type AdminPermissionsSchemaPermissions = {
/** A list of environments with available permissions per environment */
environments: AdminPermissionsSchemaPermissionsEnvironmentsItem[];
/** Permissions available at the project level */
project: AdminPermissionSchema[];
/** Permissions available at the root level, i.e. not connected to any specific project or environment */
root?: AdminPermissionSchema[];
/** Permissions available at the project level */
project: AdminPermissionSchema[];
/** A list of environments with available permissions per environment */
environments: AdminPermissionsSchemaPermissionsEnvironmentsItem[];
};

View File

@ -9,20 +9,6 @@ import type { ConstraintSchema } from './constraintSchema';
* A description of a [segment](https://docs.getunleash.io/reference/segments)
*/
export interface AdminSegmentSchema {
/** The list of constraints that are used in this segment */
constraints: ConstraintSchema[];
/** When the segment was created */
createdAt: string;
/**
* The creator's email or username
* @nullable
*/
createdBy?: string | null;
/**
* The description for this segment
* @nullable
*/
description?: string | null;
/**
* The ID of this segment
* @minimum 0
@ -31,10 +17,12 @@ export interface AdminSegmentSchema {
/** The name of this segment */
name: string;
/**
* The project the segment belongs to. Only present if the segment is a project-specific segment.
* The description for this segment
* @nullable
*/
project?: string | null;
description?: string | null;
/** The list of constraints that are used in this segment */
constraints: ConstraintSchema[];
/**
* The number of feature flags that use this segment. The number also includes the any flags with pending change requests that would add this segment.
* @minimum 0
@ -47,4 +35,16 @@ export interface AdminSegmentSchema {
* @nullable
*/
usedInProjects?: number | null;
/**
* The project the segment belongs to. Only present if the segment is a project-specific segment.
* @nullable
*/
project?: string | null;
/**
* The creator's email or username
* @nullable
*/
createdBy?: string | null;
/** When the segment was created */
createdAt: string;
}

View File

@ -12,22 +12,22 @@ import type { VariantSchema } from './variantSchema';
* A simplified feature flag model intended for the Unleash playground.
*/
export interface AdvancedPlaygroundEnvironmentFeatureSchema {
/** The context to use when evaluating flags */
context: SdkFlatContextSchema;
/** The feature's environment. */
environment: string;
/** Whether this feature is enabled or not in the current environment.
If a feature can't be fully evaluated (that is, `strategies.result` is `unknown`),
this will be `false` to align with how client SDKs treat unresolved feature states. */
isEnabled: boolean;
/** Whether the feature is active and would be evaluated in the provided environment in a normal SDK context. */
isEnabledInCurrentEnvironment: boolean;
/** The feature's name. */
name: string;
/** The feature's environment. */
environment: string;
/** The context to use when evaluating flags */
context: SdkFlatContextSchema;
/** The ID of the project that contains this feature. */
projectId: string;
/** Feature's applicable strategies and cumulative results of the strategies */
strategies: AdvancedPlaygroundEnvironmentFeatureSchemaStrategies;
/** Whether the feature is active and would be evaluated in the provided environment in a normal SDK context. */
isEnabledInCurrentEnvironment: boolean;
/** Whether this feature is enabled or not in the current environment.
If a feature can't be fully evaluated (that is, `strategies.result` is `unknown`),
this will be `false` to align with how client SDKs treat unresolved feature states. */
isEnabled: boolean;
/**
* The feature variant you receive based on the provided context or the _disabled
variant_. If a feature is disabled or doesn't have any

View File

@ -3,19 +3,19 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { PlaygroundStrategySchema } from './playgroundStrategySchema';
import type { AdvancedPlaygroundEnvironmentFeatureSchemaStrategiesResult } from './advancedPlaygroundEnvironmentFeatureSchemaStrategiesResult';
import type { PlaygroundStrategySchema } from './playgroundStrategySchema';
/**
* Feature's applicable strategies and cumulative results of the strategies
*/
export type AdvancedPlaygroundEnvironmentFeatureSchemaStrategies = {
/** The strategies that apply to this feature. */
data: PlaygroundStrategySchema[];
/** The cumulative results of all the feature's strategies. Can be `true`,
`false`, or `unknown`.
This property will only be `unknown`
if one or more of the strategies can't be fully evaluated and the rest of the strategies
all resolve to `false`. */
result: AdvancedPlaygroundEnvironmentFeatureSchemaStrategiesResult;
/** The strategies that apply to this feature. */
data: PlaygroundStrategySchema[];
};

View File

@ -13,12 +13,12 @@ import type { AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload } from '.
* @nullable
*/
export type AdvancedPlaygroundEnvironmentFeatureSchemaVariant = {
/** Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be `false` */
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 flag is disabled, this will be `disabled` */
name: string;
/** Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be `false` */
enabled: boolean;
/** An optional payload attached to the variant. */
payload?: AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload;
/** Whether the feature is enabled or not. If the feature is disabled, this property will be `false` */
feature_enabled?: boolean;
} | null;

View File

@ -9,10 +9,10 @@ import type { AdvancedPlaygroundFeatureSchemaEnvironments } from './advancedPlay
* A simplified feature flag model intended for the Unleash playground.
*/
export interface AdvancedPlaygroundFeatureSchema {
/** The lists of features that have been evaluated grouped by environment. */
environments: AdvancedPlaygroundFeatureSchemaEnvironments;
/** The feature's name. */
name: string;
/** The ID of the project that contains this feature. */
projectId: string;
/** The lists of features that have been evaluated grouped by environment. */
environments: AdvancedPlaygroundFeatureSchemaEnvironments;
}

View File

@ -3,14 +3,13 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { SdkContextSchema } from './sdkContextSchema';
import type { AdvancedPlaygroundRequestSchemaProjects } from './advancedPlaygroundRequestSchemaProjects';
import type { SdkContextSchema } from './sdkContextSchema';
/**
* Data for the playground API to evaluate toggles in advanced mode with environment and context multi selection
*/
export interface AdvancedPlaygroundRequestSchema {
context: SdkContextSchema;
/**
* The environments to evaluate toggles in.
* @minItems 1
@ -18,4 +17,5 @@ export interface AdvancedPlaygroundRequestSchema {
environments: string[];
/** A list of projects to check for toggles in. */
projects?: AdvancedPlaygroundRequestSchemaProjects;
context: SdkContextSchema;
}

View File

@ -3,18 +3,18 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AdvancedPlaygroundFeatureSchema } from './advancedPlaygroundFeatureSchema';
import type { AdvancedPlaygroundRequestSchema } from './advancedPlaygroundRequestSchema';
import type { AdvancedPlaygroundFeatureSchema } from './advancedPlaygroundFeatureSchema';
import type { AdvancedPlaygroundResponseSchemaWarnings } from './advancedPlaygroundResponseSchemaWarnings';
/**
* The state of all features given the provided input.
*/
export interface AdvancedPlaygroundResponseSchema {
/** The list of features that have been evaluated. */
features: AdvancedPlaygroundFeatureSchema[];
/** The given input used to evaluate the features. */
input: AdvancedPlaygroundRequestSchema;
/** The list of features that have been evaluated. */
features: AdvancedPlaygroundFeatureSchema[];
/** Warnings that occurred during evaluation. */
warnings?: AdvancedPlaygroundResponseSchemaWarnings;
}

View File

@ -1,16 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AiChatMessageSchemaRole } from './aiChatMessageSchemaRole';
/**
* Describes an Unleash AI chat message.
*/
export interface AiChatMessageSchema {
/** The message content. */
content: string;
/** The role of the message sender. */
role: AiChatMessageSchemaRole;
}

View File

@ -1,18 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The role of the message sender.
*/
export type AiChatMessageSchemaRole =
(typeof AiChatMessageSchemaRole)[keyof typeof AiChatMessageSchemaRole];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AiChatMessageSchemaRole = {
system: 'system',
user: 'user',
assistant: 'assistant',
} as const;

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Describes a new Unleash AI chat message sent by the user.
*/
export interface AiChatNewMessageSchema {
/** The message content. */
message: string;
}

View File

@ -1,23 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AiChatMessageSchema } from './aiChatMessageSchema';
/**
* Describes an Unleash AI chat.
*/
export interface AiChatSchema {
/** The date and time of when the chat was created. */
createdAt: string;
/**
* The chat's ID. Chat IDs are incrementing integers. In other words, a more recently created chat will always have a higher ID than an older one. This ID is represented as a string since it is a BigInt.
* @pattern ^[0-9]+$
*/
id: string;
/** The messages exchanged between the user and the Unleash AI. */
messages: AiChatMessageSchema[];
/** The ID of the user that the chat belongs to. */
userId: number;
}

View File

@ -9,38 +9,38 @@ import type { ApiTokenSchemaType } from './apiTokenSchemaType';
* An overview of an [Unleash API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys).
*/
export interface ApiTokenSchema {
/**
* Alias is no longer in active use and will often be NULL. It's kept around as a way of allowing old proxy tokens created with the old metadata format to keep working.
* @nullable
*/
alias?: string | null;
/** When the token was created. */
createdAt: string;
/** The environment the token has access to. `*` if it has access to all environments. */
environment?: string;
/**
* The token's expiration date. NULL if the token doesn't have an expiration set.
* @nullable
*/
expiresAt?: string | null;
/** The project this token belongs to. */
project: string;
/** The list of projects this token has access to. If the token has access to specific projects they will be listed here. If the token has access to all projects it will be represented as `[*]` */
projects: string[];
/** The token used for authentication. */
secret: string;
/**
* When the token was last seen/used to authenticate with. NULL if the token has not yet been used for authentication.
* @nullable
*/
seenAt?: string | null;
/** A unique name for this particular token */
tokenName: string;
/** The type of API token */
type: ApiTokenSchemaType;
/**
* This property was deprecated in Unleash v5. Prefer the `tokenName` property instead.
* @deprecated
*/
username?: string;
/** A unique name for this particular token */
tokenName: string;
/** The type of API token */
type: ApiTokenSchemaType;
/** The environment the token has access to. `*` if it has access to all environments. */
environment?: string;
/** The project this token belongs to. */
project: string;
/** The list of projects this token has access to. If the token has access to specific projects they will be listed here. If the token has access to all projects it will be represented as `[*]` */
projects: string[];
/**
* The token's expiration date. NULL if the token doesn't have an expiration set.
* @nullable
*/
expiresAt?: string | null;
/** When the token was created. */
createdAt: string;
/**
* When the token was last seen/used to authenticate with. NULL if the token has not yet been used for authentication.
* @nullable
*/
seenAt?: string | null;
/**
* Alias is no longer in active use and will often be NULL. It's kept around as a way of allowing old proxy tokens created with the old metadata format to keep working.
* @nullable
*/
alias?: string | null;
}

View File

@ -5,12 +5,15 @@
*/
export type ApplicationEnvironmentInstancesSchemaInstancesItem = {
/** An IP address identifying the instance of the application running the SDK */
clientIp?: string;
/** A unique identifier identifying the instance of the application running the SDK. Often changes based on execution environment. For instance: two pods in Kubernetes will have two different instanceIds */
instanceId: string;
/**
* An SDK version identifier. Usually formatted as "unleash-client-<language>:<version>"
* @nullable
*/
sdkVersion?: string | null;
/** An IP address identifying the instance of the application running the SDK */
clientIp?: string;
/** The last time the application environment instance was seen */
lastSeen?: string;
/** An SDK version identifier. Usually formatted as "unleash-client-<language>:<version>" */
sdkVersion?: string;
};

View File

@ -9,17 +9,17 @@ import type { ApplicationEnvironmentIssuesSchema } from './applicationEnvironmen
* Data about an application environment
*/
export interface ApplicationOverviewEnvironmentSchema {
/** Name of the application environment */
name: string;
/** The number of instances of the application environment */
instanceCount: number;
/** This list of issues that might be wrong with the application */
issues: ApplicationEnvironmentIssuesSchema;
/** SDKs used in the application environment */
sdks: string[];
/**
* The last time the application environment was seen
* @nullable
*/
lastSeen: string | null;
/** Name of the application environment */
name: string;
/** SDKs used in the application environment */
sdks: string[];
/** This list of issues that might be wrong with the application */
issues: ApplicationEnvironmentIssuesSchema;
}

View File

@ -10,12 +10,12 @@ import type { ApplicationOverviewIssuesSchema } from './applicationOverviewIssue
* Data about an application that's connected to Unleash via an SDK.
*/
export interface ApplicationOverviewSchema {
/** The list of environments the application has been using. */
environments: ApplicationOverviewEnvironmentSchema[];
/** The number of features the application has been using. */
featureCount: number;
/** This list of issues that might be wrong with the application */
issues: ApplicationOverviewIssuesSchema;
/** The list of projects the application has been using. */
projects: string[];
/** The number of features the application has been using. */
featureCount: number;
/** The list of environments the application has been using. */
environments: ApplicationOverviewEnvironmentSchema[];
/** This list of issues that might be wrong with the application */
issues: ApplicationOverviewIssuesSchema;
}

View File

@ -11,18 +11,18 @@ import type { ApplicationUsageSchema } from './applicationUsageSchema';
export interface ApplicationSchema {
/** Name of the application */
appName: string;
/** The CSS color that is used to color the application's entry in the application list */
color?: string;
/** Extra information added about the application reporting the metrics. Only present if added via the Unleash Admin interface */
description?: string;
/** An URL to an icon file to be used for the applications's entry in the application list */
icon?: string;
/** Which SDK and version the application reporting uses. Typically represented as `<identifier>:<version>` */
sdkVersion?: string;
/** Which [strategies](https://docs.getunleash.io/topics/the-anatomy-of-unleash#activation-strategies) the application has loaded. Useful when trying to figure out if your [custom strategy](https://docs.getunleash.io/reference/custom-activation-strategies) has been loaded in the SDK */
strategies?: string[];
/** Extra information added about the application reporting the metrics. Only present if added via the Unleash Admin interface */
description?: string;
/** A link to reference the application reporting the metrics. Could for instance be a GitHub link to the repository of the application */
url?: string;
/** The CSS color that is used to color the application's entry in the application list */
color?: string;
/** An URL to an icon file to be used for the applications's entry in the application list */
icon?: string;
/** The list of projects the application has been using. */
usage?: ApplicationUsageSchema[];
}

View File

@ -8,8 +8,8 @@
* Data about an project that have been used by applications.
*/
export interface ApplicationUsageSchema {
/** Which environments have been accessed in this project. */
environments: string[];
/** Name of the project */
project: string;
/** Which environments have been accessed in this project. */
environments: string[];
}

View File

@ -9,8 +9,8 @@ import type { ApplicationSchema } from './applicationSchema';
* An object containing a list of applications that have connected to Unleash via an SDK.
*/
export interface ApplicationsSchema {
/** The list of applications that have connected to this Unleash instance. */
applications: ApplicationSchema[];
/** The total number of project applications. */
total: number;
/** The list of applications that have connected to this Unleash instance. */
applications: ApplicationSchema[];
}

View File

@ -7,8 +7,8 @@
export type ArchiveFeature401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveFeature403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveFeature404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveFeatures400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveFeatures401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveFeatures403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveFeatures415 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveProject400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveProject401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type ArchiveProject403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -9,34 +9,34 @@ import type { ArchivedFeatureSchemaEnvironmentsItem } from './archivedFeatureSch
* An archived project feature flag definition
*/
export interface ArchivedFeatureSchema {
/** The date the feature was archived */
archivedAt?: string;
/** The date the feature was created */
createdAt?: string;
/** Unique feature name */
name: string;
/** Type of the flag e.g. experiment, kill-switch, release, operational, permission */
type?: string;
/**
* Detailed description of the feature
* @nullable
*/
description?: string | null;
/**
* The list of environments where the feature can be used
* @deprecated
*/
environments?: ArchivedFeatureSchemaEnvironmentsItem[];
/** 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;
/** `true` if the impression data collection is enabled for the feature, otherwise `false`. */
impressionData?: boolean;
/** The date the feature was created */
createdAt?: string;
/** The date the feature was archived */
archivedAt?: string;
/**
* The date when metrics where last collected for the feature. This field was deprecated in v5, use the one in featureEnvironmentSchema
* @deprecated
* @nullable
*/
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;
/** Type of the flag e.g. experiment, kill-switch, release, operational, permission */
type?: string;
/**
* The list of environments where the feature can be used
* @deprecated
*/
environments?: ArchivedFeatureSchemaEnvironmentsItem[];
}

View File

@ -5,13 +5,13 @@
*/
export type ArchivedFeatureSchemaEnvironmentsItem = {
/** `true` if the feature is enabled for the environment, otherwise `false`. */
enabled?: boolean;
/** The name of the environment */
name?: string;
/**
* The date when metrics where last collected for the feature environment
* @nullable
*/
lastSeenAt?: string | null;
/** The name of the environment */
name?: string;
/** `true` if the feature is enabled for the environment, otherwise `false`. */
enabled?: boolean;
};

View File

@ -9,8 +9,8 @@ import type { ArchivedFeatureSchema } from './archivedFeatureSchema';
* A list of archived features
*/
export interface ArchivedFeaturesSchema {
/** A list of features */
features: ArchivedFeatureSchema[];
/** The version of the feature's schema */
version: number;
/** A list of features */
features: ArchivedFeatureSchema[];
}

View File

@ -8,30 +8,24 @@
* An object describing a banner to be displayed to all users.
*/
export interface BannerSchema {
/** The date and time of when the banner was created. */
createdAt: string;
/**
* The markdown to display on the dialog. If not specified, no dialog will be displayed.
* @nullable
*/
dialog?: string | null;
/**
* The title to display on the dialog. If not specified, this will be the same as `linkText`.
* @nullable
*/
dialogTitle?: string | null;
/** Whether the banner should be displayed currently. If not specified, defaults to true. */
enabled?: boolean;
/**
* The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If "none", no icon will be displayed.
* @nullable
*/
icon?: string | null;
/**
* The banner's ID. Banner IDs are incrementing integers. In other words, a more recently created banner will always have a higher ID than an older one.
* @minimum 1
*/
id: number;
/** The message to display to all users. Supports markdown. */
message: string;
/** Whether the banner should be displayed currently. If not specified, defaults to true. */
enabled?: boolean;
/** The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info". */
variant?: string;
/** Whether the banner should be sticky on the screen. If not specified, defaults to `false`. */
sticky?: boolean;
/**
* The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If "none", no icon will be displayed.
* @nullable
*/
icon?: string | null;
/**
* The link to display on the banner. Can either be an absolute or a relative link (e.g. absolute: "https://example.com" or relative: "/admin/service-accounts"). If "dialog", will display a dialog when clicked. If not specified, no link will be displayed.
* @nullable
@ -42,10 +36,16 @@ export interface BannerSchema {
* @nullable
*/
linkText?: string | null;
/** The message to display to all users. Supports markdown. */
message: string;
/** Whether the banner should be sticky on the screen. If not specified, defaults to `false`. */
sticky?: boolean;
/** The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info". */
variant?: string;
/**
* The title to display on the dialog. If not specified, this will be the same as `linkText`.
* @nullable
*/
dialogTitle?: string | null;
/**
* The markdown to display on the dialog. If not specified, no dialog will be displayed.
* @nullable
*/
dialog?: string | null;
/** The date and time of when the banner was created. */
createdAt: string;
}

View File

@ -10,21 +10,21 @@ import type { DateSchema } from './dateSchema';
* An application registration. Defines the format POSTed by our server-side SDKs when they're starting up
*/
export interface BulkRegistrationSchema {
/** The name of the application that is evaluating toggles */
appName: string;
/** A list of applications this app registration has been registered through. If connected directly to Unleash, this is an empty list.
This can be used in later visualizations to tell how many levels of proxy or Edge instances our SDKs have connected through */
connectVia?: BulkRegistrationSchemaConnectViaItem[];
/** The name of the application that is evaluating toggles */
appName: string;
/** Which environment the application is running in */
environment: string;
/** A [(somewhat) unique identifier](https://docs.getunleash.io/reference/sdks/node#advanced-usage) for the application */
instanceId: string;
/** How often (in seconds) the application refreshes its features */
interval?: number;
/** The version the sdk is running. Typically <client>:<version> */
sdkVersion?: string;
/** The application started at */
started?: DateSchema;
/** Enabled [strategies](https://docs.getunleash.io/reference/activation-strategies) in the application */
strategies?: string[];
/** The version the sdk is running. Typically <client>:<version> */
sdkVersion?: string;
}

View File

@ -7,8 +7,8 @@
export type BulkToggleFeaturesEnvironmentOff400 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type BulkToggleFeaturesEnvironmentOff401 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type BulkToggleFeaturesEnvironmentOff403 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type BulkToggleFeaturesEnvironmentOff404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type BulkToggleFeaturesEnvironmentOff413 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

View File

@ -7,8 +7,8 @@
export type BulkToggleFeaturesEnvironmentOff415 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
};

Some files were not shown because too many files have changed in this diff Show More