1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-07-26 13:48:33 +02:00

chore: generate new models from openapi (#5528)

This commit is contained in:
Jaanus Sellin 2023-12-04 21:49:49 +02:00 committed by GitHub
parent 0481661a6f
commit 6b2b7a3388
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
888 changed files with 2666 additions and 2532 deletions

View File

@ -7,8 +7,8 @@
export type AddAccessToProject400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddAccessToProject401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddAccessToProject403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddAccessToProject404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddAccessToProject415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddDefaultStrategyToProjectEnvironment400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddEnvironmentToProject401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddEnvironmentToProject403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddEnvironmentToProject409 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFavoriteFeature401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFavoriteFeature404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFavoriteProject401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFavoriteProject404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFeatureDependency401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFeatureDependency403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFeatureDependency404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFeatureStrategy401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFeatureStrategy403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddFeatureStrategy404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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;
/** The name of the error kind */
name?: 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 AddPublicSignupTokenUser409 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleAccessToProject400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleAccessToProject401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleAccessToProject403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleAccessToProject404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleAccessToProject415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleToUser401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleToUser403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddRoleToUser404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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;
/** The name of the error kind */
name?: 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 AddTag401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddTag403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddTag404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddTagToFeatures401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddTagToFeatures403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddTagToFeatures404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 AddTagToFeatures415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -9,6 +9,18 @@ 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.
@ -22,16 +34,4 @@ 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 {
/** 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 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 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,20 +9,20 @@ 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. */
id: number;
/** The addon provider, such as "webhook" or "slack". */
provider: string;
/** A description of the addon. `null` if no description exists. */
description: string | null;
/** Whether the addon is enabled or not. */
enabled: boolean;
/** 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 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. */
id: number;
/** Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. */
parameters: AddonSchemaParameters;
/** 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;
}

View File

@ -3,35 +3,35 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { TagTypeSchema } from './tagTypeSchema';
import type { AddonParameterSchema } from './addonParameterSchema';
import type { AddonTypeSchemaInstallation } from './addonTypeSchemaInstallation';
import type { AddonTypeSchemaAlertsItem } from './addonTypeSchemaAlertsItem';
import type { AddonTypeSchemaInstallation } from './addonTypeSchemaInstallation';
import type { AddonParameterSchema } from './addonParameterSchema';
import type { TagTypeSchema } from './tagTypeSchema';
/**
* 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 {
/** 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;
/** 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;
/** 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[];
/** The addon provider's parameters. Use these to configure an addon of this provider type. Items with `required: true` must be provided. */
parameters?: AddonParameterSchema[];
/** 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;
/** A description of the addon type. */
description: 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 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;
/** 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[];
}

View File

@ -6,8 +6,8 @@
import type { AddonTypeSchemaAlertsItemType } from './addonTypeSchemaAlertsItemType';
export type AddonTypeSchemaAlertsItem = {
/** 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;
/** The type of alert. This determines the color of the alert. */
type: AddonTypeSchemaAlertsItemType;
};

View File

@ -8,10 +8,10 @@
* The installation configuration for this addon type.
*/
export type AddonTypeSchemaInstallation = {
/** 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;
/** 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;
};

View File

@ -8,10 +8,10 @@
* Contains total admin counts for an Unleash instance.
*/
export interface AdminCountSchema {
/** 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 admins that have a password set. */
password: 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 {
/** 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 toggles */
namePrefix?: string;
/** Used to filter by tags. For each entry, a TAGTYPE:TAGVALUE is expected */
tag?: 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 { AdminPermissionSchema } from './adminPermissionSchema';
import type { AdminPermissionsSchemaPermissionsEnvironmentsItem } from './adminPermissionsSchemaPermissionsEnvironmentsItem';
import type { AdminPermissionSchema } from './adminPermissionSchema';
/**
* Returns permissions available at all three levels (root|project|environment)
*/
export type AdminPermissionsSchemaPermissions = {
/** 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[];
/** 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[];
};

View File

@ -9,22 +9,22 @@ 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 */
createdBy?: string | null;
/** The description for this segment */
description?: string | null;
/** The ID of this segment */
id: number;
/** The name of this segment */
name: string;
/** The description for this segment */
description?: string | null;
/** The list of constraints that are used in this segment */
constraints: ConstraintSchema[];
/** The project the segment belongs to. Only present if the segment is a project-specific segment. */
project?: string | null;
/** 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. */
usedInFeatures?: number | null;
/** The number of projects that use this segment. The number includes any projects with pending change requests that would add this segment. */
usedInProjects?: number | null;
/** The project the segment belongs to. Only present if the segment is a project-specific segment. */
project?: string | null;
/** The creator's email or username */
createdBy?: string | null;
/** When the segment was created */
createdAt: string;
}

View File

@ -5,14 +5,14 @@
*/
export type AdminStrategiesSchemaStrategiesItem = {
/** The ID of the strategy */
id: string;
/** The name of the feature flag that this strategy belongs to. */
featureName: string;
/** The ID of the project that the strategy belongs to. */
projectId: string;
/** The ID of the environment that the strategy belongs to. */
environment: string;
/** The name of the feature flag that this strategy belongs to. */
featureName: string;
/** The ID of the strategy */
id: string;
/** The ID of the project that the strategy belongs to. */
projectId: string;
/** The name of the strategy's type. */
strategyName: string;
};

View File

@ -12,22 +12,22 @@ import type { VariantSchema } from './variantSchema';
* A simplified feature toggle model intended for the Unleash playground.
*/
export interface AdvancedPlaygroundEnvironmentFeatureSchema {
/** The feature's name. */
name: string;
/** The feature's environment. */
environment: string;
/** The context to use when evaluating toggles */
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;
/** 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 ID of the project that contains this feature. */
projectId: string;
/** Feature's applicable strategies and cumulative results of the strategies */
strategies: AdvancedPlaygroundEnvironmentFeatureSchemaStrategies;
/** The feature variant you receive based on the provided context or the _disabled
variant_. If a feature is disabled or doesn't have any
variants, you would get the _disabled variant_.

View File

@ -3,19 +3,19 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AdvancedPlaygroundEnvironmentFeatureSchemaStrategiesResult } from './advancedPlaygroundEnvironmentFeatureSchemaStrategiesResult';
import type { PlaygroundStrategySchema } from './playgroundStrategySchema';
import type { AdvancedPlaygroundEnvironmentFeatureSchemaStrategiesResult } from './advancedPlaygroundEnvironmentFeatureSchemaStrategiesResult';
/**
* 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

@ -12,10 +12,10 @@ import type { AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload } from '.
Otherwise, you'll get one of the feature's defined variants.
*/
export type AdvancedPlaygroundEnvironmentFeatureSchemaVariant = {
/** The variant's name. If there is no variant or if the toggle 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;
/** The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled` */
name: string;
/** An optional payload attached to the variant. */
payload?: AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload;
} | null;

View File

@ -9,10 +9,10 @@ import type { AdvancedPlaygroundFeatureSchemaEnvironments } from './advancedPlay
* A simplified feature toggle 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,16 +3,16 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AdvancedPlaygroundRequestSchemaProjects } from './advancedPlaygroundRequestSchemaProjects';
import type { SdkContextSchema } from './sdkContextSchema';
import type { AdvancedPlaygroundRequestSchemaProjects } from './advancedPlaygroundRequestSchemaProjects';
/**
* 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. */
environments: string[];
/** A list of projects to check for toggles in. */
projects?: AdvancedPlaygroundRequestSchemaProjects;
context: SdkContextSchema;
}

View File

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

View File

@ -9,29 +9,29 @@ 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. */
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. */
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. */
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. */
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. */
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. */
alias?: string | null;
}

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 {
/** Name of the project */
project: string;
/** Which environments have been accessed in this project. */
environments: string[];
/** Name of the project */
project: string;
}

View File

@ -7,8 +7,8 @@
export type ArchiveFeature401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ArchiveFeature403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ArchiveFeature404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ArchiveFeatures400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ArchiveFeatures401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ArchiveFeatures403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ArchiveFeatures415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -8,26 +8,26 @@
* An object describing a banner to be displayed to all users.
*/
export interface BannerSchema {
/** 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. */
id: number;
/** The message to display to all users. Supports markdown. */
message: string;
/** 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. */
dialog?: string | null;
/** The title to display on the dialog. If not specified, this will be the same as `linkText`. */
dialogTitle?: string | null;
/** 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. */
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. */
id: number;
/** 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. */
link?: string | null;
/** The text to display on the link. If not specified, will be displayed as "More info". */
linkText?: string | null;
/** The title to display on the dialog. If not specified, this will be the same as `linkText`. */
dialogTitle?: string | null;
/** The markdown to display on the dialog. If not specified, no dialog will be displayed. */
dialog?: string | null;
/** The date and time of when the banner was created. */
createdAt: string;
/** 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;
}

View File

@ -7,8 +7,8 @@
export type BulkMetrics400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkMetrics413 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkMetrics415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: 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;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOff401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOff403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOff404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOff413 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOff415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOn400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOn401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOn403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOn404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOn413 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 BulkToggleFeaturesEnvironmentOn415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangePassword401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangePassword403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangePassword415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -8,8 +8,8 @@
* Change password as long as the token is a valid token
*/
export interface ChangePasswordSchema {
/** A reset token used to validate that the user is allowed to change the password. */
token: string;
/** The new password for the user */
password: string;
/** A reset token used to validate that the user is allowed to change the password. */
token: string;
}

View File

@ -7,8 +7,8 @@
export type ChangeProject400 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangeProject401 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangeProject403 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangeProject404 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: 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 ChangeProject415 = {
/** The ID of the error instance */
id?: string;
/** The name of the error kind */
name?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -9,8 +9,8 @@ import type { ChangeRequestApprovalSchemaCreatedBy } from './changeRequestApprov
* Information about a [change request](https://docs.getunleash.io/reference/change-requests) approval.
*/
export interface ChangeRequestApprovalSchema {
/** Information about the user who gave this approval. */
createdBy: ChangeRequestApprovalSchemaCreatedBy;
/** When the approval was given. */
createdAt: string;
/** Information about the user who gave this approval. */
createdBy: ChangeRequestApprovalSchemaCreatedBy;
}

View File

@ -10,8 +10,8 @@
export type ChangeRequestApprovalSchemaCreatedBy = {
/** The ID of the user who gave this approval. */
id?: number;
/** The approving user's username. */
username?: string;
/** The URL where the user's image can be found. */
imageUrl?: string;
/** The approving user's username. */
username?: string;
};

View File

@ -3,23 +3,23 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestChangeSchemaPayload } from './changeRequestChangeSchemaPayload';
import type { ChangeRequestChangeSchemaCreatedBy } from './changeRequestChangeSchemaCreatedBy';
import type { ChangeRequestChangeSchemaPayload } from './changeRequestChangeSchemaPayload';
/**
* A change request change, containing info about the type of change and the specific changes.
*/
export interface ChangeRequestChangeSchema {
/** The ID of this change. */
id: number;
/** The kind of action that the change contains information about. */
action: string;
/** A description of the conflict caused by this change. Only present if there are any conflicts. */
conflict?: string;
/** The data required to perform this action. */
payload: ChangeRequestChangeSchemaPayload;
/** The user who created this change. */
createdBy?: ChangeRequestChangeSchemaCreatedBy;
/** When this change was suggested */
createdAt?: string;
/** The user who created this change. */
createdBy?: ChangeRequestChangeSchemaCreatedBy;
/** The ID of this change. */
id: number;
/** The data required to perform this action. */
payload: ChangeRequestChangeSchemaPayload;
}

View File

@ -8,8 +8,8 @@
* The user who created this change.
*/
export type ChangeRequestChangeSchemaCreatedBy = {
/** The user's username. */
username?: string | null;
/** The URL where the user's image can be found. */
imageUrl?: string | null;
/** The user's username. */
username?: string | null;
};

View File

@ -9,12 +9,12 @@ import type { ChangeRequestCommentSchemaCreatedBy } from './changeRequestComment
* A comment belonging to a [change request](https://docs.getunleash.io/reference/change-requests).
*/
export interface ChangeRequestCommentSchema {
/** When the comment was made. */
createdAt: string;
/** Information about the user who posted the comment */
createdBy: ChangeRequestCommentSchemaCreatedBy;
/** The comment's ID. Unique per change request. */
id?: number;
/** The content of the comment. */
text: string;
/** Information about the user who posted the comment */
createdBy: ChangeRequestCommentSchemaCreatedBy;
/** When the comment was made. */
createdAt: string;
}

View File

@ -8,8 +8,8 @@
* Information about the user who posted the comment
*/
export type ChangeRequestCommentSchemaCreatedBy = {
/** The user's username. */
username?: string | null;
/** The URL where the user's image can be found. */
imageUrl?: string | null;
/** The user's username. */
username?: string | null;
};

View File

@ -10,9 +10,9 @@ import type { ChangeRequestCreateFeatureSchemaOneOfPayload } from './changeReque
* Update the enabled state for a feature.
*/
export type ChangeRequestCreateFeatureSchemaOneOf = {
/** The name of the feature that this change applies to. */
feature: string;
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfAction;
/** The name of the feature that this change applies to. */
feature: string;
payload: ChangeRequestCreateFeatureSchemaOneOfPayload;
};

View File

@ -10,9 +10,9 @@ import type { ChangeRequestCreateFeatureSchemaOneOfEightPayload } from './change
* Delete a strategy from this feature.
*/
export type ChangeRequestCreateFeatureSchemaOneOfEight = {
/** The name of the feature that this change applies to. */
feature: string;
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfEightAction;
/** The name of the feature that this change applies to. */
feature: string;
payload: ChangeRequestCreateFeatureSchemaOneOfEightPayload;
};

View File

@ -10,9 +10,9 @@ import type { CreateFeatureStrategySchema } from './createFeatureStrategySchema'
* Add a strategy to the feature
*/
export type ChangeRequestCreateFeatureSchemaOneOfFour = {
/** The name of the feature that this change applies to. */
feature: string;
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfFourAction;
/** The name of the feature that this change applies to. */
feature: string;
payload: CreateFeatureStrategySchema;
};

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