[AlyaEru]

Description

API spec update for BED-10188

Motivation and Context

Resolves BED-10188

How Has This Been Tested?

Before commenting out including the change, I ran just gen-spec and took a look at the API documentation to make sure it looked good

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
  • Documented the extension retention policy endpoint, including its required request header, extension identifier, successful response, and possible error responses.
  • Added a schema describing extension retention policies and their extension identifier.
  • Added commented-out references to retention policy paths; these are not active API routes.

[coderabbitai]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: SpecterOps/BloodHound
• Branch: main
• File: .coderabbit.yaml
• Commit: 3d0e564
• Layers: Repository YAML (base), Organization UI (inherited)
• Review profile: CHILL
• Plan: Advanced
• Run ID: 140b623c-e45a-496a-b2e3-3875f9a8937a

Commits

Reviewing files that changed from the base of the PR and between 3d0e564 and f65624b.

Files selected for processing: 3

• packages/go/openapi/src/openapi.yaml
• packages/go/openapi/src/paths/graph-retention-policies.extensions.id.policy.yaml
• packages/go/openapi/src/schemas/model.graph-extension-retention-policy.yaml

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

Walkthrough

The OpenAPI files add a retrieval operation and schema for extension retention policies. The main OpenAPI file includes a commented path reference, so it does not define an active endpoint.

Changes: Extension retention policy

Layer / File(s)	Summary
Define the extension policy contract packages/go/openapi/src/schemas/model.graph-extension-retention-policy.yaml, packages/go/openapi/src/paths/graph-retention-policies.extensions.id.policy.yaml, packages/go/openapi/src/openapi.yaml	The schema extends the graph retention policy schema with an extension_id integer. The operation documents its required Prefer header, path parameter, success response, and error responses. The main OpenAPI path reference remains commented out.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Suggested labels: documentation

Suggested reviewers: urangel

Merge Risk: Minimal · up to f6562

This specification-only change has no established application behavior impact and is mergeable after normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title names the change: an API spec for the get extension retention policy endpoint, tied to BED-10188. The changeset adds an OpenAPI operation, schema, and commented-out path entries for that end…
Description check		The description follows the template structure: Description, Motivation and Context with the ticket linked, How Has This Been Tested, Types of changes, and the checklist. It has three gaps. The Descri…
Docstring Coverage		No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Title check

Explanation

The title names the change: an API spec for the get extension retention policy endpoint, tied to BED-10188. The changeset adds an OpenAPI operation, schema, and commented-out path entries for that endpoint, so the title matches the main change. The 'docs:' prefix fits a spec-only update.

Full details: Description check

Explanation

The description follows the template structure: Description, Motivation and Context with the ticket linked, How Has This Been Tested, Types of changes, and the checklist. It has three gaps. The Description section gives only one line and does not describe the added schema, operation, or commented-out paths. The Motivation section does not explain why the spec is needed. The testing note says the author ran just gen-spec but does not describe the result, and it is unclear how a commented-out change was verified. The Motivation and Description sections are also thin. The Checklist marks documentation as up to date, which matches the change.

Resolution

Optional improvements: expand the Description to list the new schema (model.graph-extension-retention-policy.yaml), the new GetExtensionRetentionPolicy operation, and the two commented-out path entries. Add a sentence on why the spec is needed now. Describe the verification result of just gen-spec and say how the commented-out entries were checked. Also, the 'Resolves BED-10188' line links the Jira ticket, but the checklist still points to GitHub issue 672, so confirm which reference is correct.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

Finishing Touches

Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts