Allow recursive schemas in multipart-based paths #813
Merged
+211 −7
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
czechboy0 reviewed Aug 25, 2025
Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift Outdated Show resolved Hide resolved
| Thank you, @ptoffy - added one comment about the test, I think we need to tweak it to prove out that this change really makes recursive schemas work with multipart. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Motivation
Fixes #769
Currently, as seen in the issue mentioned above, if a recursive schema gets referenced from a multipart-based path, a reference cycle error gets thrown. Since we support recursive type generation already, this shouldn't happen.
Modifications
This PR removes the last
dereferenced(in:)method call, which would throw if a reference cycle was found, replacing it with a simple lookup in the OpenAPI components tree. It also replacesDerereferencedJSONSchemawithJSONSchemaaccordingly.Result
Multipart-based paths can now reference recursive types.
Test Plan
This also adds a test with such a case. We could probably also add a test with a multipart path referencing an array of references instead of just a reference to be thorough.