Support processing XML comments on [AsParameters] parameter #63166
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
github-actions
bot
added
the
needs-area-label
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for processing XML comments on properties of [AsParameters] parameter classes in OpenAPI documentation generation. The feature enables XML documentation comments on individual properties within parameter classes to be reflected in the generated OpenAPI documentation.
Key Changes:
- Added a new overload of
CreateDocumentationIdmethod to generate documentation IDs for properties using container type and property name - Enhanced the OpenAPI operation transformer to process parameter descriptions with property-level metadata and apply XML comments
- Added comprehensive test cases covering various scenarios including mixed parameters, binding sources, and examples
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| OperationTests.MinimalApis.cs | Added test cases for [AsParameters] with XML comments including parameter classes and validation scenarios |
| XmlCommentGenerator.Emitter.cs | Added new CreateDocumentationId overload and logic to process property-level XML comments for AsParameters |
| Multiple snapshot files | Updated generated code snapshots to include the new functionality and test data |
captainsafia
added
feature-openapi
area-minimal
| { | ||
| if (operation.RequestBody is not null) | ||
| { | ||
| operation.RequestBody.Description = propertyComment.Summary ?? propertyComment.Description; |
There was a problem hiding this comment.
Is this the right precedence? Just from the naming it looks like it should be the other way around.
There was a problem hiding this comment.
I believe you're right. I believe this should be .Value, .Returns then .Summary to match other property-based comments.
captainsafia
force-pushed
the
safia/fix-asparams-xmldocs
branch
from
c2c1a60 to
da93209
Compare
captainsafia
force-pushed
the
safia/fix-asparams-xmldocs
branch
from
da93209 to
c4f153c
Compare
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.
Closes #61936.