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 model.

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

JSON Schema

The JSON Schema for this model.

$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

The TypeSpec code for this model.

/** 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 model.

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

JSON Schema

The JSON Schema for this model.

$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

The TypeSpec code for this model.

/** Filters by comparing a field to an array of string values */
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>;
}