|
| 1 | +## v4.2.1 2025-07-19 |
| 2 | + |
| 3 | +- Fixes issue where register_api isn't idempotent by @zakmatik in #230 |
| 4 | +- Make validate_request pass on existing kwargs but remove those part of path by @puittenbroek in #227 |
| 5 | + |
1 | 6 | ## v4.2.0 2025-06-21 |
2 | 7 |
|
3 | 8 | - fix(models): enable 'populate_by_name' to alias fields correctly by @omikader in #221 |
4 | 9 | - operation_id_callback with blueprint name and func name by @luolingchun in #224 |
5 | 10 | - Delay throwing validation error by @luolingchun in #223 |
6 | 11 |
|
7 | | - |
8 | 12 | ## v4.1.0 2025-02-08 |
9 | 13 |
|
10 | 14 | - Support for Python 3.13 by @luolingchun in #200 |
|
18 | 22 |
|
19 | 23 | - Add PrefixItems to Schema Model for use with Tuple types by @JesseDeLoore in #197 |
20 | 24 |
|
21 | | - |
22 | 25 | ## v4.0.2 2024-11-10 |
23 | 26 |
|
24 | 27 | - Reuse schema["title"] if it's defined by @ddorian in #186 |
25 | 28 | - Simple webhook schema by @ddorian in #191 |
26 | 29 | - Fix missing Field.default when it's value is None in openapi spec by @ddorian in #189 |
27 | 30 | - ServerVariable.enum should be optional by @luolingchun in #194 |
28 | 31 |
|
29 | | - |
30 | 32 | ## v4.0.1 2024-10-05 |
31 | 33 |
|
32 | | -- Fix alias in query and form by @luolingchun in #184 |
| 34 | +- Fix alias in query and form by @luolingchun in #184 |
33 | 35 |
|
34 | 36 | ## v4.0.0 2024-09-29 |
35 | 37 |
|
|
116 | 118 | - [#106](https://github.com/luolingchun/flask-openapi3/pull/106) Bugfix for parameter object. Thanks, @ota42y. |
117 | 119 | - [#107](https://github.com/luolingchun/flask-openapi3/pull/107) Bugfix for generics class. Thanks, @ota42y. |
118 | 120 | - [#114](https://github.com/luolingchun/flask-openapi3/pull/114) Support Flask 3.0. |
119 | | -- [#118](https://github.com/luolingchun/flask-openapi3/discussions/118) Fix missed components schemas in ValidationErrorModel. Thanks, @SeFeX. |
| 121 | +- [#118](https://github.com/luolingchun/flask-openapi3/discussions/118) Fix missed components schemas in |
| 122 | + ValidationErrorModel. Thanks, @SeFeX. |
120 | 123 | - [#122](https://github.com/luolingchun/flask-openapi3/issues/122) Skip 422 response non parameters. Thanks, @Danielsn1. |
121 | 124 |
|
122 | | - |
123 | 125 | ## v3.0.0rc2 2023-10-03 |
124 | 126 |
|
125 | 127 | - [#105](https://github.com/luolingchun/flask-openapi3/pull/105) Supports valid properties only. Thanks, @ota42y. |
|
141 | 143 |
|
142 | 144 | ## v2.5.4 2023-10-22 |
143 | 145 |
|
144 | | -- [#118](https://github.com/luolingchun/flask-openapi3/discussions/118) Fix missed components schemas in ValidationErrorModel. Thanks, @SeFeX. |
| 146 | +- [#118](https://github.com/luolingchun/flask-openapi3/discussions/118) Fix missed components schemas in |
| 147 | + ValidationErrorModel. Thanks, @SeFeX. |
145 | 148 | - [#122](https://github.com/luolingchun/flask-openapi3/issues/122) Skip 422 response non parameters. Thanks, @Danielsn1. |
146 | 149 |
|
147 | 150 | ## v2.5.3 2023-10-03 |
|
156 | 159 |
|
157 | 160 | ## v2.5.1 2023-08-07 |
158 | 161 |
|
159 | | -- [#95](https://github.com/luolingchun/flask-openapi3/pull/95) Added ability to deserialize complex form parameter objects. Thanks, @BlackGad. |
| 162 | +- [#95](https://github.com/luolingchun/flask-openapi3/pull/95) Added ability to deserialize complex form parameter |
| 163 | + objects. Thanks, @BlackGad. |
160 | 164 |
|
161 | 165 | ## v2.5.0 2023-08-02 |
162 | 166 |
|
163 | | -- [#79](https://github.com/luolingchun/flask-openapi3/discussions/79) Support `by_alias` in Model Config. Thanks, @candleindark. |
| 167 | +- [#79](https://github.com/luolingchun/flask-openapi3/discussions/79) Support `by_alias` in Model Config. Thanks, |
| 168 | + @candleindark. |
164 | 169 | - [#82](https://github.com/luolingchun/flask-openapi3/issues/82) Fix parameter in url_prefix. Thanks, @riedgar-ms. |
165 | | -- [#83](https://github.com/luolingchun/flask-openapi3/pull/83) Be able to change 422 validation errors to other http response status. Thanks, @CostcoFanboy. |
166 | | -- [#86](https://github.com/luolingchun/flask-openapi3/issues/86) Responses key supports both string, int, and HTTPStatus. Thanks, @CostcoFanboy. |
| 170 | +- [#83](https://github.com/luolingchun/flask-openapi3/pull/83) Be able to change 422 validation errors to other http |
| 171 | + response status. Thanks, @CostcoFanboy. |
| 172 | +- [#86](https://github.com/luolingchun/flask-openapi3/issues/86) Responses key supports both string, int, and |
| 173 | + HTTPStatus. Thanks, @CostcoFanboy. |
167 | 174 |
|
168 | 175 | ## v2.4.0 2023-06-04 |
169 | 176 |
|
170 | 177 | - [#72](https://github.com/luolingchun/flask-openapi3/pull/72) security_schemes(SecurityScheme) supports a json format. |
171 | 178 | - [#68](https://github.com/luolingchun/flask-openapi3/pull/68) feat: Add operation_id_callback. Thanks, @BoyanYK. |
172 | | -- [#64](https://github.com/luolingchun/flask-openapi3/pull/64) Explains the usage of flask openapi command more clearly. Thanks, @candleindark. |
| 179 | +- [#64](https://github.com/luolingchun/flask-openapi3/pull/64) Explains the usage of flask openapi command more clearly. |
| 180 | + Thanks, @candleindark. |
173 | 181 | - [#75](https://github.com/luolingchun/flask-openapi3/pull/75) Init view_class and pass view_kwargs. Thanks, @stufisher. |
174 | | -- [#70](https://github.com/luolingchun/flask-openapi3/issues/70) Support for Specification Extensions in OpenAPI Object and Operation Object. Thanks, @simonblund. |
| 182 | +- [#70](https://github.com/luolingchun/flask-openapi3/issues/70) Support for Specification Extensions in OpenAPI Object |
| 183 | + and Operation Object. Thanks, @simonblund. |
175 | 184 | - [#73](https://github.com/luolingchun/flask-openapi3/issues/73) BaseModel Config support openapi_extra. |
176 | 185 | - Merge `extra_responses` to `responses` and deprecate `extra_responses`. |
177 | 186 |
|
178 | 187 | **DeprecationWarning:** |
179 | 188 |
|
180 | | -- Add DeprecationWarning to `APIKey`, `HTTPBase`, `OAuth2`, `OpenIdConnect`, `HTTPBearer` that will be deprecated in v3.0. |
| 189 | +- Add DeprecationWarning to `APIKey`, `HTTPBase`, `OAuth2`, `OpenIdConnect`, `HTTPBearer` that will be deprecated in |
| 190 | + v3.0. |
181 | 191 | - Add DeprecationWarning to `extra_form`, `extra_body` and `extra_responses` that will be deprecated in v3.0. |
182 | 192 |
|
183 | | - |
184 | 193 | ## v2.3.2 2023-04-03 |
185 | 194 |
|
186 | 195 | - [#61](https://github.com/luolingchun/flask-openapi3/issues/61) Fix headers with pydantic alias |
|
214 | 223 |
|
215 | 224 | ## v2.1.1 2022-10-12 |
216 | 225 |
|
217 | | -- [#41](https://github.com/luolingchun/flask-openapi3/issues/41) Set the `requestBody required` default value to True. Thanks, @Colin-b |
| 226 | +- [#41](https://github.com/luolingchun/flask-openapi3/issues/41) Set the `requestBody required` default value to True. |
| 227 | + Thanks, @Colin-b |
218 | 228 | - Fix multi decorator for api |
219 | | -- [#42](https://github.com/luolingchun/flask-openapi3/issues/42) Fix required header is not found when `_` in header field. Thanks, @elirud |
| 229 | +- [#42](https://github.com/luolingchun/flask-openapi3/issues/42) Fix required header is not found when `_` in header |
| 230 | + field. Thanks, @elirud |
220 | 231 |
|
221 | 232 | ## v2.1.0 2022-09-04 |
222 | 233 |
|
|
225 | 236 | - Add external_docs for operation |
226 | 237 | - Add servers for operation |
227 | 238 | - Support to parse extra field in parameters |
228 | | -- [#35](https://github.com/luolingchun/flask-openapi3/issues/35) Fixed extra_responses can now be used to set every field in Response. Thanks, @Colin-b |
| 239 | +- [#35](https://github.com/luolingchun/flask-openapi3/issues/35) Fixed extra_responses can now be used to set every |
| 240 | + field in Response. Thanks, @Colin-b |
229 | 241 | - Upgrade Swagger UI 4.14.0 |
230 | 242 | - Upgrade Redoc UI 2.0.0-rc.76 |
231 | 243 | - Upgrade RapiDoc UI 9.3.3 |
232 | 244 |
|
233 | | - |
234 | 245 | ### Breaking Changes |
235 | 246 |
|
236 | 247 | - [#39](https://github.com/luolingchun/flask-openapi3/issues/39) Remove configuration FLASK_OPENAPI_VALIDATE_RESPONSE |
237 | 248 |
|
238 | | - |
239 | 249 | ## v2.0.1 2022-08-07 |
240 | 250 |
|
241 | 251 | - [#32](https://github.com/luolingchun/flask-openapi3/issues/32) Fix: parse_rule is deprecated in werkzeug>=2.2.0. |
242 | 252 |
|
243 | 253 | ## v2.0.0 2022-06-26 |
244 | 254 |
|
245 | | -- [#26](https://github.com/luolingchun/flask-openapi3/issues/26) Fixed: Body throws exception when receiving str instead of dict. Thanks, @nor3th |
| 255 | +- [#26](https://github.com/luolingchun/flask-openapi3/issues/26) Fixed: Body throws exception when receiving str instead |
| 256 | + of dict. Thanks, @nor3th |
246 | 257 | - [#23](https://github.com/luolingchun/flask-openapi3/pull/23) Fixed externalDocs support. Thanks, @dvaerum |
247 | | -- [#28](https://github.com/luolingchun/flask-openapi3/pull/28) Fixed to enable `__root__` property when validation responses. Thanks, @dvaerum |
248 | | -- [#17](https://github.com/luolingchun/flask-openapi3/issues/17) Support for Nested APIBlueprint enhancement. Thanks, @dvaerum |
| 258 | +- [#28](https://github.com/luolingchun/flask-openapi3/pull/28) Fixed to enable `__root__` property when validation |
| 259 | + responses. Thanks, @dvaerum |
| 260 | +- [#17](https://github.com/luolingchun/flask-openapi3/issues/17) Support for Nested APIBlueprint enhancement. Thanks, |
| 261 | + @dvaerum |
249 | 262 | - [#29](https://github.com/luolingchun/flask-openapi3/pull/29) Support disable warnings. Thanks, @dvaerum |
250 | 263 | - Support for empty response body. Thanks, @dvaerum |
251 | 264 | - Support reload authorizations in Swagger UI |
|
276 | 289 | ## v1.1.0 2022-03-13 |
277 | 290 |
|
278 | 291 | - [#13](https://github.com/luolingchun/flask-openapi3/issues/13) drop support for flask 1.0.x. Thanks, @danmur |
279 | | -- [#15](https://github.com/luolingchun/flask-openapi3/pull/15) Fix to enable BaseModel with `__root__` property. Thanks, @tarcisiojr |
280 | | -- [#14](https://github.com/luolingchun/flask-openapi3/pull/14) Custom parameters: doc_prefix, api_doc_url, swagger_url, redoc_url, rapidoc_url. Thanks, @barryrobison |
| 292 | +- [#15](https://github.com/luolingchun/flask-openapi3/pull/15) Fix to enable BaseModel with `__root__` property. Thanks, |
| 293 | + @tarcisiojr |
| 294 | +- [#14](https://github.com/luolingchun/flask-openapi3/pull/14) Custom parameters: doc_prefix, api_doc_url, swagger_url, |
| 295 | + redoc_url, rapidoc_url. Thanks, @barryrobison |
281 | 296 | - Upgrade swagger UI v4.6.2 |
282 | 297 | - Upgrade Redoc v2.0.0-rc.63 |
283 | 298 | - Upgrade RapiDoc v9.2.0 |
|
290 | 305 |
|
291 | 306 | - [#10](https://github.com/luolingchun/flask-openapi3/issues/10) Fix: header's title case. Thanks, @rrr34 |
292 | 307 | - [#9](https://github.com/luolingchun/flask-openapi3/issues/9) Support for extra responses. Thanks, @blynn99 |
293 | | -- [#12](https://github.com/luolingchun/flask-openapi3/pull/12) Support for path operation field deprecated. Thanks, @blynn99 |
| 308 | +- [#12](https://github.com/luolingchun/flask-openapi3/pull/12) Support for path operation field deprecated. Thanks, |
| 309 | + @blynn99 |
294 | 310 | - Add keyword parameters `summary` and `description` |
295 | 311 | - Add servers for OpenAPI |
296 | 312 | - Upgrade swagger UI v4.1.3 |
|
331 | 347 |
|
332 | 348 | - OpenAPI add responses and APIBlueprint add abp_responses |
333 | 349 | - fix: validate response error when responses is empty dict |
334 | | -- [#3](https://github.com/luolingchun/flask-openapi3/issues/3) endpoint and APIBlueprint add `doc_ui`. Thanks, @DerManoMann |
| 350 | +- [#3](https://github.com/luolingchun/flask-openapi3/issues/3) endpoint and APIBlueprint add `doc_ui`. Thanks, |
| 351 | + @DerManoMann |
335 | 352 | - [#4](https://github.com/luolingchun/flask-openapi3/issues/4) fix: response description. Thanks, @DerManoMann |
336 | 353 | - [#5](https://github.com/luolingchun/flask-openapi3/issues/5) add custom parameter `oauth_config`. Thanks, @DerManoMann |
337 | 354 | - [#6](https://github.com/luolingchun/flask-openapi3/issues/6) support validation Flask Response. Thanks, @DerManoMann |
|
0 commit comments