Rename workspace_name to name in cost_report.proto for consistency #584
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: ImMin5 <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Renames the workspace_name field to name in the cost report protobuf for naming consistency.
- Updated
CostReportQueryto usenameinstead ofworkspace_name. - Updated
CostReportInfoto usenameinstead ofworkspace_name.
Comments suppressed due to low confidence (1)
proto/spaceone/api/cost_analysis/v1/cost_report.proto:81
- [nitpick] The new field name ‘name’ is very generic and may cause ambiguity. Consider using a more descriptive identifier like ‘report_name’ or keeping ‘workspace_name’ if it specifically refers to the workspace.
string name = 6;
| string issue_date = 5; | ||
| // +optional | ||
| string workspace_name = 6; | ||
| string name = 6; |
There was a problem hiding this comment.
Renaming this field is a breaking change for existing clients. Consider marking the old workspace_name tag as deprecated = true and providing migration guidance or reserving the old field number.
Suggested change
| string name = 6; | |
| // Deprecated: Use an alternative field if applicable. | |
| string name = 6 [deprecated = true]; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Category
Description
Known issue