-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
APP-7615 Update list machine fragments to support versions #629
Conversation
proto/viam/app/v1/app.proto
Outdated
@@ -976,13 +977,19 @@ message ListRobotsRequest { | |||
string location_id = 1; | |||
} | |||
|
|||
message FragmentRequest { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
quibble: I like your AdditionalFragment
idea for the interface/field name symmetry
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean AdditionalFragment would be the name of this message? My thought here is that I don't like the word Request because it implies that its a message used at the top level of the API
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, good point. i'm going to rename this to AdditionalFragment
proto/viam/app/v1/app.proto
Outdated
message ListMachineFragmentsRequest { | ||
// the machine_id used to filter fragments defined in a machine's parts. | ||
// Also returns any fragments nested within the fragments defined in parts. | ||
string machine_id = 1; | ||
// additional fragment_ids to append to the response. useful when needing to view fragments that will be | ||
// provisionally added to the machine alongside existing fragments. | ||
repeated string additional_fragment_ids = 2; | ||
repeated FragmentRequest additional_fragments = 3; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreement: yup, I think adding the field is the right move. As discussed with ML, let's hold off on any sort of deprecated
or reserved
keyword for the old field - we can do the least to make sure the old field doesn't break until we can ensure its usage is removed from the app
8d41010
to
c9e4920
Compare
c9e4920
to
62288fe
Compare
@@ -1046,13 +1047,20 @@ message ListRobotsRequest { | |||
string location_id = 1; | |||
} | |||
|
|||
message AdditionalFragment { | |||
string fragment_id = 1; | |||
optional string version = 2; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i updated this to optional. does that seem right to everyone?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of naming questions, looks good to merge once those are addressed/discussed!
0c69cc4
to
c037a5f
Compare
tech spec
Open Qs
repeated string additional_fragment_ids = 2;
? or should we support both fields?