Skip to content
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.

Sign up for GitHub

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

chore: use openapi doc from Flipt repo; add OFREP docs #258

Merged
merged 4 commits into from
Aug 7, 2024
Merged

chore: use openapi doc from Flipt repo; add OFREP docs #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54948fe
chore: use openapi doc from Flipt repo; add OFREP docs
markphelps Aug 7, 2024
01a0a40
chore: rm fetch openapi workflow
markphelps Aug 7, 2024
5e4c7a9
chore: fmt
markphelps Aug 7, 2024
d26f220
chore: simplify ofrep config curl example
markphelps Aug 7, 2024
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
47 changes: 0 additions & 47 deletions .github/workflows/fetch-openapi.yml
View file
Open in desktop

This file was deleted.

12 changes: 12 additions & 0 deletions integration/openfeature.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,15 @@
> Need a client in another language? Let us know!
</Card>
</CardGroup>

## Remote Evaluation Protocol

Check warning on line 81 in integration/openfeature.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Remote Evaluation Protocol' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Remote Evaluation Protocol' should be in sentence case", "location": {"path": "integration/openfeature.mdx", "range": {"start": {"line": 81, "column": 4}}}, "severity": "WARNING"}

The OpenFeature Remote Evaluation Protocol (OFREP) is an API specification for feature flagging that allows the use of generic providers to connect to any feature flag management systems that support the protocol.

Check warning on line 83 in integration/openfeature.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "integration/openfeature.mdx", "range": {"start": {"line": 83, "column": 1}}}, "severity": "WARNING"}

Flipt is one of the early adopters of the OFREP protocol and has implemented the protocol in its API.

The OFREP protocol is still in the early stages of development, so the specification is subject to change.

Check warning on line 87 in integration/openfeature.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "integration/openfeature.mdx", "range": {"start": {"line": 87, "column": 65}}}, "severity": "WARNING"}

The API documentation for the OFREP protocol implementation in Flipt is available in the [OpenFeature Remote Evaluation](/reference/openfeature/overview) API documentation.

For more information on the OFREP protocol, see the [OpenFeature Remote Evaluation Protocol](https://github.com/open-feature/protocol) repository on GitHub.
9 changes: 9 additions & 0 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"mode": "simple"
}
},
"openapi": "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml",
"favicon": "/favicon.svg",
"colors": {
"primary": "#7C3AED",
Expand Down Expand Up @@ -307,6 +308,14 @@
"reference/evaluation/batch-evaluation"
]
},
{
"group": "OpenFeature Evaluation",
"pages": [
"reference/openfeature/overview",
"reference/openfeature/configuration",
"reference/openfeature/flag-evaluation"
]
},
{
"group": "Namespaces",
"pages": [
Expand Down
Loading
Loading