[OpenAPI] Properly handle recursive input types#9855
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the OpenAPI adapter’s schema generation so recursive (self-referencing and mutually-referencing) GraphQL input types can be represented safely in OpenAPI by emitting reusable components ($ref) instead of endlessly inlining input-object schemas. It also expands the integration test suite with recursive input/output scenarios and updates snapshots accordingly.
Changes:
- Refactors
DynamicOpenApiDocumentTransformerto introduce a statefulDocumentBuilderthat registers input object types as OpenAPI components to break cycles. - Adds test schema types + integration tests covering self-referencing and indirect recursive input/output cases.
- Updates/introduces snapshot files to validate the new OpenAPI output across target frameworks.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/HotChocolate/Adapters/src/Adapters.OpenApi.AspNetCore/DynamicOpenApiDocumentTransformer.cs | Refactors document building and adds input-component registration to handle recursive input types. |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/TestSchema.cs | Adds recursive input/output types and operations used by OpenAPI integration tests. |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/OpenApiIntegrationTests.cs | Adds new integration tests for recursive input/output OpenAPI generation. |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.SelfRef_Input_Type_Via_Mutation_Body_NET9_0.json | New snapshot for self-referencing input handling (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.SelfRef_Input_Type_Via_Mutation_Body_NET10_0.json | New snapshot for self-referencing input handling (NET10). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.SelfRef_Output_Type_Via_Query_NET9_0.json | New snapshot for recursive-ish output selection handling (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.SelfRef_Output_Type_Via_Query_NET10_0.json | New snapshot for recursive-ish output selection handling (NET10). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.Indirect_Input_Type_Via_Mutation_Body_NET9_0.json | New snapshot for indirect recursive input handling (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.Indirect_Input_Type_Via_Mutation_Body_NET10_0.json | New snapshot for indirect recursive input handling (NET10). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.Indirect_Output_Type_Via_Query_NET9_0.json | New snapshot for indirect recursive output selection handling (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.Indirect_Output_Type_Via_Query_NET10_0.json | New snapshot for indirect recursive output selection handling (NET10). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.Indirect_Input_Type_With_Two_Sibling_Occurrences_NET9_0.json | New snapshot verifying repeated sibling input occurrences emit $ref consistently (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTests.Indirect_Input_Type_With_Two_Sibling_Occurrences_NET10_0.json | New snapshot verifying repeated sibling input occurrences emit $ref consistently (NET10). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTestBase.OpenApi_Includes_Initial_Routes_NET9_0.json | Snapshot update reflecting new componentized input schemas (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTestBase.OpenApi_Includes_Initial_Routes_NET9_0_Fusion.json | Snapshot update reflecting new componentized input schemas for Fusion (NET9). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTestBase.OpenApi_Includes_Initial_Routes_NET10_0.json | Snapshot update reflecting new componentized input schemas (NET10). |
| src/HotChocolate/Adapters/test/Adapters.OpenApi.Tests/OpenApi/snapshots/OpenApiIntegrationTestBase.OpenApi_Includes_Initial_Routes_NET10_0_Fusion.json | Snapshot update reflecting new componentized input schemas for Fusion (NET10). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jun 16, 2026
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.
No description provided.