Skip to content

Fix ApiExplorer to include FromQuery(Name) prefix in parameter names #68344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Youssef1313 merged 3 commits into from
Aug 19, 2026
Merged

Fix ApiExplorer to include FromQuery(Name) prefix in parameter names #68344

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9223b65
Fix ApiExplorer to include FromQuery(Name) prefix in parameter names
snemeckayova Aug 11, 2026
60598ff
Add test coverage
snemeckayova Aug 12, 2026
0e53fbd
Fix header binding
snemeckayova Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Mvc/Mvc.ApiExplorer/src/DefaultApiDescriptionProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ private void Visit(

// We don't want to append the **parameter** name when building a model name.

@Youssef1313 Youssef1313 Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update this comment as well to reflect the updated condition.

And correct me if I'm wrong, I think modelMetadata.ContainerType != null is responsible for appending a property name, so it prevents appending parameter name. But then the other check can append a parameter name but if and only if explicitly given via IModelNameProvider.

var newContainerName = containerName;
if (modelMetadata.ContainerType != null)
if (modelMetadata.ContainerType != null || !string.IsNullOrEmpty(bindingContext.BinderModelName))
{
newContainerName = GetName(containerName, bindingContext);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Mvc/Mvc.ApiExplorer/test/DefaultApiDescriptionProviderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1624,7 +1624,7 @@ public void GetApiDescription_ParameterDescription_FromQueryEmployee()
var description = Assert.Single(descriptions);
Assert.Single(description.ParameterDescriptions);

var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Name");
var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "employee.Name");

@Youssef1313 Youssef1313 Aug 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if Employee class had a property that had [FromHeader("X-MyCustomHeader")]?

Are we prefixing this as well? And is it expected to be prefixed? Same question applies to FromRoute

In addition, let's make sure we have equivalent tests for both Mvc and minimal API, including tests directed for OpenAPI

@Youssef1313 Youssef1313 Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If no scenario here is applicable for minimal API (e.g, an analyzer warning is produced), feel free to skip the minimal API part here.

Assert.Same(BindingSource.Query, id.Source);
Assert.Equal(typeof(string), id.Type);
Comment on lines +1627 to 1629
}
Expand Down
Loading