Goal

The session goal block. status and percentComplete are carried verbatim — out-of-contract status strings and >100 percents pass through; display clamping is the renderer’s job.

Fields and variants

• currentWork
• nextWork
• objective
• percentComplete
• status

Source

schema/msp/experimental/msp.schema.json#/types/Goal

{
  "description": "The session goal block. `status` and `percentComplete` are carried **verbatim** —\nout-of-contract status strings and >100 percents pass through; display\nclamping is the renderer's job.",
  "properties": {
    "currentWork": {
      "description": "Current work description, when present.",
      "type": "string"
    },
    "nextWork": {
      "description": "Next work description, when present.",
      "type": "string"
    },
    "objective": {
      "description": "The goal objective text.",
      "type": "string"
    },
    "percentComplete": {
      "description": "Percent complete, verbatim (>100 passes through).",
      "type": "integer"
    },
    "status": {
      "description": "Goal status, verbatim from the durable goal state (free string by\ndesign: out-of-contract values pass through).",
      "type": "string"
    }
  },
  "required": [
    "objective",
    "percentComplete",
    "status"
  ],
  "type": "object"
}