Merge branch 'main' into patch-1

connexion/apps/abstract.py

@@ -75,7 +75,7 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
+        :param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
             configuration options for the swagger ui.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
@@ -162,7 +162,7 @@ def add_api(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
+        :param swagger_ui_options: A :class:`options.SwaggerUIOptions` instance with configuration
             options for the swagger ui.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has

connexion/apps/asynchronous.py

@@ -168,7 +168,7 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
+        :param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
             configuration options for the swagger ui.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has

connexion/apps/flask.py

@@ -202,11 +202,9 @@ def __init__(
             should either be absolute or relative to the root path of the application. Defaults to
             the root path.
         :param arguments: Arguments to substitute the specification using Jinja.
-        :param auth_all_paths: whether to authenticate not paths not defined in the specification.
+        :param auth_all_paths: whether to authenticate all paths not defined in the specification.
             Defaults to False.
         :param jsonifier: Custom jsonifier to overwrite json encoding for json responses.
-        :param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
-            options for the swagger ui.
         :param pythonic_params: When True, CamelCase parameters are converted to snake_case and an
             underscore is appended to any shadowed built-ins. Defaults to False.
         :param resolver: Callable that maps operationId to a function or instance of
@@ -216,7 +214,7 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
+        :param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
             configuration options for the swagger ui.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has

connexion/middleware/main.py

@@ -235,7 +235,7 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: Instance of :class:`options.ConnexionOptions` with
+        :param swagger_ui_options: Instance of :class:`options.SwaggerUIOptions` with
             configuration options for the swagger ui.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
@@ -391,7 +391,7 @@ def add_api(
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
         :param swagger_ui_options: A dict with configuration options for the swagger ui. See
-            :class:`options.ConnexionOptions`.
+            :class:`options.SwaggerUIOptions`.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
             an impact on performance. Defaults to False.

connexion/middleware/swagger_ui.py

@@ -63,7 +63,7 @@ def _base_path_for_prefix(self, request: StarletteRequest) -> str:
             "route_root_path", request.scope.get("root_path", "")
         ).rstrip("/")
 
-    def _spec_for_prefix(self, request):
+    def _spec_for_prefix(self, request) -> dict:
         """
         returns a spec with a modified basePath / servers block
         which corresponds to the incoming request path.

connexion/spec.py

@@ -204,7 +204,7 @@ def enforce_string_keys(obj):
         return OpenAPISpecification(spec, base_uri=base_uri)
 
     def clone(self):
-        return type(self)(copy.deepcopy(self._raw_spec))
+        return type(self)(copy.deepcopy(self._spec))
 
     @classmethod
     def load(cls, spec, *, arguments=None):

docs/v3.rst

@@ -94,11 +94,11 @@ Instead, you need to run the Connexion application using an ASGI server:
 
 .. code-block:: bash
 
-    $ uvicorn run:app
+    $ uvicorn hello:app
 
 .. code-block:: bash
 
-    $ gunicorn -k uvicorn.workers.UvicornWorker run:app
+    $ gunicorn -k uvicorn.workers.UvicornWorker hello:app
 
 .. warning::