[Canvas] Filter is not using the type
property correctly; fix in 8.0
#37422
Labels
bug
Fixes for quality problems that affect the customer experience
Feature:Canvas
impact:low
Addressing this issue will have a low level of impact on the quality/strength of our product.
loe:small
Small Level of Effort
release_note:breaking
Team:Presentation
Presentation Team for Dashboard, Input Controls, and Canvas
v8.0.0
In Canvas, all types used and returned by the Interpreter include a
type
property, a string, which indicates what the JSON shape represents, (e.g.Datatable
hastype: 'datatable'
, etc).As we were moving the Canvas Function Typescript to the Interpreter package (#36960), we noticed that
Filter
does not honor this contract. Instead,Filter
usestype
to indicate what type of filter it is, and is missing thetype
string.The fix for this would be to rename the existing
type
property to something likefilterType
, and addtype: 'filter'
to the shape, (and TS type). This would constitute a breaking change for Canvas plugin authors.We're tracking the need for this change in this issue, as something to ship in v8.0.
cc: @w33ble, @lukeelmers
The text was updated successfully, but these errors were encountered: