api icon indicating copy to clipboard operation
api copied to clipboard

Include failing examples

Open wezm opened this issue 5 years ago • 1 comments
trafficstars

The API documentation only provides happy path samples. It would be great if the "Error Response" section included samples of real error responses that might be encountered. This would make writing tests for API clients that wish to parse error responses much easier ­— since it's often not straightforward to generate and capture a real one by hand.

wezm avatar Jul 31 '20 07:07 wezm

Yeah good call, we should definitely add those in the section about error handling. I think adding them to each endpoint would be very verbose and they all follow the same pattern, so just expanding out that error section would be 👌

d11wtq avatar Jul 31 '20 09:07 d11wtq

Adding a sample error response to the docs, thanks!

markbrown4 avatar Mar 20 '24 03:03 markbrown4