Filtered

Filtered

A 200 response with a paginated list of filtered items.

Table

Parameter	Type	Description
status	integer	The HTTP status code
message	string	The message to return
items	Array	Items from the current page
paginationInfo	PaginatedResultsInfo	Details about the pagination
sortInfo	SortedResultsInfo	The sort order of the items
filterInfo	object	The filters applied to the response items

Formats

Example

A JSON example of this model.

{
  "status": 200,
  "message": "Success",
  "items": [
    {
      "id": "123",
      "name": "Test 1"
    },
    {
      "id": "124",
      "name": "Test 2"
    }
  ],
  "paginationInfo": {
    "page": 1,
    "pageSize": 10,
    "totalItems": 25,
    "totalPages": 3
  },
  "sortInfo": {
    "field": "name",
    "direction": "asc"
  },
  "filterInfo": {
    "filters": {
      "lastModifiedAt": {
        "operator": "gte",
        "value": "2024-01-01T00:00:00Z"
      },
      "status": {
        "operator": "in",
        "value": [
          "active",
          "inactive"
        ]
      }
    }
  }
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: Filtered.yaml
type: object
properties:
  items:
    type: array
    description: Items from the current page
  paginationInfo:
    $ref: PaginatedResultsInfo.yaml
  sortInfo:
    $ref: SortedResultsInfo.yaml
  filterInfo:
    type: object
    description: The filters applied to the response items
    properties:
      filters:
        type: object
        description: The filters applied to the response items
      errors:
        type: array
        items:
          type: string
        description: Non-fatal errors that occurred during filtering
allOf:
  - $ref: Success.yaml
required:
  - items
  - paginationInfo
  - sortInfo
  - filterInfo

TypeSpec

The TypeSpec code for this model.

@doc("A paginated list of items with a filter")
@Versioning.added(CommonGrants.Versions.v0_1)
model Filtered<ItemsT, FilterT> extends Success {
  // Inherit the properties of the Sorted response
  ...Sorted<ItemsT>;

  /** The filters applied to the response items */
  filterInfo: {
    filters: FilterT;

    /** Non-fatal errors that occurred during filtering */
    errors?: string[];
  };
}

Python

The Python code for this model.

class FilterInfo(CommonGrantsBaseModel, Generic[FilterT]):
    """Filter information for search results."""

    filters: FilterT = Field(
        ..., description="The filters applied to the response items"
    )
    errors: Optional[list[str]] = Field(
        default_factory=lambda: [],
        description="Non-fatal errors that occurred during filtering",
    )


class Filtered(Sorted[ItemsT], Generic[ItemsT, FilterT]):
    """A paginated list of items with a filter."""

    filter_info: FilterInfo[FilterT] = Field(
        ...,
        description="The filters applied to the response items",
        alias="filterInfo",
    )

    model_config = {"populate_by_name": True}

TypeScript

The TypeScript code for this model.

export const FilteredSchema = <ItemsT extends z.ZodTypeAny, FilterT extends z.ZodTypeAny>(
  itemsSchema: ItemsT,
  filterSchema: FilterT
) =>
  SortedSchema(itemsSchema).extend({
    /** The filters applied to the response items */
    filterInfo: z
      .object({
        filters: filterSchema,

        /** Non-fatal errors that occurred during filtering */
        errors: z.array(z.string()).nullish(),
      })
      .strict(),
  });