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

feat: update orval schema (#8595)

This commit is contained in:
Jaanus Sellin 2024-10-30 14:33:51 +02:00 committed by GitHub
parent a1d6795533
commit 8259b9e9f6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 54 additions and 22 deletions

View File

@ -42,7 +42,7 @@ export interface EventSchema {
*/ */
id: number; id: number;
/** /**
* **[Experimental]** The concise, human-readable name of the event. * The concise, human-readable name of the event.
* @nullable * @nullable
*/ */
label?: string | null; label?: string | null;
@ -57,7 +57,7 @@ export interface EventSchema {
*/ */
project?: string | null; project?: string | null;
/** /**
* **[Experimental]** A markdown-formatted summary of the event. * A markdown-formatted summary of the event.
* @nullable * @nullable
*/ */
summary?: string | null; summary?: string | null;

View File

@ -15,8 +15,6 @@ import type { VariantSchema } from './variantSchema';
* A feature flag definition * A feature flag definition
*/ */
export interface FeatureSearchResponseSchema { export interface FeatureSearchResponseSchema {
/** `true` if the feature is archived */
archived?: boolean;
/** /**
* The date the feature was archived * The date the feature was archived
* @nullable * @nullable

View File

@ -5,7 +5,7 @@
*/ */
/** /**
* A [feature flag type](https://docs.getunleash.io/reference/feature-toggles#feature-flag-types. * A [feature flag type](https://docs.getunleash.io/reference/feature-toggles#feature-flag-types).
*/ */
export interface FeatureTypeSchema { export interface FeatureTypeSchema {
/** A description of what this feature flag type is intended to be used for. */ /** A description of what this feature flag type is intended to be used for. */

View File

@ -13,7 +13,7 @@ import type { PersonalDashboardProjectDetailsSchemaRolesItem } from './personalD
* Project details in personal dashboard * Project details in personal dashboard
*/ */
export interface PersonalDashboardProjectDetailsSchema { export interface PersonalDashboardProjectDetailsSchema {
/** Insights for the project */ /** Insights for the project, including flag data and project health information. */
insights: PersonalDashboardProjectDetailsSchemaInsights; insights: PersonalDashboardProjectDetailsSchemaInsights;
/** The latest events for the project. */ /** The latest events for the project. */
latestEvents: PersonalDashboardProjectDetailsSchemaLatestEventsItem[]; latestEvents: PersonalDashboardProjectDetailsSchemaLatestEventsItem[];
@ -21,8 +21,6 @@ export interface PersonalDashboardProjectDetailsSchema {
onboardingStatus: PersonalDashboardProjectDetailsSchemaOnboardingStatus; onboardingStatus: PersonalDashboardProjectDetailsSchemaOnboardingStatus;
/** The users and/or groups that have the "owner" role in this project. If no such users or groups exist, the list will contain the "system" owner instead. */ /** The users and/or groups that have the "owner" role in this project. If no such users or groups exist, the list will contain the "system" owner instead. */
owners: PersonalDashboardProjectDetailsSchemaOwners; owners: PersonalDashboardProjectDetailsSchemaOwners;
/** /** The list of roles that the user has in this project. */
* The list of roles that the user has in this project.
*/
roles: PersonalDashboardProjectDetailsSchemaRolesItem[]; roles: PersonalDashboardProjectDetailsSchemaRolesItem[];
} }

View File

@ -5,22 +5,44 @@
*/ */
/** /**
* Insights for the project * Insights for the project, including flag data and project health information.
*/ */
export type PersonalDashboardProjectDetailsSchemaInsights = { export type PersonalDashboardProjectDetailsSchemaInsights = {
/** /**
* The average health score in the current window of the last 4 weeks * The number of active flags that are not stale or potentially stale
* @minimum 0
*/
activeFlags: number;
/**
* The project's average health score over the last 4 weeks
* @minimum 0
* @nullable * @nullable
*/ */
avgHealthCurrentWindow: number | null; avgHealthCurrentWindow: number | null;
/** /**
* The average health score in the previous 4 weeks before the current window * The project's average health score over the previous 4-week window
* @minimum 0
* @nullable * @nullable
*/ */
avgHealthPastWindow: number | null; avgHealthPastWindow: number | null;
totalFlags: number; /**
activeFlags: number; * The project's current health score
staleFlags: number; * @minimum 0
potentiallyStaleFlags: number; */
health: number; health: number;
/**
* The number of potentially stale flags as calculated by Unleash
* @minimum 0
*/
potentiallyStaleFlags: number;
/**
* The current number of flags that have been manually marked as stale
* @minimum 0
*/
staleFlags: number;
/**
* The current number of non-archived flags
* @minimum 0
*/
totalFlags: number;
}; };

View File

@ -8,6 +8,8 @@
* An event summary * An event summary
*/ */
export type PersonalDashboardProjectDetailsSchemaLatestEventsItem = { export type PersonalDashboardProjectDetailsSchemaLatestEventsItem = {
/** When the event was recorded */
createdAt: string;
/** Which user created this event */ /** Which user created this event */
createdBy: string; createdBy: string;
/** URL used for the user profile image of the event author */ /** URL used for the user profile image of the event author */
@ -22,5 +24,4 @@ export type PersonalDashboardProjectDetailsSchemaLatestEventsItem = {
* @nullable * @nullable
*/ */
summary: string | null; summary: string | null;
createdAt: string;
}; };

View File

@ -14,6 +14,4 @@ export type PersonalDashboardProjectDetailsSchemaRolesItemType =
export const PersonalDashboardProjectDetailsSchemaRolesItemType = { export const PersonalDashboardProjectDetailsSchemaRolesItemType = {
custom: 'custom', custom: 'custom',
project: 'project', project: 'project',
root: 'root',
'custom-root': 'custom-root',
} as const; } as const;

View File

@ -5,13 +5,22 @@
*/ */
export type PersonalDashboardSchemaProjectsItem = { export type PersonalDashboardSchemaProjectsItem = {
/** The number of features this project has */ /**
* The number of features this project has
* @minimum 0
*/
featureCount: number; featureCount: number;
/** An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100 */ /**
* An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100
* @minimum 0
*/
health: number; health: number;
/** The id of the project */ /** The id of the project */
id: string; id: string;
/** The number of members this project has */ /**
* The number of members this project has
* @minimum 0
*/
memberCount: number; memberCount: number;
/** The name of the project */ /** The name of the project */
name: string; name: string;

View File

@ -58,6 +58,10 @@ export type SearchFeaturesParams = {
* The flag to indicate if the favorite features should be returned first. By default it is set to false. * The flag to indicate if the favorite features should be returned first. By default it is set to false.
*/ */
favoritesFirst?: string; favoritesFirst?: string;
/**
* Whether to get results for archived feature flags or active feature flags. If `true`, Unleash will return only archived flags. If `false`, it will return only active flags.
*/
archived?: string;
/** /**
* The date the feature was created. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER. * The date the feature was created. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER.
*/ */

View File

@ -55,6 +55,8 @@ export interface UiConfigSchema {
* @deprecated * @deprecated
*/ */
strategySegmentsLimit?: number; strategySegmentsLimit?: number;
/** Whether Unleash AI is available. */
unleashAIAvailable?: boolean;
/** The URL of the Unleash instance. */ /** The URL of the Unleash instance. */
unleashUrl: string; unleashUrl: string;
/** The current version of Unleash */ /** The current version of Unleash */