-
Notifications
You must be signed in to change notification settings - Fork 607
Description
Preliminary Checks
-
I have reviewed the documentation: https://unkey.com/docs
-
I have searched for existing issues: https://github.com/unkeyed/unkey/issues
-
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
The documentation for the keys.getVerifications method in the @unkey/api SDK presents misleading and incorrect information by displaying examples related to the keys.get method instead.
Additionally, there is an inconsistency in how code snippets are presented across different methods in the documentation. While the "Request" code block for other methods includes clear examples of the code used, the corresponding "Success" code block typically shows the expected JSON result. However, for keys.getVerifications, the structure deviates from this format, further contributing to user confusion.
https://www.unkey.com/docs/libraries/ts/sdk/keys/verifications
Steps to Reproduce
- Visit https://www.unkey.com/docs/libraries/ts/sdk/keys/verifications
- See the code blocks with
RequestandSuccesstitles on the right side suggesting example usage of an SDK method
Expected behavior
Update the documentation for the keys.getVerifications method to accurately reflect its functionality, ensuring that both the "Request" and "Success" code blocks align with the established format used for other methods.
Other information
No response
Screenshots
Version info
- OS:
- Node:
- npm: