Merge pull request #116 from core-api/add-schemas

tomchristie · web-flow · commit 4d187b76e2ba · 2017-02-08T10:41:03.000Z
Add schemas, using `coreschema`
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,5 @@
 language: python
+cache: pip
 
 python:
   - "2.7"
diff --git a/coreapi/__init__.py b/coreapi/__init__.py
@@ -4,7 +4,7 @@
 from coreapi.document import Array, Document, Link, Object, Error, Field
 
 
-__version__ = '2.1.1'
+__version__ = '2.2.0'
 __all__ = [
     'Array', 'Document', 'Link', 'Object', 'Error', 'Field',
     'Client',
diff --git a/coreapi/codecs/corejson.py b/coreapi/codecs/corejson.py
@@ -156,10 +156,6 @@ def _document_to_primative(node, base_url=None):
             ret['required'] = node.required
         if node.location:
             ret['location'] = node.location
-        if node.type:
-            ret['type'] = node.type
-        if node.description:
-            ret['description'] = node.description
         return ret
 
     elif isinstance(node, Object):
@@ -217,9 +213,7 @@ def _primative_to_document(data, base_url=None):
                 name=_get_string(item, 'name'),
                 required=_get_bool(item, 'required'),
                 location=_get_string(item, 'location'),
-                type=_get_string(item, 'type'),
-                description=_get_string(item, 'description'),
-                example=item.get('example')
+                schema=item.get('schema', None)
             )
             for item in fields if isinstance(item, dict)
         ]
diff --git a/coreapi/codecs/python.py b/coreapi/codecs/python.py
@@ -59,8 +59,8 @@ def _to_repr(node):
             args += ', required=True'
         if node.location:
             args += ', location=%s' % repr(node.location)
-        if node.description:
-            args += ', description=%s' % repr(node.description)
+        if node.schema:
+            args += ', schema=%s' % repr(node.schema)
         return 'Field(%s)' % args
 
     return repr(node)
diff --git a/coreapi/document.py b/coreapi/document.py
@@ -26,18 +26,26 @@ def _str(node):
 def _key_sorting(item):
     """
     Document and Object sorting.
-    Regular attributes sorted alphabetically, then links sorted alphabetically.
+    Regular attributes sorted alphabetically.
+    Links are sorted based on their URL and action.
     """
     key, value = item
     if isinstance(value, Link):
-        return (1, key)
+        action_priority = {
+            'get': 0,
+            'post': 1,
+            'put': 2,
+            'patch': 3,
+            'delete': 4
+        }.get(value.action, 5)
+        return (1, (value.url, action_priority))
     return (0, key)
 
 
 # The field class, as used by Link objects:
 
-Field = namedtuple('Field', ['name', 'required', 'location', 'type', 'description', 'example'])
-Field.__new__.__defaults__ = (False, '', '', '', None)
+Field = namedtuple('Field', ['name', 'required', 'location', 'schema'])
+Field.__new__.__defaults__ = (False, '', None)
 
 
 # The Core API primatives:
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,5 @@
 # Package requirements
+coreschema
 itypes
 requests
 uritemplate
diff --git a/setup.py b/setup.py
@@ -63,6 +63,7 @@ def get_package_data(package):
     packages=get_packages('coreapi'),
     package_data=get_package_data('coreapi'),
     install_requires=[
+        'coreschema',
         'requests',
         'itypes',
         'uritemplate'

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`language: python`
	`2`	`+cache: pip`
`2`	`3`
`3`	`4`	`python:`
`4`	`5`	`- "2.7"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Package requirements`
	`2`	`+coreschema`
`2`	`3`	`itypes`
`3`	`4`	`requests`
`4`	`5`	`uritemplate`