mermaid-atlas.vercel.app

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Short title for the tour, e.g. 'Checkout request to payment database'."
    },
    "steps": {
      "type": "array",
      "minItems": 1,
      "maxItems": 24,
      "description": "Ordered steps. Consecutive nodes should be connected for the edge highlight to appear.",
      "items": {
        "type": "object",
        "properties": {
          "nodeId": {
            "type": "string",
            "description": "Exact node id."
          },
          "caption": {
            "type": "string",
            "description": "One or two sentences explaining what happens at this node and why the next hop follows."
          }
        },
        "required": [
          "nodeId",
          "caption"
        ],
        "additionalProperties": false
      }
    },
    "requireConnected": {
      "type": "boolean",
      "description": "Reject the tour if any consecutive nodes lack a graph edge (default true). Set false only for intentional jumps."
    }
  },
  "required": [
    "title",
    "steps"
  ],
  "additionalProperties": false
}