Skip to content

Commit 45e4b5d

Browse files
committed
Add changelog and unpin dev requirements
Based on community feedback added back in a changelog. Done in markdown to make copying into GH release notes easy. ALso unpinned dev requirements, as pinning tox and black to much older versions for development will cause issues in the near future.
1 parent 3614028 commit 45e4b5d

File tree

2 files changed

+86
-2
lines changed

2 files changed

+86
-2
lines changed

CHANGELOG.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Flask-RestX Changelog
2+
Basic structure is
3+
4+
```
5+
## VERSION
6+
### Bug Fixes or Enchancements
7+
* Message (TICKET) [CONTRIBUTOR]
8+
```
9+
10+
## Opening a release
11+
If you're the first contributor, add a new semver release to the document. Place your addition in the correct category, giving a short description (matching something in a git commit), the issue ID (or PR ID if no issue opened), and your Github username for tracking contributors!
12+
13+
Releases prior to 0.3.0 were "best effort" filled out, but are missing some info. If you see your contribution missing info, please open a PR on the Changelog!
14+
15+
16+
## 0.3.0
17+
18+
### Bug Fixes
19+
20+
* Make error handlers order of registration respected when handling errors (#202) [avilaton]
21+
* add prefix to config setting (#114) [heeplr]
22+
* Doc fixes [openbrian, mikhailpashkov, rich0rd, Rich107, kashyapm94, SteadBytes, ziirish]
23+
* Use relative path for `api.specs_url` (#188) [jslay88]
24+
* Allow example=False (#203) [ogenstad]
25+
* Add support for recursive models (#110) [peterjwest, buggyspace, Drarok, edwardfung123]
26+
* generate choices schema without collectionFormat (#164) [leopold-p]
27+
* Catch TypeError in marshalling (#75) [robyoung]
28+
29+
30+
### Enhancements
31+
32+
* Update Python versions [johnthagen]
33+
* allow strict mode when validating model fields (#186) [maho]
34+
* Make it possible to include "unused" models in the generated swagger documentation (#90)[volfpeter]
35+
36+
37+
## 0.2.0
38+
39+
This release properly fixes the issue raised by the release of werkzeug 1.0.
40+
41+
### Bug Fixes
42+
43+
* Remove deprecated werkzeug imports (#35)
44+
* Fix OrderedDict imports (#54)
45+
* Fixing Swagger Issue when using @api.expect() on a request parser (#20)
46+
47+
### Enhancements
48+
49+
* use black to enforce a formatting codestyle (#60)
50+
* improve test workflows
51+
52+
## 0.1.1
53+
54+
This release is mostly a hotfix release to address incompatibility issue with the recent release of werkzeug 1.0.
55+
56+
### Bug Fixes
57+
58+
* pin werkzeug version (#39)
59+
* register wildcard fields in docs (#24)
60+
* update package.json version accordingly with the flask-restx version and update the author (#38)
61+
62+
### Enhancements
63+
64+
* use github actions instead of travis-ci (#18)
65+
66+
67+
## 0.1.0
68+
69+
### Bug Fixes
70+
71+
* Fix exceptions/error handling bugs https://github.com/noirbizarre/flask-restplus/pull/706/files noirbizarre/flask-restplus#741
72+
* Fix illegal characters in JSON references to model names noirbizarre/flask-restplus#653
73+
* Support envelope parameter in Swagger documentation noirbizarre/flask-restplus#673
74+
* Fix polymorph field ambiguity noirbizarre/flask-restplus#691
75+
* Fix wildcard support for fields.Nested and fields.List noirbizarre/flask-restplus#739
76+
77+
### Enhancements
78+
79+
* Api/Namespace individual loggers noirbizarre/flask-restplus#708
80+
* Various deprecated import changes noirbizarre/flask-restplus#732 noirbizarre/flask-restplus#738
81+
* Start the Flask-RESTX fork!
82+
* Rename all the things (#2 #9)
83+
* Set up releases from CI (#12)
84+
* Not a library enhancement but this was much needed - thanks @ziirish !

requirements/develop.pip

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
tox==3.13.2
2-
black==19.10b0; python_version >= '3.6'
1+
tox
2+
black; python_version >= '3.6'

0 commit comments

Comments
 (0)