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]>
python-restx · Mar 4, 2023 · ad23cdc · ad23cdc
1 parent e876292
commit ad23cdc
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -25,18 +25,19 @@ 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-1.0.7:
-1.0.7
+.. _section-1.1.0:
+1.1.0
 -----
 
-.. _bug_fixes-1.0.7
+.. _bug_fixes-1.1.0
 Bug Fixes
 ~~~~~~~~~
 
 ::
 
    * Update Swagger-UI to latest version to fix several security vulnerabiltiies. [peter-doggart]
    * Add a warning to the docs that nested Blueprints are not supported. [peter-doggart]
+   * Add a note to the docs that flask-restx always registers the root (/) path. [peter-doggart]
 
 .. _section-1.0.6:
 1.0.6

diff --git a/doc/quickstart.rst b/doc/quickstart.rst
@@ -110,6 +110,12 @@ You can also use the automatic documentation on you API root (by default).
 In this case: http://127.0.0.1:5000/.
 See :ref:`swaggerui` for a complete documentation on the automatic documentation.
 
+.. note ::
+    Initializing the :class:`~Api` object always registers the root endpoint ``/`` 
+    even if the :ref:`swaggerui` path is changed. If you wish to use the root 
+    endpoint ``/`` for other purposes, you must register it before initializing 
+    the :class:`~Api` object.
+
 
 Resourceful Routing
 -------------------

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "flask-restx",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "Fully featured framework for fast, easy and documented API development with Flask",
   "repository": "python-restx/flask-restx",
   "keywords": [