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.

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

Conversation

markphelps
Copy link
Contributor

Re: flipt-io/flipt#3357

@erka I noticed that enums are now returned as integer types in the generated OpenAPI spec. I wonder if there is a way we can override that to denote the string values?

Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
@markphelps markphelps requested a review from erka August 7, 2024 19:24
@markphelps markphelps requested a review from a team as a code owner August 7, 2024 19:25
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
@erka
Copy link
Collaborator

erka commented Aug 7, 2024

@markphelps probably enum_type=string opt for google-gnostic-openapi could help with it in buf.gen.yaml. Does it solve this problem?

Copy link
Collaborator

@erka erka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

The drawback is that the openapi.yaml could have unreleased feature in main. I think that will be a rare event.

@markphelps
Copy link
Contributor Author

@markphelps probably enum_type=string opt for google-gnostic-openapi could help with it in buf.gen.yaml. Does it solve this problem?

I will try it. Good shout

@markphelps
Copy link
Contributor Author

nice!

The drawback is that the openapi.yaml could have unreleased feature in main. I think that will be a rare event.

Yeh it won't actually show on the docs until we add the mdx files and add it to mint.json so shouldn't be an issue

@markphelps markphelps merged commit 53bcc1b into main Aug 7, 2024
3 checks passed
@markphelps markphelps deleted the openapi branch August 7, 2024 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants