Skip to content

Commit 1f6e1e8

Browse files
chore: update sdk readmes (#962)
The PR was automatically generated via the update-sdk-docs GitHub workflow. Signed-off-by: OpenFeature Bot <[email protected]>
1 parent 72a99d7 commit 1f6e1e8

File tree

14 files changed

+131
-82
lines changed

14 files changed

+131
-82
lines changed

docs/reference/technologies/client/kotlin.mdx

Lines changed: 20 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ This content has been automatically generated from kotlin-sdk.
1010
Edits should be made here: https://github.com/open-feature/kotlin-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:46 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
17-
<a href="https://github.com/open-feature/spec/releases/tag/v0.6.0">
18-
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.6.0&color=yellow&style=for-the-badge" />
17+
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
18+
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

2121
<a href="https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.3">
@@ -72,7 +72,7 @@ coroutineScope.launch(Dispatchers.IO) {
7272
|| [Tracking](#tracking) | Associate user actions with feature flag evaluations. |
7373
|| [Logging](#logging) | Integrate with popular logging packages. |
7474
|| [Named clients](#named-clients) | Utilize multiple providers in a single application. |
75-
| | [Eventing](#eventing) | React to state changes in the provider or flag management system. |
75+
| | [Eventing](#eventing) | React to state changes in the provider or flag management system. |
7676
|| [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. |
7777
| ⚠️ | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. |
7878

@@ -87,10 +87,21 @@ If the provider you're looking for hasn't been created yet, see the [develop a p
8787
Once you've added a provider as a dependency, it can be registered with OpenFeature like this:
8888

8989
```kotlin
90-
OpenFeatureAPI.setProviderAndWait(MyProvider())
90+
coroutineScope.launch(Dispatchers.IO) {
91+
OpenFeatureAPI.setProviderAndWait(MyProvider())
92+
}
9193
```
9294

93-
> Asynchronous API that doesn't wait is also available
95+
Asynchronous API that doesn't wait is also available. It's useful when you want to set a provider and continue with other tasks.
96+
97+
However, flag evaluations are only possible after the provider is Ready.
98+
99+
```kotlin
100+
OpenFeatureAPI.setProvider(MyProvider()) // can pass a dispatcher here
101+
// The provider initialization happens on a coroutine launched on the IO dispatcher.
102+
val status = OpenFeatureAPI.getStatus()
103+
// When status is Ready, flag evaluations can be made
104+
```
94105

95106
### Targeting
96107

@@ -162,31 +173,7 @@ Support for named clients is not yet available in the Kotlin SDK.
162173

163174
### Eventing
164175

165-
Events allow you to react to state changes in the provider or underlying flag management system, such as flag definition changes, provider readiness, or error conditions.
166-
Initialization events (`PROVIDER_READY` on success, `PROVIDER_ERROR` on failure) are dispatched for every provider.
167-
Some providers support additional events, such as `PROVIDER_CONFIGURATION_CHANGED`.
168-
169-
Please refer to the documentation of the provider you're using to see what events are supported.
170-
171-
Example usage:
172-
```kotlin
173-
viewModelScope.launch {
174-
OpenFeatureAPI.observe<OpenFeatureEvents.ProviderReady>().collect {
175-
println(">> ProviderReady event received")
176-
}
177-
}
178-
179-
viewModelScope.launch {
180-
OpenFeatureAPI.setProviderAndWait(
181-
ConfidenceFeatureProvider.create(
182-
applicationContext,
183-
clientSecret
184-
),
185-
Dispatchers.IO,
186-
myEvaluationContext
187-
)
188-
}
189-
```
176+
Support for eventing is not yet available in the Kotlin SDK.
190177

191178
### Shutdown
192179

@@ -246,21 +233,13 @@ class NewProvider(override val hooks: List<Hook<*>>, override val metadata: Meta
246233
// resolve a string flag value
247234
}
248235

249-
override fun initialize(initialContext: EvaluationContext?) {
236+
override suspend fun initialize(initialContext: EvaluationContext?) {
250237
// add context-aware provider initialization
251238
}
252239

253-
override fun onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) {
240+
override suspend fun onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) {
254241
// add necessary changes on context change
255242
}
256-
257-
override fun observe(): Flow<OpenFeatureEvents> {
258-
// return a `Flow` of the Events
259-
}
260-
261-
override fun getProviderStatus(): OpenFeatureEvents {
262-
// return the event representative of the current Provider Status
263-
}
264243
}
265244
```
266245

docs/reference/technologies/client/swift.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk.
1010
Edits should be made here: https://github.com/open-feature/swift-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:46 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">

docs/reference/technologies/client/web/angular.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:47 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
1717
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
1818
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

21-
<a href="https://github.com/open-feature/js-sdk/releases/tag/angular-sdk-v0.0.9-experimental">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.9-experimental&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/js-sdk/releases/tag/angular-sdk-v0.0.10">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.10&color=blue&style=for-the-badge" />
2323
</a>
2424

2525
<br/>

docs/reference/technologies/client/web/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:46 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
1717
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
1818
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

21-
<a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.4.0">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.4.1">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.4.1&color=blue&style=for-the-badge" />
2323
</a>
2424

2525
<br/>

docs/reference/technologies/client/web/react.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:46 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
1717
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
1818
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

21-
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.4.10">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.10&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.4.11">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.11&color=blue&style=for-the-badge" />
2323
</a>
2424

2525
<br/>

docs/reference/technologies/server/dotnet.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk.
1010
Edits should be made here: https://github.com/open-feature/dotnet-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:45 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
[![Specification](https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.7.0)

docs/reference/technologies/server/go.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk.
99
Edits should be made here: https://github.com/open-feature/go-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Thu Feb 06 2025 08:09:45 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
1313
-->
1414

1515
<p align="center" class="github-badges">

docs/reference/technologies/server/java.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk.
99
Edits should be made here: https://github.com/open-feature/java-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Thu Feb 06 2025 08:09:44 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
1313
-->
1414

1515
<p align="center" class="github-badges">
@@ -18,8 +18,8 @@ Last updated at Thu Feb 06 2025 08:09:44 GMT+0000 (Coordinated Universal Time)
1818
</a>
1919

2020

21-
<a href="https://github.com/open-feature/java-sdk/releases/tag/v1.14.0">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.14.0&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/java-sdk/releases/tag/v1.14.1">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.14.1&color=blue&style=for-the-badge" />
2323
</a>
2424

2525

@@ -54,7 +54,7 @@ Note that this library is intended to be used in server-side contexts and has no
5454
<dependency>
5555
<groupId>dev.openfeature</groupId>
5656
<artifactId>sdk</artifactId>
57-
<version>1.14.0</version>
57+
<version>1.14.1</version>
5858
</dependency>
5959
```
6060

@@ -77,7 +77,7 @@ If you would like snapshot builds, this is the relevant repository information:
7777

7878
```groovy
7979
dependencies {
80-
implementation 'dev.openfeature:sdk:1.14.0'
80+
implementation 'dev.openfeature:sdk:1.14.1'
8181
}
8282
```
8383

docs/reference/technologies/server/javascript/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:44 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
1717
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
1818
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

21-
<a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.17.0">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.17.0&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.17.1">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.17.1&color=blue&style=for-the-badge" />
2323
</a>
2424

2525
<br/>

docs/reference/technologies/server/javascript/nestjs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Thu Feb 06 2025 08:09:44 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">

0 commit comments

Comments
 (0)