Calaf Seed Tools

Returns the complete specification (markdown) for calaf_seed: 1 JSON documents — the format to follow when a user asks for a Calaf seed. Read it before authoring; then check your draft with validate_seed.

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "Where the same document lives as a resource."
    },
    "markdown": {
      "type": "string"
    }
  },
  "required": [
    "uri",
    "markdown"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}

Runs a draft seed document through the exact parser the Calaf app imports with. Pass the entire JSON document as a string. Returns per-section counts and the precise issue list (path, severity, message): severity "error" means nothing imports; "dropped" means that row or field is discarded and the rest lands. Fix the issues and validate again until clean before delivering the file to the user.

{
  "type": "object",
  "properties": {
    "seed": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        }
      ],
      "description": "The complete seed JSON document — as text, or as the JSON object itself."
    }
  },
  "required": [
    "seed"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "valid": {
      "type": "boolean"
    },
    "counts": {
      "type": "object",
      "properties": {
        "orgs": {
          "type": "number"
        },
        "contacts": {
          "type": "number"
        },
        "templates": {
          "type": "number"
        },
        "prep": {
          "type": "number"
        },
        "keyDates": {
          "type": "number"
        },
        "orgKinds": {
          "type": "number"
        },
        "ladderRungs": {
          "type": "number"
        }
      },
      "required": [
        "orgs",
        "contacts",
        "templates",
        "prep",
        "keyDates",
        "orgKinds",
        "ladderRungs"
      ],
      "additionalProperties": false
    },
    "hasVocab": {
      "type": "boolean"
    },
    "hasPlanner": {
      "type": "boolean"
    },
    "issues": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "severity": {
            "type": "string",
            "enum": [
              "error",
              "dropped"
            ]
          }
        },
        "required": [
          "path",
          "message",
          "severity"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "valid",
    "counts",
    "hasVocab",
    "hasPlanner",
    "issues"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}