Support [DataMember] IsRequired in NewtonsoftDataContractResolver #2644

ouvreboite · 2023-05-03T14:28:04Z

Resolves #2383

Add non-regression tests to ensure [DataMember(IsRequired)] do not bypass existing [JsonObject], [JsonProperty] or [JsonRequired] attributes.
Add tests for [DataMember(IsRequired)] and [DataMember(name)]
Update NewtonsoftDataContractResolver to directly leverage jsonProperty.Required, instead of using the IsRequiredSpecifed extension method

martincostello · 2024-04-13T08:40:17Z

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. We'd also require tests for this scenario.

ouvreboite · 2024-04-16T09:17:22Z

I'll rebase once #2799 is merged

martincostello · 2024-06-18T09:57:33Z

FYI #2799 was merged a month ago.

src/Swashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/JsonPropertyExtensions.cs

test/Swashbuckle.AspNetCore.Newtonsoft.Test/Fixtures/JsonPropertyAnnotatedType.cs

test/Swashbuckle.AspNetCore.Newtonsoft.Test/Fixtures/JsonRequiredAnnotatedType.cs

As DataMember implementation comes after the implementation for [JsonProperty] and [JsonObject], we want to be sure that the current behavior is not bypassed.

Add test cases for DataMember (IsRequired and Name). It seems that NewtonSoft's ResolveContract correctly set the Required, using [DataMember], [JsonProperpty] and [JsonRequired] so we can directly use it instead of the IsRequiredSpecifed extension method.

Newtonsoft do all the work for us, handling [JsonProperty(Required = Required.Always)] or [JsonRequired] or [DataMember(IsRequired = true)] and filling the JsonProperty.Required field.

codecov-commenter · 2024-08-01T14:04:34Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.61%. Comparing base (8f9c079) to head (77994ee).

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2644      +/-   ##
==========================================
+ Coverage   88.46%   90.61%   +2.14%     
==========================================
  Files          95       74      -21     
  Lines        3364     2962     -402     
  Branches      577      469     -108     
==========================================
- Hits         2976     2684     -292     
+ Misses        388      278     -110

Flag	Coverage Δ
Linux	`90.61% <ø> (ø)`
Windows	`?`
macOS	`90.61% <ø> (ø)`

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.

martincostello · 2024-08-01T14:10:00Z

Thanks!

martincostello · 2024-08-18T07:35:36Z

Version 6.7.1 is now available from NuGet.org which includes this change.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.7.0` -> `6.7.1` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.7.0/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.7.0/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.7.1`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.1) #### What's Changed - docs: Update README.md by [@WeihanLi](https://togithub.com/WeihanLi) in [domaindrivendev/Swashbuckle.AspNetCore#3002 - Support `[DataMember]` `IsRequired` in `NewtonsoftDataContractResolver` by [@ouvreboite](https://togithub.com/ouvreboite) in [domaindrivendev/Swashbuckle.AspNetCore#2644 - Add API analysers by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3003 - Update README by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3004 - docs: fix example code formatting by [@WeihanLi](https://togithub.com/WeihanLi) in [domaindrivendev/Swashbuckle.AspNetCore#3010 - Fixes nullability problems with dictionaries by [@ozziepeeps](https://togithub.com/ozziepeeps) in [domaindrivendev/Swashbuckle.AspNetCore#3023 - Fix handling of nullable structs by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3015 - Fix missing form parameter XML documentation by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3020 #### New Contributors - [@ouvreboite](https://togithub.com/ouvreboite) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2644 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.7.0...v6.7.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/gritcsenko/HomeInventory).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.7.0` -> `6.7.1` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.7.0/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.7.0/6.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.7.1`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.1) #### What's Changed - docs: Update README.md by [@WeihanLi](https://togithub.com/WeihanLi) in [domaindrivendev/Swashbuckle.AspNetCore#3002 - Support `[DataMember]` `IsRequired` in `NewtonsoftDataContractResolver` by [@ouvreboite](https://togithub.com/ouvreboite) in [domaindrivendev/Swashbuckle.AspNetCore#2644 - Add API analysers by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3003 - Update README by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3004 - docs: fix example code formatting by [@WeihanLi](https://togithub.com/WeihanLi) in [domaindrivendev/Swashbuckle.AspNetCore#3010 - Fixes nullability problems with dictionaries by [@ozziepeeps](https://togithub.com/ozziepeeps) in [domaindrivendev/Swashbuckle.AspNetCore#3023 - Fix handling of nullable structs by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3015 - Fix missing form parameter XML documentation by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3020 #### New Contributors - [@ouvreboite](https://togithub.com/ouvreboite) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2644 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.7.0...v6.7.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 10pm every weekday,every weekend,before 5am every weekday" in timezone Europe/Berlin, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/orso-co/Orso.Arpa.Api).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

ouvreboite force-pushed the master branch from 21d3c7f to a8e2841 Compare May 3, 2023 15:20

schnerring mentioned this pull request Jun 16, 2023

💚Move tests to net7 to fix build #2672

Closed

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

Port domaindrivendev/Swashbuckle.AspNetCore#2644 for Havunen/DotSwash…

328b0ec

…buckle#1

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

Port domaindrivendev#2644 for #1 credits @ouvreboite

d46b373

martincostello mentioned this pull request Apr 14, 2024

[DataMember(IsRequired = true)] do not mark property as required #2383

Closed

ouvreboite force-pushed the master branch from a8e2841 to 119be8c Compare August 1, 2024 08:37

martincostello reviewed Aug 1, 2024

View reviewed changes

martincostello mentioned this pull request Aug 1, 2024

Add public API analysers #2801

Closed

ouvreboite added 2 commits August 1, 2024 13:41

✅ Add non-regression tests for DataMember required

3d17511

As DataMember implementation comes after the implementation for [JsonProperty] and [JsonObject], we want to be sure that the current behavior is not bypassed.

ouvreboite force-pushed the master branch from 119be8c to 78aa6b5 Compare August 1, 2024 11:42

✨ Keep IsRequiredSpecified() but use JsonProperty.Required internally

77994ee

Newtonsoft do all the work for us, handling [JsonProperty(Required = Required.Always)] or [JsonRequired] or [DataMember(IsRequired = true)] and filling the JsonProperty.Required field.

ouvreboite force-pushed the master branch from 78aa6b5 to 77994ee Compare August 1, 2024 11:45

martincostello approved these changes Aug 1, 2024

View reviewed changes

martincostello added this to the v6.7.1 milestone Aug 1, 2024

martincostello merged commit 2c5ec58 into domaindrivendev:master Aug 1, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support [DataMember] IsRequired in NewtonsoftDataContractResolver #2644

Support [DataMember] IsRequired in NewtonsoftDataContractResolver #2644

ouvreboite commented May 3, 2023 •

edited by martincostello

Loading

martincostello commented Apr 13, 2024

ouvreboite commented Apr 16, 2024

martincostello commented Jun 18, 2024

codecov-commenter commented Aug 1, 2024

martincostello commented Aug 1, 2024

martincostello commented Aug 18, 2024

Support [DataMember] IsRequired in NewtonsoftDataContractResolver #2644

Support [DataMember] IsRequired in NewtonsoftDataContractResolver #2644

Conversation

ouvreboite commented May 3, 2023 • edited by martincostello Loading

martincostello commented Apr 13, 2024

ouvreboite commented Apr 16, 2024

martincostello commented Jun 18, 2024

codecov-commenter commented Aug 1, 2024

Codecov Report

martincostello commented Aug 1, 2024

martincostello commented Aug 18, 2024

ouvreboite commented May 3, 2023 •

edited by martincostello

Loading