Skip to content

Bump Swashbuckle.AspNetCore from 2.5.0 to 4.0.1 - #27

Open
dependabot-preview[bot] wants to merge 1 commit into
masterfrom
dependabot/nuget/Swashbuckle.AspNetCore-4.0.1
Open

Bump Swashbuckle.AspNetCore from 2.5.0 to 4.0.1#27
dependabot-preview[bot] wants to merge 1 commit into
masterfrom
dependabot/nuget/Swashbuckle.AspNetCore-4.0.1

Conversation

@dependabot-preview

Copy link
Copy Markdown

Bumps Swashbuckle.AspNetCore from 2.5.0 to 4.0.1.

Release notes

Sourced from Swashbuckle.AspNetCore's releases.

v4.0.0

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

v3.0.0

Release Summary
Includes two significant changes in addition to a handful of bug fixes and minor enhancements. The generator will now honor the BindRequired and Required attributes on ALL parameters (top-level or property-based) and model properties, flagging the corresponding elements as required in the generated Swagger. Also, the Swagger-specific annotations (SwaggerOperation, SwaggerResponse etc.) have been enhanced, but also extracted from the core functionality into a separate package that consumers need to explicitly install and enable.

Breaking Changes

  • Updates to annotations: To continue using the swagger-specific annotations, you'll need to explicitly install and enable the new Swashbuckle.AspNetCore.Annotations package as described here. Furthermore, the attributes have moved from the SwaggerGen namespace to the Annotations namespace, and the ordering of some constructor parameters has changed. So, you'll need to update and test your use of these attributes.
  • Handling of Required / BindRequired attributes: Previously, parameters and properties had to be decorated with these attributes AND be nullable to be flagged as required in the generated Swagger. This has changed and now those attributes will be honored on ALL parameters and model properties.

Issues Addressed
See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestone/5?closed=1

Commits
  • 28e8673 Increment patch number
  • f21ecec Merge pull request #932 from CodeBlanch/swaggerui-strong-name
  • 48e43d5 Added SignAssembly element to SwaggerUI csproj.
  • a5f343a Remove ssl from Basic example launchSettings
  • 3c91969 Add link to release notes in readme
  • 1336171 Upgrade swagger-ui to 3.19.5, ReDoc to 1.22.2
  • 0466ecd Upgrade Microsoft.AspNetCore.All in test projects
  • e9a3395 Merge pull request #926 from frank-borkin/patch-1
  • ebe1788 Add Using info to README
  • 0188149 Merge pull request #915 from Cmouse87/patch-1
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Pull request limits (per update run and/or open at any time)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant