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
unevaluatedProperties:
  not: {}
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 */
@Versioning.added(CommonGrants.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;
}

Python

The Python code for this model.

class StringComparisonFilter(CommonGrantsBaseModel):
    """Filter that applies a comparison to a string value."""

    operator: EquivalenceOperator | StringOperator = Field(
        ...,
        description="The operator to apply to the filter value",
    )
    value: str = Field(..., description="The string value to compare against")

    @field_validator("operator", mode="before")
    @classmethod
    def validate_operator(cls, v):
        """Convert string to enum if needed."""
        if isinstance(v, str):
            if v in [op.value for op in EquivalenceOperator]:
                return EquivalenceOperator(v)
            elif v in [op.value for op in StringOperator]:
                return StringOperator(v)
        return v

TypeScript

The TypeScript code for this model.

export const StringComparisonFilterSchema = z.object({
  operator: z.union([EquivalenceOperatorsEnum, StringOperatorsEnum]),
  value: z.string(),
});

Changelog

Version	Changes	Schema
0.1.0	Added StringComparisonFilter model	StringComparisonFilter.yaml

StringArrayFilter

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

Table

Property	Type	Required	Description
operator	ArrayOperators	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": "in",
  "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
unevaluatedProperties:
  not: {}
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 */
@Versioning.added(CommonGrants.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>;
}

Python

The Python code for this model.

class StringArrayFilter(CommonGrantsBaseModel):
    """Filter that matches against an array of string values."""

    operator: ArrayOperator = Field(
        ...,
        description="The operator to apply to the filter value",
    )
    value: list[str] = Field(..., description="The array of string values")

    @field_validator("operator", mode="before")
    @classmethod
    def validate_operator(cls, v):
        """Convert string to enum if needed."""
        if isinstance(v, str):
            return ArrayOperator(v)
        return v

TypeScript

The TypeScript code for this model.

export const StringArrayFilterSchema = z.object({
  operator: ArrayOperatorsEnum,
  value: z.array(z.string()),
});

Changelog

Version	Changes	Schema
0.1.0	Added StringArrayFilter model	StringArrayFilter.yaml