Update swagger - #17
Merged
Merged
Conversation
SirCotare
force-pushed
the
update-swagger
branch
from
February 25, 2025 07:41
d635a8d to
88cd1c4
Compare
ThoSap
approved these changes
Feb 25, 2025
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
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.
There has been a change in the swagger library that breaks our "nullablility hack".
We want to set all properties to be not-null/required by default. And just those annotated with
@Nullableshould be nullable. Swagger does do it the other way round with no option to change that.Unfortunately setting the nullablity flag of the property seems to no longer work as it get overwritten at some point. So I changed it to misuse the "title" field to basically do the same thing as before.
Maybe in a future iteration, we could work out something to write json in to the description field to be able to carry more of that metadata in a more controlled way. But for not this should suffice.