String filters

Filters that compare a field to a string value or array of strings.

StringComparisonFilter

A filter that applies a comparison to a string value.

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

Example

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

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: StringComparisonFilter.yaml
type: object
properties:
  operator:
    anyOf:
      - $ref: EquivalenceOperators.yaml
      - $ref: StringOperators.yaml
    description: The operator to apply to the filter value.
  value:
    type: string
    examples:
      - value
    description: The value to use for the filter operation.
required:
  - operator
  - value
description: A filter that applies a comparison to a string value.

TypeSpec

/** A filter that applies a comparison to a string value. */
@Versioning.added(Versions.v0_1)
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

Filters by comparing a field to an array of string values.

Property	Type	Required	Description
operator	ArrayOperators	Yes	The operator to apply to the filter value.
value	string[]	Yes	The value to use for the filter operation.

Example

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

JSON Schema

$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: Filters by comparing a field to an array of string values.

TypeSpec

/** Filters by comparing a field to an array of string values. */
@Versioning.added(Versions.v0_1)
model StringArrayFilter {
  /** The operator to apply to the filter value. */
  operator: ArrayOperators;

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