Schema
A typed personal attribute value.
The three temporal types are three variants, and none of them is "an instant with an optional zone" ([ADR-183]). The meaning is carried by which variant it is, never by whether a field happens to be filled in, so there is no reading of a stored value that could go two ways.
[ADR-183]: ../../../docs/decisions/ADR-201-225.md#adr-206-timemodel--koru-has-three-temporal-types-not-one-with-a-nullable-timezone
Type object or object or object or object or object or object
One of 6 shapes:
type: "text"
Free text.
| Field | Type | Description |
|---|---|---|
| textrequired | string | |
| typerequired | "text" |
type: "number"
A finite number.
| Field | Type | Description |
|---|---|---|
| numberrequired | number (double) | |
| typerequired | "number" |
type: "bool"
A boolean. Stored only when set - "false" is a value, "unset" is an absent key.
| Field | Type | Description |
|---|---|---|
| valuerequired | boolean | |
| typerequired | "bool" |
type: "date"
A calendar date, YYYY-MM-DD. Deliberately not an instant: it names a day, the same day in every timezone.
| Field | Type | Description |
|---|---|---|
| daterequired | string | |
| typerequired | "date" |
type: "datetime_floating"
A wall-clock date and time with no zone, YYYY-MM-DDTHH:MM:SS.
The normal shape for a personal timed value, and why it is: koru.plan answers when do I intend to work on this, and 09:00 means 09:00 wherever the person wakes up. Pinning it to the zone they were sitting in when they typed it would make a plan move overnight on a flight - a decision nobody made.
There is no tz field, so nothing can half-fill one.
| Field | Type | Description |
|---|---|---|
| wallrequired | string | |
| typerequired | "datetime_floating" |
type: "datetime_zoned"
An instant in epoch milliseconds UTC plus the IANA zone it was meant in (America/New_York) - a name rather than an offset, because daylight-saving rules change what a future offset will be.
The zone is not optional: a personal value that is genuinely tied to a place says which, and one that is not is [DatetimeFloating](Self::DatetimeFloating) instead.
| Field | Type | Description |
|---|---|---|
| msrequired | integer (int64) | |
| tzrequired | string | |
| typerequired | "datetime_zoned" |
{
"text": "string",
"type": "text"
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .