Skip to content
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

Merged
merged 4 commits into from
Feb 18, 2025

Conversation

ehhong
Copy link
Member

@ehhong ehhong commented Feb 11, 2025

tech spec

Open Qs

  • should we eventually deprecate repeated string additional_fragment_ids = 2;? or should we support both fields?
  • which struct name?
message AdditionalFragment {
  string fragment_id = 1;
  string version = 2;
}

// or

message FragmentRequest {
  string fragment_id = 1;
  string version = 2;
}

@github-actions github-actions bot added the safe to test committer is a member of this org label Feb 11, 2025
@@ -976,13 +977,19 @@ message ListRobotsRequest {
string location_id = 1;
}

message FragmentRequest {
Copy link
Member

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

Copy link
Member

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

Copy link
Member Author

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

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;
Copy link
Member

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

@ehhong ehhong force-pushed the APP-7615/ehhong/list-machine-fragments branch from 8d41010 to c9e4920 Compare February 12, 2025 23:06
@ehhong ehhong force-pushed the APP-7615/ehhong/list-machine-fragments branch from c9e4920 to 62288fe Compare February 12, 2025 23:07
@@ -1046,13 +1047,20 @@ message ListRobotsRequest {
string location_id = 1;
}

message AdditionalFragment {
string fragment_id = 1;
optional string version = 2;
Copy link
Member Author

@ehhong ehhong Feb 13, 2025

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?

Copy link
Member

@Abalaxy Abalaxy left a 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!

@ehhong ehhong force-pushed the APP-7615/ehhong/list-machine-fragments branch from 0c69cc4 to c037a5f Compare February 18, 2025 14:47
@ehhong ehhong added the ready-for-protos add this when you want protos to compile on every commit label Feb 18, 2025
@ehhong ehhong removed the ready-for-protos add this when you want protos to compile on every commit label Feb 18, 2025
@ehhong ehhong merged commit 9eb04f2 into main Feb 18, 2025
3 checks passed
@ehhong ehhong deleted the APP-7615/ehhong/list-machine-fragments branch February 18, 2025 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protos-compiled safe to test committer is a member of this org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants