search

core-api / python-openapi-codec

An OpenAPI codec for Core API.
Other
33 stars 35 forks source link

Support the API description from schema’s document #39

Closed nickromano closed 7 years ago

nickromano commented 7 years ago

The swagger specification has a field called description that is used to display content at the top of a swagger page.

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object

The description field is available in the coreapi Document:

https://github.com/core-api/python-client/blob/master/coreapi/document.py#L80

Please let me know if you have any questions!

Thank you, Nick

nickromano commented 7 years ago

Looks like this is a duplicate of #35. Closing.