forked from flasgger/flasgger
-
Notifications
You must be signed in to change notification settings - Fork 0
/
HISTORY
225 lines (192 loc) · 9.26 KB
/
HISTORY
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
Changelog
=========
These are all the changes in Flasgger since the 0.6.0 release
0.9.7b2
-----
- chore: noqa for APISpecsView.get bare exception with json.dumps fallback (exception logging preserved)
- fix: flask >== 2.3 json encoder change
- chore: python 3.11 and flasklatest travis config
- removed usage of safe_str_cmp of werkzeug. using hmac.compare_digest instead (#532)
- Resolve #562 - Incompatibility with flask 2.3 (#564)
- Fix the wrong code block separation in README (#516)
- Fix openapi3 request parse validation (#505)
- Remove top level definitions, move #/definitions to #/components/schemas if configured to openapi3 (#504)
- Fix required body if one parameter is required (#476)
- change cian -> cyan (#502)
- Implemented the SwaggerUI urls config parameter which displays a dropdown of API specs instead of an editable textbox (#473)
- Fix indentation in readme example (#480)
- fix path parameter bug for integers (#485)
- Wrapping APISpecsView get response in a try except (#420)
- Merge branch 'master' into generate-schema-command
- Trivial flake issue resolved for docker build of flasgger (#452)
- Deprecate imp [Breaks py2.7 compatibility] (#413) Resolves #434
- Fix line too long error
- Remove python2
- Add command to generate the specs
- Fix error format and add regression tests
- Extract is_openapi3 in utils and test it
- Add flask_mongorest
- Set displayOperationId to true
- Pep8
- Fix chinese table of contents
- Fix for apispec 4
- Add chinese docs
- Fix definition docstring splitting
- Add use func validate from utils
- add test case for post request
- Change test for swag_schema
- Easy usage Marshmallow and flasgger
- PEP 8 compliance for oauth static html default
- Add Swagger UI auth config to ui.inioauth
- Make available oauth2 redirect html
NOTE: python2 is deprecated and no longer supported in flasgger
0.9.5
-----
- 'swag_from' supports 'pathlib.Path'
- Added support for OpenAPI3 parameter schema parsing [#390](https://github.com/flasgger/flasgger/pull/390)
- Enable optional OpenAPI3 fields [#366](https://github.com/flasgger/flasgger/issues/366)
- Fix access to local $ref definition #367
- Add support for custom validation_function and error_handler
- Accept pathlib.Path objects as path specification for swag_from
- Delay RuntimeError for not installing apispec marshmallow in Schema #384
- Ensure downward compatibility for werkzeug #391
- Support default configuration merging #383
- Update `swagger-ui` to `3.28.0` (improves safety)
0.9.4
-----
- Changed apispec version supported to 2.0.2
- Added support for OpenAPI3 callback field
- Changed jsonschema version supported to jsonschema>=3.0.1
- Changed json data to be parsed from request directly
- Changed swagger-ui 3 version to 3.23.1
- Added support for JWT_AUTH_HEADER_NAME
- Changed to yaml.safe_load
- Added support for docExpansion in swagger-ui 2
- Fixed bug for apispec_to_template definition [#301](https://github.com/flasgger/flasgger/commit/0ee67a755121000dad5b4405f2dd2bcb50c8ad51)
- Added support for using external yml file to specify parameter [commit by @isaacfi](https://github.com/flasgger/flasgger/commit/5ee9586febd931cbdce54527f40c53def4d747d1)
- Changed flask-restful abort call to abort(code, e.message)
- Added definitions to parsed_data validation [#330] (https://github.com/flasgger/flasgger/commit/8310196821ed61374581bb99d2be7739661b3afa)
- Added support for Marshmallow Schema in Function Based View [#341] (https://github.com/flasgger/flasgger/commit/fbaa7a12859823137c485f9f6fb5591325dc90da)
- Changed status code for no data to validate from 500 to 400
- Added require_data kwarg to validate() to make data optional [#340](https://github.com/flasgger/flasgger/commit/b8e6b4fc7390d4f8f7ddcd113d70a54acd54da1d)
- Added support for importing OpenAPI3 spec components from config
- Enable "import:" syntax in template.yml
- Forward validation_error_handler in Marshmallow APIspec [#352](https://github.com/flasgger/flasgger/commit/c5b36a7eee8958a77cbc4b3b4629416b5d9a987e)
0.9.2
-----
- Fixed packaging issue caused by the inclusion of examples [#242](https://github.com/rochacbruno/flasgger/issues/242)
- Enhancement allowing swagger-ui and static js to be loaded from external URLs [#245](https://github.com/rochacbruno/flasgger/pull/245)
- Added ui_params_text to allow raw text to be added to ui_params [#244](https://github.com/rochacbruno/flasgger/pull/244)
- Auto-disable Flasgger caching when running Flask in debug mode [#250](https://github.com/rochacbruno/flasgger/pull/250)
0.9.1
-----
- Updated support for apispec >=0.39.0 [#205](https://github.com/rochacbruno/flasgger/pull/205)
- Added install of etc/flasgger_package in requirements-dev.txt [#208](https://github.com/rochacbruno/flasgger/pull/208)
- repaired key error thrown when a path is given instead of in the func [#210](https://github.com/rochacbruno/flasgger/pull/210)
- fixed static file paths in demo app [#213](https://github.com/rochacbruno/flasgger/pull/213)
- removed pre-compile/cache *.pyc files from dist [#137](https://github.com/rochacbruno/flasgger/issues/137)
- auto-detect unicode charset-encoding in YAML files [#156](https://github.com/rochacbruno/flasgger/issues/156)
- bug fix, use getattr instead of dict get [#226](https://github.com/rochacbruno/flasgger/pull/226)
- added dev support for Docker (for demo app)
- added support for parsed MethodView (flask_restful) [#222](https://github.com/rochacbruno/flasgger/pull/222)
0.9.0
-----
- Updated Swagger UI 3.x
- uiversion now defaults to 3
- 'hide_top_bar' config option to remove the green top bar
- 'fotter_text' added to customize the footer text (allows html and <script>)
- templates/flasgger/footer.html added and can be replaced to customization
this footer.html is the right place for custom <script>
- 'top_text' added to customize the header text (allows html)
- templates/flasgger/top.html added and can be replaced to customization
- 'head_text' added to customize the <head> (allows html)
- templates/flasgger/head.html added and can be replaced to customization
- added 'doc_expansion' config to control the collapse
- added 'ui_params' to allow override of any swagger.ui values
- See examples/changelog_090.py
- schemes are now pulled from config when present [#201](https://github.com/rochacbruno/flasgger/pull/201)
- UI template refactoring/separation
0.8.3
-----
- Small update to release target (using twine)
0.8.2
-----
- Update index.html
- Update index.html
- Merge pull request #180 from anilpai/anilpai-patch-1
- Update jwt_auth.py
- Merge pull request #182 from anilpai/patch-1
- Avoid inclusion of empty definition dict
- Merge pull request #184 from mmichaels01/master
- Fix README.md error
- Merge pull request #186 from phylee/master
- Fix get_schema exception message
- Merge pull request #187 from boris-42/fix_get_schema_exc_message
- Fix erroneous extra definitions objects
- adding support for requestBody
- fixing python 2.7 incompliant syntax
- Merge pull request #191 from zrayn/add-requestBody-support
- Merge pull request #190 from abstiles/fix-extra-definitions
- Validate examples according to Swagger spec
- Correct example's declaration as OpenAPI 3.0
- Correct reference of invalid type int32
- Make example python filter more strict
- Fall back to simpler validation for OpenAPI 3
- Skip validation of intentionally invalid example
- Merge pull request #193 from abstiles/enhance-tests
0.8.1
-----
JWT - Flask_jwt support added
0.8.0
-----
- Reverted the automatic set of json_encoder and allowed user to import LAzyJSONEncoder (tks @SBillion)
0.7.0
-----
- Added support for LazyString https://github.com/rochacbruno/flasgger/issues/158
0.6.6
-----
- Support custom validation functions
- (TODO) Allow the caller to handle validation exceptions (solves #122)
- Swagger::get_schema method to get defined schemas as python dicts
- Updated static UI versions from latest github distribution
- Better test for `import` functionality
0.6.5
-----
- Suporting for decorating FlasggerViews (to protect with login etc)
- description and summary are now optional
- specs_route fix to be customized `/specs_route` to `/anything`
- enable/disable swagger UI (if you only need specs json)
- attempt to fix #102 allowing `import:` from subfolders
0.6.4
-----
- template_file argument added to Swagger class
0.6.3
-----
- HOTFIX: Support views using `decorator` package (#80)
0.6.2
-----
- introduced tests on Travis CI (examples apps as test cases)
- Fix blueprint support (examples/blueprint_example.py)
- Added `prefix_ids = True` for compat with <= 05.14 (see examples/compat.py)
- Added `import: another.yml` to inherit YAML files.
- Fix missing `lib` static folder
- Added support for Flask RESTful (examples/restful.py)
- Added APISpec support (examples/apispec.py)
- Fix error in case of empty MethodViews
0.6.1
-----
- HOTFIX: added six (missing requirement)
0.6.0
-----
- Fixed support for MethodViews
- Added swag.definition to class based definitions
- Added support for docs in dispatch_request (for FlaskRESTful compat)
- Upgrades Swagger UI
- Added `uiversion = 3` to support new experimental swagger UI
- Improved `validate` to abort with error so no need for try: validate...
- `validate` does not require `root` argument
- Definitions is no more prefixed with fucntion and http method names
- Dictionary can be used as specs in `@swag_from`
0.5.14
------
No history for older versions