Date and time types

Date and time types used throughout the protocol.

isoDate

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

Example

"2025-01-01"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: isoDate.yaml
type: string
format: date
examples:
  - 2025-01-01
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"))
@Versioning.added(Versions.v0_1)
scalar isoDate extends plainDate;

isoTime

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

Example

"17:00:00"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: isoTime.yaml
type: string
format: time
examples:
  - 17:00:00
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"))
@Versioning.added(Versions.v0_1)
scalar isoTime extends plainTime;

calendarYear

A 4-digit calendar year.

Example

"2025"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: calendarYear.yaml
type: string
examples:
  - "2025"
pattern: ^[0-9]{4}$
description: A 4-digit calendar year.

TypeSpec

/** A 4-digit calendar year. */
@example("2025")
@pattern("^[0-9]{4}$")
@Versioning.added(Versions.v0_1)
scalar calendarYear extends string;