Config property to include health endpoints in OpenAPI definition

Description As discussed in Zulip it could be useful to include the health endpoints (like /health) in the OpenAPI definition for the application.

Our use case for this is that we are deploying our applications to Azure and register all endpoints with its API management. If an endpoint (like /health) isn’t registered there, it can’t be called by other applications. For this reason we would like to have an option to include the MicroProfile Health endpoints in the generated OpenAPI definition.

Implementation ideas As discussed on Zulip one idea would be to add a new configuration property to the quarkus-smallrye-openapi extension, which when set and quarkus-smallrye-health is available, would automatically add the health endpoints to the OpenAPI definition.

[kenfinnigan]

We need to be very careful about this, as it does open up possible security concerns exposing what is “internal APIs” to exposure.

I would suggest this is only enabled is the OpenAPI endpoint is secured, or it’s DEV mode.

@n1hility @maxandersen might have comments too

[maxandersen]

this all sounds reasonable imo. agree with @kenfinnigan security concern but making this an optional opt-in and there is a usecase for azure to make it even work I think we should be fine.