diff --git a/openapi_codec/encode.py b/openapi_codec/encode.py index 4a6fbec..784f827 100644 --- a/openapi_codec/encode.py +++ b/openapi_codec/encode.py @@ -16,6 +16,7 @@ def generate_swagger_object(document): swagger['info'] = OrderedDict() swagger['info']['title'] = document.title swagger['info']['version'] = '' # Required by the spec + swagger['info']['description'] = document.description if parsed_url.netloc: swagger['host'] = parsed_url.netloc diff --git a/tests/test_encode.py b/tests/test_encode.py index 0ffd883..20dd182 100644 --- a/tests/test_encode.py +++ b/tests/test_encode.py @@ -13,7 +13,8 @@ def test_info(self): self.assertIn('info', self.swagger) expected = { 'title': self.document.title, - 'version': '' + 'version': '', + 'description': '' } self.assertEquals(self.swagger['info'], expected) @@ -33,6 +34,21 @@ def test_schemes(self): self.assertEquals(self.swagger['schemes'], expected) +class TestInfoDescription(TestCase): + def setUp(self): + self.document = coreapi.Document(title='Example API', url='https://www.example.com/', description='Welcome to API Docs') + self.swagger = generate_swagger_object(self.document) + + def test_info(self): + self.assertIn('info', self.swagger) + expected = { + 'title': self.document.title, + 'version': '', + 'description': self.document.description + } + self.assertEquals(self.swagger['info'], expected) + + class TestPaths(TestCase): def setUp(self): self.path = '/users/'