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.

Sign up for GitHub

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

Jump to bottom

Openapi-swaggerui guide - reference MicroProfile OpenAPI Core configuration #43593

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Openapi-swaggerui guide - reference MicroProfile OpenAPI Core configuration #43593

merged 1 commit into from
Oct 1, 2024
+5 −0

Conversation

rsvoboda
Copy link
Member

@rsvoboda rsvoboda commented Sep 30, 2024 •
edited by geoand
Loading

Reference MicroProfile OpenAPI Core configuration

@rsvoboda rsvoboda mentioned this pull request Sep 30, 2024
Closed
@rsvoboda
Copy link
Member Author

/CC @MikeEdgar @phillip-kruger

@geoand geoand added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Sep 30, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 30, 2024 •
edited
Loading

🙈 The PR is closed and the preview is expired.

@quarkus-bot

This comment has been minimized.

Sign in to view
MikeEdgar
MikeEdgar approved these changes Sep 30, 2024
View reviewed changes
Copy link
Contributor

@MikeEdgar MikeEdgar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@gsmet
Copy link
Member

gsmet commented Sep 30, 2024

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

@MikeEdgar
Copy link
Contributor

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
Copy link
Member Author

@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
Copy link
Member

gsmet commented Sep 30, 2024

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
Copy link
Member Author

PR updated

@quarkus-bot
Copy link

quarkus-bot bot commented Sep 30, 2024

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
Copy link
Member Author

rsvoboda commented Oct 1, 2024

@gsmet good to go?

@gsmet gsmet merged commit de41930 into quarkusio:main Oct 1, 2024
5 checks passed
@quarkus-bot quarkus-bot bot added kind/enhancement New feature or request and removed triage/waiting-for-ci Ready to merge when CI successfully finishes labels Oct 1, 2024
@quarkus-bot quarkus-bot bot added this to the 3.16 - main milestone Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gsmet gsmet gsmet approved these changes

@phillip-kruger phillip-kruger phillip-kruger approved these changes

@MikeEdgar MikeEdgar MikeEdgar approved these changes

Assignees
No one assigned
Labels
area/documentation kind/enhancement New feature or request triage/backport
Projects
None yet
Milestone
3.16 - main
Development

Successfully merging this pull request may close these issues.

Add ability to hide rest endpoints from OpenAPI schema / Swagger
5 participants
@rsvoboda @gsmet @MikeEdgar @phillip-kruger @geoand