Fix spec clone method and usage of raw vs resolved spec (#2089)

This PR fixes an issue introduced in #2002, and the original issue #2002
was trying to address.

The original issue was that a cloned spec did not have properly resolved
references. #2002 fixed this incorrectly by cloning the resolved spec,
while the `Spec` initializer expects a raw spec.

This PR fixes this by cloning the raw spec, and passing the `base_uri`
required to resolve it along to the initializer of the new `Spec`
instance.

The swagger ui was also updated to use the resolved spec instead of the
raw spec.

Supersedes:
#1889
#2080

Fixes:
#1890
#1909
#2028 
#2029

Author: RobbeSneyders

connexion/middleware/swagger_ui.py

@@ -70,7 +70,7 @@ def _spec_for_prefix(self, request) -> dict:
         This is needed when behind a path-altering reverse proxy.
         """
         base_path = self._base_path_for_prefix(request)
-        return self.specification.with_base_path(base_path).raw
+        return self.specification.with_base_path(base_path).spec
 
     def add_openapi_json(self):
         """

connexion/spec.py

@@ -81,6 +81,7 @@ def __init__(self, raw_spec, *, base_uri=""):
         self._set_defaults(raw_spec)
         self._validate_spec(raw_spec)
         self._spec = resolve_refs(raw_spec, base_uri=base_uri)
+        self._base_uri = base_uri
 
     @classmethod
     @abc.abstractmethod
@@ -107,6 +108,10 @@ def get_operation(self, path, method):
     def raw(self):
         return self._raw_spec
 
+    @property
+    def spec(self):
+        return self._spec
+
     @property
     def version(self):
         return self._get_spec_version(self._spec)
@@ -204,7 +209,7 @@ def enforce_string_keys(obj):
         return OpenAPISpecification(spec, base_uri=base_uri)
 
     def clone(self):
-        return type(self)(copy.deepcopy(self._spec))
+        return type(self)(copy.deepcopy(self._raw_spec), base_uri=self._base_uri)
 
     @classmethod
     def load(cls, spec, *, arguments=None):

tests/test_api.py

@@ -6,6 +6,7 @@
 import pytest
 from connexion import FlaskApi
 from connexion.exceptions import InvalidSpecification, ResolverError
+from connexion.jsonifier import Jsonifier
 from connexion.spec import Specification, canonical_base_path
 from yaml import YAMLError
 
@@ -198,9 +199,18 @@ def test_validation_error_on_completely_invalid_swagger_spec():
 
 
 def test_relative_refs(relative_refs, spec):
+    jsonifier = Jsonifier()
+
     spec_path = relative_refs / spec
     specification = Specification.load(spec_path)
-    assert "$ref" not in specification.raw
+
+    assert "$ref" in jsonifier.dumps(specification.raw)
+    assert "$ref" not in jsonifier.dumps(specification.spec)
+
+    cloned_specification = specification.clone()
+
+    assert "$ref" in jsonifier.dumps(cloned_specification.raw)
+    assert "$ref" not in jsonifier.dumps(cloned_specification.spec)
 
 
 @pytest.fixture