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

EventAffordance: rename data and dataResponse to message and messageResponse #1403

Open
mlagally opened this issue Feb 22, 2022 · 5 comments
Labels
affordance uniformity Discussions on uniform pattern/state machines between Actions, Events, and Properties Defer to TD 2.0 EventAffordance Topics related to Event Affordances

Comments

@mlagally
Copy link
Contributor

The term "data" is very generic and non-descriptive.

Since the event subscription is providing messages and corresponding responses, the name should be changed.

@relu91
Copy link
Member

relu91 commented Feb 22, 2022

I'm ok with the change, but I wondering if "message" isn't too protocol-oriented. We could also evaluate event and eventResponse.

@relu91
Copy link
Member

relu91 commented Feb 22, 2022

Ops, I've almost forgotten. Sadly, changing data to message or event would break backward compatibility.

@mlagally
Copy link
Contributor Author

@relu91
event and eventResponse would also be way more descriptive, so +1.

Wrt. backwards compatibility: we could preserve "data" fand add the new vocabulary terms, stating that bata and event MUST have the same value.

@egekorkan
Copy link
Contributor

What is the rush? I would propose to wait for TD 2.0 for doing such a change with names (no matter what is chosen for the actual new word). If we have two words, TD 1.1 consumers need to be able to understand both of these words, which increases implementation effort for Consumers. It also means testing yet another thing and again last minute...
We have declined to introduce such double possibility mechanisms in TD1.1 like inline security definitions #945

Regarding the name, I also think that data is a bit ambiguous, everything is data in the end. Regarding message, I think that it is also a bit ambiguous since both directions are messages. Regarding naming it as event, I find it a bit weird due to an event affordance having an event. Do properties have property and actions have action? Some alternatives that come to mind without a strong preference for one: payload, emission, emit, eventData, eventPayload, output

@egekorkan
Copy link
Contributor

Call of 23.02:

  • The group wants to postpone this discussion to TD2.0
  • This is an issue that involves other affordances in some way. Maybe a bigger overhaul of all affordance DataSchemas
  • No matter the change, we should be aware of the implications of this change.

@egekorkan egekorkan added EventAffordance Topics related to Event Affordances affordance uniformity Discussions on uniform pattern/state machines between Actions, Events, and Properties labels Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affordance uniformity Discussions on uniform pattern/state machines between Actions, Events, and Properties Defer to TD 2.0 EventAffordance Topics related to Event Affordances
Projects
None yet
Development

No branches or pull requests

3 participants