Skip to content

HYPERFLEET-895 - docs: move force-delete to versioned API path and add endpoint alternatives#132

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift-hyperfleet:mainfrom
pnguyen44:HYPERFLEET-895/update-force-delete
May 11, 2026
Merged

HYPERFLEET-895 - docs: move force-delete to versioned API path and add endpoint alternatives#132
openshift-merge-bot[bot] merged 1 commit into
openshift-hyperfleet:mainfrom
pnguyen44:HYPERFLEET-895/update-force-delete

Conversation

@pnguyen44
Copy link
Copy Markdown
Contributor

@pnguyen44 pnguyen44 commented May 6, 2026

Summary

  • Move force-delete endpoints from /admin/ to /api/hyperfleet/v1/ for consistency with existing API conventions
  • Add three rejected endpoint path alternatives to Alternatives Considered

Jira ticket

Test Plan

  • Unit tests added/updated
  • make test-all passes
  • make lint passes
  • Helm chart changes validated with make test-helm (if applicable)
  • Deployed to a development cluster and verified (if Helm/config changes)
  • E2E tests passed (if cross-component or major changes)

Summary by CodeRabbit

  • Documentation
    • Updated API contract documentation for force-deletion operations with versioned endpoint paths
    • Documented endpoint design alternatives and rationale

versioned API path and add endpoint alternatives
@openshift-ci openshift-ci Bot requested review from kuudori and ma-hill May 6, 2026 14:58
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 5b979f67-f394-47da-9cb7-203ca5055240

📥 Commits

Reviewing files that changed from the base of the PR and between 7afa0c9 and 5a4e3c0.

📒 Files selected for processing (1)
  • hyperfleet/docs/force-deletion-design.md

Walkthrough

The pull request updates the force-deletion design document to transition from admin-prefixed API endpoints to versioned endpoints under /api/hyperfleet/v1/. The API contract diagram and endpoint examples were revised to reflect versioned paths for both cluster and nodepool force-delete operations. Additionally, three alternative endpoint design approaches (separate /admin/ path, hybrid versioned/admin path, and action-prefixed endpoints) were documented with their respective rationale, all marked as rejected. The document metadata was updated with a new timestamp.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: moving force-delete endpoints to versioned API paths and documenting endpoint alternatives.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown
Contributor

@ciaranRoche ciaranRoche left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 11, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ciaranRoche

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot openshift-merge-bot Bot merged commit 300f1b3 into openshift-hyperfleet:main May 11, 2026
5 checks passed
@pnguyen44 pnguyen44 deleted the HYPERFLEET-895/update-force-delete branch May 11, 2026 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants