Endpoint errors configuration

This configuration enables errors to show up on the endpoint pages of your documentation. The error names, codes, and objects returned are configured in your API definition.

Configuration

1
navigation:
2
  - api: API Reference
3
    display-errors: true #<--- add this line

Example

By clicking on an error, you can see the error name, code, and object returned. The response also updates to show the error object.