Possible to add description responses?

[ruuddeenen]

Is it possible to add a description to every response. For example 404 responses. Right now only 200 responses automatically get the resource model as descript, but I also want to add a description for other responses. Or default to the http code. This can be helpful for exporting the api documentation.

[romalytvynenko]

Hey @ruuddeenen

Can you show me an example of what you want to get?

[ruuddeenen]

Hi @romalytvynenko ,

Sorry for the late reply, I missed the notification.

This is roughly what gets generated as responses for an endpoint;

Which results in the following in (for example) Postman:

I would either like to have a default description for 422 (and other) response codes e.g. ValidationError with message OR have the ability to add a custom description to every request using PHPDoc or something.

[romalytvynenko]

@ruuddeenen sorry for the late reply.

Thanks for the screenshots, I see.

This is an interesting issue. Postman simply does not correctly use a description of referenced response. Notice how 422 response is a reference. If you check that reference you'll find that there is a description there. This is a description of response that Postman should've shown in the sidebar.

Did you find some workaround for this?

[ruuddeenen]

Thanks for the explanation! I did not find an workaround but I accepted it haha.