YQueue DocsDevelopers

Schema

Schedule

Defines a schedule that may be associated with another catalog model.

  • Catalog

Overview

object · 7 properties · 7 required

Properties

uuid

string Required

The schedule's unique identifier.

Format uuid
Read only Yes

model_type

enum Required
Read only Yes

Allowed values

schedule

name

string Required

The schedule's name.

Example Breakfast Schedule
Min length 1
Max length 255

tags

array Required

The schedule's tags.

Unique items Yes
Array items

Items

string
Format uuid

entries

array Required

The periods of time throughout the week that the schedule applies.

Array items

Items

reference

References Schedule Entry.

exceptions

array Required

The date-time ranges that the schedule should not apply.

Array items

Items

reference

References Schedule Exception.

created_at

string Required

The date-time that the schedule was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
title: Schedule
x-tags:
  - Catalog
type: object
description: Defines a schedule that may be associated with another catalog model.
properties:
  uuid:
    type: string
    format: uuid
    description: The schedule's unique identifier.
    readOnly: true
  model_type:
    enum:
      - schedule
    readOnly: true
  name:
    type: string
    minLength: 1
    maxLength: 255
    description: The schedule's name.
    example: Breakfast Schedule
  tags:
    type: array
    uniqueItems: true
    description: The schedule's tags.
    items:
      type: string
      format: uuid
  entries:
    type: array
    description: The periods of time throughout the week that the schedule applies.
    items:
      $ref: ./ScheduleEntry.yaml
  exceptions:
    type: array
    description: The date-time ranges that the schedule should not apply.
    items:
      $ref: ./ScheduleException.yaml
  created_at:
    type: string
    description: The date-time that the schedule was created.
    format: date-time
    readOnly: true
required:
  - uuid
  - model_type
  - name
  - tags
  - entries
  - exceptions
  - created_at

Search documentation

Search across this documentation site.