Skip to content

fix(rest-api): Remove OS scope drop migration to ensure compatibility, fix type enum - #4214

Merged
pbreton merged 2 commits into
NVIDIA:mainfrom
pbreton:fix/do-no-drop-column-yet
Jul 29, 2026
Merged

fix(rest-api): Remove OS scope drop migration to ensure compatibility, fix type enum#4214
pbreton merged 2 commits into
NVIDIA:mainfrom
pbreton:fix/do-no-drop-column-yet

Conversation

@pbreton

@pbreton pbreton commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Ensure the obsolete column stays for now to ensure compatibility during components deployment.
Follow convention for enum name.

Type of Change

  • Fix - Bug fixes

Breaking Changes

  • This PR contains breaking changes

Testing

  • Manual testing performed

@pbreton
pbreton requested a review from a team as a code owner July 27, 2026 20:10
@coderabbitai

coderabbitai Bot commented Jul 27, 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 74161550-df04-4f53-bc75-6a8cba297ae4

📥 Commits

Reviewing files that changed from the base of the PR and between 49df42d and 3bf1438.

📒 Files selected for processing (5)
  • rest-api/db/pkg/db/model/operatingsystem.go
  • rest-api/db/pkg/migrations/20260717190000_drop_operating_system_ipxe_os_scope.go
  • rest-api/docs/index.html
  • rest-api/openapi/oasdiff-breaking-changes-ignore.txt
  • rest-api/openapi/spec.yaml
💤 Files with no reviewable changes (1)
  • rest-api/db/pkg/migrations/20260717190000_drop_operating_system_ipxe_os_scope.go
🚧 Files skipped from review as they are similar to previous changes (3)
  • rest-api/openapi/oasdiff-breaking-changes-ignore.txt
  • rest-api/openapi/spec.yaml
  • rest-api/db/pkg/db/model/operatingsystem.go

Summary by CodeRabbit

  • API Changes
    • Renamed the templated iPXE operating system type from Templated iPXE to TemplatedIpxe.
    • Updated operating system type values in the API specification and related API compatibility documentation.
  • Bug Fixes
    • Standardized templated iPXE type recognition across operating system APIs.

Walkthrough

The canonical templated iPXE identifier changes from Templated iPXE to TemplatedIpxe in the model and OpenAPI enums. The breaking-change ignore list is updated, and the migration removing ipxe_os_scope is deleted.

Changes

Operating system identifier alignment

Layer / File(s) Summary
Canonical identifier and API enum alignment
rest-api/db/pkg/db/model/operatingsystem.go, rest-api/openapi/spec.yaml, rest-api/openapi/oasdiff-breaking-changes-ignore.txt
The model constant and two OpenAPI enum entries use TemplatedIpxe; the breaking-change ignore list records removal of the previous enum value.
Operating-system scope migration removal
rest-api/db/pkg/migrations/20260717190000_drop_operating_system_ipxe_os_scope.go
The migration that dropped ipxe_os_scope and its structural rollback is deleted.

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

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: removing the OS scope drop migration and renaming the type enum.
Description check ✅ Passed The description matches the changeset by describing the compatibility fix and the enum naming update.
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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ast-grep (0.45.0)
rest-api/docs/index.html

ast-grep timed out on this file


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

@pbreton
pbreton marked this pull request as draft July 27, 2026 20:14
@copy-pr-bot

copy-pr-bot Bot commented Jul 27, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@pbreton pbreton self-assigned this Jul 27, 2026
@pbreton
pbreton marked this pull request as ready for review July 27, 2026 20:21
@github-actions

Copy link
Copy Markdown

🔐 TruffleHog Secret Scan

No secrets or credentials found!

Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉

🔗 View scan details

🕐 Last updated: 2026-07-27 20:21:17 UTC | Commit: ad99f03

@pbreton
pbreton force-pushed the fix/do-no-drop-column-yet branch 2 times, most recently from f6e04e1 to a4ce573 Compare July 27, 2026 22:37

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@rest-api/openapi/oasdiff-breaking-changes-ignore.txt`:
- Around line 13-14: Remove the entries for the deleted bmc-reset route and the
removed “Templated iPXE” query enum from oasdiff-breaking-changes-ignore.txt so
these compatibility breaks are reported. If the API changes are intentional,
mark the release as breaking and add the required versioning, migration
guidance, and deprecation documentation; otherwise retain or deprecate the
legacy behavior.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: bf7aa687-3ad6-4b34-8676-818fcd7ebcdb

📥 Commits

Reviewing files that changed from the base of the PR and between f6e04e1 and a4ce573.

⛔ Files ignored due to path filters (1)
  • rest-api/sdk/standard/api_site_explorer.go is excluded by !rest-api/sdk/standard/api_*.go
📒 Files selected for processing (5)
  • rest-api/db/pkg/db/model/operatingsystem.go
  • rest-api/db/pkg/migrations/20260717190000_drop_operating_system_ipxe_os_scope.go
  • rest-api/docs/index.html
  • rest-api/openapi/oasdiff-breaking-changes-ignore.txt
  • rest-api/openapi/spec.yaml
💤 Files with no reviewable changes (1)
  • rest-api/db/pkg/migrations/20260717190000_drop_operating_system_ipxe_os_scope.go
🚧 Files skipped from review as they are similar to previous changes (1)
  • rest-api/db/pkg/db/model/operatingsystem.go

Comment thread rest-api/openapi/oasdiff-breaking-changes-ignore.txt
@pbreton
pbreton force-pushed the fix/do-no-drop-column-yet branch 2 times, most recently from 49df42d to 8a1af04 Compare July 27, 2026 22:45
@thossain-nv thossain-nv changed the title fix(rest-api): do not drop column yet to ensure compatibility and minor enum fix fix(rest-api): Remove OS scope drop migration to ensure compatibility, fix type enum Jul 28, 2026

@thossain-nv thossain-nv left a comment

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.

Thank you @pbreton

pbreton added 2 commits July 28, 2026 16:04
…or enum fix

Signed-off-by: Patrice Breton <pbreton@nvidia.com>
Signed-off-by: Patrice Breton <pbreton@nvidia.com>
@pbreton
pbreton force-pushed the fix/do-no-drop-column-yet branch from 8a1af04 to 3bf1438 Compare July 28, 2026 23:07
@pbreton
pbreton enabled auto-merge (squash) July 28, 2026 23:07
@thossain-nv thossain-nv added the rest-api Add this label when an issue or PR concerns NICo REST API label Jul 29, 2026 — with ChatGPT Codex Connector
@pbreton
pbreton merged commit 2a6ff60 into NVIDIA:main Jul 29, 2026
121 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rest-api Add this label when an issue or PR concerns NICo REST API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants