add Event schema #55
add Event schema #55
Conversation
james-rms
force-pushed
the
jrms/add-event-schema
branch
from
50935bc
to
aba23d5
Compare
This commit adds a schema that allows a robot to publish an Event. An Event is intended to annotate a range of time with some metadata, to facilitate searching the dataset. The content and field names for this message closely mirrors the Event API exposed by Foxglove Data Platform.
james-rms
force-pushed
the
jrms/add-event-schema
branch
from
aba23d5
to
c811b98
Compare
| const foxglove_EventKeyValue: FoxgloveMessageSchema = { | ||
| type: "message", | ||
| name: "EventKeyValue", | ||
| description: "a single key-value pair of metadata for an event", | ||
| fields: [ | ||
| { | ||
| name: "key", | ||
| type: { type: "primitive", name: "string" }, | ||
| description: "key for this metadata", | ||
| }, | ||
| { | ||
| name: "value", | ||
| type: { type: "primitive", name: "string" }, | ||
| description: "value of the metadata", | ||
| }, | ||
| ], | ||
| }; |
There was a problem hiding this comment.
Adding an identical KeyValuePair in #17. Want to remove Event from the name and "metadata" from the descriptions so we can reuse it in both places?
There was a problem hiding this comment.
Seems ok for now. The Event schema might evolve more over time (e.g. to support other structured data like nested arrays / structs) but we can cross that bridge when we get to it.
| const foxglove_Event: FoxgloveMessageSchema = { | ||
| type: "message", | ||
| name: "Event", | ||
| description: "a message used to annotate some event of interest in the data", |
There was a problem hiding this comment.
nit: I believe we are capitalizing sentences for descriptions on the other types/fields in this file
| timestamp: Time; | ||
|
|
||
| /** duration of event, starting at `timestamp` */ | ||
| duration: Duration; |
There was a problem hiding this comment.
Should duration be optional to indicate an instantaneous event? Or do we require specifying 0 length duration?
There was a problem hiding this comment.
optional imo (for schema formats that support optionals - 0 is also fine and means the same thing in other cases)
|
Closing this PR for now, will reopen once the plan for Event ingestion is more solidified. |
This commit adds a schema that allows a robot to publish an Event.
An Event is intended to annotate a range of time with some metadata,
to facilitate searching the dataset. The content and field names
for this message closely mirrors the Event API exposed by Foxglove
Data Platform.
Public-Facing Changes
Description
Fixes #31