Skip to content

docs: Mark the flag override API with the experimental tag #2106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kinyoklion merged 1 commit into from
Oct 16, 2026
+10 −8
Merged

docs: Mark the flag override API with the experimental tag #2106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/shared/common/src/api/data/LDEvaluationReason.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
12 changes: 7 additions & 5 deletions packages/shared/sdk-server/src/api/options/LDDataSystemOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -121,6 +121,8 @@ export interface LDDataSystemOptions {
* },
* });
* ```
*
* @experimental Flag overrides are currently experimental and subject to change.
*/
export interface FileOverrideSourceOptions {
type: 'file';
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions packages/shared/sdk-server/src/api/subsystems/LDOverrideSource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down Expand Up @@ -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 {
/**
Expand Down
Loading