basic-bulk-uc-upload/docs/use-case-schema.json at main · nckcem/basic-bulk-uc-upload · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
{
   "$schema":"http://json-schema.org/draft-07/schema#",
   "$id":"https://credo.ai/use_cases.schema_1-0-0.json",
   "title":"Use cases",
   "description":"CredoAI use cased schema, version 1.0, the initial version",
   "oneOf":[
      {
         "type":"array",
         "items":{
            "$ref":"#/definitions/use_case"
         }
      },
      {
         "$ref":"#/definitions/use_case"
      }
   ],
   "definitions":{
      "use_case":{
         "type":"object",
         "properties":{
            "id":{
               "type":"string",
               "description":"The unique identifier of the use case"
            },
            "description":{
               "type":[
                  "string",
                  "null"
               ],
               "description":"The description of the use case"
            },
            "name":{
               "type":"string",
               "description":"The name of the use case"
            },
            "icon":{
               "type":[
                  "string",
                  "null"
               ],
               "description":"The icon of the use case"
            },
            "ai_type":{
               "type":"string",
               "description":"The type of AI used in the use case"
            },
            "governance_status":{
               "type":"integer",
               "description":"The governance status of the use case"
            },
            "domains":{
               "type":"array",
               "items":{
                  "type":"string"
               },
               "description":"The domains of the use case"
            },
            "industries":{
               "type":"array",
               "items":{
                  "type":"string"
               },
               "description":"The industries of the use case"
            },
            "regions":{
               "type":"array",
               "items":{
                  "type":"string"
               },
               "description":"The regions of the use case"
            },
            "risk_category_level":{
               "type":[
                  "integer",
                  "null"
               ],
               "description":"The risk category level of the use case"
            },
            "custom_fields":{
               "type":"array",
               "items":{
                  "$ref":"#/definitions/custom_field"
               },
               "description":"The use case custom fields"
            },
            "questionnaires":{
               "type":"array",
               "items":{
                  "$ref":"#/definitions/questionnaire"
               },
               "description":"The questionnaires of the use case"
            },
            "inserted_at":{
               "type":"string",
               "format":"date-time",
               "description":"The date and time when the use case was created"
            },
            "updated_at":{
               "type":"string",
               "format":"date-time",
               "description":"The date and time when the use case was last updated"
            }
         },
         "additionalProperties":false
      },
      "custom_field":{
         "type":"object",
         "properties":{
            "custom_field_id":{
               "type":"string",
               "description":"The unique UUID of the custom field"
            },
            "type":{
               "type":"string",
               "description":"The type of the custom field"
            },
            "name":{
               "type":"string",
               "description":"The name of the custom field"
            },
            "value":{
               "type":[
                  "boolean",
                  "number",
                  "string",
                  "null"
               ],
               "description":"The value of the custom field"
            }
         },
         "additionalProperties":false
      },
      "questionnaire":{
         "type":"object",
         "properties":{
            "name":{
               "type":"string",
               "description":"The name of the questionnaire"
            },
            "key":{
               "type":"string",
               "description":"The unique key of the questionnaire"
            },
            "version":{
               "type":"number",
               "description":"The version of the questionnaire"
            },
            "sections":{
               "type":"array",
               "items":{
                  "$ref":"#/definitions/section"
               },
               "description":"The sections of the questionnaire"
            }
         },
         "additionalProperties":false
      },
      "section":{
         "type":"object",
         "properties":{
            "id":{
               "type":"string",
               "description":"The unique UUID of the section"
            },
            "title":{
               "type":"string",
               "description":"The title of the section"
            },
            "questions":{
               "type":"array",
               "items":{
                  "$ref":"#/definitions/question"
               },
               "description":"The questions of the section"
            }
         },
         "additionalProperties":false
      },
      "question":{
         "type":"object",
         "properties":{
            "id":{
               "type":"string",
               "description":"The unique UUID of the question"
            },
            "answer":{
               "type":[
                  "boolean",
                  "number",
                  "string",
                  "object",
                  "null"
               ],
               "description":"The answer of the question"
            }
         },
         "additionalProperties":false
      }
   }
}