1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-05-31 01:16:01 +02:00

chore: regenerate orval with new changes (#7283)

This PR generates new orval schemas with:
- new create tag schema
- updates from toggle to flag
- deprecation and obsolescence info
This commit is contained in:
Thomas Heartman 2024-06-05 09:14:50 +02:00 committed by GitHub
parent 3039fc3d59
commit e5c3cc0c8d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
32 changed files with 55 additions and 325 deletions

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type _ExportFormat = (typeof _ExportFormat)[keyof typeof _ExportFormat];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const _ExportFormat = {
json: 'json',
yaml: 'yaml',
} as const;

View File

@ -1,37 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { _ExportFormat } from './_exportFormat';
export type _ExportParams = {
/**
* Desired export format. Must be either `json` or `yaml`.
*/
format?: _ExportFormat;
/**
* Whether exported data should be downloaded as a file.
*/
download?: boolean | string | number;
/**
* Whether strategies should be included in the exported data.
*/
strategies?: boolean | string | number;
/**
* Whether feature flags should be included in the exported data.
*/
featureToggles?: boolean | string | number;
/**
* Whether projects should be included in the exported data.
*/
projects?: boolean | string | number;
/**
* Whether tag types, tags, and feature_tags should be included in the exported data.
*/
tags?: boolean | string | number;
/**
* Whether environments should be included in the exported data.
*/
environments?: boolean | string | number;
};

View File

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

View File

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

View File

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

View File

@ -5,9 +5,9 @@
*/
/**
* Data required to move a feature toggle to a project.
* Data required to move a feature flag to a project.
*/
export interface ChangeProjectSchema {
/** The project to move the feature toggle to. */
/** The project to move the feature flag to. */
newProjectId: string;
}

View File

@ -12,7 +12,7 @@ export interface ClientApplicationSchema {
/** An identifier for the app that uses the sdk, should be static across SDK restarts */
appName: string;
/**
* The SDK's configured 'environment' property. Deprecated. This property does **not** control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.
* The SDK's configured 'environment' property. This property was deprecated in v5. This property does **not** control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.
* @deprecated
*/
environment?: string;

View File

@ -9,7 +9,7 @@
*/
export interface ClientFeaturesQuerySchema {
/**
* Strategies for the feature flag configured for this environment are included. (DEPRECATED) - Handled by API tokens
* Strategies for the feature flag configured for this environment are included. This is now handled by API tokens and was marked as deprecated in v5
* @deprecated
*/
environment?: string;
@ -18,7 +18,7 @@ export interface ClientFeaturesQuerySchema {
/** Features are filtered to only include features whose name starts with this prefix */
namePrefix?: string;
/**
* Features that are part of these projects are included in this response. (DEPRECATED) - Handled by API tokens
* Features that are part of these projects are included in this response. This is now handled by API tokens and was marked as deprecated in v5
* @deprecated
*/
project?: string[];

View File

@ -19,7 +19,7 @@ export type CreateApiTokenSchemaOneOfFour = {
*/
type: string;
/**
* The name of the token. This property is deprecated. Use `tokenName` instead.
* The name of the token. This property was deprecated in v5. Use `tokenName` instead.
* @deprecated
*/
username: string;

View File

@ -13,7 +13,7 @@ export type CreateApiTokenSchemaOneOfTwo = {
*/
type: string;
/**
* The name of the token. This property is deprecated. Use `tokenName` instead.
* The name of the token. This property was deprecated in v5. Use `tokenName` instead.
* @deprecated
*/
username: string;

View File

@ -33,8 +33,8 @@ export interface CreateProjectSchema {
/** A mode of the project affecting what actions are possible in this project */
mode?: CreateProjectSchemaMode;
/**
* The project's name.
* @minLength 1
* The project's name. The name must contain at least one non-whitespace character.
* @pattern ^(?!\s*$).+
*/
name: string;
}

View File

@ -0,0 +1,22 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Data used to create a new [tag](https://docs.getunleash.io/reference/tags)
*/
export interface CreateTagSchema {
/**
* The [type](https://docs.getunleash.io/reference/tags#tag-types) of the tag
* @minLength 2
* @maxLength 50
*/
type: string;
/**
* The value of the tag. The value must be between 2 and 50 characters long. Leading and trailing whitespace is ignored and will be trimmed before saving the tag value.
* @pattern ^\s*\S.{0,48}\S\s*$
*/
value: string;
}

View File

@ -24,7 +24,7 @@ export interface CreateUserResponseSchema {
/** If the user is actively inviting other users, this is the link that can be shared with other users */
inviteLink?: string;
/**
* (Deprecated): Used internally to know which operations the user should be allowed to perform
* Deprecated in v5. Used internally to know which operations the user should be allowed to perform
* @deprecated
*/
isAPI?: boolean;

View File

@ -44,7 +44,7 @@ export interface FeatureSchema {
/** `true` if the impression data collection is enabled for the feature, otherwise `false`. */
impressionData?: boolean;
/**
* The date when metrics where last collected for the feature. This field is deprecated, use the one in featureEnvironmentSchema
* The date when metrics where last collected for the feature. This field was deprecated in v5, use the one in featureEnvironmentSchema
* @deprecated
* @nullable
*/
@ -58,7 +58,7 @@ export interface FeatureSchema {
/** `true` if the feature is stale based on the age and feature type, otherwise `false`. */
stale?: boolean;
/**
* This is a legacy field that will be deprecated
* This was deprecated in v5 and will be removed in a future major version
* @deprecated
*/
strategies?: FeatureSchemaStrategiesItem[];

View File

@ -43,7 +43,7 @@ export interface FeatureSearchResponseSchema {
/** `true` if the impression data collection is enabled for the feature, otherwise `false`. */
impressionData: boolean;
/**
* The date when metrics where last collected for the feature. This field is deprecated, use the one in featureEnvironmentSchema
* The date when metrics where last collected for the feature. This field was deprecated in v5 and will be removed in a future release, use the one in featureEnvironmentSchema
* @deprecated
* @nullable
*/
@ -59,7 +59,7 @@ export interface FeatureSearchResponseSchema {
/** `true` if the feature is stale based on the age and feature type, otherwise `false`. */
stale: boolean;
/**
* This is a legacy field that will be deprecated
* This is a legacy field that was deprecated in v5
* @deprecated
*/
strategies?: FeatureSearchResponseSchemaStrategiesItem[];
@ -71,7 +71,7 @@ export interface FeatureSearchResponseSchema {
/** Type of the flag e.g. experiment, kill-switch, release, operational, permission */
type: string;
/**
* The list of feature variants
* The list of feature variants. This field was deprecated in v5
* @deprecated
*/
variants?: VariantSchema[];

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,23 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Configuration for using Google Authentication
*/
export interface GoogleSettingsSchema {
/** Should Unleash create users based on the emails coming back in the authentication reply from Google */
autoCreate?: boolean;
/** The google client id, used to authenticate against google */
clientId: string;
/** The client secret used to authenticate the OAuth session used to log the user in */
clientSecret: string;
/** A comma separated list of email domains that Unleash will auto create user accounts for. */
emailDomains?: string;
/** Is google OIDC enabled */
enabled?: boolean;
/** Name of the host allowed to access the Google authentication flow */
unleashHostname: string;
}

View File

@ -4,8 +4,6 @@
* See `gen:api` script in package.json
*/
export * from './_exportFormat';
export * from './_exportParams';
export * from './accessOverviewSchema';
export * from './actionDefinitionParameterSchema';
export * from './actionDefinitionParameterSchemaName';
@ -118,9 +116,6 @@ export * from './bannerSchema';
export * from './bannersSchema';
export * from './batchFeaturesSchema';
export * from './batchStaleSchema';
export * from './bulkMetrics400';
export * from './bulkMetrics413';
export * from './bulkMetrics415';
export * from './bulkMetricsSchema';
export * from './bulkRegistrationSchema';
export * from './bulkRegistrationSchemaConnectViaItem';
@ -431,6 +426,7 @@ export * from './createTag401';
export * from './createTag403';
export * from './createTag409';
export * from './createTag415';
export * from './createTagSchema';
export * from './createTagType400';
export * from './createTagType401';
export * from './createTagType403';
@ -594,8 +590,6 @@ export * from './getAllEnvironments401';
export * from './getAllEnvironments403';
export * from './getAllFeatureTypes401';
export * from './getAllStrategies401';
export * from './getAllToggles401';
export * from './getAllToggles403';
export * from './getApiTokensByName401';
export * from './getApiTokensByName403';
export * from './getApplication404';
@ -647,9 +641,6 @@ export * from './getFeatures401';
export * from './getFeatures403';
export * from './getFrontendFeatures401';
export * from './getFrontendFeatures404';
export * from './getGoogleSettings400';
export * from './getGoogleSettings401';
export * from './getGoogleSettings403';
export * from './getGroup400';
export * from './getGroup401';
export * from './getGroup403';
@ -757,7 +748,6 @@ export * from './getUsers403';
export * from './getValidTokens400';
export * from './getValidTokens413';
export * from './getValidTokens415';
export * from './googleSettingsSchema';
export * from './groupSchema';
export * from './groupUserModelSchema';
export * from './groupWithProjectRoleSchema';
@ -1022,10 +1012,6 @@ export * from './sendResetPasswordEmail404';
export * from './sendResetPasswordEmail415';
export * from './serviceAccountSchema';
export * from './serviceAccountsSchema';
export * from './setGoogleSettings400';
export * from './setGoogleSettings401';
export * from './setGoogleSettings403';
export * from './setGoogleSettings415';
export * from './setOidcSettings400';
export * from './setOidcSettings401';
export * from './setOidcSettings403';
@ -1072,7 +1058,6 @@ export * from './splashResponseSchema';
export * from './staleFeatures401';
export * from './staleFeatures403';
export * from './staleFeatures415';
export * from './stateSchema';
export * from './strategiesSchema';
export * from './strategiesSchemaVersion';
export * from './strategySchema';

View File

@ -12,7 +12,7 @@ export type NotificationsSchemaItem = {
createdBy: NotificationsSchemaItemCreatedBy;
/** The id of this notification */
id: number;
/** The link to change request or feature toggle the notification refers to */
/** The link to change request or feature flag the notification refers to */
link: string;
/** The actual notification message */
message: string;

View File

@ -18,7 +18,7 @@ export type SearchFeaturesParams = {
*/
state?: string;
/**
* The list of feature types to filter by
* The feature flag type to filter by. The type can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.
*/
type?: string;
/**

View File

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

View File

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

View File

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

View File

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

View File

@ -1,47 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { EnvironmentSchema } from './environmentSchema';
import type { FeatureEnvironmentSchema } from './featureEnvironmentSchema';
import type { FeatureSchema } from './featureSchema';
import type { FeatureStrategySchema } from './featureStrategySchema';
import type { FeatureStrategySegmentSchema } from './featureStrategySegmentSchema';
import type { FeatureTagSchema } from './featureTagSchema';
import type { ProjectSchema } from './projectSchema';
import type { SegmentSchema } from './segmentSchema';
import type { StrategySchema } from './strategySchema';
import type { TagSchema } from './tagSchema';
import type { TagTypeSchema } from './tagTypeSchema';
/**
* The application state as used by the deprecated export/import APIs.
* @deprecated
*/
export interface StateSchema {
/** A list of environments */
environments?: EnvironmentSchema[];
/** A list of feature environment configurations */
featureEnvironments?: FeatureEnvironmentSchema[];
/** A list of features */
features?: FeatureSchema[];
/** A list of feature strategies as applied to features */
featureStrategies?: FeatureStrategySchema[];
/** A list of segment/strategy pairings */
featureStrategySegments?: FeatureStrategySegmentSchema[];
/** A list of tags applied to features */
featureTags?: FeatureTagSchema[];
/** A list of projects */
projects?: ProjectSchema[];
/** A list of segments */
segments?: SegmentSchema[];
/** A list of strategies */
strategies?: StrategySchema[];
/** A list of tags */
tags?: TagSchema[];
/** A list of tag types */
tagTypes?: TagTypeSchema[];
/** The version of the schema used to describe the state */
version: number;
}

View File

@ -8,8 +8,16 @@
* Representation of a [tag](https://docs.getunleash.io/reference/tags)
*/
export interface TagSchema {
/** The [type](https://docs.getunleash.io/reference/tags#tag-types) of the tag */
/**
* The [type](https://docs.getunleash.io/reference/tags#tag-types) of the tag
* @minLength 2
* @maxLength 50
*/
type: string;
/** The value of the tag */
/**
* The value of the tag.
* @minLength 2
* @maxLength 50
*/
value: string;
}

View File

@ -15,6 +15,9 @@ export interface UpdateProjectSchema {
description?: string;
/** A mode of the project affecting what actions are possible in this project */
mode?: UpdateProjectSchemaMode;
/** The new name of the project */
/**
* The new name of the project. The name must contain at least one non-whitespace character.
* @pattern ^(?!\s*$).+
*/
name: string;
}

View File

@ -23,7 +23,7 @@ export interface UserSchema {
/** If the user is actively inviting other users, this is the link that can be shared with other users */
inviteLink?: string;
/**
* (Deprecated): Used internally to know which operations the user should be allowed to perform
* Deprecated in v5. Used internally to know which operations the user should be allowed to perform
* @deprecated
*/
isAPI?: boolean;