C# 9 Record - Read example/summary from positional record #2546

pixellos · 2022-11-12T11:16:52Z

Minimal fix for most common case of C#9 constructor.
#1920

pixellos · 2022-11-17T16:55:11Z

@domaindrivendev is there something that needs to be done to get this merged? Or is it no go?

pixellos · 2023-02-09T19:53:18Z

@Bumping

LockTar · 2023-04-13T15:31:42Z

This would be very nice to have!

Naxaliav · 2023-05-25T17:04:33Z

This is very needed :/ Why its not merged yet?

pixellos · 2023-05-25T17:39:00Z

If there would be any feedback about what to improve, i'd implement it right away - but no contributor was engaged in this thread :( .

owns · 2023-05-25T18:14:10Z

this is very needed for a project I'm on too - we currently have a separate build we use because of it.

Naxaliav · 2023-05-25T20:06:54Z

@domaindrivendev any feedback about this PR? Records are commonly used for API contracts since they have easier declaration and better equality. Now basically I am forced to have a copy XmlCommentsSchemaFilter.cs from this contribution at work, since we strongly document everything with openAPI…. If any updates are needed, just let us now… We are actual users of this already. (even though its unofficial)

paulosincos · 2023-07-06T18:55:43Z

+1 in the line waiting for this improvement hehe

niemyjski · 2023-08-27T18:46:43Z

Can we get this merged?

pixellos · 2023-09-26T08:07:46Z

There are some build issues - probably https://github.com/domaindrivendev/Swashbuckle.AspNetCore/pull/2672/files would be predecessor of this RP

LockTar · 2023-10-04T07:44:50Z

@pixellos You say that #2672 is a predecessor. Any idea when that one will be closed so this will be closed? Because all checks are passing on that PR. What can we do to help?

pixellos · 2023-10-04T13:35:05Z

Yes, but i haven't got changes from #2672 but from master, on which tests are already failing.
Personally, i just did a filter in my project to retrofit this functionality.

barruka · 2024-01-06T16:51:40Z

I believe it's crucial for the developer community to have this issue resolved, especially since the necessary code to fix it is already available. Documentation is incredibly important when building an API, and it's been three years since the release of .NET 5 with record types. In my opinion, prioritizing the resolution and merging of this issue might be more important than adding new features.

…avunen/DotSwashbuckle#1 records are supported

@pixellos

…ed credits @pixellos

martincostello · 2024-04-13T08:44:04Z

Thanks for contributing - if you'd like to continue with this pull request, please rebase against the default branch to pick up our new CI.

pixellos · 2024-04-13T09:20:20Z

Hi, on it :)

…ctor.

codecov-commenter · 2024-04-13T10:02:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.66%. Comparing base (c207be7) to head (f9997fd).

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2546      +/-   ##
==========================================
+ Coverage   91.62%   91.66%   +0.03%     
==========================================
  Files          91       91              
  Lines        2998     3010      +12     
  Branches      514      517       +3     
==========================================
+ Hits         2747     2759      +12     
  Misses        251      251

Flag	Coverage Δ
Linux	`91.66% <100.00%> (+0.03%)`	⬆️
Windows	`91.66% <100.00%> (+0.03%)`	⬆️
macOS	`91.66% <100.00%> (+0.03%)`	⬆️

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.

src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsSchemaFilter.cs

pixellos · 2024-04-13T11:09:47Z

build / windows-latest (pull_request) seems to be transient error - sth wrong with coverlet - as ubuntu succeeded

martincostello · 2024-04-13T11:56:30Z

Thanks for the fast turnaround! This will be part of the next release (we haven't planned when that will be yet).

If you'd like to consume these changes before then, you can use our pre-release feed in MyGet: https://www.myget.org/gallery/domaindrivendev

Add support for reading summary and example from default type constructor for C# 9 records. Resolves domaindrivendev#1920. --------- Co-authored-by: pixellos <codereinvented@gmail.com>

pixellos mentioned this pull request Nov 17, 2022

Records (positional) and DataAnnotations #2212

Open

pixellos changed the title ~~C# 9 Record - Read example/summary from default constructor~~ C# 9 Record - Read example/summary from positional record Nov 17, 2022

AoooR42 approved these changes Dec 20, 2022

View reviewed changes

LockTar approved these changes Apr 13, 2023

View reviewed changes

Havunen added a commit to Havunen/DotSwashbuckle2 that referenced this pull request Feb 11, 2024

porting test cases of domaindrivendev/Swashbuckle.AspNetCore#2546 for H…

2514f8b

…avunen/DotSwashbuckle#1 records are supported

Havunen added a commit to Havunen/DotSwashbuckle that referenced this pull request Feb 18, 2024

porting test cases of domaindrivendev#2546 for #1 records are support…

54008a4

…ed credits @pixellos

Add support for reading summary and example from default type constru…

745db4e

…ctor.

pixellos force-pushed the issue/1920/add-param-example-support branch from e9eb8c4 to 745db4e Compare April 13, 2024 09:59

martincostello reviewed Apr 13, 2024

View reviewed changes

src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsSchemaFilter.cs Outdated Show resolved Hide resolved

Resolve comment

f9997fd

martincostello approved these changes Apr 13, 2024

View reviewed changes

martincostello added this to the v6.5.1 milestone Apr 13, 2024

martincostello merged commit b8abb91 into domaindrivendev:master Apr 13, 2024
9 checks passed

martincostello modified the milestones: v6.5.1, v6.6.0 Apr 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

C# 9 Record - Read example/summary from positional record #2546

C# 9 Record - Read example/summary from positional record #2546

pixellos commented Nov 12, 2022 •

edited

pixellos commented Nov 17, 2022

pixellos commented Feb 9, 2023

LockTar commented Apr 13, 2023

Naxaliav commented May 25, 2023

pixellos commented May 25, 2023

owns commented May 25, 2023 •

edited

Naxaliav commented May 25, 2023 •

edited

paulosincos commented Jul 6, 2023

niemyjski commented Aug 27, 2023

pixellos commented Sep 26, 2023

LockTar commented Oct 4, 2023

pixellos commented Oct 4, 2023

barruka commented Jan 6, 2024

martincostello commented Apr 13, 2024

pixellos commented Apr 13, 2024

codecov-commenter commented Apr 13, 2024 •

edited

pixellos commented Apr 13, 2024

martincostello commented Apr 13, 2024

C# 9 Record - Read example/summary from positional record #2546

C# 9 Record - Read example/summary from positional record #2546

Conversation

pixellos commented Nov 12, 2022 • edited

pixellos commented Nov 17, 2022

pixellos commented Feb 9, 2023

LockTar commented Apr 13, 2023

Naxaliav commented May 25, 2023

pixellos commented May 25, 2023

owns commented May 25, 2023 • edited

Naxaliav commented May 25, 2023 • edited

paulosincos commented Jul 6, 2023

niemyjski commented Aug 27, 2023

pixellos commented Sep 26, 2023

LockTar commented Oct 4, 2023

pixellos commented Oct 4, 2023

barruka commented Jan 6, 2024

martincostello commented Apr 13, 2024

pixellos commented Apr 13, 2024

codecov-commenter commented Apr 13, 2024 • edited

Codecov Report

pixellos commented Apr 13, 2024

martincostello commented Apr 13, 2024

pixellos commented Nov 12, 2022 •

edited

owns commented May 25, 2023 •

edited

Naxaliav commented May 25, 2023 •

edited

codecov-commenter commented Apr 13, 2024 •

edited