Skip to content

#254 part 1: Add changelog and unpin dev requirements #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 148 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
Flask-RestX Changelog
=====================

Basic structure is

::

ADD LINK (..) _section-VERSION
VERSION
-------
ADD LINK (..) _bug_fixes-VERSION OR _enhancments-VERSION
Bug Fixes or Enchancements
~~~~~~~~~~~~~~~~~~~~~~~~~~
* Message (TICKET) [CONTRIBUTOR]

Opening a release
-----------------

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!

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!

.. _section-0.3.0:

0.3.0
-----

.. _bug_fixes-0.3.0:

Bug Fixes
~~~~~~~~~

::

* Make error handlers order of registration respected when handling errors (#202) [avilaton]
* add prefix to config setting (#114) [heeplr]
* Doc fixes [openbrian, mikhailpashkov, rich0rd, Rich107, kashyapm94, SteadBytes, ziirish]
* Use relative path for `api.specs_url` (#188) [jslay88]
* Allow example=False (#203) [ogenstad]
* Add support for recursive models (#110) [peterjwest, buggyspace, Drarok, edwardfung123]
* generate choices schema without collectionFormat (#164) [leopold-p]
* Catch TypeError in marshalling (#75) [robyoung]
* Unable to access nested list propert (#91) [arajkumar]

.. _enhancements-0.3.0:

Enhancements
~~~~~~~~~~~~

::

* Update Python versions [johnthagen]
* allow strict mode when validating model fields (#186) [maho]
* Make it possible to include "unused" models in the generated swagger documentation (#90)[volfpeter]

.. _section-0.2.0:

0.2.0
-----

This release properly fixes the issue raised by the release of werkzeug
1.0.

.. _bug-fixes-0.2.0:

Bug Fixes
~~~~~~~~~

::

* Remove deprecated werkzeug imports (#35)
* Fix OrderedDict imports (#54)
* Fixing Swagger Issue when using @api.expect() on a request parser (#20)

.. _enhancements-0.2.0:

Enhancements
~~~~~~~~~~~~

::

* use black to enforce a formatting codestyle (#60)
* improve test workflows

.. _section-0.1.1:

0.1.1
-----

This release is mostly a hotfix release to address incompatibility issue
with the recent release of werkzeug 1.0.

.. _bug-fixes-0.1.1:

Bug Fixes
~~~~~~~~~

::

* pin werkzeug version (#39)
* register wildcard fields in docs (#24)
* update package.json version accordingly with the flask-restx version and update the author (#38)

.. _enhancements-0.1.1:

Enhancements
~~~~~~~~~~~~

::

* use github actions instead of travis-ci (#18)

.. _section-0.1.0:

0.1.0
-----

.. _bug-fixes-0.1.0:

Bug Fixes
~~~~~~~~~

::

* Fix exceptions/error handling bugs https://github.com/noirbizarre/flask-restplus/pull/706/files noirbizarre/flask-restplus#741
* Fix illegal characters in JSON references to model names noirbizarre/flask-restplus#653
* Support envelope parameter in Swagger documentation noirbizarre/flask-restplus#673
* Fix polymorph field ambiguity noirbizarre/flask-restplus#691
* Fix wildcard support for fields.Nested and fields.List noirbizarre/flask-restplus#739

.. _enhancements-0.1.0:

Enhancements
~~~~~~~~~~~~

::

* Api/Namespace individual loggers noirbizarre/flask-restplus#708
* Various deprecated import changes noirbizarre/flask-restplus#732 noirbizarre/flask-restplus#738
* Start the Flask-RESTX fork!
* Rename all the things (#2 #9)
* Set up releases from CI (#12)
* Not a library enhancement but this was much needed - thanks @ziirish !
4 changes: 2 additions & 2 deletions requirements/develop.pip
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
tox==3.13.2
black==19.10b0; python_version >= '3.6'
tox
black; python_version >= '3.6'