non-blank string enforcement for parameters #282

tfranzel · Oct 15, 2021 · bdea0c2 · bdea0c2
1 parent 7222466
commit bdea0c2
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 1 deletion.
diff --git a/drf_spectacular/openapi.py b/drf_spectacular/openapi.py
@@ -167,19 +167,23 @@ def _process_override_parameters(self):
                         style=parameter.style,
                         explode=parameter.explode,
                         default=parameter.default,
+                        allow_blank=parameter.allow_blank,
                         examples=build_examples_list(parameter.examples),
                         extensions=parameter.extensions,
                     )
             elif is_basic_serializer(parameter):
                 # explode serializer into separate parameters. defaults to QUERY location
+                parameter = force_instance(parameter)
                 mapped = self._map_serializer(parameter, 'request')
                 for property_name, property_schema in mapped['properties'].items():
+                    field = parameter.fields.get(property_name)
                     result[property_name, OpenApiParameter.QUERY] = build_parameter_type(
                         name=property_name,
                         schema=property_schema,
                         description=property_schema.pop('description', None),
                         location=OpenApiParameter.QUERY,
-                        required=property_name in mapped.get('required', []),
+                        allow_blank=getattr(field, 'allow_blank', True),
+                        required=field.required,
                     )
             else:
                 warn(f'could not resolve parameter annotation {parameter}. Skipping.')
@@ -1272,6 +1276,7 @@ def _get_response_headers_for_code(self, status_code) -> dict:
                 style=parameter.style,
                 explode=parameter.explode,
                 default=parameter.default,
+                allow_blank=parameter.allow_blank,
                 examples=build_examples_list(parameter.examples),
                 extensions=parameter.extensions,
             )

diff --git a/drf_spectacular/plumbing.py b/drf_spectacular/plumbing.py
@@ -300,6 +300,7 @@ def build_parameter_type(
         explode=None,
         style=None,
         default=None,
+        allow_blank=True,
         examples=None,
         extensions=None,
 ):
@@ -325,6 +326,8 @@ def build_parameter_type(
         schema['schema']['enum'] = sorted(enum)
     if default is not None and 'default' not in irrelevant_field_meta:
         schema['schema']['default'] = default
+    if not allow_blank and schema['schema'].get('type') == 'string':
+        schema['schema']['minLength'] = schema['schema'].get('minLength', 1)
     if examples:
         schema['examples'] = examples
     if extensions:

diff --git a/drf_spectacular/utils.py b/drf_spectacular/utils.py
@@ -155,6 +155,7 @@ def __init__(
             style: Optional[str] = None,
             explode: Optional[bool] = None,
             default: Any = None,
+            allow_blank: bool = True,
             examples: Optional[List[OpenApiExample]] = None,
             extensions: Optional[Dict[str, Any]] = None,
             exclude: bool = False,
@@ -170,6 +171,7 @@ def __init__(
         self.style = style
         self.explode = explode
         self.default = default
+        self.allow_blank = allow_blank
         self.examples = examples or []
         self.extensions = extensions
         self.exclude = exclude

diff --git a/tests/test_extend_schema.py b/tests/test_extend_schema.py
@@ -53,6 +53,7 @@ class QuerySerializer(serializers.Serializer):
         choices=['a', 'b', 'c'],
         default=['a'],
     )
+    tag = serializers.CharField(required=False)
 
 
 class ErrorDetailSerializer(serializers.Serializer):

diff --git a/tests/test_extend_schema.yml b/tests/test_extend_schema.yml
@@ -279,6 +279,11 @@ paths:
           minimum: 1
         description: filter by rating stars
         required: true
+      - in: query
+        name: tag
+        schema:
+          type: string
+          minLength: 1
       tags:
       - doesitall
       security:
@@ -408,6 +413,8 @@ components:
             $ref: '#/components/schemas/OrderByEnum'
           default:
           - a
+        tag:
+          type: string
       required:
       - stars
   securitySchemes: