Nswag 14.6.2

[christianhelle]

Summary by CodeRabbit

• Chores

  • Updated NSwag package dependencies to version 14.6.2
  • Added System.Text.Json version 9.0.9 to project dependencies

• Tests

  • Adjusted test assertion logic for improved flexibility

[coderabbitai]

Walkthrough

This PR updates NSwag package dependencies from 14.6.0 to 14.6.2 across two projects, adds System.Text.Json 9.0.9 to three projects, and loosens a test assertion in InlineJsonConvertersTests.cs to accept variable trailing characters in JsonConverter attribute strings.

Changes

Cohort / File(s)	Summary
NSwag package version bumps src/Refitter.Core/Refitter.Core.csproj, src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj	Updated NSwag.CodeGeneration.CSharp and NSwag.Core.Yaml PackageReferences from version 14.6.0 to 14.6.2
System.Text.Json dependency additions src/Refitter/Refitter.csproj, src/Refitter.Tests/Refitter.Tests.csproj, src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj	Added System.Text.Json PackageReference version 9.0.9 to three project files
Test assertion modification src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs	Loosened JsonConverter attribute assertion from exact string match to substring prefix match, removing requirement for closing "))]"

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Rationale: Changes are primarily homogeneous package updates repeated across multiple files with consistent pattern. One test assertion modification requires understanding of test intent but involves straightforward string comparison change.
• Areas requiring attention:
  • Verify System.Text.Json 9.0.9 compatibility across all three affected projects
  • Confirm the test assertion loosening in InlineJsonConvertersTests.cs aligns with intended behavioral change in JsonConverter attribute generation

Possibly related PRs

• Add option to remove [JsonConverter(typeof(JsonStringEnumConverter))] from generated contracts #786: Directly related to the InlineJsonConvertersTests.cs assertion loosening and NSwag package bumps, involving JsonConverter attribute handling in generated contracts
• Revert NSwag back to v14.4.0 #734: Related to NSwag package version management in the same project files, previously addressing NSwag dependency versioning

Poem

🐰 Dependencies dance their version change today,
System.Text.Json joins the fray,
NSwag ascends to 14.6.2's way,
Tests relax their grip, come what may,
Another hop toward stability's display! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Nswag 14.6.2' accurately reflects the main change: upgrading NSwag packages to version 14.6.2 across multiple project files.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch nswag-14.6.2

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 747ade4 and b4f436a.

⛔ Files ignored due to path filters (6)

• src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/Refitter.g.cs is excluded by !**/generated/**
• src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreOptionalParameters.g.cs is excluded by !**/generated/**
• src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreSingleInterfaceWithHttpResilience.g.cs is excluded by !**/generated/**
• src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreSingleInterfaceWithPolly.g.cs is excluded by !**/generated/**
• src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/UseJsonInheritanceConverter.g.cs is excluded by !**/generated/**
• src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/UsePolymorphicSerialization.g.cs is excluded by !**/generated/**

📒 Files selected for processing (6)

• src/Refitter.Core/Refitter.Core.csproj (1 hunks)
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj (1 hunks)
• src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj (1 hunks)
• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs (1 hunks)
• src/Refitter.Tests/Refitter.Tests.csproj (1 hunks)
• src/Refitter/Refitter.csproj (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

**/*.cs: Follow existing C# coding conventions defined in .editorconfig
Use PascalCase for public members and camelCase for parameters and local variables
Use meaningful variable and method names
Keep methods focused with single responsibility
Run dotnet format and ensure no formatting changes before committing

Files:

• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs

src/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Include XML documentation for public APIs

Files:

• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs

src/Refitter.Tests/Examples/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

src/Refitter.Tests/Examples/**/*.cs: New unit tests must follow the pattern used in Refitter.Tests.Examples (Arrange/Act/Assert style with GenerateCode(), content assertions, and build verification)
Add unit tests for new CLI options in src/Refitter.Tests/Examples/ following the established test structure

Files:

• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs

🧠 Learnings (8)

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter.Core/RefitInterfaceGenerator.cs : Implement or update generation logic in src/Refitter.Core/RefitInterfaceGenerator.cs (or related generator classes) for new features/options

Applied to files:

• src/Refitter.Core/Refitter.Core.csproj
• src/Refitter/Refitter.csproj
• src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj
• src/Refitter.Tests/Refitter.Tests.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter.Core/Settings/RefitGeneratorSettings.cs : Add corresponding property to src/Refitter.Core/Settings/RefitGeneratorSettings.cs for new CLI options

Applied to files:

• src/Refitter.Core/Refitter.Core.csproj
• src/Refitter/Refitter.csproj
• src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter.sln : Use the main solution file src/Refitter.sln for restore, build, test, and formatting operations

Applied to files:

• src/Refitter.Core/Refitter.Core.csproj
• src/Refitter/Refitter.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter/**/*.cs : Use Spectre.Console for CLI UI (rich output, progress, styled errors) and respect flags like --no-banner and --no-logging

Applied to files:

• src/Refitter/Refitter.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Multi-targeting: test .NET 8.0 and 9.0 when making framework-specific changes

Applied to files:

• src/Refitter/Refitter.csproj
• src/Refitter.Tests/Refitter.Tests.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter.Tests/Examples/**/*.cs : New unit tests must follow the pattern used in Refitter.Tests.Examples (Arrange/Act/Assert style with GenerateCode(), content assertions, and build verification)

Applied to files:

• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs
• src/Refitter.Tests/Refitter.Tests.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter.Tests/Examples/**/*.cs : Add unit tests for new CLI options in src/Refitter.Tests/Examples/ following the established test structure

Applied to files:

• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs
• src/Refitter.Tests/Refitter.Tests.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

📚 Learning: 2025-10-20T20:29:54.111Z

