Skip to content

Config: remove version id from response body#822

Open
nishika26 wants to merge 1 commit into
mainfrom
enhancement/config_remove_vid
Open

Config: remove version id from response body#822
nishika26 wants to merge 1 commit into
mainfrom
enhancement/config_remove_vid

Conversation

@nishika26
Copy link
Copy Markdown
Collaborator

@nishika26 nishika26 commented May 11, 2026

Summary

Target issue is #624

Notes

  • Refactor
    • Modified the configuration version response structure by removing the unique identifier field , version ID, while retaining core metadata fields (config ID, version number, and timestamps). Version ID is not used anywhere by any endpoint and keeping it in response body along with config id and version number is just confusing.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 11, 2026

📝 Walkthrough

Walkthrough

The PR removes the explicit id: UUID field from the ConfigVersionPublic model in the config version definition, while retaining identifying and temporal fields like config_id, version, inserted_at, and updated_at.

Changes

ConfigVersion Model Update

Layer / File(s) Summary
Public Model Definition
backend/app/models/config/version.py
ConfigVersionPublic removes the explicit id field declaration; config_id, version, inserted_at, and updated_at fields remain.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A field bids farewell with grace,
id removes itself from place,
While config_id stands proud and true—
One less UUID in our view! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Config: remove version id from response body' directly and accurately describes the main change: removing the id field from the ConfigVersionPublic model's response.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch enhancement/config_remove_vid

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@nishika26 nishika26 self-assigned this May 11, 2026
@nishika26 nishika26 force-pushed the enhancement/config_remove_vid branch from c8fa154 to f870f61 Compare May 11, 2026 05:52
@nishika26 nishika26 added ready-for-review enhancement New feature or request labels May 11, 2026
@nishika26 nishika26 linked an issue May 11, 2026 that may be closed by this pull request
@codecov
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!



class ConfigVersionPublic(ConfigVersionBase):
id: UUID = Field(description="Unique id for the configuration version")
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just confirm, was this removed only because the config version did not require this API? Also, if it has been removed from here, then corresponding changes may also be required on the frontend side? otherwise, the frontend might crash.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request ready-for-review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Config: version ID not needed in create config response body

3 participants