OpenAPI: Fix ModelMetadata null reference exception in emitted XMLComment transformers #63872
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
…ment transformers When a route parameter does not have a bound model it would case a null reference exception because the ModelMetadata on the ParameterDescriptor was null. This is fixed by adding a null reference check Fixes dotnet#63757
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a null reference exception in the OpenAPI source generator that occurs when processing route parameters that don't have bound models. The fix adds a null check for ModelMetadata before accessing its properties.
- Adds null safety check for ModelMetadata in XML comment transformer generation
- Updates all generated test snapshots to reflect the fix
- Includes a new test case to verify the fix works correctly
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/OpenApi/gen/XmlCommentGenerator.Emitter.cs | Adds null check before accessing ModelMetadata properties |
| src/OpenApi/test/.../OperationTests.Controllers.cs | Adds test case for unused route parameters scenario |
| Multiple snapshot files | Updates generated code snapshots to include the null check |
dotnet-policy-service
bot
added
the
community-contribution
|
Thanks for your PR, @@desjoerd. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
github-actions
bot
added
the
area-mvc
...pshots/AddOpenApiTests.CanInterceptAddOpenApi#OpenApiXmlCommentSupport.generated.verified.cs
Outdated
Show resolved
Hide resolved
As I think this was the encoding before my change
martincostello
approved these changes
Sep 30, 2025
|
@captainsafia could you review this? Maybe it's still possible to backport this fix into .NET 10. Also when thinking of fixing potential review comments 😊. |
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.
When a route parameter does not have a bound model it would case a null reference exception because the ModelMetadata on the ParameterDescriptor was null. This is fixed by adding a null reference check
Fixes #63757