summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/annotation-model/definitions/collections.json
blob: 9f5b13a9f83f137e7acde8ed2e969e56c3efcf24 (plain)
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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "collections.json",
  "title": "Definitions: Annotation Collections.",
  "description": "Schemas in #/definitions detect or validate keys/objects (direct children) uniquely used to describe Annotation Collections (Section 5.1 and 5.2).",
  "definitions": {

    "contextValueFound": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: Valid @context string included in Collection / Page description",
      "description": "True when the string has value http://www.w3.org/ns/anno.jsonld (Section 5)",
      "type": "string",
      "enum": [ "http://www.w3.org/ns/anno.jsonld" ]
    },

    "contextValueInArrayFound": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: Valid @context string found in array included in Collection / Page description",
      "description": "True when the array contains a string item having value http://www.w3.org/ns/anno.jsonld (Section 5)",
      "type": "array",
      "not":
      { "items":
        { "not":
          { "$ref": "#/definitions/contextValueFound" }
        }
      }
    },

    "annotationCollectionTypeValueRecognized": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: Valid AnnotationCollection type value string included in Collection description",
      "description": "True when the string has value 'AnnotationCollection' (Section 5.1)",
      "type": "string",
      "enum": [ "AnnotationCollection" ]
    },

    "annotationCollectionTypeValueInArrayRecognized": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: Valid AnnotationCollection type in array included in Collection description",
      "description": "True when the array contains a string item having value 'AnnotationCollection' (Section 5.1)",
      "type": "array",
      "not":
      { "items":
        { "not":
          { "$ref": "#/definitions/annotationCollectionTypeValueRecognized" }
        }
      }
    },

    "annotationCollectionTypeValueFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Implementation: AnnotationCollection type",
      "description": "True when the Annotation Collection has type key and 'AnnotationCollection' is a value of type (Section 5.1)",
      "type": "object",
      "required": [ "type" ],
      "properties": {
        "type": {
          "oneOf": [
          { "$ref": "#/definitions/annotationCollectionTypeValueRecognized" },
          { "$ref": "#/definitions/annotationCollectionTypeValueInArrayRecognized" }
          ]
        }
      }
    },

    "annotationPageTypeValueRecognized": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: Valid AnnotationPage type value string included in Page description",
      "description": "True when the string has value 'AnnotationPage' (Section 5.2)",
      "type": "string",
      "enum": [ "AnnotationPage" ]
    },

    "annotationPageTypeValueInArrayRecognized": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: Valid AnnotationPage type in array included in Page description",
      "description": "True when the array contains a string item having value 'AnnotationPage' (Section 5.2)",
      "type": "array",
      "not":
      { "items":
        { "not":
          { "$ref": "#/definitions/annotationPageTypeValueRecognized" }
        }
      }
    },

    "annotationPageTypeValueFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Implementation: AnnotationPage type",
      "description": "True when the Annotation Page has type key and 'AnnotationPage' is a value of type (Section 5.2)",
      "type": "object",
      "required": [ "type" ],
      "properties": {
        "type": {
          "oneOf": [
          { "$ref": "#/definitions/annotationPageTypeValueRecognized" },
          { "$ref": "#/definitions/annotationPageTypeValueInArrayRecognized" }
          ]
        }
      }
    },

    "labelDefinition":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: label (Annotation Collections)",
      "description": "True when the object has no label or has one or more label values of type string (Section 5.1)",
      "type": "object",
      "properties":
      {
        "label":
        {
          "oneOf":
            [
            {"type": "string" },
            {"type": "array",
              "minItems": 1,
              "items": {"type": "string"}
            }
            ]
        }
      }
    },

    "labelFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Collection label",
      "description": "True when the object has one or more label value(s) (Section 5.1)",
      "allOf": [
      {"required": ["label"]},
      {"$ref": "#/definitions/labelDefinition"}
      ]
    },

    "totalDefinition":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: total (Annotation Collections)",
      "description": "True when the object has no total key or has exactly one total value of type integer greater or equal to zero (Section 5.1)",
      "type": "object",
      "properties":
      {
        "total":
        {
          "oneOf":
            [
             {"type": "integer",
              "minimum": 0 },
             {"type": "array",
               "minItems": 1,
               "maxItems": 1,
               "items": {"type": "integer",
                         "minimum": 0 }
             }
            ]
        }
      }
    },

    "totalFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Collection total key",
      "description": "True when the object has exactly one total value (Section 5.1)",
      "allOf": [
      {"required": ["total"]},
      {"$ref": "#/definitions/totalDefinition"}
      ]
    },

    "totalMoreThanZero":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: total more than zero (Annotation Collections)",
      "description": "True when the object has exactly one total value of type integer and greater than zero (Section 5.1)",
      "type": "object",
      "properties":
      {
        "total":
        {
          "oneOf":
            [
             {"type": "integer",
              "minimum": 0,
              "exclusiveMinimum": true},
             {"type": "array",
               "minItems": 1,
               "maxItems": 1,
               "items": {"type": "integer",
                         "minimum": 0,
                         "exclusiveMinimum": true}
             }
            ]
        }
      },
      "required": [ "total" ]
    },

    "firstValidIfPresent":
    {   "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Validation: first value (Annotation Collection)",
      "description": "True when the Annotation Collection has no first key or has 1 first key value that is string of format uri or has first key value that is an object of type AnnotationPage (Section 5.1)",
      "type": "object",
      "properties": {"first":
        { "oneOf": [
          {
            "oneOf": [
              { "$ref": "id.json#/definitions/stringUri" },
              { "$ref": "#/definitions/annotationPageTypeValueFound" }
             ]
          },
          { "type": "array",
            "minItems": 1,
            "maxItems": 1,
            "items": {
                "oneOf": [
                  { "$ref": "id.json#/definitions/stringUri" },
                  { "$ref": "#/definitions/annotationPageTypeValueFound" }
               ]
             }
          }
         ]
        }
      }
    },

    "firstFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Collection first key",
      "description": "True when the object has exactly one first value (Section 5.1)",
      "allOf": [
      {"required": ["first"]},
      {"$ref": "#/definitions/firstValidIfPresent"}
      ]
    },

    "firstRequiredIfTotalMoreThanZero":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "If total greater than zero, check for implementation of Annotation Collection first key",
      "description": "True when the object has no total or has total = zero or has exactly one first value (Section 5.1)",
      "type": "object",
      "oneOf": [
        {
          "allOf": [
             { "$ref": "#/definitions/totalMoreThanZero" },
             { "$ref": "#/definitions/firstFound" }
          ]
        },
        { "not": { "$ref": "#/definitions/totalMoreThanZero" } }
      ]
    },

    "lastValidIfPresent":
    {   "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Validation: last value (Annotation Collection)",
      "description": "True when the Annotation Collection has no last key or has 1 last key value that is string of format uri (Section 5.1)",
      "type": "object",
      "properties": {"last":
        { "oneOf": [
          { "$ref": "id.json#/definitions/stringUri" },
          { "type": "array",
            "minItems": 1,
            "maxItems": 1,
            "items": { "$ref": "id.json#/definitions/stringUri" }
          }
         ]
        }
      }
    },

    "lastFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Collection last key",
      "description": "True when the object has exactly one last value that is string of format uri (Section 5.1)",
      "allOf": [
      {"required": ["last"]},
      {"$ref": "#/definitions/lastValidIfPresent"}
      ]
    },

    "partOfValidIfPresent":
    {   "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Validation: partOf value (Annotation Page)",
      "description": "True when the Annotation Page has no partOf key or has 1 partOf key value that is string of format uri (Section 5.2)",
      "type": "object",
      "properties": {"partOf":
        { "oneOf": [
          { "$ref": "id.json#/definitions/arraySingleStringUri" },
          { "$ref": "id.json#/definitions/idValueFound" }
         ]
        }
      }
    },

    "partOfFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Page partOf key",
      "description": "True when the object has exactly one partOf value that is string of format uri (Section 5.2)",
      "allOf": [
      {"required": ["partOf"]},
      {"$ref": "#/definitions/partOfValidIfPresent"}
      ]
    },

    "nextValidIfPresent":
    {   "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Validation: next value (Annotation Page)",
      "description": "True when the Annotation Page has no next key or has 1 next key value that is string of format uri (Section 5.2)",
      "type": "object",
      "properties": {"next":
        { "oneOf": [
          { "$ref": "id.json#/definitions/stringUri" },
          { "type": "array",
            "minItems": 1,
            "maxItems": 1,
            "items": { "$ref": "id.json#/definitions/stringUri" }
          }
         ]
        }
      }
    },

    "nextFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Page next key",
      "description": "True when the object has exactly one next value that is string of format uri (Section 5.2)",
      "allOf": [
      {"required": ["next"]},
      {"$ref": "#/definitions/nextValidIfPresent"}
      ]
    },

    "prevValidIfPresent":
    {   "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Validation: prev value (Annotation Page)",
      "description": "True when the Annotation Page has no prev key or has 1 prev key value that is string of format uri (Section 5.2)",
      "type": "object",
      "properties": {"prev":
        { "oneOf": [
          { "$ref": "id.json#/definitions/stringUri" },
          { "type": "array",
            "minItems": 1,
            "maxItems": 1,
            "items": { "$ref": "id.json#/definitions/stringUri" }
          }
         ]
        }
      }
    },

    "prevFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Page prev key",
      "description": "True when the object has exactly one prev value that is string of format uri (Section 5.2)",
      "allOf": [
      {"required": ["prev"]},
      {"$ref": "#/definitions/prevValidIfPresent"}
      ]
    },

    "startIndexDefinition":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Definition: startIndex (Annotation Pages)",
      "description": "True when the object has no startIndex key or has exactly one startIndex value of type integer greater or equal to zero (Section 5.2)",
      "type": "object",
      "properties":
      {
        "startIndex":
        {
          "oneOf":
            [
             {"type": "integer",
              "minimum": 0 },
             {"type": "array",
               "minItems": 1,
               "maxItems": 1,
               "items": {"type": "integer",
                         "minimum": 0 }
             }
            ]
        }
      }
    },

    "startIndexFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Page startIndex key",
      "description": "True when the object has exactly one startIndex value (Section 5.2)",
      "allOf": [
      {"required": ["startIndex"]},
      {"$ref": "#/definitions/startIndexDefinition"}
      ]
    },

    "itemsFound":
    {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Check for implementation of Annotation Page items key",
      "description": "True when the object has items key with value that is an array of strings of format uri and/or objects of type Annotation (Section 5.2)",
      "type": "object",
      "properties":
      {   "items":
          {  "type": "array",
             "items": {
               "oneOf":[
                   { "$ref": "annotations.json#/definitions/annotationTypeValueFound" },
                   { "type": "string",
                     "format": "uri" }
                ]
              }
          }
      },
      "required": [ "items" ]
    }

  }
}