Skip to content

Commit ad23cdc

Browse files
peter-doggartPeter Doggart
and
Peter Doggart
authored
Update docs root route (#527)
* Add note to quick start about API root path. * Fix typo. * Change version to 1.1.0 --------- Co-authored-by: Peter Doggart <[email protected]>
1 parent e876292 commit ad23cdc

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

CHANGELOG.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,19 @@ Releases prior to 0.3.0 were “best effort” filled out, but are missing
2525
some info. If you see your contribution missing info, please open a PR
2626
on the Changelog!
2727

28-
.. _section-1.0.7:
29-
1.0.7
28+
.. _section-1.1.0:
29+
1.1.0
3030
-----
3131

32-
.. _bug_fixes-1.0.7
32+
.. _bug_fixes-1.1.0
3333
Bug Fixes
3434
~~~~~~~~~
3535

3636
::
3737

3838
* Update Swagger-UI to latest version to fix several security vulnerabiltiies. [peter-doggart]
3939
* Add a warning to the docs that nested Blueprints are not supported. [peter-doggart]
40+
* Add a note to the docs that flask-restx always registers the root (/) path. [peter-doggart]
4041

4142
.. _section-1.0.6:
4243
1.0.6

doc/quickstart.rst

+6
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ You can also use the automatic documentation on you API root (by default).
110110
In this case: http://127.0.0.1:5000/.
111111
See :ref:`swaggerui` for a complete documentation on the automatic documentation.
112112

113+
.. note ::
114+
Initializing the :class:`~Api` object always registers the root endpoint ``/``
115+
even if the :ref:`swaggerui` path is changed. If you wish to use the root
116+
endpoint ``/`` for other purposes, you must register it before initializing
117+
the :class:`~Api` object.
118+
113119
114120
Resourceful Routing
115121
-------------------

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "flask-restx",
3-
"version": "1.0.7",
3+
"version": "1.1.0",
44
"description": "Fully featured framework for fast, easy and documented API development with Flask",
55
"repository": "python-restx/flask-restx",
66
"keywords": [

0 commit comments

Comments
 (0)