From 49a36b6921ef00039192594182fd399038e2a475 Mon Sep 17 00:00:00 2001
From: Paul Tiplady <paul@qwil.co>
Date: Thu, 30 Mar 2017 13:38:44 -0700
Subject: [PATCH] Add OpenAPI info.description field

The CoreAPI document now contains a `description`, so add it
to the OpenAPI `info` dictionary.
---
 openapi_codec/encode.py | 1 +
 tests/test_encode.py    | 9 +++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/openapi_codec/encode.py b/openapi_codec/encode.py
index 4a6fbec..13b3ef4 100644
--- 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
index 0ffd883..429a9f0 100644
--- 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)