|
| 1 | +# Changelog |
| 2 | +All notable changes to this project will be documented in this file. |
| 3 | + |
| 4 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 5 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 6 | + |
| 7 | +## [1.2.18] - 2019-12-08 |
| 8 | +### Addded |
| 9 | +- Globally exclude params for webflux #228 |
| 10 | + |
| 11 | +## [1.2.17] - 2019-12-05 |
| 12 | +### Addded |
| 13 | +- Handle multiple endpoints on @GetParam #219 |
| 14 | + |
| 15 | +### Changed |
| 16 | +- Upgrade Springboot to 2.2.1 |
| 17 | +- Upgrade Swagger UI to 3.24.3 |
| 18 | +- Upgrade webjars locator to 0.38 |
| 19 | + |
| 20 | +## [1.2.16] - 2019-12-04 |
| 21 | +### Added |
| 22 | +- Add Spring Boot metadata for config properties. #208 |
| 23 | +- Explicitly set which packages/ paths to scan #210 |
| 24 | +- Disable the try it out button #214 |
| 25 | + |
| 26 | +### Changed |
| 27 | +- Changed getOpenApi in AbstractOpenApiResource to synchronized #209 |
| 28 | + |
| 29 | +### Fixed |
| 30 | +- Missing Response Content - #212 |
| 31 | + |
| 32 | +## [1.2.15] - 2019-11-30 |
| 33 | +### Added |
| 34 | +- Ignore @AuthenticationPrincipal from spring-security #198 |
| 35 | + |
| 36 | +## [1.2.14] - 2019-11-30 |
| 37 | +### Added |
| 38 | +- Add operationsSorter and tagsSorter configuration. |
| 39 | +### Changed |
| 40 | +- Flux<> implies array structure #195 |
| 41 | +- Improve support of ArraySchema in @Parameter #202 |
| 42 | +### Removed |
| 43 | +- Removed default description on RequestBody annotation #207 |
| 44 | +### Fixed |
| 45 | +- Duplicated mapping key. Random ConcurrentModificationException error #206 |
| 46 | + |
| 47 | +## [1.2.13] - 2019-11-28 |
| 48 | +### Added |
| 49 | +- Add Ability to Configure Swagger UI - The support of the swagger official properties #192 |
| 50 | +- Support of @Parameters on controller or interface level #185 |
| 51 | + |
| 52 | +## [1.2.12] - 2019-11-27 |
| 53 | +### Added |
| 54 | +- Disable/enable Swagger-UI generation based on env variable #191 |
| 55 | +### Changed |
| 56 | +- Update README.md #189 |
| 57 | + |
| 58 | +## [1.2.11] - 2019-11-24 |
| 59 | +### Added |
| 60 | +- Use `@Deprecated` annotation to mark API operation as deprecated #180 |
| 61 | +- Support for mappring Pageable of spring-data to correct URL-Parameter in Swagger UI #177 |
| 62 | + |
| 63 | +## [1.2.10] - 2019-11-22 |
| 64 | +### Added |
| 65 | +- Make webjars prefix configurable |
| 66 | +- Generate a default tag name if no tag specified |
| 67 | +- Support for Kotlin Coroutines added #172 |
| 68 | +### Changed |
| 69 | +- update swagger api version to 2.0.10 #167 |
| 70 | + |
| 71 | +## [1.2.9] - 2019-11-19 |
| 72 | +### Changed |
| 73 | +- project refactoring |
| 74 | + |
| 75 | +## [1.2.8] - 2019-11-18 |
| 76 | +### Added |
| 77 | +- Support custom annotations of @RequestMapping #160 |
| 78 | +- Add @NotEmpty @NotBlank @PositiveOrZero @NegativeOrZero support #161 |
| 79 | + |
| 80 | +### Changed |
| 81 | +- Improve handling of @RequestBody Mono<Tweet> #163 |
| 82 | + |
| 83 | +## [1.2.7] - 2019-11-18 |
| 84 | +### Added |
| 85 | +- Support @Schema(hidden = true) on @Parameter #148 |
| 86 | + |
| 87 | +## [1.2.6] - 2019-11-10 |
| 88 | +### Changed |
| 89 | +- project refactoring |
| 90 | + |
| 91 | +## [1.2.5] - 2019-11-10 |
| 92 | +### Added |
| 93 | +- Support of RequestMapping with Regex #145 |
| 94 | +- Open base classes for subclassing outside of package |
| 95 | +### Fixed |
| 96 | +- Improve handling interface methods #147 |
| 97 | + |
| 98 | +## [1.2.4] - 2019-11-07 |
| 99 | +### Changed |
| 100 | +- Improve Media Type management, on ControllerAdvice method with explicit ApiResponse annotation #144 |
| 101 | +- Using @Content on @ApiResponse, will ensure that no content will be generated on the OpenAPI yml/json description. #143 |
| 102 | + |
| 103 | +### Fixed |
| 104 | +- Error on calling GET /v3/api-docs #142 |
| 105 | + |
| 106 | +## [1.2.3] - 2019-11-03 |
| 107 | +### Added |
| 108 | +- Support for @Controller class with @ResponseBody annotation #138 |
| 109 | + |
| 110 | +## [1.2.2] - 2019-11-02 |
| 111 | +### Changed |
| 112 | +- project refactoring |
| 113 | + |
| 114 | +## [1.2.1] - 2019-11-02 |
| 115 | +### Added |
| 116 | +- upgrade to spring-boot 2.2.0.RELEASE |
| 117 | +- Open up for customisation #136: Change signatures on some methods in AbstractParameterBuilder |
| 118 | +- Add support for @JsonView annotations in Spring MVC APIs #107 |
| 119 | + |
| 120 | +## [1.2.0] - 2019-10-27 |
| 121 | +### Added |
| 122 | +- rename module springdoc-openapi-core to springdoc-openapi-webmvc-core |
| 123 | +- Missing Header parameters from @Operation annotation #127 |
| 124 | +- Ui with multiple file @RequestPart only shows last part #55 |
| 125 | + |
| 126 | +## [1.1.49] - 2019-10-22 |
| 127 | +### Changed |
| 128 | +- Upgrade swagger-api from 2.0.9 to 2.0.10 |
| 129 | +- Upgrade swagger-ui from 3.23.5 to 3.24.0 |
| 130 | + |
| 131 | +## [1.1.48] - 2019-10-15 |
| 132 | +### Changed |
| 133 | +- Enable strict JSON output checking in tests #115 |
| 134 | + |
| 135 | +## [1.1.47] - 2019-10-15 |
| 136 | +### Added |
| 137 | +- Make ignoring parameters in AbstractRequestBuilder easier to extend |
| 138 | +- Do not ignore PathVariable parameters, they are all time mandatory |
| 139 | +- Extend search for @ApiResponse annotations |
| 140 | +- Ability to generate operation responses that reference a global reusable response component #114 |
| 141 | + |
| 142 | +## [1.1.46] - 2019-10-11 |
| 143 | +### Changed |
| 144 | +- Imporove support of `oneOf` Response schemas: merge will be based on content element inside @ApiResponse annotation only #106 |
| 145 | +### Added |
| 146 | +- @SecurityRequirement at Operation and class level |
| 147 | + |
| 148 | +## [1.1.45] - 2019-10-03 |
| 149 | +### Changed |
| 150 | +- Project refactoring |
| 151 | + |
| 152 | +## [1.1.44] - 2019-09-29 |
| 153 | +### Added |
| 154 | +- Added sample tests for Swagger UI #99 |
| 155 | +- Support of Kotlin List of MultipartFile #95 |
| 156 | +### Changed |
| 157 | +- Imporive inconsistency of generated operationId in /v3/api-docs #96 |
| 158 | +- Change behaviour to not overwrite an existing common schema. #98 |
| 159 | + |
| 160 | +## [1.1.43] - 2019-09-24 |
| 161 | +### Added |
| 162 | +- New Feature: OpenAPICustomiser #92 |
| 163 | +- Added Custom converter to handle IllegalArgumentException at com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.getSetter() #94 |
| 164 | + |
| 165 | +## [1.1.42] - 2019-09-23 |
| 166 | +### Fixed |
| 167 | +- Error in AbstractResponseBuilder.Schema calculateSchema(Components components, ParameterizedType parameterizedType) #90 |
| 168 | + |
| 169 | +## [1.1.41] - 2019-09-21 |
| 170 | +### Changed |
| 171 | +- Project refactoring |
| 172 | + |
| 173 | +## [1.1.40] - 2019-09-21 |
| 174 | +### Changed |
| 175 | +- Imporove support of overloaded methods in the same Rest Controller |
| 176 | + |
| 177 | +## [1.1.39] - 2019-09-15 |
| 178 | +### Added |
| 179 | +- Added specefic tag for spring-boot-actuator endpoints |
| 180 | + |
| 181 | +## [1.1.38] - 2019-09-15 |
| 182 | +### Added |
| 183 | +- Support of spring-boot-actuator endpoints to swagger-ui #88 |
| 184 | + |
| 185 | +## [1.1.37] - 2019-09-06 |
| 186 | +### Changed |
| 187 | +- Update README.md |
| 188 | + |
| 189 | +### Fixed |
| 190 | +- Regression between 1.1.33 and 1.1.34 #84 |
| 191 | + |
| 192 | +## [1.1.36] - 2019-09-04 |
| 193 | +### Added |
| 194 | +- Make @Hidden work on classlevel of @RestControllerAdvice #81 |
| 195 | +### Fixed |
| 196 | +- ClassCastException in org.springdoc.core.AbstractResponseBuilder#calculateSchema #76 |
| 197 | + |
| 198 | +## [1.1.35] - 2019-09-04 |
| 199 | +### Changed |
| 200 | +- Project refactoring |
| 201 | + |
| 202 | +## [1.1.34] - 2019-09-04 |
| 203 | +### Added |
| 204 | +- Query parameter with defaultValue specified will not be marked as required #72 |
| 205 | +- Added Support for callbacks #74 |
| 206 | +- WebFlux Multipart File Upload - Support for FilePart #75 |
| 207 | +### Fixed |
| 208 | +- Error in version 1.1.27 #79 |
| 209 | +- requestBody content is empty when using @RequestMapping annotation but is populated for @PostMapping #80 |
| 210 | + |
| 211 | +## [1.1.33] - 2019-09-01 |
| 212 | +### Changed |
| 213 | +- Project refactoring |
| 214 | + |
| 215 | +## [1.1.32] - 2019-08-30 |
| 216 | +### Fixed |
| 217 | +- Regression between 1.1.25 and 1.1.26 #70 |
| 218 | + |
| 219 | +## [1.1.31] - 2019-08-28 |
| 220 | +### Changed |
| 221 | +- Added more tests |
| 222 | +- Spring ResponseEntity shoudl not return empty MediaType for no-body responses #68 |
| 223 | + |
| 224 | +## [1.1.30] - 2019-08-27 |
| 225 | +### Fixed |
| 226 | +- Operation.requestBody.content[0].mediaType is ignored #62 |
| 227 | + |
| 228 | +## [1.1.29] - 2019-08-26 |
| 229 | +### Added |
| 230 | +- Support of schema.example for string/date-time #61 |
| 231 | + |
| 232 | +## [1.1.28] - 2019-08-26 |
| 233 | +### Changed |
| 234 | +- project refactoring |
| 235 | + |
| 236 | +## [1.1.27] - 2019-08-26 |
| 237 | +### Added |
| 238 | +- View on the Swagger-ui multiple file @RequestPart #55 |
| 239 | + |
| 240 | +## [1.1.26] - 2019-08-25 |
| 241 | +### Added |
| 242 | +- Support beans as parameter in @GetMapping / components empty #12 |
| 243 | +### Changed |
| 244 | +- Improve Generic (error) responses built from `ControllerAdvice` #53 |
| 245 | +- Parameter documentation overwritten by schema calculation based on type #59 |
| 246 | + |
| 247 | +## [1.1.25] - 2019-08-23 |
| 248 | +### Added |
| 249 | +- Ignore HttpServletRequest and HttpServletResponse params #57 |
| 250 | +- HTTP status codes in responses not according to spec #46 |
| 251 | +- better support for global parameters |
| 252 | +- Support of @Hidden annotation for ControllerAdvice exception handlers |
| 253 | +### Changed |
| 254 | +- Do not override parameter.schema #51 |
| 255 | + |
| 256 | +## [1.1.24] - 2019-08-15 |
| 257 | +### Changed |
| 258 | +- project refactoring |
| 259 | + |
| 260 | +## [1.1.23] - 2019-08-15 |
| 261 | +### Changed |
| 262 | +- project refactoring |
| 263 | + |
| 264 | +## [1.1.22] - 2019-08-15 |
| 265 | +### Added |
| 266 | +- A Controller method that does not return a response body will not document a schema #40 |
| 267 | +- Make sure the swagger-ui.path of the initial html page is the same for other swagger-ui requests |
| 268 | + |
| 269 | +## [1.1.21] - 2019-08-15 |
| 270 | +### Added |
| 271 | +- Allow to overwrite default API response #35 |
| 272 | +### Fixed |
| 273 | +- Exception in case of parametrized types inside ReponseEntity #34 |
| 274 | + |
| 275 | +## [1.1.20] - 2019-08-14 |
| 276 | +### Changed |
| 277 | +- project refactoring |
| 278 | + |
| 279 | +## [1.1.19] - 2019-08-14 |
| 280 | +### Fixed |
| 281 | +- Attempting to add @SecurityScheme to annotation results in a NPE. #36 |
| 282 | + |
| 283 | +## [1.1.18] - 2019-08-14 |
| 284 | +### Added |
| 285 | +- Support the io.swagger.v3.oas.annotations.security.SecurityScheme annotation #33 |
| 286 | +- Support the io.swagger.v3.oas.annotations.Hidden annotation to exclude from swagger docs #32 |
| 287 | +### Changed |
| 288 | +- update README |
| 289 | + |
| 290 | +## [1.1.17] - 2019-08-12 |
| 291 | +### Changed |
| 292 | +- project refactoring |
| 293 | + |
| 294 | +## [1.1.16] - 2019-08-12 |
| 295 | +### Added |
| 296 | +- Support hiding of Schema and Example Value #16 |
| 297 | + |
| 298 | +## [1.1.15] - 2019-08-12 |
| 299 | +### Added |
| 300 | +- Add property that helps disable springdoc-openapi endpoints. |
| 301 | + |
| 302 | +## [1.1.14] - 2019-08-11 |
| 303 | +### Changed |
| 304 | +- project refactoring |
| 305 | + |
| 306 | +## [1.1.13] - 2019-08-10 |
| 307 | +### Added |
| 308 | +- Add server url on webflux |
| 309 | + |
| 310 | +## [1.1.12] - 2019-08-10 |
| 311 | +### Changed |
| 312 | +- project refactoring |
| 313 | + |
| 314 | +## [1.1.11] - 2019-08-09 |
| 315 | +### Changed |
| 316 | +- project refactoring |
| 317 | + |
| 318 | +## [1.1.10] - 2019-08-09 |
| 319 | +### Changed |
| 320 | +- project refactoring |
| 321 | + |
| 322 | +## [1.1.9] - 2019-08-09 |
| 323 | +### Added |
| 324 | +- Load components from OpenAPI bean config #28 |
| 325 | +- Load components from OpenAPI bean config |
| 326 | +- Support handling @requestbody annotation directly at parameter level |
| 327 | + |
| 328 | +## [1.1.8] - 2019-08-08 |
| 329 | +### Added |
| 330 | +- Detect context-path on standalone webservers #20 |
| 331 | +### Changed |
| 332 | +- Parameter will not be missing, if @parameter is used without name. #23 |
| 333 | + |
| 334 | +## [1.1.7] - 2019-08-07 |
| 335 | +### Added |
| 336 | +- Support of @javax.validation.Size specs with (maximum instead of maxLength) #21 |
| 337 | +- Any @GetMapping parameters should be marked as required, even if @RequestParam missing #14 |
| 338 | +- Handling @parameter in @operation with proper schema #17 |
| 339 | + |
| 340 | +## [1.1.6] - 2019-08-02 |
| 341 | +### Changed |
| 342 | +- project refactoring |
| 343 | + |
| 344 | +## [1.1.5] - 2019-08-01 |
| 345 | +### Added |
| 346 | +- Support MultipartFile schema in UI #1 |
| 347 | + |
| 348 | +## [1.1.4] - 2019-08-01 |
| 349 | +### Changed |
| 350 | +- project refactoring |
| 351 | + |
| 352 | +## [1.1.3] - 2019-07-31 |
| 353 | +### Added |
| 354 | +- support Annotations from interfaces #8 |
| 355 | +- oneOf response implementation #10 |
| 356 | +- Support Spring Boot WebFlux Netty #3 |
| 357 | +### Changed |
| 358 | +- Complete parameter types list to be excluded #9 |
| 359 | + |
| 360 | +## [1.1.2] - 2019-07-30 |
| 361 | +### Added |
| 362 | +- Allow to customize OpenAPI object programmatically #4 |
| 363 | + |
| 364 | +## [1.1.1] - 2019-07-27 |
| 365 | +### Fixed |
| 366 | +- context-path is not respected when using Swagger UI - #2 |
| 367 | + |
| 368 | +## [1.1.0] - 2019-07-25 |
| 369 | +### Changed |
| 370 | +- update README.md |
| 371 | + |
| 372 | +## [1.0.1] - 2019-07-24 |
| 373 | +### Added |
| 374 | +- Added sample codes |
| 375 | + |
| 376 | +## [1.0.0] - 2019-07-23 |
| 377 | +### Added |
| 378 | +- First release of springdoc-openapi, that supports OpenAPI 3 |
| 379 | + |
| 380 | +## [0.0.14] - 2019-07-21 |
| 381 | +### Added |
| 382 | +- Experimental release |
| 383 | + |
0 commit comments