family.pardy.familytime.goal

pardy.at

Documentation

A star chart goal: earn this many stars, get the reward. Stars, claims and rewards point at the id. Tied to an event, it shows before it on the days it happens; otherwise in its own window. Board configuration: board space (parents only); each parent saves their own copy with rkey = id, and the newest updatedAt wins (a deleted copy removes it).

main record

A star chart goal: earn this many stars, get the reward. Stars, claims and rewards point at the id. Tied to an event, it shows before it on the days it happens; otherwise in its own window. Board configuration: board space (parents only); each parent saves their own copy with rkey = id, and the newest updatedAt wins (a deleted copy removes it).

Record Key any Any valid record key

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

deleted boolean Optional

Removed, when this is the newest copy.

emoji string Optional

No description available.

maxLength: 32 bytes
event string Optional

A board event's URI, or an imported calendar series (feed URI#uid): when to show the goal, not how many stars it takes.

maxLength: 2000 bytes
id string Required

Stable across edits and parents; the record key.

maxLength: 64 bytes
reward object Optional

No description available.

show object Optional

When to show it, if not tied to an event.

stars integer Optional

Stars to earn the reward.

minimum: 1maximum: 30
title string Optional

No description available.

maxLength: 100 bytes
updatedAt string datetime Required

Last write wins across parents.

who array of string did Optional

Kids it's for; empty means every kid.

View raw schema 
{
  "description": "A star chart goal: earn this many stars, get the reward. Stars, claims and rewards point at the id. Tied to an event, it shows before it on the days it happens; otherwise in its own window. Board configuration: board space (parents only); each parent saves their own copy with rkey = id, and the newest updatedAt wins (a deleted copy removes it).",
  "key": "any",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "deleted": {
        "description": "Removed, when this is the newest copy.",
        "type": "boolean"
      },
      "emoji": {
        "maxLength": 32,
        "type": "string"
      },
      "event": {
        "description": "A board event's URI, or an imported calendar series (feed URI#uid): when to show the goal, not how many stars it takes.",
        "maxLength": 2000,
        "type": "string"
      },
      "id": {
        "description": "Stable across edits and parents; the record key.",
        "maxLength": 64,
        "type": "string"
      },
      "reward": {
        "properties": {
          "emoji": {
            "maxLength": 32,
            "type": "string"
          },
          "title": {
            "maxLength": 100,
            "type": "string"
          }
        },
        "required": [
          "title",
          "emoji"
        ],
        "type": "object"
      },
      "show": {
        "description": "When to show it, if not tied to an event.",
        "properties": {
          "from": {
            "maxLength": 5,
            "type": "string"
          },
          "until": {
            "maxLength": 5,
            "type": "string"
          }
        },
        "required": [
          "from",
          "until"
        ],
        "type": "object"
      },
      "stars": {
        "description": "Stars to earn the reward.",
        "maximum": 30,
        "minimum": 1,
        "type": "integer"
      },
      "title": {
        "maxLength": 100,
        "type": "string"
      },
      "updatedAt": {
        "description": "Last write wins across parents.",
        "format": "datetime",
        "type": "string"
      },
      "who": {
        "description": "Kids it's for; empty means every kid.",
        "items": {
          "format": "did",
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "createdAt",
      "id",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@