Skip to content

Commit 233efd4

Browse files
author
springdoc
committed
added ChangeLog
1 parent 780156c commit 233efd4

File tree

1 file changed

+385
-0
lines changed

1 file changed

+385
-0
lines changed

CHANGELOG.md

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

0 commit comments

Comments
 (0)