Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency Swashbuckle.AspNetCore to v4 #211

Merged
merged 2 commits into from
Nov 6, 2018

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 6, 2018

This PR contains the following updates:

Package Type Update Change References
Swashbuckle.AspNetCore nuget major 3.0.0 -> 4.0.0 source

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 in formData.

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 compile

  • Explicit OperationIds now required:
    As per the Swagger spec, operationIds 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.

@renovate renovate bot requested a review from tomkerkhove as a code owner November 6, 2018 13:47
@renovate renovate bot added the dependencies All issues related to dependencies & Renovate label Nov 6, 2018
Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
@tomkerkhove tomkerkhove merged commit b1c5d25 into master Nov 6, 2018
@tomkerkhove tomkerkhove deleted the renovate-swashbuckle.aspnetcore-4.x branch November 6, 2018 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies All issues related to dependencies & Renovate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants