Respect IModelNameProvider when matching OpenAPI parameters #64535

khellang · 2025-11-26T08:45:57Z

Description

This makes sure any attribute implementing IModelNameProvider is respected when matching OpenAPI operation parameters with .NET action parameters.

Fixes #64534
Fixes #64521

Copilot

Pull request overview

This pull request adds support for respecting IModelNameProvider attributes (like FromQuery(Name = "...")) when matching OpenAPI operation parameters with .NET action parameters for XML comment documentation. This ensures that XML documentation comments are correctly applied to parameters that have custom names specified via model binding attributes.

Key Changes:

Introduces a new GetOperationParameter helper method that considers both the parameter's original name and any custom names from IModelNameProvider attributes
Adds early null check for parameterInfo before attempting to match operation parameters
Updates generated code across all snapshot test files to include the new logic

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

File	Description
src/OpenApi/gen/XmlCommentGenerator.cs	Adds `System.Reflection` using statement for `ParameterInfo` type
src/OpenApi/gen/XmlCommentGenerator.Emitter.cs	Implements the core logic for parameter matching with `IModelNameProvider` support; adds `GetOperationParameter` helper method and includes `Microsoft.AspNetCore.Mvc.ModelBinding` namespace
src/OpenApi/test/.../snapshots/*.verified.cs	Updates all snapshot test files to reflect the generated code changes from the source generator

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs

khellang · 2025-11-26T11:45:53Z

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs

                            var requestBody = operation.RequestBody;
                            if (requestBody is not null)
                            {
                                requestBody.Description = parameterComment.Description;


@captainsafia Do you know why this fallback exists? We're seeing the CancellationToken argument being applied to the request body because of this, which is weird 🤔

Added a check to skip CancellationToken to avoid applying its XML doc to the request body. I can't see a scenario where you'd ever want to include a cancellation token in your OpenAPI docs 😅

Ideally, instead of checking against typeof(CancellationToken) directly, it should probably check against the binding source to see if it's BindingSource.Body instead of just blindly falling back to setting the request body description.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

...enApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/OperationTests.Controllers.cs

silkfire · 2025-12-30T23:21:22Z

@khellang Could this be merged soon?

khellang · 2025-12-30T23:23:23Z

@khellang Could this be merged soon?

Sure. If it was up to me, this would've shipped long ago, as it's a major blocker for .NET 10 adoption for us. Unfortunately I don't control the review and merge process here. Someone on the ASP.NET team needs to review and merge it. And judging by the lack of activity here, it looks like it could take a while 😅

mikekistler · 2025-12-31T16:26:44Z

Thank you for this contribution!

I spent a little time this morning investigating and it appears that this problem also exists for Minimal APIs. I'm going to add that tag to the PR. Could you add a test in

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/OperationTests.MinimalApis.cs

that verifies the fix also works for Minimal APIs?

khellang · 2026-01-06T08:24:02Z

Could you add a test in

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/OperationTests.MinimalApis.cs

that verifies the fix also works for Minimal APIs?

Will add it and check 👍🏻

khellang · 2026-01-06T11:11:18Z

I've reverted the change from @desjoerd's comment and added a test that verifies the fix for Minimal APIs as well. This should be ready for review again.

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated no new comments.

mikekistler

Looks good! 👍

@captainsafia I will defer to you for formal approval, but this all looks good to me.

Copilot AI review requested due to automatic review settings November 26, 2025 08:45

khellang requested review from a team and captainsafia as code owners November 26, 2025 08:45

github-actions bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Nov 26, 2025

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Nov 26, 2025

Copilot started reviewing on behalf of khellang November 26, 2025 08:46 View session

Copilot finished reviewing on behalf of khellang November 26, 2025 08:49

Copilot AI reviewed Nov 26, 2025

View reviewed changes

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs Outdated Show resolved Hide resolved

martincostello added area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates feature-openapi and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Nov 26, 2025

khellang force-pushed the fix/openapi-name-provider branch 3 times, most recently from 68d5b6f to 16a616e Compare November 26, 2025 09:27

khellang requested a review from Copilot November 26, 2025 09:27

Copilot started reviewing on behalf of khellang November 26, 2025 09:27 View session

Copilot finished reviewing on behalf of khellang November 26, 2025 09:30

Copilot AI reviewed Nov 26, 2025

View reviewed changes

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs Outdated Show resolved Hide resolved

khellang force-pushed the fix/openapi-name-provider branch from 16a616e to d6a6aaa Compare November 26, 2025 10:11

khellang requested a review from Copilot November 26, 2025 11:13

Copilot started reviewing on behalf of khellang November 26, 2025 11:14 View session

Copilot finished reviewing on behalf of khellang November 26, 2025 11:15

Copilot AI reviewed Nov 26, 2025

View reviewed changes

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs Outdated Show resolved Hide resolved

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs Show resolved Hide resolved

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs Outdated Show resolved Hide resolved

khellang requested a review from Copilot November 26, 2025 11:40

Copilot started reviewing on behalf of khellang November 26, 2025 11:40 View session

Copilot finished reviewing on behalf of khellang November 26, 2025 11:42

khellang commented Nov 26, 2025

View reviewed changes

Copilot AI reviewed Nov 26, 2025

View reviewed changes

...enApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/OperationTests.Controllers.cs Outdated Show resolved Hide resolved

khellang mentioned this pull request Nov 26, 2025

Open API documentation is not generated from XML comments with header parameters #64521

Open

1 task

build-analysis bot mentioned this pull request Nov 26, 2025

Known Build Error: error : Cannot create a file when that file already exists. #61178

Open

khellang closed this Dec 30, 2025

khellang reopened this Dec 30, 2025

dotnet-policy-service bot added this to the 11.0-preview1 milestone Dec 30, 2025

mikekistler added the area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc label Dec 31, 2025

ilonatommy mentioned this pull request Jan 5, 2026

Exclude localize files from newline check and remove trailing newlines from templatestrings.*.json #64911

Merged

4 tasks

khellang added 9 commits January 6, 2026 10:01

Add test demonstrating the issue

0523aa3

Respect IModelNameProvider when matching OpenAPI parameters

0d81048

Extract helper method to get model names

9d34c65

Also respect IModelNameProvider when getting XML docs for properties

f2a9a34

Fix nullability warnings from Copilot

a795565

Add test to verify cancellation token description

8552e45

Don't include CancellationToken when applying XML doc description

c5aa96c

Remove unused usings

99077e4

Make assert less specific to avoid regressions

d0c6e16

khellang force-pushed the fix/openapi-name-provider branch 2 times, most recently from 78cbcd9 to d6049c6 Compare January 6, 2026 09:51

khellang added 3 commits January 6, 2026 12:06

Add test for Minimal APIs

3a99e0c

Don't fetch model names if there are no parameters

b2f8243

Add back missing parameter and fix support for missing parameters

99560e2

khellang force-pushed the fix/openapi-name-provider branch from d6049c6 to 99560e2 Compare January 6, 2026 11:06

khellang requested a review from Copilot January 6, 2026 11:12

Copilot started reviewing on behalf of khellang January 6, 2026 11:12 View session

Copilot AI reviewed Jan 6, 2026

View reviewed changes

mikekistler reviewed Jan 6, 2026

View reviewed changes

desjoerd approved these changes Jan 6, 2026

View reviewed changes

Respect IModelNameProvider when matching OpenAPI parameters #64535

Are you sure you want to change the base?

Respect IModelNameProvider when matching OpenAPI parameters #64535

Uh oh!

Conversation

khellang commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

khellang Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

khellang Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

khellang Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

silkfire commented Dec 30, 2025

Uh oh!

khellang commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mikekistler commented Dec 31, 2025

Uh oh!

khellang commented Jan 6, 2026

Uh oh!

khellang commented Jan 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

mikekistler left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

khellang commented Nov 26, 2025 •

edited

Loading

khellang Nov 26, 2025 •

edited

Loading

khellang commented Dec 30, 2025 •

edited

Loading