Skip to content

Confusing Documentation for keys.getVerifications Method in @unkey/api SDK #2299

@unrenamed

Description

@unrenamed

Preliminary Checks

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

  1. Visit https://www.unkey.com/docs/libraries/ts/sdk/keys/verifications
  2. See the code blocks with Request and Success titles 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

image

Version info

- OS:
- Node:
- npm:

Metadata

Metadata

Labels

BugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions