Skip to content

Conversation

@MikeEdgar
Copy link
Contributor

Closes #46628

Disables by default the automatic merging of OpenAPI schema example into the new examples array introduced in the OpenAPI specification version 3.1.0. See Swagger UI issue described in #46628 that is affected by the merging of examples.

Users may enable the new configuration property if desired.

@quarkus-bot

This comment has been minimized.

@quarkus-bot

This comment has been minimized.

@github-actions
Copy link

github-actions bot commented Mar 23, 2025

🎊 PR Preview d83f84f has been successfully built and deployed to https://quarkus-pr-main-46956-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Thanks. You probably need to adjust the TCK test configuration to use this new config though.

What's the plan for when Swagger actually handles this correctly?

@MikeEdgar
Copy link
Contributor Author

You probably need to adjust the TCK test configuration to use this new config though.

👍 , this will likely have some impact on tests as well, FYI @michalvavrik

What's the plan for when Swagger actually handles this correctly?

Later versions of Swagger should handle either example or examples properly. It's actually already released, but as that includes functional changes I did not propose that here for 3.20.x. However, that is an alternate approach if it's fine to bump Swagger from 5.18.2 to 5.20.1.

@quarkus-bot

This comment has been minimized.

@quarkus-bot

This comment has been minimized.

@quarkus-bot
Copy link

quarkus-bot bot commented Mar 25, 2025

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit 28eade7.

✅ 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.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

You can consult the Develocity build scans.

@quarkus-bot
Copy link

quarkus-bot bot commented Mar 25, 2025

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 28eade7.

✅ 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.

@gsmet gsmet merged commit 23cef13 into quarkusio:main Mar 25, 2025
31 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.22 - main milestone Mar 25, 2025
@MikeEdgar MikeEdgar deleted the issue-46628 branch March 25, 2025 15:57
@gsmet
Copy link
Member

gsmet commented Mar 25, 2025

@MikeEdgar I merged this one. What I suggest is to prepare another PR to undo part of that and update Swagger UI. Once released for some time, we can rediscuss if it makes sense to push it to 3.20 LTS.

Thanks!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

swagger ui does not show schema examples after migration to quarkus 3.19

3 participants