YQueue DocsDevelopers

Schema

Media Search Request

  • Media Library

Overview

object · 5 properties · 0 required

Properties

page

integer | null
Default 1
Minimum 1
Nullable Yes

per_page

integer | null
Default 25
Minimum 1
Maximum 25
Nullable Yes

sort_field

string | null
Default name
Nullable Yes

Allowed values

uuidnamenull

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

query

string | null

The media file names to search against.

Min length 1
Max length 255
Nullable Yes

file_type

array | null
Min items 1
Nullable Yes
Unique items Yes
Array items
Items
string

Allowed values

imagevideoaudio

Used by

Raw YAML
Download source
title: Media Search Request
x-tags:
  - Media Library
type: object
properties:
  page:
    type:
      - integer
      - 'null'
    minimum: 1
    default: 1
  per_page:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 25
    default: 25
  sort_field:
    type:
      - string
      - 'null'
    enum:
      - uuid
      - name
      - null
    default: name
  sort_direction:
    oneOf:
      - type: 'null'
      - $ref: ./SortDirection.yaml
    default: asc
  filters:
    type:
      - object
      - 'null'
    properties:
      query:
        type:
          - string
          - 'null'
        minLength: 1
        maxLength: 255
        description: The media file names to search against.
      file_type:
        type:
          - array
          - 'null'
        minItems: 1
        uniqueItems: true
        items:
          type: string
          enum:
            - image
            - video
            - audio

Search documentation

Search across this documentation site.