Schema enum

Author: p1c2u

openapi_core/enums.py

@@ -22,3 +22,27 @@ class ParameterStyle(Enum):
     SPACE_DELIMITED = 'spaceDelimited'
     PIPE_DELIMITED = 'pipeDelimited'
     DEEP_OBJECT = 'deepObject'
+
+
+class SchemaType(Enum):
+
+    INTEGER = 'integer'
+    NUMBER = 'number'
+    STRING = 'string'
+    BOOLEAN = 'boolean'
+    ARRAY = 'array'
+    OBJECT = 'object'
+
+
+class SchemaFormat(Enum):
+
+    NONE = None
+    INT32 = 'int32'
+    INT64 = 'int64'
+    FLOAT = 'float'
+    DOUBLE = 'double'
+    BYTE = 'byte'
+    BINARY = 'binary'
+    DATE = 'date'
+    DATETIME = 'date-time'
+    PASSWORD = 'password'

openapi_core/schemas.py

@@ -9,6 +9,7 @@
 from json import loads
 from six import iteritems
 
+from openapi_core.enums import SchemaType, SchemaFormat
 from openapi_core.exceptions import (
     InvalidValueType, UndefinedSchemaProperty, MissingProperty, InvalidValue,
 )
@@ -17,9 +18,9 @@
 log = logging.getLogger(__name__)
 
 DEFAULT_CAST_CALLABLE_GETTER = {
-    'integer': int,
-    'number': float,
-    'boolean': lambda x: bool(strtobool(x)),
+    SchemaType.INTEGER: int,
+    SchemaType.NUMBER: float,
+    SchemaType.BOOLEAN: lambda x: bool(strtobool(x)),
 }
 
 
@@ -28,13 +29,13 @@ class Schema(object):
 
     def __init__(
             self, schema_type, model=None, properties=None, items=None,
-            spec_format=None, required=None, default=None, nullable=False,
+            schema_format=None, required=None, default=None, nullable=False,
             enum=None, deprecated=False, all_of=None):
-        self.type = schema_type
+        self.type = SchemaType(schema_type)
         self.model = model
         self.properties = properties and dict(properties) or {}
         self.items = items
-        self.format = spec_format
+        self.format = SchemaFormat(schema_format)
         self.required = required or []
         self.default = default
         self.nullable = nullable
@@ -57,8 +58,8 @@ def get_all_properties(self):
     def get_cast_mapping(self):
         mapping = DEFAULT_CAST_CALLABLE_GETTER.copy()
         mapping.update({
-            'array': self._unmarshal_collection,
-            'object': self._unmarshal_object,
+            SchemaType.ARRAY: self._unmarshal_collection,
+            SchemaType.OBJECT: self._unmarshal_object,
         })
 
         return defaultdict(lambda: lambda x: x, mapping)
@@ -159,6 +160,7 @@ def create(self, schema_spec):
         schema_deref = self.dereferencer.dereference(schema_spec)
 
         schema_type = schema_deref['type']
+        schema_format = schema_deref.get('format')
         model = schema_deref.get('x-model', None)
         required = schema_deref.get('required', False)
         default = schema_deref.get('default', None)
@@ -183,8 +185,8 @@ def create(self, schema_spec):
 
         return Schema(
             schema_type, model=model, properties=properties, items=items,
-            required=required, default=default, nullable=nullable, enum=enum,
-            deprecated=deprecated, all_of=all_of,
+            schema_format=schema_format, required=required, default=default,
+            nullable=nullable, enum=enum, deprecated=deprecated, all_of=all_of,
         )
 
     @property

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

@@ -119,9 +119,9 @@ components:
     Tag:
       type: string
       enum:
-        - Cat
-        - Dog
-        - Bird
+        - cats
+        - dogs
+        - birds
     Position:
       type: integer
       enum:
@@ -148,7 +148,7 @@ components:
         name:
           type: string
         tag:
-          type: "#/components/schemas/Tag"
+          $ref: "#/components/schemas/Tag"
         address:
           $ref: "#/components/schemas/Address"
         position:

tests/integration/test_petstore.py

@@ -128,7 +128,10 @@ def test_spec(self, spec, spec_dict):
                             continue
 
                         assert type(parameter.schema) == Schema
-                        assert parameter.schema.type == schema_spec['type']
+                        assert parameter.schema.type.value ==\
+                            schema_spec['type']
+                        assert parameter.schema.format.value ==\
+                            schema_spec.get('format')
                         assert parameter.schema.required == schema_spec.get(
                             'required', [])
 
@@ -160,7 +163,10 @@ def test_spec(self, spec, spec_dict):
                         continue
 
                     assert type(media_type.schema) == Schema
-                    assert media_type.schema.type == schema_spec['type']
+                    assert media_type.schema.type.value ==\
+                        schema_spec['type']
+                    assert media_type.schema.format.value ==\
+                        schema_spec.get('format')
                     assert media_type.schema.required == schema_spec.get(
                         'required', False)
 
@@ -207,6 +213,43 @@ def test_get_pets(self, spec, response_validator):
         assert response_result.errors == []
         assert response_result.data == data_json
 
+    def test_get_pets_tag_param(self, spec, response_validator):
+        host_url = 'http://petstore.swagger.io/v1'
+        path_pattern = '/v1/pets'
+        query_params = {
+            'limit': '20',
+            'ids': ['12', '13'],
+        }
+
+        request = MockRequest(
+            host_url, 'GET', '/pets',
+            path_pattern=path_pattern, args=query_params,
+        )
+
+        parameters = request.get_parameters(spec)
+        body = request.get_body(spec)
+
+        assert parameters == {
+            'query': {
+                'limit': 20,
+                'page': 1,
+                'search': '',
+                'ids': [12, 13],
+            }
+        }
+        assert body is None
+
+        data_json = {
+            'data': [],
+        }
+        data = json.dumps(data_json)
+        response = MockResponse(data)
+
+        response_result = response_validator.validate(request, response)
+
+        assert response_result.errors == []
+        assert response_result.data == data_json
+
     def test_get_pets_wrong_parameter_type(self, spec):
         host_url = 'http://petstore.swagger.io/v1'
         path_pattern = '/v1/pets'