Extension Labels instead of keys

Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation

https://redocly.github.io/redoc/

MIT License

23.68k stars 2.31k forks source link

Extension Labels instead of keys #787

Closed theomega closed 1 year ago

theomega commented 5 years ago

The extension support is nice, but it uses the key from the openapi spec as label. It would be nice to have the possibility to change the label in ReDoc.

Example:

I'd love to replace x-olt-permissions with something more descriptive in ReDoc.

Is there a possibility to do so? Or anyone having implemented something like that?

RomanHotsiy commented 5 years ago

It's not possible to do it right now. But I think we can implement an option for this.

@ingoclaro PR would be appreciated 😉

ingoclaro commented 5 years ago

Maybe supplying a map of key value as an option to ReDoc?

theomega commented 5 years ago

Maybe supplying a map of key value as an option to ReDoc?

I was thinking the same, although I could decide on what should be the key and the values: "Description" -> "YAML Field" or "YAML Field" -> Description

The second one makes more sense IMHO as the "YAML Field" is definitively unique, but the Description could not be unique...

lornajane commented 1 year ago

Out of scope for the project at this time, but we're open to pull requests for specific tag support.