Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add references to godoc #46

Merged
merged 4 commits into from
Feb 27, 2025
Merged

Add references to godoc #46

merged 4 commits into from
Feb 27, 2025

Conversation

wneessen
Copy link
Owner

No description provided.

Added inline references to HIBP API documentation for clarity and better maintainability. These links provide direct access to the relevant API details for each method, aiding future developers in understanding and utilizing the methods effectively.
Include links to relevant Have I Been Pwned API documentation for `CheckPassword` and `ListHashesPassword` methods. This improves clarity and provides context for API usage.
Updated the PastedAccount method comments to clarify that this API requires authentication with a valid API key. Included a reference link to the official documentation for better guidance.
Clarified that the Status API requires authentication with a valid API key. Included a reference link to the official documentation for further details.
@wneessen wneessen merged commit 1fed88e into main Feb 27, 2025
1 check was pending
@wneessen wneessen deleted the add-references-to-godoc branch February 27, 2025 12:14
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant