Skip to content

Commit 31edc0b

Browse files
committed
Change CHANGELOG to .rst
Turns out there was a check for changelog compatibility with PyPi. The changelog also looks to get published to PyPi. As such, converted the .md to .rst using pandoc, then did a little cleaning up.
1 parent 45e4b5d commit 31edc0b

File tree

2 files changed

+147
-84
lines changed

2 files changed

+147
-84
lines changed

CHANGELOG.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

CHANGELOG.rst

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

0 commit comments

Comments
 (0)