Merge pull request core-api#35 from paultiplady/add-description-field

tomchristie · web-flow · commit 1c1c68080c14 · 2017-06-16T11:33:11.000+01:00
Add OpenAPI info.description field
diff --git a/openapi_codec/encode.py b/openapi_codec/encode.py
@@ -15,6 +15,7 @@ def generate_swagger_object(document):
     swagger['swagger'] = '2.0'
     swagger['info'] = OrderedDict()
     swagger['info']['title'] = document.title
+    swagger['info']['description'] = document.description
     swagger['info']['version'] = ''  # Required by the spec
 
     if parsed_url.netloc:
diff --git a/tests/test_encode.py b/tests/test_encode.py
@@ -6,14 +6,19 @@
 
 class TestBasicInfo(TestCase):
     def setUp(self):
-        self.document = coreapi.Document(title='Example API', url='https://www.example.com/')
+        self.document = coreapi.Document(
+            title='Example API',
+            url='https://www.example.com/',
+            description='Example description.',
+        )
         self.swagger = generate_swagger_object(self.document)
 
     def test_info(self):
         self.assertIn('info', self.swagger)
         expected = {
             'title': self.document.title,
-            'version': ''
+            'version': '',
+            'description': self.document.description,
         }
         self.assertEquals(self.swagger['info'], expected)
 
