Response Description

[eilst]

drf-spectacular/drf_spectacular/openapi.py

Line 1006 in f23de89

# Description is required by spec, but descriptions for each response code don't really

Can we still add a custom description for a Response?
I tried and it is displayed in the schema of the response and not in the main Response description.

[tfranzel]

the key question here is: how and where should it be added? it isn't clear to me.

we use description for operations, components and some other places. that specific description is on a status code level. i can see that this may be useful for error description, but that is supposed to be solved with a different feature in the future.

[eilst]

I found that is is possible to add an example (examples= [OpenApiExample...) with a description and linked it to a specific status_codes. So that was enough for me.

For a simple error description it can be helpful like you said to be able to do it.

[tfranzel]

sounds good! i'll close this because you found a way, and we may have a more structured approach once the error feature is implemented (#101)