Skip to content

Update docs root route #527

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.

Sign up for GitHub

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
Mar 4, 2023
Merged

Update docs root route #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea8ef23
Add note to quick start about API root path.
Mar 4, 2023
142bdd9
Fix typo.
Mar 4, 2023
f83046e
Change version to 1.1.0
Mar 4, 2023
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
7 changes: 4 additions & 3 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions doc/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": [
Expand Down