pdf-text-layer-auditor/docs/action-report-schema-v6.json at main · lMysticl/pdf-text-layer-auditor · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/lMysticl/pdf-text-layer-auditor/main/docs/action-report-schema-v6.json",
  "title": "PDF Text Layer Audit GitHub Action report v6",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "repository",
    "pullRequestNumber",
    "filesChecked",
    "filesWithFindings",
    "filesFailed",
    "conclusion",
    "files"
  ],
  "properties": {
    "schemaVersion": { "const": 6 },
    "repository": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$"
    },
    "pullRequestNumber": { "type": "integer", "minimum": 1 },
    "filesChecked": { "type": "integer", "minimum": 0 },
    "filesWithFindings": { "type": "integer", "minimum": 0 },
    "filesFailed": { "type": "integer", "minimum": 0 },
    "conclusion": {
      "type": "string",
      "enum": ["passed", "neutral", "findings", "error"]
    },
    "files": {
      "type": "array",
      "items": {
        "oneOf": [
          { "$ref": "#/$defs/auditedFile" },
          { "$ref": "#/$defs/failedFile" }
        ]
      }
    }
  },
  "$defs": {
    "auditedFile": {
      "type": "object",
      "additionalProperties": false,
      "required": ["path", "status", "report"],
      "properties": {
        "path": { "type": "string" },
        "status": { "type": "string", "enum": ["passed", "attention"] },
        "report": { "$ref": "report-schema-v6.json" }
      }
    },
    "failedFile": {
      "type": "object",
      "additionalProperties": false,
      "required": ["path", "status", "error"],
      "properties": {
        "path": { "type": "string" },
        "status": { "const": "error" },
        "error": { "type": "string" }
      }
    }
  }
}