Skip to content

docs: Add documentation for ofrep #3229

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.

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
merged 2 commits into from
Mar 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions website/docs/sdk/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ description: Use GO Feature Flag with Openfeature SDKs
---
import { Card } from "@site/src/components/doc/cardv3";
import { sdk } from "@site/data/sdk";
import ofLogo from "@site/static/docs/openfeature/logo.png";

# 🧩 SDKs (with OpenFeature)

Expand Down Expand Up @@ -60,3 +61,16 @@ GO Feature Flag support both paradigms, and the SDKs are designed to make it eas
/>
))}
</div>

### OpenFeature Remote Evaluation Protocol (OFREP)
In addition to the GO Feature Flag specific providers, we also support the OpenFeature Remote Evaluation Protocol (OFREP) which is a standard protocol for feature flag evaluation.

<Card
name={"OFREP"}
logo={ofLogo}
link={`sdk/ofrep`}
featureList={[{
status: "done",
name: "OpenFeature (OFREP) API",
}]}
/>
32 changes: 32 additions & 0 deletions website/docs/sdk/ofrep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
description: Use GO Feature Flag with Openfeature SDKs
title: OpenFeature Remote Evaluation Protocol (OFREP)
---
# OpenFeature Remote Evaluation Protocol (OFREP)

## Overview
In addition of the GO Feature Flag specific providers, we also support the OpenFeature Remote Evaluation Protocol (OFREP) which is a standard protocol for feature flag evaluation.
This protocol is designed to be used with any feature flag provider that supports it.

## What is OFREP?
OFREP is an API specification that allows you to connect your applications to any feature flag management system that supports the protocol using generic providers.
This means more flexibility and choice when it comes to managing your features.

For the full technical details, you can head over to the Open Feature Protocol documentation: Open Feature Protocol: https://github.com/open-feature/protocol/.

## When to use OFREP instead of the official GO Feature Flag providers?
- When you want to be able to switch between different feature flag vendors without changing your code.
- When what you need is only the evaluation and you don't need the full feature flag management capabilities _(collect of flag evaluations, provider specific function for GO Feature Flag, etc ...)_.
- When you want to avoid vendor lock-in as much as possible.
- When you have a software that wants to integrate with different vendors, without importing all the providers of those vendors.
- When you want to use a SDK that has support of OFREP but not the official GO Feature Flag providers.

## How to use OFREP with GO Feature Flag?
To use OpenFeature Remote Evaluation Protocol (OFREP) with GO Feature Flag, you need to have the [`relay-proxy`](../relay-proxy) running in your infrastructure.

The `relay-proxy` has all the endpoints needed to communicate with any of the feature flag providers that support OFREP.

If you want to look at those endpoints, you can look at them in the [API doc](https://gofeatureflag.org/API_relayproxy#tag/OpenFeature-Remote-Evaluation-Protocol-(OFREP)).

## Any questions about OFREP?
Ask them on [Slack](/slack) or open an issue on the [GitHub repository](https://github.com/thomaspoignant/go-feature-flag/issues).
Binary file added website/static/docs/openfeature/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 24 additions & 10 deletions website/versioned_docs/version-v1.42.0/sdk/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ description: Use GO Feature Flag with Openfeature SDKs
---
import { Card } from "@site/src/components/doc/cardv3";
import { sdk } from "@site/data/sdk";
import ofLogo from "@site/static/docs/openfeature/logo.png";

# 🧩 SDKs (with OpenFeature)

Expand Down Expand Up @@ -34,16 +35,16 @@ GO Feature Flag support both paradigms, and the SDKs are designed to make it eas

### Client-side Languages
<div className={"grid grid-cols-1 sm:grid-cols-2 md:grid-cols-3 gap-4"}>
{ sdk.filter(it => it.paradigm.includes('Client')).map((item) => (
<Card
key={item.name}
name={item.name}
cssLogo={item.faLogo}
link={`sdk/${item.docLink}`}
badge={item.badgeUrl}
featureList={item.featureList}
/>
))}
{ sdk.filter(it => it.paradigm.includes('Client')).map((item) => (
<Card
key={item.name}
name={item.name}
cssLogo={item.faLogo}
link={`sdk/${item.docLink}`}
badge={item.badgeUrl}
featureList={item.featureList}
/>
))}
</div>


Expand All @@ -60,3 +61,16 @@ GO Feature Flag support both paradigms, and the SDKs are designed to make it eas
/>
))}
</div>

### OpenFeature Remote Evaluation Protocol (OFREP)
In addition to the GO Feature Flag specific providers, we also support the OpenFeature Remote Evaluation Protocol (OFREP) which is a standard protocol for feature flag evaluation.

<Card
name={"OFREP"}
logo={ofLogo}
link={`sdk/ofrep`}
featureList={[{
status: "done",
name: "OpenFeature (OFREP) API",
}]}
/>
32 changes: 32 additions & 0 deletions website/versioned_docs/version-v1.42.0/sdk/ofrep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
description: Use GO Feature Flag with Openfeature SDKs
title: OpenFeature Remote Evaluation Protocol (OFREP)
---
# OpenFeature Remote Evaluation Protocol (OFREP)

## Overview
In addition of the GO Feature Flag specific providers, we also support the OpenFeature Remote Evaluation Protocol (OFREP) which is a standard protocol for feature flag evaluation.
This protocol is designed to be used with any feature flag provider that supports it.

## What is OFREP?
OFREP is an API specification that allows you to connect your applications to any feature flag management system that supports the protocol using generic providers.
This means more flexibility and choice when it comes to managing your features.

For the full technical details, you can head over to the Open Feature Protocol documentation: Open Feature Protocol: https://github.com/open-feature/protocol/.

## When to use OFREP instead of the official GO Feature Flag providers?
- When you want to be able to switch between different feature flag vendors without changing your code.
- When what you need is only the evaluation and you don't need the full feature flag management capabilities _(collect of flag evaluations, provider specific function for GO Feature Flag, etc ...)_.
- When you want to avoid vendor lock-in as much as possible.
- When you have a software that wants to integrate with different vendors, without importing all the providers of those vendors.
- When you want to use a SDK that has support of OFREP but not the official GO Feature Flag providers.

## How to use OFREP with GO Feature Flag?
To use OpenFeature Remote Evaluation Protocol (OFREP) with GO Feature Flag, you need to have the [`relay-proxy`](../relay-proxy) running in your infrastructure.

The `relay-proxy` has all the endpoints needed to communicate with any of the feature flag providers that support OFREP.

If you want to look at those endpoints, you can look at them in the [API doc](https://gofeatureflag.org/API_relayproxy#tag/OpenFeature-Remote-Evaluation-Protocol-(OFREP)).

## Any questions about OFREP?
Ask them on [Slack](/slack) or open an issue on the [GitHub repository](https://github.com/thomaspoignant/go-feature-flag/issues).
Loading