python 3.x - drf-spectacular: add response description

Question

How can I add description to responses in the @extend_schema decorator?

'500':
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/Error'
      description: ''

question from:https://stackoverflow.com/questions/65933270/drf-spectacular-add-response-description

Answer 1

that specific description location you are referring to is not easily available through the decorators. however, there are multiple places a description can be put.

1. @extend_schema(description='Your description') this will add the description to the view action (operation). However, this is targeted to the operation itself and not the 500 Error case.

2. adding a docstring to your Error serializer. probably what you want to do.

this part is still a bit rough as the "Error" feature is still work in progress.