Skip to content

Commit

Permalink
Fix middleware doc example (#1796)
Browse files Browse the repository at this point in the history
I'm starting to use the project with the newly release 3 version.


https://github.com/spec-first/connexion/blob/70084bcc4c21713cbf861841ebda977263d3ab8c/docs/middleware.rst?plain=1#L115-L120

It seems this example is not correct. 

1. missing import for SecurityMiddleware
2. `ConnexionMiddleware.default_middlewares` is a list of classes, not
class instances: the filtering never happen.
  • Loading branch information
ajoga committed Nov 8, 2023
1 parent 70084bc commit 095ae89
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/middleware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,10 @@ Security through an API Gateway in front of your application, you can do:
.. code-block:: python
from connexion import AsyncApp, ConnexionMiddleware
from connexion.middleware.security import SecurityMiddleware
middlewares = [middleware for middleware in ConnexionMiddleware.default_middlewares
if not isinstance(middleware, SecurityMiddleware)]
if middleware is not SecurityMiddleware]
app = AsyncApp(__name__, middlewares=middlewares)
Expand All @@ -132,9 +133,10 @@ Security through an API Gateway in front of your application, you can do:
.. code-block:: python
from connexion import FlaskApp, ConnexionMiddleware
from connexion.middleware.security import SecurityMiddleware
middlewares = [middleware for middleware in ConnexionMiddleware.default_middlewares
if not isinstance(middleware, SecurityMiddleware)]
if middleware is not SecurityMiddleware]
app = FlaskApp(__name__, middlewares=middlewares)
Expand All @@ -153,9 +155,10 @@ Security through an API Gateway in front of your application, you can do:
from asgi_framework import App
from connexion import ConnexionMiddleware
from connexion.middleware.security import SecurityMiddleware
middlewares = [middleware for middleware in ConnexionMiddleware.default_middlewares
if not isinstance(middleware, SecurityMiddleware)]
if middleware is not SecurityMiddleware]
app = App(__name__)
app = ConnexionMiddleware(app, middlewares=middlewares)
Expand Down

0 comments on commit 095ae89

Please sign in to comment.