springfox / springfox-javadoc

Ability to use Javadoc for documentation for generating OpenAPI specifications
Apache License 2.0
17 stars 15 forks source link

Bump springfox-swagger2 from 2.8.0 to 3.0.0 #18

Open dependabot-preview[bot] opened 4 years ago

dependabot-preview[bot] commented 4 years ago

Bumps springfox-swagger2 from 2.8.0 to 3.0.0.

Release notes

Sourced from springfox-swagger2's releases.

3.0.0

Release Notes

image Picture Credit National Geographic

First and foremost a big thank you to the community for keeping me motivated to work on this project. There have been some really amazing contributions in this release in terms of code, comments, bug reports and it is humbling to see people jumping in to solve problems on the issue forum. It sure motivated me to get over the "hump" and start working on in earnest. What better way to lose the COVID blues!

Thank you! 🥳 🍾

Also please welcome the newest maintainer to the springfox team @MaksimOrlov. A lot of the great work you see in the model generation support is due to his efforts, collaborating tirelessly on weekends and not giving up while ensuring the model generation engine is performant 👏

NOTE: This is a breaking change release, I've tried to maintain backwards compatibility with earlier versions of springfox as much as possible. Deprecated APIs prior to 2.9 have been aggressively removed and new APIs that will go away in the near future have been marked. So please look out for those and do report anything that has been missed.

Highlights of this release include

  • Spring 5, Webflux support (only request mapping support, functional endpoints aren't supported yet)
  • Spring Integration support (feedback is much appreciated)
  • Spring Boot support springfox-boot-starter dependency (Zero Config, Autoconfiguration support)
  • Documented Configuration Properties with autocomplete
  • Better specification compatibility with 2.0
  • Support for OpenApi 3.0.3
  • Zero Dependency (almost, the only libraries needed are spring-plugin, pswagger-core](https://github.com/swagger-api/swagger-core)
  • Existing swagger2 annotations will continue to work and enrich open api 3.0 specification

Contributions

Significant contributions that come to mind (and please remind me of others in this list cos' my memory is weak)

  • @MaksimOrlov for his work on better model generation (json view, validation groups, request/response models)
  • @dschulten for introducing spring integration support
  • @deblockt and @ligasgr for their work on webflux support
  • @ile for spring 5 support
  • @neil1hart for removing the guava dependencies
  • and @cbornet for the occasional nudges to working on this release :)

Pull Requests

Changelog

Sourced from springfox-swagger2's changelog.

2.9.2 Release Notes

This is mostly a service release. Predominantly to publish the repository to maven along with minor improvements

Pull requests and contributions

Bugs

  • (#2502) OperationContext only finds SecurityContext's by path ignoring methods @robinsonmark
  • (#2481) ConditionalOnWebApplication not found after upgrading to 2.9.0 duplicate @gionn
  • (#2461) 2.8.0 /swagger-resource/configuration/ui does not set Accept header properly @OverDrone
  • (#2446) ApiParam allowableValues string with spaces is not supported @uriparush
  • (#2438) Upgrade to SpringFox 2.9.0 causes failures in Spring Boot 2.0.2.RELEASE @james
  • (#2428) description = "@Size: Min - Max (until #1244 gets fixed)" when param annotated with @Min and/or @Max but #1244 is already fixed @haelduksf
  • (#2423) Query Parameter extracted from Object doesn't recognize public field without getter @kintomiko
  • (#2415) JSR-303: Size annotation on Path Param generates maximum/minimum, but on Model generates maxLength/minLength @retinaburn
  • (#2401) Present multipart object attributes as "formData" duplicate @andyRokit
  • (#2376) Model attribute expansion should respect form/query parameter type @dilipkrish
  • (#2498) Path Parameter generated having unsupported properties duplicate @FossilBlade
  • (#2481) ConditionalOnWebApplication not found after upgrading to 2.9.0 duplicate @gionn
  • (#2466) There is no jar in maven repo.Why? duplicate @litttlefisher
  • (#2441) Upgrading from 2.8.0 to 2.9.0 causes SpringBootTest to stop working duplicate @maraswrona
  • (#2401) Present multipart object attributes as "formData" duplicate @andyRokit
  • (#755) o.s.data.domain.Pageable - automatically add @ApiImplicitParams? can-use-for-docs duplicate @steve

Feature

  • (#2180) Is it possible to document OAuth 2 scopes for different HTTP methods? feature @Beontra

Maintenance

2.9.0 Release Notes

This is the last release supporting jdk 6 and spring 4.x. The next planned release is 3.0 which will have jdk 8 as a pre-requisite. There was a large effort to ensure a stable release before moving to the next major release. A big thank you again for the numerous feature/bug requests for making this product better and supporting this library.

A special thank you to @kasecato, @MaksimOrlov, @neumaennl, @rgoers and @Fyro-Ing for working on some much requested features.

NOTE: All deprecations will be removed when we move to 3.0

Pull Requests

Commits
  • bc9d0ca Updated the documentation
  • d92928f Sorted the model properties by position and name
  • 4f4aa54 Added anchors for section links.
  • 9ffb648 Merge branch 'bug/3030-fix-base-path-with-plugins'
  • af99ca6 Added documentation about the avilability of the plugins
  • fb979a8 Added webmvc/webflux varaints of transformation filter plugins
  • dd47e4f Added two plugins to help customize the host/basePath
  • a9cf914 Added auto-startup property to the properties
  • a66b9a0 Fixed issue rendering file input as model attribute
  • 6b34f42 Merge branch 'bug/3353-form-variables-are-not-visible'
  • 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.


Note: This repo was added to Dependabot recently, so you'll receive a maximum of 5 PRs for your first few update runs. Once an update run creates fewer than 5 PRs we'll remove that limit.

You can always request more updates by clicking Bump now in your Dependabot dashboard.

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 squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor 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](https://app.dependabot.com): - Update frequency (including time of day and day of week) - 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)