Swashbuckle.AspNetCore.Filters

Fix issue #261 (thanks @ntark)

Fix when used with Swashbuckle.Aspnetcore 9.0.0.

Made MvcOutputformatter public so that it can be overridden #254

Bug fix #244

Add Readme to NuGet.

Breaking change. Default to camelCase instead of PascalCase for examples in minimal APIs.

Render CSV examples for requests, and for IMultipleExamplesProvider (thanks @Bl4d3s)

Inject IServiceProvider to MvcOutputFormatter instead of creating a new one

Fixed

• Fix bug in GetControllerAndActionAttributes, introduced by the last release which causes AddResponseHeadersFilter to fail.

Fixed

• Issue #227 - SecurityRequirementsOperationFilter for minimal APIs doesn't work with Swashbuckle.AspNetCore > 6.3.0 (thanks @hartmair)

Fixed

• Issue #231 - NuGet package now built in Release mode

Fixed

• Issue #225 - SecurityRequirementsOperationFilter doesn't add Auth to methods derived from a BaseController (thanks @andrew-yustyk)

Changed

• Allow SwaggerResponseHeaderAttribute to be used on classes.

Fixed

• Issue #209 - Request example clash when using API versioning

Added

• Issues #43 and #129 - added support for text/csv in response examples (thanks @icnocop)

Fixed

• Issue #189 - fix exception when using Minimal APIs (thanks @dotdiego)

Added

• Issue #165 - add Description to multiple examples (thanks @penenkel)

Removed

• Issue #162 - removed internal OpenApiRawString and use OpenApiString with isRawString parameter (thanks @WillGunn)

Fixed

• Fixed License

Added

• Add symbols NuGet package

Security

• PR #176 update NuGet packages

Changed

• PR #178 dependency cleanup

Added

• PR #179 introduce Swashbuckle.AspNetCore.Filters.Abstractions package so that IExamplesProvider can be consumed without Swashbuckle dependency.
• Target .NET 5.0
• Microsoft.SourceLink.GitHub NuGet reference

Removed

• Issue #174 remove ExcludeObsoletePropertiesResolver and NewtonsoftJson dependency.

Added

• Issue #171 support auto example for ProducesDefaultResponseType.

Fixed

• PR #161 restore NewtonsoftJson dependency.

Fixed

• Issue #132 Support [System.Text.JsonPropertyNameAttribute]. This is a breaking change which rewrote how the examples are generated. Instead of explicitly using Newtonsoft's JsonConvert.SerializeObject(), I now use whichever JSON serializer is registered with the MVC pipeline, i.e. during services.AddControllers().

Removed

• contractResolver and jsonConverter parameters from [SwaggerRequestExampleAttribute].
• contractResolver and jsonConverter parameters from [SwaggerResponseExampleAttribute].
• Microsoft.AspNetCore.Mvc.NewtonsoftJson dependency.

Changed

• If you are using options.IgnoreObsoleteProperties(); and you want your Examples to not have the obsolete properties, then you will need to register my custom Newtonsoft ExcludeObsoletePropertiesResolver, e.g.

services.AddControllers()
    .AddNewtonsoftJson(opt =>
    {
        opt.SerializerSettings.ContractResolver = new ExcludeObsoletePropertiesResolver(opt.SerializerSettings.ContractResolver);

Fixed

• #154 Upgrade to Microsoft.OpenApi 1.2.2 because 1.2.0 had breaking changes

Added

• Add services.AddSwaggerExamples() extension method to allow examples without automatic annotation

Fixed

• #115 Added workaround for request examples when SerializeAsV2 = true
• #148 AddSwaggerExamplesFromAssemblies method does not scan for IMultipleExamplesProvider implementations

Added

• PR #147 add support for multiple request and response examples. Thanks to @tomkludy and @pozy for the contribution.

Added

• PR #140 add extension methods AddSwaggerExamplesFromAssemblyOf and AddSwaggerExamplesFromAssemblies

Fixed

• Fix #136 use either XmlSerializer or DataContractSerializer to output XML examples, depending on what is configured. Thanks to @CumpsD and @ridingwolf for the PR.

Changed

• Use Swashbuckle.AspNetCore 5.0.0

Fixed

• PR #110, where using IgnoreObsoleteProperties option causes PascalCase to be emitted instead of camelCase.

Changed

• Use Swashbuckle.AspNetCore 5.0.0-rc5

Fixed

• Issue #106 SecurityRequirementsOperationFilter removes existing OpenApiSecurityRequirements

Fixed

• Issue #98 check schemaGeneratorOptions.IgnoreObsoleteProperties when generating json examples

Added

• PR #103 - Response Headers filter can now take an array of status codes

Fixed

• Issue #101, Exception with SecurityRequirementsOperationFilter when you have already added a 401 or a 403

Fixed

• Issue #99, JSON examples were encoded JSON

Removed

• Remove IExamplesProvider interface. Only support IExamplesProvider<T>

Changed

• Use Swashbuckle.AspNetCore 5.0.0-rc2
• Support .NET Core 3.0 preview 5

Changed

• Use Swashbuckle.AspNetCore 5.0.0-beta
• Drop support for .NET Standard 1.6 and .NET Framework, since Swashbuckle.AspNetCore doesn't support them any more
• Only set request example on the operation, no longer set it on the type. This means you can have different request examples for different operations which use the same request type, which is an often requested feature.

Added

• XML examples

Deprecated

• Removed AuthorizationInputOperationFilter
• Removed DescriptionOperationFilter
• Removed AddFileParamTypesOperationFilter

[4.5.5] - 2018-03-04

Fixed

• Repository URL in NuGet package
• Issue #89 - use Json.NET SerializationBinder property when generating examples. Thanks @dmitry-baryshev for the PR.

Deprecated

• Marked AddFileParamTypesOperationFilter as Obsolete, because Swashbuckle 4.0 supports IFormFile directly.

Changed

• Issue #84 - allow security schema to have a name other than "oauth2" via configuration

Fixed

• Issue #80 - allow interfaces when resolving IExampleProvider<T>

Fixed

• Issue #69
  • Only set request examples on the schema registry object. The request parameter will only be set if a schema registry object is not found. This fix prevents a warning in Redoc. Thanks @Leon99 for the pull request.
• Issue #72 do not override SerializerSettings.NullValueHandling because underlying issue seems to have been fixed

Fixed

• Issue #67 3rd time
  • Support Swashbuckle.AspNetCore 4.0.0 for .NET Framework 4.6.1 projects

Fixed

• Issue #67 again
  • Support Swashbuckle.AspNetCore 4.0.0 for .NET Framework 4.6.1 projects

Fixed

• Issue #67
  • Support Swashbuckle.AspNetCore 4.0.0 for .NET Standard 2.0 projects

Added

• Fix issue #63
  • Add an optional true/false value to the AddHeaderOperationFilter to determine whether the header is required or not.

Changed

• Issue #60
  • No longer support .NET Framework 4.5.1 because it doesn't work with Scrutor (because Scrutor is unsigned)
  • Support .NET Framework 4.6.1
  • Support .NET Standard 2.0 (still support 1.6 too)

Deprecated

• Mark DescriptionOperationFilter as obsolete, because you can accomplish the same thing with summary tags

Changed

• It is no longer necessary to specify a ProducesResponseType or SwaggerResponse attribute in order to get response examples, so long as it is obvious what Type your action method returns.

Added

• Add generic version of SecurityRequirementsOperationFilter and AppendAuthorizeToSummaryOperationFilter so that they can be used with other attributes. Reason: a client had implemented their own TypeFilterAttribute which did Authorization but wasn't an AuthorizeAttribute

Fixed

• Issue #54 where child objects weren't having their descriptions set if parent property was missing [Description]

Fixed

• Issue #54 where arrays of child objects weren't having their description set

Fixed

• Fix bug where generic types weren't being automatically annotated

Added

• Automatic annotation of request and response examples
• Dependency on Scrutor 2.2.2

Changed

• How ExamplesOperationFilter is installed - see Installation section of the Readme

Added

• SecurityRequirementsOperationFilter to correctly set bearer token stuff when using [Authorize]

Fixed

• Fix bug with DescriptionOperationFilter where Description not set if using a DefaultContractResolver

Fixed

• Fix where Examples doesn't work on ASP.NET Core 2.0

Fixed

• Port of bug #36 from Swashbuckle.Examples

Changed

• Rename from Swashbuckle.AspNetCore.Examples
• Dependency on Swashbuckle.AspNetCore 3.0 instead of 1.0