Fix missing exception response types in OpenAPI spec #2577
Merged
+2
−1
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.
Since e893628, some error response types referenced by the schema in
$ref
's were missing from the spec.For example, we have a custom error response type that gets returned via
@ControllerAdvice
when we throw a specific exception type. In v2.3.0, these were correctly included in the OpenAPI spec. Starting in v2.4.0 these were missing, creating an invalid schema.e.g.:
and then later down, we should have
BadRequestExceptionResponse
in the spec under.compoents.schemas
like this:Quick
git bisect
revealed that this broke in e893628. I don't fully know the logic behind that commit, but the attached pull request gets the missing items back in the schema for us by changing how the ObjectMapper is constructed back to the way it was before e893628