YQueue DocsDevelopers

Schema

Schedule Entry

The standardised representation of a schedule entry.

  • Foundation

Overview

object · 3 properties · 3 required

Properties

day_of_week_iso

integer Required

The day of the week that the entry applies (local time). This is expressed as an ISO week date as defined in ISO 8601 (i.e. 1 is Monday, 7 is Sunday).

Minimum 1
Maximum 7

start

string Required

The time that the entry "starts" (local time).

Example 09:00
Pattern ^(?:2[0-3]|[01][0-9]):[0-5][0-9]$

end

string Required

The time that the entry "ends" (local time).

Example 17:00
Pattern ^(?:2[0-3]|[01][0-9]):[0-5][0-9]$

Used by

Raw YAML
Download source
title: Schedule Entry
x-tags:
  - Foundation
type: object
description: The standardised representation of a schedule entry.
properties:
  day_of_week_iso:
    type: integer
    minimum: 1
    maximum: 7
    description: |-
      The day of the week that the entry applies (local time).

      This is expressed as an ISO week date as defined in ISO 8601 (i.e. 1 is Monday, 7 is Sunday).
  start:
    type: string
    example: '09:00'
    pattern: '^(?:2[0-3]|[01][0-9]):[0-5][0-9]$'
    description: The time that the entry "starts" (local time).
  end:
    type: string
    pattern: '^(?:2[0-3]|[01][0-9]):[0-5][0-9]$'
    example: '17:00'
    description: The time that the entry "ends" (local time).
required:
  - day_of_week_iso
  - start
  - end

Search documentation

Search across this documentation site.