1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-08-09 13:47:13 +02:00

chore: Update OpenAPI definitions generated for frontend (#4283)

## About the changes
`frontend> yarn gen:api` after recent updates
This commit is contained in:
Tymoteusz Czech 2023-07-20 12:59:55 +02:00 committed by GitHub
parent 5dd78f3c15
commit 77a365e667
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
497 changed files with 6620 additions and 230 deletions

View File

@ -117,7 +117,7 @@
"whatwg-fetch": "3.6.2" "whatwg-fetch": "3.6.2"
}, },
"optionalDependencies": { "optionalDependencies": {
"orval": "^6.10.3" "orval": "^6.17.0"
}, },
"resolutions": { "resolutions": {
"@codemirror/state": "6.2.1", "@codemirror/state": "6.2.1",

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type DeleteLoginHistory401 = { export type AddFavoriteFeature401 = {
/** The ID of the error instance */ /** The ID of the error instance */
id?: string; id?: string;
/** The name of the error kind */ /** The name of the error kind */

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type DeleteLoginEvent401 = { export type AddTagToFeatures401 = {
/** The ID of the error instance */ /** The ID of the error instance */
id?: string; id?: string;
/** The name of the error kind */ /** The name of the error kind */

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type DeleteLoginEvent404 = { export type AddTagToFeatures403 = {
/** The ID of the error instance */ /** The ID of the error instance */
id?: string; id?: string;
/** The name of the error kind */ /** The name of the error kind */

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type DeleteLoginEvent400 = { export type AddTagToFeatures404 = {
/** The ID of the error instance */ /** The ID of the error instance */
id?: string; id?: string;
/** The name of the error kind */ /** The name of the error kind */

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -5,6 +5,8 @@
*/ */
import type { TagTypeSchema } from './tagTypeSchema'; import type { TagTypeSchema } from './tagTypeSchema';
import type { AddonParameterSchema } from './addonParameterSchema'; 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. * An addon provider. Defines a specific addon type and what the end user must configure when creating a new addon of that type.
@ -24,4 +26,10 @@ export interface AddonTypeSchema {
parameters?: AddonParameterSchema[]; 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. */ /** 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[]; 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

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,19 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The type of alert. This determines the color of the alert.
*/
export type AddonTypeSchemaAlertsItemType =
typeof AddonTypeSchemaAlertsItemType[keyof typeof AddonTypeSchemaAlertsItemType];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AddonTypeSchemaAlertsItemType = {
success: 'success',
info: 'info',
warning: 'warning',
error: 'error',
} as const;

View File

@ -0,0 +1,17 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* 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;
};

View File

@ -4,10 +4,18 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Describes a single permission
*/
export interface AdminPermissionSchema { export interface AdminPermissionSchema {
/** The identifier for this permission */
id: number; id: number;
/** The name of this permission */
name: string; name: string;
/** The name to display in listings of permissions */
displayName: string; displayName: string;
/** What level this permission applies to. Either root, project or the name of the environment it applies to */
type: string; type: string;
/** Which environment this permission applies to */
environment?: string; environment?: string;
} }

View File

@ -4,8 +4,14 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { AdminPermissionsSchemaPermissions } from './adminPermissionsSchemaPermissions'; import type { AdminPermissionsSchemaPermissions } from './adminPermissionsSchemaPermissions';
import type { AdminPermissionsSchemaVersion } from './adminPermissionsSchemaVersion';
/**
* What kind of permissions are available
*/
export interface AdminPermissionsSchema { export interface AdminPermissionsSchema {
/** Returns permissions available at all three levels (root|project|environment) */
permissions: AdminPermissionsSchemaPermissions; permissions: AdminPermissionsSchemaPermissions;
version: number; /** The api version of this response. A natural increasing number. Only increases if format changes */
version: AdminPermissionsSchemaVersion;
} }

View File

@ -6,8 +6,14 @@
import type { AdminPermissionSchema } from './adminPermissionSchema'; import type { AdminPermissionSchema } from './adminPermissionSchema';
import type { AdminPermissionsSchemaPermissionsEnvironmentsItem } from './adminPermissionsSchemaPermissionsEnvironmentsItem'; import type { AdminPermissionsSchemaPermissionsEnvironmentsItem } from './adminPermissionsSchemaPermissionsEnvironmentsItem';
/**
* Returns permissions available at all three levels (root|project|environment)
*/
export type AdminPermissionsSchemaPermissions = { export type AdminPermissionsSchemaPermissions = {
/** Permissions available at the root level, i.e. not connected to any specific project or environment */
root?: AdminPermissionSchema[]; root?: AdminPermissionSchema[];
/** Permissions available at the project level */
project: AdminPermissionSchema[]; project: AdminPermissionSchema[];
/** A list of environments with available permissions per environment */
environments: AdminPermissionsSchemaPermissionsEnvironmentsItem[]; environments: AdminPermissionsSchemaPermissionsEnvironmentsItem[];
}; };

View File

@ -6,6 +6,8 @@
import type { AdminPermissionSchema } from './adminPermissionSchema'; import type { AdminPermissionSchema } from './adminPermissionSchema';
export type AdminPermissionsSchemaPermissionsEnvironmentsItem = { export type AdminPermissionsSchemaPermissionsEnvironmentsItem = {
/** The name of the environment */
name: string; name: string;
/** Permissions available for this environment */
permissions: AdminPermissionSchema[]; permissions: AdminPermissionSchema[];
}; };

View File

@ -0,0 +1,17 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The api version of this response. A natural increasing number. Only increases if format changes
*/
export type AdminPermissionsSchemaVersion =
typeof AdminPermissionsSchemaVersion[keyof typeof AdminPermissionsSchemaVersion];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AdminPermissionsSchemaVersion = {
NUMBER_1: 1,
NUMBER_2: 2,
} as const;

View File

@ -6,17 +6,17 @@
import type { ConstraintSchema } from './constraintSchema'; import type { ConstraintSchema } from './constraintSchema';
export interface AdminSegmentSchema { export interface AdminSegmentSchema {
/** The id of a segment */ /** The ID of this segment */
id: number; id: number;
/** The name of a segment */ /** The name of this segment */
name: string; name: string;
/** The description for a segment */ /** The description for this segment */
description?: string | null; description?: string | null;
/** List of constraints that are used in this segment */ /** The list of constraints that are used in this segment */
constraints: ConstraintSchema[]; constraints: ConstraintSchema[];
/** Number of projects where this segment is used in */ /** The number of projects that use this segment */
usedInFeatures?: number | null; usedInFeatures?: number | null;
/** Number of projects where this segment is used in */ /** The number of projects that use this segment */
usedInProjects?: number | null; usedInProjects?: number | null;
project?: string | null; project?: string | null;
/** The creator's email or username */ /** The creator's email or username */

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AdminStrategiesSchemaStrategiesItem } from './adminStrategiesSchemaStrategiesItem';
/**
* A collection of strategies belonging to a specified segment.
*/
export interface AdminStrategiesSchema {
/** The list of strategies */
strategies: AdminStrategiesSchemaStrategiesItem[];
}

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type AdminStrategiesSchemaStrategiesItem = {
/** The ID of the strategy */
id: string;
/** The ID of the strategy */
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 strategy's type. */
strategyName: string;
};

View File

@ -6,9 +6,9 @@
import type { ApiTokenSchema } from './apiTokenSchema'; import type { ApiTokenSchema } from './apiTokenSchema';
/** /**
* Contains a list of API tokens. * An object with [Unleash API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys)
*/ */
export interface ApiTokensSchema { export interface ApiTokensSchema {
/** A list of API tokens. */ /** A list of Unleash API tokens. */
tokens: ApiTokenSchema[]; tokens: ApiTokenSchema[];
} }

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -4,6 +4,10 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* A list of feature toggle names for batch operations
*/
export interface BatchFeaturesSchema { export interface BatchFeaturesSchema {
/** List of feature toggle names */
features: string[]; features: string[];
} }

View File

@ -4,7 +4,12 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* A list of features to operate on and whether they should be marked as stale or as not stale.
*/
export interface BatchStaleSchema { export interface BatchStaleSchema {
/** A list of features to mark as (not) stale */
features: string[]; features: string[];
/** Whether the list of features should be marked as stale or not stale. If `true`, the features will be marked as stale. If `false`, the features will be marked as not stale. */
stale: boolean; stale: boolean;
} }

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -4,7 +4,12 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Change password as long as the token is a valid token
*/
export interface ChangePasswordSchema { export interface ChangePasswordSchema {
/** A reset token used to validate that the user is allowed to change the password. */
token: string; token: string;
/** The new password for the user */
password: string; password: string;
} }

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
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;
};

View File

@ -4,6 +4,10 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data required to move a feature toggle to a project.
*/
export interface ChangeProjectSchema { export interface ChangeProjectSchema {
/** The project to move the feature toggle to. */
newProjectId: string; newProjectId: string;
} }

View File

@ -4,6 +4,6 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export interface ChangeRequestEditTitleSchema { export interface ChangeRequestUpdateTitleSchema {
title: string; title: string;
} }

View File

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

View File

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

View File

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

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { ClientFeatureSchema } from './clientFeatureSchema'; import type { ClientFeatureSchema } from './clientFeatureSchema';
import type { SegmentSchema } from './segmentSchema'; import type { ClientSegmentSchema } from './clientSegmentSchema';
import type { ClientFeaturesQuerySchema } from './clientFeaturesQuerySchema'; import type { ClientFeaturesQuerySchema } from './clientFeaturesQuerySchema';
/** /**
@ -16,7 +16,7 @@ export interface ClientFeaturesSchema {
/** A list of feature toggles with their configuration */ /** A list of feature toggles with their configuration */
features: ClientFeatureSchema[]; features: ClientFeatureSchema[];
/** A list of [Segments](https://docs.getunleash.io/reference/segments) configured for this Unleash instance */ /** A list of [Segments](https://docs.getunleash.io/reference/segments) configured for this Unleash instance */
segments?: SegmentSchema[]; segments?: ClientSegmentSchema[];
/** A summary of filters and parameters sent to the endpoint. Used by the server to build the features and segments response */ /** A summary of filters and parameters sent to the endpoint. Used by the server to build the features and segments response */
query?: ClientFeaturesQuerySchema; query?: ClientFeaturesQuerySchema;
} }

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ConstraintSchema } from './constraintSchema';
/**
* Represents a client API segment of users defined by a set of constraints.
*/
export interface ClientSegmentSchema {
/** The segment's id. */
id: number;
/** The name of the segment. */
name?: string;
/** List of constraints that determine which users are part of the segment */
constraints: ConstraintSchema[];
}

View File

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

View File

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

View File

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

View File

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

View File

@ -4,7 +4,12 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Copy of a feature with a new name
*/
export interface CloneFeatureSchema { export interface CloneFeatureSchema {
/** The name of the new feature */
name: string; name: string;
/** Whether to use the new feature name as its group ID or not. Group ID is used for calculating [stickiness](https://docs.getunleash.io/reference/stickiness#calculation). Defaults to true. */
replaceGroupId?: boolean; replaceGroupId?: boolean;
} }

View File

@ -5,15 +5,24 @@
*/ */
import type { LegalValueSchema } from './legalValueSchema'; import type { LegalValueSchema } from './legalValueSchema';
/**
* A representation of a [context field](https://docs.getunleash.io/reference/unleash-context).
*/
export interface ContextFieldSchema { export interface ContextFieldSchema {
/** The name of the context field */
name: string; name: string;
/** The description of the context field. */
description?: string | null; description?: string | null;
/** Does this context field support being used for [stickiness](https://docs.getunleash.io/reference/stickiness) calculations */
stickiness?: boolean; stickiness?: boolean;
/** Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically. */
sortOrder?: number; sortOrder?: number;
/** When this context field was created */
createdAt?: string | null; createdAt?: string | null;
/** Number of projects where this context field is used in */ /** Number of projects where this context field is used in */
usedInFeatures?: number | null; usedInFeatures?: number | null;
/** Number of projects where this context field is used in */ /** Number of projects where this context field is used in */
usedInProjects?: number | null; usedInProjects?: number | null;
/** Allowed values for this context field schema. Can be used to narrow down accepted input */
legalValues?: LegalValueSchema[]; legalValues?: LegalValueSchema[];
} }

View File

@ -6,7 +6,7 @@
import type { ContextFieldStrategiesSchemaStrategiesItem } from './contextFieldStrategiesSchemaStrategiesItem'; import type { ContextFieldStrategiesSchemaStrategiesItem } from './contextFieldStrategiesSchemaStrategiesItem';
/** /**
* A wrapper object containing all for strategies using a specific context field * A wrapper object containing all strategies that use a specific context field
*/ */
export interface ContextFieldStrategiesSchema { export interface ContextFieldStrategiesSchema {
/** List of strategies using the context field */ /** List of strategies using the context field */

View File

@ -5,4 +5,7 @@
*/ */
import type { ContextFieldSchema } from './contextFieldSchema'; import type { ContextFieldSchema } from './contextFieldSchema';
/**
* A list of context fields
*/
export type ContextFieldsSchema = ContextFieldSchema[]; export type ContextFieldsSchema = ContextFieldSchema[];

View File

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

View File

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

View File

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

View File

@ -3,25 +3,28 @@
* Do not edit manually. * Do not edit manually.
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { CreateApiTokenSchemaAnyOf } from './createApiTokenSchemaAnyOf'; import type { CreateApiTokenSchemaOneOf } from './createApiTokenSchemaOneOf';
import type { CreateApiTokenSchemaAnyOfTwo } from './createApiTokenSchemaAnyOfTwo'; import type { CreateApiTokenSchemaOneOfFour } from './createApiTokenSchemaOneOfFour';
import type { CreateApiTokenSchemaOneOfSeven } from './createApiTokenSchemaOneOfSeven';
import type { CreateApiTokenSchemaOneOfOnezero } from './createApiTokenSchemaOneOfOnezero';
/**
* The data required to create an [Unleash API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys).
*/
export type CreateApiTokenSchema = export type CreateApiTokenSchema =
| (CreateApiTokenSchemaAnyOf & { | (CreateApiTokenSchemaOneOf & {
secret?: string; /** The time when this token should expire. */
/** One of client, admin, frontend */ expiresAt?: string;
type: string;
environment?: string;
project?: string;
projects?: string[];
expiresAt?: string | null;
}) })
| (CreateApiTokenSchemaAnyOfTwo & { | (CreateApiTokenSchemaOneOfFour & {
secret?: string; /** The time when this token should expire. */
/** One of client, admin, frontend */ expiresAt?: string;
type: string; })
environment?: string; | (CreateApiTokenSchemaOneOfSeven & {
project?: string; /** The time when this token should expire. */
projects?: string[]; expiresAt?: string;
expiresAt?: string | null; })
| (CreateApiTokenSchemaOneOfOnezero & {
/** The time when this token should expire. */
expiresAt?: string;
}); });

View File

@ -1,9 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaAnyOf = {
username: string;
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateApiTokenSchemaOneOfAllOf } from './createApiTokenSchemaOneOfAllOf';
import type { CreateApiTokenSchemaOneOfAllOfTwo } from './createApiTokenSchemaOneOfAllOfTwo';
export type CreateApiTokenSchemaOneOf = CreateApiTokenSchemaOneOfAllOf &
CreateApiTokenSchemaOneOfAllOfTwo;

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfAllOf = {
/** An admin token. Must be the string "admin" (not case sensitive). */
type: string;
};

View File

@ -4,6 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type CreateApiTokenSchemaAnyOfTwo = { export type CreateApiTokenSchemaOneOfAllOfTwo = {
/** The name of the token. */
tokenName: string; tokenName: string;
}; };

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateApiTokenSchemaOneOfFourAllOf } from './createApiTokenSchemaOneOfFourAllOf';
import type { CreateApiTokenSchemaOneOfFourAllOfTwo } from './createApiTokenSchemaOneOfFourAllOfTwo';
export type CreateApiTokenSchemaOneOfFour = CreateApiTokenSchemaOneOfFourAllOf &
CreateApiTokenSchemaOneOfFourAllOfTwo;

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfFourAllOf = {
/** An admin token. Must be the string "admin" (not case sensitive). */
type: string;
};

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfFourAllOfTwo = {
/**
* The name of the token. This property is deprecated. Use `tokenName` instead.
* @deprecated
*/
username: string;
};

View File

@ -0,0 +1,11 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateApiTokenSchemaOneOfOnezeroAllOf } from './createApiTokenSchemaOneOfOnezeroAllOf';
import type { CreateApiTokenSchemaOneOfOnezeroAllOfTwo } from './createApiTokenSchemaOneOfOnezeroAllOfTwo';
export type CreateApiTokenSchemaOneOfOnezero =
CreateApiTokenSchemaOneOfOnezeroAllOf &
CreateApiTokenSchemaOneOfOnezeroAllOfTwo;

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfOnezeroAllOf = {
/** A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive). */
type: string;
/** The environment that the token should be valid for. Defaults to "default" */
environment?: string;
/** The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the `projects` property. If you specify one, you cannot specify the other. */
project?: string;
/** A list of projects that the token should be valid for. This property is mutually incompatible with the `project` property. If you specify one, you cannot specify the other. */
projects?: string[];
};

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfOnezeroAllOfTwo = {
/**
* The name of the token. This property is deprecated. Use `tokenName` instead.
* @deprecated
*/
username: string;
};

View File

@ -0,0 +1,11 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateApiTokenSchemaOneOfSevenAllOf } from './createApiTokenSchemaOneOfSevenAllOf';
import type { CreateApiTokenSchemaOneOfSevenAllOfTwo } from './createApiTokenSchemaOneOfSevenAllOfTwo';
export type CreateApiTokenSchemaOneOfSeven =
CreateApiTokenSchemaOneOfSevenAllOf &
CreateApiTokenSchemaOneOfSevenAllOfTwo;

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfSevenAllOf = {
/** A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive). */
type: string;
/** The environment that the token should be valid for. Defaults to "default" */
environment?: string;
/** The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the `projects` property. If you specify one, you cannot specify the other. */
project?: string;
/** A list of projects that the token should be valid for. This property is mutually incompatible with the `project` property. If you specify one, you cannot specify the other. */
projects?: string[];
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateApiTokenSchemaOneOfSevenAllOfTwo = {
/** The name of the token. */
tokenName: string;
};

View File

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

View File

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

View File

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

View File

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

View File

@ -5,8 +5,12 @@
*/ */
export interface CreateFeatureSchema { export interface CreateFeatureSchema {
/** Unique feature name */
name: string; name: string;
/** The feature toggle's [type](https://docs.getunleash.io/reference/feature-toggle-types). One of experiment, kill-switch, release, operational, or permission */
type?: string; type?: string;
description?: string; /** Detailed description of the feature */
description?: string | null;
/** `true` if the impression data collection is enabled for the feature, otherwise `false`. */
impressionData?: boolean; impressionData?: boolean;
} }

View File

@ -4,10 +4,14 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { ConstraintSchema } from './constraintSchema'; import type { ConstraintSchema } from './constraintSchema';
import type { CreateStrategyVariantSchema } from './createStrategyVariantSchema';
import type { ParametersSchema } from './parametersSchema'; import type { ParametersSchema } from './parametersSchema';
/**
* Create a strategy configuration in a feature
*/
export interface CreateFeatureStrategySchema { export interface CreateFeatureStrategySchema {
/** The name or type of strategy */ /** The name of the strategy type */
name: string; name: string;
/** A descriptive title for the strategy */ /** A descriptive title for the strategy */
title?: string | null; title?: string | null;
@ -15,8 +19,10 @@ export interface CreateFeatureStrategySchema {
disabled?: boolean | null; disabled?: boolean | null;
/** The order of the strategy in the list */ /** The order of the strategy in the list */
sortOrder?: number; sortOrder?: number;
/** A list of the constraints attached to the strategy */ /** A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints */
constraints?: ConstraintSchema[]; constraints?: ConstraintSchema[];
/** Strategy level variants */
variants?: CreateStrategyVariantSchema[];
/** An object containing the parameters for the strategy */ /** An object containing the parameters for the strategy */
parameters?: ParametersSchema; parameters?: ParametersSchema;
/** Ids of segments to use for this strategy */ /** Ids of segments to use for this strategy */

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -4,8 +4,14 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Describes the properties required to create a new service account
*/
export interface CreateServiceAccountSchema { export interface CreateServiceAccountSchema {
/** The username of the service account */
username?: string; username?: string;
/** The name of the service account */
name?: string; name?: string;
/** The id of the root role for the service account */
rootRole: number; rootRole: number;
} }

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type CreateServiceAccountToken401 = {
/** The ID of the error instance */
id?: 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