Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] [v2] Swagger WithSummary / WithDescription metadata doesnt show up on the UI #910

Open
iammukeshm opened this issue Dec 27, 2023 · 5 comments
Labels
bug Something isn't working help wanted Extra attention is needed
Milestone

Comments

@iammukeshm
Copy link
Member

chrome_vMo86y9SAH

devenv_a7FuO36xcV

@iammukeshm iammukeshm added bug Something isn't working help wanted Extra attention is needed labels Dec 27, 2023
@iammukeshm iammukeshm added this to the Release 2.0 milestone Dec 27, 2023
@fcantenot
Copy link

Hello @iammukeshm , I quickly took a look. I saw this issue was present with .NET7 (dotnet/aspnetcore#40753). I don't know if the issue has been correctly fixed.

Inside comments, it is indicated to use WithOpenApi to get around the problem. I tested and it works.

WithOpenApi
WithOpenApi-Result

@iammukeshm
Copy link
Member Author

Hi @fcantenot, I have seen something similar to this, and tried fixing it. I was able to make the Swagger UI display the correct summary and description, but I was not able to hit the API endpoint. It was giving me a 404 exception. Are you able to access the APIs? If so, can you please take the latest changes from v2 and raise a new PR with this fix?

@iammukeshm
Copy link
Member Author

domaindrivendev/Swashbuckle.AspNetCore#2414

I think this is the fix for this issue. Let's see if this gets merged anytime soon!

@fcantenot
Copy link

Hi @fcantenot, I have seen something similar to this, and tried fixing it. I was able to make the Swagger UI display the correct summary and description, but I was not able to hit the API endpoint. It was giving me a 404 exception. Are you able to access the APIs? If so, can you please take the latest changes from v2 and raise a new PR with this fix?

sorry @iammukeshm , I tried but we have an error like you mentioned.
If we use "WithSummary&WithDescription", versioning is ok (see curl command) but not summary and description.
WithSummary

If we use "WithOpenApi", summary & description are ok but versioning is ko as you can see with the curl command
WithOpenApi

I searched but it seems it is also a bug or I don't know how to get around.
dotnet/aspnet-api-versioning#953

@hwoodiwiss
Copy link

Hey 👋🏼
domaindrivendev/Swashbuckle.AspNetCore#2414 has now merged, and looks like it is going to be in Swashbuckle.AspNetCore v6.5.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants