YQueue DocsDevelopers

Schema

Catalog Cursor Search Request

  • Catalog

Overview

object · 5 properties · 0 required

Properties

cursor

string | null

The cursor returned by the previous request.

Example eyJ1dWlkIjoiYTUxODNmM2ItNDRjZC00Y2ZlLTk4N2UtZTU1NGU4MTkxYmQ0In0
Min length 1
Nullable Yes

cursor_limit

integer | null

The maximum number of results to return.

Default 2000
Minimum 1
Maximum 2000
Nullable Yes

sort_field

oneOf
Default uuid
Nullable Yes
One of

One of 1

null

One of 2

reference

References Catalog Sort Field.

sort_direction

oneOf
Default asc
Nullable Yes
One of

One of 1

null

One of 2

reference

References Sort By.

filters

object | null
Nullable Yes
Nested properties

model_types

array | null
Nullable Yes
Unique items Yes
Array items
Items
reference

References Catalog Model Type.

query

string | null

The catalog model names to search against.

Min length 1
Max length 255
Nullable Yes

Used by

Raw YAML
Download source
title: Catalog Cursor Search Request
x-tags:
  - Catalog
type: object
properties:
  cursor:
    type:
      - string
      - 'null'
    minLength: 1
    description: The cursor returned by the previous request.
    example: eyJ1dWlkIjoiYTUxODNmM2ItNDRjZC00Y2ZlLTk4N2UtZTU1NGU4MTkxYmQ0In0
  cursor_limit:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 2000
    default: 2000
    description: The maximum number of results to return.
  sort_field:
    oneOf:
      - type: 'null'
      - $ref: ./CatalogSortField.yaml
    default: uuid
  sort_direction:
    oneOf:
      - type: 'null'
      - $ref: ./SortDirection.yaml
    default: asc
  filters:
    type:
      - object
      - 'null'
    properties:
      model_types:
        type:
          - array
          - 'null'
        uniqueItems: true
        items:
          $ref: ./CatalogModelType.yaml
      query:
        type:
          - string
          - 'null'
        minLength: 1
        maxLength: 255
        description: The catalog model names to search against.

Search documentation

Search across this documentation site.