Fix embedded ID relation response schemas - #3334
Open
hej090224 wants to merge 2 commits into
Open
Conversation
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.
Summary
@EmbeddedId/@MapsIdregression fixture and compare the complete generated OpenAPI 3.1 document with a golden file.Root cause
SpringDocDataRestUtilsrewrote top-level and_embeddedentity response references, but did not rewrite associations to entities that were not themselves exported as repositories. Those properties retained the raw ModelConverters schema, which expanded the@EmbeddedIdand@MapsIdassociation fields recursively.Compatibility
The change is limited to non-exported Spring Data REST association properties in generated response schemas. Existing exported relation handling, request schemas, and relation-free embeddables remain unchanged.
Testing
mvn -pl springdoc-openapi-tests/springdoc-openapi-data-rest-tests -am -Dtest=SpringDocApp40Test '-Dsurefire.failIfNoSpecifiedTests=false' testmvn -pl springdoc-openapi-tests/springdoc-openapi-data-rest-tests -Dtest=SpringDocApp40Test '-Dsurefire.failIfNoSpecifiedTests=false' testmvn -pl springdoc-openapi-tests/springdoc-openapi-data-rest-tests test(79 tests pass)mvn install(the reactor reachedspringdoc-openapi-javadoc-tests, where existing Javadoc golden-output tests fail because descriptions, summaries, and tags are missing; the targeted app40 test and data REST module pass)Fixes #3136