networking: add constants for statuses#3329
Merged
pierreprinetti merged 1 commit intogophercloud:mainfrom May 16, 2025
Merged
Conversation
Contributor
Author
|
I'm leaning towards just providing the constants without changing the types, because that's going to be a pain for users as shown with the failing CI unit tests. |
Member
pierreprinetti
left a comment
There was a problem hiding this comment.
My opinion is that these constants can be of type string without additional typing. If designed from scratch they could be numeric Go enums, but as a retrofit I don't see a lot of value balancing the lack of backwards compatibility.
| PortStatusActive PortStatus = "ACTIVE" | ||
| PortStatusBuild PortStatus = "BUILD" | ||
| PortStatusDown PortStatus = "DOWN" | ||
| PortStatusError PortStatus = "ERROR" |
Member
There was a problem hiding this comment.
Given the package name "ports", the identifiers for these constants can be just "StatusActive" without fear of confusion.
This avoids the need to define these constants in consumer code. Router also has a status field, but there's no documentation for it, so let's not guess what the valid statuses are.
ced40b2 to
eda8452
Compare
stephenfin
approved these changes
May 16, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This avoids the need to define these constants in consumer code.
Router also has a status field, but there's no documentation for it, so
let's not guess what the valid statuses are.