Conversation
Document opaque Response endpoints with explicit JSON object and string response schemas so SmallRye emits valid OpenAPI types. This removes 86 oas-missing-type findings and raises Vacuum quality from 89 to 98. No Java return signatures or runtime behavior changed.
Member
|
Discussed at tech hours. @poikilotherm plans to reply. See also this thread: #dev > Improve OpenAPI descriptions with AI @ 💬 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a followup to PR #12439. SmallRye OpenAPI plugin generator has been updated to 4.3.5, which generates empty schema types.
This PR documents opaque
Responseendpoints with explicit JSON object and string response schemas so SmallRye emits valid OpenAPI types. This removes 86oas-missing-typefindings and raises Vacuum quality from 89 to 98.No Java return signatures or runtime behavior changed.
Which issue(s) this PR closes:
Closes #12701
Suggestions on how to test this:
Use same Vacuum settings as in #12439
Should we maybe add some form of vacuum test to the dataverse test suite, so that we are always aware of OpenAPI regressions?