docs/release-notes.md
This is mostly a service release. Predominantly to publish the repository to maven along with minor improvements
duplicate @gionnduplicate @andyRokitduplicate @FossilBladeduplicate @gionnduplicate @litttlefisherduplicate @maraswronaduplicate @andyRokitduplicate @steveThis 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
duplicate @igieonduplicate @rantunesboreasduplicate @PascalSchumachernot-reproducable @thiagolocatellinot-reproducable @ok11duplicate @k631583871duplicate @903452746duplicate @Mumijava.lang.NoSuchMethodError duplicate @salah3xduplicate @Snina88not-reproducable @bgiaccioPR @kasecatoPR @kasecatoResources not rendered correctly duplicate @raffaelschmidfeature @kasecatobug @avdvbug @gzsombor maintenance @simongajdosechfeature @matrosovsduplicate @deblocktduplicate @dohoonduplicate @madheshrduplicate @alexduplicate @shashankitmasterduplicate @akashgupta08duplicate @JLLeitschuhdocumentation @silentsnoocdocumentation @rajatdocumentation @ljp510016132documentation @sdocumentation @Sir4ur0ndocumentation @dreambrotherdocumentation @neil4dongdocumentation @mojaiqdocumentation @kevinm416documentation @pinkyjain26documentation duplicate @kidshgduplicate @bohdanduplicate @gauravphoenixnot-reproducable @bbrenneduplicate @milosonatorduplicate @jrishabh198duplicate @ejuniorasasduplicate @cxl086not-reproducable wontfix @raderionot-reproducable @cesartlduplicate @joelduplicate @frbo42not-reproducable @heyuxianduplicate @drendanot-reproducable @rawadrifainot-reproducable @lorenzobenvenutinot-reproducable @muff1nmanduplicate @jdupont22not-reproducable @gionnnot-reproducable @GarrettMosiervendorExtension scope to all auth requests @pmlido=================
============
=============
The one spring data rest support lands!
Thank you for all your contributions!
Not to mention all the questions and suggestions by the community!! :metal:
(#1145) Generated file is not compatible with Swagger specification if method parameter is Object and is used as path parameter @tjuchniewicz (#1122) Default page served isn't configurable and lacks search / listAll functionality @porcoesphino (#1087) Change hardcoded "api_key" @JulianaRed (#1061) Add support @RequestParam of type Map<String, String> @matias2681 (#1046) Control over swagger contact object @smwurster (#1037) Add support for multiple allowable values @smwurster (#1023) Provide a method for Model Properties to by sorted by configurable methods @nickpanaiotov (#969) Support alternate type resolution for @ModelAttribute annotated model fields @ejain (#937) Add support for @ResponseHeader @MarkVanVenrooij (#936) Add support for adding global tags to the docket @dilipkrish (#735) Support for adding additional models for request or response that are not inferred from operationshas-workaround @cabbonizio (#388) @ApiParam not working on Interface method declarations @charleslieferando (#356) Support for JSR-303 (Java Bean Validation) @omayevskiy
(#1194) Swagger-ui does not render correctly in safari @dilipkrish (#1193) NPE when Feign, Swagger and Spring Security are used - Brixton.BUILD-SNAPSHOT @varghgeorge (#1186) Unwanted class with map of map attribute @cbornet (#1174) Doc: includePatterns does not exist (anymore?) can-use-for-docs @vorburger (#1147) Using parameterized types using Void resulting in invalid Swagger @nigelsim (#1132) Api operations on abstract superclass not affected by @API tags @gionn (#1129) Swagger2Controller.getDocumentation get IndexOutOfBoundsException @yqzhan2014 (#1127) Setup base URL after Swagger UI is initialized #1126 @chornyi (#1126) Race condition and crash on Swagger UI startup @chornyi (#1125) Service description has no api's as the path regular expression does not match any of the service @irfandawood (#1051) Customised ObjectMapper not recognized @milanov (#953) NullPointerException when extending controller classes with multiple parameterized types @woemler (#902) @ApiImplicitParam: "array" dataType is getting resolved into "type":"ref" @anny-ts
(#1180) Supply the text values for `@ApiOperation, @ApiResponse, @ApiParam, @ApiModelProperty from an external resource file, instead of hardcoding? @joetconcur (#1168) Changelog not being updated question @jayanderson (#1161) Update documentation for JSR310 and Joda dates @cbornet (#1142) Fix the reference document not showing versions correctly in the gh pages @dilipkrish (#854) Rework the ModelRef design to not be a hacky project of the swagger models @dilipkrish
(#1189) Allow extension of ApiResourceController by making its methods public @gmarziou (#1165) ParameterDefaultReader in swagger does not honor other annotations usage of DefaultValue @ctruzzi (#1163) Updated the Docket XML Configuration Documentation @kellydavid (#1159) Add basic Bean validation api (JSR-303) support @jfiala (#1127) Setup base URL after Swagger UI is initialized #1126 @chornyi
===================
Full Changelog Big thank you to @wxjlibra, @abaile33 for reporting bugs and Thanks @sbuettner and @vmarusic for the PRs!
Maintenance:
spring-hateoas #1104java.util.Objects class so that java 6 is still supportedPull Requests:
Bug Fixes:
Full Changelog As usual thank you for all your support, especially @RobWin for also hanging out on the gitter channel and helping answering questions!
Highlights of this release are:
Features:
Pull requests from the community: :bow:
Bug Fixes:
Closed issues:
Thank you as usual for everyone who contributed in some for or the other to make this product better!! This release sneaks in some features we're incubating to provide hypermedia support.
This release is mostly a stabilization release due to issues related to the introduction of using the spring caching abstraction.
@Incubation and @Deprecated certain apis.ResourceGroupingStrategy has following deprecations getResourceDescription and getResourcePosition
Includes major bug fix that caused degraded performance and a few minor bug fixes
Significant changes include:
com.wordnik.swagger.* to io.swagger.*Thank you for all your contributions!
This is a major release for springfox (formally swagger-springmvc). This release includes the long awaited support for Swagger 2.0 along with some significant architectural changes aimed at improving extensibility and laying a foundation for sporting API specifications other than Swagger.
There has also been some less visible work going on:
springfox.documentation.spring.web.plugins.Docket replaces what was com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugincom.mangofactory.swagger.configuration.SpringSwaggerConfig has been removed.springfox.documentation.spring.web.plugins.ApiSelectorBuilderWe would like to thank the following community members for helping with this release:
[#552] Enable ApiResponses annotation on interface
[#541] Fix the rendering of enums in model properties. Attempt to clean up logic to handle bare enums in the response
[#539] Prevents excludeAnnotations from modifying the defaults in SpringSwaggerConfig
[#496] Upgerades swagger-ui webjar version. Adds jstl dependencies to fix webjar context path
Use @ApiModel.value as alternate type name for serialization
Respect original property ordering on models.
Introduced pmd and addressed the violations and added findbugs plugin
This solution lets delegates the choice of interpreting the position. Part of the solution to the problem reported in #519
springfox.swagger.plugins.SwaggerSpringMvcPlugin .useDefaultResponseMessagescom.wordnik.swagger.model) have been removed.
The equivalent java models now live in springfox.swagger.models.dto. If an application has
configured swagger auth or custom response messages it's likely there will be compilation issues with this
upgrade, the fix is to simply import the java equivalents from springfox.swagger.models.dto.
There are also builders in springfox.swagger.models.dto.builder. These are the most likely offenders: