bugfix format param: path params must be required=True

tfranzel · Jul 1, 2020 · 6b29d1b · 6b29d1b
1 parent b64e915
commit 6b29d1b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/drf_spectacular/plumbing.py b/drf_spectacular/plumbing.py
@@ -649,12 +649,11 @@ def resolve_regex_path_parameter(path_regex, variable):
             converter = 'drf_format_suffix'  # remove appended options
 
         if parameter == variable and converter in DJANGO_PATH_CONVERTER_MAPPING:
-            return {
-                'name': parameter,
-                'schema': build_basic_type(DJANGO_PATH_CONVERTER_MAPPING[converter]),
-                'in': OpenApiParameter.PATH,
-                'required': False if converter == 'drf_format_suffix' else True,
-            }
+            return build_parameter_type(
+                name=parameter,
+                schema=build_basic_type(DJANGO_PATH_CONVERTER_MAPPING[converter]),
+                location=OpenApiParameter.PATH,
+            )
 
     return None
 

diff --git a/tests/test_regressions.py b/tests/test_regressions.py
@@ -328,11 +328,11 @@ def pi(request, format=None):
 
     generator = SchemaGenerator(patterns=urlpatterns)
     schema = generator.get_schema(request=None, public=True)
-
+    validate_schema(schema)
     assert len(schema['paths']) == 2
     format_parameter = schema['paths']['/pi{format}']['get']['parameters'][0]
     assert format_parameter['name'] == 'format'
-    assert format_parameter['required'] is False
+    assert format_parameter['required'] is True
     assert format_parameter['in'] == 'path'
 
 
@@ -345,6 +345,7 @@ def pi(request, foo):
     urlpatterns = [re_path(r'^/pi/<int:precision>', pi)]
     generator = SchemaGenerator(patterns=urlpatterns)
     schema = generator.get_schema(request=None, public=True)
+    validate_schema(schema)
     parameter = schema['paths']['/pi/{precision}']['get']['parameters'][0]
     assert parameter['name'] == 'precision'
     assert parameter['in'] == 'path'
@@ -750,6 +751,7 @@ def get(self, request):
     ]
     generator = SchemaGenerator(patterns=urlpatterns)
     schema = generator.get_schema(request=None, public=True)
+    validate_schema(schema)
     assert len(schema['components']['schemas']) == 1
     assert 'X' in schema['components']['schemas']
     operation = schema['paths']['/api/x/']['get']