String filters

StringComparisonFilter

A filter that applies a comparison to a string value.

Table

Property	Type	Required	Description
operator	StringOperators	Yes	The operator to apply to the filter value
value	string	Yes	The value to use for the filter operation

Formats

Example

A JSON example of this field is:

{
  "operator": "eq",
  "value": "value"
}

Or with a string operator:

{
  "operator": "like",
  "value": "value"
}

JSON Schema

The JSON schema for this field is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: StringComparisonFilter.yaml
type: object
properties:
  operator:
    type: string
    description: The operator to apply to the filter value
    enum:
      - eq
      - ne
      - like
      - not_like
    value:
      type: string
      description: The value to use for the filter operation

TypeSpec

The TypeSpec code for this field is:

/** A filter that applies a comparison to a string value */
model StringComparisonFilter {
  /** The operator to apply to the filter value */
  operator: EquivalenceOperators | StringOperators;

  /** The value to use for the filter operation */
  @example("value")
  value: string;
}

StringArrayFilter

A filter that applies a comparison to an array of string values.

Table

Property	Type	Required	Description
operator	StringOperators	Yes	The operator to apply to the filter value
value	Array<string>	Yes	The value to use for the filter operation

Formats

Example

A JSON example of this field is:

{
  "operator": "eq",
  "value": ["value1", "value2"]
}

JSON Schema

The JSON schema for this field is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: StringArrayFilter.yaml
type: object
properties:
  operator:
    $ref: ArrayOperators.yaml
    description: The operator to apply to the filter value
  value:
    type: array
    items:
      type: string
    examples:
      - value1
      - value2
    description: The value to use for the filter operation
required:
  - operator
  - value
description: A filter that applies a filter to an array of strings

TypeSpec

The TypeSpec code for this field is:

/** A filter that applies a filter to an array of strings */
model StringArrayFilter {
  /** The operator to apply to the filter value */
  operator: ArrayOperators;

  /** The value to use for the filter operation */
  @example(["value1", "value2"])
  value: string[];
}