Merge pull request core-api#15 from core-api/include-descriptions

lovelydinosaur · web-flow · commit ee1051721cfb · 2016-10-05T15:54:28.000+01:00
Include description, summary. Ensure methods are ordered.
diff --git a/openapi_codec/__init__.py b/openapi_codec/__init__.py
@@ -8,7 +8,7 @@
 from openapi_codec.decode import _parse_document
 
 
-__version__ = '1.1.3'
+__version__ = '1.1.4'
 
 
 class OpenAPICodec(BaseCodec):
diff --git a/openapi_codec/encode.py b/openapi_codec/encode.py
@@ -66,7 +66,7 @@ def _get_paths_object(document):
 
     for operation_id, link, tags in links:
         if link.url not in paths:
-            paths[link.url] = {}
+            paths[link.url] = OrderedDict()
 
         method = get_method(link)
         operation = _get_operation(operation_id, link, tags)
@@ -77,13 +77,19 @@ def _get_paths_object(document):
 
 def _get_operation(operation_id, link, tags):
     encoding = get_encoding(link)
+    description = link.description.strip()
+    summary = description.splitlines()[0] if description else None
 
     operation = {
         'operationId': operation_id,
-        'description': link.description,
         'responses': _get_responses(link),
         'parameters': _get_parameters(link, encoding)
     }
+
+    if description:
+        operation['description'] = description
+    if summary:
+        operation['summary'] = summary
     if encoding:
         operation['consumes'] = [encoding]
     if tags:
diff --git a/tests/test_encode.py b/tests/test_encode.py
@@ -63,7 +63,6 @@ def test_paths(self):
                 }
             },
             'parameters': [],
-            'description': '',
             'operationId': 'list',
             'tags': ['users']
         }
@@ -75,7 +74,6 @@ def test_paths(self):
                 }
             },
             'parameters': [],
-            'description': '',
             'operationId': 'create',
             'tags': ['users']
         }

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@ def test_paths(self):`
`63`	`63`	`}`
`64`	`64`	`},`
`65`	`65`	`'parameters': [],`
`66`		`- 'description': '',`
`67`	`66`	`'operationId': 'list',`
`68`	`67`	`'tags': ['users']`
`69`	`68`	`}`
`@@ -75,7 +74,6 @@ def test_paths(self):`
`75`	`74`	`}`
`76`	`75`	`},`
`77`	`76`	`'parameters': [],`
`78`		`- 'description': '',`
`79`	`77`	`'operationId': 'create',`
`80`	`78`	`'tags': ['users']`
`81`	`79`	`}`