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

OpenAPI: provide a way to customize the header info text #21221

Closed
loicmathieu opened this issue Nov 5, 2021 · 2 comments · Fixed by #21261
Closed

OpenAPI: provide a way to customize the header info text #21221

loicmathieu opened this issue Nov 5, 2021 · 2 comments · Fixed by #21261
Assignees
Milestone

Comments

@loicmathieu
Copy link
Contributor

Description

The OpenAPI header info text is auto generated by Quarkus to something like app-name version (quarkus quarkus-version).

Today, it can only be customize by providing a style.css file, but it needs to provides all the styles in it and not juste the one that need to be customize as style.css will replace the generated one. It's also a little complex to provide a CSS to manage text content.

The current text value can be an issue if OpenAPI is planed to be deployed on production as it contains technical information so it's a security vulnerability as defined in the OWASP top 10 vulnerabilities: information disclosure.

Quarkus may provide a way to easily customize this text.

Implementation ideas

Provide a way to customize the header info text via application.properties

quarkus.swagger-ui.header-info=foo bar

Another solution would be to provide an header-info-enable property and not a custimization. Both solutions are OK for me.

@quarkus-bot
Copy link

quarkus-bot bot commented Nov 5, 2021

@phillip-kruger phillip-kruger self-assigned this Nov 5, 2021
@phillip-kruger
Copy link
Member

Thanks ! I'll do this fix a.s.a.p

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants