[release/10.0] Handle DescriptionAttribute for nullable value types in OpenAPI generation - #67051
Merged
Merged
Conversation
Improve OpenApiSchemaService to retrieve DescriptionAttribute from underlying types, enabling correct descriptions for enums and nullable enums. Expand tests to cover these scenarios and verify schema descriptions. Standardize HelixContent formatting in project files.
Co-authored-by: Youssef Fahmy <youssefvictor00@gmail.com>
Co-authored-by: Youssef Fahmy <youssefvictor00@gmail.com>
Member
|
Thanks to whoever made the backport bot add the servicing template as part of the PR description automatically :) Drafting for now until I fill the template later on Monday. |
Youssef1313
marked this pull request as draft
June 6, 2026 06:48
Youssef1313
marked this pull request as ready for review
June 8, 2026 10:39
Contributor
|
Hi @github-actions[bot]. Please make sure you've updated the PR description to use the Shiproom Template. Also, make sure this PR is not marked as a draft and is ready-to-merge. To learn more about how to prepare a servicing PR click here. |
DescriptionAttribute for nullable value types in OpenAPI generation
Contributor
There was a problem hiding this comment.
Pull request overview
This backport fixes OpenAPI schema generation so DescriptionAttribute applied to enum types is honored even when the enum is used via Nullable<T> (e.g., MyEnum?), restoring missing description fields in generated OpenAPI documents.
Changes:
- Unwrap nullable value types before reading
DescriptionAttributewhen generating schema descriptions. - Expand request body schema tests to cover enum/property/type description scenarios, including nullable enums.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/OpenApi/src/Services/Schemas/OpenApiSchemaService.cs | Updates schema generation to read DescriptionAttribute from the underlying type for nullable value types. |
| src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.RequestBodySchemas.cs | Adds/extends tests asserting enum/type/property descriptions, including nullable enum coverage. |
halter73
approved these changes
Jun 9, 2026
Member
|
Approved via email. |
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
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.
Backport of #65245 to release/10.0
/cc @Youssef1313 @rdeveen
Handle
DescriptionAttributefor nullable value types in OpenAPI generationFixes missing description in OpenAPI document for nullable enums.
Description
This PR handles DescriptionAttribute correctly when generating OpenAPI documents when processing
Nullable<T>whereTis an enum that hasDescriptionAttribute, which was previously ignored.Fixes #65067
Customer Impact
Customer reported in #65067. While this appears to have been broken since the beginning, there are certain scenarios where it could have worked by chance (when two APIs are declared, and one uses
Nullable<Enum>while the other usesEnum). For those scenarios that worked by chance, this is seen by users as a regression (and user report is reporting it as a regression).Regression?
Technically no, but from user perspective, it could be if they fall in the "worked by chance" scenario. The working version in this case is Microsoft.AspNetCore.OpenApi 10.0.1 and the broken version is 10.0.2
Risk
Low. The change is very well-scoped and simply unwraps nullable value types before retrieving DescriptionAttribute.
Verification
Test is added
Packaging changes reviewed?
N/A