Skip to content

ASP.NET Core does not collect metadata from XML doc comments. #35257

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
Rick-Anderson merged 5 commits into from
Apr 18, 2025
Merged

ASP.NET Core does not collect metadata from XML doc comments. #35257

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dec0165
ASP.NET Core does not collect metadata from XML doc comments.
Rick-Anderson Apr 17, 2025
e985e6a
Update aspnetcore/fundamentals/openapi/include-metadata.md
Rick-Anderson Apr 18, 2025
fac7f24
Update aspnetcore/fundamentals/openapi/include-metadata.md
Rick-Anderson Apr 18, 2025
f23ae36
Update aspnetcore/fundamentals/openapi/include-metadata.md
Rick-Anderson Apr 18, 2025
8f619bd
Update aspnetcore/fundamentals/openapi/include-metadata.md
Rick-Anderson Apr 18, 2025
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
5 changes: 2 additions & 3 deletions aspnetcore/fundamentals/openapi/include-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ The following table provides an overview of the metadata collected and the strat
| responses | [`[Produces]`](xref:Microsoft.AspNetCore.Mvc.ProducesAttribute) | <xref:Microsoft.AspNetCore.Http.OpenApiRouteHandlerBuilderExtensions.Produces%2A>, <xref:Microsoft.AspNetCore.Http.OpenApiRouteHandlerBuilderExtensions.ProducesProblem%2A> | <xref:Microsoft.AspNetCore.Http.TypedResults> |
| Excluding endpoints | [`[ExcludeFromDescription]`](xref:Microsoft.AspNetCore.Routing.ExcludeFromDescriptionAttribute), [`[ApiExplorerSettings]`](xref:Microsoft.AspNetCore.Mvc.ApiExplorerSettingsAttribute) | <xref:Microsoft.AspNetCore.Http.OpenApiRouteHandlerBuilderExtensions.ExcludeFromDescription%2A> | |

ASP.NET Core does not collect metadata from XML doc comments.

ASP.NET Core can also collect metadata from XML doc comments. See <xref:fundamentals/openapi/aspnet-openapi-xml> for more details.
The following sections demonstrate how to include metadata in an app to customize the generated OpenAPI document.

### Summary and description
Expand Down Expand Up @@ -677,4 +676,4 @@ A schema transformer can be used to override any default metadata or add additio

[!INCLUDE[](~/fundamentals/openapi/includes/include-metadata9.md)]

:::moniker-end
:::moniker-end