Add comment to OpenApiDocumentProvider #57061
Merged
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 comment to OpenApiDocumentProvider
Add a comment explaining what the
OpenApiDocumentProvider
class is for.Description
I was looking through the code to see if it was possible for the new OpenAPI library to output YAML instead of JSON yet (context: #54598 (comment)), and at first I thought
OpenApiDocumentProvider
was only used by tests, so it seemed redundant.Then I found this comment:
aspnetcore/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
Lines 70 to 71 in 06155c0
This PR adds a class-level summary explaining what the purpose of the internal class is, as otherwise it seems unused (it's accessed through reflection here):
aspnetcore/src/Tools/GetDocumentInsider/src/Commands/GetDocumentCommandWorker.cs
Line 27 in 06155c0
aspnetcore/src/Tools/GetDocumentInsider/src/Commands/GetDocumentCommandWorker.cs
Lines 193 to 207 in 06155c0