Fix some issues in generated OpenAPI spec #824
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
mnonnenmacher
requested review from
bs-ondem,
MarcelBochtler,
nnobelis,
oheger-bosch and
sschuberth
as code owners
Enable the option to mark optional properties as not required in the OpenAPI spec. Otherwise, some (but for some reason not all) properties with default arguments are still marked as required in the generated OpenAPI spec. Relates to eclipse-apoapsis#605. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
The `OptionalValue` class is only used in Kotlin code to model the difference between `null` values and not present values for PATCH requests. In the JSON request bodies such properties can simply be omitted. Configure type redirects for `OptionalValue` to its generic types used in the API classes to eliminate the class from the generated OpenAPI spec. Fixes eclipse-apoapsis#821. Relates to eclipse-apoapsis#605. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
mnonnenmacher
force-pushed
the
fix-openapi-spec
branch
from
bd36c75
to
181a4bb
Compare
nnobelis
approved these changes
Aug 16, 2024
sschuberth
reviewed
Aug 16, 2024
| @@ -116,7 +117,9 @@ fun Application.configureOpenApi() { | |||
| } | |||
| .connectSubTypes() | |||
| .handleNameAnnotation() | |||
| .generateSwaggerSchema() | |||
| .generateSwaggerSchema { | |||
| optionalHandling = OptionalHandling.NON_REQUIRED | |||
There was a problem hiding this comment.
Weird that it is not the default to mark optional properties as not required... 😕
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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.
Please see the commit messages for details.