Releases: domaindrivendev/Swashbuckle.AspNetCore
Releases · domaindrivendev/Swashbuckle.AspNetCore
v6.6.1
What's Changed
- Modernise build and migrate to GitHub Actions for CI by @martincostello in #2775
- Update Redoc spelling in docs by @Quppa in #2568
- C# 9 Record - Read example/summary from positional record by @pixellos in #2546
- Grammatical correction of some comments by @mokarchi in #2768
- Update README.md for nested types custom schemaId support by @antmeehan in #2746
- Add support for
WithSummaryandWithDescriptionmetadata by @hwoodiwiss in #2414 - Update README.md - Fix
Add Security Definitions and Requirements for Bearer authURL by @Saibamen in #2705 - Replace text with Markdown link format by @mburumaxwell in #2392
- Add support for required keyword by @keahpeters in #2810
- Resolves #2717 by @MerickOWA in #2718
- Observe the route template constraints in the Swagger middleware by @0xced in #2418
- Added Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute by @jcracknell in #2610
- Fix schema generation with allOf inheritance by @bkoelman in #2815
- avoid triple enumeration of formParameters by @SimonCropp in #2823
- reduce some linq allocation by @SimonCropp in #2819
- remove some duplicate dictionary lookups by @SimonCropp in #2822
- remove redundant any check in InferRequestContentTypes by @SimonCropp in #2824
- Correctly respect interfaces in
GetInheritanceChainby @angelaki in #2826 - Generate Enum-Dictionary-Keys (analogous to Newtonsoft) by @angelaki in #2825
- Fix build badge by @martincostello in #2782
- Fix preview package versions by @martincostello in #2783
- Handle Stream and PipeReader content types correctly by @martincostello in #2784
- Add NuGet package READMEs by @martincostello in #2808
- Bump redoc to 2.1.3 by @martincostello in #2807
- Sort system usings first by @martincostello in #2790
- Throw if unsupported HTTP method used by @martincostello in #2797
- Fix configuration properties not being copied by @martincostello in #2796
- Add security policy by @martincostello in #2785
- Bump Microsoft.OpenApi by @martincostello in #2795
- Update to Swagger UI v5 by @martincostello in #2806
- Add customized document serialization support by @remcolam in #2677
- Added documentation for ISwaggerDocumentSerializer by @remcolam in #2837
- Fix flaky tests by locking on the statup type by @remcolam in #2838
- #2765 Allow Filter instance reuse by @remcolam in #2839
- Throw an error when a user uses FromForm attribute with IFormFile in … by @nikunjbhargava in #2840
- Filter illegal header fields by @keahpeters in #2842
- Fix handling of FileResult's with content types by @IGx89 in #2841
- Adding additional responses when 5XX errors are thrown. by @say25 in #2852
- Fix that XML comment examples do not show up if the type is string and the example contains quotation marks by @dldl-cmd in #2727
- Exclude unused Swagger-UI files by @martincostello in #2851
- Fix RequestBodyFilters not being deep copied by @martincostello in #2850
- Avoid GitHub step summary file write conflicts by @martincostello in #2848
- Extend built-in supported types by @martincostello in #2804
- Update compatibility table by @martincostello in #2856
- Add GitHub issue and PR templates by @martincostello in #2788
- Fix stale permissions by @martincostello in #2855
- Add .NET 8 support by @martincostello in #2799
- Release automation workflows by @martincostello in #2809
- Support native AoT with SwaggerUI by @martincostello in #2800
- Bump some NuGet packages by @martincostello in #2868
- Fix stale permissions by @martincostello in #2863
- Attestation by @martincostello in #2869
- Add descriptions for more HTTP status codes by @cremor in #2872
- Only attest packages by @martincostello in #2870
- Fix tag version by @martincostello in #2875
New Contributors
- @mokarchi made their first contribution in #2768
- @hwoodiwiss made their first contribution in #2414
- @Saibamen made their first contribution in #2705
- @keahpeters made their first contribution in #2810
- @MerickOWA made their first contribution in #2718
- @0xced made their first contribution in #2418
- @jcracknell made their first contribution in #2610
- @bkoelman made their first contribution in #2815
- @angelaki made their first contribution in #2826
- @remcolam made their first contribution in #2677
- @nikunjbhargava made their first contribution in #2840
- @IGx89 made their first contribution in #2841
- @dldl-cmd made their first contribution in #2727
- @cremor made their first contribution in #2872
Full Changelog: v6.5.0...v6.6.1
Contributors
0xced, cremor, and 19 other contributors
Assets 2
v6.6.0
What's Changed
- Modernise build and migrate to GitHub Actions for CI by @martincostello in #2775
- Update Redoc spelling in docs by @Quppa in #2568
- C# 9 Record - Read example/summary from positional record by @pixellos in #2546
- Grammatical correction of some comments by @mokarchi in #2768
- Update README.md for nested types custom schemaId support by @antmeehan in #2746
- Add support for
WithSummaryandWithDescriptionmetadata by @hwoodiwiss in #2414 - Update README.md - Fix
Add Security Definitions and Requirements for Bearer authURL by @Saibamen in #2705 - Replace text with Markdown link format by @mburumaxwell in #2392
- Add support for required keyword by @keahpeters in #2810
- Resolves #2717 by @MerickOWA in #2718
- Observe the route template constraints in the Swagger middleware by @0xced in #2418
- Added Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute by @jcracknell in #2610
- Fix schema generation with allOf inheritance by @bkoelman in #2815
- avoid triple enumeration of formParameters by @SimonCropp in #2823
- reduce some linq allocation by @SimonCropp in #2819
- remove some duplicate dictionary lookups by @SimonCropp in #2822
- remove redundant any check in InferRequestContentTypes by @SimonCropp in #2824
- Correctly respect interfaces in
GetInheritanceChainby @angelaki in #2826 - Generate Enum-Dictionary-Keys (analogous to Newtonsoft) by @angelaki in #2825
- Fix build badge by @martincostello in #2782
- Fix preview package versions by @martincostello in #2783
- Handle Stream and PipeReader content types correctly by @martincostello in #2784
- Add NuGet package READMEs by @martincostello in #2808
- Bump redoc to 2.1.3 by @martincostello in #2807
- Sort system usings first by @martincostello in #2790
- Throw if unsupported HTTP method used by @martincostello in #2797
- Fix configuration properties not being copied by @martincostello in #2796
- Add security policy by @martincostello in #2785
- Bump Microsoft.OpenApi by @martincostello in #2795
- Update to Swagger UI v5 by @martincostello in #2806
- Add customized document serialization support by @remcolam in #2677
- Added documentation for ISwaggerDocumentSerializer by @remcolam in #2837
- Fix flaky tests by locking on the statup type by @remcolam in #2838
- #2765 Allow Filter instance reuse by @remcolam in #2839
- Throw an error when a user uses FromForm attribute with IFormFile in … by @nikunjbhargava in #2840
- Filter illegal header fields by @keahpeters in #2842
- Fix handling of FileResult's with content types by @IGx89 in #2841
- Adding additional responses when 5XX errors are thrown. by @say25 in #2852
- Fix that XML comment examples do not show up if the type is string and the example contains quotation marks by @dldl-cmd in #2727
- Exclude unused Swagger-UI files by @martincostello in #2851
- Fix RequestBodyFilters not being deep copied by @martincostello in #2850
- Avoid GitHub step summary file write conflicts by @martincostello in #2848
- Extend built-in supported types by @martincostello in #2804
- Update compatibility table by @martincostello in #2856
- Add GitHub issue and PR templates by @martincostello in #2788
- Fix stale permissions by @martincostello in #2855
- Add .NET 8 support by @martincostello in #2799
- Release automation workflows by @martincostello in #2809
- Support native AoT with SwaggerUI by @martincostello in #2800
- Bump some NuGet packages by @martincostello in #2868
- Fix stale permissions by @martincostello in #2863
- Attestation by @martincostello in #2869
- Add descriptions for more HTTP status codes by @cremor in #2872
- Only attest packages by @martincostello in #2870
New Contributors
- @mokarchi made their first contribution in #2768
- @hwoodiwiss made their first contribution in #2414
- @Saibamen made their first contribution in #2705
- @keahpeters made their first contribution in #2810
- @MerickOWA made their first contribution in #2718
- @0xced made their first contribution in #2418
- @jcracknell made their first contribution in #2610
- @bkoelman made their first contribution in #2815
- @angelaki made their first contribution in #2826
- @remcolam made their first contribution in #2677
- @nikunjbhargava made their first contribution in #2840
- @IGx89 made their first contribution in #2841
- @dldl-cmd made their first contribution in #2727
- @cremor made their first contribution in #2872
Full Changelog: v6.5.0...v6.6.0
Contributors
0xced, cremor, and 19 other contributors
Assets 2
v6.5.0
v6.4.0
v6.3.1
v6.3.0
v6.2.3
v6.1.3
Upgrade swagger-ui to 3.47.1 + prep for next release
v6.1.0
Support DefaultValueAttribute on parameter-based schemas
v6.0.0
This release includes a number of small enhancements and bug fixes. See the following for a full list of issues addressed:
https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestone/16?closed=1
Of note, these include:
- include discriminator metadata in base schema if either UseOneOfForPolymorphism OR UseAllOfForInheritance are enabled
- remove fragile logic around X-Forwarded-* headers in favor of MS's Forwarded Headers Middleware (*see breaking changes)
- beta (opt-in) support for non-nullable reference types
- enhancements to SwaggerSchemaAttribute incl. use on Enum types & ability to set Nullable flag explicitly
- wrap generator exceptions to surface contextual info for troubleshooting
- support JSON object/array syntax in XML tags
- improved handling for enum default values to reflect serializer behavior more accurately
- upgrade swagger-ui to 3.40.0
Breaking Changes
- the obsolete settings
DescribeAllEnumsAsStringsandDescribeStringEnumsInCamelCaseare now fully removed - X-Forwarded-* headers are no longer honored within SB code - use MS's Forwarded Headers Middleware instead