redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Add descriptions to individual response objects

Open Bitz opened this issue 3 years ago • 1 comments

Describe the problem to be solved I would like to be able to describe what the actual response object means.

Describe the solution you'd like For instance: image

In the space shown, I would like to be able to add a description, but currently, even though the content supports description, the text is not shown.

In the example shown above, the response body looks like:

'400':
  description: Bad Request (Validation failure)
  content:
    application/json:
      schema:
        $ref: ..\components\schemas\loi\Response400.yaml

And in Response400.yaml:

type: object
description: >-
  This is an example, real stuff has been removed.

I am not sure if this simply does not work as intended and is therefore a bug, or is something that I am requesting as a new feature.

Bitz avatar Sep 14 '21 21:09 Bitz

I think this is a bug (or at least a valuable feature request), since the yaml spec is valid, but the information is not rendered. In swagger-ui this works as expected.

EDIT: Seems to be related to https://github.com/Redocly/redoc/issues/1727#issuecomment-982011719

ideadapt avatar Jan 18 '22 10:01 ideadapt

https://github.com/Redocly/redoc/issues/1840

AlexVarchuk avatar Oct 12 '22 14:10 AlexVarchuk