Openapi-swaggerui guide - reference MicroProfile OpenAPI Core configuration

[rsvoboda]

Reference MicroProfile OpenAPI Core configuration

• Fixes: Add ability to hide rest endpoints from OpenAPI schema / Swagger #40007

[rsvoboda]

/CC @MikeEdgar @phillip-kruger

[github-actions]

🙈 The PR is closed and the preview is expired.

[MikeEdgar]

LGTM. Note to self - update spec link(s) when bumping to smallrye-open-api 4.0.

[gsmet]

I'm all for merging this but do we also have a pointer for the annotations mentioned in #40007 (comment) ?

[MikeEdgar]

JavaDoc for @Operation#hidden is : https://download.eclipse.org/microprofile/microprofile-open-api-3.1.2/apidocs/org/eclipse/microprofile/openapi/annotations/Operation.html#hidden()

[rsvoboda]

@gsmet there is no reference for that in https://download.eclipse.org/microprofile/microprofile-open-api-3.1.1/microprofile-openapi-spec-3.1.1.html#_operation

Spec html points also to https://github.com/eclipse/microprofile-open-api/wiki which and https://github.com/eclipse/microprofile-open-api/wiki/Annotation-Samples#operation-sample shows an example with hidden = true attribute

So it's pretty hidden :) Pointer for the annotations mentioned in #40007 (comment) should be ideally in MicroProfile OpenAPI Specification document.
For our guide I'm not sure where to put info about that. @Operation is mentioned only in https://quarkus.io/guides/openapi-swaggerui#auto-generation-of-operation-id

[gsmet]

Maybe a generic sentence saying that more information about the MicroProfile OpenAPI annotations can be found in the MicroProfile OpenAPI API Javadoc: https://download.eclipse.org/microprofile/microprofile-open-api-3.1.2/apidocs/org/eclipse/microprofile/openapi/annotations/package-summary.html .

Not perfect but still better than nothing.

And yes, I totally concur on the fact that it should be the MicroProfile OpenAPI doc containing this information.

[rsvoboda]

PR updated

[quarkus-bot]

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 17c870c.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

[rsvoboda]

@gsmet good to go?