search

flipt-io / docs

https://www.flipt.io/docs (powered by https://mintlify.com/)
https://www.flipt.io/docs
8 stars 14 forks source link

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

Closed markphelps closed 3 months ago

markphelps commented 3 months ago

Re: https://github.com/flipt-io/flipt/pull/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?

erka commented 3 months ago

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

markphelps commented 3 months ago

@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 commented 3 months ago

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