Verify XML documentation for AddOpenAPI extension methods #62024
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.
This PR addresses issue #58807 which requested adding examples to the XML documentation for
AddOpenApi
extension methods to help new .NET developers understand common usage patterns.After reviewing the codebase, I found that all four overloads of the
AddOpenApi
extension methods already have proper XML documentation with examples:AddOpenApi(this IServiceCollection services)
has an example showing usage with WebApplicationBuilderAddOpenApi(this IServiceCollection services, string documentName)
has an exampleAddOpenApi(this IServiceCollection services, Action<OpenApiOptions> configureOptions)
has an exampleAddOpenApi(this IServiceCollection services, string documentName, Action<OpenApiOptions> configureOptions)
has an exampleAll examples follow XML documentation best practices and show consistent usage patterns with WebApplicationBuilder:
These examples effectively demonstrate how to use the extension methods with a
WebApplicationBuilder
, which addresses the issue's request to show common usage patterns for new .NET developers.No changes were needed to the documentation as it already meets the requirements specified in the issue.
Fixes #58807.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
dc.services.visualstudio.com
/home/REDACTED/work/aspnetcore/aspnetcore/.dotnet/dotnet msbuild /m /nologo /clp:Summary /v:minimal /nr:true /warnaserror /p:TreatWarningsAsErrors=true /p:ContinuousIntegrationBuild=false /home/REDACTED/work/aspnetcore/aspnetcore/artifacts/toolset/restore.proj /t:__WriteToolsetLocation /clp:ErrorsOnly;NoSummary /p:__ToolsetLocationOutputFile=/home/REDACTED/work/aspnetcore/aspnetcore/artifacts/toolset/10.0.0-beta.25265.101.txt
(dns block)pkgs.dev.azure.com
/home/REDACTED/work/aspnetcore/aspnetcore/.dotnet/dotnet msbuild /m /nologo /clp:Summary /v:minimal /nr:true /warnaserror /p:TreatWarningsAsErrors=true /p:ContinuousIntegrationBuild=false /home/REDACTED/work/aspnetcore/aspnetcore/artifacts/toolset/restore.proj /t:__WriteToolsetLocation /clp:ErrorsOnly;NoSummary /p:__ToolsetLocationOutputFile=/home/REDACTED/work/aspnetcore/aspnetcore/artifacts/toolset/10.0.0-beta.25265.101.txt
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.