quarkusio / quarkus

Quarkus: Supersonic Subatomic Java.
https://quarkus.io
Apache License 2.0
13.78k stars 2.68k forks source link

Provide a way to exclude /q/health from OpenAPI spec #42912

Closed brice-laurencin closed 2 months ago

brice-laurencin commented 2 months ago

Description

SmallRye health is add through a filter here. I'd like to be able to deactivate the addition of those endpoints to the generated openapi.json/yaml file.

I suppose a property in application.properties would help here.

Thanks!

Implementation ideas

No response

quarkus-bot[bot] commented 2 months ago

/cc @EricWittmann (openapi), @MikeEdgar (openapi), @jmartisk (health), @phillip-kruger (openapi), @xstefank (health)

MikeEdgar commented 2 months ago

@brice-laurencin, there is already a property which defaults to false. Do you have either of the following configurations set?

quarkus.smallrye-health.openapi.included=true
# deprecated as of 3.14
quarkus.health.openapi.included=true
brice-laurencin commented 2 months ago

Indeed! thanks a lot for pointing that out.