Skip to content

Add bucket object and leak event docs#237

Merged
jenip13 merged 1 commit into
mainfrom
aparent/add_leak_events_doc
Jul 21, 2026
Merged

Add bucket object and leak event docs#237
jenip13 merged 1 commit into
mainfrom
aparent/add_leak_events_doc

Conversation

@aaparent

@aaparent aaparent commented Jul 21, 2026

Copy link
Copy Markdown
Member

Add some documentation for bucket object and leak events as part of the MCP changes
Screenshot 2026-07-21 at 3 07 29 PM
Screenshot 2026-07-21 at 3 07 35 PM

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
flare 🟢 Ready View Preview Jul 21, 2026, 6:00 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
flare 🟡 Building Jul 21, 2026, 6:00 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@jenip13

jenip13 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Could you add screenshots in the MR description ?

Comment thread docs/event-types-v2/bucket-object.mdx Outdated

import BucketObjectExample from '/snippets/event_model_examples/bucket_object.mdx'

The `bucket_object` type represents individual files (objects) discovered within a publicly exposed cloud storage bucket, such as Amazon S3, Azure Blob, or Google Cloud Storage.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Azure Blob Storage

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Storage" is missing: it is present in https://api.docs.flare.io/event-types/bucket-object

Comment thread docs/event-types-v2/leak.mdx Outdated

Each record corresponds to a single leak and may include:
- The search term that matched the leak and the site it originated from.
- Timing details: when the leak occurred (`leaked_at`) and when the breach was disclosed (`breached_at`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: no need to mention the specific field i.e. leaked_at: we don't do that for the other events in https://api.docs.flare.io/event-types-v

Comment thread docs/event-types-v2/leak.mdx Outdated

import LeakExample from '/snippets/event_model_examples/leak.mdx'

The `leak` type represents a discrete data leak, such as a batch of credentials or PII published, sold, or shared on a leak site, forum, or marketplace.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe this could be simplified to such as a batch of credentials or PII published a leak site.

Add some documentation for bucket object and leak events as part of the MCP changes
@jenip13
jenip13 merged commit 2c98425 into main Jul 21, 2026
6 checks passed
@jenip13
jenip13 deleted the aparent/add_leak_events_doc branch July 21, 2026 19:13
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