From f0adcfe955dc96405e4d3b4fa0286393bb0976dc Mon Sep 17 00:00:00 2001 From: Jonathan Norris Date: Mon, 20 Oct 2025 14:36:25 -0400 Subject: [PATCH 1/5] feat: add OpenAPI documentation page for OFREP Signed-off-by: Jonathan Norris --- specification/appendix-c/_category_.json | 6 ++++++ .../{appendix-c-ofrep.md => appendix-c/index.md} | 6 +++++- specification/appendix-c/ofrep-api.mdx | 14 ++++++++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 specification/appendix-c/_category_.json rename specification/{appendix-c-ofrep.md => appendix-c/index.md} (89%) create mode 100644 specification/appendix-c/ofrep-api.mdx diff --git a/specification/appendix-c/_category_.json b/specification/appendix-c/_category_.json new file mode 100644 index 00000000..c79e9b73 --- /dev/null +++ b/specification/appendix-c/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Appendix C: OpenFeature Remote Evaluation Protocol", + "position": 5, + "collapsible": false, + "collapsed": false +} \ No newline at end of file diff --git a/specification/appendix-c-ofrep.md b/specification/appendix-c/index.md similarity index 89% rename from specification/appendix-c-ofrep.md rename to specification/appendix-c/index.md index 853da794..0490a5d0 100644 --- a/specification/appendix-c-ofrep.md +++ b/specification/appendix-c/index.md @@ -2,7 +2,7 @@ id: appendix-c title: "Appendix C: OpenFeature Remote Evaluation Protocol" description: A unified protocol for feature flagging -sidebar_position: 5 +sidebar_position: 0 --- # Appendix C: OpenFeature Remote Evaluation Protocol @@ -17,3 +17,7 @@ There is a dedicated [OpenFeature working group](https://github.com/open-feature - Reference implementations of the protocol If you are interested in this initiative, you can join the [`#openfeature-remote-evaluation-protocol`](https://cloud-native.slack.com/archives/C066A48LK35) Slack channel on the [CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf) workspace. + +## API Specification + +View the full [OFREP API Specification](./ofrep-api) with interactive documentation. diff --git a/specification/appendix-c/ofrep-api.mdx b/specification/appendix-c/ofrep-api.mdx new file mode 100644 index 00000000..761e774b --- /dev/null +++ b/specification/appendix-c/ofrep-api.mdx @@ -0,0 +1,14 @@ +--- +title: "OFREP OpenAPI Documentation" +sidebar_position: 1 +hide_title: true +--- + +import Redoc from '@theme/Redoc'; + +
+ +
From 1841e2f8cf081e9cd6e797f2bd1fdc5b2d52fbbc Mon Sep 17 00:00:00 2001 From: Jonathan Norris Date: Mon, 20 Oct 2025 14:44:02 -0400 Subject: [PATCH 2/5] chore: remove redundant collapsed field and move inline styles to CSS Signed-off-by: Jonathan Norris --- specification/appendix-c/_category_.json | 3 +-- specification/appendix-c/ofrep-api.mdx | 5 +---- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/specification/appendix-c/_category_.json b/specification/appendix-c/_category_.json index c79e9b73..7df8d7cb 100644 --- a/specification/appendix-c/_category_.json +++ b/specification/appendix-c/_category_.json @@ -1,6 +1,5 @@ { "label": "Appendix C: OpenFeature Remote Evaluation Protocol", "position": 5, - "collapsible": false, - "collapsed": false + "collapsible": false } \ No newline at end of file diff --git a/specification/appendix-c/ofrep-api.mdx b/specification/appendix-c/ofrep-api.mdx index 761e774b..c7f40a98 100644 --- a/specification/appendix-c/ofrep-api.mdx +++ b/specification/appendix-c/ofrep-api.mdx @@ -6,9 +6,6 @@ hide_title: true import Redoc from '@theme/Redoc'; -
+
From 19b8bb5ae4c2840b73fb5c4d0e1b75d761eada47 Mon Sep 17 00:00:00 2001 From: Jonathan Norris Date: Mon, 20 Oct 2025 14:59:25 -0400 Subject: [PATCH 3/5] fix: update broken links after restructuring appendix-c Signed-off-by: Jonathan Norris --- specification/README.md | 2 +- specification/appendix-c/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/README.md b/specification/README.md index 50a2862a..c39658d5 100644 --- a/specification/README.md +++ b/specification/README.md @@ -19,7 +19,7 @@ sidebar_position: 0 - [Tracking](./sections/06-tracking.md) - [Appendix A: Included Utilities](./appendix-a-included-utilities.md) - [Appendix B: Gherkin Suites](./appendix-b-gherkin-suites.md) -- [Appendix C: OFREP](./appendix-c-ofrep.md) +- [Appendix C: OFREP](./appendix-c/index.md) - [Appendix D: Observability](./appendix-d-observability.md) ## Conformance diff --git a/specification/appendix-c/index.md b/specification/appendix-c/index.md index 0490a5d0..03939a84 100644 --- a/specification/appendix-c/index.md +++ b/specification/appendix-c/index.md @@ -20,4 +20,4 @@ If you are interested in this initiative, you can join the [`#openfeature-remote ## API Specification -View the full [OFREP API Specification](./ofrep-api) with interactive documentation. +View the full [OFREP API Specification](./ofrep-api.mdx) with interactive documentation. From dbf6df8672f77bfdf4d040a5bfbdc6440f0903e1 Mon Sep 17 00:00:00 2001 From: Jonathan Norris Date: Mon, 27 Oct 2025 14:46:03 -0400 Subject: [PATCH 4/5] docs: move OFREP OpenAPI docs to main docs site Signed-off-by: Jonathan Norris --- specification/appendix-c/index.md | 2 +- specification/appendix-c/ofrep-api.mdx | 11 ----------- 2 files changed, 1 insertion(+), 12 deletions(-) delete mode 100644 specification/appendix-c/ofrep-api.mdx diff --git a/specification/appendix-c/index.md b/specification/appendix-c/index.md index 03939a84..528be353 100644 --- a/specification/appendix-c/index.md +++ b/specification/appendix-c/index.md @@ -20,4 +20,4 @@ If you are interested in this initiative, you can join the [`#openfeature-remote ## API Specification -View the full [OFREP API Specification](./ofrep-api.mdx) with interactive documentation. +View the full [OFREP API Specification](/docs/reference/other-technologies/ofrep/openapi) with interactive documentation. diff --git a/specification/appendix-c/ofrep-api.mdx b/specification/appendix-c/ofrep-api.mdx deleted file mode 100644 index c7f40a98..00000000 --- a/specification/appendix-c/ofrep-api.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "OFREP OpenAPI Documentation" -sidebar_position: 1 -hide_title: true ---- - -import Redoc from '@theme/Redoc'; - -
- -
From 67b36df1199894f47985936ffe096c36db006691 Mon Sep 17 00:00:00 2001 From: Jonathan Norris Date: Tue, 28 Oct 2025 16:52:32 -0400 Subject: [PATCH 5/5] fix: use absolute URL and ignore pattern for OFREP API docs link Signed-off-by: Jonathan Norris --- .markdown-link-check-config.json | 9 +++++++-- specification/appendix-c/index.md | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.markdown-link-check-config.json b/.markdown-link-check-config.json index dc6514f7..96c10500 100644 --- a/.markdown-link-check-config.json +++ b/.markdown-link-check-config.json @@ -1,5 +1,10 @@ { "ignorePatterns": [ - {"pattern": ".*split.io.*"} + { + "pattern": ".*split.io.*" + }, + { + "pattern": ".*openfeature.dev/docs/reference/other-technologies/ofrep/openapi.*" + } ] -} +} \ No newline at end of file diff --git a/specification/appendix-c/index.md b/specification/appendix-c/index.md index 528be353..993371c6 100644 --- a/specification/appendix-c/index.md +++ b/specification/appendix-c/index.md @@ -20,4 +20,4 @@ If you are interested in this initiative, you can join the [`#openfeature-remote ## API Specification -View the full [OFREP API Specification](/docs/reference/other-technologies/ofrep/openapi) with interactive documentation. +View the full [OFREP API Specification](https://openfeature.dev/docs/reference/other-technologies/ofrep/openapi) with interactive documentation.