nodos-dev / nodos

0 stars 0 forks source link

Request for partial pin updates in the API #2 #7

Open ugurtur opened 3 days ago

ugurtur commented 3 days ago

The current API method for updating a pin’s value/data is:

table EditorPinValueChanged {
  pin_path:string (required);
  value:[ubyte];
}

Suppose the client updates a Track input, specifically, Track → lens_distortion → center_shift → x. Since the client is using either a keyboard or a mouse to update the value of the x, the only change in the previous and new data is that specific x value. However, the current API for updating the pin data requires all the pin data (including every field), even though we are updating just a tiny portion.

REQUEST: We would like to send only the value of the x and the pin path (including the partial path for the subfield x)

table EditorPartialPinValueChanged {
  pin_path:string (required);
  field_path:string=null; # if omitted, process the update as if it is an EditorPinValueChanged
  value:[ubyte];
}

Example:

{
  pin_path: '/Add_Track.X',
  field_path: 'location.X',
  value: [0, 0, 0, 150]
}

Jira: R5-700