From 03bcf3c5c2cbc529096859ece6c9d6a4000f29a9 Mon Sep 17 00:00:00 2001 From: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Date: Thu, 19 Mar 2026 08:21:49 +0000 Subject: [PATCH] chore: update sdk readmes Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> --- docs/reference/other-technologies/cli.mdx | 3 ++ docs/reference/sdks/client/kotlin.mdx | 14 +++---- docs/reference/sdks/client/swift.mdx | 2 +- docs/reference/sdks/client/web/angular.mdx | 2 +- docs/reference/sdks/client/web/index.mdx | 2 +- docs/reference/sdks/client/web/react.mdx | 2 +- docs/reference/sdks/server/dart.mdx | 42 ++++++++++++++++--- docs/reference/sdks/server/dotnet.mdx | 2 +- docs/reference/sdks/server/go.mdx | 4 +- docs/reference/sdks/server/java.mdx | 2 +- .../sdks/server/javascript/index.mdx | 2 +- .../sdks/server/javascript/nestjs.mdx | 2 +- docs/reference/sdks/server/php.mdx | 2 +- docs/reference/sdks/server/python.mdx | 13 +++++- docs/reference/sdks/server/ruby.mdx | 2 +- docs/reference/sdks/server/rust.mdx | 8 ++-- src/datasets/sdks/sdk-compatibility.json | 12 +++--- 17 files changed, 80 insertions(+), 36 deletions(-) diff --git a/docs/reference/other-technologies/cli.mdx b/docs/reference/other-technologies/cli.mdx index 51f76d572..ff28c50a1 100644 --- a/docs/reference/other-technologies/cli.mdx +++ b/docs/reference/other-technologies/cli.mdx @@ -210,6 +210,9 @@ openfeature generate typescript --output ./src/flags See [here](https://github.com/open-feature/cli/blob/main/docs/commands/openfeature_generate.md) for all available options. +> **_NOTE:_** +> Angular generated code requires `@openfeature/angular-sdk` version `1.1.0` or newer. + ### `pull` Fetch feature flag configurations from a remote source. diff --git a/docs/reference/sdks/client/kotlin.mdx b/docs/reference/sdks/client/kotlin.mdx index dfcf62ebe..141bcbec9 100644 --- a/docs/reference/sdks/client/kotlin.mdx +++ b/docs/reference/sdks/client/kotlin.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from kotlin-sdk. Edits should be made here: https://github.com/open-feature/kotlin-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; @@ -20,8 +20,8 @@ import MCPInstall from '@site/src/partials/mcp-install'; Specification - - Release + + Release
@@ -41,10 +41,10 @@ import MCPInstall from '@site/src/partials/mcp-install'; The following [Kotlin Multiplatform Targets](https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-dsl-reference.html#targets) are supported: | Supported | Platform | Supported versions | -| --------- | -------------------- | ------------------------------------------------------------------------------ | +| --------- | -------------------- |--------------------------------------------------------------------------------| | ✅ | Android | SDK 21+ | | ✅ | JVM | JDK 11+ | -| ✅ | Native | Linux x64 | +| ✅ | Native | Linux x64, iosSimulatorArm64, iosArm64 | | ❌ | Native | [Other native targets](https://kotlinlang.org/docs/native-target-support.html) | | ✅ | Javascript (Node.js) | | | ✅ | Javascript (Browser) | | @@ -67,7 +67,7 @@ Installation is preferred via Maven Central. ```kotlin dependencies { - api("dev.openfeature:kotlin-sdk:0.7.1") + api("dev.openfeature:kotlin-sdk:0.7.2") } ``` @@ -77,7 +77,7 @@ dependencies { kotlin { sourceSets { commonMain.dependencies { - api("dev.openfeature:kotlin-sdk:0.7.1") + api("dev.openfeature:kotlin-sdk:0.7.2") } } } diff --git a/docs/reference/sdks/client/swift.mdx b/docs/reference/sdks/client/swift.mdx index 3d6e54466..283696cd2 100644 --- a/docs/reference/sdks/client/swift.mdx +++ b/docs/reference/sdks/client/swift.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk. Edits should be made here: https://github.com/open-feature/swift-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/client/web/angular.mdx b/docs/reference/sdks/client/web/angular.mdx index dcefea456..1bd6477ce 100644 --- a/docs/reference/sdks/client/web/angular.mdx +++ b/docs/reference/sdks/client/web/angular.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:47 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/sdks/client/web/index.mdx b/docs/reference/sdks/client/web/index.mdx index b9d09d016..bcf9bd7bc 100644 --- a/docs/reference/sdks/client/web/index.mdx +++ b/docs/reference/sdks/client/web/index.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/client/web/react.mdx b/docs/reference/sdks/client/web/react.mdx index 8ea2ec1f9..913ca16d1 100644 --- a/docs/reference/sdks/client/web/react.mdx +++ b/docs/reference/sdks/client/web/react.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/dart.mdx b/docs/reference/sdks/server/dart.mdx index 68b8e9596..6781b3c4c 100644 --- a/docs/reference/sdks/server/dart.mdx +++ b/docs/reference/sdks/server/dart.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from dart-server-sdk. Edits should be made here: https://github.com/open-feature/dart-server-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:47 GMT+0000 (Coordinated Universal Time) -->

@@ -19,8 +19,8 @@ Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time) - - Release + + Release @@ -56,7 +56,7 @@ Dart language version: [3.9.2](https://dart.dev/get-dart/archive) ```yaml dependencies: - openfeature_dart_server_sdk: ^0.0.16 + openfeature_dart_server_sdk: ^0.0.17 ``` ### Then run: @@ -123,6 +123,7 @@ See [here](https://pub.dev/documentation/openfeature_dart_server_sdk/latest/) fo | ✅ | [Providers](#providers) | Integrate with a commercial, open source, or in-house feature management tool. | | ✅ | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). | | ✅ | [Hooks](#hooks) | Add functionality to various stages of the flag evaluation life-cycle. | +| ✅ | [Tracking](#tracking) | Associate user actions with feature flag evaluations for experimentation. | | ✅ | [Logging](#logging) | Integrate with popular logging packages. | | ✅ | [Domains](#domains) | Logically bind clients with providers. | | ✅ | [Eventing](#eventing) | React to state changes in the provider or flag management system. | @@ -214,13 +215,33 @@ For example, a flag enhancing the appearance of a UI component might drive user Note that some providers may not support tracking; check the documentation for your provider for more information. +```dart +import 'package:openfeature_dart_server_sdk/open_feature_api.dart'; +import 'package:openfeature_dart_server_sdk/feature_provider.dart'; + +final api = OpenFeatureAPI(); +final client = api.getClient('my-app'); + +// Track a user action associated with a feature flag evaluation +await client.track( + 'checkout-completed', + context: EvaluationContext(attributes: { + 'user': 'user-123', + }), + trackingDetails: TrackingEventDetails( + value: 99.99, + attributes: {'currency': 'USD'}, + ), +); +``` + ### Logging Note that in accordance with the OpenFeature specification, the SDK doesn't generally log messages during flag evaluation. #### Logging Hook -The Dart SDK includes a `LoggingHook`, which logs detailed information at key points during flag evaluation, using [TBD](https://github.com/open-feature/dart-server-sdk/blob/main/TBD) structured logging API. +The Dart SDK includes a `LoggingHook`, which logs detailed information at key points during flag evaluation, using the [package:logging](https://pub.dev/packages/logging) structured logging API. This hook can be particularly helpful for troubleshooting and debugging; simply attach it at the global, client or invocation level and ensure your log level is set to "debug". ##### Usage example @@ -387,7 +408,7 @@ transactionManager.popContext(); To develop a provider, you need to create a new project and include the OpenFeature SDK as a dependency. This can be a new repository or included in [the existing contrib repository](https://github.com/open-feature/dart-server-sdk-contrib) available under the OpenFeature organization. -You’ll then need to write the provider by implementing the `FeatureProvider` interface exported by the OpenFeature SDK. +You'll then need to write the provider by implementing the `FeatureProvider` interface exported by the OpenFeature SDK. ```dart import 'dart:async'; @@ -418,6 +439,15 @@ class MyCustomProvider implements FeatureProvider { // Clean up resources } + @override + Future track( + String trackingEventName, { + Map? evaluationContext, + TrackingEventDetails? trackingDetails, + }) async { + // Send tracking event to your backend, or no-op if unsupported + } + @override Future> getBooleanFlag( String flagKey, diff --git a/docs/reference/sdks/server/dotnet.mdx b/docs/reference/sdks/server/dotnet.mdx index 775bf73eb..4db293360 100644 --- a/docs/reference/sdks/server/dotnet.mdx +++ b/docs/reference/sdks/server/dotnet.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk. Edits should be made here: https://github.com/open-feature/dotnet-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/go.mdx b/docs/reference/sdks/server/go.mdx index 962189044..93720a1c2 100644 --- a/docs/reference/sdks/server/go.mdx +++ b/docs/reference/sdks/server/go.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk. Edits should be made here: https://github.com/open-feature/go-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; @@ -45,7 +45,7 @@ import MCPInstall from '@site/src/partials/mcp-install'; ### Requirements -Go language version: [1.24](https://go.dev/doc/devel/release#go1.24.0) +Go language version: [1.25](https://go.dev/doc/devel/release#go1.25.0) > [!NOTE] > The OpenFeature Go SDK only supports currently maintained Go language versions. diff --git a/docs/reference/sdks/server/java.mdx b/docs/reference/sdks/server/java.mdx index dc932dc5a..9647a27de 100644 --- a/docs/reference/sdks/server/java.mdx +++ b/docs/reference/sdks/server/java.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk. Edits should be made here: https://github.com/open-feature/java-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:45 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/javascript/index.mdx b/docs/reference/sdks/server/javascript/index.mdx index 1310bc08c..adb589cfd 100644 --- a/docs/reference/sdks/server/javascript/index.mdx +++ b/docs/reference/sdks/server/javascript/index.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/javascript/nestjs.mdx b/docs/reference/sdks/server/javascript/nestjs.mdx index 2d13ca6ed..ac75c8c99 100644 --- a/docs/reference/sdks/server/javascript/nestjs.mdx +++ b/docs/reference/sdks/server/javascript/nestjs.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/php.mdx b/docs/reference/sdks/server/php.mdx index aa373b80c..cb3923994 100644 --- a/docs/reference/sdks/server/php.mdx +++ b/docs/reference/sdks/server/php.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from php-sdk. Edits should be made here: https://github.com/open-feature/php-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/python.mdx b/docs/reference/sdks/server/python.mdx index b2d7bcdcb..5441be01e 100644 --- a/docs/reference/sdks/server/python.mdx +++ b/docs/reference/sdks/server/python.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from python-sdk. Edits should be made here: https://github.com/open-feature/python-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; @@ -187,6 +187,17 @@ client.get_boolean_flag("my-flag", False, flag_evaluation_options=options) The OpenFeature SDK logs to the `openfeature` logger using the `logging` package from the Python Standard Library. +#### Logging Hook + +The Python SDK includes a `LoggingHook`, which logs detailed information at key points during flag evaluation, using the `logging` package. This hook can be particularly helpful for troubleshooting and debugging; simply attach it at the global, client or invocation level and ensure your log level is set to "debug". + +```python +from openfeature import api +from openfeature.hook.logging_hook import LoggingHook + +api.add_hooks([LoggingHook()]) +``` + ### Domains Clients can be assigned to a domain. diff --git a/docs/reference/sdks/server/ruby.mdx b/docs/reference/sdks/server/ruby.mdx index 2b0af4d20..0e31d4b28 100644 --- a/docs/reference/sdks/server/ruby.mdx +++ b/docs/reference/sdks/server/ruby.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from ruby-sdk. Edits should be made here: https://github.com/open-feature/ruby-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Sun Mar 08 2026 22:19:16 GMT-0700 (Pacific Daylight Time) +Last updated at Thu Mar 19 2026 08:21:46 GMT+0000 (Coordinated Universal Time) --> import MCPInstall from '@site/src/partials/mcp-install'; diff --git a/docs/reference/sdks/server/rust.mdx b/docs/reference/sdks/server/rust.mdx index a9c61e60b..885a87f0d 100644 --- a/docs/reference/sdks/server/rust.mdx +++ b/docs/reference/sdks/server/rust.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from rust-sdk. Edits should be made here: https://github.com/open-feature/rust-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Wed Feb 18 2026 08:21:17 GMT+0000 (Coordinated Universal Time) +Last updated at Thu Mar 19 2026 08:21:47 GMT+0000 (Coordinated Universal Time) -->

@@ -17,8 +17,8 @@ Last updated at Wed Feb 18 2026 08:21:17 GMT+0000 (Coordinated Universal Time) Specification - - Release + + Release @@ -50,7 +50,7 @@ This package was built with Rust version `1.77.0`. Earlier versions might work, Add the following content to the `Cargo.toml` file: ```toml -open-feature = "0.2.7" +open-feature = "0.3.0" ``` ### Usage diff --git a/src/datasets/sdks/sdk-compatibility.json b/src/datasets/sdks/sdk-compatibility.json index e5aed021e..c055aec6e 100644 --- a/src/datasets/sdks/sdk-compatibility.json +++ b/src/datasets/sdks/sdk-compatibility.json @@ -420,8 +420,8 @@ "path": "/docs/reference/sdks/client/kotlin", "category": "Client", "release": { - "href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.7.1", - "version": "0.7.1", + "href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.7.2", + "version": "0.7.2", "stable": false }, "spec": { @@ -592,8 +592,8 @@ "path": "/docs/reference/sdks/server/dart", "category": "Server", "release": { - "href": "https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.16", - "version": "0.0.16", + "href": "https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.17", + "version": "0.0.17", "stable": false }, "spec": { @@ -626,8 +626,8 @@ "path": "/docs/reference/sdks/server/dart#eventing" }, "Tracking": { - "status": "❓", - "path": "/docs/reference/sdks/server/dart" + "status": "✅", + "path": "/docs/reference/sdks/server/dart#tracking" }, "Transaction Context Propagation": { "status": "✅",