contract-vault-cli/docs/spec/obligations-output.schema.json at main · DrBaher/contract-vault-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/DrBaher/contract-vault-cli/blob/main/docs/spec/obligations-output.schema.json",
  "title": "contract-vault obligations (`due --format json`) output schema (v1)",
  "description": "Machine-readable projection of upcoming, dated obligations across the whole vault, produced by `contract-vault due --format json` (and `obligations`), and by `remind --format json` (which omits within_days). Doubles as the reminder manifest: each row carries days_until, reminders, and a suggested lead_days. The .ics output (`--format ics`) is the same data rendered as RFC 5545.",
  "type": "object",
  "additionalProperties": false,
  "required": ["generated_at", "as_of", "count", "obligations"],
  "$defs": {
    "source": {
      "enum": ["deterministic", "llm", "manual", "none"]
    },
    "confidence": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  },
  "properties": {
    "generated_at": { "type": "string" },
    "as_of": { "type": "string" },
    "within_days": { "type": "integer", "minimum": 0 },
    "count": { "type": "integer", "minimum": 0 },
    "obligations": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "deal",
          "counterparty",
          "type",
          "due",
          "days_until",
          "description",
          "status",
          "owner",
          "recurrence",
          "reminders",
          "source",
          "confidence",
          "lead_days"
        ],
        "properties": {
          "id": { "type": "string" },
          "deal": { "type": "string" },
          "counterparty": { "type": "string" },
          "type": { "type": "string" },
          "due": { "type": "string" },
          "days_until": { "type": "integer" },
          "description": { "type": "string" },
          "status": { "enum": ["open", "done", "waived"] },
          "owner": { "type": ["string", "null"] },
          "recurrence": { "type": ["string", "null"] },
          "reminders": { "type": "array", "items": { "type": "integer", "minimum": 0 } },
          "source": { "$ref": "#/$defs/source" },
          "confidence": { "$ref": "#/$defs/confidence" },
          "lead_days": { "type": "integer", "minimum": 0 }
        }
      }
    }
  }
}