Skip to content

To Allow specify description in response definition when $ref is used #2084

@ratermir

Description

@ratermir

It would be very useful to be able to add (at least) description to the $ref in case (at least) response part of the API specification.
It would allow me to specify generic response that could be refined for every use case. Because there are a lot of cases of responses that have the same structure, only the difference is the information why / when the error occurred.
I know that it is not allowed by the specification, byt by my opinion (and according my experiences) it helps to simplify the API and make documentation more readable and useful.

One example is here:
image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions