@@ -3869,20 +3869,23 @@ class CellValueFilter(Filter, EnumCoercionMixin):
38693869 A filter used to select rows based on cell values. For example, to handle a
38703870 user request like 'find all rows where the Project column is Alpha', you
38713871 would set 'columnName' to 'Project', 'operator' to 'EQUALS', and 'value' to
3872- [ 'Alpha'] .
3872+ 'Alpha'.
38733873
38743874 <https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/grid/query/CellValueFilter.html>
38753875
38763876 Attributes:
38773877 column_name: The name of the column to filter by.
38783878 operator: The comparison operator.
3879- value: Use operators like 'EQUALS' or 'LIKE' with the 'value' property
3880- for standard comparisons. The 'IS_NULL' operator can be used to
3881- find null values. The 'IS_UNDEFINED' operator can be used to find
3882- undefined values. When using IN or NOT_IN operators, value should
3883- be an array of values to compare against. When using either 'LIKE'
3884- or 'NOT_LIKE', the wildcard character '%' is used to represents
3885- zero or more characters, and '_' is used to represent a single
3879+ value: For 'EQUALS', 'NOT_EQUALS', the ordering operators, and
3880+ 'LIKE'/'NOT_LIKE', provide a scalar value to match a scalar cell
3881+ (e.g. 'Alpha'), or a JSON array to match a multi-value LIST cell
3882+ exactly (e.g. ['Alpha', 'Beta']). The 'IS_NULL' operator can be
3883+ used to find null values. The 'IS_UNDEFINED' operator can be used
3884+ to find undefined values. When using IN or NOT_IN operators,
3885+ value should be an array of candidate values, matching a row when
3886+ the cell equals any of them. When using either 'LIKE' or
3887+ 'NOT_LIKE', the wildcard character '%' is used to represent zero
3888+ or more characters, and '_' is used to represent a single
38863889 character.
38873890 """
38883891
@@ -3895,13 +3898,16 @@ class CellValueFilter(Filter, EnumCoercionMixin):
38953898 """The comparison operator."""
38963899
38973900 value : Optional [Any ] = None
3898- """Use operators like 'EQUALS' or 'LIKE' with the 'value' property for
3899- standard comparisons. The 'IS_NULL' operator can be used to find null
3901+ """For 'EQUALS', 'NOT_EQUALS', the ordering operators, and 'LIKE'/
3902+ 'NOT_LIKE', provide a scalar value to match a scalar cell (e.g. 'Alpha'),
3903+ or a JSON array to match a multi-value LIST cell exactly (e.g.
3904+ ['Alpha', 'Beta']). The 'IS_NULL' operator can be used to find null
39003905 values. The 'IS_UNDEFINED' operator can be used to find undefined values.
3901- When using IN or NOT_IN operators, value should be an array of values to
3902- compare against. When using either 'LIKE' or 'NOT_LIKE', the wildcard
3903- character '%' is used to represents zero or more characters, and '_' is
3904- used to represent a single character."""
3906+ When using IN or NOT_IN operators, value should be an array of candidate
3907+ values, matching a row when the cell equals any of them. When using
3908+ either 'LIKE' or 'NOT_LIKE', the wildcard character '%' is used to
3909+ represents zero or more characters, and '_' is used to represent a single
3910+ character."""
39053911
39063912 def to_synapse_request (self ) -> Dict [str , Any ]:
39073913 """
0 commit comments