Update dependency Swashbuckle.AspNetCore to v4 #211
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
3.0.0
->4.0.0
Release Notes
domaindrivendev/Swashbuckle.AspNetCore
v4.0.0
Compare Source
Release Summary
This release makese an explicit jump to ASP.NET Core 2.0 and the
netstandard2.0
library contract. As a result, Swashbuckle can simplify it's implementation by leveraging some of the newer ASP.NET Core features. However, it also means applications need to upgrade their ASP.NET Core stack to 2.0 or above before they can use this version or subsequent versions of Swashbuckle.It also includes a significant refactor to the way in which Swashbuckle middleware and services are configured, adhering more closely to the ASP.NET Core Options Pattern. This allows for the Swashbuckle components to be configured via
appSettings.json
if desired.The other notable change with this release is out-of-the-box support for parameters of type
IFormFile
. That is, the generator will automatically detect these and generate the correct Swagger to describe parameters that are passed informData
.Breaking Changes
Requires ASP.NET Core 2.0 and netstandard2.0 or above:
Applications need to upgrade their ASP.NET Core stack to 2.0 or above before they can use this version or subsequent versions of Swashbuckle.
Strongly typed options for SwaggerUI and ReDoc middleware:
May need to update middleware configuration (e.g. in
Startup.cs
) to compileExplicit OperationIds now required:
As per the Swagger spec,
operationId
s MUST be unique and SHOULD follow common programming conventions. In previous versions, Swashbuckle attempted to generate these values but this has proved increasingly problematic. As a result, this behavior has been removed and the action name or (optionally) the route name is used instead. So, API developers are now responsible to ensure the uniqueness of these values. See the readme topic for more details.Issues Addressed
See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestone/6?closed=1
Renovate configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻️ Rebasing: Whenever PR becomes conflicted, or if you modify the PR title to begin with "
rebase!
".🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot. View repository job log here.