Skip to content

docs: add HibpBreaches and HibpPasswords to usage.md and advanced_usa…#45

Merged
mlodic merged 1 commit intointelowlproject:mainfrom
R1sh0bh-1:add-hibp-analyzers-docs
Jan 26, 2026
Merged

docs: add HibpBreaches and HibpPasswords to usage.md and advanced_usa…#45
mlodic merged 1 commit intointelowlproject:mainfrom
R1sh0bh-1:add-hibp-analyzers-docs

Conversation

@R1sh0bh-1
Copy link
Copy Markdown
Contributor

Checklist

  • The pull request is for the branch main
  • If I added new documentation related to a new Pull Request that I created, I have added a reference to the related Pull Request
    • N/A (documentation is for current PR, no future version note needed)
  • If the additional documentation is a fix, you should directly push to the main branch and do not open this PR.
    → This is not a fix; it's new documentation for newly added analyzers, so opening a PR is correct.

Related code PR: intelowlproject/IntelOwl#3210

Changes made:

  • Added HibpBreaches and HibpPasswords entries to docs/IntelOwl/usage.md under Generic analyzers → External services, following the exact same format/style as the existing HaveIBeenPwned entry (including link to HIBP API docs).
  • Added a short configuration subsection for both analyzers in docs/IntelOwl/advanced_usage.md under Analyzers with special configuration (covering API key requirement, dummy test key, domain endpoint limitations, optional parameters for HibpBreaches, and k-anonymity note for HibpPasswords).

@mlodic as per your comment in #3210:

changes are good, please open a PR for the docs too, as requested in the PR template. Once both are up and fine, I'll merge them together

I have now opened this docs PR with both usage.md and advanced_usage.md updated.

Please review and let me know if any changes, wording adjustments, or additional details are needed happy to fix anything right away!

Thank you!

@mlodic
Copy link
Copy Markdown
Member

mlodic commented Jan 26, 2026

thank you!

@mlodic mlodic merged commit 92543a6 into intelowlproject:main Jan 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants