Add examples to AddOpenApi extension method/overloads #58808
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
old-area-web-frameworks-do-not-use
captainsafia
reviewed
Nov 5, 2024
| /// <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.
Here and elsewhere?
Suggested change
| /// 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 |
gfoidl
added
feature-openapi
area-minimal
captainsafia
reviewed
Nov 6, 2024
captainsafia
reviewed
Nov 7, 2024
src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Safia Abdalla <[email protected]>
captainsafia
approved these changes
Nov 7, 2024
captainsafia
added a commit
that referenced
this pull request
Feb 11, 2025
* Add examples to AddOpenApi extension method/overloads * Commit suggestions from PR review Co-authored-by: Safia Abdalla <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add examples to AddOpenApi extension method/overloads
Adds examples to the xmldoc for the
AddOpenApiextension 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.