OpenArCloud / oscp-geopose-protocol

OSCP GeoPose Protocol
Other
12 stars 4 forks source link

id parametre in request lacks descriptive comment #19

Open janerivi opened 2 years ago

janerivi commented 2 years ago

the other fields are either explained elsewhere or directly in the field. I suggest givving a short explainer comment next to the id field in this section:

export interface GeoPoseReq {
  id: string;
  timestamp: number;  //  The number of milliseconds* since the Unix Epoch.
  type: string; //ex. geopose
  sensors: Sensor[];
  sensorReadings: SensorReading[];
  priorPoses?: GeoPoseResp[]; //previous geoposes
}