OpenAPI extensions should be included in the UI

[Stwissel]

Is there an existing request for this feature?

• [X] I have searched the existing issues for this feature request and I know that duplicates will be closed

Is your feature request related to a problem?

We use x-extensions to configure our API, they are not visible in the edit form or the preview

Describe the solution you'd like

OpenAPI allows extensions:

• 3.0.x https://spec.openapis.org/oas/v3.0.0.html#specification-extensions
• 3.1 https://spec.openapis.org/oas/v3.1.0.html#specification-extensions

When added to the OpenAPI source code, they are preserved, but they are not visible anywhere in form or preview which makes them hard to use. Has been solved in other GUIs:

P.S.: Love your work!

Describe alternatives you've considered

Use apicur.io to cross check

Additional context

No response

[apigitlabs]

hi @Stwissel ,

Thank you for highlighting this requirement. We understand the need to support the OpenAPI x-extension. However, it was initially a lower priority for us as this extension is quite vendor-specific and can appear at various levels within the OpenAPI specification. Our code editor currently has the flexibility to support it in any configuration.

Could you share more about where exactly you plan to use the extension in your spec? For instance, is it at the root, path, operation, or schema level? If this is a common use case, we could prioritize implementing quick support for it ahead of a full extension rollout in the form editor.

[Stwissel]

We use x-roles on the method level to define the roles for RBAC. That's our current use. We used other x-... flags on the path level and inside info before. It is quite common (e.g https://www.npmjs.com/package/express-openapi-validator )

[apigitlabs]

thanks @Stwissel for the quick response and valuable suggestion, we will take a look and let you know if there is any update.

[Stwissel]

A big step would be just show them in form mode, so they can be seen. For editing the source mode would do.

[apigitlabs]

thanks @Stwissel , per your request, we have get it supported in spec info and spec method level. please refresh browser to take a look if it match your expect.

[Stwissel]

You people are awesome. Some finishing touches needed:

• doesn't show in the SwaggerUI
• doesn't show in ReDoc

I checked, current Swagger does display extensions, so it might just need a library update.

ReDoc doesn't seem to show, so I would put that on low priority until upstream provides

[apigitlabs]

thanks @Stwissel , it is a configuration on Swagger ui, we have added it support. please refresh browser to have a try.

[apigitlabs]

hi @Stwissel , can you let me know if everything work well for you ?

[Stwissel]

all good, you people are awesome