Skip to content
This repository was archived by the owner on Mar 18, 2019. It is now read-only.

Add OpenAPI info.description field #35

Merged
merged 1 commit into from
Jun 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions openapi_codec/encode.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
9 changes: 7 additions & 2 deletions tests/test_encode.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down