These are the changes to each version that has been released on the nuget.
- Fix #38
- 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
- Fix #17: check schema for null in
DisplayEnumsWithValuesDocumentFilter
- Fix #18: add aliases for "x-enumNames" and "x-enumDescriptions"
- Fix NRE in
InheritDocRequestBodyFilterandInheritDocParameterFilter
- Add
IncludeXmlCommentsWithRemarksimprovements
- Add message template for
AppendActionCountToTagSummaryDocumentFilter
- Add
IncludeXmlCommentsWithRemarksimprovements
- Fix
IncludeXmlCommentsWithRemarks
- Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.1.5
- Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.1.0
- Fix
DisplayEnumsWithValuesDocumentFilterfor action enum parameters like:
[HttpGet("MyFunction")]
public IActionResult MyFunction(ParameterEnum parameter1)
{
return NoContent();
}
- Add more overloads for
IncludeXmlCommentsWithRemarksextension method - Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.0.2
- Update nuget-dependencies: update Swashbuckle.AspNetCore to v6.0.0
- Fix some bugs in
IncludeXmlCommentsWithRemarksoption - Add
IncludeXmlCommentsFromInheritDocsoption to add xml comments from inheritdocs (from summary and remarks) into the swagger documentation
- Add
params Type[]parameters toIncludeXmlCommentsWithRemarksoption to exclude remarks for concrete types
- Add
IncludeXmlCommentsWithRemarksoption to add xml comments from summary and remarks into the swagger documentation - Update nuget-dependencies
- Add
IncludeXEnumRemarksoption to include remarks for descriptions from xml-comments - Fix small bugs
- Fix issue #11
- Fix bug related with removal of required schemes from
AllOfusingHidePathsAndDefinitionsByRolesDocumentFilter
- Update nuget dependencies for sample WebAPI
- Fix issue #12
- Fix bug with missed required definitions in
HidePathsAndDefinitionsByRolesDocumentFilter
- Fix bug with missed required definitions in
HidePathsAndDefinitionsByRolesDocumentFilter
- Fix bug with OpenAPI operation RequestBody in
HidePathsAndDefinitionsByRolesDocumentFilter
- Fix bug in
HidePathsAndDefinitionsByRolesDocumentFilter
- Fix bug #10
- Add option to choose descriptions source -
FixEnumOptions.DescriptionSource - Fix small bugs
- Fix bug with
System.MissingMethodException
- Add feature: add configured options to
AddEnumsWithValuesFixFilters - Fix bug: fix #7 - get descriptions from xml comments
- Fix small bugs
- Fix bug: add fix #6 to
options.AddEnumsWithValuesFixFilters(true);when usingJsonStringEnumConverter()
- Fix bug: hide Paths and Components with
AuthorizeAttributeapplied to the Controller
- Add
RemovePathsAndComponentsWithoutAcceptedRolesForoverloaded extension method (withactionNameparameter)
- Allow to use
RemovePathsAndComponentsWithoutAcceptedRolesForControllerextension method withoutnew()constraint
- Fix bug with
AmbiguousMatchException
- Add feature: remove Paths and Definitions from OpenApi documentation for all controller actions without accepted roles
- Add feature: remove Paths and Definitions from OpenApi documentation for specific controller action without accepted roles
- Fix bug: replace
<br>tag to{Envirinment.NewLine}{Envirinment.NewLine}for enum descriptions
- Fix bug: fix openApi response content schema in
ChangeResponseByHttpStatusCodeDocumentFilter
- Add xml-comments to nuget package
- Fix bug: use
System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscapingencoder for responses examples
- Add
ChangeAllResponsesByHttpStatusCode<T>extension method forSwaggerGenOptionsallows to change all responses by specific http status codes in OpenApi document - Add
TagOrderByNameDocumentFilterfor ordering tags by name in OpenApi document
BREAKING CHANGES (see README.md):
- Close #2 issue: Add support for Swashbuckle.AspNetCore 5.0.0
- Add
AppendActionCountToTagSummaryDocumentFilterto append action count into the SwaggetTag's descriptions
- Add extension-method
HidePathItemsWithoutAcceptedRolesfor hiding all SwaggerDocument PathItems with added Security information for OAuth2 without accepted roles - Change extension-method name from
EnumsWithValuesFixFilterstoAddEnumsWithValuesFixFilters - Update
README
- Add an output enums integer values with there strings like
0 = FirstEnumValuewithout aStringEnumConverterin swaggerUI and schema (by default enums will output only their integer values) - Add description to each enum value that has an
[Description]attribute inswaggerUIand schema - Fix enum values in generated by
NSwagStudioor Unchase OpenAPI Connected Service client classes - Add
Getting Startedoverview to GitHubREADME - Release version of
Unchase Swashbuckle Asp.Net Core Extensions