@twin.org/auditable-item-stream-service 0.0.3-next.9 → 0.9.0
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/README.md +2 -2
- package/dist/es/auditableItemStreamRoutes.js +401 -73
- package/dist/es/auditableItemStreamRoutes.js.map +1 -1
- package/dist/es/auditableItemStreamService.js +304 -113
- package/dist/es/auditableItemStreamService.js.map +1 -1
- package/dist/es/entities/auditableItemStream.js +17 -3
- package/dist/es/entities/auditableItemStream.js.map +1 -1
- package/dist/es/models/IAuditableItemStreamServiceConfig.js.map +1 -1
- package/dist/es/models/IAuditableItemStreamServiceConstructorOptions.js.map +1 -1
- package/dist/es/models/IAuditableItemStreamServiceContext.js.map +1 -1
- package/dist/es/restEntryPoints.js +3 -0
- package/dist/es/restEntryPoints.js.map +1 -1
- package/dist/types/auditableItemStreamRoutes.d.ts +37 -5
- package/dist/types/auditableItemStreamService.d.ts +37 -38
- package/dist/types/entities/auditableItemStream.d.ts +10 -1
- package/dist/types/models/IAuditableItemStreamServiceConfig.d.ts +4 -0
- package/dist/types/models/IAuditableItemStreamServiceConstructorOptions.d.ts +4 -0
- package/dist/types/models/IAuditableItemStreamServiceContext.d.ts +4 -0
- package/dist/types/restEntryPoints.d.ts +3 -0
- package/docs/changelog.md +396 -92
- package/docs/examples.md +211 -1
- package/docs/open-api/spec.json +832 -169
- package/docs/reference/classes/AuditableItemStream.md +30 -14
- package/docs/reference/classes/AuditableItemStreamEntry.md +13 -13
- package/docs/reference/classes/AuditableItemStreamService.md +109 -84
- package/docs/reference/functions/auditableItemStreamClose.md +31 -0
- package/docs/reference/functions/auditableItemStreamDeleteEntry.md +1 -1
- package/docs/reference/functions/auditableItemStreamList.md +1 -1
- package/docs/reference/functions/auditableItemStreamListEntries.md +1 -1
- package/docs/reference/functions/auditableItemStreamListEntriesNoStream.md +31 -0
- package/docs/reference/functions/auditableItemStreamListEntryObjects.md +1 -1
- package/docs/reference/functions/auditableItemStreamListEntryObjectsNoStream.md +31 -0
- package/docs/reference/functions/auditableItemStreamRemoveProof.md +31 -0
- package/docs/reference/index.md +4 -0
- package/docs/reference/interfaces/IAuditableItemStreamServiceConfig.md +10 -2
- package/docs/reference/interfaces/IAuditableItemStreamServiceConstructorOptions.md +18 -10
- package/docs/reference/variables/restEntryPoints.md +2 -0
- package/locales/en.json +6 -1
- package/package.json +19 -18
package/docs/open-api/spec.json
CHANGED
|
@@ -39,26 +39,36 @@
|
|
|
39
39
|
"content": {
|
|
40
40
|
"application/json": {
|
|
41
41
|
"schema": {
|
|
42
|
-
"$ref": "
|
|
42
|
+
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamBase"
|
|
43
43
|
},
|
|
44
44
|
"examples": {
|
|
45
45
|
"auditableItemStreamCreateRequestExample": {
|
|
46
46
|
"value": {
|
|
47
|
+
"@context": [
|
|
48
|
+
"https://schema.org",
|
|
49
|
+
"https://schema.twindev.org/ais/",
|
|
50
|
+
"https://schema.twindev.org/common/"
|
|
51
|
+
],
|
|
52
|
+
"type": "AuditableItemStream",
|
|
47
53
|
"annotationObject": {
|
|
48
54
|
"@context": "https://schema.org",
|
|
49
55
|
"@type": "Note",
|
|
50
56
|
"content": "This is a simple note"
|
|
51
57
|
},
|
|
52
|
-
"entries":
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
"
|
|
57
|
-
"
|
|
58
|
-
|
|
58
|
+
"entries": {
|
|
59
|
+
"type": "ItemList",
|
|
60
|
+
"itemListElement": [
|
|
61
|
+
{
|
|
62
|
+
"type": "AuditableItemStreamEntry",
|
|
63
|
+
"entryObject": {
|
|
64
|
+
"@context": "https://schema.org",
|
|
65
|
+
"@type": "Event",
|
|
66
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
67
|
+
"description": "A description of the event"
|
|
68
|
+
}
|
|
59
69
|
}
|
|
60
|
-
|
|
61
|
-
|
|
70
|
+
]
|
|
71
|
+
}
|
|
62
72
|
}
|
|
63
73
|
}
|
|
64
74
|
}
|
|
@@ -158,7 +168,6 @@
|
|
|
158
168
|
"in": "query",
|
|
159
169
|
"required": false,
|
|
160
170
|
"schema": {
|
|
161
|
-
"type": "string",
|
|
162
171
|
"enum": [
|
|
163
172
|
"dateCreated",
|
|
164
173
|
"dateModified"
|
|
@@ -239,6 +248,7 @@
|
|
|
239
248
|
"itemListElement": [
|
|
240
249
|
{
|
|
241
250
|
"@context": [
|
|
251
|
+
"https://schema.org",
|
|
242
252
|
"https://schema.twindev.org/ais/",
|
|
243
253
|
"https://schema.twindev.org/common/"
|
|
244
254
|
],
|
|
@@ -280,6 +290,7 @@
|
|
|
280
290
|
"itemListElement": [
|
|
281
291
|
{
|
|
282
292
|
"@context": [
|
|
293
|
+
"https://schema.org",
|
|
283
294
|
"https://schema.twindev.org/ais/",
|
|
284
295
|
"https://schema.twindev.org/common/"
|
|
285
296
|
],
|
|
@@ -412,9 +423,27 @@
|
|
|
412
423
|
"style": "simple",
|
|
413
424
|
"example": "ais:1234567890"
|
|
414
425
|
},
|
|
426
|
+
{
|
|
427
|
+
"name": "cursor",
|
|
428
|
+
"description": "Cursor to use for next chunk of entries.",
|
|
429
|
+
"in": "query",
|
|
430
|
+
"required": false,
|
|
431
|
+
"schema": {
|
|
432
|
+
"type": "string"
|
|
433
|
+
}
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "limit",
|
|
437
|
+
"description": "Limit the number of entries to return, only applicable if includeEntries is true.",
|
|
438
|
+
"in": "query",
|
|
439
|
+
"required": false,
|
|
440
|
+
"schema": {
|
|
441
|
+
"type": "string"
|
|
442
|
+
}
|
|
443
|
+
},
|
|
415
444
|
{
|
|
416
445
|
"name": "includeEntries",
|
|
417
|
-
"description": "Whether to include the entries, defaults to false
|
|
446
|
+
"description": "Whether to include the entries, defaults to false.\nThe entries will be limited to the first page of entries in date descending order.\nIf you want to get more entries you can use the returned cursor with the get entries method.",
|
|
418
447
|
"in": "query",
|
|
419
448
|
"required": false,
|
|
420
449
|
"schema": {
|
|
@@ -476,6 +505,7 @@
|
|
|
476
505
|
"auditableItemStreamGetResponseExample": {
|
|
477
506
|
"value": {
|
|
478
507
|
"@context": [
|
|
508
|
+
"https://schema.org",
|
|
479
509
|
"https://schema.twindev.org/ais/",
|
|
480
510
|
"https://schema.twindev.org/common/"
|
|
481
511
|
],
|
|
@@ -492,25 +522,28 @@
|
|
|
492
522
|
"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
493
523
|
"immutableInterval": 10,
|
|
494
524
|
"numberOfItems": 1,
|
|
495
|
-
"entries":
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
"
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
"
|
|
508
|
-
"
|
|
509
|
-
|
|
510
|
-
|
|
525
|
+
"entries": {
|
|
526
|
+
"type": "ItemList",
|
|
527
|
+
"itemListElement": [
|
|
528
|
+
{
|
|
529
|
+
"@context": [
|
|
530
|
+
"https://schema.twindev.org/ais/",
|
|
531
|
+
"https://schema.twindev.org/common/"
|
|
532
|
+
],
|
|
533
|
+
"type": "AuditableItemStreamEntry",
|
|
534
|
+
"id": "tst:1234567890",
|
|
535
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
536
|
+
"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
537
|
+
"index": 0,
|
|
538
|
+
"entryObject": {
|
|
539
|
+
"@context": "https://schema.org",
|
|
540
|
+
"@type": "Event",
|
|
541
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
542
|
+
"description": "A description of the event"
|
|
543
|
+
}
|
|
511
544
|
}
|
|
512
|
-
|
|
513
|
-
|
|
545
|
+
]
|
|
546
|
+
}
|
|
514
547
|
}
|
|
515
548
|
}
|
|
516
549
|
}
|
|
@@ -523,6 +556,7 @@
|
|
|
523
556
|
"auditableItemStreamJsonLdGetResponseExample": {
|
|
524
557
|
"value": {
|
|
525
558
|
"@context": [
|
|
559
|
+
"https://schema.org",
|
|
526
560
|
"https://schema.twindev.org/ais/",
|
|
527
561
|
"https://schema.twindev.org/common/"
|
|
528
562
|
],
|
|
@@ -539,25 +573,28 @@
|
|
|
539
573
|
"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
540
574
|
"immutableInterval": 10,
|
|
541
575
|
"numberOfItems": 1,
|
|
542
|
-
"entries":
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
"
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
"
|
|
555
|
-
"
|
|
556
|
-
|
|
557
|
-
|
|
576
|
+
"entries": {
|
|
577
|
+
"type": "ItemList",
|
|
578
|
+
"itemListElement": [
|
|
579
|
+
{
|
|
580
|
+
"@context": [
|
|
581
|
+
"https://schema.twindev.org/ais/",
|
|
582
|
+
"https://schema.twindev.org/common/"
|
|
583
|
+
],
|
|
584
|
+
"type": "AuditableItemStreamEntry",
|
|
585
|
+
"id": "tst:1234567890",
|
|
586
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
587
|
+
"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
588
|
+
"index": 0,
|
|
589
|
+
"entryObject": {
|
|
590
|
+
"@context": "https://schema.org",
|
|
591
|
+
"@type": "Event",
|
|
592
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
593
|
+
"description": "A description of the event"
|
|
594
|
+
}
|
|
558
595
|
}
|
|
559
|
-
|
|
560
|
-
|
|
596
|
+
]
|
|
597
|
+
}
|
|
561
598
|
}
|
|
562
599
|
}
|
|
563
600
|
}
|
|
@@ -687,6 +724,12 @@
|
|
|
687
724
|
"examples": {
|
|
688
725
|
"auditableItemStreamUpdateRequestExample": {
|
|
689
726
|
"value": {
|
|
727
|
+
"@context": [
|
|
728
|
+
"https://schema.org",
|
|
729
|
+
"https://schema.twindev.org/ais/",
|
|
730
|
+
"https://schema.twindev.org/common/"
|
|
731
|
+
],
|
|
732
|
+
"type": "AuditableItemStream",
|
|
690
733
|
"annotationObject": {
|
|
691
734
|
"@context": "https://schema.org",
|
|
692
735
|
"@type": "Note",
|
|
@@ -891,6 +934,116 @@
|
|
|
891
934
|
}
|
|
892
935
|
}
|
|
893
936
|
},
|
|
937
|
+
"/auditable-item-stream/{id}/close": {
|
|
938
|
+
"put": {
|
|
939
|
+
"operationId": "auditableItemStreamClose",
|
|
940
|
+
"summary": "Close a stream",
|
|
941
|
+
"tags": [
|
|
942
|
+
"Auditable Item Stream"
|
|
943
|
+
],
|
|
944
|
+
"parameters": [
|
|
945
|
+
{
|
|
946
|
+
"name": "id",
|
|
947
|
+
"description": "The id of the stream to close.",
|
|
948
|
+
"in": "path",
|
|
949
|
+
"required": true,
|
|
950
|
+
"schema": {
|
|
951
|
+
"type": "string"
|
|
952
|
+
},
|
|
953
|
+
"style": "simple",
|
|
954
|
+
"example": "ais:1234567890"
|
|
955
|
+
}
|
|
956
|
+
],
|
|
957
|
+
"security": [
|
|
958
|
+
{
|
|
959
|
+
"jwtBearerAuthScheme": []
|
|
960
|
+
}
|
|
961
|
+
],
|
|
962
|
+
"responses": {
|
|
963
|
+
"204": {
|
|
964
|
+
"description": "The rest request ended in success with no data."
|
|
965
|
+
},
|
|
966
|
+
"400": {
|
|
967
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
968
|
+
"content": {
|
|
969
|
+
"application/json": {
|
|
970
|
+
"schema": {
|
|
971
|
+
"$ref": "#/components/schemas/Error"
|
|
972
|
+
},
|
|
973
|
+
"examples": {
|
|
974
|
+
"exampleResponse": {
|
|
975
|
+
"value": {
|
|
976
|
+
"name": "GeneralError",
|
|
977
|
+
"message": "errorMessage",
|
|
978
|
+
"properties": {
|
|
979
|
+
"foo": "bar"
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
},
|
|
987
|
+
"401": {
|
|
988
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
989
|
+
"content": {
|
|
990
|
+
"application/json": {
|
|
991
|
+
"schema": {
|
|
992
|
+
"$ref": "#/components/schemas/Error"
|
|
993
|
+
},
|
|
994
|
+
"examples": {
|
|
995
|
+
"exampleResponse": {
|
|
996
|
+
"value": {
|
|
997
|
+
"name": "UnauthorizedError",
|
|
998
|
+
"message": "errorMessage"
|
|
999
|
+
}
|
|
1000
|
+
}
|
|
1001
|
+
}
|
|
1002
|
+
}
|
|
1003
|
+
}
|
|
1004
|
+
},
|
|
1005
|
+
"404": {
|
|
1006
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
1007
|
+
"content": {
|
|
1008
|
+
"application/json": {
|
|
1009
|
+
"schema": {
|
|
1010
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
1011
|
+
},
|
|
1012
|
+
"examples": {
|
|
1013
|
+
"exampleResponse": {
|
|
1014
|
+
"value": {
|
|
1015
|
+
"name": "NotFoundError",
|
|
1016
|
+
"message": "errorMessage",
|
|
1017
|
+
"properties": {
|
|
1018
|
+
"notFoundId": "1"
|
|
1019
|
+
}
|
|
1020
|
+
}
|
|
1021
|
+
}
|
|
1022
|
+
}
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
},
|
|
1026
|
+
"500": {
|
|
1027
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1028
|
+
"content": {
|
|
1029
|
+
"application/json": {
|
|
1030
|
+
"schema": {
|
|
1031
|
+
"$ref": "#/components/schemas/Error"
|
|
1032
|
+
},
|
|
1033
|
+
"examples": {
|
|
1034
|
+
"exampleResponse": {
|
|
1035
|
+
"value": {
|
|
1036
|
+
"name": "InternalServerError",
|
|
1037
|
+
"message": "errorMessage"
|
|
1038
|
+
}
|
|
1039
|
+
}
|
|
1040
|
+
}
|
|
1041
|
+
}
|
|
1042
|
+
}
|
|
1043
|
+
}
|
|
1044
|
+
}
|
|
1045
|
+
}
|
|
1046
|
+
},
|
|
894
1047
|
"/auditable-item-stream/{id}/entries": {
|
|
895
1048
|
"post": {
|
|
896
1049
|
"operationId": "auditableItemStreamCreateEntry",
|
|
@@ -1280,7 +1433,7 @@
|
|
|
1280
1433
|
"parameters": [
|
|
1281
1434
|
{
|
|
1282
1435
|
"name": "id",
|
|
1283
|
-
"description": "The id of the stream to
|
|
1436
|
+
"description": "The id of the stream to get the entry from.",
|
|
1284
1437
|
"in": "path",
|
|
1285
1438
|
"required": true,
|
|
1286
1439
|
"schema": {
|
|
@@ -1291,7 +1444,7 @@
|
|
|
1291
1444
|
},
|
|
1292
1445
|
{
|
|
1293
1446
|
"name": "entryId",
|
|
1294
|
-
"description": "The id of the entry to
|
|
1447
|
+
"description": "The id of the entry to get.",
|
|
1295
1448
|
"in": "path",
|
|
1296
1449
|
"required": true,
|
|
1297
1450
|
"schema": {
|
|
@@ -1869,25 +2022,14 @@
|
|
|
1869
2022
|
}
|
|
1870
2023
|
}
|
|
1871
2024
|
},
|
|
1872
|
-
"/auditable-item-stream/
|
|
2025
|
+
"/auditable-item-stream/entries": {
|
|
1873
2026
|
"get": {
|
|
1874
|
-
"operationId": "
|
|
1875
|
-
"summary": "Get the entry objects
|
|
2027
|
+
"operationId": "auditableItemStreamListEntriesNoStream",
|
|
2028
|
+
"summary": "Get the entry objects for all streams",
|
|
1876
2029
|
"tags": [
|
|
1877
2030
|
"Auditable Item Stream"
|
|
1878
2031
|
],
|
|
1879
2032
|
"parameters": [
|
|
1880
|
-
{
|
|
1881
|
-
"name": "id",
|
|
1882
|
-
"description": "The id of the stream to get.",
|
|
1883
|
-
"in": "path",
|
|
1884
|
-
"required": true,
|
|
1885
|
-
"schema": {
|
|
1886
|
-
"type": "string"
|
|
1887
|
-
},
|
|
1888
|
-
"style": "simple",
|
|
1889
|
-
"example": "ais:1234567890"
|
|
1890
|
-
},
|
|
1891
2033
|
{
|
|
1892
2034
|
"name": "conditions",
|
|
1893
2035
|
"description": "The conditions to filter the stream, JSON stringified IComparator[].",
|
|
@@ -1906,6 +2048,15 @@
|
|
|
1906
2048
|
"type": "string"
|
|
1907
2049
|
}
|
|
1908
2050
|
},
|
|
2051
|
+
{
|
|
2052
|
+
"name": "verifyEntries",
|
|
2053
|
+
"description": "Should the entries be verified, defaults to false.",
|
|
2054
|
+
"in": "query",
|
|
2055
|
+
"required": false,
|
|
2056
|
+
"schema": {
|
|
2057
|
+
"type": "string"
|
|
2058
|
+
}
|
|
2059
|
+
},
|
|
1909
2060
|
{
|
|
1910
2061
|
"name": "order",
|
|
1911
2062
|
"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
|
|
@@ -1950,14 +2101,14 @@
|
|
|
1950
2101
|
],
|
|
1951
2102
|
"responses": {
|
|
1952
2103
|
"200": {
|
|
1953
|
-
"description": "Response to getting an auditable item stream entries
|
|
2104
|
+
"description": "Response to getting an auditable item stream entries.",
|
|
1954
2105
|
"content": {
|
|
1955
2106
|
"application/json": {
|
|
1956
2107
|
"schema": {
|
|
1957
|
-
"$ref": "https://schema.twindev.org/ais/
|
|
2108
|
+
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
|
|
1958
2109
|
},
|
|
1959
2110
|
"examples": {
|
|
1960
|
-
"
|
|
2111
|
+
"auditableItemStreamListEntriesNoStreamResponseExample": {
|
|
1961
2112
|
"value": {
|
|
1962
2113
|
"@context": [
|
|
1963
2114
|
"https://schema.org",
|
|
@@ -1966,50 +2117,595 @@
|
|
|
1966
2117
|
],
|
|
1967
2118
|
"type": [
|
|
1968
2119
|
"ItemList",
|
|
1969
|
-
"
|
|
2120
|
+
"AuditableItemStreamEntryList"
|
|
1970
2121
|
],
|
|
1971
2122
|
"itemListElement": [
|
|
1972
2123
|
{
|
|
1973
|
-
"@context":
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
2124
|
+
"@context": [
|
|
2125
|
+
"https://schema.twindev.org/ais/",
|
|
2126
|
+
"https://schema.twindev.org/common/"
|
|
2127
|
+
],
|
|
2128
|
+
"type": "AuditableItemStreamEntry",
|
|
2129
|
+
"id": "tst:1234567890",
|
|
2130
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
2131
|
+
"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
2132
|
+
"index": 0,
|
|
2133
|
+
"entryObject": {
|
|
2134
|
+
"@context": "https://schema.org",
|
|
2135
|
+
"@type": "Event",
|
|
2136
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
2137
|
+
"description": "A description of the event"
|
|
2138
|
+
}
|
|
1977
2139
|
}
|
|
1978
2140
|
]
|
|
1979
2141
|
}
|
|
1980
2142
|
}
|
|
1981
2143
|
}
|
|
1982
|
-
}
|
|
1983
|
-
|
|
1984
|
-
},
|
|
1985
|
-
"400": {
|
|
1986
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
1987
|
-
"content": {
|
|
1988
|
-
"application/json": {
|
|
2144
|
+
},
|
|
2145
|
+
"application/ld+json": {
|
|
1989
2146
|
"schema": {
|
|
1990
|
-
"$ref": "
|
|
2147
|
+
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryList"
|
|
1991
2148
|
},
|
|
1992
2149
|
"examples": {
|
|
1993
|
-
"
|
|
2150
|
+
"auditableItemStreamJsonLdListEntriesNoStreamResponseExample": {
|
|
1994
2151
|
"value": {
|
|
1995
|
-
"
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
"
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
|
|
2152
|
+
"@context": [
|
|
2153
|
+
"https://schema.org",
|
|
2154
|
+
"https://schema.twindev.org/ais/",
|
|
2155
|
+
"https://schema.twindev.org/common/"
|
|
2156
|
+
],
|
|
2157
|
+
"type": [
|
|
2158
|
+
"ItemList",
|
|
2159
|
+
"AuditableItemStreamEntryList"
|
|
2160
|
+
],
|
|
2161
|
+
"itemListElement": [
|
|
2162
|
+
{
|
|
2163
|
+
"@context": [
|
|
2164
|
+
"https://schema.twindev.org/ais/",
|
|
2165
|
+
"https://schema.twindev.org/common/"
|
|
2166
|
+
],
|
|
2167
|
+
"type": "AuditableItemStreamEntry",
|
|
2168
|
+
"id": "tst:1234567890",
|
|
2169
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
2170
|
+
"proofId": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
2171
|
+
"index": 0,
|
|
2172
|
+
"entryObject": {
|
|
2173
|
+
"@context": "https://schema.org",
|
|
2174
|
+
"@type": "Event",
|
|
2175
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
2176
|
+
"description": "A description of the event"
|
|
2177
|
+
}
|
|
2178
|
+
}
|
|
2179
|
+
]
|
|
2180
|
+
}
|
|
2181
|
+
}
|
|
2182
|
+
}
|
|
2183
|
+
}
|
|
2184
|
+
},
|
|
2185
|
+
"headers": {
|
|
2186
|
+
"content-type": {
|
|
2187
|
+
"schema": {
|
|
2188
|
+
"type": "string"
|
|
2189
|
+
},
|
|
2190
|
+
"description": "e.g. application/ld+json"
|
|
2191
|
+
}
|
|
2192
|
+
}
|
|
2193
|
+
},
|
|
2194
|
+
"400": {
|
|
2195
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2196
|
+
"content": {
|
|
2197
|
+
"application/json": {
|
|
2198
|
+
"schema": {
|
|
2199
|
+
"$ref": "#/components/schemas/Error"
|
|
2200
|
+
},
|
|
2201
|
+
"examples": {
|
|
2202
|
+
"exampleResponse": {
|
|
2203
|
+
"value": {
|
|
2204
|
+
"name": "GeneralError",
|
|
2205
|
+
"message": "errorMessage",
|
|
2206
|
+
"properties": {
|
|
2207
|
+
"foo": "bar"
|
|
2208
|
+
}
|
|
2209
|
+
}
|
|
2210
|
+
}
|
|
2211
|
+
}
|
|
2212
|
+
}
|
|
2213
|
+
}
|
|
2214
|
+
},
|
|
2215
|
+
"401": {
|
|
2216
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2217
|
+
"content": {
|
|
2218
|
+
"application/json": {
|
|
2219
|
+
"schema": {
|
|
2220
|
+
"$ref": "#/components/schemas/Error"
|
|
2221
|
+
},
|
|
2222
|
+
"examples": {
|
|
2223
|
+
"exampleResponse": {
|
|
2224
|
+
"value": {
|
|
2225
|
+
"name": "UnauthorizedError",
|
|
2226
|
+
"message": "errorMessage"
|
|
2227
|
+
}
|
|
2228
|
+
}
|
|
2229
|
+
}
|
|
2230
|
+
}
|
|
2231
|
+
}
|
|
2232
|
+
},
|
|
2233
|
+
"404": {
|
|
2234
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
2235
|
+
"content": {
|
|
2236
|
+
"application/json": {
|
|
2237
|
+
"schema": {
|
|
2238
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
2239
|
+
},
|
|
2240
|
+
"examples": {
|
|
2241
|
+
"exampleResponse": {
|
|
2242
|
+
"value": {
|
|
2243
|
+
"name": "NotFoundError",
|
|
2244
|
+
"message": "errorMessage",
|
|
2245
|
+
"properties": {
|
|
2246
|
+
"notFoundId": "1"
|
|
2247
|
+
}
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2250
|
+
}
|
|
2251
|
+
}
|
|
2252
|
+
}
|
|
2253
|
+
},
|
|
2254
|
+
"500": {
|
|
2255
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
2256
|
+
"content": {
|
|
2257
|
+
"application/json": {
|
|
2258
|
+
"schema": {
|
|
2259
|
+
"$ref": "#/components/schemas/Error"
|
|
2260
|
+
},
|
|
2261
|
+
"examples": {
|
|
2262
|
+
"exampleResponse": {
|
|
2263
|
+
"value": {
|
|
2264
|
+
"name": "InternalServerError",
|
|
2265
|
+
"message": "errorMessage"
|
|
2266
|
+
}
|
|
2267
|
+
}
|
|
2268
|
+
}
|
|
2269
|
+
}
|
|
2270
|
+
}
|
|
2271
|
+
}
|
|
2272
|
+
}
|
|
2273
|
+
}
|
|
2274
|
+
},
|
|
2275
|
+
"/auditable-item-stream/{id}/entries/objects": {
|
|
2276
|
+
"get": {
|
|
2277
|
+
"operationId": "auditableItemStreamListEntryObjects",
|
|
2278
|
+
"summary": "Get the entry objects in a stream",
|
|
2279
|
+
"tags": [
|
|
2280
|
+
"Auditable Item Stream"
|
|
2281
|
+
],
|
|
2282
|
+
"parameters": [
|
|
2283
|
+
{
|
|
2284
|
+
"name": "id",
|
|
2285
|
+
"description": "The id of the stream to get.",
|
|
2286
|
+
"in": "path",
|
|
2287
|
+
"required": true,
|
|
2288
|
+
"schema": {
|
|
2289
|
+
"type": "string"
|
|
2290
|
+
},
|
|
2291
|
+
"style": "simple",
|
|
2292
|
+
"example": "ais:1234567890"
|
|
2293
|
+
},
|
|
2294
|
+
{
|
|
2295
|
+
"name": "conditions",
|
|
2296
|
+
"description": "The conditions to filter the stream, JSON stringified IComparator[].",
|
|
2297
|
+
"in": "query",
|
|
2298
|
+
"required": false,
|
|
2299
|
+
"schema": {
|
|
2300
|
+
"type": "string"
|
|
2301
|
+
}
|
|
2302
|
+
},
|
|
2303
|
+
{
|
|
2304
|
+
"name": "includeDeleted",
|
|
2305
|
+
"description": "Whether to include deleted entries, defaults to false.",
|
|
2306
|
+
"in": "query",
|
|
2307
|
+
"required": false,
|
|
2308
|
+
"schema": {
|
|
2309
|
+
"type": "string"
|
|
2310
|
+
}
|
|
2311
|
+
},
|
|
2312
|
+
{
|
|
2313
|
+
"name": "order",
|
|
2314
|
+
"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
|
|
2315
|
+
"in": "query",
|
|
2316
|
+
"required": false,
|
|
2317
|
+
"schema": {
|
|
2318
|
+
"$ref": "#/components/schemas/SortDirection"
|
|
2319
|
+
}
|
|
2320
|
+
},
|
|
2321
|
+
{
|
|
2322
|
+
"name": "limit",
|
|
2323
|
+
"description": "How many entries to return.",
|
|
2324
|
+
"in": "query",
|
|
2325
|
+
"required": false,
|
|
2326
|
+
"schema": {
|
|
2327
|
+
"type": "string"
|
|
2328
|
+
}
|
|
2329
|
+
},
|
|
2330
|
+
{
|
|
2331
|
+
"name": "cursor",
|
|
2332
|
+
"description": "Cursor to use for next chunk of data.",
|
|
2333
|
+
"in": "query",
|
|
2334
|
+
"required": false,
|
|
2335
|
+
"schema": {
|
|
2336
|
+
"type": "string"
|
|
2337
|
+
}
|
|
2338
|
+
},
|
|
2339
|
+
{
|
|
2340
|
+
"name": "accept",
|
|
2341
|
+
"in": "header",
|
|
2342
|
+
"required": true,
|
|
2343
|
+
"schema": {
|
|
2344
|
+
"type": "string"
|
|
2345
|
+
},
|
|
2346
|
+
"style": "simple"
|
|
2347
|
+
}
|
|
2348
|
+
],
|
|
2349
|
+
"security": [
|
|
2350
|
+
{
|
|
2351
|
+
"jwtBearerAuthScheme": []
|
|
2352
|
+
}
|
|
2353
|
+
],
|
|
2354
|
+
"responses": {
|
|
2355
|
+
"200": {
|
|
2356
|
+
"description": "Response to getting an auditable item stream entries objects.",
|
|
2357
|
+
"content": {
|
|
2358
|
+
"application/json": {
|
|
2359
|
+
"schema": {
|
|
2360
|
+
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
|
|
2361
|
+
},
|
|
2362
|
+
"examples": {
|
|
2363
|
+
"auditableItemStreamListEntryObjectsResponseExample": {
|
|
2364
|
+
"value": {
|
|
2365
|
+
"@context": [
|
|
2366
|
+
"https://schema.org",
|
|
2367
|
+
"https://schema.twindev.org/ais/",
|
|
2368
|
+
"https://schema.twindev.org/common/"
|
|
2369
|
+
],
|
|
2370
|
+
"type": [
|
|
2371
|
+
"ItemList",
|
|
2372
|
+
"AuditableItemStreamEntryObjectList"
|
|
2373
|
+
],
|
|
2374
|
+
"itemListElement": [
|
|
2375
|
+
{
|
|
2376
|
+
"@context": "https://schema.org",
|
|
2377
|
+
"@type": "Event",
|
|
2378
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
2379
|
+
"description": "A description of the event"
|
|
2380
|
+
}
|
|
2381
|
+
]
|
|
2382
|
+
}
|
|
2383
|
+
}
|
|
2384
|
+
}
|
|
2385
|
+
}
|
|
2386
|
+
}
|
|
2387
|
+
},
|
|
2388
|
+
"400": {
|
|
2389
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2390
|
+
"content": {
|
|
2391
|
+
"application/json": {
|
|
2392
|
+
"schema": {
|
|
2393
|
+
"$ref": "#/components/schemas/Error"
|
|
2394
|
+
},
|
|
2395
|
+
"examples": {
|
|
2396
|
+
"exampleResponse": {
|
|
2397
|
+
"value": {
|
|
2398
|
+
"name": "GeneralError",
|
|
2399
|
+
"message": "errorMessage",
|
|
2400
|
+
"properties": {
|
|
2401
|
+
"foo": "bar"
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
}
|
|
2405
|
+
}
|
|
2406
|
+
}
|
|
2407
|
+
}
|
|
2408
|
+
},
|
|
2409
|
+
"401": {
|
|
2410
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2411
|
+
"content": {
|
|
2412
|
+
"application/json": {
|
|
2413
|
+
"schema": {
|
|
2414
|
+
"$ref": "#/components/schemas/Error"
|
|
2415
|
+
},
|
|
2416
|
+
"examples": {
|
|
2417
|
+
"exampleResponse": {
|
|
2418
|
+
"value": {
|
|
2419
|
+
"name": "UnauthorizedError",
|
|
2420
|
+
"message": "errorMessage"
|
|
2421
|
+
}
|
|
2422
|
+
}
|
|
2423
|
+
}
|
|
2424
|
+
}
|
|
2425
|
+
}
|
|
2426
|
+
},
|
|
2427
|
+
"404": {
|
|
2428
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
2429
|
+
"content": {
|
|
2430
|
+
"application/json": {
|
|
2431
|
+
"schema": {
|
|
2432
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
2433
|
+
},
|
|
2434
|
+
"examples": {
|
|
2435
|
+
"exampleResponse": {
|
|
2436
|
+
"value": {
|
|
2437
|
+
"name": "NotFoundError",
|
|
2438
|
+
"message": "errorMessage",
|
|
2439
|
+
"properties": {
|
|
2440
|
+
"notFoundId": "1"
|
|
2441
|
+
}
|
|
2442
|
+
}
|
|
2443
|
+
}
|
|
2444
|
+
}
|
|
2445
|
+
}
|
|
2446
|
+
}
|
|
2447
|
+
},
|
|
2448
|
+
"500": {
|
|
2449
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
2450
|
+
"content": {
|
|
2451
|
+
"application/json": {
|
|
2452
|
+
"schema": {
|
|
2453
|
+
"$ref": "#/components/schemas/Error"
|
|
2454
|
+
},
|
|
2455
|
+
"examples": {
|
|
2456
|
+
"exampleResponse": {
|
|
2457
|
+
"value": {
|
|
2458
|
+
"name": "InternalServerError",
|
|
2459
|
+
"message": "errorMessage"
|
|
2460
|
+
}
|
|
2461
|
+
}
|
|
2462
|
+
}
|
|
2463
|
+
}
|
|
2464
|
+
}
|
|
2465
|
+
}
|
|
2466
|
+
}
|
|
2467
|
+
}
|
|
2468
|
+
},
|
|
2469
|
+
"/auditable-item-stream/entries/objects": {
|
|
2470
|
+
"get": {
|
|
2471
|
+
"operationId": "auditableItemStreamListEntryObjectsNoStream",
|
|
2472
|
+
"summary": "Get the entry objects for all streams",
|
|
2473
|
+
"tags": [
|
|
2474
|
+
"Auditable Item Stream"
|
|
2475
|
+
],
|
|
2476
|
+
"parameters": [
|
|
2477
|
+
{
|
|
2478
|
+
"name": "conditions",
|
|
2479
|
+
"description": "The conditions to filter the stream, JSON stringified IComparator[].",
|
|
2480
|
+
"in": "query",
|
|
2481
|
+
"required": false,
|
|
2482
|
+
"schema": {
|
|
2483
|
+
"type": "string"
|
|
2484
|
+
}
|
|
2485
|
+
},
|
|
2486
|
+
{
|
|
2487
|
+
"name": "includeDeleted",
|
|
2488
|
+
"description": "Whether to include deleted entries, defaults to false.",
|
|
2489
|
+
"in": "query",
|
|
2490
|
+
"required": false,
|
|
2491
|
+
"schema": {
|
|
2492
|
+
"type": "string"
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
"name": "order",
|
|
2497
|
+
"description": "Retrieve the entries in ascending/descending time order, defaults to Ascending.",
|
|
2498
|
+
"in": "query",
|
|
2499
|
+
"required": false,
|
|
2500
|
+
"schema": {
|
|
2501
|
+
"$ref": "#/components/schemas/SortDirection"
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"name": "limit",
|
|
2506
|
+
"description": "How many entries to return.",
|
|
2507
|
+
"in": "query",
|
|
2508
|
+
"required": false,
|
|
2509
|
+
"schema": {
|
|
2510
|
+
"type": "string"
|
|
2511
|
+
}
|
|
2512
|
+
},
|
|
2513
|
+
{
|
|
2514
|
+
"name": "cursor",
|
|
2515
|
+
"description": "Cursor to use for next chunk of data.",
|
|
2516
|
+
"in": "query",
|
|
2517
|
+
"required": false,
|
|
2518
|
+
"schema": {
|
|
2519
|
+
"type": "string"
|
|
2520
|
+
}
|
|
2521
|
+
},
|
|
2522
|
+
{
|
|
2523
|
+
"name": "accept",
|
|
2524
|
+
"in": "header",
|
|
2525
|
+
"required": true,
|
|
2526
|
+
"schema": {
|
|
2527
|
+
"type": "string"
|
|
2528
|
+
},
|
|
2529
|
+
"style": "simple"
|
|
2530
|
+
}
|
|
2531
|
+
],
|
|
2532
|
+
"security": [
|
|
2533
|
+
{
|
|
2534
|
+
"jwtBearerAuthScheme": []
|
|
2535
|
+
}
|
|
2536
|
+
],
|
|
2537
|
+
"responses": {
|
|
2538
|
+
"200": {
|
|
2539
|
+
"description": "Response to getting an auditable item stream entries objects.",
|
|
2540
|
+
"content": {
|
|
2541
|
+
"application/json": {
|
|
2542
|
+
"schema": {
|
|
2543
|
+
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
|
|
2544
|
+
},
|
|
2545
|
+
"examples": {
|
|
2546
|
+
"auditableItemStreamListEntryObjectsNoStreamResponseExample": {
|
|
2547
|
+
"value": {
|
|
2548
|
+
"@context": [
|
|
2549
|
+
"https://schema.org",
|
|
2550
|
+
"https://schema.twindev.org/ais/",
|
|
2551
|
+
"https://schema.twindev.org/common/"
|
|
2552
|
+
],
|
|
2553
|
+
"type": [
|
|
2554
|
+
"ItemList",
|
|
2555
|
+
"AuditableItemStreamEntryObjectList"
|
|
2556
|
+
],
|
|
2557
|
+
"itemListElement": [
|
|
2558
|
+
{
|
|
2559
|
+
"@context": "https://schema.org",
|
|
2560
|
+
"@type": "Event",
|
|
2561
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
2562
|
+
"description": "A description of the event"
|
|
2563
|
+
}
|
|
2564
|
+
]
|
|
2565
|
+
}
|
|
2566
|
+
}
|
|
2567
|
+
}
|
|
2568
|
+
}
|
|
2569
|
+
}
|
|
2570
|
+
},
|
|
2571
|
+
"400": {
|
|
2572
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2573
|
+
"content": {
|
|
2574
|
+
"application/json": {
|
|
2575
|
+
"schema": {
|
|
2576
|
+
"$ref": "#/components/schemas/Error"
|
|
2577
|
+
},
|
|
2578
|
+
"examples": {
|
|
2579
|
+
"exampleResponse": {
|
|
2580
|
+
"value": {
|
|
2581
|
+
"name": "GeneralError",
|
|
2582
|
+
"message": "errorMessage",
|
|
2583
|
+
"properties": {
|
|
2584
|
+
"foo": "bar"
|
|
2585
|
+
}
|
|
2586
|
+
}
|
|
2587
|
+
}
|
|
2588
|
+
}
|
|
2589
|
+
}
|
|
2590
|
+
}
|
|
2591
|
+
},
|
|
2592
|
+
"401": {
|
|
2593
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2594
|
+
"content": {
|
|
2595
|
+
"application/json": {
|
|
2596
|
+
"schema": {
|
|
2597
|
+
"$ref": "#/components/schemas/Error"
|
|
2598
|
+
},
|
|
2599
|
+
"examples": {
|
|
2600
|
+
"exampleResponse": {
|
|
2601
|
+
"value": {
|
|
2602
|
+
"name": "UnauthorizedError",
|
|
2603
|
+
"message": "errorMessage"
|
|
2604
|
+
}
|
|
2605
|
+
}
|
|
2606
|
+
}
|
|
2607
|
+
}
|
|
2608
|
+
}
|
|
2609
|
+
},
|
|
2610
|
+
"404": {
|
|
2611
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
2612
|
+
"content": {
|
|
2613
|
+
"application/json": {
|
|
2614
|
+
"schema": {
|
|
2615
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
2616
|
+
},
|
|
2617
|
+
"examples": {
|
|
2618
|
+
"exampleResponse": {
|
|
2619
|
+
"value": {
|
|
2620
|
+
"name": "NotFoundError",
|
|
2621
|
+
"message": "errorMessage",
|
|
2622
|
+
"properties": {
|
|
2623
|
+
"notFoundId": "1"
|
|
2624
|
+
}
|
|
2625
|
+
}
|
|
2626
|
+
}
|
|
2627
|
+
}
|
|
2628
|
+
}
|
|
2629
|
+
}
|
|
2630
|
+
},
|
|
2631
|
+
"500": {
|
|
2632
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
2633
|
+
"content": {
|
|
2634
|
+
"application/json": {
|
|
2635
|
+
"schema": {
|
|
2636
|
+
"$ref": "#/components/schemas/Error"
|
|
2637
|
+
},
|
|
2638
|
+
"examples": {
|
|
2639
|
+
"exampleResponse": {
|
|
2640
|
+
"value": {
|
|
2641
|
+
"name": "InternalServerError",
|
|
2642
|
+
"message": "errorMessage"
|
|
2643
|
+
}
|
|
2644
|
+
}
|
|
2645
|
+
}
|
|
2646
|
+
}
|
|
2647
|
+
}
|
|
2648
|
+
}
|
|
2649
|
+
}
|
|
2650
|
+
}
|
|
2651
|
+
},
|
|
2652
|
+
"/auditable-item-stream/{id}/proof": {
|
|
2653
|
+
"delete": {
|
|
2654
|
+
"operationId": "auditableItemStreamRemoveProof",
|
|
2655
|
+
"summary": "Remove the proof from a stream",
|
|
2656
|
+
"tags": [
|
|
2657
|
+
"Auditable Item Stream"
|
|
2658
|
+
],
|
|
2659
|
+
"parameters": [
|
|
2660
|
+
{
|
|
2661
|
+
"name": "id",
|
|
2662
|
+
"description": "The id of the stream to remove the proof from.",
|
|
2663
|
+
"in": "path",
|
|
2664
|
+
"required": true,
|
|
2665
|
+
"schema": {
|
|
2666
|
+
"type": "string"
|
|
2667
|
+
},
|
|
2668
|
+
"style": "simple",
|
|
2669
|
+
"example": "ais:1234567890"
|
|
2670
|
+
}
|
|
2671
|
+
],
|
|
2672
|
+
"security": [
|
|
2673
|
+
{
|
|
2674
|
+
"jwtBearerAuthScheme": []
|
|
2675
|
+
}
|
|
2676
|
+
],
|
|
2677
|
+
"responses": {
|
|
2678
|
+
"204": {
|
|
2679
|
+
"description": "The rest request ended in success with no data."
|
|
2680
|
+
},
|
|
2681
|
+
"400": {
|
|
2682
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2683
|
+
"content": {
|
|
2684
|
+
"application/json": {
|
|
2685
|
+
"schema": {
|
|
2686
|
+
"$ref": "#/components/schemas/Error"
|
|
2687
|
+
},
|
|
2688
|
+
"examples": {
|
|
2689
|
+
"exampleResponse": {
|
|
2690
|
+
"value": {
|
|
2691
|
+
"name": "GeneralError",
|
|
2692
|
+
"message": "errorMessage",
|
|
2693
|
+
"properties": {
|
|
2694
|
+
"foo": "bar"
|
|
2695
|
+
}
|
|
2696
|
+
}
|
|
2697
|
+
}
|
|
2698
|
+
}
|
|
2699
|
+
}
|
|
2700
|
+
}
|
|
2701
|
+
},
|
|
2702
|
+
"401": {
|
|
2703
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2704
|
+
"content": {
|
|
2705
|
+
"application/json": {
|
|
2706
|
+
"schema": {
|
|
2707
|
+
"$ref": "#/components/schemas/Error"
|
|
2708
|
+
},
|
|
2013
2709
|
"examples": {
|
|
2014
2710
|
"exampleResponse": {
|
|
2015
2711
|
"value": {
|
|
@@ -2076,37 +2772,6 @@
|
|
|
2076
2772
|
"required": [
|
|
2077
2773
|
"entryObject"
|
|
2078
2774
|
],
|
|
2079
|
-
"additionalProperties": false,
|
|
2080
|
-
"description": "The data to be used in the stream."
|
|
2081
|
-
},
|
|
2082
|
-
"AuditableItemStreamCreateRequest": {
|
|
2083
|
-
"type": "object",
|
|
2084
|
-
"properties": {
|
|
2085
|
-
"annotationObject": {
|
|
2086
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
2087
|
-
},
|
|
2088
|
-
"entries": {
|
|
2089
|
-
"type": "array",
|
|
2090
|
-
"items": {
|
|
2091
|
-
"type": "object",
|
|
2092
|
-
"properties": {
|
|
2093
|
-
"entryObject": {
|
|
2094
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
2095
|
-
}
|
|
2096
|
-
},
|
|
2097
|
-
"required": [
|
|
2098
|
-
"entryObject"
|
|
2099
|
-
],
|
|
2100
|
-
"additionalProperties": false
|
|
2101
|
-
},
|
|
2102
|
-
"description": "The entries for the stream."
|
|
2103
|
-
},
|
|
2104
|
-
"immutableInterval": {
|
|
2105
|
-
"type": "number",
|
|
2106
|
-
"description": "After how many entries do we add immutable checks, defaults to service configured value. A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval."
|
|
2107
|
-
}
|
|
2108
|
-
},
|
|
2109
|
-
"additionalProperties": false,
|
|
2110
2775
|
"description": "The data to be used in the stream."
|
|
2111
2776
|
},
|
|
2112
2777
|
"AuditableItemStreamUpdateEntryRequest": {
|
|
@@ -2119,20 +2784,46 @@
|
|
|
2119
2784
|
"required": [
|
|
2120
2785
|
"entryObject"
|
|
2121
2786
|
],
|
|
2122
|
-
"additionalProperties": false,
|
|
2123
2787
|
"description": "The data to be used in the entry."
|
|
2124
2788
|
},
|
|
2125
2789
|
"AuditableItemStreamUpdateRequest": {
|
|
2790
|
+
"description": "The data to be used in the stream, entries should be updated separately.",
|
|
2126
2791
|
"type": "object",
|
|
2127
2792
|
"properties": {
|
|
2793
|
+
"@context": {
|
|
2794
|
+
"type": "array",
|
|
2795
|
+
"prefixItems": [
|
|
2796
|
+
{
|
|
2797
|
+
"const": "https://schema.org"
|
|
2798
|
+
},
|
|
2799
|
+
{
|
|
2800
|
+
"const": "https://schema.twindev.org/ais/"
|
|
2801
|
+
},
|
|
2802
|
+
{
|
|
2803
|
+
"const": "https://schema.twindev.org/common/"
|
|
2804
|
+
}
|
|
2805
|
+
],
|
|
2806
|
+
"items": {
|
|
2807
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
2808
|
+
},
|
|
2809
|
+
"minItems": 3,
|
|
2810
|
+
"description": "JSON-LD Context."
|
|
2811
|
+
},
|
|
2812
|
+
"type": {
|
|
2813
|
+
"const": "AuditableItemStream",
|
|
2814
|
+
"description": "JSON-LD Type."
|
|
2815
|
+
},
|
|
2128
2816
|
"annotationObject": {
|
|
2129
2817
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
2130
2818
|
}
|
|
2131
2819
|
},
|
|
2132
|
-
"
|
|
2133
|
-
|
|
2820
|
+
"required": [
|
|
2821
|
+
"@context",
|
|
2822
|
+
"type"
|
|
2823
|
+
]
|
|
2134
2824
|
},
|
|
2135
2825
|
"Error": {
|
|
2826
|
+
"description": "Model to describe serialized error.",
|
|
2136
2827
|
"type": "object",
|
|
2137
2828
|
"properties": {
|
|
2138
2829
|
"name": {
|
|
@@ -2141,7 +2832,7 @@
|
|
|
2141
2832
|
},
|
|
2142
2833
|
"message": {
|
|
2143
2834
|
"type": "string",
|
|
2144
|
-
"description": "The message for the error."
|
|
2835
|
+
"description": "The message for the error as an i18n key."
|
|
2145
2836
|
},
|
|
2146
2837
|
"source": {
|
|
2147
2838
|
"type": "string",
|
|
@@ -2163,63 +2854,35 @@
|
|
|
2163
2854
|
"required": [
|
|
2164
2855
|
"name",
|
|
2165
2856
|
"message"
|
|
2166
|
-
]
|
|
2167
|
-
"additionalProperties": false,
|
|
2168
|
-
"description": "Model to describe serialized error."
|
|
2857
|
+
]
|
|
2169
2858
|
},
|
|
2170
2859
|
"NotFoundResponse": {
|
|
2171
2860
|
"type": "object",
|
|
2172
|
-
"additionalProperties": false,
|
|
2173
2861
|
"properties": {
|
|
2174
2862
|
"notFoundId": {
|
|
2175
2863
|
"type": "string",
|
|
2176
2864
|
"description": "The id if the item that was not found."
|
|
2177
|
-
},
|
|
2178
|
-
"name": {
|
|
2179
|
-
"type": "string",
|
|
2180
|
-
"description": "The name for the error."
|
|
2181
|
-
},
|
|
2182
|
-
"message": {
|
|
2183
|
-
"type": "string",
|
|
2184
|
-
"description": "The message for the error."
|
|
2185
|
-
},
|
|
2186
|
-
"source": {
|
|
2187
|
-
"type": "string",
|
|
2188
|
-
"description": "The source of the error."
|
|
2189
|
-
},
|
|
2190
|
-
"properties": {
|
|
2191
|
-
"type": "object",
|
|
2192
|
-
"additionalProperties": {},
|
|
2193
|
-
"description": "Any additional information for the error."
|
|
2194
|
-
},
|
|
2195
|
-
"stack": {
|
|
2196
|
-
"type": "string",
|
|
2197
|
-
"description": "The stack trace for the error."
|
|
2198
|
-
},
|
|
2199
|
-
"cause": {
|
|
2200
|
-
"$ref": "#/components/schemas/Error"
|
|
2201
2865
|
}
|
|
2202
2866
|
},
|
|
2203
|
-
"
|
|
2204
|
-
|
|
2205
|
-
|
|
2867
|
+
"allOf": [
|
|
2868
|
+
{
|
|
2869
|
+
"$ref": "#/components/schemas/Error"
|
|
2870
|
+
}
|
|
2206
2871
|
],
|
|
2207
2872
|
"description": "The body which contains the error."
|
|
2208
2873
|
},
|
|
2209
2874
|
"SortDirection": {
|
|
2875
|
+
"description": "The sort directions.",
|
|
2210
2876
|
"anyOf": [
|
|
2211
2877
|
{
|
|
2212
|
-
"type": "string",
|
|
2213
2878
|
"const": "asc",
|
|
2214
2879
|
"description": "Ascending."
|
|
2215
2880
|
},
|
|
2216
2881
|
{
|
|
2217
|
-
"type": "string",
|
|
2218
2882
|
"const": "desc",
|
|
2219
2883
|
"description": "Descending."
|
|
2220
2884
|
}
|
|
2221
|
-
]
|
|
2222
|
-
"description": "The sort directions."
|
|
2885
|
+
]
|
|
2223
2886
|
}
|
|
2224
2887
|
},
|
|
2225
2888
|
"securitySchemes": {
|