Pass the whole Dispatch
object when reporting dispatch updates
#55
Labels
scope:breaking-change
Breaking change, users will need to update their code
type:enhancement
New feature or enhancement visitble to users
We are now using a
DispatchUpdate
object that only has theselector
(named ascomponents
),dry_run
andpayload
(maybe namedinputs
oroptions
).It might be better to send an actual
Dispatch
object, in case the user needs to access more information about the particular dispatch that triggered the update.We still need to account for potential "merges", like for now dispatches with the same
type
as merged is if they were one big virtual dispatch. For example, if we are merging all dispatches with different IDs but the same type, and we haveid=1 start=10:00 end=11:00
andid=2 start=11:00 end=None
, that would be merged into a dispatch withstart=10:00 and end=None
).Related to:
If we do no merging by default, then we can just return the
Dispatch
object and other merge functions can have their own update types that make sense for that particular merge. For example, if we are merging byselector
as well astype
, we might not want to have theselector
in theDispatchUpdate
as it is redundant.Originally posted by @llucax in #54 (comment)
The text was updated successfully, but these errors were encountered: