bundleup/docs/schema/cache-v1.json at main · funkyfunc/bundleup · 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/funkyfunc/bundleup/blob/main/docs/schema/cache-v1.json",
  "title": "bundleup cache list|clean --json, schema version 1",
  "description": "One document on stdout at exit. Within schema_version 1 changes are additive only: consumers must ignore unknown keys.",
  "type": "object",
  "required": [
    "schema_version",
    "command",
    "ok",
    "exit_code",
    "result",
    "diagnostics"
  ],
  "properties": {
    "schema_version": {
      "const": 1
    },
    "command": {
      "enum": [
        "cache",
        "cache list",
        "cache clean"
      ]
    },
    "ok": {
      "type": "boolean"
    },
    "exit_code": {
      "enum": [
        0,
        1,
        2,
        3,
        130
      ]
    },
    "result": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "description": "cache list",
          "required": [
            "bundles"
          ],
          "properties": {
            "bundles": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "path",
                  "name",
                  "size_bytes",
                  "last_used"
                ],
                "properties": {
                  "path": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "size_bytes": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "last_used": {
                    "type": "integer",
                    "description": "Seconds since the epoch"
                  }
                }
              }
            }
          }
        },
        {
          "type": "object",
          "description": "cache clean",
          "required": [
            "removed",
            "freed_bytes",
            "dry_run"
          ],
          "properties": {
            "removed": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "freed_bytes": {
              "type": "integer",
              "minimum": 0
            },
            "dry_run": {
              "type": "boolean"
            },
            "in_use": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Old copies left alone because a running program holds them (added within version 1)"
            }
          }
        }
      ]
    },
    "diagnostics": {
      "type": "array"
    }
  }
}