Date and time types

isoDate

A date on a calendar in ISO 8601 format YYYY-MM-DD.

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: isoDate.yaml
type: string
format: date
description: A date on a calendar in ISO 8601 format YYYY-MM-DD

TypeSpec

/** A date on a calendar in ISO 8601 format YYYY-MM-DD */
@example(isoDate.fromISO("2025-01-01"))
scalar isoDate extends plainTime;

Example

"2025-01-01"

isoTime

A time on a clock, without a timezone, in ISO 8601 format HH:mm:ss.

Caution

The isoTime type does not include timezone information. When representing a time in a specific timezone, use utcDateTime or offsetDateTime instead.

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: isoTime.yaml
type: string
format: time
description: A time on a clock, without a timezone, in ISO 8601 format HH:mm:ss

TypeSpec

/** A time on a clock, without a timezone, in ISO 8601 format HH:mm:ss */
@example(isoTime.fromISO("17:00:00"))
scalar isoTime extends plainTime;

Example

"17:00:00"

utcDateTime

A date and time with timezone in ISO 8601 format YYYY-MM-DDThh:mm:ssZ.

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: isoDateTime.yaml
type: string
format: date-time
description: A date and time with timezone in ISO 8601 format YYYY-MM-DDThh:mm:ssZ

Example

"2024-02-28T17:00:00Z"

offsetDateTime

A date and time with timezone in ISO 8601 format YYYY-MM-DDThh:mm:ss±hh:mm.

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: offsetDateTime.yaml
type: string
format: date-time
description: A date and time with timezone in ISO 8601 format YYYY-MM-DDThh:mm:ss±hh:mm

Example

"2024-02-28T17:00:00+01:00"