chore(alerts): update OpenAPI docs for GET alert events endpoint BED-8994

[sirisjo]

Description

Adds clarification to the docs for the GET alert-events endpoint

Motivation and Context

Resolves BED-8994

Why is this change required? What problem does it solve?

How Has This Been Tested?

Nothing to test, just a documentation change

Screenshots (optional):

Types of changes

• Chore (a change that does not modify the application functionality)

Checklist:

• I have met the contributing prerequisites
  • Assigned myself to this PR
  • Added the appropriate labels
  • Associated an issue: Issues and Pull Requests README #672
  • Read the Contributing guide: https://github.com/SpecterOps/BloodHound/wiki/Contributing
• I have ensured that related documentation is up-to-date
  • Open API docs
  • Code comments (GoDocs / JSDocs)
• I have followed proper test practices
  • Added/updated tests to cover my changes
  • All new and existing tests passed

Summary by CodeRabbit

• Documentation
  • Clarified the type query parameter’s supported eq and neq operators.
  • Documented that eq requires a valid alert event type.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 2dde5c44-3227-4e3e-baa7-4c32a297a266

📥 Commits

Reviewing files that changed from the base of the PR and between a275104 and 42efd20.

📒 Files selected for processing (1)

• packages/go/openapi/src/paths/alerts.alert-events.yaml

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/go/openapi/src/paths/alerts.alert-events.yaml

---

📝 Walkthrough

Walkthrough

The OpenAPI specification documents supported type filter operators and the validation requirement for eq matches.

Changes

Alert event filter

Layer / File(s)	Summary
Document type filter behavior packages/go/openapi/src/paths/alerts.alert-events.yaml	The type query parameter description now documents eq and neq operators. It requires a valid alert event type for eq matches.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Mergeability Score: ⚪ Minimal · up to 42efd

This PR only clarifies the documented GET alert-events endpoint and does not change application behavior, so no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description explains the documentation change, motivation, testing status, change type, and checklist items.
Title check	✅ Passed	The title clearly identifies the OpenAPI documentation update for the alert events endpoint and includes the associated ticket.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch BED-8994

---

_{Comment @coderabbitai help to get the list of available commands.}