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

Unclear interface for InspectableEvent #907

Open
jethron opened this issue Sep 20, 2024 · 0 comments
Open

Unclear interface for InspectableEvent #907

jethron opened this issue Sep 20, 2024 · 0 comments
Labels
type:enhancement New features or improvements to existing features.

Comments

@jethron
Copy link

jethron commented Sep 20, 2024

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 of eventName or schema will be set depending on that category.
Since eventName is similar to the event_name field you see in data, it is reasonable to expect that InspectableEvent.eventName will be the schema's name for a self describing event; but instead the value is always nil 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 of event.eventName which is confusing, and then uses event.schema as a value for eventName 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 always nil.

@jethron jethron added the type:enhancement New features or improvements to existing features. label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement New features or improvements to existing features.
Projects
None yet
Development

No branches or pull requests

1 participant