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

chore: update orval schemas (#5858)

This PR updates Orval schemas. The motivation is to get the new schemas
for schedule suspension, but as always, we get everything else too.
This commit is contained in:
Thomas Heartman 2024-01-11 18:18:44 +05:30 committed by GitHub
parent b496990f79
commit be579ba63b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
42 changed files with 527 additions and 25 deletions

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateActionsSchema } from './createActionsSchema';
/**
* A response model with a list of action sets.
*/
export interface ActionsListSchema {
/** A list of action sets. */
actions: CreateActionsSchema[];
}

View File

@ -0,0 +1,23 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionsSchemaActionsItem } from './actionsSchemaActionsItem';
import type { ActionsSchemaMatch } from './actionsSchemaMatch';
/**
* A response model with an identifiable action set.
*/
export interface ActionsSchema {
/** The list of actions to execute in sequential order when the action set is triggered */
actions: ActionsSchemaActionsItem[];
/** The id of the service account that will execute the action */
actor: number;
/** The id of the action set */
id: number;
/** Defines a matching rule for the observable event that will trigger the action set */
match: ActionsSchemaMatch;
/** The name of the action set */
name: string;
}

View File

@ -0,0 +1,15 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionsSchemaActionsItemParams } from './actionsSchemaActionsItemParams';
export type ActionsSchemaActionsItem = {
/** The name of the action to execute */
action: string;
/** A map of parameters to pass to the action */
params?: ActionsSchemaActionsItemParams;
/** The order in which the action should be executed */
sortOrder: number;
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A map of parameters to pass to the action
*/
export type ActionsSchemaActionsItemParams = { [key: string]: any };

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionsSchemaMatchPayload } from './actionsSchemaMatchPayload';
/**
* Defines a matching rule for the observable event that will trigger the action set
*/
export type ActionsSchemaMatch = {
/** Match the payload of the observable event */
payload: ActionsSchemaMatchPayload;
/** Match the source of the observable event */
source: string;
/** Match the source id of the observable event */
sourceId: string;
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Match the payload of the observable event
*/
export type ActionsSchemaMatchPayload = { [key: string]: any };

View File

@ -3,16 +3,14 @@
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestScheduleSchemaStatus } from './changeRequestScheduleSchemaStatus';
import type { ChangeRequestScheduleSchemaOneOf } from './changeRequestScheduleSchemaOneOf';
import type { ChangeRequestScheduleSchemaOneOfThree } from './changeRequestScheduleSchemaOneOfThree';
import type { ChangeRequestScheduleSchemaOneOfFive } from './changeRequestScheduleSchemaOneOfFive';
/**
* A schedule for a change request.
* A schedule for a change request's application. The schedule can either be pending, failed, or suspended. The schedule will always contain the state of the schedule and the last scheduled time, but other data varies between the different states.
*/
export interface ChangeRequestScheduleSchema {
/** The reason the scheduled failed to apply. */
failureReason?: string | null;
/** When this change request is to be applied. */
scheduledAt: string;
/** The status of the schedule. */
status: ChangeRequestScheduleSchemaStatus;
}
export type ChangeRequestScheduleSchema =
| ChangeRequestScheduleSchemaOneOf
| ChangeRequestScheduleSchemaOneOfThree
| ChangeRequestScheduleSchemaOneOfFive;

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestScheduleSchemaOneOfStatus } from './changeRequestScheduleSchemaOneOfStatus';
/**
* A pending schedule for a change request.
*/
export type ChangeRequestScheduleSchemaOneOf = {
/** When this change request will be applied. */
scheduledAt: string;
/** The status of the schedule. */
status: ChangeRequestScheduleSchemaOneOfStatus;
};

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestScheduleSchemaOneOfFiveStatus } from './changeRequestScheduleSchemaOneOfFiveStatus';
/**
* A suspended schedule for a change request.
*/
export type ChangeRequestScheduleSchemaOneOfFive = {
/** Why the scheduled was suspended. */
reason: string;
/** When Unleash would have attempted to apply this change request if the schedule was not suspended. */
scheduledAt: string;
/** The status of the schedule. */
status: ChangeRequestScheduleSchemaOneOfFiveStatus;
};

View File

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

View File

