@twin.org/document-management-service 0.0.1-next.8 → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +728 -428
- package/dist/esm/index.mjs +728 -430
- package/dist/types/documentManagementRoutes.d.ts +20 -4
- package/dist/types/documentManagementService.d.ts +71 -36
- package/dist/types/models/IDocumentManagementStorageServiceConstructorOptions.d.ts +5 -0
- package/docs/changelog.md +195 -0
- package/docs/open-api/spec.json +609 -1470
- package/docs/reference/classes/DocumentManagementService.md +179 -63
- package/docs/reference/functions/{documentManagementSet.md → documentManagementCreate.md} +4 -4
- package/docs/reference/functions/documentManagementGetRevision.md +31 -0
- package/docs/reference/functions/documentManagementUpdate.md +31 -0
- package/docs/reference/index.md +3 -1
- package/docs/reference/interfaces/IDocumentManagementServiceConstructorOptions.md +14 -0
- package/locales/en.json +6 -5
- package/package.json +73 -15
package/docs/open-api/spec.json
CHANGED
|
@@ -21,41 +21,28 @@
|
|
|
21
21
|
}
|
|
22
22
|
],
|
|
23
23
|
"paths": {
|
|
24
|
-
"/
|
|
24
|
+
"/document-management": {
|
|
25
25
|
"post": {
|
|
26
26
|
"operationId": "DocumentManagementSet",
|
|
27
27
|
"summary": "Store a document in an auditable item graph vertex and add its content to blob storage.",
|
|
28
28
|
"tags": [
|
|
29
29
|
"Document Management"
|
|
30
30
|
],
|
|
31
|
-
"parameters": [
|
|
32
|
-
{
|
|
33
|
-
"name": "auditableItemGraphId",
|
|
34
|
-
"description": "The id of the auditable item graph vertex to store the document on.",
|
|
35
|
-
"in": "path",
|
|
36
|
-
"required": true,
|
|
37
|
-
"schema": {
|
|
38
|
-
"type": "string"
|
|
39
|
-
},
|
|
40
|
-
"style": "simple",
|
|
41
|
-
"example": "aig:123456"
|
|
42
|
-
}
|
|
43
|
-
],
|
|
44
31
|
"security": [
|
|
45
32
|
{
|
|
46
33
|
"jwtBearerAuthScheme": []
|
|
47
34
|
}
|
|
48
35
|
],
|
|
49
36
|
"requestBody": {
|
|
50
|
-
"description": "Request to
|
|
37
|
+
"description": "Request to create a document as an auditable item graph vertex.",
|
|
51
38
|
"required": true,
|
|
52
39
|
"content": {
|
|
53
40
|
"application/json": {
|
|
54
41
|
"schema": {
|
|
55
|
-
"$ref": "#/components/schemas/
|
|
42
|
+
"$ref": "#/components/schemas/DocumentManagementCreateRequest"
|
|
56
43
|
},
|
|
57
44
|
"examples": {
|
|
58
|
-
"
|
|
45
|
+
"DocumentManagementCreateRequestExample": {
|
|
59
46
|
"value": {
|
|
60
47
|
"documentId": "2721000",
|
|
61
48
|
"documentIdFormat": "bol",
|
|
@@ -81,7 +68,7 @@
|
|
|
81
68
|
"schema": {
|
|
82
69
|
"type": "string"
|
|
83
70
|
},
|
|
84
|
-
"description": "e.g.
|
|
71
|
+
"description": "e.g. aig:123456"
|
|
85
72
|
}
|
|
86
73
|
}
|
|
87
74
|
},
|
|
@@ -152,50 +139,34 @@
|
|
|
152
139
|
],
|
|
153
140
|
"parameters": [
|
|
154
141
|
{
|
|
155
|
-
"name": "
|
|
156
|
-
"description": "The id of the
|
|
157
|
-
"in": "path",
|
|
158
|
-
"required": true,
|
|
159
|
-
"schema": {
|
|
160
|
-
"type": "string"
|
|
161
|
-
},
|
|
162
|
-
"style": "simple",
|
|
163
|
-
"example": "aig:123456"
|
|
164
|
-
},
|
|
165
|
-
{
|
|
166
|
-
"name": "documentCodes",
|
|
167
|
-
"description": "List of comma separated document codes to filter the query.",
|
|
142
|
+
"name": "documentId",
|
|
143
|
+
"description": "The id of the document id we are trying to find.",
|
|
168
144
|
"in": "query",
|
|
169
145
|
"required": false,
|
|
170
146
|
"schema": {
|
|
171
147
|
"type": "string"
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
{
|
|
175
|
-
"name": "includeRemoved",
|
|
176
|
-
"description": "Include deleted documents in the response.",
|
|
177
|
-
"in": "query",
|
|
178
|
-
"required": false,
|
|
179
|
-
"schema": {
|
|
180
|
-
"type": "boolean"
|
|
181
|
-
}
|
|
148
|
+
},
|
|
149
|
+
"example": "2721000"
|
|
182
150
|
},
|
|
183
151
|
{
|
|
184
|
-
"name": "
|
|
185
|
-
"description": "
|
|
152
|
+
"name": "cursor",
|
|
153
|
+
"description": "The cursor to get the next chunk of documents.",
|
|
186
154
|
"in": "query",
|
|
187
155
|
"required": false,
|
|
188
156
|
"schema": {
|
|
189
|
-
"type": "
|
|
157
|
+
"type": "string"
|
|
190
158
|
}
|
|
191
159
|
},
|
|
192
160
|
{
|
|
193
|
-
"name": "
|
|
194
|
-
"description": "The
|
|
161
|
+
"name": "pageSize",
|
|
162
|
+
"description": "The number of documents to return.",
|
|
195
163
|
"in": "query",
|
|
196
164
|
"required": false,
|
|
197
165
|
"schema": {
|
|
198
|
-
"type":
|
|
166
|
+
"type": [
|
|
167
|
+
"number",
|
|
168
|
+
"string"
|
|
169
|
+
]
|
|
199
170
|
}
|
|
200
171
|
},
|
|
201
172
|
{
|
|
@@ -219,80 +190,67 @@
|
|
|
219
190
|
"content": {
|
|
220
191
|
"application/json": {
|
|
221
192
|
"schema": {
|
|
222
|
-
"$ref": "
|
|
193
|
+
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexList"
|
|
223
194
|
},
|
|
224
195
|
"examples": {
|
|
225
196
|
"DocumentManagementQueryResponseExample": {
|
|
226
197
|
"value": {
|
|
227
198
|
"@context": [
|
|
228
|
-
"https://schema.
|
|
229
|
-
"https://schema.twindev.org/
|
|
199
|
+
"https://schema.org",
|
|
200
|
+
"https://schema.twindev.org/aig/"
|
|
230
201
|
],
|
|
231
|
-
"type":
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
"@context": [
|
|
235
|
-
"https://schema.twindev.org/documents/",
|
|
236
|
-
"https://schema.twindev.org/common/",
|
|
237
|
-
"https://schema.org"
|
|
238
|
-
],
|
|
239
|
-
"type": "Document",
|
|
240
|
-
"id": "documents:705:2721000:rev-0",
|
|
241
|
-
"documentId": "2721000",
|
|
242
|
-
"documentIdFormat": "bol",
|
|
243
|
-
"documentCode": "unece:DocumentCodeList#705",
|
|
244
|
-
"documentRevision": 0,
|
|
245
|
-
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
246
|
-
"blobHash": "sha256:123456",
|
|
247
|
-
"dateCreated": "2024-01-01T00:00:00Z",
|
|
248
|
-
"annotationObject": {
|
|
249
|
-
"@context": "https://schema.org",
|
|
250
|
-
"@type": "DigitalDocument",
|
|
251
|
-
"name": "myfile.pdf"
|
|
252
|
-
},
|
|
253
|
-
"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
|
|
254
|
-
"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
|
|
255
|
-
}
|
|
256
|
-
]
|
|
257
|
-
}
|
|
258
|
-
}
|
|
259
|
-
}
|
|
260
|
-
},
|
|
261
|
-
"application/ld+json": {
|
|
262
|
-
"schema": {
|
|
263
|
-
"$ref": "#/components/schemas/DocumentList"
|
|
264
|
-
},
|
|
265
|
-
"examples": {
|
|
266
|
-
"DocumentManagementListResponseJsonLdExample": {
|
|
267
|
-
"value": {
|
|
268
|
-
"@context": [
|
|
269
|
-
"https://schema.twindev.org/documents/",
|
|
270
|
-
"https://schema.twindev.org/common/"
|
|
202
|
+
"type": [
|
|
203
|
+
"ItemList",
|
|
204
|
+
"AuditableItemGraphVertexList"
|
|
271
205
|
],
|
|
272
|
-
"
|
|
273
|
-
"documents": [
|
|
206
|
+
"itemListElement": [
|
|
274
207
|
{
|
|
275
208
|
"@context": [
|
|
276
|
-
"https://schema.twindev.org/
|
|
277
|
-
"https://schema.twindev.org/common/"
|
|
278
|
-
"https://schema.org"
|
|
209
|
+
"https://schema.twindev.org/aig/",
|
|
210
|
+
"https://schema.twindev.org/common/"
|
|
279
211
|
],
|
|
280
|
-
"
|
|
281
|
-
"
|
|
282
|
-
"
|
|
283
|
-
"
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
212
|
+
"id": "aig:c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7",
|
|
213
|
+
"type": "AuditableItemGraphVertex",
|
|
214
|
+
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
215
|
+
"aliases": [
|
|
216
|
+
{
|
|
217
|
+
"@context": [
|
|
218
|
+
"https://schema.twindev.org/aig/"
|
|
219
|
+
],
|
|
220
|
+
"id": "test-id-0",
|
|
221
|
+
"type": "AuditableItemGraphAlias",
|
|
222
|
+
"dateCreated": "2024-08-22T04:13:20.000Z"
|
|
223
|
+
}
|
|
224
|
+
],
|
|
225
|
+
"resources": [
|
|
226
|
+
{
|
|
227
|
+
"@context": "https://schema.twindev.org/aig/",
|
|
228
|
+
"type": "AuditableItemGraphResource",
|
|
229
|
+
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
230
|
+
"resourceObject": {
|
|
231
|
+
"@context": [
|
|
232
|
+
"https://schema.twindev.org/documents/",
|
|
233
|
+
"https://schema.twindev.org/common/",
|
|
234
|
+
"https://schema.org"
|
|
235
|
+
],
|
|
236
|
+
"type": "Document",
|
|
237
|
+
"id": "test-id-0:0",
|
|
238
|
+
"documentId": "test-id-0",
|
|
239
|
+
"documentCode": "unece:DocumentCodeList#705",
|
|
240
|
+
"documentRevision": 0,
|
|
241
|
+
"annotationObject": {
|
|
242
|
+
"@context": "https://schema.org",
|
|
243
|
+
"type": "DigitalDocument",
|
|
244
|
+
"name": "bill-of-lading"
|
|
245
|
+
},
|
|
246
|
+
"blobHash": "sha256:E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
|
|
247
|
+
"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
|
|
248
|
+
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
249
|
+
"nodeIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
|
|
250
|
+
"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
]
|
|
296
254
|
}
|
|
297
255
|
]
|
|
298
256
|
}
|
|
@@ -361,27 +319,126 @@
|
|
|
361
319
|
}
|
|
362
320
|
}
|
|
363
321
|
},
|
|
364
|
-
"/
|
|
365
|
-
"
|
|
366
|
-
"operationId": "
|
|
367
|
-
"summary": "
|
|
322
|
+
"/document-management/{auditableItemGraphDocumentId}": {
|
|
323
|
+
"put": {
|
|
324
|
+
"operationId": "DocumentManagementUpdate",
|
|
325
|
+
"summary": "Update a document in an auditable item graph vertex and add its content to blob storage.",
|
|
368
326
|
"tags": [
|
|
369
327
|
"Document Management"
|
|
370
328
|
],
|
|
371
329
|
"parameters": [
|
|
372
330
|
{
|
|
373
|
-
"name": "
|
|
374
|
-
"description": "The id of the
|
|
331
|
+
"name": "auditableItemGraphDocumentId",
|
|
332
|
+
"description": "The full id of the document to get.",
|
|
375
333
|
"in": "path",
|
|
376
334
|
"required": true,
|
|
377
335
|
"schema": {
|
|
378
336
|
"type": "string"
|
|
379
337
|
},
|
|
380
338
|
"style": "simple",
|
|
381
|
-
"example": "aig:
|
|
339
|
+
"example": "aig:123456"
|
|
340
|
+
}
|
|
341
|
+
],
|
|
342
|
+
"security": [
|
|
343
|
+
{
|
|
344
|
+
"jwtBearerAuthScheme": []
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"requestBody": {
|
|
348
|
+
"description": "Request to update a document as an auditable item graph vertex.",
|
|
349
|
+
"required": true,
|
|
350
|
+
"content": {
|
|
351
|
+
"application/json": {
|
|
352
|
+
"schema": {
|
|
353
|
+
"$ref": "#/components/schemas/DocumentManagementUpdateRequest"
|
|
354
|
+
},
|
|
355
|
+
"examples": {
|
|
356
|
+
"DocumentManagementUpdateRequestExample": {
|
|
357
|
+
"value": {
|
|
358
|
+
"blob": "SGVsbG8gV29ybGQ=",
|
|
359
|
+
"annotationObject": {
|
|
360
|
+
"@context": "https://schema.org",
|
|
361
|
+
"@type": "DigitalDocument",
|
|
362
|
+
"name": "myfile.pdf"
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
},
|
|
370
|
+
"responses": {
|
|
371
|
+
"204": {
|
|
372
|
+
"description": "The rest request ended in success with no data."
|
|
373
|
+
},
|
|
374
|
+
"400": {
|
|
375
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
376
|
+
"content": {
|
|
377
|
+
"application/json": {
|
|
378
|
+
"schema": {
|
|
379
|
+
"$ref": "#/components/schemas/Error"
|
|
380
|
+
},
|
|
381
|
+
"examples": {
|
|
382
|
+
"exampleResponse": {
|
|
383
|
+
"value": {
|
|
384
|
+
"name": "GeneralError",
|
|
385
|
+
"message": "component.error",
|
|
386
|
+
"properties": {
|
|
387
|
+
"foo": "bar"
|
|
388
|
+
}
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
}
|
|
394
|
+
},
|
|
395
|
+
"401": {
|
|
396
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
397
|
+
"content": {
|
|
398
|
+
"application/json": {
|
|
399
|
+
"schema": {
|
|
400
|
+
"$ref": "#/components/schemas/Error"
|
|
401
|
+
},
|
|
402
|
+
"examples": {
|
|
403
|
+
"exampleResponse": {
|
|
404
|
+
"value": {
|
|
405
|
+
"name": "UnauthorizedError",
|
|
406
|
+
"message": "component.error"
|
|
407
|
+
}
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
}
|
|
382
412
|
},
|
|
413
|
+
"500": {
|
|
414
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
415
|
+
"content": {
|
|
416
|
+
"application/json": {
|
|
417
|
+
"schema": {
|
|
418
|
+
"$ref": "#/components/schemas/Error"
|
|
419
|
+
},
|
|
420
|
+
"examples": {
|
|
421
|
+
"exampleResponse": {
|
|
422
|
+
"value": {
|
|
423
|
+
"name": "InternalServerError",
|
|
424
|
+
"message": "component.error"
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
"get": {
|
|
434
|
+
"operationId": "DocumentManagementGet",
|
|
435
|
+
"summary": "Get the data for a document from document management",
|
|
436
|
+
"tags": [
|
|
437
|
+
"Document Management"
|
|
438
|
+
],
|
|
439
|
+
"parameters": [
|
|
383
440
|
{
|
|
384
|
-
"name": "
|
|
441
|
+
"name": "auditableItemGraphDocumentId",
|
|
385
442
|
"description": "The full id of the document to get.",
|
|
386
443
|
"in": "path",
|
|
387
444
|
"required": true,
|
|
@@ -389,7 +446,7 @@
|
|
|
389
446
|
"type": "string"
|
|
390
447
|
},
|
|
391
448
|
"style": "simple",
|
|
392
|
-
"example": "
|
|
449
|
+
"example": "aig:123456"
|
|
393
450
|
},
|
|
394
451
|
{
|
|
395
452
|
"name": "includeBlobStorageMetadata",
|
|
@@ -397,7 +454,10 @@
|
|
|
397
454
|
"in": "query",
|
|
398
455
|
"required": false,
|
|
399
456
|
"schema": {
|
|
400
|
-
"type":
|
|
457
|
+
"type": [
|
|
458
|
+
"boolean",
|
|
459
|
+
"string"
|
|
460
|
+
]
|
|
401
461
|
}
|
|
402
462
|
},
|
|
403
463
|
{
|
|
@@ -406,7 +466,10 @@
|
|
|
406
466
|
"in": "query",
|
|
407
467
|
"required": false,
|
|
408
468
|
"schema": {
|
|
409
|
-
"type":
|
|
469
|
+
"type": [
|
|
470
|
+
"boolean",
|
|
471
|
+
"string"
|
|
472
|
+
]
|
|
410
473
|
}
|
|
411
474
|
},
|
|
412
475
|
{
|
|
@@ -415,7 +478,10 @@
|
|
|
415
478
|
"in": "query",
|
|
416
479
|
"required": false,
|
|
417
480
|
"schema": {
|
|
418
|
-
"type":
|
|
481
|
+
"type": [
|
|
482
|
+
"boolean",
|
|
483
|
+
"string"
|
|
484
|
+
]
|
|
419
485
|
}
|
|
420
486
|
},
|
|
421
487
|
{
|
|
@@ -424,20 +490,44 @@
|
|
|
424
490
|
"in": "query",
|
|
425
491
|
"required": false,
|
|
426
492
|
"schema": {
|
|
427
|
-
"type":
|
|
493
|
+
"type": [
|
|
494
|
+
"boolean",
|
|
495
|
+
"string"
|
|
496
|
+
]
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
"name": "extractRuleGroupId",
|
|
501
|
+
"description": "If provided will extract data from the document using the specified rule group id.",
|
|
502
|
+
"in": "query",
|
|
503
|
+
"required": false,
|
|
504
|
+
"schema": {
|
|
505
|
+
"type": "string"
|
|
506
|
+
}
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
"name": "extractMimeType",
|
|
510
|
+
"description": "By default extraction will auto detect the mime type of the document, this can be used to override the detection.",
|
|
511
|
+
"in": "query",
|
|
512
|
+
"required": false,
|
|
513
|
+
"schema": {
|
|
514
|
+
"type": "string"
|
|
428
515
|
}
|
|
429
516
|
},
|
|
430
517
|
{
|
|
431
|
-
"name": "
|
|
432
|
-
"description": "
|
|
518
|
+
"name": "pageSize",
|
|
519
|
+
"description": "Page size of items to return, defaults to 1 so only most recent is returned.",
|
|
433
520
|
"in": "query",
|
|
434
521
|
"required": false,
|
|
435
522
|
"schema": {
|
|
436
|
-
"type":
|
|
523
|
+
"type": [
|
|
524
|
+
"number",
|
|
525
|
+
"string"
|
|
526
|
+
]
|
|
437
527
|
}
|
|
438
528
|
},
|
|
439
529
|
{
|
|
440
|
-
"name": "
|
|
530
|
+
"name": "cursor",
|
|
441
531
|
"description": "The cursor to get the next chunk of revisions.",
|
|
442
532
|
"in": "query",
|
|
443
533
|
"required": false,
|
|
@@ -466,42 +556,249 @@
|
|
|
466
556
|
"content": {
|
|
467
557
|
"application/json": {
|
|
468
558
|
"schema": {
|
|
469
|
-
"$ref": "#/components/schemas/
|
|
559
|
+
"$ref": "#/components/schemas/DocumentList"
|
|
470
560
|
},
|
|
471
561
|
"examples": {
|
|
472
562
|
"DocumentManagementGetResponseExample": {
|
|
473
563
|
"value": {
|
|
474
564
|
"@context": [
|
|
565
|
+
"https://schema.org",
|
|
475
566
|
"https://schema.twindev.org/documents/",
|
|
476
|
-
"https://schema.twindev.org/common/"
|
|
477
|
-
"https://schema.org"
|
|
567
|
+
"https://schema.twindev.org/common/"
|
|
478
568
|
],
|
|
479
|
-
"type": "
|
|
480
|
-
"
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
569
|
+
"type": "ItemList",
|
|
570
|
+
"itemListElement": [
|
|
571
|
+
{
|
|
572
|
+
"@context": [
|
|
573
|
+
"https://schema.twindev.org/documents/",
|
|
574
|
+
"https://schema.twindev.org/common/",
|
|
575
|
+
"https://schema.org"
|
|
576
|
+
],
|
|
577
|
+
"type": "Document",
|
|
578
|
+
"id": "2721000:0",
|
|
579
|
+
"documentId": "2721000",
|
|
580
|
+
"documentIdFormat": "bol",
|
|
581
|
+
"documentCode": "unece:DocumentCodeList#705",
|
|
582
|
+
"documentRevision": 0,
|
|
583
|
+
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
584
|
+
"blobHash": "sha256:123456",
|
|
585
|
+
"dateCreated": "2024-01-01T00:00:00Z",
|
|
586
|
+
"annotationObject": {
|
|
587
|
+
"@context": "https://schema.org",
|
|
588
|
+
"@type": "DigitalDocument",
|
|
589
|
+
"name": "myfile.pdf"
|
|
590
|
+
},
|
|
591
|
+
"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
|
|
592
|
+
"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
|
|
593
|
+
}
|
|
594
|
+
]
|
|
495
595
|
}
|
|
496
596
|
}
|
|
497
597
|
}
|
|
498
598
|
},
|
|
499
599
|
"application/ld+json": {
|
|
500
600
|
"schema": {
|
|
501
|
-
"$ref": "#/components/schemas/
|
|
601
|
+
"$ref": "#/components/schemas/DocumentList"
|
|
502
602
|
},
|
|
503
603
|
"examples": {
|
|
504
604
|
"DocumentManagementGetResponseExample": {
|
|
605
|
+
"value": {
|
|
606
|
+
"@context": [
|
|
607
|
+
"https://schema.org",
|
|
608
|
+
"https://schema.twindev.org/documents/",
|
|
609
|
+
"https://schema.twindev.org/common/"
|
|
610
|
+
],
|
|
611
|
+
"type": "ItemList",
|
|
612
|
+
"itemListElement": [
|
|
613
|
+
{
|
|
614
|
+
"@context": [
|
|
615
|
+
"https://schema.twindev.org/documents/",
|
|
616
|
+
"https://schema.twindev.org/common/",
|
|
617
|
+
"https://schema.org"
|
|
618
|
+
],
|
|
619
|
+
"type": "Document",
|
|
620
|
+
"id": "2721000:0",
|
|
621
|
+
"documentId": "2721000",
|
|
622
|
+
"documentIdFormat": "bol",
|
|
623
|
+
"documentCode": "unece:DocumentCodeList#705",
|
|
624
|
+
"documentRevision": 0,
|
|
625
|
+
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
626
|
+
"blobHash": "sha256:123456",
|
|
627
|
+
"dateCreated": "2024-01-01T00:00:00Z",
|
|
628
|
+
"annotationObject": {
|
|
629
|
+
"@context": "https://schema.org",
|
|
630
|
+
"@type": "DigitalDocument",
|
|
631
|
+
"name": "myfile.pdf"
|
|
632
|
+
},
|
|
633
|
+
"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
|
|
634
|
+
"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
|
|
635
|
+
}
|
|
636
|
+
]
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
}
|
|
640
|
+
}
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"400": {
|
|
644
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
645
|
+
"content": {
|
|
646
|
+
"application/json": {
|
|
647
|
+
"schema": {
|
|
648
|
+
"$ref": "#/components/schemas/Error"
|
|
649
|
+
},
|
|
650
|
+
"examples": {
|
|
651
|
+
"exampleResponse": {
|
|
652
|
+
"value": {
|
|
653
|
+
"name": "GeneralError",
|
|
654
|
+
"message": "component.error",
|
|
655
|
+
"properties": {
|
|
656
|
+
"foo": "bar"
|
|
657
|
+
}
|
|
658
|
+
}
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
}
|
|
663
|
+
},
|
|
664
|
+
"401": {
|
|
665
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
666
|
+
"content": {
|
|
667
|
+
"application/json": {
|
|
668
|
+
"schema": {
|
|
669
|
+
"$ref": "#/components/schemas/Error"
|
|
670
|
+
},
|
|
671
|
+
"examples": {
|
|
672
|
+
"exampleResponse": {
|
|
673
|
+
"value": {
|
|
674
|
+
"name": "UnauthorizedError",
|
|
675
|
+
"message": "component.error"
|
|
676
|
+
}
|
|
677
|
+
}
|
|
678
|
+
}
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"404": {
|
|
683
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
684
|
+
"content": {
|
|
685
|
+
"application/json": {
|
|
686
|
+
"schema": {
|
|
687
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
688
|
+
},
|
|
689
|
+
"examples": {
|
|
690
|
+
"exampleResponse": {
|
|
691
|
+
"value": {
|
|
692
|
+
"name": "NotFoundError",
|
|
693
|
+
"message": "component.error",
|
|
694
|
+
"properties": {
|
|
695
|
+
"notFoundId": "1"
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
}
|
|
699
|
+
}
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
},
|
|
703
|
+
"500": {
|
|
704
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
705
|
+
"content": {
|
|
706
|
+
"application/json": {
|
|
707
|
+
"schema": {
|
|
708
|
+
"$ref": "#/components/schemas/Error"
|
|
709
|
+
},
|
|
710
|
+
"examples": {
|
|
711
|
+
"exampleResponse": {
|
|
712
|
+
"value": {
|
|
713
|
+
"name": "InternalServerError",
|
|
714
|
+
"message": "component.error"
|
|
715
|
+
}
|
|
716
|
+
}
|
|
717
|
+
}
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
}
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
"/document-management/{auditableItemGraphDocumentId}/{revision}": {
|
|
725
|
+
"get": {
|
|
726
|
+
"operationId": "DocumentManagementGetRevision",
|
|
727
|
+
"summary": "Get the data for a document revision from document management",
|
|
728
|
+
"tags": [
|
|
729
|
+
"Document Management"
|
|
730
|
+
],
|
|
731
|
+
"parameters": [
|
|
732
|
+
{
|
|
733
|
+
"name": "auditableItemGraphDocumentId",
|
|
734
|
+
"description": "",
|
|
735
|
+
"in": "path",
|
|
736
|
+
"required": true,
|
|
737
|
+
"schema": {
|
|
738
|
+
"type": "string"
|
|
739
|
+
},
|
|
740
|
+
"style": "simple",
|
|
741
|
+
"example": "aig:123456"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"name": "revision",
|
|
745
|
+
"description": "",
|
|
746
|
+
"in": "path",
|
|
747
|
+
"required": true,
|
|
748
|
+
"schema": {
|
|
749
|
+
"type": "string"
|
|
750
|
+
},
|
|
751
|
+
"style": "simple",
|
|
752
|
+
"example": "1"
|
|
753
|
+
}
|
|
754
|
+
],
|
|
755
|
+
"security": [
|
|
756
|
+
{
|
|
757
|
+
"jwtBearerAuthScheme": []
|
|
758
|
+
}
|
|
759
|
+
],
|
|
760
|
+
"responses": {
|
|
761
|
+
"200": {
|
|
762
|
+
"description": "Response to get a document revision from an auditable item graph vertex.",
|
|
763
|
+
"content": {
|
|
764
|
+
"application/json": {
|
|
765
|
+
"schema": {
|
|
766
|
+
"$ref": "#/components/schemas/Document"
|
|
767
|
+
},
|
|
768
|
+
"examples": {
|
|
769
|
+
"DocumentManagementGetRevisionResponseExample": {
|
|
770
|
+
"value": {
|
|
771
|
+
"@context": [
|
|
772
|
+
"https://schema.twindev.org/documents/",
|
|
773
|
+
"https://schema.twindev.org/common/",
|
|
774
|
+
"https://schema.org"
|
|
775
|
+
],
|
|
776
|
+
"type": "Document",
|
|
777
|
+
"id": "2721000:0",
|
|
778
|
+
"documentId": "2721000",
|
|
779
|
+
"documentIdFormat": "bol",
|
|
780
|
+
"documentCode": "unece:DocumentCodeList#705",
|
|
781
|
+
"documentRevision": 1,
|
|
782
|
+
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
783
|
+
"blobHash": "sha256:123456",
|
|
784
|
+
"dateCreated": "2024-01-01T00:00:00Z",
|
|
785
|
+
"annotationObject": {
|
|
786
|
+
"@context": "https://schema.org",
|
|
787
|
+
"@type": "DigitalDocument",
|
|
788
|
+
"name": "myfile.pdf"
|
|
789
|
+
},
|
|
790
|
+
"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
|
|
791
|
+
"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
},
|
|
796
|
+
"application/ld+json": {
|
|
797
|
+
"schema": {
|
|
798
|
+
"$ref": "#/components/schemas/Document"
|
|
799
|
+
},
|
|
800
|
+
"examples": {
|
|
801
|
+
"DocumentManagementGetRevisionResponseExample": {
|
|
505
802
|
"value": {
|
|
506
803
|
"@context": [
|
|
507
804
|
"https://schema.twindev.org/documents/",
|
|
@@ -509,11 +806,11 @@
|
|
|
509
806
|
"https://schema.org"
|
|
510
807
|
],
|
|
511
808
|
"type": "Document",
|
|
512
|
-
"id": "
|
|
809
|
+
"id": "2721000:0",
|
|
513
810
|
"documentId": "2721000",
|
|
514
811
|
"documentIdFormat": "bol",
|
|
515
812
|
"documentCode": "unece:DocumentCodeList#705",
|
|
516
|
-
"documentRevision":
|
|
813
|
+
"documentRevision": 1,
|
|
517
814
|
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
518
815
|
"blobHash": "sha256:123456",
|
|
519
816
|
"dateCreated": "2024-01-01T00:00:00Z",
|
|
@@ -618,8 +915,8 @@
|
|
|
618
915
|
],
|
|
619
916
|
"parameters": [
|
|
620
917
|
{
|
|
621
|
-
"name": "
|
|
622
|
-
"description": "The id of the auditable item graph vertex to remove the
|
|
918
|
+
"name": "auditableItemGraphDocumentId",
|
|
919
|
+
"description": "The id of the auditable item graph vertex to remove the revision from.",
|
|
623
920
|
"in": "path",
|
|
624
921
|
"required": true,
|
|
625
922
|
"schema": {
|
|
@@ -629,24 +926,15 @@
|
|
|
629
926
|
"example": "aig:1234"
|
|
630
927
|
},
|
|
631
928
|
{
|
|
632
|
-
"name": "
|
|
633
|
-
"description": "The
|
|
929
|
+
"name": "revision",
|
|
930
|
+
"description": "The revision of the document to remove.",
|
|
634
931
|
"in": "path",
|
|
635
932
|
"required": true,
|
|
636
933
|
"schema": {
|
|
637
934
|
"type": "string"
|
|
638
935
|
},
|
|
639
936
|
"style": "simple",
|
|
640
|
-
"example": "
|
|
641
|
-
},
|
|
642
|
-
{
|
|
643
|
-
"name": "removeAllRevisions",
|
|
644
|
-
"description": "Flag to remove all revisions of the document.",
|
|
645
|
-
"in": "query",
|
|
646
|
-
"required": false,
|
|
647
|
-
"schema": {
|
|
648
|
-
"type": "boolean"
|
|
649
|
-
}
|
|
937
|
+
"example": "1"
|
|
650
938
|
}
|
|
651
939
|
],
|
|
652
940
|
"security": [
|
|
@@ -742,16 +1030,17 @@
|
|
|
742
1030
|
},
|
|
743
1031
|
"components": {
|
|
744
1032
|
"schemas": {
|
|
745
|
-
"
|
|
1033
|
+
"Document": {
|
|
746
1034
|
"type": "object",
|
|
747
1035
|
"properties": {
|
|
748
1036
|
"@context": {
|
|
749
1037
|
"type": "array",
|
|
750
1038
|
"minItems": 3,
|
|
751
|
-
"
|
|
1039
|
+
"description": "JSON-LD Context.",
|
|
1040
|
+
"prefixItems": [
|
|
752
1041
|
{
|
|
753
1042
|
"type": "string",
|
|
754
|
-
"const": "https://schema.twindev.org/
|
|
1043
|
+
"const": "https://schema.twindev.org/documents/"
|
|
755
1044
|
},
|
|
756
1045
|
{
|
|
757
1046
|
"type": "string",
|
|
@@ -762,287 +1051,144 @@
|
|
|
762
1051
|
"const": "https://schema.org"
|
|
763
1052
|
}
|
|
764
1053
|
],
|
|
765
|
-
"
|
|
766
|
-
"$ref": "
|
|
767
|
-
}
|
|
768
|
-
"description": "JSON-LD Context."
|
|
1054
|
+
"items": {
|
|
1055
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
1056
|
+
}
|
|
769
1057
|
},
|
|
770
1058
|
"type": {
|
|
771
1059
|
"type": "string",
|
|
772
|
-
"const": "
|
|
1060
|
+
"const": "Document",
|
|
773
1061
|
"description": "JSON-LD Type."
|
|
774
1062
|
},
|
|
775
1063
|
"id": {
|
|
776
1064
|
"type": "string",
|
|
777
|
-
"description": "The
|
|
1065
|
+
"description": "The full id of the document."
|
|
778
1066
|
},
|
|
779
|
-
"
|
|
1067
|
+
"documentId": {
|
|
780
1068
|
"type": "string",
|
|
781
|
-
"description": "
|
|
1069
|
+
"description": "The id of the document."
|
|
782
1070
|
},
|
|
783
|
-
"
|
|
1071
|
+
"documentIdFormat": {
|
|
784
1072
|
"type": "string",
|
|
785
|
-
"description": "
|
|
1073
|
+
"description": "The format of the document id."
|
|
1074
|
+
},
|
|
1075
|
+
"documentCode": {
|
|
1076
|
+
"$ref": "#/components/schemas/UneceDocumentCodes"
|
|
1077
|
+
},
|
|
1078
|
+
"documentRevision": {
|
|
1079
|
+
"type": "number",
|
|
1080
|
+
"description": "The revision of the document as a 0 based index."
|
|
786
1081
|
},
|
|
787
|
-
"
|
|
1082
|
+
"annotationObject": {
|
|
1083
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1084
|
+
},
|
|
1085
|
+
"blobStorageId": {
|
|
788
1086
|
"type": "string",
|
|
789
|
-
"description": "The
|
|
1087
|
+
"description": "The blob storage id for the document."
|
|
790
1088
|
},
|
|
791
|
-
"
|
|
1089
|
+
"blobHash": {
|
|
792
1090
|
"type": "string",
|
|
793
|
-
"description": "The
|
|
1091
|
+
"description": "The hash of the blob data."
|
|
794
1092
|
},
|
|
795
|
-
"
|
|
796
|
-
"$ref": "
|
|
1093
|
+
"blobStorageEntry": {
|
|
1094
|
+
"$ref": "https://schema.twindev.org/blob-storage/BlobStorageEntry"
|
|
797
1095
|
},
|
|
798
|
-
"
|
|
799
|
-
"
|
|
1096
|
+
"extractedData": {
|
|
1097
|
+
"description": "The data extracted from the document using data extraction services."
|
|
800
1098
|
},
|
|
801
|
-
"
|
|
802
|
-
"type": "
|
|
803
|
-
"description": "
|
|
1099
|
+
"attestationId": {
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"description": "The attestation for the document if one was created."
|
|
1102
|
+
},
|
|
1103
|
+
"attestationInformation": {
|
|
1104
|
+
"$ref": "https://schema.twindev.org/attestation/AttestationInformation"
|
|
1105
|
+
},
|
|
1106
|
+
"dateCreated": {
|
|
1107
|
+
"type": "string",
|
|
1108
|
+
"description": "The date/time of when the document was created."
|
|
1109
|
+
},
|
|
1110
|
+
"dateModified": {
|
|
1111
|
+
"type": "string",
|
|
1112
|
+
"description": "The date/time of when the document was modified."
|
|
1113
|
+
},
|
|
1114
|
+
"dateDeleted": {
|
|
1115
|
+
"type": "string",
|
|
1116
|
+
"description": "The date/time of when the document was deleted, as we never actually remove items."
|
|
1117
|
+
},
|
|
1118
|
+
"nodeIdentity": {
|
|
1119
|
+
"type": "string",
|
|
1120
|
+
"description": "The node which added the document to the graph."
|
|
804
1121
|
},
|
|
805
|
-
"
|
|
1122
|
+
"userIdentity": {
|
|
806
1123
|
"type": "string",
|
|
807
|
-
"description": "The
|
|
1124
|
+
"description": "The user who added the document to the graph."
|
|
808
1125
|
}
|
|
809
1126
|
},
|
|
810
1127
|
"required": [
|
|
811
1128
|
"@context",
|
|
812
1129
|
"type",
|
|
813
1130
|
"id",
|
|
1131
|
+
"documentId",
|
|
1132
|
+
"documentCode",
|
|
1133
|
+
"documentRevision",
|
|
1134
|
+
"blobStorageId",
|
|
1135
|
+
"blobHash",
|
|
814
1136
|
"dateCreated",
|
|
815
|
-
"
|
|
816
|
-
"
|
|
1137
|
+
"nodeIdentity",
|
|
1138
|
+
"userIdentity"
|
|
817
1139
|
],
|
|
818
1140
|
"additionalProperties": false,
|
|
819
|
-
"description": "Interface describing
|
|
1141
|
+
"description": "Interface describing a document."
|
|
820
1142
|
},
|
|
821
|
-
"
|
|
1143
|
+
"DocumentList": {
|
|
822
1144
|
"type": "object",
|
|
823
1145
|
"properties": {
|
|
824
1146
|
"@context": {
|
|
825
1147
|
"type": "array",
|
|
826
|
-
"minItems":
|
|
827
|
-
"
|
|
1148
|
+
"minItems": 3,
|
|
1149
|
+
"description": "JSON-LD Context.",
|
|
1150
|
+
"prefixItems": [
|
|
1151
|
+
{
|
|
1152
|
+
"type": "string",
|
|
1153
|
+
"const": "https://schema.org"
|
|
1154
|
+
},
|
|
828
1155
|
{
|
|
829
1156
|
"type": "string",
|
|
830
|
-
"const": "https://schema.twindev.org/
|
|
1157
|
+
"const": "https://schema.twindev.org/documents/"
|
|
831
1158
|
},
|
|
832
1159
|
{
|
|
833
1160
|
"type": "string",
|
|
834
1161
|
"const": "https://schema.twindev.org/common/"
|
|
835
1162
|
}
|
|
836
1163
|
],
|
|
837
|
-
"
|
|
838
|
-
"$ref": "
|
|
839
|
-
}
|
|
840
|
-
|
|
841
|
-
},
|
|
1164
|
+
"items": {
|
|
1165
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
1166
|
+
}
|
|
1167
|
+
},
|
|
842
1168
|
"type": {
|
|
843
1169
|
"type": "string",
|
|
844
|
-
"const": "
|
|
1170
|
+
"const": "ItemList",
|
|
845
1171
|
"description": "JSON-LD Type."
|
|
846
1172
|
},
|
|
847
|
-
"
|
|
848
|
-
"type": "string",
|
|
849
|
-
"description": "The id for the blob."
|
|
850
|
-
},
|
|
851
|
-
"dateCreated": {
|
|
852
|
-
"type": "string",
|
|
853
|
-
"description": "The date/time when the entry was created."
|
|
854
|
-
},
|
|
855
|
-
"dateModified": {
|
|
856
|
-
"type": "string",
|
|
857
|
-
"description": "The date/time when the entry was modified."
|
|
858
|
-
},
|
|
859
|
-
"blobSize": {
|
|
860
|
-
"type": "number",
|
|
861
|
-
"description": "The size of the data in the blob."
|
|
862
|
-
},
|
|
863
|
-
"blobHash": {
|
|
864
|
-
"type": "string",
|
|
865
|
-
"description": "The hash of the data in the blob."
|
|
866
|
-
},
|
|
867
|
-
"encodingFormat": {
|
|
868
|
-
"type": "string",
|
|
869
|
-
"description": "The mime type for the blob."
|
|
870
|
-
},
|
|
871
|
-
"fileExtension": {
|
|
872
|
-
"type": "string",
|
|
873
|
-
"description": "The extension."
|
|
874
|
-
},
|
|
875
|
-
"metadata": {
|
|
876
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
877
|
-
},
|
|
878
|
-
"blob": {
|
|
879
|
-
"type": "string",
|
|
880
|
-
"description": "The blob in base64 format, included if the includeContent flag was set in the request."
|
|
881
|
-
}
|
|
882
|
-
},
|
|
883
|
-
"required": [
|
|
884
|
-
"@context",
|
|
885
|
-
"type",
|
|
886
|
-
"id",
|
|
887
|
-
"dateCreated",
|
|
888
|
-
"blobSize",
|
|
889
|
-
"blobHash"
|
|
890
|
-
],
|
|
891
|
-
"additionalProperties": false,
|
|
892
|
-
"description": "Interface describing a blob storage entry."
|
|
893
|
-
},
|
|
894
|
-
"Document": {
|
|
895
|
-
"type": "object",
|
|
896
|
-
"properties": {
|
|
897
|
-
"@context": {
|
|
1173
|
+
"itemListElement": {
|
|
898
1174
|
"type": "array",
|
|
899
|
-
"
|
|
900
|
-
"
|
|
901
|
-
{
|
|
902
|
-
"type": "string",
|
|
903
|
-
"const": "https://schema.twindev.org/documents/"
|
|
904
|
-
},
|
|
905
|
-
{
|
|
906
|
-
"type": "string",
|
|
907
|
-
"const": "https://schema.twindev.org/common/"
|
|
908
|
-
},
|
|
1175
|
+
"description": "The list of documents.",
|
|
1176
|
+
"prefixItems": [
|
|
909
1177
|
{
|
|
910
|
-
"
|
|
911
|
-
"const": "https://schema.org"
|
|
1178
|
+
"$ref": "#/components/schemas/Document"
|
|
912
1179
|
}
|
|
913
|
-
]
|
|
914
|
-
"additionalItems": {
|
|
915
|
-
"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
|
|
916
|
-
},
|
|
917
|
-
"description": "JSON-LD Context."
|
|
918
|
-
},
|
|
919
|
-
"type": {
|
|
920
|
-
"type": "string",
|
|
921
|
-
"const": "Document",
|
|
922
|
-
"description": "JSON-LD Type."
|
|
923
|
-
},
|
|
924
|
-
"id": {
|
|
925
|
-
"type": "string",
|
|
926
|
-
"description": "The full id of the document."
|
|
927
|
-
},
|
|
928
|
-
"documentId": {
|
|
929
|
-
"type": "string",
|
|
930
|
-
"description": "The id of the document."
|
|
931
|
-
},
|
|
932
|
-
"documentIdFormat": {
|
|
933
|
-
"type": "string",
|
|
934
|
-
"description": "The format of the document id."
|
|
935
|
-
},
|
|
936
|
-
"documentCode": {
|
|
937
|
-
"$ref": "#/components/schemas/UneceDocumentCodes"
|
|
938
|
-
},
|
|
939
|
-
"documentRevision": {
|
|
940
|
-
"type": "number",
|
|
941
|
-
"description": "The revision of the document as a 0 based index."
|
|
942
|
-
},
|
|
943
|
-
"annotationObject": {
|
|
944
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
945
|
-
},
|
|
946
|
-
"blobStorageId": {
|
|
947
|
-
"type": "string",
|
|
948
|
-
"description": "The blob storage id for the document."
|
|
949
|
-
},
|
|
950
|
-
"blobHash": {
|
|
951
|
-
"type": "string",
|
|
952
|
-
"description": "The hash of the blob data."
|
|
953
|
-
},
|
|
954
|
-
"blobStorageEntry": {
|
|
955
|
-
"$ref": "#/components/schemas/BlobStorageEntry"
|
|
956
|
-
},
|
|
957
|
-
"attestationId": {
|
|
958
|
-
"type": "string",
|
|
959
|
-
"description": "The attestation for the document if one was created."
|
|
960
|
-
},
|
|
961
|
-
"attestationInformation": {
|
|
962
|
-
"$ref": "#/components/schemas/AttestationInformation"
|
|
963
|
-
},
|
|
964
|
-
"dateCreated": {
|
|
965
|
-
"type": "string",
|
|
966
|
-
"description": "The date/time of when the document was created."
|
|
967
|
-
},
|
|
968
|
-
"dateModified": {
|
|
969
|
-
"type": "string",
|
|
970
|
-
"description": "The date/time of when the document was modified."
|
|
971
|
-
},
|
|
972
|
-
"dateDeleted": {
|
|
973
|
-
"type": "string",
|
|
974
|
-
"description": "The date/time of when the document was deleted, as we never actually remove items."
|
|
975
|
-
},
|
|
976
|
-
"nodeIdentity": {
|
|
977
|
-
"type": "string",
|
|
978
|
-
"description": "The node which added the document to the graph."
|
|
979
|
-
},
|
|
980
|
-
"userIdentity": {
|
|
981
|
-
"type": "string",
|
|
982
|
-
"description": "The user who added the document to the graph."
|
|
983
|
-
},
|
|
984
|
-
"revisions": {
|
|
985
|
-
"type": "array",
|
|
986
|
-
"items": {
|
|
987
|
-
"$ref": "#/components/schemas/Document"
|
|
988
|
-
},
|
|
989
|
-
"description": "The previous revisions of the document."
|
|
1180
|
+
]
|
|
990
1181
|
},
|
|
991
|
-
"
|
|
992
|
-
"type": "string",
|
|
993
|
-
"description": "The cursor to get the next chunk of revisions."
|
|
994
|
-
}
|
|
995
|
-
},
|
|
996
|
-
"required": [
|
|
997
|
-
"@context",
|
|
998
|
-
"type",
|
|
999
|
-
"id",
|
|
1000
|
-
"documentId",
|
|
1001
|
-
"documentCode",
|
|
1002
|
-
"documentRevision",
|
|
1003
|
-
"blobStorageId",
|
|
1004
|
-
"blobHash",
|
|
1005
|
-
"dateCreated",
|
|
1006
|
-
"nodeIdentity",
|
|
1007
|
-
"userIdentity"
|
|
1008
|
-
],
|
|
1009
|
-
"additionalProperties": false,
|
|
1010
|
-
"description": "Interface describing a document."
|
|
1011
|
-
},
|
|
1012
|
-
"DocumentList": {
|
|
1013
|
-
"type": "object",
|
|
1014
|
-
"properties": {
|
|
1015
|
-
"@context": {
|
|
1182
|
+
"edges": {
|
|
1016
1183
|
"type": "array",
|
|
1017
|
-
"
|
|
1018
|
-
"
|
|
1019
|
-
{
|
|
1020
|
-
"type": "string",
|
|
1021
|
-
"const": "https://schema.twindev.org/documents/"
|
|
1022
|
-
},
|
|
1184
|
+
"description": "The ids of the other vertices which are connected to the document.",
|
|
1185
|
+
"prefixItems": [
|
|
1023
1186
|
{
|
|
1024
|
-
"type": "string"
|
|
1025
|
-
"const": "https://schema.twindev.org/common/"
|
|
1187
|
+
"type": "string"
|
|
1026
1188
|
}
|
|
1027
|
-
]
|
|
1028
|
-
"additionalItems": {
|
|
1029
|
-
"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
|
|
1030
|
-
},
|
|
1031
|
-
"description": "JSON-LD Context."
|
|
1032
|
-
},
|
|
1033
|
-
"type": {
|
|
1034
|
-
"type": "string",
|
|
1035
|
-
"const": "DocumentList",
|
|
1036
|
-
"description": "JSON-LD Type."
|
|
1037
|
-
},
|
|
1038
|
-
"documents": {
|
|
1039
|
-
"type": "array",
|
|
1040
|
-
"items": {
|
|
1041
|
-
"$ref": "#/components/schemas/Document"
|
|
1042
|
-
},
|
|
1043
|
-
"description": "The list of documents."
|
|
1189
|
+
]
|
|
1044
1190
|
},
|
|
1045
|
-
"
|
|
1191
|
+
"nextItem": {
|
|
1046
1192
|
"type": "string",
|
|
1047
1193
|
"description": "The cursor to get the next chunk of documents."
|
|
1048
1194
|
}
|
|
@@ -1050,12 +1196,12 @@
|
|
|
1050
1196
|
"required": [
|
|
1051
1197
|
"@context",
|
|
1052
1198
|
"type",
|
|
1053
|
-
"
|
|
1199
|
+
"itemListElement"
|
|
1054
1200
|
],
|
|
1055
1201
|
"additionalProperties": false,
|
|
1056
1202
|
"description": "Interface describing a list of document entries."
|
|
1057
1203
|
},
|
|
1058
|
-
"
|
|
1204
|
+
"DocumentManagementCreateRequest": {
|
|
1059
1205
|
"type": "object",
|
|
1060
1206
|
"properties": {
|
|
1061
1207
|
"documentId": {
|
|
@@ -1074,18 +1220,42 @@
|
|
|
1074
1220
|
"description": "The data to create the document with, in base64."
|
|
1075
1221
|
},
|
|
1076
1222
|
"annotationObject": {
|
|
1077
|
-
"$ref": "
|
|
1223
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1224
|
+
},
|
|
1225
|
+
"auditableItemGraphEdges": {
|
|
1226
|
+
"type": "array",
|
|
1227
|
+
"description": "The auditable item graph vertices to connect the document to.",
|
|
1228
|
+
"prefixItems": [
|
|
1229
|
+
{
|
|
1230
|
+
"type": "object",
|
|
1231
|
+
"properties": {
|
|
1232
|
+
"id": {
|
|
1233
|
+
"type": "string"
|
|
1234
|
+
},
|
|
1235
|
+
"addAlias": {
|
|
1236
|
+
"type": "boolean"
|
|
1237
|
+
},
|
|
1238
|
+
"aliasAnnotationObject": {
|
|
1239
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1240
|
+
}
|
|
1241
|
+
},
|
|
1242
|
+
"required": [
|
|
1243
|
+
"id"
|
|
1244
|
+
],
|
|
1245
|
+
"additionalProperties": false
|
|
1246
|
+
}
|
|
1247
|
+
]
|
|
1078
1248
|
},
|
|
1079
1249
|
"createAttestation": {
|
|
1080
1250
|
"type": "boolean",
|
|
1081
|
-
"description": "Flag to create an attestation for the document, defaults to false"
|
|
1251
|
+
"description": "Flag to create an attestation for the document, defaults to false."
|
|
1082
1252
|
},
|
|
1083
|
-
"
|
|
1253
|
+
"addAlias": {
|
|
1084
1254
|
"type": "boolean",
|
|
1085
|
-
"description": "
|
|
1255
|
+
"description": "Flag to add the document id as an alias to the aig vertex, defaults to true."
|
|
1086
1256
|
},
|
|
1087
1257
|
"aliasAnnotationObject": {
|
|
1088
|
-
"$ref": "
|
|
1258
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1089
1259
|
}
|
|
1090
1260
|
},
|
|
1091
1261
|
"required": [
|
|
@@ -1096,6 +1266,44 @@
|
|
|
1096
1266
|
"additionalProperties": false,
|
|
1097
1267
|
"description": "The body parameters."
|
|
1098
1268
|
},
|
|
1269
|
+
"DocumentManagementUpdateRequest": {
|
|
1270
|
+
"type": "object",
|
|
1271
|
+
"properties": {
|
|
1272
|
+
"blob": {
|
|
1273
|
+
"type": "string",
|
|
1274
|
+
"description": "The data to create the document with, in base64."
|
|
1275
|
+
},
|
|
1276
|
+
"annotationObject": {
|
|
1277
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1278
|
+
},
|
|
1279
|
+
"auditableItemGraphEdges": {
|
|
1280
|
+
"type": "array",
|
|
1281
|
+
"description": "The auditable item graph vertices to connect the document to.",
|
|
1282
|
+
"prefixItems": [
|
|
1283
|
+
{
|
|
1284
|
+
"type": "object",
|
|
1285
|
+
"properties": {
|
|
1286
|
+
"id": {
|
|
1287
|
+
"type": "string"
|
|
1288
|
+
},
|
|
1289
|
+
"addAlias": {
|
|
1290
|
+
"type": "boolean"
|
|
1291
|
+
},
|
|
1292
|
+
"aliasAnnotationObject": {
|
|
1293
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1294
|
+
}
|
|
1295
|
+
},
|
|
1296
|
+
"required": [
|
|
1297
|
+
"id"
|
|
1298
|
+
],
|
|
1299
|
+
"additionalProperties": false
|
|
1300
|
+
}
|
|
1301
|
+
]
|
|
1302
|
+
}
|
|
1303
|
+
},
|
|
1304
|
+
"additionalProperties": false,
|
|
1305
|
+
"description": "The body parameters."
|
|
1306
|
+
},
|
|
1099
1307
|
"Error": {
|
|
1100
1308
|
"type": "object",
|
|
1101
1309
|
"properties": {
|
|
@@ -1131,1075 +1339,6 @@
|
|
|
1131
1339
|
"additionalProperties": false,
|
|
1132
1340
|
"description": "Model to describe serialized error."
|
|
1133
1341
|
},
|
|
1134
|
-
"JsonLdContainerType": {
|
|
1135
|
-
"type": "string",
|
|
1136
|
-
"enum": [
|
|
1137
|
-
"@language",
|
|
1138
|
-
"@index",
|
|
1139
|
-
"@id",
|
|
1140
|
-
"@graph",
|
|
1141
|
-
"@type"
|
|
1142
|
-
],
|
|
1143
|
-
"description": "Helper Types"
|
|
1144
|
-
},
|
|
1145
|
-
"JsonLdContainerTypeArray": {
|
|
1146
|
-
"anyOf": [
|
|
1147
|
-
{
|
|
1148
|
-
"type": "array",
|
|
1149
|
-
"minItems": 2,
|
|
1150
|
-
"items": [
|
|
1151
|
-
{
|
|
1152
|
-
"type": "string",
|
|
1153
|
-
"const": "@graph"
|
|
1154
|
-
},
|
|
1155
|
-
{
|
|
1156
|
-
"type": "string",
|
|
1157
|
-
"const": "@id"
|
|
1158
|
-
}
|
|
1159
|
-
],
|
|
1160
|
-
"maxItems": 2
|
|
1161
|
-
},
|
|
1162
|
-
{
|
|
1163
|
-
"type": "array",
|
|
1164
|
-
"minItems": 2,
|
|
1165
|
-
"items": [
|
|
1166
|
-
{
|
|
1167
|
-
"type": "string",
|
|
1168
|
-
"const": "@id"
|
|
1169
|
-
},
|
|
1170
|
-
{
|
|
1171
|
-
"type": "string",
|
|
1172
|
-
"const": "@graph"
|
|
1173
|
-
}
|
|
1174
|
-
],
|
|
1175
|
-
"maxItems": 2
|
|
1176
|
-
},
|
|
1177
|
-
{
|
|
1178
|
-
"type": "array",
|
|
1179
|
-
"minItems": 3,
|
|
1180
|
-
"items": [
|
|
1181
|
-
{
|
|
1182
|
-
"type": "string",
|
|
1183
|
-
"const": "@set"
|
|
1184
|
-
},
|
|
1185
|
-
{
|
|
1186
|
-
"type": "string",
|
|
1187
|
-
"const": "@graph"
|
|
1188
|
-
},
|
|
1189
|
-
{
|
|
1190
|
-
"type": "string",
|
|
1191
|
-
"const": "@id"
|
|
1192
|
-
}
|
|
1193
|
-
],
|
|
1194
|
-
"maxItems": 3
|
|
1195
|
-
},
|
|
1196
|
-
{
|
|
1197
|
-
"type": "array",
|
|
1198
|
-
"minItems": 3,
|
|
1199
|
-
"items": [
|
|
1200
|
-
{
|
|
1201
|
-
"type": "string",
|
|
1202
|
-
"const": "@set"
|
|
1203
|
-
},
|
|
1204
|
-
{
|
|
1205
|
-
"type": "string",
|
|
1206
|
-
"const": "@id"
|
|
1207
|
-
},
|
|
1208
|
-
{
|
|
1209
|
-
"type": "string",
|
|
1210
|
-
"const": "@graph"
|
|
1211
|
-
}
|
|
1212
|
-
],
|
|
1213
|
-
"maxItems": 3
|
|
1214
|
-
},
|
|
1215
|
-
{
|
|
1216
|
-
"type": "array",
|
|
1217
|
-
"minItems": 3,
|
|
1218
|
-
"items": [
|
|
1219
|
-
{
|
|
1220
|
-
"type": "string",
|
|
1221
|
-
"const": "@graph"
|
|
1222
|
-
},
|
|
1223
|
-
{
|
|
1224
|
-
"type": "string",
|
|
1225
|
-
"const": "@set"
|
|
1226
|
-
},
|
|
1227
|
-
{
|
|
1228
|
-
"type": "string",
|
|
1229
|
-
"const": "@id"
|
|
1230
|
-
}
|
|
1231
|
-
],
|
|
1232
|
-
"maxItems": 3
|
|
1233
|
-
},
|
|
1234
|
-
{
|
|
1235
|
-
"type": "array",
|
|
1236
|
-
"minItems": 3,
|
|
1237
|
-
"items": [
|
|
1238
|
-
{
|
|
1239
|
-
"type": "string",
|
|
1240
|
-
"const": "@id"
|
|
1241
|
-
},
|
|
1242
|
-
{
|
|
1243
|
-
"type": "string",
|
|
1244
|
-
"const": "@set"
|
|
1245
|
-
},
|
|
1246
|
-
{
|
|
1247
|
-
"type": "string",
|
|
1248
|
-
"const": "@graph"
|
|
1249
|
-
}
|
|
1250
|
-
],
|
|
1251
|
-
"maxItems": 3
|
|
1252
|
-
},
|
|
1253
|
-
{
|
|
1254
|
-
"type": "array",
|
|
1255
|
-
"minItems": 3,
|
|
1256
|
-
"items": [
|
|
1257
|
-
{
|
|
1258
|
-
"type": "string",
|
|
1259
|
-
"const": "@graph"
|
|
1260
|
-
},
|
|
1261
|
-
{
|
|
1262
|
-
"type": "string",
|
|
1263
|
-
"const": "@id"
|
|
1264
|
-
},
|
|
1265
|
-
{
|
|
1266
|
-
"type": "string",
|
|
1267
|
-
"const": "@set"
|
|
1268
|
-
}
|
|
1269
|
-
],
|
|
1270
|
-
"maxItems": 3
|
|
1271
|
-
},
|
|
1272
|
-
{
|
|
1273
|
-
"type": "array",
|
|
1274
|
-
"minItems": 3,
|
|
1275
|
-
"items": [
|
|
1276
|
-
{
|
|
1277
|
-
"type": "string",
|
|
1278
|
-
"const": "@id"
|
|
1279
|
-
},
|
|
1280
|
-
{
|
|
1281
|
-
"type": "string",
|
|
1282
|
-
"const": "@graph"
|
|
1283
|
-
},
|
|
1284
|
-
{
|
|
1285
|
-
"type": "string",
|
|
1286
|
-
"const": "@set"
|
|
1287
|
-
}
|
|
1288
|
-
],
|
|
1289
|
-
"maxItems": 3
|
|
1290
|
-
},
|
|
1291
|
-
{
|
|
1292
|
-
"type": "array",
|
|
1293
|
-
"minItems": 2,
|
|
1294
|
-
"items": [
|
|
1295
|
-
{
|
|
1296
|
-
"type": "string",
|
|
1297
|
-
"const": "@set"
|
|
1298
|
-
},
|
|
1299
|
-
{
|
|
1300
|
-
"$ref": "#/components/schemas/JsonLdContainerType"
|
|
1301
|
-
}
|
|
1302
|
-
],
|
|
1303
|
-
"maxItems": 2
|
|
1304
|
-
},
|
|
1305
|
-
{
|
|
1306
|
-
"type": "array",
|
|
1307
|
-
"minItems": 2,
|
|
1308
|
-
"items": [
|
|
1309
|
-
{
|
|
1310
|
-
"$ref": "#/components/schemas/JsonLdContainerType"
|
|
1311
|
-
},
|
|
1312
|
-
{
|
|
1313
|
-
"type": "string",
|
|
1314
|
-
"const": "@set"
|
|
1315
|
-
}
|
|
1316
|
-
],
|
|
1317
|
-
"maxItems": 2
|
|
1318
|
-
}
|
|
1319
|
-
],
|
|
1320
|
-
"description": "Helper Types."
|
|
1321
|
-
},
|
|
1322
|
-
"JsonLdContextDefinition": {
|
|
1323
|
-
"type": "object",
|
|
1324
|
-
"properties": {
|
|
1325
|
-
"@base": {
|
|
1326
|
-
"type": [
|
|
1327
|
-
"string",
|
|
1328
|
-
"null"
|
|
1329
|
-
]
|
|
1330
|
-
},
|
|
1331
|
-
"@direction": {
|
|
1332
|
-
"type": [
|
|
1333
|
-
"string",
|
|
1334
|
-
"null"
|
|
1335
|
-
],
|
|
1336
|
-
"enum": [
|
|
1337
|
-
"ltr",
|
|
1338
|
-
"rtl",
|
|
1339
|
-
null
|
|
1340
|
-
]
|
|
1341
|
-
},
|
|
1342
|
-
"@import": {
|
|
1343
|
-
"type": "string"
|
|
1344
|
-
},
|
|
1345
|
-
"@language": {
|
|
1346
|
-
"type": "string"
|
|
1347
|
-
},
|
|
1348
|
-
"@propagate": {
|
|
1349
|
-
"type": "boolean"
|
|
1350
|
-
},
|
|
1351
|
-
"@protected": {
|
|
1352
|
-
"type": "boolean"
|
|
1353
|
-
},
|
|
1354
|
-
"@type": {
|
|
1355
|
-
"type": "object",
|
|
1356
|
-
"properties": {
|
|
1357
|
-
"@container": {
|
|
1358
|
-
"type": "string",
|
|
1359
|
-
"const": "@set"
|
|
1360
|
-
},
|
|
1361
|
-
"@protected": {
|
|
1362
|
-
"type": "boolean"
|
|
1363
|
-
}
|
|
1364
|
-
},
|
|
1365
|
-
"required": [
|
|
1366
|
-
"@container"
|
|
1367
|
-
],
|
|
1368
|
-
"additionalProperties": false
|
|
1369
|
-
},
|
|
1370
|
-
"@version": {
|
|
1371
|
-
"type": "string",
|
|
1372
|
-
"const": "1.1"
|
|
1373
|
-
},
|
|
1374
|
-
"@vocab": {
|
|
1375
|
-
"type": [
|
|
1376
|
-
"string",
|
|
1377
|
-
"null"
|
|
1378
|
-
]
|
|
1379
|
-
}
|
|
1380
|
-
},
|
|
1381
|
-
"additionalProperties": {
|
|
1382
|
-
"anyOf": [
|
|
1383
|
-
{
|
|
1384
|
-
"type": "null"
|
|
1385
|
-
},
|
|
1386
|
-
{
|
|
1387
|
-
"type": "string"
|
|
1388
|
-
},
|
|
1389
|
-
{
|
|
1390
|
-
"$ref": "#/components/schemas/JsonLdExpandedTermDefinition"
|
|
1391
|
-
}
|
|
1392
|
-
]
|
|
1393
|
-
},
|
|
1394
|
-
"description": "A context definition defines a local context in a node object."
|
|
1395
|
-
},
|
|
1396
|
-
"JsonLdContextDefinitionElement": {
|
|
1397
|
-
"anyOf": [
|
|
1398
|
-
{
|
|
1399
|
-
"type": "null"
|
|
1400
|
-
},
|
|
1401
|
-
{
|
|
1402
|
-
"type": "string"
|
|
1403
|
-
},
|
|
1404
|
-
{
|
|
1405
|
-
"$ref": "#/components/schemas/JsonLdContextDefinition"
|
|
1406
|
-
}
|
|
1407
|
-
],
|
|
1408
|
-
"description": "A context definition element is used to define the types of a context definition."
|
|
1409
|
-
},
|
|
1410
|
-
"JsonLdContextDefinitionRoot": {
|
|
1411
|
-
"anyOf": [
|
|
1412
|
-
{
|
|
1413
|
-
"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
|
|
1414
|
-
},
|
|
1415
|
-
{
|
|
1416
|
-
"type": "array",
|
|
1417
|
-
"items": {
|
|
1418
|
-
"$ref": "#/components/schemas/JsonLdContextDefinitionElement"
|
|
1419
|
-
}
|
|
1420
|
-
}
|
|
1421
|
-
],
|
|
1422
|
-
"description": "A context definition root is used to define the root of a context definition."
|
|
1423
|
-
},
|
|
1424
|
-
"JsonLdExpandedTermDefinition": {
|
|
1425
|
-
"anyOf": [
|
|
1426
|
-
{
|
|
1427
|
-
"type": "object",
|
|
1428
|
-
"additionalProperties": false,
|
|
1429
|
-
"properties": {
|
|
1430
|
-
"@id": {
|
|
1431
|
-
"anyOf": [
|
|
1432
|
-
{
|
|
1433
|
-
"type": "string"
|
|
1434
|
-
},
|
|
1435
|
-
{
|
|
1436
|
-
"type": "array",
|
|
1437
|
-
"items": {
|
|
1438
|
-
"type": "string"
|
|
1439
|
-
}
|
|
1440
|
-
},
|
|
1441
|
-
{
|
|
1442
|
-
"type": "null"
|
|
1443
|
-
}
|
|
1444
|
-
]
|
|
1445
|
-
},
|
|
1446
|
-
"@nest": {
|
|
1447
|
-
"type": "string"
|
|
1448
|
-
},
|
|
1449
|
-
"@container": {
|
|
1450
|
-
"anyOf": [
|
|
1451
|
-
{
|
|
1452
|
-
"type": "string",
|
|
1453
|
-
"const": "@list"
|
|
1454
|
-
},
|
|
1455
|
-
{
|
|
1456
|
-
"type": "string",
|
|
1457
|
-
"const": "@set"
|
|
1458
|
-
},
|
|
1459
|
-
{
|
|
1460
|
-
"$ref": "#/components/schemas/JsonLdContainerType"
|
|
1461
|
-
},
|
|
1462
|
-
{
|
|
1463
|
-
"type": "array",
|
|
1464
|
-
"items": {
|
|
1465
|
-
"anyOf": [
|
|
1466
|
-
{
|
|
1467
|
-
"type": "string",
|
|
1468
|
-
"const": "@list"
|
|
1469
|
-
},
|
|
1470
|
-
{
|
|
1471
|
-
"type": "string",
|
|
1472
|
-
"const": "@set"
|
|
1473
|
-
},
|
|
1474
|
-
{
|
|
1475
|
-
"$ref": "#/components/schemas/JsonLdContainerType"
|
|
1476
|
-
}
|
|
1477
|
-
]
|
|
1478
|
-
}
|
|
1479
|
-
},
|
|
1480
|
-
{
|
|
1481
|
-
"$ref": "#/components/schemas/JsonLdContainerTypeArray"
|
|
1482
|
-
},
|
|
1483
|
-
{
|
|
1484
|
-
"type": "null"
|
|
1485
|
-
}
|
|
1486
|
-
]
|
|
1487
|
-
},
|
|
1488
|
-
"@type": {
|
|
1489
|
-
"type": "string"
|
|
1490
|
-
},
|
|
1491
|
-
"@language": {
|
|
1492
|
-
"type": "string"
|
|
1493
|
-
},
|
|
1494
|
-
"@index": {
|
|
1495
|
-
"type": "string"
|
|
1496
|
-
},
|
|
1497
|
-
"@context": {
|
|
1498
|
-
"$ref": "#/components/schemas/JsonLdContextDefinition"
|
|
1499
|
-
},
|
|
1500
|
-
"@prefix": {
|
|
1501
|
-
"type": "boolean"
|
|
1502
|
-
},
|
|
1503
|
-
"@propagate": {
|
|
1504
|
-
"type": "boolean"
|
|
1505
|
-
},
|
|
1506
|
-
"@protected": {
|
|
1507
|
-
"type": "boolean"
|
|
1508
|
-
}
|
|
1509
|
-
}
|
|
1510
|
-
},
|
|
1511
|
-
{
|
|
1512
|
-
"type": "object",
|
|
1513
|
-
"additionalProperties": false,
|
|
1514
|
-
"properties": {
|
|
1515
|
-
"@reverse": {
|
|
1516
|
-
"type": "string"
|
|
1517
|
-
},
|
|
1518
|
-
"@container": {
|
|
1519
|
-
"type": [
|
|
1520
|
-
"string",
|
|
1521
|
-
"null"
|
|
1522
|
-
],
|
|
1523
|
-
"enum": [
|
|
1524
|
-
"@set",
|
|
1525
|
-
"@index",
|
|
1526
|
-
null
|
|
1527
|
-
]
|
|
1528
|
-
},
|
|
1529
|
-
"@type": {
|
|
1530
|
-
"type": "string"
|
|
1531
|
-
},
|
|
1532
|
-
"@language": {
|
|
1533
|
-
"type": "string"
|
|
1534
|
-
},
|
|
1535
|
-
"@index": {
|
|
1536
|
-
"type": "string"
|
|
1537
|
-
},
|
|
1538
|
-
"@context": {
|
|
1539
|
-
"$ref": "#/components/schemas/JsonLdContextDefinition"
|
|
1540
|
-
},
|
|
1541
|
-
"@prefix": {
|
|
1542
|
-
"type": "boolean"
|
|
1543
|
-
},
|
|
1544
|
-
"@propagate": {
|
|
1545
|
-
"type": "boolean"
|
|
1546
|
-
},
|
|
1547
|
-
"@protected": {
|
|
1548
|
-
"type": "boolean"
|
|
1549
|
-
}
|
|
1550
|
-
},
|
|
1551
|
-
"required": [
|
|
1552
|
-
"@reverse"
|
|
1553
|
-
]
|
|
1554
|
-
}
|
|
1555
|
-
],
|
|
1556
|
-
"description": "An expanded term definition is used to describe the mapping between a term and its expanded identifier, as well as other properties of the value associated with the term when it is used as key in a node object."
|
|
1557
|
-
},
|
|
1558
|
-
"JsonLdGraphObject": {
|
|
1559
|
-
"type": "object",
|
|
1560
|
-
"properties": {
|
|
1561
|
-
"@graph": {
|
|
1562
|
-
"anyOf": [
|
|
1563
|
-
{
|
|
1564
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1565
|
-
},
|
|
1566
|
-
{
|
|
1567
|
-
"type": "array",
|
|
1568
|
-
"items": {
|
|
1569
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1570
|
-
}
|
|
1571
|
-
}
|
|
1572
|
-
]
|
|
1573
|
-
},
|
|
1574
|
-
"@index": {
|
|
1575
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
1576
|
-
},
|
|
1577
|
-
"@id": {
|
|
1578
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
1579
|
-
},
|
|
1580
|
-
"@context": {
|
|
1581
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
1582
|
-
}
|
|
1583
|
-
},
|
|
1584
|
-
"required": [
|
|
1585
|
-
"@graph"
|
|
1586
|
-
],
|
|
1587
|
-
"additionalProperties": false,
|
|
1588
|
-
"description": "A graph object represents a named graph, which MAY include an explicit graph name."
|
|
1589
|
-
},
|
|
1590
|
-
"JsonLdIdMap": {
|
|
1591
|
-
"type": "object",
|
|
1592
|
-
"additionalProperties": {
|
|
1593
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1594
|
-
},
|
|
1595
|
-
"description": "An id map is used to associate an IRI with a value that allows easy programmatic access."
|
|
1596
|
-
},
|
|
1597
|
-
"JsonLdIncludedBlock": {
|
|
1598
|
-
"anyOf": [
|
|
1599
|
-
{
|
|
1600
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1601
|
-
},
|
|
1602
|
-
{
|
|
1603
|
-
"type": "array",
|
|
1604
|
-
"items": {
|
|
1605
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1606
|
-
}
|
|
1607
|
-
}
|
|
1608
|
-
],
|
|
1609
|
-
"description": "An included block is used to provide a set of node objects."
|
|
1610
|
-
},
|
|
1611
|
-
"JsonLdIndexMap": {
|
|
1612
|
-
"type": "object",
|
|
1613
|
-
"additionalProperties": {
|
|
1614
|
-
"anyOf": [
|
|
1615
|
-
{
|
|
1616
|
-
"$ref": "#/components/schemas/JsonLdIndexMapItem"
|
|
1617
|
-
},
|
|
1618
|
-
{
|
|
1619
|
-
"type": "array",
|
|
1620
|
-
"items": {
|
|
1621
|
-
"$ref": "#/components/schemas/JsonLdIndexMapItem"
|
|
1622
|
-
}
|
|
1623
|
-
}
|
|
1624
|
-
]
|
|
1625
|
-
},
|
|
1626
|
-
"description": "An index map allows keys that have no semantic meaning, but should be preserved regardless, to be used in JSON-LD documents."
|
|
1627
|
-
},
|
|
1628
|
-
"JsonLdIndexMapItem": {
|
|
1629
|
-
"anyOf": [
|
|
1630
|
-
{
|
|
1631
|
-
"type": "null"
|
|
1632
|
-
},
|
|
1633
|
-
{
|
|
1634
|
-
"type": "boolean"
|
|
1635
|
-
},
|
|
1636
|
-
{
|
|
1637
|
-
"type": "number"
|
|
1638
|
-
},
|
|
1639
|
-
{
|
|
1640
|
-
"type": "string"
|
|
1641
|
-
},
|
|
1642
|
-
{
|
|
1643
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1644
|
-
},
|
|
1645
|
-
{
|
|
1646
|
-
"$ref": "#/components/schemas/JsonLdValueObject"
|
|
1647
|
-
},
|
|
1648
|
-
{
|
|
1649
|
-
"$ref": "#/components/schemas/JsonLdListObject"
|
|
1650
|
-
},
|
|
1651
|
-
{
|
|
1652
|
-
"$ref": "#/components/schemas/JsonLdSetObject"
|
|
1653
|
-
}
|
|
1654
|
-
],
|
|
1655
|
-
"description": "The items that can be stored in an index map."
|
|
1656
|
-
},
|
|
1657
|
-
"JsonLdJsonArray": {
|
|
1658
|
-
"type": "array",
|
|
1659
|
-
"items": {
|
|
1660
|
-
"$ref": "#/components/schemas/JsonLdJsonValue"
|
|
1661
|
-
},
|
|
1662
|
-
"description": "JSON Type for array."
|
|
1663
|
-
},
|
|
1664
|
-
"JsonLdJsonObject": {
|
|
1665
|
-
"type": "object",
|
|
1666
|
-
"additionalProperties": {
|
|
1667
|
-
"anyOf": [
|
|
1668
|
-
{
|
|
1669
|
-
"$ref": "#/components/schemas/JsonLdJsonValue"
|
|
1670
|
-
},
|
|
1671
|
-
{
|
|
1672
|
-
"not": {}
|
|
1673
|
-
}
|
|
1674
|
-
]
|
|
1675
|
-
},
|
|
1676
|
-
"description": "JSON Type for object."
|
|
1677
|
-
},
|
|
1678
|
-
"JsonLdJsonPrimitive": {
|
|
1679
|
-
"type": [
|
|
1680
|
-
"string",
|
|
1681
|
-
"number",
|
|
1682
|
-
"boolean",
|
|
1683
|
-
"null"
|
|
1684
|
-
],
|
|
1685
|
-
"description": "JSON Primitive."
|
|
1686
|
-
},
|
|
1687
|
-
"JsonLdJsonValue": {
|
|
1688
|
-
"anyOf": [
|
|
1689
|
-
{
|
|
1690
|
-
"$ref": "#/components/schemas/JsonLdJsonPrimitive"
|
|
1691
|
-
},
|
|
1692
|
-
{
|
|
1693
|
-
"$ref": "#/components/schemas/JsonLdJsonArray"
|
|
1694
|
-
},
|
|
1695
|
-
{
|
|
1696
|
-
"$ref": "#/components/schemas/JsonLdJsonObject"
|
|
1697
|
-
}
|
|
1698
|
-
],
|
|
1699
|
-
"description": "JSON Value."
|
|
1700
|
-
},
|
|
1701
|
-
"JsonLdKeyword": {
|
|
1702
|
-
"type": "object",
|
|
1703
|
-
"properties": {
|
|
1704
|
-
"@base": {
|
|
1705
|
-
"type": [
|
|
1706
|
-
"string",
|
|
1707
|
-
"null"
|
|
1708
|
-
]
|
|
1709
|
-
},
|
|
1710
|
-
"@container": {
|
|
1711
|
-
"anyOf": [
|
|
1712
|
-
{
|
|
1713
|
-
"type": "string",
|
|
1714
|
-
"const": "@list"
|
|
1715
|
-
},
|
|
1716
|
-
{
|
|
1717
|
-
"type": "string",
|
|
1718
|
-
"const": "@set"
|
|
1719
|
-
},
|
|
1720
|
-
{
|
|
1721
|
-
"$ref": "#/components/schemas/JsonLdContainerType"
|
|
1722
|
-
},
|
|
1723
|
-
{
|
|
1724
|
-
"type": "array",
|
|
1725
|
-
"items": {
|
|
1726
|
-
"anyOf": [
|
|
1727
|
-
{
|
|
1728
|
-
"type": "string",
|
|
1729
|
-
"const": "@list"
|
|
1730
|
-
},
|
|
1731
|
-
{
|
|
1732
|
-
"type": "string",
|
|
1733
|
-
"const": "@set"
|
|
1734
|
-
},
|
|
1735
|
-
{
|
|
1736
|
-
"$ref": "#/components/schemas/JsonLdContainerType"
|
|
1737
|
-
}
|
|
1738
|
-
]
|
|
1739
|
-
}
|
|
1740
|
-
},
|
|
1741
|
-
{
|
|
1742
|
-
"$ref": "#/components/schemas/JsonLdContainerTypeArray"
|
|
1743
|
-
},
|
|
1744
|
-
{
|
|
1745
|
-
"type": "null"
|
|
1746
|
-
}
|
|
1747
|
-
]
|
|
1748
|
-
},
|
|
1749
|
-
"@context": {
|
|
1750
|
-
"$ref": "#/components/schemas/JsonLdContextDefinitionRoot"
|
|
1751
|
-
},
|
|
1752
|
-
"@direction": {
|
|
1753
|
-
"type": [
|
|
1754
|
-
"string",
|
|
1755
|
-
"null"
|
|
1756
|
-
],
|
|
1757
|
-
"enum": [
|
|
1758
|
-
"ltr",
|
|
1759
|
-
"rtl",
|
|
1760
|
-
null
|
|
1761
|
-
]
|
|
1762
|
-
},
|
|
1763
|
-
"@graph": {
|
|
1764
|
-
"anyOf": [
|
|
1765
|
-
{
|
|
1766
|
-
"$ref": "#/components/schemas/JsonLdValueObject"
|
|
1767
|
-
},
|
|
1768
|
-
{
|
|
1769
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1770
|
-
},
|
|
1771
|
-
{
|
|
1772
|
-
"type": "array",
|
|
1773
|
-
"items": {
|
|
1774
|
-
"anyOf": [
|
|
1775
|
-
{
|
|
1776
|
-
"$ref": "#/components/schemas/JsonLdValueObject"
|
|
1777
|
-
},
|
|
1778
|
-
{
|
|
1779
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1780
|
-
}
|
|
1781
|
-
]
|
|
1782
|
-
}
|
|
1783
|
-
}
|
|
1784
|
-
]
|
|
1785
|
-
},
|
|
1786
|
-
"@id": {
|
|
1787
|
-
"anyOf": [
|
|
1788
|
-
{
|
|
1789
|
-
"type": "string"
|
|
1790
|
-
},
|
|
1791
|
-
{
|
|
1792
|
-
"type": "array",
|
|
1793
|
-
"items": {
|
|
1794
|
-
"type": "string"
|
|
1795
|
-
}
|
|
1796
|
-
}
|
|
1797
|
-
]
|
|
1798
|
-
},
|
|
1799
|
-
"@import": {
|
|
1800
|
-
"type": "string"
|
|
1801
|
-
},
|
|
1802
|
-
"@included": {
|
|
1803
|
-
"$ref": "#/components/schemas/JsonLdIncludedBlock"
|
|
1804
|
-
},
|
|
1805
|
-
"@index": {
|
|
1806
|
-
"type": "string"
|
|
1807
|
-
},
|
|
1808
|
-
"@json": {
|
|
1809
|
-
"type": "string",
|
|
1810
|
-
"const": "@json"
|
|
1811
|
-
},
|
|
1812
|
-
"@language": {
|
|
1813
|
-
"type": "string"
|
|
1814
|
-
},
|
|
1815
|
-
"@list": {
|
|
1816
|
-
"anyOf": [
|
|
1817
|
-
{
|
|
1818
|
-
"$ref": "#/components/schemas/JsonLdListOrSetItem"
|
|
1819
|
-
},
|
|
1820
|
-
{
|
|
1821
|
-
"type": "array",
|
|
1822
|
-
"items": {
|
|
1823
|
-
"$ref": "#/components/schemas/JsonLdListOrSetItem"
|
|
1824
|
-
}
|
|
1825
|
-
}
|
|
1826
|
-
]
|
|
1827
|
-
},
|
|
1828
|
-
"@nest": {
|
|
1829
|
-
"type": "object"
|
|
1830
|
-
},
|
|
1831
|
-
"@none": {
|
|
1832
|
-
"type": "string",
|
|
1833
|
-
"const": "@none"
|
|
1834
|
-
},
|
|
1835
|
-
"@prefix": {
|
|
1836
|
-
"type": "boolean"
|
|
1837
|
-
},
|
|
1838
|
-
"@propagate": {
|
|
1839
|
-
"type": "boolean"
|
|
1840
|
-
},
|
|
1841
|
-
"@protected": {
|
|
1842
|
-
"type": "boolean"
|
|
1843
|
-
},
|
|
1844
|
-
"@reverse": {
|
|
1845
|
-
"type": "string"
|
|
1846
|
-
},
|
|
1847
|
-
"@set": {
|
|
1848
|
-
"anyOf": [
|
|
1849
|
-
{
|
|
1850
|
-
"$ref": "#/components/schemas/JsonLdListOrSetItem"
|
|
1851
|
-
},
|
|
1852
|
-
{
|
|
1853
|
-
"type": "array",
|
|
1854
|
-
"items": {
|
|
1855
|
-
"$ref": "#/components/schemas/JsonLdListOrSetItem"
|
|
1856
|
-
}
|
|
1857
|
-
}
|
|
1858
|
-
]
|
|
1859
|
-
},
|
|
1860
|
-
"@type": {
|
|
1861
|
-
"type": "string"
|
|
1862
|
-
},
|
|
1863
|
-
"@value": {
|
|
1864
|
-
"type": [
|
|
1865
|
-
"null",
|
|
1866
|
-
"boolean",
|
|
1867
|
-
"number",
|
|
1868
|
-
"string"
|
|
1869
|
-
]
|
|
1870
|
-
},
|
|
1871
|
-
"@version": {
|
|
1872
|
-
"type": "string",
|
|
1873
|
-
"const": "1.1"
|
|
1874
|
-
},
|
|
1875
|
-
"@vocab": {
|
|
1876
|
-
"type": [
|
|
1877
|
-
"string",
|
|
1878
|
-
"null"
|
|
1879
|
-
]
|
|
1880
|
-
}
|
|
1881
|
-
},
|
|
1882
|
-
"required": [
|
|
1883
|
-
"@base",
|
|
1884
|
-
"@container",
|
|
1885
|
-
"@context",
|
|
1886
|
-
"@direction",
|
|
1887
|
-
"@graph",
|
|
1888
|
-
"@id",
|
|
1889
|
-
"@import",
|
|
1890
|
-
"@included",
|
|
1891
|
-
"@index",
|
|
1892
|
-
"@json",
|
|
1893
|
-
"@language",
|
|
1894
|
-
"@list",
|
|
1895
|
-
"@nest",
|
|
1896
|
-
"@none",
|
|
1897
|
-
"@prefix",
|
|
1898
|
-
"@propagate",
|
|
1899
|
-
"@protected",
|
|
1900
|
-
"@reverse",
|
|
1901
|
-
"@set",
|
|
1902
|
-
"@type",
|
|
1903
|
-
"@value",
|
|
1904
|
-
"@version",
|
|
1905
|
-
"@vocab"
|
|
1906
|
-
],
|
|
1907
|
-
"additionalProperties": false,
|
|
1908
|
-
"description": "A list of keywords and their types. Only used for internal reference; not an actual interface. Not for export."
|
|
1909
|
-
},
|
|
1910
|
-
"JsonLdLanguageMap": {
|
|
1911
|
-
"type": "object",
|
|
1912
|
-
"additionalProperties": {
|
|
1913
|
-
"anyOf": [
|
|
1914
|
-
{
|
|
1915
|
-
"type": "null"
|
|
1916
|
-
},
|
|
1917
|
-
{
|
|
1918
|
-
"type": "string"
|
|
1919
|
-
},
|
|
1920
|
-
{
|
|
1921
|
-
"type": "array",
|
|
1922
|
-
"items": {
|
|
1923
|
-
"type": "string"
|
|
1924
|
-
}
|
|
1925
|
-
}
|
|
1926
|
-
]
|
|
1927
|
-
},
|
|
1928
|
-
"description": "A language map is used to associate a language with a value in a way that allows easy programmatic access."
|
|
1929
|
-
},
|
|
1930
|
-
"JsonLdListObject": {
|
|
1931
|
-
"type": "object",
|
|
1932
|
-
"properties": {
|
|
1933
|
-
"@list": {
|
|
1934
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
1935
|
-
},
|
|
1936
|
-
"@index": {
|
|
1937
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
1938
|
-
}
|
|
1939
|
-
},
|
|
1940
|
-
"required": [
|
|
1941
|
-
"@list"
|
|
1942
|
-
],
|
|
1943
|
-
"additionalProperties": false,
|
|
1944
|
-
"description": "A list represents an ordered set of values."
|
|
1945
|
-
},
|
|
1946
|
-
"JsonLdListOrSetItem": {
|
|
1947
|
-
"anyOf": [
|
|
1948
|
-
{
|
|
1949
|
-
"type": "null"
|
|
1950
|
-
},
|
|
1951
|
-
{
|
|
1952
|
-
"type": "boolean"
|
|
1953
|
-
},
|
|
1954
|
-
{
|
|
1955
|
-
"type": "number"
|
|
1956
|
-
},
|
|
1957
|
-
{
|
|
1958
|
-
"type": "string"
|
|
1959
|
-
},
|
|
1960
|
-
{
|
|
1961
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
1962
|
-
},
|
|
1963
|
-
{
|
|
1964
|
-
"$ref": "#/components/schemas/JsonLdValueObject"
|
|
1965
|
-
}
|
|
1966
|
-
],
|
|
1967
|
-
"description": "A list or set item can be a null, boolean, number, string, node object, or value object."
|
|
1968
|
-
},
|
|
1969
|
-
"JsonLdNodeObject": {
|
|
1970
|
-
"type": "object",
|
|
1971
|
-
"additionalProperties": {
|
|
1972
|
-
"anyOf": [
|
|
1973
|
-
{
|
|
1974
|
-
"$ref": "#/components/schemas/JsonLdNodePrimitive"
|
|
1975
|
-
},
|
|
1976
|
-
{
|
|
1977
|
-
"$ref": "#/components/schemas/JsonLdLanguageMap"
|
|
1978
|
-
},
|
|
1979
|
-
{
|
|
1980
|
-
"$ref": "#/components/schemas/JsonLdIndexMap"
|
|
1981
|
-
},
|
|
1982
|
-
{
|
|
1983
|
-
"$ref": "#/components/schemas/JsonLdIncludedBlock"
|
|
1984
|
-
},
|
|
1985
|
-
{
|
|
1986
|
-
"$ref": "#/components/schemas/JsonLdIdMap"
|
|
1987
|
-
},
|
|
1988
|
-
{
|
|
1989
|
-
"$ref": "#/components/schemas/JsonLdTypeMap"
|
|
1990
|
-
},
|
|
1991
|
-
{
|
|
1992
|
-
"type": "array"
|
|
1993
|
-
}
|
|
1994
|
-
]
|
|
1995
|
-
},
|
|
1996
|
-
"properties": {
|
|
1997
|
-
"@context": {
|
|
1998
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
1999
|
-
},
|
|
2000
|
-
"@id": {
|
|
2001
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2002
|
-
},
|
|
2003
|
-
"@included": {
|
|
2004
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2005
|
-
},
|
|
2006
|
-
"@graph": {
|
|
2007
|
-
"anyOf": [
|
|
2008
|
-
{
|
|
2009
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
2010
|
-
},
|
|
2011
|
-
{
|
|
2012
|
-
"type": "array",
|
|
2013
|
-
"items": {
|
|
2014
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
2015
|
-
}
|
|
2016
|
-
}
|
|
2017
|
-
]
|
|
2018
|
-
},
|
|
2019
|
-
"@nest": {
|
|
2020
|
-
"anyOf": [
|
|
2021
|
-
{
|
|
2022
|
-
"$ref": "#/components/schemas/JsonLdJsonObject"
|
|
2023
|
-
},
|
|
2024
|
-
{
|
|
2025
|
-
"type": "array",
|
|
2026
|
-
"items": {
|
|
2027
|
-
"$ref": "#/components/schemas/JsonLdJsonObject"
|
|
2028
|
-
}
|
|
2029
|
-
}
|
|
2030
|
-
]
|
|
2031
|
-
},
|
|
2032
|
-
"@type": {
|
|
2033
|
-
"anyOf": [
|
|
2034
|
-
{
|
|
2035
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2036
|
-
},
|
|
2037
|
-
{
|
|
2038
|
-
"type": "array",
|
|
2039
|
-
"items": {
|
|
2040
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2041
|
-
}
|
|
2042
|
-
}
|
|
2043
|
-
]
|
|
2044
|
-
},
|
|
2045
|
-
"@reverse": {
|
|
2046
|
-
"type": "object",
|
|
2047
|
-
"additionalProperties": {
|
|
2048
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2049
|
-
}
|
|
2050
|
-
},
|
|
2051
|
-
"@index": {
|
|
2052
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2053
|
-
}
|
|
2054
|
-
},
|
|
2055
|
-
"description": "A node object represents zero or more properties of a node in the graph serialized by the JSON-LD document."
|
|
2056
|
-
},
|
|
2057
|
-
"JsonLdNodePrimitive": {
|
|
2058
|
-
"anyOf": [
|
|
2059
|
-
{
|
|
2060
|
-
"type": "null"
|
|
2061
|
-
},
|
|
2062
|
-
{
|
|
2063
|
-
"type": "boolean"
|
|
2064
|
-
},
|
|
2065
|
-
{
|
|
2066
|
-
"type": "number"
|
|
2067
|
-
},
|
|
2068
|
-
{
|
|
2069
|
-
"type": "string"
|
|
2070
|
-
},
|
|
2071
|
-
{
|
|
2072
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
2073
|
-
},
|
|
2074
|
-
{
|
|
2075
|
-
"$ref": "#/components/schemas/JsonLdGraphObject"
|
|
2076
|
-
},
|
|
2077
|
-
{
|
|
2078
|
-
"$ref": "#/components/schemas/JsonLdValueObject"
|
|
2079
|
-
},
|
|
2080
|
-
{
|
|
2081
|
-
"$ref": "#/components/schemas/JsonLdListObject"
|
|
2082
|
-
},
|
|
2083
|
-
{
|
|
2084
|
-
"$ref": "#/components/schemas/JsonLdSetObject"
|
|
2085
|
-
}
|
|
2086
|
-
],
|
|
2087
|
-
"description": "A node primitive is a JSON-LD value which is not one of the defined NodeObject properties."
|
|
2088
|
-
},
|
|
2089
|
-
"JsonLdSetObject": {
|
|
2090
|
-
"type": "object",
|
|
2091
|
-
"properties": {
|
|
2092
|
-
"@set": {
|
|
2093
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2094
|
-
},
|
|
2095
|
-
"@index": {
|
|
2096
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2097
|
-
}
|
|
2098
|
-
},
|
|
2099
|
-
"required": [
|
|
2100
|
-
"@set"
|
|
2101
|
-
],
|
|
2102
|
-
"additionalProperties": false,
|
|
2103
|
-
"description": "A set represents an unordered set of values."
|
|
2104
|
-
},
|
|
2105
|
-
"JsonLdTypeMap": {
|
|
2106
|
-
"type": "object",
|
|
2107
|
-
"additionalProperties": {
|
|
2108
|
-
"anyOf": [
|
|
2109
|
-
{
|
|
2110
|
-
"type": "string"
|
|
2111
|
-
},
|
|
2112
|
-
{
|
|
2113
|
-
"$ref": "#/components/schemas/JsonLdNodeObject"
|
|
2114
|
-
}
|
|
2115
|
-
]
|
|
2116
|
-
},
|
|
2117
|
-
"description": "A type map is used to associate an IRI with a value that allows easy programmatic access."
|
|
2118
|
-
},
|
|
2119
|
-
"JsonLdValueObject": {
|
|
2120
|
-
"anyOf": [
|
|
2121
|
-
{
|
|
2122
|
-
"type": "object",
|
|
2123
|
-
"additionalProperties": false,
|
|
2124
|
-
"properties": {
|
|
2125
|
-
"@value": {
|
|
2126
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2127
|
-
},
|
|
2128
|
-
"@language": {
|
|
2129
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2130
|
-
},
|
|
2131
|
-
"@direction": {
|
|
2132
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2133
|
-
},
|
|
2134
|
-
"@index": {
|
|
2135
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2136
|
-
},
|
|
2137
|
-
"@context": {
|
|
2138
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2139
|
-
}
|
|
2140
|
-
},
|
|
2141
|
-
"required": [
|
|
2142
|
-
"@value"
|
|
2143
|
-
]
|
|
2144
|
-
},
|
|
2145
|
-
{
|
|
2146
|
-
"type": "object",
|
|
2147
|
-
"additionalProperties": false,
|
|
2148
|
-
"properties": {
|
|
2149
|
-
"@value": {
|
|
2150
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2151
|
-
},
|
|
2152
|
-
"@type": {
|
|
2153
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2154
|
-
},
|
|
2155
|
-
"@index": {
|
|
2156
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2157
|
-
},
|
|
2158
|
-
"@context": {
|
|
2159
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2160
|
-
}
|
|
2161
|
-
},
|
|
2162
|
-
"required": [
|
|
2163
|
-
"@type",
|
|
2164
|
-
"@value"
|
|
2165
|
-
]
|
|
2166
|
-
},
|
|
2167
|
-
{
|
|
2168
|
-
"type": "object",
|
|
2169
|
-
"additionalProperties": false,
|
|
2170
|
-
"properties": {
|
|
2171
|
-
"@value": {
|
|
2172
|
-
"anyOf": [
|
|
2173
|
-
{
|
|
2174
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2175
|
-
},
|
|
2176
|
-
{
|
|
2177
|
-
"$ref": "#/components/schemas/JsonLdJsonObject"
|
|
2178
|
-
},
|
|
2179
|
-
{
|
|
2180
|
-
"$ref": "#/components/schemas/JsonLdJsonArray"
|
|
2181
|
-
}
|
|
2182
|
-
]
|
|
2183
|
-
},
|
|
2184
|
-
"@type": {
|
|
2185
|
-
"type": "string",
|
|
2186
|
-
"const": "@json"
|
|
2187
|
-
},
|
|
2188
|
-
"@index": {
|
|
2189
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2190
|
-
},
|
|
2191
|
-
"@context": {
|
|
2192
|
-
"$ref": "#/components/schemas/JsonLdKeyword"
|
|
2193
|
-
}
|
|
2194
|
-
},
|
|
2195
|
-
"required": [
|
|
2196
|
-
"@type",
|
|
2197
|
-
"@value"
|
|
2198
|
-
]
|
|
2199
|
-
}
|
|
2200
|
-
],
|
|
2201
|
-
"description": "A value object is used to explicitly associate a type or a language with a value to create a typed value or a language-tagged string and possibly associate a base direction."
|
|
2202
|
-
},
|
|
2203
1342
|
"NotFoundResponse": {
|
|
2204
1343
|
"type": "object",
|
|
2205
1344
|
"additionalProperties": false,
|