Component schema

AttributeFilterOperator

string2 direct references

Definition

The match operation for filtering attributes.

Equality Operators

is - equals (attribute exists and has a matching value)
is_not - not equals (attribute exists and has a different value)

Existence Operators

is_set - is set (attribute exists)
is_not_set - is not set (attribute does not exist)

Multiple Value Operators

is_one_of - is any of (attribute exists and has a value that is in the specified values)
is_not_one_of - is not any of (attribute exists and has a value that is not in the specified values)

Comparison Operators

gt - greater than
lt - less than
gte - greater than or equal
lte - less than or equal

Pattern Matching Operators

matches - match regex expression (attribute exists and matches the regular expression)
does_not_match - does not match regex expression (attribute exists and does not match the regular expression)

String Operators

contains - contains (attribute exists and contains the specified value)
does_not_contain - does not contain (attribute exists and does not contain the specified value)
starts_with - starts with (attribute exists and starts with the specified value)
does_not_start_with - does not start with (attribute exists and does not start with the specified value)
ends_with - ends with (attribute exists and ends with the specified value)
does_not_end_with - does not end with (attribute exists and does not end with the specified value)

Special Operators

is_any - matches any value, ignoring whether the key exists or not

string

Allowed values"is""is_not""is_set""is_not_set""is_one_of""is_not_one_of""gt""lt""gte""lte""matches""does_not_match""contains""does_not_contain""starts_with""does_not_start_with""ends_with""does_not_end_with""is_any"

Used by 2

These schemas and endpoints reference this type directly.

SchemaAttributeFilterSchemaMatcher

json

OpenAPI source12345678910111213141516171819202122232425
{
  "description": "The match operation for filtering attributes.\n\n#### Equality Operators\n- `is` - equals (attribute exists and has a matching value)\n- `is_not` - not equals (attribute exists and has a different value)\n\n#### Existence Operators\n- `is_set` - is set (attribute exists)\n- `is_not_set` - is not set (attribute does not exist)\n\n#### Multiple Value Operators\n- `is_one_of` - is any of (attribute exists and has a value that is in the specified values)\n- `is_not_one_of` - is not any of (attribute exists and has a value that is not in the specified values)\n\n#### Comparison Operators\n- `gt` - greater than\n- `lt` - less than\n- `gte` - greater than or equal\n- `lte` - less than or equal\n\n#### Pattern Matching Operators\n- `matches` - match regex expression (attribute exists and matches the regular expression)\n- `does_not_match` - does not match regex expression (attribute exists and does not match the regular expression)\n\n#### String Operators\n- `contains` - contains (attribute exists and contains the specified value)\n- `does_not_contain` - does not contain (attribute exists and does not contain the specified value)\n- `starts_with` - starts with (attribute exists and starts with the specified value)\n- `does_not_start_with` - does not start with (attribute exists and does not start with the specified value)\n- `ends_with` - ends with (attribute exists and ends with the specified value)\n- `does_not_end_with` - does not end with (attribute exists and does not end with the specified value)\n\n#### Special Operators\n- `is_any` - matches any value, ignoring whether the key exists or not\n",
  "type": "string",
  "enum": [
    "is",
    "is_not",
    "is_set",
    "is_not_set",
    "is_one_of",
    "is_not_one_of",
    "gt",
    "lt",
    "gte",
    "lte",
    "matches",
    "does_not_match",
    "contains",
    "does_not_contain",
    "starts_with",
    "does_not_start_with",
    "ends_with",
    "does_not_end_with",
    "is_any"
  ]
}