Skip to content

Conversation

@jgarciadelanoceda
Copy link
Contributor

@jgarciadelanoceda jgarciadelanoceda commented Jun 11, 2024

This PR fixes #1685.

I do not know if it's a SwaggerUi Bug, because this PR only copies the Description that was obtained in the SchemaFilter to the Parameters section. If the description is not showed under every parameter of the operation then the SwaggerUi does not show it.

Anyway, the solution I gave in the issue is very simple, so if you do not see this addition a built in you can close the PR

@codecov-commenter
Copy link

codecov-commenter commented Jun 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.13%. Comparing base (9f6a07a) to head (6163ff4).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2943      +/-   ##
==========================================
+ Coverage   90.10%   90.13%   +0.02%     
==========================================
  Files          72       72              
  Lines        2730     2736       +6     
  Branches      432      433       +1     
==========================================
+ Hits         2460     2466       +6     
  Misses        270      270              
Flag Coverage Δ
Linux 90.13% <100.00%> (+0.02%) ⬆️
Windows 90.13% <100.00%> (+0.02%) ⬆️
macOS 90.13% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@martincostello martincostello left a comment

Choose a reason for hiding this comment

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

Are you able to add an integration test for this scenario too?

@jgarciadelanoceda
Copy link
Contributor Author

Are you able to add an integration test for this scenario too?

Finally I gave up, because the Verify test was giving different response in the linux build

@martincostello
Copy link
Collaborator

Do you use an editor that supports EditorConfig?

The .editorconfig and .gitattributes are both configured so that line endings shouldn't be an issue, unless I've misunderstood how it works. Alternatively, does it have a setting that allows us to tell it to ignore line ending differences?

@jgarciadelanoceda
Copy link
Contributor Author

jgarciadelanoceda commented Jun 13, 2024

As soon as I insert the Verify again the build fails, I do not see why it failed now.
I have Visual Studio which supports editorconfig file. Also I have changed the condition from NotEmpty to be equal to the schema description (This could be the reason why you suggested to create the test using verify)

@martincostello martincostello added this to the v6.7.0 milestone Jun 17, 2024
@martincostello
Copy link
Collaborator

Could you rebase onto the latest changes please? I just merged #2950 which added a bunch of new verification tests and this change might impact them and need regenerating.

This was referenced Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Can't generate enum item descriptions

3 participants