Swashbuckle.AspNetCore icon indicating copy to clipboard operation
Swashbuckle.AspNetCore copied to clipboard

Add support for `WithSummary` and `WithDescription` metadata

Open hwoodiwiss opened this issue 2 years ago • 1 comments

fixes https://github.com/dotnet/aspnetcore/issues/40753

Adds support for the MinimalAPI operation metadata functions, WithSummary and WithDescription, including CI changes.

hwoodiwiss avatar May 12 '22 15:05 hwoodiwiss

@domaindrivendev Just pinging for a review now that we're at .NET 7 RC1. Also looking for some thoughts, I know this has been superseded a bit by WithOpenApi, but it might still be nice to support the new metadata piecemeal?

I'm happy to either expand this to support the rest of the new Metadata types, leave it as is, or scrap it altogether. Just looking for your thoughts on this.

hwoodiwiss avatar Sep 14 '22 23:09 hwoodiwiss

Hi, why is this still open?

esskar avatar Jul 20 '23 04:07 esskar

I'd honestly forgotten about this. Ideally I think this should still be reviewed and merged, a quick check indicates that support for WithSummary and WIthDescription hasn't been added yet. (I'll test that out a bit later just in case) If this is still needed, I'll update it from main, and look to get a review.

hwoodiwiss avatar Jul 20 '23 11:07 hwoodiwiss

There is quite a large backlog of unreviewed and unmerged changes in this repo from lots of people (I've had #2526 outstanding for months too).

martincostello avatar Jul 20 '23 12:07 martincostello

Hello, will this code merged? I want it to use already :)

DES-Destry avatar Jan 10 '24 11:01 DES-Destry

That's up to the owner of the repository to review the backlog of open pull requests.

martincostello avatar Jan 10 '24 11:01 martincostello

Can we finally merge it?

cutpix avatar Feb 24 '24 19:02 cutpix

Can we finally merge it?

Based on https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2759#issuecomment-1936136992, it looks like this repo is on hiatus until a new maintainer can be found.

Until then, it's unlikely this will be merged. It looks like this PR is being ported over to a fork of this project, so it could be worth checking that out, or checking out NSwag.

hwoodiwiss avatar Feb 24 '24 23:02 hwoodiwiss

@hwoodiwiss If you rebase on to the default branch to pick up our new CI we can take a look at this for you.

martincostello avatar Apr 13 '24 08:04 martincostello

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.69%. Comparing base (9e77996) to head (b4ecaaa). Report is 2 commits behind head on master.

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2414      +/-   ##
==========================================
+ Coverage   91.66%   91.69%   +0.03%     
==========================================
  Files          91       91              
  Lines        3010     3022      +12     
  Branches      517      519       +2     
==========================================
+ Hits         2759     2771      +12     
  Misses        251      251              
Flag Coverage Δ
Linux 91.69% <100.00%> (+0.03%) :arrow_up:
Windows 91.69% <100.00%> (+0.03%) :arrow_up:
macOS 91.69% <100.00%> (+0.03%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Apr 13 '24 21:04 codecov-commenter