From 348c292b45cade13468e811c87ec0f67685457e3 Mon Sep 17 00:00:00 2001 From: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com> Date: Thu, 15 Oct 2026 21:17:00 +0000 Subject: [PATCH] docs: Mark the flag override API with the experimental tag The public override surface already said in prose that flag overrides are experimental and subject to change. The sentence now carries the @experimental tag, the TSDoc modifier that TypeDoc renders as a badge on the declaration and that editors show as a separate tag line, so the status is visible without reading the comment body. The prose stays as the tag's text. This is the form the client-side debug override API already uses. --- .../shared/common/src/api/data/LDEvaluationReason.ts | 2 +- .../src/api/options/LDDataSystemOptions.ts | 12 +++++++----- .../src/api/subsystems/LDOverrideSource.ts | 4 ++-- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/packages/shared/common/src/api/data/LDEvaluationReason.ts b/packages/shared/common/src/api/data/LDEvaluationReason.ts index c9926ce8f2..72f5ed8579 100644 --- a/packages/shared/common/src/api/data/LDEvaluationReason.ts +++ b/packages/shared/common/src/api/data/LDEvaluationReason.ts @@ -68,7 +68,7 @@ export interface LDEvaluationReason { * Otherwise it is false or undefined. In the JSON representation of the reason the property is * present only when it is true. * - * Flag overrides are currently experimental and subject to change. + * @experimental Flag overrides are currently experimental and subject to change. */ overrideAffected?: boolean; } diff --git a/packages/shared/sdk-server/src/api/options/LDDataSystemOptions.ts b/packages/shared/sdk-server/src/api/options/LDDataSystemOptions.ts index 27769b1704..cb9dfef0fd 100644 --- a/packages/shared/sdk-server/src/api/options/LDDataSystemOptions.ts +++ b/packages/shared/sdk-server/src/api/options/LDDataSystemOptions.ts @@ -79,8 +79,7 @@ export interface LDDataSystemOptions { fdv1Fallback?: FDv1FallbackConfiguration | null; /** - * Configures an override source. Flag overrides are currently experimental and subject to - * change. + * Configures an override source. * * The source supplies flag and segment definitions that take precedence over data received * from LaunchDarkly on a per-key basis. Overrides let an operator force one or more flags to a @@ -94,13 +93,14 @@ export interface LDDataSystemOptions { * Some implementations provide the source object itself, while others provide a factory * function that creates the source based on the SDK configuration. This property accepts * either. + * + * @experimental Flag overrides are currently experimental and subject to change. */ overrides?: LDOverrideSourceOptions; } /** - * Configuration of the file-based override source. Flag overrides are currently experimental and - * subject to change. + * Configuration of the file-based override source. * * The source reads flag and segment overrides from one or more local files and reloads them as * the files change. The files use the same document format as the file data source: a JSON or @@ -121,6 +121,8 @@ export interface LDDataSystemOptions { * }, * }); * ``` + * + * @experimental Flag overrides are currently experimental and subject to change. */ export interface FileOverrideSourceOptions { type: 'file'; @@ -171,7 +173,7 @@ export interface FileOverrideSourceOptions { * The ways an override source can be configured: the file-based source, a source object, or a * factory function that creates a source from the client context. * - * Flag overrides are currently experimental and subject to change. + * @experimental Flag overrides are currently experimental and subject to change. */ export type LDOverrideSourceOptions = | FileOverrideSourceOptions diff --git a/packages/shared/sdk-server/src/api/subsystems/LDOverrideSource.ts b/packages/shared/sdk-server/src/api/subsystems/LDOverrideSource.ts index dbe06e5192..11617e3039 100644 --- a/packages/shared/sdk-server/src/api/subsystems/LDOverrideSource.ts +++ b/packages/shared/sdk-server/src/api/subsystems/LDOverrideSource.ts @@ -5,7 +5,7 @@ import { LDKeyedFeatureStoreItem } from './LDFeatureStore'; * interface and passes it to {@link LDOverrideSource.start}. Override sources call it. They do * not implement it. * - * Flag overrides are currently experimental and subject to change. + * @experimental Flag overrides are currently experimental and subject to change. */ export interface LDOverrideSink { /** @@ -41,7 +41,7 @@ export interface LDOverrideSink { * * Configure an override source with the `overrides` property of the data system options. * - * Flag overrides are currently experimental and subject to change. + * @experimental Flag overrides are currently experimental and subject to change. */ export interface LDOverrideSource { /**