This repository was archived by the owner on Mar 18, 2019. It is now read-only.
Support the API description from schema’s document #39
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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