io.atplan.plan Documentation (EN)

main record

A user plan record. Inspired by the Unix .plan file tradition.

Record Key literal:self Fixed literal value

Properties

displayName string Optional

Human readable name

maxLength: 64 bytes

project string Optional

Current project, the .project companion

maxLength: 256 bytes

status string Optional

Short availability or mood line

maxLength: 100 bytes

text string Required

The freeform .plan body

maxLength: 10000 bytes

updatedAt string datetime Required

Timestamp of last update

url string Optional

Optional personal or project URL

maxLength: 512 bytes

View raw schema

{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "text",
      "updatedAt"
    ],
    "properties": {
      "url": {
        "type": "string",
        "maxLength": 512,
        "description": "Optional personal or project URL"
      },
      "text": {
        "type": "string",
        "maxLength": 10000,
        "description": "The freeform .plan body"
      },
      "status": {
        "type": "string",
        "maxLength": 100,
        "description": "Short availability or mood line"
      },
      "project": {
        "type": "string",
        "maxLength": 256,
        "description": "Current project, the .project companion"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of last update"
      },
      "displayName": {
        "type": "string",
        "maxLength": 64,
        "description": "Human readable name"
      }
    }
  },
  "description": "A user plan record. Inspired by the Unix .plan file tradition."
}