Add additional newline after SGML comments so that Swagger editor displays markdown header properly#652
Open
eric-murray wants to merge 1 commit into
Open
Conversation
eric-murray
requested review from
PedroDiez,
bigludo7,
jlurien and
rartych
as code owners
tlohmar
approved these changes
Jun 19, 2026
tlohmar
left a comment
tlohmar
left a comment
Contributor
There was a problem hiding this comment.
Good. I thought that I accidentally removed these empty lines and already inserted them.
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
3 participants
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.
What type of PR is this?
What this PR does / why we need it:
The swagger editor is ignoring the markdown header directive that immediately follows SGML comments: e.g.
The solution is to add an additional newline following the comment. e.g.:
Which issue(s) this PR fixes:
Fixes #651
Does this PR introduce a breaking change?
Special notes for reviewers:
Redoc viewer is unaffected by this
Changelog input
Additional documentation
None