-
Notifications
You must be signed in to change notification settings - Fork 10k
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.
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
Add examples to AddOpenApi extension method/overloads #58808
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The build is having trouble resolving the WebApplicationBuilder
reference.
We'll need to add a reference to the Microsoft.AspNetCore.DefaultBuilder
project to the *.csproj for this library then add any necessary usings.
@@ -19,6 +19,14 @@ public static class OpenApiServiceCollectionExtensions | |||
/// </summary> | |||
/// <param name="services">The <see cref="IServiceCollection"/> to register services onto.</param> | |||
/// <param name="documentName">The name of the OpenAPI document associated with registered services.</param> | |||
/// <example> | |||
/// This method is commonly used to add OpenAPI services to the service collection of a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here and elsewhere?
/// This method is commonly used to add OpenAPI services to the service collection of a | |
/// This method is commonly used to add OpenAPI services to the <see cref="IServiceCollection" /> of a |
src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Safia Abdalla <[email protected]>
Add examples to AddOpenApi extension method/overloads
Adds examples to the xmldoc for the
AddOpenApi
extension methods/overloads.Description
Added an example to the xmldoc of each method showing the most common usage of this extension method -- to add OpenAPI services to the service collection of WebApplicationBuilder.