Comments

tomchristie · tomchristie · commit 6803b6af9689 · 2016-09-23T11:22:16.000+01:00
diff --git a/openapi_codec/__init__.py b/openapi_codec/__init__.py
@@ -15,7 +15,7 @@ class OpenAPICodec(BaseCodec):
     media_type = "application/openapi+json"
     supports = ['encoding', 'decoding']
 
-    def load(self, bytes, base_url=None):
+    def decode(self, bytes, **options):
         """
         Takes a bytestring and returns a document.
         """
@@ -24,12 +24,15 @@ def load(self, bytes, base_url=None):
         except ValueError as exc:
             raise ParseError('Malformed JSON. %s' % exc)
 
+        base_url = options.get('base_url')
         doc = _parse_document(data, base_url)
         if not isinstance(doc, Document):
             raise ParseError('Top level node must be a document.')
 
         return doc
 
-    def dump(self, document, **kwargs):
+    def encode(self, document, **options):
+        if not isinstance(document, coreapi.Document):
+            raise ValueError('Expected a `coreapi.Document` instance')
         data = generate_swagger_object(document)
         return force_bytes(json.dumps(data))
diff --git a/openapi_codec/encode.py b/openapi_codec/encode.py
@@ -80,6 +80,7 @@ def _get_parameters(link, encoding):
         location = get_location(link, field)
         if location == 'form':
             if encoding in ('multipart/form-data', 'application/x-www-form-urlencoded'):
+                # 'formData' in swagger MUST be one of these media types.
                 parameter = {
                     'name': field.name,
                     'required': field.required,
@@ -89,6 +90,8 @@ def _get_parameters(link, encoding):
                 }
                 parameters.append(parameter)
             else:
+                # Expand coreapi fields with location='form' into a single swagger
+                # parameter, with a schema containing multiple properties.
                 schema_property = {
                     'description': field.description
                 }
@@ -133,13 +136,6 @@ def _get_parameters(link, encoding):
     return parameters
 
 
-def _get_in(link, field):
-    in_location = get_location(link, field)
-    if in_location == 'form':
-        return 'formData'
-    return in_location
-
-
 def _get_responses(link):
     """
     Returns minimally acceptable responses object based