@ -7,11 +7,10 @@
/**
* The status of the schedule.
*/
export type ChangeRequestScheduleSchemaStatus =
(typeof ChangeRequestScheduleSchemaStatus)[keyof typeof ChangeRequestScheduleSchemaStatus];
export type ChangeRequestScheduleSchemaOneOfStatus =
(typeof ChangeRequestScheduleSchemaOneOfStatus)[keyof typeof ChangeRequestScheduleSchemaOneOfStatus];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestScheduleSchemaStatus = {
export const ChangeRequestScheduleSchemaOneOfStatus = {
pending: 'pending',
failed: 'failed',
} as const;

View File

@ -0,0 +1,23 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestScheduleSchemaOneOfThreeStatus } from './changeRequestScheduleSchemaOneOfThreeStatus';
/**
* A failed schedule for a change request.
*/
export type ChangeRequestScheduleSchemaOneOfThree = {
/**
* The reason the scheduled failed to apply. Deprecated in favor of the `reason` property.
* @deprecated
*/
failureReason?: string | null;
/** The reason the scheduled failed to apply. */
reason: string;
/** When Unleash last attempted to apply this change request. */
scheduledAt: string;
/** The status of the schedule. */
status: ChangeRequestScheduleSchemaOneOfThreeStatus;
};

View File

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

View File

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

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

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

@ -0,0 +1,21 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateActionsSchemaActionsItem } from './createActionsSchemaActionsItem';
import type { CreateActionsSchemaMatch } from './createActionsSchemaMatch';
/**
* An action set defines actions that Unleash performs when an observable event is matched.
*/
export interface CreateActionsSchema {
/** The list of actions to execute in sequential order when the action set is triggered */
actions: CreateActionsSchemaActionsItem[];
/** The id of the service account that will execute the action */
actor: number;
/** Defines a matching rule for the observable event that will trigger the action set */
match: CreateActionsSchemaMatch;
/** The name of the action set */
name: string;
}

View File

