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

chore: re-generate openapi (#10450)

Update documentation to replace 'server-side' with 'backend' in API schemas
This commit is contained in:
Tymoteusz Czech 2025-08-01 10:50:03 +02:00 committed by GitHub
parent 0ac997e63e
commit 2629705501
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 8 additions and 8 deletions

View File

@ -8,7 +8,7 @@ import type { BulkRegistrationSchemaSdkType } from './bulkRegistrationSchemaSdkT
import type { DateSchema } from './dateSchema.js';
/**
* An application registration. Defines the format POSTed by our server-side SDKs when they're starting up
* An application registration. Defines the format POSTed by our backend SDKs when they're starting up
*/
export interface BulkRegistrationSchema {
/** The name of the application that is evaluating toggles */

View File

@ -8,7 +8,7 @@ import type { ClientFeaturesQuerySchema } from './clientFeaturesQuerySchema.js';
import type { ClientSegmentSchema } from './clientSegmentSchema.js';
/**
* Configuration data for server-side SDKs for evaluating feature flags.
* Configuration data for backend SDKs for evaluating feature flags.
*/
export interface ClientFeaturesSchema {
/** A list of feature flags with their configuration */

View File

@ -6,13 +6,13 @@
import type { EdgeTokenSchemaType } from './edgeTokenSchemaType.js';
/**
* A representation of a client token, limiting access to [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens) (used by serverside SDKs) or [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens) (used by proxy SDKs)
* A representation of a client token, limiting access to [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#backend-tokens) (used by serverside SDKs) or [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens) (used by proxy SDKs)
*/
export interface EdgeTokenSchema {
/** The list of projects this token has access to. If the token has access to specific projects they will be listed here. If the token has access to all projects it will be represented as [`*`] */
projects: string[];
/** The actual token value. [Unleash API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys) are comprised of three parts. <project(s)>:<environment>.randomcharacters */
token: string;
/** The [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys)'s **type**. Unleash supports three different types of API tokens ([ADMIN](https://docs.getunleash.io/reference/api-tokens-and-client-keys#admin-tokens), [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens), [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens)). They all have varying access, so when validating a token it's important to know what kind you're dealing with */
/** The [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys)'s **type**. Unleash supports three different types of API tokens ([ADMIN](https://docs.getunleash.io/reference/api-tokens-and-client-keys#admin-tokens), [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#backend-tokens), [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens)). They all have varying access, so when validating a token it's important to know what kind you're dealing with */
type: EdgeTokenSchemaType;
}

View File

@ -5,7 +5,7 @@
*/
/**
* The [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys)'s **type**. Unleash supports three different types of API tokens ([ADMIN](https://docs.getunleash.io/reference/api-tokens-and-client-keys#admin-tokens), [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens), [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens)). They all have varying access, so when validating a token it's important to know what kind you're dealing with
* The [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys)'s **type**. Unleash supports three different types of API tokens ([ADMIN](https://docs.getunleash.io/reference/api-tokens-and-client-keys#admin-tokens), [CLIENT](https://docs.getunleash.io/reference/api-tokens-and-client-keys#backend-tokens), [FRONTEND](https://docs.getunleash.io/reference/api-tokens-and-client-keys#frontend-tokens)). They all have varying access, so when validating a token it's important to know what kind you're dealing with
*/
export type EdgeTokenSchemaType =
(typeof EdgeTokenSchemaType)[keyof typeof EdgeTokenSchemaType];

View File

@ -17,7 +17,7 @@ export interface ResourceLimitsSchema {
/** The maximum number of action set definitions per project allowed. */
actionSetsPerProject: number;
/**
* The maximum number of SDK and admin API tokens you can have at the same time. This limit applies only to server-side and client-side SDK tokens and to admin tokens. Personal access tokens are not subject to this limit. The limit applies to the total number of tokens across all projects in your organization.
* The maximum number of SDK and admin API tokens you can have at the same time. This limit applies only to backend and frontend SDK tokens and to admin tokens. Personal access tokens are not subject to this limit. The limit applies to the total number of tokens across all projects in your organization.
* @minimum 0
*/
apiTokens: number;

View File

@ -5,7 +5,7 @@
*/
/**
* An unknown flag that has been reported by the system
* An unknown flag report
*/
export interface UnknownFlagSchema {
/** The name of the application that reported the unknown flag. */

View File

@ -6,7 +6,7 @@
import type { UnknownFlagSchema } from './unknownFlagSchema.js';
/**
* A list of unknown flags that have been reported by the system
* A list of unknown flag reports
*/
export interface UnknownFlagsResponseSchema {
/** The list of recently reported unknown flags. */