unkeyed
`EXPIRED` and `DISABLED` error codes do not include example JSON responses in Unkey Docs
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
- Visit any of the error code documentation pages for
EXPIREDorDISABLED. - 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
EXPIREDandDISABLEDerror 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
Version info
- OS:
- Node:
- npm:
![linear[bot] avatar](https://avatars.githubusercontent.com/in/20150?v=4 "Published by a pub.dev verified publisher"){kind=small}
@2DELTA7 This ticket first needs to be approved by the repo owners. The /assign command will not work without oss.gg label, fyi.
Awarding unrenamed: 150 points đšī¸ Well done! Check out your new contribution on oss.gg/unrenamed
![oss-gg[bot] avatar](https://avatars.githubusercontent.com/in/835270?v=4 "Published by a pub.dev verified publisher"){kind=small}
Assigned to @HimanshuGaur14! Please open a draft PR linking this issue within 48h â ī¸ If we can't detect a PR from you linking this issue in 48h, you'll be unassigned automatically đšī¸ Excited to have you ship this đ
Let's add examples everywhere, rather than removing. I think it helps to understand what we return
My system is facing a problem while im updating the issue , i won't be able to complete it please unassign me. I'm sorry for the delay.
My system is facing a problem while im updating the issue , i won't be able to complete it please unassign me. I'm sorry for the delay.
you can unassign yourself too. Look at the top right corner or use /unassign command
Assigned to @joelwalice! Please open a draft PR linking this issue within 48h â ī¸ If we can't detect a PR from you linking this issue in 48h, you'll be unassigned automatically đšī¸ Excited to have you ship this đ
Assigned to @rajtejani! Please open a draft PR linking this issue within 48h â ī¸ If we can't detect a PR from you linking this issue in 48h, you'll be unassigned automatically đšī¸ Excited to have you ship this đ
After carefully reviewing the code it seems like the issue is not related with Docs but actually these ErrExpired and ErrDisabled response are not implemented. It can not be found on https://api.unkey.dev/openapi.json.
@rajtejani ah that might be yeah if you add them here, it will add them to the openapi spec once deployed https://github.com/unkeyed/unkey/blob/main/apps/api/src/pkg/errors/openapi_responses.ts
Running pnpm fmt before commiting code throw some errors of dashboard code which is not relevant to my changes. There are more then 20+ problems highlighted by linter. What should I do?
