connector-errors/fatal-errors-schema.json at master · iTwin/connector-errors · 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
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/product.schema.json",
    "title": "Connector Errors",
    "description": "A connector error in the errors-schema.json",
    "type": "object",
    "properties": {
        "systems": {
            "description": "Array of json objects where each entry is a system name and its phases",
            "type": "array",
            "items": {
                "$ref": "#/$defs/system"
            },
            "uniqueItems": true
        },
        "categories": {
            "description": "Category is used as an organizational property to describe what an error pertains to",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "kbArticleLinks": {
            "description": "knowledge-based article links, these usually contain information about one or more errors in the list of errors",
            "type": "object",
            "patternProperties": {
                ".*": {"type": "string"}
            }
        },
        "errors": {
            "type": "object",
            "patternProperties": {
                ".*": {"$ref": "#/$defs/error"}
            },
            "additionalProperties": false
        }
    },
    "$defs": {
        "system": {
            "type": "object",
            "required": ["name", "phases"],
            "properties": {
                "name": {
                    "type": "string",
                    "description": "name of the system"
                },
                "phases": {
                    "type": "array",
                    "description": "array of phases that the system would typically go through",
                    "items": {
                        "type": "string"
                    }
                }
            }
        },
        "error": {
            "type": "object",
            "required": ["description", "categoryId", "canUserFix"],
            "properties": {
                "description": {
                    "type": "string"
                },
                "categoryId": {
                    "type": "string"
                },
                "kbLinkId": {
                    "type": "string"
                },
                "canUserFix": {
                    "type": "boolean"
                }
            },
            "additionalProperties": false
        }
    }
}