Skip to content

Commit

Permalink
chore: update sdk readmes (#585)
Browse files Browse the repository at this point in the history
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
  • Loading branch information
openfeaturebot authored Jun 13, 2024
1 parent ca8f14f commit 426a116
Show file tree
Hide file tree
Showing 12 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs/reference/technologies/client/kotlin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:56 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/client/swift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:56 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/technologies/client/web/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ 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 Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:56 GMT+0000 (Coordinated Universal Time)
-->

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

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

<br/>
Expand All @@ -41,7 +41,7 @@ Last updated at Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)

### Requirements

- ES2022-compatible web browser (Chrome, Edge, Firefox, etc)
- ES2015-compatible web browser (Chrome, Edge, Firefox, etc)

### Install

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/technologies/client/web/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ 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 Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:56 GMT+0000 (Coordinated Universal Time)
-->

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

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

<br/>
Expand Down Expand Up @@ -58,7 +58,7 @@ In addition to the feature provided by the [web sdk](/docs/reference/technologie

### Requirements

- ES2022-compatible web browser (Chrome, Edge, Firefox, etc)
- ES2015-compatible web browser (Chrome, Edge, Firefox, etc)
- React version 16.8+

### Install
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/dotnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:55 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)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
26 changes: 13 additions & 13 deletions docs/reference/technologies/server/java.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:55 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down Expand Up @@ -118,7 +118,7 @@ See [here](https://javadoc.io/doc/dev.openfeature/sdk/latest/) for the Javadocs.
|| [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. |
|| [Logging](#logging) | Integrate with popular logging packages. |
|| [Named clients](#named-clients) | Utilize multiple providers in a single application. |
|| [Domains](#domains) | Logically bind clients with providers. |
|| [Eventing](#eventing) | React to state changes in the provider or flag management system. |
|| [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. |
|| [Transaction Context Propagation](#transaction-context-propagation) | Set a specific [evaluation context](/docs/reference/concepts/evaluation-context) for a transaction (e.g. an HTTP request or a thread). |
Expand Down Expand Up @@ -152,7 +152,7 @@ To register a provider in a non-blocking manner, you can use the `setProvider` m
```

In some situations, it may be beneficial to register multiple providers in the same application.
This is possible using [named clients](#named-clients), which is covered in more details below.
This is possible using [domains](#domains), which is covered in more detail below.

### Targeting

Expand Down Expand Up @@ -211,27 +211,27 @@ Once you've added a hook as a dependency, it can be registered at the global, cl

The Java SDK uses SLF4J. See the [SLF4J manual](https://slf4j.org/manual.html) for complete documentation.

### Named clients
### Domains

Clients can be given a name.
A name is a logical identifier which can be used to associate clients with a particular provider.
If a name has no associated provider, the global provider is used.
Clients can be assigned to a domain.
A domain is a logical identifier which can be used to associate clients with a particular provider.
If a domain has no associated provider, the global provider is used.

```java
FeatureProvider scopedProvider = new MyProvider();

// registering the default provider
OpenFeatureAPI.getInstance().setProvider(LocalProvider());
// registering a named provider
OpenFeatureAPI.getInstance().setProvider("clientForCache", new CachedProvider());
// registering a provider to a domain
OpenFeatureAPI.getInstance().setProvider("my-domain", new CachedProvider());

// a client backed by default provider
// A client bound to the default provider
Client clientDefault = OpenFeatureAPI.getInstance().getClient();
// a client backed by CachedProvider
Client clientNamed = OpenFeatureAPI.getInstance().getClient("clientForCache");
// A client bound to the CachedProvider provider
Client domainScopedClient = OpenFeatureAPI.getInstance().getClient("my-domain");
```

Named providers can be set in a blocking or non-blocking way.
Providers for domains can be set in a blocking or non-blocking way.
For more details, please refer to the [providers](#providers) section.

### Eventing
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/technologies/server/javascript/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ 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 Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:55 GMT+0000 (Coordinated Universal Time)
-->

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

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

<br/>
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/technologies/server/javascript/nestjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ 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 Tue Jun 04 2024 18:59:53 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:55 GMT+0000 (Coordinated Universal Time)
-->

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

<a href="https://github.com/open-feature/js-sdk/releases/tag/nestjs-sdk-v0.2.0-experimental">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.0-experimental&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/js-sdk/releases/tag/nestjs-sdk-v0.2.1-experimental">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.1-experimental&color=blue&style=for-the-badge" />
</a>

<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/php.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:56 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/technologies/server/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 Tue Jun 04 2024 18:59:54 GMT+0000 (Coordinated Universal Time)
Last updated at Thu Jun 13 2024 08:07:56 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
10 changes: 5 additions & 5 deletions src/datasets/sdks/sdk-compatibility.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
"Domains": {
"status": "",
"path": "/docs/reference/technologies/server/java#named-clients"
"path": "/docs/reference/technologies/server/java#domains"
},
"Eventing": {
"status": "",
Expand All @@ -56,8 +56,8 @@
"path": "/docs/reference/technologies/server/javascript",
"category": "Server",
"release": {
"href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.14.0",
"version": "1.14.0",
"href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.15.0",
"version": "1.15.0",
"stable": true
},
"spec": {
Expand Down Expand Up @@ -316,8 +316,8 @@
"path": "/docs/reference/technologies/client/web",
"category": "Client",
"release": {
"href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.1.0",
"version": "1.1.0",
"href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.2.1",
"version": "1.2.1",
"stable": true
},
"spec": {
Expand Down

0 comments on commit 426a116

Please sign in to comment.