@ -0,0 +1,15 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateActionsSchemaActionsItemParams } from './createActionsSchemaActionsItemParams';
export type CreateActionsSchemaActionsItem = {
/** The name of the action to execute */
action: string;
/** A map of parameters to pass to the action */
params?: CreateActionsSchemaActionsItemParams;
/** The order in which the action should be executed */
sortOrder: number;
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A map of parameters to pass to the action
*/
export type CreateActionsSchemaActionsItemParams = { [key: string]: any };

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateActionsSchemaMatchPayload } from './createActionsSchemaMatchPayload';
/**
* Defines a matching rule for the observable event that will trigger the action set
*/
export type CreateActionsSchemaMatch = {
/** Match the payload of the observable event */
payload: CreateActionsSchemaMatchPayload;
/** Match the source of the observable event */
source: string;
/** Match the source id of the observable event */
sourceId: string;
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Match the payload of the observable event
*/
export type CreateActionsSchemaMatchPayload = { [key: string]: any };

View File

@ -8,6 +8,8 @@
* Describes the properties required to create or update an incoming webhook.
*/
export interface CreateIncomingWebhookSchema {
/** A more detailed description of the incoming webhook and its intended use. */
description?: string | null;
/** Whether the incoming webhook is currently enabled. If not specified, defaults to true. */
enabled?: boolean;
/** The incoming webhook name. Must be URL-safe. */

View File

@ -118,6 +118,7 @@ export const EventSchemaType = {
'change-request-cancelled': 'change-request-cancelled',
'change-request-sent-to-review': 'change-request-sent-to-review',
'scheduled-change-request-executed': 'scheduled-change-request-executed',
'change-request-schedule-suspended': 'change-request-schedule-suspended',
'change-request-applied': 'change-request-applied',
'change-request-scheduled': 'change-request-scheduled',
'change-request-scheduled-application-success':

View File

@ -9,17 +9,17 @@
*/
export interface FeedbackSchema {
/** Details aspects of the service or product that could benefit from enhancements or modifications. Aids in pinpointing areas needing attention for improvement. */
areasForImprovement: string;
areasForImprovement: string | null;
/** The category of the feedback. */
category: string;
/** The date and time when the feedback was provided. */
createdAt: string;
/** A score indicating the difficulty experienced by the user. */
difficultyScore: number;
difficultyScore: number | null;
/** The unique identifier of the feedback. */
id: number;
/** This field is for users to mention what they liked. */
positive: string;
positive: string | null;
/** The type of user providing the feedback. */
userType: string;
userType: string | null;
}

View File

@ -12,10 +12,14 @@ export interface IncomingWebhookSchema {
createdAt: string;
/** The ID of the user that created this incoming webhook. */
createdByUserId: number;
/** A more detailed description of the incoming webhook and its intended use. */
description?: string | null;
/** Whether the incoming webhook is currently enabled. If not specified, defaults to true. */
enabled: boolean;
/** The incoming webhook's ID. Incoming webhook IDs are incrementing integers. In other words, a more recently created incoming webhook will always have a higher ID than an older one. */
id: number;
/** The incoming webhook name. Must be URL-safe. */
name: string;
/** The full URL that should be used to call the incoming webhook. This property is only returned for newly created or updated incoming webhooks. */
url?: string;
}

View File

@ -10,5 +10,5 @@ import type { IncomingWebhookTokenSchema } from './incomingWebhookTokenSchema';
*/
export interface IncomingWebhookTokensSchema {
/** A list of incoming webhook tokens. */
incoming_webhook_tokens: IncomingWebhookTokenSchema[];
incomingWebhookTokens: IncomingWebhookTokenSchema[];
}

View File

@ -10,5 +10,5 @@ import type { IncomingWebhookSchema } from './incomingWebhookSchema';
*/
export interface IncomingWebhooksSchema {
/** A list of incoming webhooks. */
incoming_webhooks: IncomingWebhookSchema[];
incomingWebhooks: IncomingWebhookSchema[];
}

View File

@ -7,6 +7,12 @@
export * from './_exportFormat';
export * from './_exportParams';
export * from './accessOverviewSchema';
export * from './actionsListSchema';
export * from './actionsSchema';
export * from './actionsSchemaActionsItem';
export * from './actionsSchemaActionsItemParams';
export * from './actionsSchemaMatch';
export * from './actionsSchemaMatchPayload';
export * from './addAccessToProject400';
export * from './addAccessToProject401';
export * from './addAccessToProject403';
@ -215,7 +221,12 @@ export * from './changeRequestOneOrManyCreateSchemaOneOfTwooneAction';
export * from './changeRequestOneOrManyCreateSchemaOneOfTwothree';
export * from './changeRequestOneOrManyCreateSchemaOneOfTwothreeAction';
export * from './changeRequestScheduleSchema';
export * from './changeRequestScheduleSchemaStatus';
export * from './changeRequestScheduleSchemaOneOf';
export * from './changeRequestScheduleSchemaOneOfFive';
export * from './changeRequestScheduleSchemaOneOfFiveStatus';
export * from './changeRequestScheduleSchemaOneOfStatus';
export * from './changeRequestScheduleSchemaOneOfThree';
export * from './changeRequestScheduleSchemaOneOfThreeStatus';
export * from './changeRequestScheduledQueryParamsSchema';
export * from './changeRequestScheduledQueryParamsSchemaFeature';
export * from './changeRequestScheduledQueryParamsSchemaStrategyId';
@ -252,6 +263,9 @@ export * from './checkDependenciesExist401';
export * from './checkDependenciesExist403';
export * from './clientApplicationSchema';
export * from './clientApplicationSchemaStarted';
export * from './clientBulkMetrics400';
export * from './clientBulkMetrics413';
export * from './clientBulkMetrics415';
export * from './clientFeatureSchema';
export * from './clientFeaturesQuerySchema';
export * from './clientFeaturesSchema';
@ -276,6 +290,11 @@ export * from './contextFieldSchema';
export * from './contextFieldStrategiesSchema';
export * from './contextFieldStrategiesSchemaStrategiesItem';
export * from './contextFieldsSchema';
export * from './createActionsSchema';
export * from './createActionsSchemaActionsItem';
export * from './createActionsSchemaActionsItemParams';
export * from './createActionsSchemaMatch';
export * from './createActionsSchemaMatchPayload';
export * from './createAddon400';
export * from './createAddon401';
export * from './createAddon403';
@ -690,6 +709,9 @@ export * from './instanceAdminStatsSchemaProductionChanges';
export * from './invoicesSchema';
export * from './invoicesSchemaItem';
export * from './legalValueSchema';
export * from './licenseCheckSchema';
export * from './licenseReadSchema';
export * from './licenseUpdateSchema';
export * from './listParentOptions401';
export * from './listParentOptions403';
export * from './listParentOptions404';
@ -709,6 +731,10 @@ export * from './notificationsSchema';
export * from './notificationsSchemaItem';
export * from './notificationsSchemaItemCreatedBy';
export * from './notificationsSchemaItemNotificationType';
export * from './observableEventSchema';
export * from './observableEventSchemaPayload';
export * from './observableEventSchemaSource';
export * from './observableEventsSchema';
export * from './oidcSettingsSchema';
export * from './oidcSettingsSchemaDefaultRootRole';
export * from './oidcSettingsSchemaIdTokenSigningAlgorithm';
@ -1025,6 +1051,10 @@ export * from './updateGroup401';
export * from './updateGroup403';
export * from './updateGroup404';
export * from './updateGroup409';
export * from './updateLicense400';
export * from './updateLicense401';
export * from './updateLicense403';
export * from './updateLicense415';
export * from './updateProject400';
export * from './updateProject401';
export * from './updateProject403';

View File

@ -0,0 +1,15 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A model representing a license check response.
*/
export interface LicenseCheckSchema {
/** Whether or not the current Unleash license is considered valid */
isValid: boolean;
/** Message describing the current state of the Unleash license */
message?: string;
}

View File

@ -0,0 +1,21 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A model representing a license response.
*/
export interface LicenseReadSchema {
/** Name of the customer that owns the license. This is the name of the company that purchased the license. */
customer?: string;
/** Date when the license expires. */
expireAt?: string;
/** Name of plan that the license is for. */
plan?: string;
/** Number of seats in the license. */
seats?: number;
/** The actual license token. */
token: string;
}

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A model representing a set license token.
*/
export interface LicenseUpdateSchema {
/** The actual license token. */
token: string;
}

View File

@ -0,0 +1,25 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ObservableEventSchemaPayload } from './observableEventSchemaPayload';
import type { ObservableEventSchemaSource } from './observableEventSchemaSource';
/**
* An object describing an observable event.
*/
export interface ObservableEventSchema {
/** The date and time of when the observable event was created. */
createdAt: string;
/** The ID of the incoming webhook token that created this observable event. Only present if the observable event was created by an incoming webhook. */
createdByIncomingWebhookTokenId?: number;
/** The observable event's ID. Observable event IDs are incrementing integers. In other words, a more recently created observable event will always have a higher ID than an older one. */
id: number;
/** The payload of the observable event. */
payload?: ObservableEventSchemaPayload;
/** The observable event source type. Should be used along with `sourceId` to uniquely identify the resource that created this observable event. */
source: ObservableEventSchemaSource;
/** The ID of the source that created this observable event. Should be used along with `source` to uniquely identify the resource that created this observable event. */
sourceId: number;
}

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The payload of the observable event.
*/
export type ObservableEventSchemaPayload = { [key: string]: any };

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The observable event source type. Should be used along with `sourceId` to uniquely identify the resource that created this observable event.
*/
export type ObservableEventSchemaSource =
(typeof ObservableEventSchemaSource)[keyof typeof ObservableEventSchemaSource];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ObservableEventSchemaSource = {
'incoming-webhook': 'incoming-webhook',
} as const;

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ObservableEventSchema } from './observableEventSchema';
/**
* A response model with a list of observable events.
*/
export interface ObservableEventsSchema {
/** A list of observable events. */
observable_events: ObservableEventSchema[];
}

View File

@ -9,13 +9,13 @@
*/
export interface ProvideFeedbackSchema {
/** Details aspects of the service or product that could benefit from enhancements or modifications. Aids in pinpointing areas needing attention for improvement. */
areasForImprovement?: string;
areasForImprovement?: string | null;
/** The category of the feedback. */
category: string;
/** A score indicating the difficulty experienced by the user. */
difficultyScore?: number;
difficultyScore?: number | null;
/** This field is for users to mention what they liked. */
positive?: string;
positive?: string | null;
/** The type of user providing the feedback. */
userType?: string;
userType?: string | null;
}

View File

@ -118,6 +118,7 @@ export const SearchEventsSchemaType = {
'change-request-cancelled': 'change-request-cancelled',
'change-request-sent-to-review': 'change-request-sent-to-review',
'scheduled-change-request-executed': 'scheduled-change-request-executed',
'change-request-schedule-suspended': 'change-request-schedule-suspended',
'change-request-applied': 'change-request-applied',
'change-request-scheduled': 'change-request-scheduled',
'change-request-scheduled-application-success':

View File

@ -22,6 +22,8 @@ export interface UiConfigSchema {
emailEnabled?: boolean;
/** What kind of Unleash instance it is: Enterprise, Pro, or Open source */
environment?: string;
/** The URI path at which the feedback endpoint is listening. */
feedbackUriPath?: string;
/** Additional (largely experimental) features that are enabled in this Unleash instance. */
flags?: UiConfigSchemaFlags;
/** The list of origins that the front-end API should accept requests from. */

View File

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

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

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

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