mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-06 04:19:26 +00:00
Update v3 documentation for release (#1771)
This commit is contained in:
@@ -135,6 +135,7 @@ class ConnexionRequest(_RequestInterface):
|
|||||||
Implementation of the Connexion :code:`_RequestInterface` representing an ASGI request.
|
Implementation of the Connexion :code:`_RequestInterface` representing an ASGI request.
|
||||||
|
|
||||||
.. attribute:: _starlette_request
|
.. attribute:: _starlette_request
|
||||||
|
:noindex:
|
||||||
|
|
||||||
This class wraps a Starlette `Request <https://www.starlette.io/requests/#request>`_,
|
This class wraps a Starlette `Request <https://www.starlette.io/requests/#request>`_,
|
||||||
and provides access to its attributes by proxy.
|
and provides access to its attributes by proxy.
|
||||||
|
|||||||
@@ -3,12 +3,11 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
.. warning::
|
.. important::
|
||||||
|
|
||||||
This is the WIP documentation for Connexion 3.0 which is currently in alpha. You might want to
|
📢 **Connexion 3 was recently released!**
|
||||||
read the documentation for the latest `stable version`_ instead.
|
|
||||||
|
|
||||||
If you want to try out Connexion 3.0, refer to the :ref: `v3`_ section.
|
If you are upgrading from Connexion 2, refer to the :doc:`v3` section.
|
||||||
|
|
||||||
Welcome to Connexion's documentation!
|
Welcome to Connexion's documentation!
|
||||||
=====================================
|
=====================================
|
||||||
@@ -73,6 +72,7 @@ Documentation
|
|||||||
lifespan
|
lifespan
|
||||||
exceptions
|
exceptions
|
||||||
middleware
|
middleware
|
||||||
|
testing
|
||||||
cli
|
cli
|
||||||
v3
|
v3
|
||||||
|
|
||||||
|
|||||||
32
docs/v3.rst
32
docs/v3.rst
@@ -1,10 +1,3 @@
|
|||||||
.. warning::
|
|
||||||
|
|
||||||
Do not use Connexion 3.0 in production yet!
|
|
||||||
|
|
||||||
Connexion 3.0 is currently available in alpha to give users the ability to test it and provide
|
|
||||||
feedback while we further polish the codebase and update the documentation.
|
|
||||||
|
|
||||||
Getting started with Connexion 3.0
|
Getting started with Connexion 3.0
|
||||||
==================================
|
==================================
|
||||||
|
|
||||||
@@ -16,14 +9,19 @@ Connexion 3.0 brings some major changes compared to 2.X:
|
|||||||
* Validation is now pluggable by content type, solving longstanding issues regarding endpoints with
|
* Validation is now pluggable by content type, solving longstanding issues regarding endpoints with
|
||||||
multiple content types and providing a pluggable interface.
|
multiple content types and providing a pluggable interface.
|
||||||
|
|
||||||
Install alpha version
|
Install Connexion 3
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
Install the latest alpha version using
|
Install the latest version using
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
pip install --pre connexion
|
pip install connexion
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Connexion 3 will be released on 02/11/23. Until then, you can add the `--pre` flag to install
|
||||||
|
a pre-release version.
|
||||||
|
|
||||||
Using stand-alone Connexion
|
Using stand-alone Connexion
|
||||||
---------------------------
|
---------------------------
|
||||||
@@ -144,12 +142,12 @@ Non-breaking changes
|
|||||||
Feedback
|
Feedback
|
||||||
--------
|
--------
|
||||||
|
|
||||||
We would really love to hear from you. By trying Connexion 3 now and providing feedback, you get the opportunity to
|
We would really love to hear from you, so let us know if you have any feedback or questions. We'd
|
||||||
make sure that updating your application will be as painless as possible, while helping to create a more stable GA
|
like to make the migration for our users as easy and possible.
|
||||||
release.
|
|
||||||
|
|
||||||
* For questions, comments, and feedback, please comment on the `Connexion 3 alpha release announcement`_
|
* For questions, comments, and feedback, please comment on the `discussion`_ which will be
|
||||||
* For issues specific to the alpha version, please create a new issue and mark it with the Connexion 3 milestone
|
created and pinned after the release.
|
||||||
* For missing documentation, please comment on https://github.com/spec-first/connexion/issues/1531
|
* For issues, please open an issue on our `Github tracker`_
|
||||||
|
|
||||||
.. _Connexion 3 alpha release announcement: https://github.com/spec-first/connexion/discussions/1660
|
.. _discussion: https://github.com/spec-first/connexion/discussions
|
||||||
|
.. _Github tracker: https://github.com/spec-first/connexion/issues
|
||||||
@@ -365,8 +365,8 @@ checking.
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Keep in mind that the format checkers should be defined and registered before you run your
|
Keep in mind that the format checkers should be defined and registered before you run your
|
||||||
application server.
|
application server.
|
||||||
|
|
||||||
.. _enforce defaults: https://github.com/spec-first/connexion/tree/main/examples/enforcedefaults
|
.. _enforce defaults: https://github.com/spec-first/connexion/tree/main/examples/enforcedefaults
|
||||||
.. _jsonschema: https://github.com/python-jsonschema/jsonschema
|
.. _jsonschema: https://github.com/python-jsonschema/jsonschema
|
||||||
Reference in New Issue
Block a user