From 7f0315225c872084a372f7848eec5f1d33822199 Mon Sep 17 00:00:00 2001 From: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Date: Tue, 4 Jun 2024 18:59:54 +0000 Subject: [PATCH] chore: update sdk readmes Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> --- docs/reference/technologies/client/kotlin.mdx | 2 +- docs/reference/technologies/client/swift.mdx | 2 +- docs/reference/technologies/client/web/index.mdx | 2 +- docs/reference/technologies/client/web/react.mdx | 2 +- docs/reference/technologies/server/dotnet.mdx | 2 +- docs/reference/technologies/server/go.mdx | 2 +- docs/reference/technologies/server/java.mdx | 10 ++++------ .../reference/technologies/server/javascript/index.mdx | 2 +- .../technologies/server/javascript/nestjs.mdx | 2 +- docs/reference/technologies/server/php.mdx | 2 +- docs/reference/technologies/server/python.mdx | 2 +- 11 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/reference/technologies/client/kotlin.mdx b/docs/reference/technologies/client/kotlin.mdx index d56eea930..6ee38d590 100644 --- a/docs/reference/technologies/client/kotlin.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:26 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/client/swift.mdx b/docs/reference/technologies/client/swift.mdx index 2ad5268a7..dd52a3671 100644 --- a/docs/reference/technologies/client/swift.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:26 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/client/web/index.mdx b/docs/reference/technologies/client/web/index.mdx index 67e1fe179..557cefa2f 100644 --- a/docs/reference/technologies/client/web/index.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:26 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/client/web/react.mdx b/docs/reference/technologies/client/web/react.mdx index a860d254d..e2f7ef98e 100644 --- a/docs/reference/technologies/client/web/react.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:26 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/dotnet.mdx b/docs/reference/technologies/server/dotnet.mdx index d167c9640..ac6bd6e73 100644 --- a/docs/reference/technologies/server/dotnet.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:25 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time) --> [![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) diff --git a/docs/reference/technologies/server/go.mdx b/docs/reference/technologies/server/go.mdx index 6536c372c..208c601a7 100644 --- a/docs/reference/technologies/server/go.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:25 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/java.mdx b/docs/reference/technologies/server/java.mdx index 5ab2c1d78..1fd6a2941 100644 --- a/docs/reference/technologies/server/java.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:25 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time) -->

@@ -44,7 +44,7 @@ Last updated at Thu May 30 2024 08:08:25 GMT+0000 (Coordinated Universal Time) - Java 8+ (compiler target is 1.8) -Note that this library is intended to be used in server-side contexts and has not been evaluated for use in mobile devices. +Note that this library is intended to be used in server-side contexts and has not been evaluated for use on mobile devices. ### Install @@ -274,7 +274,7 @@ To register a `ThreadLocal` context propagator, you can use the `setTransactionC // registering the ThreadLocalTransactionContextPropagator OpenFeatureAPI.getInstance().setTransactionContextPropagator(new ThreadLocalTransactionContextPropagator()); ``` -Once you've registered a transaction context propagator, you can propagate the data into request scoped transaction context. +Once you've registered a transaction context propagator, you can propagate the data into request-scoped transaction context. ```java // adding userId to transaction context @@ -282,7 +282,7 @@ OpenFeatureAPI api = OpenFeatureAPI.getInstance(); Map transactionAttrs = new HashMap<>(); transactionAttrs.put("userId", new Value("userId")); EvaluationContext transactionCtx = new ImmutableContext(transactionAttrs); -api.setTransactionContext(apiCtx); +api.setTransactionContext(transactionCtx); ``` Additionally, you can develop a custom transaction context propagator by implementing the `TransactionContextPropagator` interface and registering it as shown above. @@ -382,8 +382,6 @@ class MyEventProvider extends EventProvider { To develop a hook, 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/java-sdk-contrib) available under the OpenFeature organization. Implement your own hook by conforming to the `Hook interface`. -To satisfy the interface, all methods (`Before`/`After`/`Finally`/`Error`) need to be defined. -To avoid defining empty functions make use of the `UnimplementedHook` struct (which already implements all the empty functions). ```java class MyHook implements Hook { diff --git a/docs/reference/technologies/server/javascript/index.mdx b/docs/reference/technologies/server/javascript/index.mdx index ea9e07a87..9f9e59381 100644 --- a/docs/reference/technologies/server/javascript/index.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:25 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/javascript/nestjs.mdx b/docs/reference/technologies/server/javascript/nestjs.mdx index 68781e13f..dbbc77be6 100644 --- a/docs/reference/technologies/server/javascript/nestjs.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:25 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/php.mdx b/docs/reference/technologies/server/php.mdx index a0e55c88a..f793d2051 100644 --- a/docs/reference/technologies/server/php.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:26 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/python.mdx b/docs/reference/technologies/server/python.mdx index af2b36e1a..14236b4e1 100644 --- a/docs/reference/technologies/server/python.mdx +++ b/docs/reference/technologies/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 Thu May 30 2024 08:08:26 GMT+0000 (Coordinated Universal Time) +Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time) -->