Remove unused fields from openapi (#316)

Author: mofr

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [26.0.1] - 2024-08-15
+- Remove unexpected openapi attributes from path and query parameters
+
 ## [26.0.0] - 2024-08-12
 - Do not ignore unexpected openapi attributes anymore
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "winter"
-version = "26.0.0"
+version = "26.0.1"
 homepage = "https://github.com/WinterFramework/winter"
 description = "Web Framework with focus on python typing, dataclasses and modular design"
 authors = ["Alexander Egorov <[email protected]>"]

tests/winter_openapi/test_query_and_path_parameter_spec.py

@@ -115,6 +115,47 @@ def simple_method(
     assert parameters == [expected_parameter]
 
 
+@pytest.mark.parametrize('type_hint, default_value, expected_parameter_properties', [
+    (int, 3, {'schema': {'format': 'int32', 'type': 'integer'}}),
+    (str, '12', {'schema': {'type': 'string'}}),
+    (IntegerEnum, IntegerEnum.RED, {'schema': {'enum': [1, 2], 'format': 'int32', 'type': 'integer'}}),
+    (IntegerValueEnum, IntegerValueEnum.RED, {'schema': {'enum': [1, 2], 'format': 'int32', 'type': 'integer'}}),
+    (StringValueEnum, StringValueEnum.RED, {'schema': {'enum': ['red', 'green'], 'type': 'string'}}),
+    (MixedValueEnum, MixedValueEnum.RED, {'schema': {'enum': [123, 'green'], 'type': 'string'}}),
+])
+def test_query_parameter_inspector_with_default_value(type_hint, default_value, expected_parameter_properties):
+    class _TestAPI:
+        @winter.route_get('/resource/{?query_param}')
+        @winter.map_query_parameter('mapped_query_param', to='invalid_query_param')
+        def simple_method(
+            self,
+            query_param: type_hint = default_value,
+        ):  # pragma: no cover
+            """
+            :param query_param: docstr
+            """
+            pass
+
+    expected_parameter = {
+        'name': 'query_param',
+        'in': 'query',
+        'required': False,
+        'allowEmptyValue': False,
+        'allowReserved': False,
+        'deprecated': False,
+        'explode': False,
+        'description': 'docstr',
+        **expected_parameter_properties,
+    }
+    route = get_route(_TestAPI.simple_method)
+    # Act
+    result = generate_openapi(title='title', version='1.0.0', description='Winter api description', routes=[route])
+
+    # Assert
+    parameters = result["paths"]["/resource/"]["get"]["parameters"]
+    assert parameters == [expected_parameter]
+
+
 @pytest.mark.parametrize('type_hint, expected_parameter_properties', param_with_diff_types)
 def test_path_parameter_different_types(type_hint, expected_parameter_properties):
     class _TestAPI:

winter/core/component_method_argument.py

@@ -31,13 +31,11 @@ class ComponentMethodArgument:
     def parameter(self) -> inspect.Parameter:
         return self.method.signature.parameters[self.name]
 
-    def get_default(self, default=inspect.Parameter.empty) -> Any:
+    def get_default(self) -> Any:
         if self.parameter.default is not inspect.Parameter.empty:
             return self.parameter.default
         if is_optional(self.type_):
             return None
-        if default is not inspect.Parameter.empty:
-            return default
         raise ArgumentDoesNotHaveDefault(self)
 
     @property

winter_openapi/inspectors/path_parameters_inspector.py

@@ -33,7 +33,6 @@ def _convert_argument_to_openapi_parameter(
             description=argument.description,
             required=argument.required,
             param_in='path',
-            default=argument.get_default(None),
             param_schema=schema,
         )
 

winter_openapi/inspectors/query_parameters_inspector.py

@@ -55,7 +55,6 @@ def _convert_argument_to_openapi_parameter(
             description=argument.description,
             required=argument.required,
             param_in='query',
-            default=argument.get_default(None),
             param_schema=schema,
             explode=query_parameter.explode,
         )