unkey icon indicating copy to clipboard operation
unkey copied to clipboard

`EXPIRED` and `DISABLED` error codes do not include example JSON responses in Unkey Docs

Open unrenamed opened this issue 4 months ago • 36 comments

Preliminary Checks

  • [X] I have reviewed the documentation: https://unkey.com/docs

  • [X] I have searched for existing issues: https://github.com/unkeyed/unkey/issues

  • [X] This issue is not a question, general help request, or anything other than a bug report directly related to Unkey. Please ask questions in our Discord community: https://unkey.com/discord.

Reproduction / Replay Link (Optional)

No response

Issue Summary

Currently, the Unkey documentation provides example JSON responses for various error codes, enhancing clarity for developers. However, the EXPIRED and DISABLED error codes are the only exceptions, as they do not include example JSON responses.

Was it done intentionally? If no, see the proposed solutions in the Expected behavior.

https://www.unkey.com/docs/api-reference/errors/code/EXPIRED https://www.unkey.com/docs/api-reference/errors/code/DISABLED

Steps to Reproduce

  1. Visit any of the error code documentation pages for EXPIRED or DISABLED.
  2. Compare the content on these pages with the corresponding pages for other error codes to identify the absence of JSON response examples.

Expected behavior

I propose one of the following solutions:

  • Include relevant example JSON responses for both the EXPIRED and DISABLED error codes for consistency.
  • Consider removing the existing JSON examples for other error codes if they are not essential.

Both approaches would contribute to a more uniform documentation structure.

Other information

No response

Screenshots

image image

Version info

- OS:
- Node:
- npm:

unrenamed avatar Oct 10 '24 12:10 unrenamed