Unclear interface for InspectableEvent
#907
Labels
type:enhancement
New features or improvements to existing features.
InspectableEvent
#907
Is your feature request related to a problem? Please describe.
The
InspectableEvent
protocol property descriptions are too vague.It is not clear that
InspectableEvent
can be either a "primitive" or "self-describing" event, and that only one ofeventName
orschema
will be set depending on that category.Since
eventName
is similar to theevent_name
field you see in data, it is reasonable to expect thatInspectableEvent.eventName
will be the schema'sname
for a self describing event; but instead the value is alwaysnil
which is confusing.Describe the solution you'd like
API documentation for
InspectableEvent
should be clearer on the possible states/values it can have, and when.Other documentation references (e.g. - also this section implies
event.name
instead ofevent.eventName
which is confusing, and then usesevent.schema
as a value foreventName
which is also confusing) should ideally include this information, too.Describe alternatives you've considered
Digging through SDK code when someone has asked why
event.eventName
is alwaysnil
.The text was updated successfully, but these errors were encountered: