Parameter with required and allow empty value support

Author: p1c2u

openapi_core/exceptions.py

@@ -33,5 +33,9 @@ class InvalidValue(OpenAPIMappingError):
     pass
 
 
+class EmptyValue(OpenAPIMappingError):
+    pass
+
+
 class UndefinedSchemaProperty(OpenAPIMappingError):
     pass

openapi_core/parameters.py

@@ -1,5 +1,8 @@
 """OpenAPI core parameters module"""
 import logging
+import warnings
+
+from openapi_core.exceptions import EmptyValue
 
 log = logging.getLogger(__name__)
 
@@ -8,20 +11,32 @@ class Parameter(object):
     """Represents an OpenAPI operation Parameter."""
 
     def __init__(
-            self, name, location, schema=None, default=None,
-            required=False, deprecated=False, allow_empty_value=False,
+            self, name, location, schema=None, required=False,
+            deprecated=False, allow_empty_value=False,
             items=None, collection_format=None):
         self.name = name
         self.location = location
         self.schema = schema
-        self.default = default
-        self.required = required
+        self.required = True if self.location == "path" else required
         self.deprecated = deprecated
-        self.allow_empty_value = allow_empty_value
+        self.allow_empty_value = (
+            allow_empty_value if self.location == "query" else False
+        )
         self.items = items
         self.collection_format = collection_format
 
     def unmarshal(self, value):
+        if self.deprecated:
+            warnings.warn(
+                "{0} parameter is deprecated".format(self.name),
+                DeprecationWarning,
+            )
+
+        if (self.location == "query" and value == "" and
+                not self.allow_empty_value):
+            raise EmptyValue(
+                "Value of {0} parameter cannot be empty.".format(self.name))
+
         if not self.schema:
             return value
 
@@ -38,7 +53,7 @@ def generate(self, paramters):
         for parameter in paramters:
             parameter_deref = self.dereferencer.dereference(parameter)
 
-            default = parameter_deref.get('default')
+            allow_empty_value = parameter_deref.get('allowEmptyValue')
             required = parameter_deref.get('required', False)
 
             schema_spec = parameter_deref.get('schema', None)
@@ -50,6 +65,7 @@ def generate(self, paramters):
                 parameter_deref['name'],
                 Parameter(
                     parameter_deref['name'], parameter_deref['in'],
-                    schema=schema, default=default, required=required,
+                    schema=schema, required=required,
+                    allow_empty_value=allow_empty_value,
                 ),
             )

openapi_core/schemas.py

@@ -149,6 +149,7 @@ def create(self, schema_spec):
         schema_type = schema_deref['type']
         model = schema_deref.get('x-model', None)
         required = schema_deref.get('required', False)
+        default = schema_deref.get('default', None)
         properties_spec = schema_deref.get('properties', None)
         items_spec = schema_deref.get('items', None)
         nullable = schema_deref.get('nullable', False)
@@ -165,7 +166,7 @@ def create(self, schema_spec):
 
         return Schema(
             schema_type, model=model, properties=properties, items=items,
-            required=required, nullable=nullable, enum=enum,
+            required=required, default=default, nullable=nullable, enum=enum,
             deprecated=deprecated,
         )
 

openapi_core/wrappers.py

@@ -64,27 +64,30 @@ def create(self, request, spec):
         params = RequestParameters()
         for param_name, param in iteritems(operation.parameters):
             try:
-                value = self._unmarshal_param(request, param)
+                raw_value = self._get_raw_value(request, param)
             except MissingParameterError:
                 if param.required:
                     raise
-                continue
+
+                if not param.schema or not param.schema.default:
+                    continue
+                raw_value = param.schema.default
+
+            value = param.unmarshal(raw_value)
 
             params[param.location][param_name] = value
         return params
 
-    def _unmarshal_param(self, request, param):
+    def _get_raw_value(self, request, param):
         request_location = self.attr_mapping[param.location]
         request_attr = getattr(request, request_location)
 
         try:
-            raw_value = request_attr[param.name]
+            return request_attr[param.name]
         except KeyError:
             raise MissingParameterError(
                 "Missing required `{0}` parameter".format(param.name))
 
-        return param.unmarshal(raw_value)
-
 
 class RequestBodyFactory(BaseRequestFactory):
 

tests/integration/data/v3.0/petstore.yaml

@@ -20,6 +20,12 @@ paths:
       tags:
         - pets
       parameters:
+        - name: page
+          in: query
+          schema:
+            type: integer
+            format: int32
+            default: 1
         - name: limit
           in: query
           description: How many items to return at one time (max 100)

tests/integration/test_petstore.py

@@ -5,6 +5,7 @@
 from openapi_core.exceptions import (
     MissingParameterError, InvalidContentTypeError, InvalidServerError,
     InvalidValueType, UndefinedSchemaProperty, MissingPropertyError,
+    EmptyValue,
 )
 from openapi_core.media_types import MediaType
 from openapi_core.operations import Operation
@@ -135,6 +136,7 @@ def test_get_pets(self, spec):
         assert parameters == {
             'query': {
                 'limit': 20,
+                'page': 1,
                 'ids': [12, 13],
             }
         }
@@ -186,14 +188,10 @@ def test_get_pets_empty_value(self, spec):
             path_pattern=path_pattern, args=query_params,
         )
 
-        parameters = request.get_parameters(spec)
+        with pytest.raises(EmptyValue):
+            request.get_parameters(spec)
         body = request.get_body(spec)
 
-        assert parameters == {
-            'query': {
-                'limit': None,
-            }
-        }
         assert body is None
 
     def test_get_pets_none_value(self, spec):
@@ -213,6 +211,7 @@ def test_get_pets_none_value(self, spec):
         assert parameters == {
             'query': {
                 'limit': None,
+                'page': 1,
             }
         }
 

tests/unit/test_paramters.py

@@ -0,0 +1,39 @@
+import pytest
+
+from openapi_core.exceptions import EmptyValue
+from openapi_core.parameters import Parameter
+
+
+class TestParameterUnmarshal(object):
+
+    def test_deprecated(self):
+        param = Parameter('param', 'query', deprecated=True)
+        value = 'test'
+
+        with pytest.warns(DeprecationWarning):
+            result = param.unmarshal(value)
+
+        assert result == value
+
+    def test_query_valid(self):
+        param = Parameter('param', 'query')
+        value = 'test'
+
+        result = param.unmarshal(value)
+
+        assert result == value
+
+    def test_query_empty(self):
+        param = Parameter('param', 'query')
+        value = ''
+
+        with pytest.raises(EmptyValue):
+            param.unmarshal(value)
+
+    def test_query_allow_empty_value(self):
+        param = Parameter('param', 'query', allow_empty_value=True)
+        value = ''
+
+        result = param.unmarshal(value)
+
+        assert result == value