-
Notifications
You must be signed in to change notification settings - Fork 0
/
request-schema.json
355 lines (355 loc) · 12.8 KB
/
request-schema.json
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Message",
"type": "object",
"additionalProperties": false,
"properties": {
"Linehash": {
"type": [
"null",
"string"
]
},
"EnrichmentId": {
"type": [
"null",
"string"
]
},
"MessageType": {
"type": [
"null",
"string"
]
},
"Fields": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ContentField"
}
}
},
"definitions": {
"ContentField": {
"type": "object",
"description": "Details of a UGC content field on an item.",
"additionalProperties": false,
"properties": {
"fieldname": {
"type": [
"null",
"string"
],
"description": "Gets or sets the name of the field."
},
"content": {
"type": [
"null",
"string"
],
"description": "Gets or sets the text content of the field."
},
"Filtered": {
"type": [
"null",
"string"
],
"description": "Gets or sets the filtered text content of the field."
},
"policy": {
"type": [
"null",
"string"
],
"description": "Gets or sets the RMF policy applied to the field."
},
"index": {
"type": "integer",
"description": "Gets or sets the index of the field in the item.",
"format": "int32"
},
"result": {
"description": "Gets or sets the score applied to the content by the RMF.",
"oneOf": [
{
"$ref": "#/definitions/RmfScore"
}
]
},
"profile": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this ContentField should be included in the primary content."
},
"type": {
"type": [
"null",
"string"
],
"description": "Gets or sets the type of the field."
},
"uri": {
"type": [
"null",
"string"
],
"description": "Gets or sets the URI address for the content.",
"format": "uri"
},
"content_tags": {
"type": [
"array",
"null"
],
"description": "Gets the set of tags related to the field.",
"items": {
"$ref": "#/definitions/ContentFieldTag"
}
},
"binarytype": {
"type": [
"null",
"string"
],
"description": "Gets or sets the binary type for the content."
},
"mimetype": {
"type": [
"null",
"string"
],
"description": "Gets or sets the associated MIME type, if known."
},
"language": {
"description": "Gets or sets the details of the language the field is in.",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ContentLanguageInfo"
}
]
},
"representations": {
"type": [
"array",
"null"
],
"description": "Gets the representations of the field.",
"items": {
"$ref": "#/definitions/ContentFieldRepresentation"
}
},
"IsMetadata": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the field data is for metadata values."
}
}
},
"RmfScore": {
"type": "integer",
"description": "Score values returned from the RMF.",
"x-enumNames": [
"None",
"WhitelistUnmatched",
"Blacklisted"
],
"enum": [
0,
1,
2
]
},
"ContentFieldTag": {
"type": "object",
"description": "Details of a message tag on a content field.",
"additionalProperties": false,
"properties": {
"Type": {
"type": [
"null",
"string"
],
"description": "Gets or sets the type of tag."
},
"Id": {
"type": [
"null",
"string"
],
"description": "Gets or sets the identifier associated with the tag."
},
"Name": {
"type": [
"null",
"string"
],
"description": "Gets or sets the name associated with the tag."
},
"ProfileId": {
"type": [
"null",
"string"
],
"description": "Gets or sets the profile identifier.",
"x-deprecated": true,
"x-deprecatedMessage": "Renamed Id"
},
"ProfileName": {
"type": [
"null",
"string"
],
"description": "Gets or sets the name of the profile.",
"x-deprecated": true,
"x-deprecatedMessage": "Renamed Name"
},
"Classification": {
"type": [
"null",
"string"
],
"description": "Gets or sets the classification associated to the tag."
},
"Score": {
"type": [
"null",
"number"
],
"description": "Gets or sets the score related to the tag.",
"format": "double"
},
"Offset": {
"type": "integer",
"description": "Gets or sets the offset in the original text.",
"format": "int32"
},
"Length": {
"type": "integer",
"description": "Gets or sets the length of the tag in the original text.",
"format": "int32"
}
}
},
"ContentLanguageInfo": {
"allOf": [
{
"$ref": "#/definitions/DetectedLanguageInfo"
},
{
"type": "object",
"description": "Details of the language the content of a UGC item has been detected to be.",
"additionalProperties": false,
"properties": {
"Supported": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this the language is supported for the item's page."
}
}
}
]
},
"DetectedLanguageInfo": {
"type": "object",
"description": "Details of a language as detected.",
"additionalProperties": false,
"properties": {
"IsEnglish": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the content is in English."
},
"DetectedLanguage": {
"type": [
"null",
"string"
],
"description": "Gets or sets the detected language code.",
"x-deprecated": true,
"x-deprecatedMessage": "Renamed LanguageCode"
},
"LanguageCode": {
"type": [
"null",
"string"
],
"description": "Gets or sets language that was detected in ISO 639-1\nformat. (https://en.wikipedia.org/wiki/ISO_639-1), if\nknown."
},
"Confidence": {
"type": [
"null",
"number"
],
"description": "Gets or sets the confidence returned from the detection, a probability between 0.0 and 1.0.",
"format": "double"
}
}
},
"ContentFieldRepresentation": {
"type": "object",
"description": "Alternative representations of the content of a field.",
"additionalProperties": false,
"properties": {
"Type": {
"type": [
"null",
"string"
],
"description": "Gets or sets the representation type, typically one of the constants in ContentFieldRepresentationType."
},
"Content": {
"type": [
"null",
"string"
],
"description": "Gets or sets the content value in this representation."
},
"LanguageCode": {
"type": [
"null",
"string"
],
"description": "Gets or sets the language code for this representation, if different from the field language."
},
"Tags": {
"type": [
"array",
"null"
],
"description": "Gets the set of tags related to the field.",
"items": {
"$ref": "#/definitions/ContentFieldTag"
}
},
"content_tags": {
"type": [
"array",
"null"
],
"description": "Gets the set of tags related to the field.",
"items": {
"$ref": "#/definitions/ContentFieldTag"
}
},
"Metadata": {
"type": [
"null",
"object"
],
"description": "Gets additional metadata about the field.",
"additionalProperties": {}
},
"Index": {
"type": [
"integer",
"null"
],
"description": "Gets or sets the representation index to correlate in messages, not normally stored on the item.",
"format": "int32"
}
}
}
}
}