Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.2.18] - 2019-12-08

Addded

Globally exclude params for webflux #228

[1.2.17] - 2019-12-05

Addded

Handle multiple endpoints on @GetParam #219

Changed

Upgrade Springboot to 2.2.1
Upgrade Swagger UI to 3.24.3
Upgrade webjars locator to 0.38

[1.2.16] - 2019-12-04

Added

Add Spring Boot metadata for config properties. #208
Explicitly set which packages/ paths to scan #210
Disable the try it out button #214

Changed

Changed getOpenApi in AbstractOpenApiResource to synchronized #209

Fixed

Missing Response Content - #212

[1.2.15] - 2019-11-30

Added

Ignore @AuthenticationPrincipal from spring-security #198

[1.2.14] - 2019-11-30

Added

Add operationsSorter and tagsSorter configuration.

Changed

Flux<> implies array structure #195
Improve support of ArraySchema in @Parameter #202

Removed

Removed default description on RequestBody annotation #207

Fixed

Duplicated mapping key. Random ConcurrentModificationException error #206

[1.2.13] - 2019-11-28

Added

Add Ability to Configure Swagger UI - The support of the swagger official properties #192
Support of @Parameters on controller or interface level #185

[1.2.12] - 2019-11-27

Added

Disable/enable Swagger-UI generation based on env variable #191

Changed

Update README.md #189

[1.2.11] - 2019-11-24

Added

Use @Deprecated annotation to mark API operation as deprecated #180
Support for mappring Pageable of spring-data to correct URL-Parameter in Swagger UI #177

[1.2.10] - 2019-11-22

Added

Make webjars prefix configurable
Generate a default tag name if no tag specified
Support for Kotlin Coroutines added #172

Changed

update swagger api version to 2.0.10 #167

[1.2.9] - 2019-11-19

Changed

project refactoring

[1.2.8] - 2019-11-18

Added

Support custom annotations of @RequestMapping #160
Add @NotEmpty @NotBlank @PositiveOrZero @NegativeOrZero support #161

Changed

Improve handling of @RequestBody Mono #163

[1.2.7] - 2019-11-18

Added

Support @Schema(hidden = true) on @Parameter #148

[1.2.6] - 2019-11-10

Changed

project refactoring

[1.2.5] - 2019-11-10

Added

Support of RequestMapping with Regex #145
Open base classes for subclassing outside of package

Fixed

Improve handling interface methods #147

[1.2.4] - 2019-11-07

Changed

Improve Media Type management, on ControllerAdvice method with explicit ApiResponse annotation #144
Using @Content on @ApiResponse, will ensure that no content will be generated on the OpenAPI yml/json description. #143

Fixed

Error on calling GET /v3/api-docs #142

[1.2.3] - 2019-11-03

Added

Support for @Controller class with @ResponseBody annotation #138

[1.2.2] - 2019-11-02

Changed

project refactoring

[1.2.1] - 2019-11-02

Added

upgrade to spring-boot 2.2.0.RELEASE
Open up for customisation #136: Change signatures on some methods in AbstractParameterBuilder
Add support for @JsonView annotations in Spring MVC APIs #107

[1.2.0] - 2019-10-27

Added

rename module springdoc-openapi-core to springdoc-openapi-webmvc-core
Missing Header parameters from @Operation annotation #127
Ui with multiple file @RequestPart only shows last part #55

[1.1.49] - 2019-10-22

Changed

Upgrade swagger-api from 2.0.9 to 2.0.10
Upgrade swagger-ui from 3.23.5 to 3.24.0

[1.1.48] - 2019-10-15

Changed

Enable strict JSON output checking in tests #115

[1.1.47] - 2019-10-15

Added

Make ignoring parameters in AbstractRequestBuilder easier to extend
Do not ignore PathVariable parameters, they are all time mandatory
Extend search for @ApiResponse annotations
Ability to generate operation responses that reference a global reusable response component #114

[1.1.46] - 2019-10-11

Changed

Imporove support of oneOf Response schemas: merge will be based on content element inside @ApiResponse annotation only #106

Added

@SecurityRequirement at Operation and class level

[1.1.45] - 2019-10-03

Changed

Project refactoring

[1.1.44] - 2019-09-29

Added

Added sample tests for Swagger UI #99
Support of Kotlin List of MultipartFile #95

Changed

Imporive inconsistency of generated operationId in /v3/api-docs #96
Change behaviour to not overwrite an existing common schema. #98

[1.1.43] - 2019-09-24

Added

New Feature: OpenAPICustomiser #92
Added Custom converter to handle IllegalArgumentException at com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.getSetter() #94

[1.1.42] - 2019-09-23

Fixed

Error in AbstractResponseBuilder.Schema calculateSchema(Components components, ParameterizedType parameterizedType) #90

[1.1.41] - 2019-09-21

Changed

Project refactoring

[1.1.40] - 2019-09-21

Changed

Imporove support of overloaded methods in the same Rest Controller

[1.1.39] - 2019-09-15

Added

Added specefic tag for spring-boot-actuator endpoints

