Skip to content

Conversation

AtolagbeMuiz
Copy link

Description

This Change Fixes #62970. Use \r\n instead of \n when joining XML comments for consistent formatting in generated OpenAPI descriptions. This helps ensure descriptions render correctly in Swagger UI.

@AtolagbeMuiz AtolagbeMuiz requested review from a team and captainsafia as code owners October 5, 2025 22:38
@github-actions github-actions bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Oct 5, 2025
@AtolagbeMuiz AtolagbeMuiz changed the title made changes to fix xml comment ot rendering prpoerly made changes to fix xml comment not rendering prpoerly Oct 5, 2025
@AtolagbeMuiz AtolagbeMuiz changed the title made changes to fix xml comment not rendering prpoerly made changes to fix xml comment not rendering properly Oct 5, 2025
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Oct 5, 2025
@AtolagbeMuiz AtolagbeMuiz reopened this Oct 6, 2025
@dotnet-policy-service dotnet-policy-service bot added this to the 11.0-preview1 milestone Oct 6, 2025
@gfoidl gfoidl added feature-openapi area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Oct 7, 2025
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for opening this PR! However, I don't believe the change you made here fixes the reported issue.

This change is impacting the C# code that is generated by the source generator which runs the logic to apply the XML comments, not the XML comments themselves.

It's likely that the fix you need to make is in this file which processes the actual XML comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc community-contribution Indicates that the PR has been added by a community member feature-openapi

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenAPI: Xml Documentation includes special new line characters that differ from previous versions.

3 participants