Skip to content

fix(docs): Updates for BED-8602 - #2967

Merged
slimi-so merged 14 commits into
mainfrom
BED-8602-archive-inactive-domain-findings
Aug 5, 2026
Merged

fix(docs): Updates for BED-8602#2967
slimi-so merged 14 commits into
mainfrom
BED-8602-archive-inactive-domain-findings

Conversation

@slimi-so

@slimi-so slimi-so commented Jul 7, 2026

Copy link
Copy Markdown
Contributor
  • Adds 'orphaned' status to attack-paths.attack-paths-findings.yaml doc Resolves BED-8602

Description

Describe your changes in detail

Motivation and Context

Small API documentation update for /attack-paths/findings endpoint to also get findings by orphaned status

Resolves

Why is this change required? What problem does it solve?
API documentation update for a bug fix in BHE where we add an archive finding status of 'orphaned' for findings associated with an inactive Domain.

How Has This Been Tested?

Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.

Screenshots (optional):

Types of changes

  • Chore (a change that does not modify the application functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Database Migrations

Checklist:

Summary by CodeRabbit

  • New Features
    • Attack path findings can now have an “orphaned” status.
  • Documentation
    • API documentation and response schemas have been updated to include the new “orphaned” status value.

slimi-so added 2 commits July 7, 2026 17:31
- Adds 'orphaned' status to attack-paths.attack-paths-findings.yaml doc
Resolves BED-8602
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The attack path findings OpenAPI response schema and generated OpenAPI document now allow orphaned as an additional status value.

Changes

Attack path findings status enum

Layer / File(s) Summary
Status enum extension
packages/go/openapi/src/paths/attack-paths.attack-paths-findings.yaml, packages/go/openapi/doc/openapi.json
The findings response schema and generated OpenAPI document add orphaned to the allowed status values.

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

Suggested labels: api

Suggested reviewers: cweidenkeller

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title references the ticket but is too vague to convey the actual change. Use a specific title like 'docs: add orphaned status to attack-paths findings OpenAPI' so the main change is clear at a glance.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description includes the required sections and issue reference, with the main change and motivation clearly stated.
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-8602-archive-inactive-domain-findings

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

@coderabbitai coderabbitai Bot added the api A pull request containing changes affecting the API code. label Jul 7, 2026
@slimi-so
slimi-so merged commit d919b43 into main Aug 5, 2026
13 checks passed
@slimi-so
slimi-so deleted the BED-8602-archive-inactive-domain-findings branch August 5, 2026 17:00
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 5, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api A pull request containing changes affecting the API code.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants