diff --git a/connexion/lifecycle.py b/connexion/lifecycle.py index a388d79..b7be1ea 100644 --- a/connexion/lifecycle.py +++ b/connexion/lifecycle.py @@ -135,6 +135,7 @@ class ConnexionRequest(_RequestInterface): Implementation of the Connexion :code:`_RequestInterface` representing an ASGI request. .. attribute:: _starlette_request + :noindex: This class wraps a Starlette `Request `_, and provides access to its attributes by proxy. diff --git a/docs/index.rst b/docs/index.rst index 52f25b8..c67cfe7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,11 @@ You can adapt this file completely to your liking, but it should at least 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 - read the documentation for the latest `stable version`_ instead. + 📢 **Connexion 3 was recently released!** - 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! ===================================== @@ -73,6 +72,7 @@ Documentation lifespan exceptions middleware + testing cli v3 diff --git a/docs/v3.rst b/docs/v3.rst index 578c628..75c9e72 100644 --- a/docs/v3.rst +++ b/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 ================================== @@ -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 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 - 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 --------------------------- @@ -144,12 +142,12 @@ Non-breaking changes Feedback -------- -We would really love to hear from you. By trying Connexion 3 now and providing feedback, you get the opportunity to -make sure that updating your application will be as painless as possible, while helping to create a more stable GA -release. +We would really love to hear from you, so let us know if you have any feedback or questions. We'd +like to make the migration for our users as easy and possible. -* For questions, comments, and feedback, please comment on the `Connexion 3 alpha release announcement`_ -* For issues specific to the alpha version, please create a new issue and mark it with the Connexion 3 milestone -* For missing documentation, please comment on https://github.com/spec-first/connexion/issues/1531 +* For questions, comments, and feedback, please comment on the `discussion`_ which will be + created and pinned after the release. +* For issues, please open an issue on our `Github tracker`_ -.. _Connexion 3 alpha release announcement: https://github.com/spec-first/connexion/discussions/1660 \ No newline at end of file +.. _discussion: https://github.com/spec-first/connexion/discussions +.. _Github tracker: https://github.com/spec-first/connexion/issues \ No newline at end of file diff --git a/docs/validation.rst b/docs/validation.rst index 7ec3d22..096d42c 100644 --- a/docs/validation.rst +++ b/docs/validation.rst @@ -365,8 +365,8 @@ checking. .. note:: -Keep in mind that the format checkers should be defined and registered before you run your -application server. + Keep in mind that the format checkers should be defined and registered before you run your + application server. .. _enforce defaults: https://github.com/spec-first/connexion/tree/main/examples/enforcedefaults .. _jsonschema: https://github.com/python-jsonschema/jsonschema \ No newline at end of file