-
Notifications
You must be signed in to change notification settings - Fork 354
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.
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
fix: OpenAPI - WebMessage response as oneOf schema [DHIS2-18251] #18858
Merged
Conversation
This file contains 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
Signed-off-by: Jan Bernitt <[email protected]>
…o openapi-web-message
jbee
changed the title
chore: WebMessage cleanup
fix: OpenAPI - WebMessage response as oneOf schema [DHIS2-18251]
Oct 21, 2024
Quality Gate passedIssues Measures |
david-mackessy
approved these changes
Oct 21, 2024
vietnguyen
approved these changes
Oct 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Goal was to fix the OpenAPI reflection of the
WebMessage.response
property.This has always been a special handling situation around
WebMessageResponse
. The issue was that the classes were located in modules that could not be referenced and so special handling was hard-coded.This PR removes this special handling and details the property with all the possible types (
oneOf
in OpenAPI terms).This now looks like this
To get there a cleanup was required which mainly moved files around and removed special handling.
BasicWebMessage
WebMessage
itself is not aWebMessageResponse
AbstractWebMessageResponse
WebMessageResponse
are inweb-api
moduleWebMessageResponse
always states itsresponseType
based on theClass.getSimpleName()
(existed as a concept before but wasn't used/implemented consistently)BasicWebMessage
(WebMessage
has web layer refs and cannot be used and fields added would be null anyhow for errors)Most classes were moved without changing the package to reduce the risk of breaking something odd.
A few exceptions were moved into another package when it felt safe to do so.
Long term we have to cleanup the packages in another PR.
Manual Testing
Open
/api/openapi/openapi.html?domain=DataElement#WebMessage
and compare to image above