Learnt from: CR
Repo: christianhelle/refitter PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-20T20:29:54.111Z
Learning: Applies to src/Refitter.Tests/Resources/{V2,V3}/**/*.json : Always test with both OpenAPI 2.0 and 3.0 specifications using the provided test resources

Applied to files:

• src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs
• src/Refitter.Tests/Refitter.Tests.csproj
• src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

• GitHub Check: CodeQL analysis (csharp)
• GitHub Check: script
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build
• GitHub Check: Analyze (csharp)

🔇 Additional comments (6)

src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj (1)

13-13: LGTM - consistent with other System.Text.Json additions.

This addition is consistent with the System.Text.Json 9.0.9 updates across other test projects. Verification of version and security advisories should be covered by the script in src/Refitter.Tests/Refitter.Tests.csproj review.

src/Refitter.Core/Refitter.Core.csproj (1)

15-16: LGTM - consistent with other NSwag updates.

These NSwag package updates are consistent with the updates in src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj. Verification of version and security advisories should be covered by the script in that file's review.

src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj (1)

19-20: NSwag packages verified—no issues found.

Version 14.6.2 is confirmed for both NSwag.CodeGeneration.CSharp and NSwag.Core.Yaml, and no security vulnerabilities were detected for either package. The specified versions are current and safe to use.

src/Refitter.Tests/Refitter.Tests.csproj (1)

19-19: System.Text.Json 9.0.9 is valid and free from known security vulnerabilities.

The latest published version is 10.0.0-rc.2.25502.107, confirming that 9.0.9 exists and is properly released. The current CVE advisories for System.Text.Json affect versions 6.0.0-6.0.9, 7.0.0-8.0.3, and 8.0.0-8.0.4. Version 9.0.9 falls outside all vulnerable ranges, so no security concerns exist for this dependency.

src/Refitter/Refitter.csproj (1)

24-24: I need to verify framework compatibility for System.Text.Json 9.0.9. Let me search for this information:

System.Text.Json 9.0.9 is compatible with multi-targeting and free from identified vulnerabilities.

System.Text.Json 9.0.9 targets .NET 8.0 and is compatible with this framework or higher, which covers both .NET 8.0 and .NET 9.0 target frameworks. Based on the security advisory check, the identified CVEs (CVE-2024-43485 and CVE-2024-30105) affect earlier versions (6.0.0–6.0.9, 7.0.0–8.0.4), not 9.0.9, so no known vulnerabilities apply to this version.

src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs (1)

97-97: Verification confirms the review comment is accurate and appropriate.

The repository does use NSwag 14.6.2 (confirmed in src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj and src/Refitter.Core/Refitter.Core.csproj). Although this version doesn't appear on the GitHub releases page, it's pinned in the codebase and evidenced in generated code headers.

The test assertion change on line 97 from an exact match to a partial match [JsonConverter(typeof(JsonStringEnumConverter is a sound approach that maintains correctness while accommodating formatting variations across NSwag versions. The test still validates the essential behavior (JsonConverter attribute presence) while being flexible about trailing characters.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull Request Overview

This PR updates NSwag dependencies from version 14.6.0 to 14.6.2 and adds explicit System.Text.Json 9.0.9 package references. The update aligns with NSwag's newer version which now generates JsonStringEnumConverter<T> (generic) instead of the non-generic JsonStringEnumConverter, requiring System.Text.Json 9.0+ for compatibility.

• Updates NSwag.CodeGeneration.CSharp and NSwag.Core.Yaml packages to version 14.6.2 across Core and SourceGenerator projects
• Adds System.Text.Json 9.0.9 dependency to CLI, test projects to support the new generic JsonStringEnumConverter
• Updates test expectations and generated code snapshots to reflect the new generic converter format

Reviewed Changes

Copilot reviewed 6 out of 12 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/Refitter/Refitter.csproj	Adds System.Text.Json 9.0.9 package reference to CLI tool
src/Refitter.Tests/Refitter.Tests.csproj	Adds System.Text.Json 9.0.9 package reference to test project
src/Refitter.Tests/Examples/InlineJsonConvertersTests.cs	Updates test assertion to check for generic JsonStringEnumConverter pattern
src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj	Updates NSwag packages from 14.6.0 to 14.6.2
src/Refitter.SourceGenerator.Tests/Refitter.SourceGenerator.Tests.csproj	Adds System.Text.Json 9.0.9 package reference
src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/UsePolymorphicSerialization.g.cs	Updates generated code to use generic JsonStringEnumConverter and NSwag 14.6.2 version strings
src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/UseJsonInheritanceConverter.g.cs	Updates generated code to use generic JsonStringEnumConverter and NSwag 14.6.2 version strings
src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreSingleInterfaceWithPolly.g.cs	Updates generated code to use generic JsonStringEnumConverter and NSwag 14.6.2 version strings
src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreSingleInterfaceWithHttpResilience.g.cs	Updates generated code to use generic JsonStringEnumConverter and NSwag 14.6.2 version strings
src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreOptionalParameters.g.cs	Updates generated code to use generic JsonStringEnumConverter and NSwag 14.6.2 version strings
src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/Refitter.g.cs	Updates generated code to use generic JsonStringEnumConverter and NSwag 14.6.2 version strings
src/Refitter.Core/Refitter.Core.csproj	Updates NSwag packages from 14.6.0 to 14.6.2

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.25%. Comparing base (7604486) to head (b4f436a).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #800   +/-   ##
=======================================
  Coverage   96.25%   96.25%           
=======================================
  Files          23       23           
  Lines        1841     1841           
  Branches      298      298           
=======================================
  Hits         1772     1772           
  Misses         36       36           
  Partials       33       33           

Flag	Coverage Δ
unittests	96.25% <ø> (ø)

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.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.