-
Notifications
You must be signed in to change notification settings - Fork 9.2k
Closed
Labels
metadatatags, info, license, contact, markdown usage, etc.tags, info, license, contact, markdown usage, etc.
Milestone
Description
I sometimes need to write a lengthy explanation for a specific response (possibly with lists and other formatted text). AFAIK description is the only field for this, but a lengthy description here doesn't look too good in most documentation renderers I've tried (e.g. Swagger UI, ReDoc). In those tools, response.description seems to be intended to be kept short, almost as a "heading" for the response.
I've posted an example with a screenshot on Redocly/redoc#500.
It would be great to have a summary field on the response object, so that renderers can use this as a summary for the response, allowing description to be used for a lengthier explanation where needed.
RomanHotsiy and LasneF
Metadata
Metadata
Assignees
Labels
metadatatags, info, license, contact, markdown usage, etc.tags, info, license, contact, markdown usage, etc.