[1.1.38] - 2019-09-15

Added

Support of spring-boot-actuator endpoints to swagger-ui #88

[1.1.37] - 2019-09-06

Changed

Update README.md

Fixed

Regression between 1.1.33 and 1.1.34 #84

[1.1.36] - 2019-09-04

Added

Make @Hidden work on classlevel of @RestControllerAdvice #81

Fixed

ClassCastException in org.springdoc.core.AbstractResponseBuilder#calculateSchema #76

[1.1.35] - 2019-09-04

Changed

Project refactoring

[1.1.34] - 2019-09-04

Added

Query parameter with defaultValue specified will not be marked as required #72
Added Support for callbacks #74
WebFlux Multipart File Upload - Support for FilePart #75

Fixed

Error in version 1.1.27 #79
requestBody content is empty when using @RequestMapping annotation but is populated for @PostMapping #80

[1.1.33] - 2019-09-01

Changed

Project refactoring

[1.1.32] - 2019-08-30

Fixed

Regression between 1.1.25 and 1.1.26 #70

[1.1.31] - 2019-08-28

Changed

Added more tests
Spring ResponseEntity shoudl not return empty MediaType for no-body responses #68

[1.1.30] - 2019-08-27

Fixed

Operation.requestBody.content[0].mediaType is ignored #62

[1.1.29] - 2019-08-26

Added

Support of schema.example for string/date-time #61

[1.1.28] - 2019-08-26

Changed

project refactoring

[1.1.27] - 2019-08-26

Added

View on the Swagger-ui multiple file @RequestPart #55

[1.1.26] - 2019-08-25

Added

Support beans as parameter in @GetMapping / components empty #12

Changed

Improve Generic (error) responses built from ControllerAdvice #53
Parameter documentation overwritten by schema calculation based on type #59

[1.1.25] - 2019-08-23

Added

Ignore HttpServletRequest and HttpServletResponse params #57
HTTP status codes in responses not according to spec #46
better support for global parameters
Support of @Hidden annotation for ControllerAdvice exception handlers

Changed

Do not override parameter.schema #51

[1.1.24] - 2019-08-15

Changed

project refactoring

[1.1.23] - 2019-08-15

Changed

project refactoring

[1.1.22] - 2019-08-15

Added

A Controller method that does not return a response body will not document a schema #40
Make sure the swagger-ui.path of the initial html page is the same for other swagger-ui requests

[1.1.21] - 2019-08-15

Added

Allow to overwrite default API response #35

Fixed

Exception in case of parametrized types inside ReponseEntity #34

[1.1.20] - 2019-08-14

Changed

project refactoring

[1.1.19] - 2019-08-14

Fixed

Attempting to add @SecurityScheme to annotation results in a NPE. #36

[1.1.18] - 2019-08-14

Added

Support the io.swagger.v3.oas.annotations.security.SecurityScheme annotation #33
Support the io.swagger.v3.oas.annotations.Hidden annotation to exclude from swagger docs #32

Changed

update README

[1.1.17] - 2019-08-12

Changed

project refactoring

[1.1.16] - 2019-08-12

Added

Support hiding of Schema and Example Value #16

[1.1.15] - 2019-08-12

Added

Add property that helps disable springdoc-openapi endpoints.

[1.1.14] - 2019-08-11

Changed

project refactoring

[1.1.13] - 2019-08-10

Added

Add server url on webflux

[1.1.12] - 2019-08-10

Changed

project refactoring

[1.1.11] - 2019-08-09

Changed

project refactoring

[1.1.10] - 2019-08-09

Changed

project refactoring

[1.1.9] - 2019-08-09

Added

Load components from OpenAPI bean config #28
Load components from OpenAPI bean config
Support handling @requestbody annotation directly at parameter level

[1.1.8] - 2019-08-08

Added

Detect context-path on standalone webservers #20

Changed

Parameter will not be missing, if @parameter is used without name. #23

[1.1.7] - 2019-08-07

Added

Support of @javax.validation.Size specs with (maximum instead of maxLength) #21
Any @GetMapping parameters should be marked as required, even if @RequestParam missing #14
Handling @parameter in @operation with proper schema #17

[1.1.6] - 2019-08-02

Changed

project refactoring

[1.1.5] - 2019-08-01

Added

Support MultipartFile schema in UI #1

[1.1.4] - 2019-08-01

Changed

project refactoring

[1.1.3] - 2019-07-31

Added

support Annotations from interfaces #8
oneOf response implementation #10
Support Spring Boot WebFlux Netty #3

Changed

Complete parameter types list to be excluded #9

[1.1.2] - 2019-07-30

Added

Allow to customize OpenAPI object programmatically #4

[1.1.1] - 2019-07-27

Fixed

context-path is not respected when using Swagger UI - #2

[1.1.0] - 2019-07-25

Changed

update README.md

[1.0.1] - 2019-07-24

Added

Added sample codes

[1.0.0] - 2019-07-23

Added

First release of springdoc-openapi, that supports OpenAPI 3

[0.0.14] - 2019-07-21

Added

Experimental release