Mark deprecated fields with deprecated option in protobuf#269
Conversation
|
@Marenz 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
deprecated optiondeprecated option in protobuf
Marenz
left a comment
There was a problem hiding this comment.
Looks good but also update the RELEASE_NOTES.md file
|
@copilot please update the release notes file |
Updated the RELEASE_NOTES.md file to document the protobuf deprecation changes in commit 17bdc11. |
There was a problem hiding this comment.
Pull Request Overview
This PR properly marks deprecated protobuf elements with the official deprecated option to provide clear deprecation signals to API consumers and code generators.
- Added
option deprecated = true;to theCategorySetmessage - Added
[deprecated = true]to thecomponent_categoriesfield inTargetComponents - Updated release notes to document the deprecation changes
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/dispatch/v1/dispatch.proto | Added protobuf deprecation options to CategorySet message and component_categories field |
| RELEASE_NOTES.md | Documented the deprecation changes for API consumers |
… field Co-authored-by: Marenz <424752+Marenz@users.noreply.github.com>
6d73842 to
5782cf6
Compare
This PR adds the protobuf
deprecatedoption to properly mark deprecated fields and message types in the dispatch API schema.Changes Made
option deprecated = true;to mark the entire message type as deprecated[deprecated = true]to mark the field as deprecatedBefore
After
Benefits
The changes follow the official protobuf specification for marking deprecated elements and maintain full backward compatibility while providing clear deprecation signals to API consumers.
Fixes #252.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.