Skip to content

Commit e7108c0

Browse files
feat: move OFREP OpenAPI docs to Other Technologies section
Signed-off-by: Jonathan Norris <[email protected]>
1 parent 661c5c7 commit e7108c0

File tree

5 files changed

+33
-8
lines changed

5 files changed

+33
-8
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "OFREP",
3+
"position": 2,
4+
"collapsible": true,
5+
"collapsed": false,
6+
"link": {
7+
"type": "doc",
8+
"id": "reference/other-technologies/ofrep/index"
9+
}
10+
}

docs/reference/other-technologies/ofrep.mdx renamed to docs/reference/other-technologies/ofrep/index.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
22
title: OpenFeature Remote Evaluation Protocol (OFREP)
3-
sidebar_label: OFREP
4-
sidebar_position: 2
5-
id: ofrep
3+
sidebar_position: 1
64
---
75

8-
The **OpenFeature Remote Evaluation Protocol (OFREP)** is an API specification for feature flagging that enables vendor-agnostic communication between applications and flag management systems. It defines a standard API layer between the provider and the flag management system, allowing any OpenSource or commercial system to implement the protocol and be compatible with community-maintained providers.
6+
The **OpenFeature Remote Evaluation Protocol (OFREP)** is an [API specification](./openapi) for feature flagging that enables vendor-agnostic communication between applications and flag management systems. It defines a standard API layer between the provider and the flag management system, allowing any OpenSource or commercial system to implement the protocol and be compatible with community-maintained providers.
97

108
### Key Benefits
119

1210
- **Vendor Agnostic**: Connect to any OFREP-compliant flag management system without vendor-specific implementations
13-
- **Standardized**: Built on a common OpenAPI specification for consistent integration
11+
- **Standardized**: Built on a [common OpenAPI specification](./openapi) for consistent integration
1412
- **Flexible**: Works on both client-side and server-side applications
1513
- **Community Maintained**: Generic OFREP providers maintained by the OpenFeature project
1614

@@ -29,7 +27,7 @@ graph LR
2927
1. Your application uses the OpenFeature SDK
3028
2. The OpenFeature SDK uses an OFREP provider
3129
3. The OFREP provider communicates with your flag management system via the standardized OFREP API
32-
4. Your flag management system implements the OFREP specification
30+
4. Your flag management system implements the [OFREP specification](./openapi)
3331

3432
### Server vs Client
3533

@@ -71,7 +69,7 @@ To create an OFREP provider for a new language:
7169

7270
To make your flag management system OFREP-compliant:
7371

74-
1. Implement the [OFREP OpenAPI specification](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/service/openapi.yaml)
72+
1. Implement the [OFREP OpenAPI specification](./openapi)
7573
2. Test your implementation with existing OFREP providers
7674
3. Register your system in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
7775

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "OpenAPI Spec"
3+
sidebar_position: 2
4+
hide_title: true
5+
---
6+
7+
import Redoc from '@theme/Redoc';
8+
9+
<div className="redoc-container">
10+
<Redoc />
11+
</div>
12+

external-content/specification

src/css/custom.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,4 +297,9 @@ article:has(.redoc-container) {
297297
.redocusaurus a[href*="redocly.com"],
298298
.redocusaurus [class*="powered-by"] {
299299
display: none !important;
300+
}
301+
302+
/* Hide menu border on API viewer pages */
303+
.redoc-container .menu-content {
304+
border-right: none !important;
300305
}

0 commit comments

Comments
 (0)