YQueue DocsDevelopers

Schema

Modifier Group Request

On edit, omitted top-level properties retain their existing values.

  • Catalog

Overview

object · 10 properties · 0 required

Properties

name

string
Example Choose Your Bread
Min length 1
Max length 255

tags

allOf

UUIDs of tags to associate with the modifier group.

All of

All of 1

reference

References Catalog UUID List.

availability

reference

References Availability Request.

alternative_names

reference

References Alternative Names.

description

string | null
Min length 1
Max length 255
Nullable Yes

minimum_selections

integer

Must not exceed a supplied `maximum_selections`. On edit, when the maximum is omitted, this value must not exceed the existing maximum.

Minimum 0

maximum_selections

integer | null

A non-null value must be supplied together with `minimum_selections` and must be greater than or equal to it.

Minimum 1
Nullable Yes

prerequisite_modifiers

allOf

UUIDs of modifiers that must be selected before presenting this group.

All of

All of 1

reference

References Catalog UUID List.

modifiers

allOf

UUIDs of modifiers to associate with the group, in their desired order.

All of

All of 1

reference

References Catalog UUID List.

translations

object
Nested properties

name

reference

References Translation.

description

reference

References Translation.

Used by

Raw YAML
Download source
title: Modifier Group Request
x-tags:
  - Catalog
type: object
description: On edit, omitted top-level properties retain their existing values.
properties:
  name:
    type: string
    minLength: 1
    maxLength: 255
    example: Choose Your Bread
  tags:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of tags to associate with the modifier group.
  availability:
    $ref: ./AvailabilityRequest.yaml
  alternative_names:
    $ref: ./AlternativeNames.yaml
  description:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  minimum_selections:
    type: integer
    minimum: 0
    description: Must not exceed a supplied `maximum_selections`. On edit, when the maximum is omitted, this value must not exceed the existing maximum.
  maximum_selections:
    type:
      - integer
      - 'null'
    minimum: 1
    description: A non-null value must be supplied together with `minimum_selections` and must be greater than or equal to it.
  prerequisite_modifiers:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of modifiers that must be selected before presenting this group.
  modifiers:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of modifiers to associate with the group, in their desired order.
  translations:
    type: object
    properties:
      name:
        $ref: ./Translation.yaml
      description:
        $ref: ./Translation.yaml

Search documentation

Search across this documentation site.