Road map

December 17, 2024 · View on GitHub

Add unit-tests
Fix open issues
Gather feedback and plan further features to implement

Change log

These are the changes to each version that has been released on the nuget.

v2.7.2 `2024-12-18`

Fix #38

v2.7.1 `2022-12-11`

Fix #24
Fix #30

v2.7.0 `2022-12-09`

Add support for .NET7/.NET6
Update and remove unused nuget-dependencies
Fix #20: Multiple Enum Labels with the Same Value Results in Unusable Output
Fix #21: Line Break is OS dependent (\r\n vs \n)
Fix #27: Enum descriptions are only written to the type description text if all enum values have a description
Fix #28: selecting distinct members when including inherited XML comments
Fix #31: enum descriptions do not work as expected when enum array is provided

v2.6.12 `2021-10-05`

Fix #17: check schema for null in DisplayEnumsWithValuesDocumentFilter

v2.6.11 `2021-09-29`

Fix #18: add aliases for "x-enumNames" and "x-enumDescriptions"

v2.6.9 `2021-08-30`

Fix NRE in InheritDocRequestBodyFilter and InheritDocParameterFilter

v2.6.8 `2021-08-26`

Add IncludeXmlCommentsWithRemarks improvements

v2.6.7 `2021-08-26`

Add message template for AppendActionCountToTagSummaryDocumentFilter

v2.6.6 `2021-08-26`

Add IncludeXmlCommentsWithRemarks improvements

v2.6.3 `2021-08-26`

Fix IncludeXmlCommentsWithRemarks

v2.6.1 `2021-08-26`

Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.1.5

v2.6.0 `2021-02-09`

Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.1.0
Fix DisplayEnumsWithValuesDocumentFilter for action enum parameters like:

[HttpGet("MyFunction")]
public IActionResult MyFunction(ParameterEnum parameter1)
{
    return NoContent();
}

DisplayEnumsWithValuesDocumentFilter with enum parameters

v2.5.2 `2021-02-09`

Add more overloads for IncludeXmlCommentsWithRemarks extension method
Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.0.2

v2.5.1 `2021-02-05`

Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.0.0

v2.5.0 `2020-10-15`

Fix some bugs in IncludeXmlCommentsWithRemarks option
Add IncludeXmlCommentsFromInheritDocs option to add xml comments from inheritdocs (from summary and remarks) into the swagger documentation

v2.4.1 `2020-10-13`

Add params Type[] parameters to IncludeXmlCommentsWithRemarks option to exclude remarks for concrete types

v2.4.0 `2020-10-11`

Add IncludeXmlCommentsWithRemarks option to add xml comments from summary and remarks into the swagger documentation
Update nuget-dependencies

v2.3.13 `2020-10-07`

Add IncludeXEnumRemarks option to include remarks for descriptions from xml-comments
Fix small bugs

v2.3.12 `(2020-09-21)`

Fix issue #11

v2.3.11 `(2020-09-17)`

Fix bug related with removal of required schemes from AllOf using HidePathsAndDefinitionsByRolesDocumentFilter

v2.3.10 `(2020-07-29)`

Fix issue #13
Fix issue #14

v2.3.9 `(2020-07-28)`

Update nuget dependencies for sample WebAPI
Fix issue #12

v2.3.8 `(2020-07-06)`

Fix bug with missed required definitions in HidePathsAndDefinitionsByRolesDocumentFilter

v2.3.7 `(2020-07-06)`

Fix bug with missed required definitions in HidePathsAndDefinitionsByRolesDocumentFilter

v2.3.6 `(2020-07-06)`

Fix bug with OpenAPI operation RequestBody in HidePathsAndDefinitionsByRolesDocumentFilter

v2.3.5 `(2020-07-06)`

Fix bug in HidePathsAndDefinitionsByRolesDocumentFilter

v2.3.4 `(2020-06-11)`

Fix bug #10

v2.3.3 `(2020-03-25)`

Add option to choose descriptions source - FixEnumOptions.DescriptionSource
Fix small bugs

v2.3.2 `(2020-03-25)`

Fix bug with System.MissingMethodException

v2.3.0 `(2020-03-23)`

Add feature: add configured options to AddEnumsWithValuesFixFilters
Fix bug: fix #7 - get descriptions from xml comments
Fix small bugs

v2.2.6 `(2020-03-22)`

Fix bug: add fix #6 to options.AddEnumsWithValuesFixFilters(true); when using JsonStringEnumConverter()

v2.2.5 `(2020-03-02)`

Fix bug: hide Paths and Components with AuthorizeAttribute applied to the Controller

v2.2.4 `(2020-03-02)`

Add RemovePathsAndComponentsWithoutAcceptedRolesFor overloaded extension method (with actionName parameter)

v2.2.3 `(2020-03-02)`

Allow to use RemovePathsAndComponentsWithoutAcceptedRolesForController extension method without new() constraint

v2.2.2 `(2020-02-29)`

Fix bug with AmbiguousMatchException

v2.2.1 `(2020-02-29)`

Add feature: remove Paths and Definitions from OpenApi documentation for all controller actions without accepted roles

v2.2.0 `(2020-02-28)`

Add feature: remove Paths and Definitions from OpenApi documentation for specific controller action without accepted roles

v2.1.6 `(2020-02-21)`

Fix bug: replace <br> tag to {Envirinment.NewLine}{Envirinment.NewLine} for enum descriptions

v2.1.5 `(2020-02-21)`

Fix bug: fix openApi response content schema in ChangeResponseByHttpStatusCodeDocumentFilter

v2.1.4 `(2020-02-20)`

Add xml-comments to nuget package

v2.1.1 `(2020-02-19)`

Fix bug: use System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping encoder for responses examples

v2.1.0 `(2020-02-19)`

Add ChangeAllResponsesByHttpStatusCode<T> extension method for SwaggerGenOptions allows to change all responses by specific http status codes in OpenApi document
Add TagOrderByNameDocumentFilter for ordering tags by name in OpenApi document

v2.0.0 `(2020-02-08)`

BREAKING CHANGES (see README.md):

Close #2 issue: Add support for Swashbuckle.AspNetCore 5.0.0

v1.1.1 `(2019-05-14)`

Add AppendActionCountToTagSummaryDocumentFilter to append action count into the SwaggetTag's descriptions

v1.1.0 `(2019-05-07)`

Add extension-method HidePathItemsWithoutAcceptedRoles for hiding all SwaggerDocument PathItems with added Security information for OAuth2 without accepted roles
Change extension-method name from EnumsWithValuesFixFilters to AddEnumsWithValuesFixFilters
Update README

v1.0.0 `(2019-05-01)`

Add an output enums integer values with there strings like 0 = FirstEnumValue without a StringEnumConverter in swaggerUI and schema (by default enums will output only their integer values)
Add description to each enum value that has an [Description] attribute in swaggerUI and schema
Fix enum values in generated by NSwagStudio or Unchase OpenAPI Connected Service client classes
Add Getting Started overview to GitHub README
Release version of Unchase Swashbuckle Asp.Net Core Extensions