@twin.org/node 0.0.3-next.49 → 0.0.3-next.50
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/locales/en.json +23 -150
- package/docs/changelog.md +14 -0
- package/docs/open-api/spec.json +790 -1511
- package/docs/usage.md +0 -6
- package/package.json +2 -2
package/docs/open-api/spec.json
CHANGED
|
@@ -71,10 +71,6 @@
|
|
|
71
71
|
"name": "Attestation",
|
|
72
72
|
"description": "Endpoints which are modelled to access an attestation contract."
|
|
73
73
|
},
|
|
74
|
-
{
|
|
75
|
-
"name": "VerifiableStorage",
|
|
76
|
-
"description": "Endpoints which are modelled to access a verifiable storage."
|
|
77
|
-
},
|
|
78
74
|
{
|
|
79
75
|
"name": "Immutable Proof",
|
|
80
76
|
"description": "Endpoints which are modelled to access an immutable proof contract."
|
|
@@ -95,10 +91,6 @@
|
|
|
95
91
|
"name": "Auditable Item Stream",
|
|
96
92
|
"description": "Endpoints which are modelled to access an auditable item stream contract."
|
|
97
93
|
},
|
|
98
|
-
{
|
|
99
|
-
"name": "Synchronised Storage",
|
|
100
|
-
"description": "Endpoints which are modelled to access a synchronised storage contract."
|
|
101
|
-
},
|
|
102
94
|
{
|
|
103
95
|
"name": "Federated Catalogue",
|
|
104
96
|
"description": "Service providing Dataspace Protocol-compliant catalogue endpoints for dataset discovery and query."
|
|
@@ -9211,12 +9203,12 @@
|
|
|
9211
9203
|
}
|
|
9212
9204
|
}
|
|
9213
9205
|
},
|
|
9214
|
-
"/
|
|
9206
|
+
"/immutable-proof": {
|
|
9215
9207
|
"post": {
|
|
9216
|
-
"operationId": "
|
|
9217
|
-
"summary": "Create
|
|
9208
|
+
"operationId": "immutableProofCreate",
|
|
9209
|
+
"summary": "Create a proof",
|
|
9218
9210
|
"tags": [
|
|
9219
|
-
"
|
|
9211
|
+
"Immutable Proof"
|
|
9220
9212
|
],
|
|
9221
9213
|
"security": [
|
|
9222
9214
|
{
|
|
@@ -9224,17 +9216,21 @@
|
|
|
9224
9216
|
}
|
|
9225
9217
|
],
|
|
9226
9218
|
"requestBody": {
|
|
9227
|
-
"description": "
|
|
9219
|
+
"description": "Create a proof.",
|
|
9228
9220
|
"required": true,
|
|
9229
9221
|
"content": {
|
|
9230
9222
|
"application/json": {
|
|
9231
9223
|
"schema": {
|
|
9232
|
-
"$ref": "#/components/schemas/
|
|
9224
|
+
"$ref": "#/components/schemas/ImmutableProofCreateRequest"
|
|
9233
9225
|
},
|
|
9234
9226
|
"examples": {
|
|
9235
|
-
"
|
|
9227
|
+
"immutableProofCreateRequestExample": {
|
|
9236
9228
|
"value": {
|
|
9237
|
-
"
|
|
9229
|
+
"document": {
|
|
9230
|
+
"@context": "https://schema.org",
|
|
9231
|
+
"type": "Person",
|
|
9232
|
+
"name": "John Smith"
|
|
9233
|
+
}
|
|
9238
9234
|
}
|
|
9239
9235
|
}
|
|
9240
9236
|
}
|
|
@@ -9242,32 +9238,14 @@
|
|
|
9242
9238
|
}
|
|
9243
9239
|
},
|
|
9244
9240
|
"responses": {
|
|
9245
|
-
"
|
|
9246
|
-
"description": "
|
|
9247
|
-
"content": {
|
|
9248
|
-
"application/json": {
|
|
9249
|
-
"schema": {
|
|
9250
|
-
"$ref": "#/components/schemas/VerifiableStorageCreateResponse"
|
|
9251
|
-
},
|
|
9252
|
-
"examples": {
|
|
9253
|
-
"verifiableStorageCreateResponseExample": {
|
|
9254
|
-
"value": {
|
|
9255
|
-
"receipt": {
|
|
9256
|
-
"@context": "https://schema.twindev.org/verifiable-storage/",
|
|
9257
|
-
"type": "VerifiableStorageIotaReceipt2026"
|
|
9258
|
-
},
|
|
9259
|
-
"id": "verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg=="
|
|
9260
|
-
}
|
|
9261
|
-
}
|
|
9262
|
-
}
|
|
9263
|
-
}
|
|
9264
|
-
},
|
|
9241
|
+
"201": {
|
|
9242
|
+
"description": "The rest request ended in created response.",
|
|
9265
9243
|
"headers": {
|
|
9266
9244
|
"location": {
|
|
9267
9245
|
"schema": {
|
|
9268
9246
|
"type": "string"
|
|
9269
9247
|
},
|
|
9270
|
-
"description": "e.g.
|
|
9248
|
+
"description": "e.g. test%3A1234567890"
|
|
9271
9249
|
}
|
|
9272
9250
|
}
|
|
9273
9251
|
},
|
|
@@ -9310,6 +9288,27 @@
|
|
|
9310
9288
|
}
|
|
9311
9289
|
}
|
|
9312
9290
|
},
|
|
9291
|
+
"404": {
|
|
9292
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
9293
|
+
"content": {
|
|
9294
|
+
"application/json": {
|
|
9295
|
+
"schema": {
|
|
9296
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
9297
|
+
},
|
|
9298
|
+
"examples": {
|
|
9299
|
+
"exampleResponse": {
|
|
9300
|
+
"value": {
|
|
9301
|
+
"name": "NotFoundError",
|
|
9302
|
+
"message": "errorMessage",
|
|
9303
|
+
"properties": {
|
|
9304
|
+
"notFoundId": "1"
|
|
9305
|
+
}
|
|
9306
|
+
}
|
|
9307
|
+
}
|
|
9308
|
+
}
|
|
9309
|
+
}
|
|
9310
|
+
}
|
|
9311
|
+
},
|
|
9313
9312
|
"500": {
|
|
9314
9313
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
9315
9314
|
"content": {
|
|
@@ -9331,24 +9330,34 @@
|
|
|
9331
9330
|
}
|
|
9332
9331
|
}
|
|
9333
9332
|
},
|
|
9334
|
-
"/
|
|
9335
|
-
"
|
|
9336
|
-
"operationId": "
|
|
9337
|
-
"summary": "
|
|
9333
|
+
"/immutable-proof/{id}": {
|
|
9334
|
+
"get": {
|
|
9335
|
+
"operationId": "immutableProofGet",
|
|
9336
|
+
"summary": "Get a proof",
|
|
9338
9337
|
"tags": [
|
|
9339
|
-
"
|
|
9338
|
+
"Immutable Proof"
|
|
9340
9339
|
],
|
|
9341
9340
|
"parameters": [
|
|
9342
9341
|
{
|
|
9343
9342
|
"name": "id",
|
|
9344
|
-
"description": "The id of the
|
|
9343
|
+
"description": "The id of the immutable proof to get.",
|
|
9345
9344
|
"in": "path",
|
|
9346
9345
|
"required": true,
|
|
9347
9346
|
"schema": {
|
|
9348
9347
|
"type": "string"
|
|
9349
9348
|
},
|
|
9350
9349
|
"style": "simple",
|
|
9351
|
-
"example": "
|
|
9350
|
+
"example": "immutable-proof:1234567890"
|
|
9351
|
+
},
|
|
9352
|
+
{
|
|
9353
|
+
"name": "accept",
|
|
9354
|
+
"in": "header",
|
|
9355
|
+
"required": true,
|
|
9356
|
+
"schema": {
|
|
9357
|
+
"type": "string"
|
|
9358
|
+
},
|
|
9359
|
+
"style": "simple",
|
|
9360
|
+
"example": "application/json"
|
|
9352
9361
|
}
|
|
9353
9362
|
],
|
|
9354
9363
|
"security": [
|
|
@@ -9356,41 +9365,86 @@
|
|
|
9356
9365
|
"jwtBearerAuthScheme": []
|
|
9357
9366
|
}
|
|
9358
9367
|
],
|
|
9359
|
-
"requestBody": {
|
|
9360
|
-
"description": "Update the data and return the receipt.",
|
|
9361
|
-
"required": true,
|
|
9362
|
-
"content": {
|
|
9363
|
-
"application/json": {
|
|
9364
|
-
"schema": {
|
|
9365
|
-
"$ref": "#/components/schemas/VerifiableStorageUpdateRequest"
|
|
9366
|
-
},
|
|
9367
|
-
"examples": {
|
|
9368
|
-
"verifiableStorageUpdateRequestExample": {
|
|
9369
|
-
"value": {
|
|
9370
|
-
"data": "SGVsbG8gd29ybGQ="
|
|
9371
|
-
}
|
|
9372
|
-
}
|
|
9373
|
-
}
|
|
9374
|
-
}
|
|
9375
|
-
}
|
|
9376
|
-
},
|
|
9377
9368
|
"responses": {
|
|
9378
9369
|
"200": {
|
|
9379
|
-
"description": "Response to
|
|
9370
|
+
"description": "Response to getting an immutable proof.",
|
|
9380
9371
|
"content": {
|
|
9381
9372
|
"application/json": {
|
|
9382
9373
|
"schema": {
|
|
9383
|
-
"$ref": "https://schema.twindev.org/
|
|
9374
|
+
"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofCredential"
|
|
9375
|
+
},
|
|
9376
|
+
"examples": {
|
|
9377
|
+
"immutableProofGetResponseExample": {
|
|
9378
|
+
"value": {
|
|
9379
|
+
"@context": [
|
|
9380
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
9381
|
+
"https://schema.twindev.org/immutable-proof/",
|
|
9382
|
+
"https://schema.twindev.org/common/"
|
|
9383
|
+
],
|
|
9384
|
+
"type": [
|
|
9385
|
+
"VerifiableCredential",
|
|
9386
|
+
"ImmutableProof"
|
|
9387
|
+
],
|
|
9388
|
+
"id": "immutable-proof:1234567890",
|
|
9389
|
+
"credentialSubject": {
|
|
9390
|
+
"id": "ais:1234567890",
|
|
9391
|
+
"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
|
|
9392
|
+
},
|
|
9393
|
+
"proof": {
|
|
9394
|
+
"type": "DataIntegrityProof",
|
|
9395
|
+
"cryptosuite": "eddsa-jcs-2022",
|
|
9396
|
+
"created": "2024-08-22T11:56:56.272Z",
|
|
9397
|
+
"proofPurpose": "assertionMethod",
|
|
9398
|
+
"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
|
|
9399
|
+
"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
|
|
9400
|
+
"notarizationId": "notarization:iota:0xabcdef1234567890"
|
|
9401
|
+
}
|
|
9402
|
+
}
|
|
9403
|
+
}
|
|
9404
|
+
}
|
|
9405
|
+
},
|
|
9406
|
+
"application/ld+json": {
|
|
9407
|
+
"schema": {
|
|
9408
|
+
"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofCredential"
|
|
9384
9409
|
},
|
|
9385
9410
|
"examples": {
|
|
9386
|
-
"
|
|
9411
|
+
"immutableProofJsonLdGetResponseExample": {
|
|
9387
9412
|
"value": {
|
|
9388
|
-
"@context":
|
|
9389
|
-
|
|
9413
|
+
"@context": [
|
|
9414
|
+
"https://www.w3.org/2018/credentials/v1",
|
|
9415
|
+
"https://schema.twindev.org/immutable-proof/",
|
|
9416
|
+
"https://schema.twindev.org/common/"
|
|
9417
|
+
],
|
|
9418
|
+
"type": [
|
|
9419
|
+
"VerifiableCredential",
|
|
9420
|
+
"ImmutableProof"
|
|
9421
|
+
],
|
|
9422
|
+
"id": "immutable-proof:1234567890",
|
|
9423
|
+
"credentialSubject": {
|
|
9424
|
+
"id": "ais:1234567890",
|
|
9425
|
+
"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
|
|
9426
|
+
},
|
|
9427
|
+
"proof": {
|
|
9428
|
+
"type": "DataIntegrityProof",
|
|
9429
|
+
"cryptosuite": "eddsa-jcs-2022",
|
|
9430
|
+
"created": "2024-08-22T11:56:56.272Z",
|
|
9431
|
+
"proofPurpose": "assertionMethod",
|
|
9432
|
+
"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
|
|
9433
|
+
"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
|
|
9434
|
+
"notarizationId": "notarization:iota:0xabcdef1234567890"
|
|
9435
|
+
}
|
|
9390
9436
|
}
|
|
9391
9437
|
}
|
|
9392
9438
|
}
|
|
9393
9439
|
}
|
|
9440
|
+
},
|
|
9441
|
+
"headers": {
|
|
9442
|
+
"content-type": {
|
|
9443
|
+
"schema": {
|
|
9444
|
+
"type": "string"
|
|
9445
|
+
},
|
|
9446
|
+
"description": "e.g. application/ld+json"
|
|
9447
|
+
}
|
|
9394
9448
|
}
|
|
9395
9449
|
},
|
|
9396
9450
|
"400": {
|
|
@@ -9432,6 +9486,27 @@
|
|
|
9432
9486
|
}
|
|
9433
9487
|
}
|
|
9434
9488
|
},
|
|
9489
|
+
"404": {
|
|
9490
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
9491
|
+
"content": {
|
|
9492
|
+
"application/json": {
|
|
9493
|
+
"schema": {
|
|
9494
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
9495
|
+
},
|
|
9496
|
+
"examples": {
|
|
9497
|
+
"exampleResponse": {
|
|
9498
|
+
"value": {
|
|
9499
|
+
"name": "NotFoundError",
|
|
9500
|
+
"message": "errorMessage",
|
|
9501
|
+
"properties": {
|
|
9502
|
+
"notFoundId": "1"
|
|
9503
|
+
}
|
|
9504
|
+
}
|
|
9505
|
+
}
|
|
9506
|
+
}
|
|
9507
|
+
}
|
|
9508
|
+
}
|
|
9509
|
+
},
|
|
9435
9510
|
"500": {
|
|
9436
9511
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
9437
9512
|
"content": {
|
|
@@ -9452,23 +9527,23 @@
|
|
|
9452
9527
|
}
|
|
9453
9528
|
}
|
|
9454
9529
|
},
|
|
9455
|
-
"
|
|
9456
|
-
"operationId": "
|
|
9457
|
-
"summary": "
|
|
9530
|
+
"delete": {
|
|
9531
|
+
"operationId": "immutableProofRemove",
|
|
9532
|
+
"summary": "Remove a proof",
|
|
9458
9533
|
"tags": [
|
|
9459
|
-
"
|
|
9534
|
+
"Immutable Proof"
|
|
9460
9535
|
],
|
|
9461
9536
|
"parameters": [
|
|
9462
9537
|
{
|
|
9463
9538
|
"name": "id",
|
|
9464
|
-
"description": "The id of the
|
|
9539
|
+
"description": "The id of the immutable proof to remove.",
|
|
9465
9540
|
"in": "path",
|
|
9466
9541
|
"required": true,
|
|
9467
9542
|
"schema": {
|
|
9468
9543
|
"type": "string"
|
|
9469
9544
|
},
|
|
9470
9545
|
"style": "simple",
|
|
9471
|
-
"example": "
|
|
9546
|
+
"example": "immutable-proof:1234567890"
|
|
9472
9547
|
}
|
|
9473
9548
|
],
|
|
9474
9549
|
"security": [
|
|
@@ -9476,40 +9551,9 @@
|
|
|
9476
9551
|
"jwtBearerAuthScheme": []
|
|
9477
9552
|
}
|
|
9478
9553
|
],
|
|
9479
|
-
"requestBody": {
|
|
9480
|
-
"description": "Get the verifiable storage item.",
|
|
9481
|
-
"required": true,
|
|
9482
|
-
"content": {
|
|
9483
|
-
"application/json": {
|
|
9484
|
-
"schema": {
|
|
9485
|
-
"$ref": "#/components/schemas/VerifiableStorageGetRequest"
|
|
9486
|
-
}
|
|
9487
|
-
}
|
|
9488
|
-
}
|
|
9489
|
-
},
|
|
9490
9554
|
"responses": {
|
|
9491
|
-
"
|
|
9492
|
-
"description": "
|
|
9493
|
-
"content": {
|
|
9494
|
-
"application/json": {
|
|
9495
|
-
"schema": {
|
|
9496
|
-
"$ref": "#/components/schemas/VerifiableStorageGetResponse"
|
|
9497
|
-
},
|
|
9498
|
-
"examples": {
|
|
9499
|
-
"verifiableStorageGetResponseExample": {
|
|
9500
|
-
"value": {
|
|
9501
|
-
"data": "SGVsbG8gd29ybGQ=",
|
|
9502
|
-
"receipt": {
|
|
9503
|
-
"@context": "https://www.w3.org/ns/activitystreams",
|
|
9504
|
-
"type": "Create",
|
|
9505
|
-
"actor": "https://example.org/actor",
|
|
9506
|
-
"object": "https://example.org/object"
|
|
9507
|
-
}
|
|
9508
|
-
}
|
|
9509
|
-
}
|
|
9510
|
-
}
|
|
9511
|
-
}
|
|
9512
|
-
}
|
|
9555
|
+
"204": {
|
|
9556
|
+
"description": "The rest request ended in success with no data."
|
|
9513
9557
|
},
|
|
9514
9558
|
"400": {
|
|
9515
9559
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -9550,6 +9594,27 @@
|
|
|
9550
9594
|
}
|
|
9551
9595
|
}
|
|
9552
9596
|
},
|
|
9597
|
+
"404": {
|
|
9598
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
9599
|
+
"content": {
|
|
9600
|
+
"application/json": {
|
|
9601
|
+
"schema": {
|
|
9602
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
9603
|
+
},
|
|
9604
|
+
"examples": {
|
|
9605
|
+
"exampleResponse": {
|
|
9606
|
+
"value": {
|
|
9607
|
+
"name": "NotFoundError",
|
|
9608
|
+
"message": "errorMessage",
|
|
9609
|
+
"properties": {
|
|
9610
|
+
"notFoundId": "1"
|
|
9611
|
+
}
|
|
9612
|
+
}
|
|
9613
|
+
}
|
|
9614
|
+
}
|
|
9615
|
+
}
|
|
9616
|
+
}
|
|
9617
|
+
},
|
|
9553
9618
|
"500": {
|
|
9554
9619
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
9555
9620
|
"content": {
|
|
@@ -9569,24 +9634,35 @@
|
|
|
9569
9634
|
}
|
|
9570
9635
|
}
|
|
9571
9636
|
}
|
|
9572
|
-
}
|
|
9573
|
-
|
|
9574
|
-
|
|
9575
|
-
|
|
9637
|
+
}
|
|
9638
|
+
},
|
|
9639
|
+
"/immutable-proof/{id}/verify": {
|
|
9640
|
+
"get": {
|
|
9641
|
+
"operationId": "immutableProofVerify",
|
|
9642
|
+
"summary": "Verify a proof",
|
|
9576
9643
|
"tags": [
|
|
9577
|
-
"
|
|
9644
|
+
"Immutable Proof"
|
|
9578
9645
|
],
|
|
9579
9646
|
"parameters": [
|
|
9580
9647
|
{
|
|
9581
9648
|
"name": "id",
|
|
9582
|
-
"description": "The id of the
|
|
9649
|
+
"description": "The id of the immutable proof to verify.",
|
|
9583
9650
|
"in": "path",
|
|
9584
9651
|
"required": true,
|
|
9585
9652
|
"schema": {
|
|
9586
9653
|
"type": "string"
|
|
9587
9654
|
},
|
|
9588
9655
|
"style": "simple",
|
|
9589
|
-
"example": "
|
|
9656
|
+
"example": "immutable-proof:1234567890"
|
|
9657
|
+
},
|
|
9658
|
+
{
|
|
9659
|
+
"name": "accept",
|
|
9660
|
+
"in": "header",
|
|
9661
|
+
"required": true,
|
|
9662
|
+
"schema": {
|
|
9663
|
+
"type": "string"
|
|
9664
|
+
},
|
|
9665
|
+
"style": "simple"
|
|
9590
9666
|
}
|
|
9591
9667
|
],
|
|
9592
9668
|
"security": [
|
|
@@ -9595,114 +9671,32 @@
|
|
|
9595
9671
|
}
|
|
9596
9672
|
],
|
|
9597
9673
|
"responses": {
|
|
9598
|
-
"
|
|
9599
|
-
"description": "
|
|
9600
|
-
},
|
|
9601
|
-
"400": {
|
|
9602
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
9674
|
+
"200": {
|
|
9675
|
+
"description": "Response to verifying an immutable proof.",
|
|
9603
9676
|
"content": {
|
|
9604
9677
|
"application/json": {
|
|
9605
9678
|
"schema": {
|
|
9606
|
-
"$ref": "
|
|
9679
|
+
"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofVerification"
|
|
9607
9680
|
},
|
|
9608
9681
|
"examples": {
|
|
9609
|
-
"
|
|
9610
|
-
"value": {
|
|
9611
|
-
"name": "GeneralError",
|
|
9612
|
-
"message": "errorMessage",
|
|
9613
|
-
"properties": {
|
|
9614
|
-
"foo": "bar"
|
|
9615
|
-
}
|
|
9616
|
-
}
|
|
9617
|
-
}
|
|
9618
|
-
}
|
|
9619
|
-
}
|
|
9620
|
-
}
|
|
9621
|
-
},
|
|
9622
|
-
"401": {
|
|
9623
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
9624
|
-
"content": {
|
|
9625
|
-
"application/json": {
|
|
9626
|
-
"schema": {
|
|
9627
|
-
"$ref": "#/components/schemas/Error"
|
|
9628
|
-
},
|
|
9629
|
-
"examples": {
|
|
9630
|
-
"exampleResponse": {
|
|
9682
|
+
"immutableProofVerifyResponseExample": {
|
|
9631
9683
|
"value": {
|
|
9632
|
-
"
|
|
9633
|
-
"
|
|
9684
|
+
"@context": "https://schema.twindev.org/immutable-proof/",
|
|
9685
|
+
"type": "ImmutableProofVerification",
|
|
9686
|
+
"verified": true
|
|
9634
9687
|
}
|
|
9635
|
-
}
|
|
9636
|
-
|
|
9637
|
-
}
|
|
9638
|
-
}
|
|
9639
|
-
},
|
|
9640
|
-
"500": {
|
|
9641
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
9642
|
-
"content": {
|
|
9643
|
-
"application/json": {
|
|
9644
|
-
"schema": {
|
|
9645
|
-
"$ref": "#/components/schemas/Error"
|
|
9646
|
-
},
|
|
9647
|
-
"examples": {
|
|
9648
|
-
"exampleResponse": {
|
|
9688
|
+
},
|
|
9689
|
+
"immutableProofVerifyResponseFailExample": {
|
|
9649
9690
|
"value": {
|
|
9650
|
-
"
|
|
9651
|
-
"
|
|
9652
|
-
|
|
9653
|
-
|
|
9654
|
-
}
|
|
9655
|
-
}
|
|
9656
|
-
}
|
|
9657
|
-
}
|
|
9658
|
-
}
|
|
9659
|
-
}
|
|
9660
|
-
},
|
|
9661
|
-
"/immutable-proof": {
|
|
9662
|
-
"post": {
|
|
9663
|
-
"operationId": "immutableProofCreate",
|
|
9664
|
-
"summary": "Create a proof",
|
|
9665
|
-
"tags": [
|
|
9666
|
-
"Immutable Proof"
|
|
9667
|
-
],
|
|
9668
|
-
"security": [
|
|
9669
|
-
{
|
|
9670
|
-
"jwtBearerAuthScheme": []
|
|
9671
|
-
}
|
|
9672
|
-
],
|
|
9673
|
-
"requestBody": {
|
|
9674
|
-
"description": "Create a proof.",
|
|
9675
|
-
"required": true,
|
|
9676
|
-
"content": {
|
|
9677
|
-
"application/json": {
|
|
9678
|
-
"schema": {
|
|
9679
|
-
"$ref": "#/components/schemas/ImmutableProofCreateRequest"
|
|
9680
|
-
},
|
|
9681
|
-
"examples": {
|
|
9682
|
-
"immutableProofCreateRequestExample": {
|
|
9683
|
-
"value": {
|
|
9684
|
-
"document": {
|
|
9685
|
-
"@context": "https://schema.org",
|
|
9686
|
-
"type": "Person",
|
|
9687
|
-
"name": "John Smith"
|
|
9691
|
+
"@context": "https://schema.twindev.org/immutable-proof/",
|
|
9692
|
+
"type": "ImmutableProofVerification",
|
|
9693
|
+
"verified": false,
|
|
9694
|
+
"failure": "verificationFailure"
|
|
9688
9695
|
}
|
|
9689
9696
|
}
|
|
9690
9697
|
}
|
|
9691
9698
|
}
|
|
9692
9699
|
}
|
|
9693
|
-
}
|
|
9694
|
-
},
|
|
9695
|
-
"responses": {
|
|
9696
|
-
"201": {
|
|
9697
|
-
"description": "The rest request ended in created response.",
|
|
9698
|
-
"headers": {
|
|
9699
|
-
"location": {
|
|
9700
|
-
"schema": {
|
|
9701
|
-
"type": "string"
|
|
9702
|
-
},
|
|
9703
|
-
"description": "e.g. test%3A1234567890"
|
|
9704
|
-
}
|
|
9705
|
-
}
|
|
9706
9700
|
},
|
|
9707
9701
|
"400": {
|
|
9708
9702
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -9785,17 +9779,17 @@
|
|
|
9785
9779
|
}
|
|
9786
9780
|
}
|
|
9787
9781
|
},
|
|
9788
|
-
"/immutable-proof/{id}": {
|
|
9789
|
-
"
|
|
9790
|
-
"operationId": "
|
|
9791
|
-
"summary": "
|
|
9782
|
+
"/immutable-proof/{id}/notarization": {
|
|
9783
|
+
"delete": {
|
|
9784
|
+
"operationId": "immutableProofRemoveNotarization",
|
|
9785
|
+
"summary": "Remove the notarization for a proof",
|
|
9792
9786
|
"tags": [
|
|
9793
9787
|
"Immutable Proof"
|
|
9794
9788
|
],
|
|
9795
9789
|
"parameters": [
|
|
9796
9790
|
{
|
|
9797
9791
|
"name": "id",
|
|
9798
|
-
"description": "The id of the immutable proof to
|
|
9792
|
+
"description": "The id of the immutable proof to remove the notarization from.",
|
|
9799
9793
|
"in": "path",
|
|
9800
9794
|
"required": true,
|
|
9801
9795
|
"schema": {
|
|
@@ -9803,16 +9797,6 @@
|
|
|
9803
9797
|
},
|
|
9804
9798
|
"style": "simple",
|
|
9805
9799
|
"example": "immutable-proof:1234567890"
|
|
9806
|
-
},
|
|
9807
|
-
{
|
|
9808
|
-
"name": "accept",
|
|
9809
|
-
"in": "header",
|
|
9810
|
-
"required": true,
|
|
9811
|
-
"schema": {
|
|
9812
|
-
"type": "string"
|
|
9813
|
-
},
|
|
9814
|
-
"style": "simple",
|
|
9815
|
-
"example": "application/json"
|
|
9816
9800
|
}
|
|
9817
9801
|
],
|
|
9818
9802
|
"security": [
|
|
@@ -9821,86 +9805,8 @@
|
|
|
9821
9805
|
}
|
|
9822
9806
|
],
|
|
9823
9807
|
"responses": {
|
|
9824
|
-
"
|
|
9825
|
-
"description": "
|
|
9826
|
-
"content": {
|
|
9827
|
-
"application/json": {
|
|
9828
|
-
"schema": {
|
|
9829
|
-
"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofCredential"
|
|
9830
|
-
},
|
|
9831
|
-
"examples": {
|
|
9832
|
-
"immutableProofGetResponseExample": {
|
|
9833
|
-
"value": {
|
|
9834
|
-
"@context": [
|
|
9835
|
-
"https://www.w3.org/2018/credentials/v1",
|
|
9836
|
-
"https://schema.twindev.org/immutable-proof/",
|
|
9837
|
-
"https://schema.twindev.org/common/"
|
|
9838
|
-
],
|
|
9839
|
-
"type": [
|
|
9840
|
-
"VerifiableCredential",
|
|
9841
|
-
"ImmutableProof"
|
|
9842
|
-
],
|
|
9843
|
-
"id": "immutable-proof:1234567890",
|
|
9844
|
-
"credentialSubject": {
|
|
9845
|
-
"id": "ais:1234567890",
|
|
9846
|
-
"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
|
|
9847
|
-
},
|
|
9848
|
-
"proof": {
|
|
9849
|
-
"type": "DataIntegrityProof",
|
|
9850
|
-
"cryptosuite": "eddsa-jcs-2022",
|
|
9851
|
-
"created": "2024-08-22T11:56:56.272Z",
|
|
9852
|
-
"proofPurpose": "assertionMethod",
|
|
9853
|
-
"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
|
|
9854
|
-
"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
|
|
9855
|
-
"notarizationId": "notarization:iota:0xabcdef1234567890"
|
|
9856
|
-
}
|
|
9857
|
-
}
|
|
9858
|
-
}
|
|
9859
|
-
}
|
|
9860
|
-
},
|
|
9861
|
-
"application/ld+json": {
|
|
9862
|
-
"schema": {
|
|
9863
|
-
"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofCredential"
|
|
9864
|
-
},
|
|
9865
|
-
"examples": {
|
|
9866
|
-
"immutableProofJsonLdGetResponseExample": {
|
|
9867
|
-
"value": {
|
|
9868
|
-
"@context": [
|
|
9869
|
-
"https://www.w3.org/2018/credentials/v1",
|
|
9870
|
-
"https://schema.twindev.org/immutable-proof/",
|
|
9871
|
-
"https://schema.twindev.org/common/"
|
|
9872
|
-
],
|
|
9873
|
-
"type": [
|
|
9874
|
-
"VerifiableCredential",
|
|
9875
|
-
"ImmutableProof"
|
|
9876
|
-
],
|
|
9877
|
-
"id": "immutable-proof:1234567890",
|
|
9878
|
-
"credentialSubject": {
|
|
9879
|
-
"id": "ais:1234567890",
|
|
9880
|
-
"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
|
|
9881
|
-
},
|
|
9882
|
-
"proof": {
|
|
9883
|
-
"type": "DataIntegrityProof",
|
|
9884
|
-
"cryptosuite": "eddsa-jcs-2022",
|
|
9885
|
-
"created": "2024-08-22T11:56:56.272Z",
|
|
9886
|
-
"proofPurpose": "assertionMethod",
|
|
9887
|
-
"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
|
|
9888
|
-
"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
|
|
9889
|
-
"notarizationId": "notarization:iota:0xabcdef1234567890"
|
|
9890
|
-
}
|
|
9891
|
-
}
|
|
9892
|
-
}
|
|
9893
|
-
}
|
|
9894
|
-
}
|
|
9895
|
-
},
|
|
9896
|
-
"headers": {
|
|
9897
|
-
"content-type": {
|
|
9898
|
-
"schema": {
|
|
9899
|
-
"type": "string"
|
|
9900
|
-
},
|
|
9901
|
-
"description": "e.g. application/ld+json"
|
|
9902
|
-
}
|
|
9903
|
-
}
|
|
9808
|
+
"204": {
|
|
9809
|
+
"description": "The rest request ended in success with no data."
|
|
9904
9810
|
},
|
|
9905
9811
|
"400": {
|
|
9906
9812
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -9981,24 +9887,26 @@
|
|
|
9981
9887
|
}
|
|
9982
9888
|
}
|
|
9983
9889
|
}
|
|
9984
|
-
}
|
|
9985
|
-
|
|
9986
|
-
|
|
9987
|
-
|
|
9890
|
+
}
|
|
9891
|
+
},
|
|
9892
|
+
"/data-processing/rule-group/{id}": {
|
|
9893
|
+
"put": {
|
|
9894
|
+
"operationId": "dataProcessingSetRuleGroup",
|
|
9895
|
+
"summary": "Store a rule group for extraction.",
|
|
9988
9896
|
"tags": [
|
|
9989
|
-
"
|
|
9897
|
+
"Data Processing"
|
|
9990
9898
|
],
|
|
9991
9899
|
"parameters": [
|
|
9992
9900
|
{
|
|
9993
9901
|
"name": "id",
|
|
9994
|
-
"description": "The id
|
|
9902
|
+
"description": "The rule id to set.",
|
|
9995
9903
|
"in": "path",
|
|
9996
9904
|
"required": true,
|
|
9997
9905
|
"schema": {
|
|
9998
9906
|
"type": "string"
|
|
9999
9907
|
},
|
|
10000
9908
|
"style": "simple",
|
|
10001
|
-
"example": "
|
|
9909
|
+
"example": "my-rule-group"
|
|
10002
9910
|
}
|
|
10003
9911
|
],
|
|
10004
9912
|
"security": [
|
|
@@ -10006,6 +9914,31 @@
|
|
|
10006
9914
|
"jwtBearerAuthScheme": []
|
|
10007
9915
|
}
|
|
10008
9916
|
],
|
|
9917
|
+
"requestBody": {
|
|
9918
|
+
"description": "Set a rule group.",
|
|
9919
|
+
"required": true,
|
|
9920
|
+
"content": {
|
|
9921
|
+
"application/json": {
|
|
9922
|
+
"schema": {
|
|
9923
|
+
"$ref": "#/components/schemas/DataProcessingRuleGroupSetRequest"
|
|
9924
|
+
},
|
|
9925
|
+
"examples": {
|
|
9926
|
+
"dataProcessingRuleGroupSetRequestExample": {
|
|
9927
|
+
"value": {
|
|
9928
|
+
"label": "My Rule Group",
|
|
9929
|
+
"rules": [
|
|
9930
|
+
{
|
|
9931
|
+
"source": "$.foo",
|
|
9932
|
+
"target": "goo",
|
|
9933
|
+
"coerce": "bigint"
|
|
9934
|
+
}
|
|
9935
|
+
]
|
|
9936
|
+
}
|
|
9937
|
+
}
|
|
9938
|
+
}
|
|
9939
|
+
}
|
|
9940
|
+
}
|
|
9941
|
+
},
|
|
10009
9942
|
"responses": {
|
|
10010
9943
|
"204": {
|
|
10011
9944
|
"description": "The rest request ended in success with no data."
|
|
@@ -10049,39 +9982,18 @@
|
|
|
10049
9982
|
}
|
|
10050
9983
|
}
|
|
10051
9984
|
},
|
|
10052
|
-
"
|
|
10053
|
-
"description": "The
|
|
9985
|
+
"500": {
|
|
9986
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
10054
9987
|
"content": {
|
|
10055
9988
|
"application/json": {
|
|
10056
9989
|
"schema": {
|
|
10057
|
-
"$ref": "#/components/schemas/
|
|
9990
|
+
"$ref": "#/components/schemas/Error"
|
|
10058
9991
|
},
|
|
10059
9992
|
"examples": {
|
|
10060
9993
|
"exampleResponse": {
|
|
10061
9994
|
"value": {
|
|
10062
|
-
"name": "
|
|
10063
|
-
"message": "errorMessage"
|
|
10064
|
-
"properties": {
|
|
10065
|
-
"notFoundId": "1"
|
|
10066
|
-
}
|
|
10067
|
-
}
|
|
10068
|
-
}
|
|
10069
|
-
}
|
|
10070
|
-
}
|
|
10071
|
-
}
|
|
10072
|
-
},
|
|
10073
|
-
"500": {
|
|
10074
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
10075
|
-
"content": {
|
|
10076
|
-
"application/json": {
|
|
10077
|
-
"schema": {
|
|
10078
|
-
"$ref": "#/components/schemas/Error"
|
|
10079
|
-
},
|
|
10080
|
-
"examples": {
|
|
10081
|
-
"exampleResponse": {
|
|
10082
|
-
"value": {
|
|
10083
|
-
"name": "InternalServerError",
|
|
10084
|
-
"message": "errorMessage"
|
|
9995
|
+
"name": "InternalServerError",
|
|
9996
|
+
"message": "errorMessage"
|
|
10085
9997
|
}
|
|
10086
9998
|
}
|
|
10087
9999
|
}
|
|
@@ -10089,35 +10001,24 @@
|
|
|
10089
10001
|
}
|
|
10090
10002
|
}
|
|
10091
10003
|
}
|
|
10092
|
-
}
|
|
10093
|
-
},
|
|
10094
|
-
"/immutable-proof/{id}/verify": {
|
|
10004
|
+
},
|
|
10095
10005
|
"get": {
|
|
10096
|
-
"operationId": "
|
|
10097
|
-
"summary": "
|
|
10006
|
+
"operationId": "dataProcessingGetRuleGroup",
|
|
10007
|
+
"summary": "Get a rule group for extraction.",
|
|
10098
10008
|
"tags": [
|
|
10099
|
-
"
|
|
10009
|
+
"Data Processing"
|
|
10100
10010
|
],
|
|
10101
10011
|
"parameters": [
|
|
10102
10012
|
{
|
|
10103
10013
|
"name": "id",
|
|
10104
|
-
"description": "The id
|
|
10014
|
+
"description": "The rule id to set.",
|
|
10105
10015
|
"in": "path",
|
|
10106
10016
|
"required": true,
|
|
10107
10017
|
"schema": {
|
|
10108
10018
|
"type": "string"
|
|
10109
10019
|
},
|
|
10110
10020
|
"style": "simple",
|
|
10111
|
-
"example": "
|
|
10112
|
-
},
|
|
10113
|
-
{
|
|
10114
|
-
"name": "accept",
|
|
10115
|
-
"in": "header",
|
|
10116
|
-
"required": true,
|
|
10117
|
-
"schema": {
|
|
10118
|
-
"type": "string"
|
|
10119
|
-
},
|
|
10120
|
-
"style": "simple"
|
|
10021
|
+
"example": "my-rule-group"
|
|
10121
10022
|
}
|
|
10122
10023
|
],
|
|
10123
10024
|
"security": [
|
|
@@ -10127,26 +10028,24 @@
|
|
|
10127
10028
|
],
|
|
10128
10029
|
"responses": {
|
|
10129
10030
|
"200": {
|
|
10130
|
-
"description": "
|
|
10031
|
+
"description": "Get a rule group response.",
|
|
10131
10032
|
"content": {
|
|
10132
10033
|
"application/json": {
|
|
10133
10034
|
"schema": {
|
|
10134
|
-
"$ref": "
|
|
10035
|
+
"$ref": "#/components/schemas/RuleGroup"
|
|
10135
10036
|
},
|
|
10136
10037
|
"examples": {
|
|
10137
|
-
"
|
|
10138
|
-
"value": {
|
|
10139
|
-
"@context": "https://schema.twindev.org/immutable-proof/",
|
|
10140
|
-
"type": "ImmutableProofVerification",
|
|
10141
|
-
"verified": true
|
|
10142
|
-
}
|
|
10143
|
-
},
|
|
10144
|
-
"immutableProofVerifyResponseFailExample": {
|
|
10038
|
+
"dataProcessingRuleGroupSetResponseExample": {
|
|
10145
10039
|
"value": {
|
|
10146
|
-
"
|
|
10147
|
-
"
|
|
10148
|
-
"
|
|
10149
|
-
|
|
10040
|
+
"id": "my-rule-group",
|
|
10041
|
+
"label": "My Rule Group",
|
|
10042
|
+
"rules": [
|
|
10043
|
+
{
|
|
10044
|
+
"source": "$.foo",
|
|
10045
|
+
"target": "goo",
|
|
10046
|
+
"coerce": "bigint"
|
|
10047
|
+
}
|
|
10048
|
+
]
|
|
10150
10049
|
}
|
|
10151
10050
|
}
|
|
10152
10051
|
}
|
|
@@ -10192,27 +10091,6 @@
|
|
|
10192
10091
|
}
|
|
10193
10092
|
}
|
|
10194
10093
|
},
|
|
10195
|
-
"404": {
|
|
10196
|
-
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
10197
|
-
"content": {
|
|
10198
|
-
"application/json": {
|
|
10199
|
-
"schema": {
|
|
10200
|
-
"$ref": "#/components/schemas/NotFoundResponse"
|
|
10201
|
-
},
|
|
10202
|
-
"examples": {
|
|
10203
|
-
"exampleResponse": {
|
|
10204
|
-
"value": {
|
|
10205
|
-
"name": "NotFoundError",
|
|
10206
|
-
"message": "errorMessage",
|
|
10207
|
-
"properties": {
|
|
10208
|
-
"notFoundId": "1"
|
|
10209
|
-
}
|
|
10210
|
-
}
|
|
10211
|
-
}
|
|
10212
|
-
}
|
|
10213
|
-
}
|
|
10214
|
-
}
|
|
10215
|
-
},
|
|
10216
10094
|
"500": {
|
|
10217
10095
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
10218
10096
|
"content": {
|
|
@@ -10232,26 +10110,24 @@
|
|
|
10232
10110
|
}
|
|
10233
10111
|
}
|
|
10234
10112
|
}
|
|
10235
|
-
}
|
|
10236
|
-
},
|
|
10237
|
-
"/immutable-proof/{id}/notarization": {
|
|
10113
|
+
},
|
|
10238
10114
|
"delete": {
|
|
10239
|
-
"operationId": "
|
|
10240
|
-
"summary": "Remove
|
|
10115
|
+
"operationId": "dataProcessingRemoveRuleGroup",
|
|
10116
|
+
"summary": "Remove an extraction rule group.",
|
|
10241
10117
|
"tags": [
|
|
10242
|
-
"
|
|
10118
|
+
"Data Processing"
|
|
10243
10119
|
],
|
|
10244
10120
|
"parameters": [
|
|
10245
10121
|
{
|
|
10246
10122
|
"name": "id",
|
|
10247
|
-
"description": "The id
|
|
10123
|
+
"description": "The rule id to remove.",
|
|
10248
10124
|
"in": "path",
|
|
10249
10125
|
"required": true,
|
|
10250
10126
|
"schema": {
|
|
10251
10127
|
"type": "string"
|
|
10252
10128
|
},
|
|
10253
10129
|
"style": "simple",
|
|
10254
|
-
"example": "
|
|
10130
|
+
"example": "my-rule-group"
|
|
10255
10131
|
}
|
|
10256
10132
|
],
|
|
10257
10133
|
"security": [
|
|
@@ -10302,27 +10178,6 @@
|
|
|
10302
10178
|
}
|
|
10303
10179
|
}
|
|
10304
10180
|
},
|
|
10305
|
-
"404": {
|
|
10306
|
-
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
10307
|
-
"content": {
|
|
10308
|
-
"application/json": {
|
|
10309
|
-
"schema": {
|
|
10310
|
-
"$ref": "#/components/schemas/NotFoundResponse"
|
|
10311
|
-
},
|
|
10312
|
-
"examples": {
|
|
10313
|
-
"exampleResponse": {
|
|
10314
|
-
"value": {
|
|
10315
|
-
"name": "NotFoundError",
|
|
10316
|
-
"message": "errorMessage",
|
|
10317
|
-
"properties": {
|
|
10318
|
-
"notFoundId": "1"
|
|
10319
|
-
}
|
|
10320
|
-
}
|
|
10321
|
-
}
|
|
10322
|
-
}
|
|
10323
|
-
}
|
|
10324
|
-
}
|
|
10325
|
-
},
|
|
10326
10181
|
"500": {
|
|
10327
10182
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
10328
10183
|
"content": {
|
|
@@ -10344,50 +10199,31 @@
|
|
|
10344
10199
|
}
|
|
10345
10200
|
}
|
|
10346
10201
|
},
|
|
10347
|
-
"/data-processing/
|
|
10348
|
-
"
|
|
10349
|
-
"operationId": "
|
|
10350
|
-
"summary": "
|
|
10202
|
+
"/data-processing/extract": {
|
|
10203
|
+
"post": {
|
|
10204
|
+
"operationId": "dataProcessingExtract",
|
|
10205
|
+
"summary": "Extract data from a binary source using the specified rule group.",
|
|
10351
10206
|
"tags": [
|
|
10352
10207
|
"Data Processing"
|
|
10353
10208
|
],
|
|
10354
|
-
"parameters": [
|
|
10355
|
-
{
|
|
10356
|
-
"name": "id",
|
|
10357
|
-
"description": "The rule id to set.",
|
|
10358
|
-
"in": "path",
|
|
10359
|
-
"required": true,
|
|
10360
|
-
"schema": {
|
|
10361
|
-
"type": "string"
|
|
10362
|
-
},
|
|
10363
|
-
"style": "simple",
|
|
10364
|
-
"example": "my-rule-group"
|
|
10365
|
-
}
|
|
10366
|
-
],
|
|
10367
10209
|
"security": [
|
|
10368
10210
|
{
|
|
10369
10211
|
"jwtBearerAuthScheme": []
|
|
10370
10212
|
}
|
|
10371
10213
|
],
|
|
10372
10214
|
"requestBody": {
|
|
10373
|
-
"description": "
|
|
10215
|
+
"description": "Perform an extraction on the data with the specified ruleset.",
|
|
10374
10216
|
"required": true,
|
|
10375
10217
|
"content": {
|
|
10376
10218
|
"application/json": {
|
|
10377
10219
|
"schema": {
|
|
10378
|
-
"$ref": "#/components/schemas/
|
|
10220
|
+
"$ref": "#/components/schemas/DataProcessingExtractRequest"
|
|
10379
10221
|
},
|
|
10380
10222
|
"examples": {
|
|
10381
|
-
"
|
|
10223
|
+
"dataProcessingExtractRequestExample": {
|
|
10382
10224
|
"value": {
|
|
10383
|
-
"
|
|
10384
|
-
"
|
|
10385
|
-
{
|
|
10386
|
-
"source": "$.foo",
|
|
10387
|
-
"target": "goo",
|
|
10388
|
-
"coerce": "bigint"
|
|
10389
|
-
}
|
|
10390
|
-
]
|
|
10225
|
+
"ruleGroupId": "my-rule-group",
|
|
10226
|
+
"data": "eyJmb28iOiAiYmFyIn0="
|
|
10391
10227
|
}
|
|
10392
10228
|
}
|
|
10393
10229
|
}
|
|
@@ -10395,8 +10231,22 @@
|
|
|
10395
10231
|
}
|
|
10396
10232
|
},
|
|
10397
10233
|
"responses": {
|
|
10398
|
-
"
|
|
10399
|
-
"description": "
|
|
10234
|
+
"200": {
|
|
10235
|
+
"description": "Response to extracting data.",
|
|
10236
|
+
"content": {
|
|
10237
|
+
"application/json": {
|
|
10238
|
+
"schema": {
|
|
10239
|
+
"$ref": "#/components/schemas/DataProcessingExtractResponse"
|
|
10240
|
+
},
|
|
10241
|
+
"examples": {
|
|
10242
|
+
"dataProcessingExtractResponseExample": {
|
|
10243
|
+
"value": {
|
|
10244
|
+
"foo": "bar"
|
|
10245
|
+
}
|
|
10246
|
+
}
|
|
10247
|
+
}
|
|
10248
|
+
}
|
|
10249
|
+
}
|
|
10400
10250
|
},
|
|
10401
10251
|
"400": {
|
|
10402
10252
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -10456,51 +10306,50 @@
|
|
|
10456
10306
|
}
|
|
10457
10307
|
}
|
|
10458
10308
|
}
|
|
10459
|
-
}
|
|
10460
|
-
|
|
10461
|
-
|
|
10462
|
-
|
|
10309
|
+
}
|
|
10310
|
+
},
|
|
10311
|
+
"/data-processing/convert": {
|
|
10312
|
+
"post": {
|
|
10313
|
+
"operationId": "dataProcessingConvert",
|
|
10314
|
+
"summary": "Convert data from a binary source and return structured object.",
|
|
10463
10315
|
"tags": [
|
|
10464
10316
|
"Data Processing"
|
|
10465
10317
|
],
|
|
10466
|
-
"parameters": [
|
|
10467
|
-
{
|
|
10468
|
-
"name": "id",
|
|
10469
|
-
"description": "The rule id to set.",
|
|
10470
|
-
"in": "path",
|
|
10471
|
-
"required": true,
|
|
10472
|
-
"schema": {
|
|
10473
|
-
"type": "string"
|
|
10474
|
-
},
|
|
10475
|
-
"style": "simple",
|
|
10476
|
-
"example": "my-rule-group"
|
|
10477
|
-
}
|
|
10478
|
-
],
|
|
10479
10318
|
"security": [
|
|
10480
10319
|
{
|
|
10481
10320
|
"jwtBearerAuthScheme": []
|
|
10482
10321
|
}
|
|
10483
10322
|
],
|
|
10323
|
+
"requestBody": {
|
|
10324
|
+
"description": "Perform a conversion on the data.",
|
|
10325
|
+
"required": true,
|
|
10326
|
+
"content": {
|
|
10327
|
+
"application/json": {
|
|
10328
|
+
"schema": {
|
|
10329
|
+
"$ref": "#/components/schemas/DataProcessingConvertRequest"
|
|
10330
|
+
},
|
|
10331
|
+
"examples": {
|
|
10332
|
+
"dataProcessingConvertRequestExample": {
|
|
10333
|
+
"value": {
|
|
10334
|
+
"data": "eyJmb28iOiAiYmFyIn0="
|
|
10335
|
+
}
|
|
10336
|
+
}
|
|
10337
|
+
}
|
|
10338
|
+
}
|
|
10339
|
+
}
|
|
10340
|
+
},
|
|
10484
10341
|
"responses": {
|
|
10485
10342
|
"200": {
|
|
10486
|
-
"description": "
|
|
10343
|
+
"description": "Response to converting data.",
|
|
10487
10344
|
"content": {
|
|
10488
10345
|
"application/json": {
|
|
10489
10346
|
"schema": {
|
|
10490
|
-
"$ref": "#/components/schemas/
|
|
10347
|
+
"$ref": "#/components/schemas/DataProcessingConvertResponse"
|
|
10491
10348
|
},
|
|
10492
10349
|
"examples": {
|
|
10493
|
-
"
|
|
10350
|
+
"dataProcessingConvertResponseExample": {
|
|
10494
10351
|
"value": {
|
|
10495
|
-
"
|
|
10496
|
-
"label": "My Rule Group",
|
|
10497
|
-
"rules": [
|
|
10498
|
-
{
|
|
10499
|
-
"source": "$.foo",
|
|
10500
|
-
"target": "goo",
|
|
10501
|
-
"coerce": "bigint"
|
|
10502
|
-
}
|
|
10503
|
-
]
|
|
10352
|
+
"foo": "bar"
|
|
10504
10353
|
}
|
|
10505
10354
|
}
|
|
10506
10355
|
}
|
|
@@ -10565,34 +10414,50 @@
|
|
|
10565
10414
|
}
|
|
10566
10415
|
}
|
|
10567
10416
|
}
|
|
10568
|
-
}
|
|
10569
|
-
|
|
10570
|
-
|
|
10571
|
-
|
|
10417
|
+
}
|
|
10418
|
+
},
|
|
10419
|
+
"/data-processing/rule-group": {
|
|
10420
|
+
"get": {
|
|
10421
|
+
"operationId": "dataProcessingListRuleGroup",
|
|
10422
|
+
"summary": "Get a list with rule groups for extraction.",
|
|
10572
10423
|
"tags": [
|
|
10573
10424
|
"Data Processing"
|
|
10574
10425
|
],
|
|
10575
|
-
"
|
|
10426
|
+
"security": [
|
|
10576
10427
|
{
|
|
10577
|
-
"
|
|
10578
|
-
"description": "The rule id to remove.",
|
|
10579
|
-
"in": "path",
|
|
10580
|
-
"required": true,
|
|
10581
|
-
"schema": {
|
|
10582
|
-
"type": "string"
|
|
10583
|
-
},
|
|
10584
|
-
"style": "simple",
|
|
10585
|
-
"example": "my-rule-group"
|
|
10586
|
-
}
|
|
10587
|
-
],
|
|
10588
|
-
"security": [
|
|
10589
|
-
{
|
|
10590
|
-
"jwtBearerAuthScheme": []
|
|
10428
|
+
"jwtBearerAuthScheme": []
|
|
10591
10429
|
}
|
|
10592
10430
|
],
|
|
10593
10431
|
"responses": {
|
|
10594
|
-
"
|
|
10595
|
-
"description": "
|
|
10432
|
+
"200": {
|
|
10433
|
+
"description": "Response for rule group entry list request.",
|
|
10434
|
+
"content": {
|
|
10435
|
+
"application/json": {
|
|
10436
|
+
"schema": {
|
|
10437
|
+
"$ref": "#/components/schemas/DataProcessingRuleGroupListResponse"
|
|
10438
|
+
},
|
|
10439
|
+
"examples": {
|
|
10440
|
+
"ruleGroupListResponseExample": {
|
|
10441
|
+
"value": {
|
|
10442
|
+
"entities": [
|
|
10443
|
+
{
|
|
10444
|
+
"id": "my-rule-group",
|
|
10445
|
+
"label": "My Rule Group",
|
|
10446
|
+
"rules": [
|
|
10447
|
+
{
|
|
10448
|
+
"source": "$.foo",
|
|
10449
|
+
"target": "goo",
|
|
10450
|
+
"coerce": "bigint"
|
|
10451
|
+
}
|
|
10452
|
+
]
|
|
10453
|
+
}
|
|
10454
|
+
],
|
|
10455
|
+
"cursor": "1"
|
|
10456
|
+
}
|
|
10457
|
+
}
|
|
10458
|
+
}
|
|
10459
|
+
}
|
|
10460
|
+
}
|
|
10596
10461
|
},
|
|
10597
10462
|
"400": {
|
|
10598
10463
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -10654,12 +10519,12 @@
|
|
|
10654
10519
|
}
|
|
10655
10520
|
}
|
|
10656
10521
|
},
|
|
10657
|
-
"/
|
|
10522
|
+
"/document-management": {
|
|
10658
10523
|
"post": {
|
|
10659
|
-
"operationId": "
|
|
10660
|
-
"summary": "
|
|
10524
|
+
"operationId": "DocumentManagementSet",
|
|
10525
|
+
"summary": "Store a document in an auditable item graph vertex and add its content to blob storage.",
|
|
10661
10526
|
"tags": [
|
|
10662
|
-
"
|
|
10527
|
+
"Document Management"
|
|
10663
10528
|
],
|
|
10664
10529
|
"security": [
|
|
10665
10530
|
{
|
|
@@ -10667,18 +10532,26 @@
|
|
|
10667
10532
|
}
|
|
10668
10533
|
],
|
|
10669
10534
|
"requestBody": {
|
|
10670
|
-
"description": "
|
|
10535
|
+
"description": "Request to create a document as an auditable item graph vertex.",
|
|
10671
10536
|
"required": true,
|
|
10672
10537
|
"content": {
|
|
10673
10538
|
"application/json": {
|
|
10674
10539
|
"schema": {
|
|
10675
|
-
"$ref": "#/components/schemas/
|
|
10540
|
+
"$ref": "#/components/schemas/DocumentManagementCreateRequest"
|
|
10676
10541
|
},
|
|
10677
10542
|
"examples": {
|
|
10678
|
-
"
|
|
10543
|
+
"DocumentManagementCreateRequestExample": {
|
|
10679
10544
|
"value": {
|
|
10680
|
-
"
|
|
10681
|
-
"
|
|
10545
|
+
"documentId": "2721000",
|
|
10546
|
+
"documentIdFormat": "bol",
|
|
10547
|
+
"documentCode": "unece:DocumentCodeList#705",
|
|
10548
|
+
"blob": "SGVsbG8gV29ybGQ=",
|
|
10549
|
+
"annotationObject": {
|
|
10550
|
+
"@context": "https://schema.org",
|
|
10551
|
+
"@type": "DigitalDocument",
|
|
10552
|
+
"name": "myfile.pdf"
|
|
10553
|
+
},
|
|
10554
|
+
"createAttestation": true
|
|
10682
10555
|
}
|
|
10683
10556
|
}
|
|
10684
10557
|
}
|
|
@@ -10686,20 +10559,14 @@
|
|
|
10686
10559
|
}
|
|
10687
10560
|
},
|
|
10688
10561
|
"responses": {
|
|
10689
|
-
"
|
|
10690
|
-
"description": "
|
|
10691
|
-
"
|
|
10692
|
-
"
|
|
10562
|
+
"201": {
|
|
10563
|
+
"description": "The rest request ended in created response.",
|
|
10564
|
+
"headers": {
|
|
10565
|
+
"location": {
|
|
10693
10566
|
"schema": {
|
|
10694
|
-
"
|
|
10567
|
+
"type": "string"
|
|
10695
10568
|
},
|
|
10696
|
-
"
|
|
10697
|
-
"dataProcessingExtractResponseExample": {
|
|
10698
|
-
"value": {
|
|
10699
|
-
"foo": "bar"
|
|
10700
|
-
}
|
|
10701
|
-
}
|
|
10702
|
-
}
|
|
10569
|
+
"description": "e.g. aig%3A123456"
|
|
10703
10570
|
}
|
|
10704
10571
|
}
|
|
10705
10572
|
},
|
|
@@ -10761,50 +10628,87 @@
|
|
|
10761
10628
|
}
|
|
10762
10629
|
}
|
|
10763
10630
|
}
|
|
10764
|
-
}
|
|
10765
|
-
|
|
10766
|
-
|
|
10767
|
-
|
|
10768
|
-
"operationId": "dataProcessingConvert",
|
|
10769
|
-
"summary": "Convert data from a binary source and return structured object.",
|
|
10631
|
+
},
|
|
10632
|
+
"get": {
|
|
10633
|
+
"operationId": "DocumentManagementQuery",
|
|
10634
|
+
"summary": "Query the items from an auditable item graph vertex",
|
|
10770
10635
|
"tags": [
|
|
10771
|
-
"
|
|
10636
|
+
"Document Management"
|
|
10772
10637
|
],
|
|
10773
10638
|
"security": [
|
|
10774
10639
|
{
|
|
10775
10640
|
"jwtBearerAuthScheme": []
|
|
10776
10641
|
}
|
|
10777
10642
|
],
|
|
10778
|
-
"requestBody": {
|
|
10779
|
-
"description": "Perform a conversion on the data.",
|
|
10780
|
-
"required": true,
|
|
10781
|
-
"content": {
|
|
10782
|
-
"application/json": {
|
|
10783
|
-
"schema": {
|
|
10784
|
-
"$ref": "#/components/schemas/DataProcessingConvertRequest"
|
|
10785
|
-
},
|
|
10786
|
-
"examples": {
|
|
10787
|
-
"dataProcessingConvertRequestExample": {
|
|
10788
|
-
"value": {
|
|
10789
|
-
"data": "eyJmb28iOiAiYmFyIn0="
|
|
10790
|
-
}
|
|
10791
|
-
}
|
|
10792
|
-
}
|
|
10793
|
-
}
|
|
10794
|
-
}
|
|
10795
|
-
},
|
|
10796
10643
|
"responses": {
|
|
10797
10644
|
"200": {
|
|
10798
|
-
"description": "Response to
|
|
10645
|
+
"description": "Response to query the documents from an auditable item graph vertex.",
|
|
10799
10646
|
"content": {
|
|
10800
10647
|
"application/json": {
|
|
10801
10648
|
"schema": {
|
|
10802
|
-
"$ref": "
|
|
10649
|
+
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexList"
|
|
10803
10650
|
},
|
|
10804
10651
|
"examples": {
|
|
10805
|
-
"
|
|
10652
|
+
"DocumentManagementQueryResponseExample": {
|
|
10806
10653
|
"value": {
|
|
10807
|
-
"
|
|
10654
|
+
"@context": [
|
|
10655
|
+
"https://schema.org",
|
|
10656
|
+
"https://schema.twindev.org/aig/"
|
|
10657
|
+
],
|
|
10658
|
+
"type": [
|
|
10659
|
+
"ItemList",
|
|
10660
|
+
"AuditableItemGraphVertexList"
|
|
10661
|
+
],
|
|
10662
|
+
"itemListElement": [
|
|
10663
|
+
{
|
|
10664
|
+
"@context": [
|
|
10665
|
+
"https://schema.twindev.org/aig/",
|
|
10666
|
+
"https://schema.twindev.org/common/"
|
|
10667
|
+
],
|
|
10668
|
+
"id": "aig:c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7",
|
|
10669
|
+
"type": "AuditableItemGraphVertex",
|
|
10670
|
+
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
10671
|
+
"aliases": [
|
|
10672
|
+
{
|
|
10673
|
+
"@context": [
|
|
10674
|
+
"https://schema.twindev.org/aig/"
|
|
10675
|
+
],
|
|
10676
|
+
"id": "test-id-0",
|
|
10677
|
+
"type": "AuditableItemGraphAlias",
|
|
10678
|
+
"dateCreated": "2024-08-22T04:13:20.000Z"
|
|
10679
|
+
}
|
|
10680
|
+
],
|
|
10681
|
+
"resources": [
|
|
10682
|
+
{
|
|
10683
|
+
"@context": "https://schema.twindev.org/aig/",
|
|
10684
|
+
"type": "AuditableItemGraphResource",
|
|
10685
|
+
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
10686
|
+
"resourceObject": {
|
|
10687
|
+
"@context": [
|
|
10688
|
+
"https://schema.twindev.org/documents/",
|
|
10689
|
+
"https://schema.twindev.org/common/",
|
|
10690
|
+
"https://schema.org"
|
|
10691
|
+
],
|
|
10692
|
+
"type": "Document",
|
|
10693
|
+
"id": "test-id-0:0",
|
|
10694
|
+
"documentId": "test-id-0",
|
|
10695
|
+
"documentCode": "unece:DocumentCodeList#705",
|
|
10696
|
+
"documentRevision": 0,
|
|
10697
|
+
"annotationObject": {
|
|
10698
|
+
"@context": "https://schema.org",
|
|
10699
|
+
"type": "DigitalDocument",
|
|
10700
|
+
"name": "bill-of-lading"
|
|
10701
|
+
},
|
|
10702
|
+
"integrity": "sha256-E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
|
|
10703
|
+
"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
|
|
10704
|
+
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
10705
|
+
"organizationIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
|
|
10706
|
+
"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
|
|
10707
|
+
}
|
|
10708
|
+
}
|
|
10709
|
+
]
|
|
10710
|
+
}
|
|
10711
|
+
]
|
|
10808
10712
|
}
|
|
10809
10713
|
}
|
|
10810
10714
|
}
|
|
@@ -10871,48 +10775,57 @@
|
|
|
10871
10775
|
}
|
|
10872
10776
|
}
|
|
10873
10777
|
},
|
|
10874
|
-
"/
|
|
10875
|
-
"
|
|
10876
|
-
"operationId": "
|
|
10877
|
-
"summary": "
|
|
10778
|
+
"/document-management/{auditableItemGraphDocumentId}": {
|
|
10779
|
+
"patch": {
|
|
10780
|
+
"operationId": "DocumentManagementUpdatePartial",
|
|
10781
|
+
"summary": "Partially update a document in an auditable item graph vertex and add its content to blob storage.",
|
|
10878
10782
|
"tags": [
|
|
10879
|
-
"
|
|
10783
|
+
"Document Management"
|
|
10784
|
+
],
|
|
10785
|
+
"parameters": [
|
|
10786
|
+
{
|
|
10787
|
+
"name": "auditableItemGraphDocumentId",
|
|
10788
|
+
"description": "",
|
|
10789
|
+
"in": "path",
|
|
10790
|
+
"required": true,
|
|
10791
|
+
"schema": {
|
|
10792
|
+
"type": "string"
|
|
10793
|
+
},
|
|
10794
|
+
"style": "simple",
|
|
10795
|
+
"example": "aig:123456"
|
|
10796
|
+
}
|
|
10880
10797
|
],
|
|
10881
10798
|
"security": [
|
|
10882
10799
|
{
|
|
10883
10800
|
"jwtBearerAuthScheme": []
|
|
10884
10801
|
}
|
|
10885
10802
|
],
|
|
10886
|
-
"
|
|
10887
|
-
"
|
|
10888
|
-
|
|
10889
|
-
|
|
10890
|
-
|
|
10891
|
-
|
|
10892
|
-
|
|
10893
|
-
|
|
10894
|
-
|
|
10895
|
-
|
|
10896
|
-
|
|
10897
|
-
|
|
10898
|
-
|
|
10899
|
-
|
|
10900
|
-
|
|
10901
|
-
|
|
10902
|
-
{
|
|
10903
|
-
"source": "$.foo",
|
|
10904
|
-
"target": "goo",
|
|
10905
|
-
"coerce": "bigint"
|
|
10906
|
-
}
|
|
10907
|
-
]
|
|
10908
|
-
}
|
|
10909
|
-
],
|
|
10910
|
-
"cursor": "1"
|
|
10803
|
+
"requestBody": {
|
|
10804
|
+
"description": "Request to partially update a document as an auditable item graph vertex.",
|
|
10805
|
+
"required": true,
|
|
10806
|
+
"content": {
|
|
10807
|
+
"application/json": {
|
|
10808
|
+
"schema": {
|
|
10809
|
+
"$ref": "#/components/schemas/DocumentManagementUpdatePartialRequest"
|
|
10810
|
+
},
|
|
10811
|
+
"examples": {
|
|
10812
|
+
"DocumentManagementUpdatePartialRequestExample": {
|
|
10813
|
+
"value": {
|
|
10814
|
+
"blob": "SGVsbG8gV29ybGQ=",
|
|
10815
|
+
"annotationObject": {
|
|
10816
|
+
"@context": "https://schema.org",
|
|
10817
|
+
"@type": "DigitalDocument",
|
|
10818
|
+
"name": "myfile.pdf"
|
|
10911
10819
|
}
|
|
10912
10820
|
}
|
|
10913
10821
|
}
|
|
10914
10822
|
}
|
|
10915
10823
|
}
|
|
10824
|
+
}
|
|
10825
|
+
},
|
|
10826
|
+
"responses": {
|
|
10827
|
+
"204": {
|
|
10828
|
+
"description": "The rest request ended in success with no data."
|
|
10916
10829
|
},
|
|
10917
10830
|
"400": {
|
|
10918
10831
|
"description": "The server cannot process the request, see the content for more details.",
|
|
@@ -10972,382 +10885,14 @@
|
|
|
10972
10885
|
}
|
|
10973
10886
|
}
|
|
10974
10887
|
}
|
|
10975
|
-
}
|
|
10976
|
-
|
|
10977
|
-
|
|
10978
|
-
|
|
10979
|
-
"operationId": "DocumentManagementSet",
|
|
10980
|
-
"summary": "Store a document in an auditable item graph vertex and add its content to blob storage.",
|
|
10888
|
+
},
|
|
10889
|
+
"get": {
|
|
10890
|
+
"operationId": "DocumentManagementGet",
|
|
10891
|
+
"summary": "Get the data for a document from document management",
|
|
10981
10892
|
"tags": [
|
|
10982
10893
|
"Document Management"
|
|
10983
10894
|
],
|
|
10984
|
-
"
|
|
10985
|
-
{
|
|
10986
|
-
"jwtBearerAuthScheme": []
|
|
10987
|
-
}
|
|
10988
|
-
],
|
|
10989
|
-
"requestBody": {
|
|
10990
|
-
"description": "Request to create a document as an auditable item graph vertex.",
|
|
10991
|
-
"required": true,
|
|
10992
|
-
"content": {
|
|
10993
|
-
"application/json": {
|
|
10994
|
-
"schema": {
|
|
10995
|
-
"$ref": "#/components/schemas/DocumentManagementCreateRequest"
|
|
10996
|
-
},
|
|
10997
|
-
"examples": {
|
|
10998
|
-
"DocumentManagementCreateRequestExample": {
|
|
10999
|
-
"value": {
|
|
11000
|
-
"documentId": "2721000",
|
|
11001
|
-
"documentIdFormat": "bol",
|
|
11002
|
-
"documentCode": "unece:DocumentCodeList#705",
|
|
11003
|
-
"blob": "SGVsbG8gV29ybGQ=",
|
|
11004
|
-
"annotationObject": {
|
|
11005
|
-
"@context": "https://schema.org",
|
|
11006
|
-
"@type": "DigitalDocument",
|
|
11007
|
-
"name": "myfile.pdf"
|
|
11008
|
-
},
|
|
11009
|
-
"createAttestation": true
|
|
11010
|
-
}
|
|
11011
|
-
}
|
|
11012
|
-
}
|
|
11013
|
-
}
|
|
11014
|
-
}
|
|
11015
|
-
},
|
|
11016
|
-
"responses": {
|
|
11017
|
-
"201": {
|
|
11018
|
-
"description": "The rest request ended in created response.",
|
|
11019
|
-
"headers": {
|
|
11020
|
-
"location": {
|
|
11021
|
-
"schema": {
|
|
11022
|
-
"type": "string"
|
|
11023
|
-
},
|
|
11024
|
-
"description": "e.g. aig%3A123456"
|
|
11025
|
-
}
|
|
11026
|
-
}
|
|
11027
|
-
},
|
|
11028
|
-
"400": {
|
|
11029
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
11030
|
-
"content": {
|
|
11031
|
-
"application/json": {
|
|
11032
|
-
"schema": {
|
|
11033
|
-
"$ref": "#/components/schemas/Error"
|
|
11034
|
-
},
|
|
11035
|
-
"examples": {
|
|
11036
|
-
"exampleResponse": {
|
|
11037
|
-
"value": {
|
|
11038
|
-
"name": "GeneralError",
|
|
11039
|
-
"message": "errorMessage",
|
|
11040
|
-
"properties": {
|
|
11041
|
-
"foo": "bar"
|
|
11042
|
-
}
|
|
11043
|
-
}
|
|
11044
|
-
}
|
|
11045
|
-
}
|
|
11046
|
-
}
|
|
11047
|
-
}
|
|
11048
|
-
},
|
|
11049
|
-
"401": {
|
|
11050
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
11051
|
-
"content": {
|
|
11052
|
-
"application/json": {
|
|
11053
|
-
"schema": {
|
|
11054
|
-
"$ref": "#/components/schemas/Error"
|
|
11055
|
-
},
|
|
11056
|
-
"examples": {
|
|
11057
|
-
"exampleResponse": {
|
|
11058
|
-
"value": {
|
|
11059
|
-
"name": "UnauthorizedError",
|
|
11060
|
-
"message": "errorMessage"
|
|
11061
|
-
}
|
|
11062
|
-
}
|
|
11063
|
-
}
|
|
11064
|
-
}
|
|
11065
|
-
}
|
|
11066
|
-
},
|
|
11067
|
-
"500": {
|
|
11068
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
11069
|
-
"content": {
|
|
11070
|
-
"application/json": {
|
|
11071
|
-
"schema": {
|
|
11072
|
-
"$ref": "#/components/schemas/Error"
|
|
11073
|
-
},
|
|
11074
|
-
"examples": {
|
|
11075
|
-
"exampleResponse": {
|
|
11076
|
-
"value": {
|
|
11077
|
-
"name": "InternalServerError",
|
|
11078
|
-
"message": "errorMessage"
|
|
11079
|
-
}
|
|
11080
|
-
}
|
|
11081
|
-
}
|
|
11082
|
-
}
|
|
11083
|
-
}
|
|
11084
|
-
}
|
|
11085
|
-
}
|
|
11086
|
-
},
|
|
11087
|
-
"get": {
|
|
11088
|
-
"operationId": "DocumentManagementQuery",
|
|
11089
|
-
"summary": "Query the items from an auditable item graph vertex",
|
|
11090
|
-
"tags": [
|
|
11091
|
-
"Document Management"
|
|
11092
|
-
],
|
|
11093
|
-
"security": [
|
|
11094
|
-
{
|
|
11095
|
-
"jwtBearerAuthScheme": []
|
|
11096
|
-
}
|
|
11097
|
-
],
|
|
11098
|
-
"responses": {
|
|
11099
|
-
"200": {
|
|
11100
|
-
"description": "Response to query the documents from an auditable item graph vertex.",
|
|
11101
|
-
"content": {
|
|
11102
|
-
"application/json": {
|
|
11103
|
-
"schema": {
|
|
11104
|
-
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexList"
|
|
11105
|
-
},
|
|
11106
|
-
"examples": {
|
|
11107
|
-
"DocumentManagementQueryResponseExample": {
|
|
11108
|
-
"value": {
|
|
11109
|
-
"@context": [
|
|
11110
|
-
"https://schema.org",
|
|
11111
|
-
"https://schema.twindev.org/aig/"
|
|
11112
|
-
],
|
|
11113
|
-
"type": [
|
|
11114
|
-
"ItemList",
|
|
11115
|
-
"AuditableItemGraphVertexList"
|
|
11116
|
-
],
|
|
11117
|
-
"itemListElement": [
|
|
11118
|
-
{
|
|
11119
|
-
"@context": [
|
|
11120
|
-
"https://schema.twindev.org/aig/",
|
|
11121
|
-
"https://schema.twindev.org/common/"
|
|
11122
|
-
],
|
|
11123
|
-
"id": "aig:c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7c7",
|
|
11124
|
-
"type": "AuditableItemGraphVertex",
|
|
11125
|
-
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
11126
|
-
"aliases": [
|
|
11127
|
-
{
|
|
11128
|
-
"@context": [
|
|
11129
|
-
"https://schema.twindev.org/aig/"
|
|
11130
|
-
],
|
|
11131
|
-
"id": "test-id-0",
|
|
11132
|
-
"type": "AuditableItemGraphAlias",
|
|
11133
|
-
"dateCreated": "2024-08-22T04:13:20.000Z"
|
|
11134
|
-
}
|
|
11135
|
-
],
|
|
11136
|
-
"resources": [
|
|
11137
|
-
{
|
|
11138
|
-
"@context": "https://schema.twindev.org/aig/",
|
|
11139
|
-
"type": "AuditableItemGraphResource",
|
|
11140
|
-
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
11141
|
-
"resourceObject": {
|
|
11142
|
-
"@context": [
|
|
11143
|
-
"https://schema.twindev.org/documents/",
|
|
11144
|
-
"https://schema.twindev.org/common/",
|
|
11145
|
-
"https://schema.org"
|
|
11146
|
-
],
|
|
11147
|
-
"type": "Document",
|
|
11148
|
-
"id": "test-id-0:0",
|
|
11149
|
-
"documentId": "test-id-0",
|
|
11150
|
-
"documentCode": "unece:DocumentCodeList#705",
|
|
11151
|
-
"documentRevision": 0,
|
|
11152
|
-
"annotationObject": {
|
|
11153
|
-
"@context": "https://schema.org",
|
|
11154
|
-
"type": "DigitalDocument",
|
|
11155
|
-
"name": "bill-of-lading"
|
|
11156
|
-
},
|
|
11157
|
-
"integrity": "sha256-E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
|
|
11158
|
-
"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
|
|
11159
|
-
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
11160
|
-
"organizationIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
|
|
11161
|
-
"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
|
|
11162
|
-
}
|
|
11163
|
-
}
|
|
11164
|
-
]
|
|
11165
|
-
}
|
|
11166
|
-
]
|
|
11167
|
-
}
|
|
11168
|
-
}
|
|
11169
|
-
}
|
|
11170
|
-
}
|
|
11171
|
-
}
|
|
11172
|
-
},
|
|
11173
|
-
"400": {
|
|
11174
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
11175
|
-
"content": {
|
|
11176
|
-
"application/json": {
|
|
11177
|
-
"schema": {
|
|
11178
|
-
"$ref": "#/components/schemas/Error"
|
|
11179
|
-
},
|
|
11180
|
-
"examples": {
|
|
11181
|
-
"exampleResponse": {
|
|
11182
|
-
"value": {
|
|
11183
|
-
"name": "GeneralError",
|
|
11184
|
-
"message": "errorMessage",
|
|
11185
|
-
"properties": {
|
|
11186
|
-
"foo": "bar"
|
|
11187
|
-
}
|
|
11188
|
-
}
|
|
11189
|
-
}
|
|
11190
|
-
}
|
|
11191
|
-
}
|
|
11192
|
-
}
|
|
11193
|
-
},
|
|
11194
|
-
"401": {
|
|
11195
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
11196
|
-
"content": {
|
|
11197
|
-
"application/json": {
|
|
11198
|
-
"schema": {
|
|
11199
|
-
"$ref": "#/components/schemas/Error"
|
|
11200
|
-
},
|
|
11201
|
-
"examples": {
|
|
11202
|
-
"exampleResponse": {
|
|
11203
|
-
"value": {
|
|
11204
|
-
"name": "UnauthorizedError",
|
|
11205
|
-
"message": "errorMessage"
|
|
11206
|
-
}
|
|
11207
|
-
}
|
|
11208
|
-
}
|
|
11209
|
-
}
|
|
11210
|
-
}
|
|
11211
|
-
},
|
|
11212
|
-
"500": {
|
|
11213
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
11214
|
-
"content": {
|
|
11215
|
-
"application/json": {
|
|
11216
|
-
"schema": {
|
|
11217
|
-
"$ref": "#/components/schemas/Error"
|
|
11218
|
-
},
|
|
11219
|
-
"examples": {
|
|
11220
|
-
"exampleResponse": {
|
|
11221
|
-
"value": {
|
|
11222
|
-
"name": "InternalServerError",
|
|
11223
|
-
"message": "errorMessage"
|
|
11224
|
-
}
|
|
11225
|
-
}
|
|
11226
|
-
}
|
|
11227
|
-
}
|
|
11228
|
-
}
|
|
11229
|
-
}
|
|
11230
|
-
}
|
|
11231
|
-
}
|
|
11232
|
-
},
|
|
11233
|
-
"/document-management/{auditableItemGraphDocumentId}": {
|
|
11234
|
-
"patch": {
|
|
11235
|
-
"operationId": "DocumentManagementUpdatePartial",
|
|
11236
|
-
"summary": "Partially update a document in an auditable item graph vertex and add its content to blob storage.",
|
|
11237
|
-
"tags": [
|
|
11238
|
-
"Document Management"
|
|
11239
|
-
],
|
|
11240
|
-
"parameters": [
|
|
11241
|
-
{
|
|
11242
|
-
"name": "auditableItemGraphDocumentId",
|
|
11243
|
-
"description": "",
|
|
11244
|
-
"in": "path",
|
|
11245
|
-
"required": true,
|
|
11246
|
-
"schema": {
|
|
11247
|
-
"type": "string"
|
|
11248
|
-
},
|
|
11249
|
-
"style": "simple",
|
|
11250
|
-
"example": "aig:123456"
|
|
11251
|
-
}
|
|
11252
|
-
],
|
|
11253
|
-
"security": [
|
|
11254
|
-
{
|
|
11255
|
-
"jwtBearerAuthScheme": []
|
|
11256
|
-
}
|
|
11257
|
-
],
|
|
11258
|
-
"requestBody": {
|
|
11259
|
-
"description": "Request to partially update a document as an auditable item graph vertex.",
|
|
11260
|
-
"required": true,
|
|
11261
|
-
"content": {
|
|
11262
|
-
"application/json": {
|
|
11263
|
-
"schema": {
|
|
11264
|
-
"$ref": "#/components/schemas/DocumentManagementUpdatePartialRequest"
|
|
11265
|
-
},
|
|
11266
|
-
"examples": {
|
|
11267
|
-
"DocumentManagementUpdatePartialRequestExample": {
|
|
11268
|
-
"value": {
|
|
11269
|
-
"blob": "SGVsbG8gV29ybGQ=",
|
|
11270
|
-
"annotationObject": {
|
|
11271
|
-
"@context": "https://schema.org",
|
|
11272
|
-
"@type": "DigitalDocument",
|
|
11273
|
-
"name": "myfile.pdf"
|
|
11274
|
-
}
|
|
11275
|
-
}
|
|
11276
|
-
}
|
|
11277
|
-
}
|
|
11278
|
-
}
|
|
11279
|
-
}
|
|
11280
|
-
},
|
|
11281
|
-
"responses": {
|
|
11282
|
-
"204": {
|
|
11283
|
-
"description": "The rest request ended in success with no data."
|
|
11284
|
-
},
|
|
11285
|
-
"400": {
|
|
11286
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
11287
|
-
"content": {
|
|
11288
|
-
"application/json": {
|
|
11289
|
-
"schema": {
|
|
11290
|
-
"$ref": "#/components/schemas/Error"
|
|
11291
|
-
},
|
|
11292
|
-
"examples": {
|
|
11293
|
-
"exampleResponse": {
|
|
11294
|
-
"value": {
|
|
11295
|
-
"name": "GeneralError",
|
|
11296
|
-
"message": "errorMessage",
|
|
11297
|
-
"properties": {
|
|
11298
|
-
"foo": "bar"
|
|
11299
|
-
}
|
|
11300
|
-
}
|
|
11301
|
-
}
|
|
11302
|
-
}
|
|
11303
|
-
}
|
|
11304
|
-
}
|
|
11305
|
-
},
|
|
11306
|
-
"401": {
|
|
11307
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
11308
|
-
"content": {
|
|
11309
|
-
"application/json": {
|
|
11310
|
-
"schema": {
|
|
11311
|
-
"$ref": "#/components/schemas/Error"
|
|
11312
|
-
},
|
|
11313
|
-
"examples": {
|
|
11314
|
-
"exampleResponse": {
|
|
11315
|
-
"value": {
|
|
11316
|
-
"name": "UnauthorizedError",
|
|
11317
|
-
"message": "errorMessage"
|
|
11318
|
-
}
|
|
11319
|
-
}
|
|
11320
|
-
}
|
|
11321
|
-
}
|
|
11322
|
-
}
|
|
11323
|
-
},
|
|
11324
|
-
"500": {
|
|
11325
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
11326
|
-
"content": {
|
|
11327
|
-
"application/json": {
|
|
11328
|
-
"schema": {
|
|
11329
|
-
"$ref": "#/components/schemas/Error"
|
|
11330
|
-
},
|
|
11331
|
-
"examples": {
|
|
11332
|
-
"exampleResponse": {
|
|
11333
|
-
"value": {
|
|
11334
|
-
"name": "InternalServerError",
|
|
11335
|
-
"message": "errorMessage"
|
|
11336
|
-
}
|
|
11337
|
-
}
|
|
11338
|
-
}
|
|
11339
|
-
}
|
|
11340
|
-
}
|
|
11341
|
-
}
|
|
11342
|
-
}
|
|
11343
|
-
},
|
|
11344
|
-
"get": {
|
|
11345
|
-
"operationId": "DocumentManagementGet",
|
|
11346
|
-
"summary": "Get the data for a document from document management",
|
|
11347
|
-
"tags": [
|
|
11348
|
-
"Document Management"
|
|
11349
|
-
],
|
|
11350
|
-
"parameters": [
|
|
10895
|
+
"parameters": [
|
|
11351
10896
|
{
|
|
11352
10897
|
"name": "auditableItemGraphDocumentId",
|
|
11353
10898
|
"description": "",
|
|
@@ -16093,291 +15638,67 @@
|
|
|
16093
15638
|
"$ref": "#/components/schemas/SortDirection"
|
|
16094
15639
|
}
|
|
16095
15640
|
},
|
|
16096
|
-
{
|
|
16097
|
-
"name": "limit",
|
|
16098
|
-
"description": "How many entries to return.",
|
|
16099
|
-
"in": "query",
|
|
16100
|
-
"required": false,
|
|
16101
|
-
"schema": {
|
|
16102
|
-
"type": "string"
|
|
16103
|
-
}
|
|
16104
|
-
},
|
|
16105
|
-
{
|
|
16106
|
-
"name": "cursor",
|
|
16107
|
-
"description": "Cursor to use for next chunk of data.",
|
|
16108
|
-
"in": "query",
|
|
16109
|
-
"required": false,
|
|
16110
|
-
"schema": {
|
|
16111
|
-
"type": "string"
|
|
16112
|
-
}
|
|
16113
|
-
},
|
|
16114
|
-
{
|
|
16115
|
-
"name": "accept",
|
|
16116
|
-
"in": "header",
|
|
16117
|
-
"required": true,
|
|
16118
|
-
"schema": {
|
|
16119
|
-
"type": "string"
|
|
16120
|
-
},
|
|
16121
|
-
"style": "simple"
|
|
16122
|
-
}
|
|
16123
|
-
],
|
|
16124
|
-
"security": [
|
|
16125
|
-
{
|
|
16126
|
-
"jwtBearerAuthScheme": []
|
|
16127
|
-
}
|
|
16128
|
-
],
|
|
16129
|
-
"responses": {
|
|
16130
|
-
"200": {
|
|
16131
|
-
"description": "Response to getting an auditable item stream entries objects.",
|
|
16132
|
-
"content": {
|
|
16133
|
-
"application/json": {
|
|
16134
|
-
"schema": {
|
|
16135
|
-
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
|
|
16136
|
-
},
|
|
16137
|
-
"examples": {
|
|
16138
|
-
"auditableItemStreamListEntryObjectsNoStreamResponseExample": {
|
|
16139
|
-
"value": {
|
|
16140
|
-
"@context": [
|
|
16141
|
-
"https://schema.org",
|
|
16142
|
-
"https://schema.twindev.org/ais/",
|
|
16143
|
-
"https://schema.twindev.org/common/"
|
|
16144
|
-
],
|
|
16145
|
-
"type": [
|
|
16146
|
-
"ItemList",
|
|
16147
|
-
"AuditableItemStreamEntryObjectList"
|
|
16148
|
-
],
|
|
16149
|
-
"itemListElement": [
|
|
16150
|
-
{
|
|
16151
|
-
"@context": "https://schema.org",
|
|
16152
|
-
"@type": "Event",
|
|
16153
|
-
"startDate": "2011-04-09T20:00:00Z",
|
|
16154
|
-
"description": "A description of the event"
|
|
16155
|
-
}
|
|
16156
|
-
]
|
|
16157
|
-
}
|
|
16158
|
-
}
|
|
16159
|
-
}
|
|
16160
|
-
}
|
|
16161
|
-
}
|
|
16162
|
-
},
|
|
16163
|
-
"400": {
|
|
16164
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
16165
|
-
"content": {
|
|
16166
|
-
"application/json": {
|
|
16167
|
-
"schema": {
|
|
16168
|
-
"$ref": "#/components/schemas/Error"
|
|
16169
|
-
},
|
|
16170
|
-
"examples": {
|
|
16171
|
-
"exampleResponse": {
|
|
16172
|
-
"value": {
|
|
16173
|
-
"name": "GeneralError",
|
|
16174
|
-
"message": "errorMessage",
|
|
16175
|
-
"properties": {
|
|
16176
|
-
"foo": "bar"
|
|
16177
|
-
}
|
|
16178
|
-
}
|
|
16179
|
-
}
|
|
16180
|
-
}
|
|
16181
|
-
}
|
|
16182
|
-
}
|
|
16183
|
-
},
|
|
16184
|
-
"401": {
|
|
16185
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
16186
|
-
"content": {
|
|
16187
|
-
"application/json": {
|
|
16188
|
-
"schema": {
|
|
16189
|
-
"$ref": "#/components/schemas/Error"
|
|
16190
|
-
},
|
|
16191
|
-
"examples": {
|
|
16192
|
-
"exampleResponse": {
|
|
16193
|
-
"value": {
|
|
16194
|
-
"name": "UnauthorizedError",
|
|
16195
|
-
"message": "errorMessage"
|
|
16196
|
-
}
|
|
16197
|
-
}
|
|
16198
|
-
}
|
|
16199
|
-
}
|
|
16200
|
-
}
|
|
16201
|
-
},
|
|
16202
|
-
"404": {
|
|
16203
|
-
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
16204
|
-
"content": {
|
|
16205
|
-
"application/json": {
|
|
16206
|
-
"schema": {
|
|
16207
|
-
"$ref": "#/components/schemas/NotFoundResponse"
|
|
16208
|
-
},
|
|
16209
|
-
"examples": {
|
|
16210
|
-
"exampleResponse": {
|
|
16211
|
-
"value": {
|
|
16212
|
-
"name": "NotFoundError",
|
|
16213
|
-
"message": "errorMessage",
|
|
16214
|
-
"properties": {
|
|
16215
|
-
"notFoundId": "1"
|
|
16216
|
-
}
|
|
16217
|
-
}
|
|
16218
|
-
}
|
|
16219
|
-
}
|
|
16220
|
-
}
|
|
16221
|
-
}
|
|
16222
|
-
},
|
|
16223
|
-
"500": {
|
|
16224
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16225
|
-
"content": {
|
|
16226
|
-
"application/json": {
|
|
16227
|
-
"schema": {
|
|
16228
|
-
"$ref": "#/components/schemas/Error"
|
|
16229
|
-
},
|
|
16230
|
-
"examples": {
|
|
16231
|
-
"exampleResponse": {
|
|
16232
|
-
"value": {
|
|
16233
|
-
"name": "InternalServerError",
|
|
16234
|
-
"message": "errorMessage"
|
|
16235
|
-
}
|
|
16236
|
-
}
|
|
16237
|
-
}
|
|
16238
|
-
}
|
|
16239
|
-
}
|
|
16240
|
-
}
|
|
16241
|
-
}
|
|
16242
|
-
}
|
|
16243
|
-
},
|
|
16244
|
-
"/synchronised-storage/sync-changeset": {
|
|
16245
|
-
"post": {
|
|
16246
|
-
"operationId": "synchronisedStorageSyncChangeSetRequest",
|
|
16247
|
-
"summary": "Request that the node perform a sync request for a changeset.",
|
|
16248
|
-
"tags": [
|
|
16249
|
-
"Synchronised Storage"
|
|
16250
|
-
],
|
|
16251
|
-
"parameters": [
|
|
16252
|
-
{
|
|
16253
|
-
"name": "accept",
|
|
16254
|
-
"in": "header",
|
|
16255
|
-
"required": true,
|
|
16256
|
-
"schema": {
|
|
16257
|
-
"type": "string"
|
|
16258
|
-
},
|
|
16259
|
-
"style": "simple"
|
|
16260
|
-
},
|
|
16261
|
-
{
|
|
16262
|
-
"name": "authorization",
|
|
16263
|
-
"in": "header",
|
|
16264
|
-
"required": true,
|
|
16265
|
-
"schema": {
|
|
16266
|
-
"type": "string"
|
|
16267
|
-
},
|
|
16268
|
-
"style": "simple",
|
|
16269
|
-
"example": "z3V32BP9ShC...z3V32BP9ShC"
|
|
16270
|
-
}
|
|
16271
|
-
],
|
|
16272
|
-
"requestBody": {
|
|
16273
|
-
"description": "Request a trusted node to perform a sync request for a changeset.",
|
|
16274
|
-
"required": true,
|
|
16275
|
-
"content": {
|
|
16276
|
-
"application/json": {
|
|
16277
|
-
"schema": {
|
|
16278
|
-
"$ref": "#/components/schemas/SyncChangeSet"
|
|
16279
|
-
},
|
|
16280
|
-
"examples": {
|
|
16281
|
-
"synchronisedStorageSyncChangeSetRequestExample": {
|
|
16282
|
-
"value": {
|
|
16283
|
-
"@context": "https://schema.twindev.org/synchronised-storage/",
|
|
16284
|
-
"type": "ChangeSet",
|
|
16285
|
-
"id": "0909090909090909090909090909090909090909090909090909090909090909",
|
|
16286
|
-
"dateCreated": "2025-05-29T01:00:00.000Z",
|
|
16287
|
-
"dateModified": "2025-05-29T01:00:00.000Z",
|
|
16288
|
-
"nodeIdentity": "did:entity-storage:0xd2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
|
|
16289
|
-
"changes": [
|
|
16290
|
-
{
|
|
16291
|
-
"entity": {
|
|
16292
|
-
"dateModified": "2025-01-01T00:00:00.000Z"
|
|
16293
|
-
},
|
|
16294
|
-
"id": "test-id-1",
|
|
16295
|
-
"operation": "set"
|
|
16296
|
-
}
|
|
16297
|
-
],
|
|
16298
|
-
"storageKey": "test-type"
|
|
16299
|
-
}
|
|
16300
|
-
}
|
|
16301
|
-
}
|
|
16302
|
-
}
|
|
16303
|
-
}
|
|
16304
|
-
},
|
|
16305
|
-
"responses": {
|
|
16306
|
-
"204": {
|
|
16307
|
-
"description": "The rest request ended in success with no data."
|
|
16308
|
-
},
|
|
16309
|
-
"400": {
|
|
16310
|
-
"description": "The server cannot process the request, see the content for more details.",
|
|
16311
|
-
"content": {
|
|
16312
|
-
"application/json": {
|
|
16313
|
-
"schema": {
|
|
16314
|
-
"$ref": "#/components/schemas/Error"
|
|
16315
|
-
},
|
|
16316
|
-
"examples": {
|
|
16317
|
-
"exampleResponse": {
|
|
16318
|
-
"value": {
|
|
16319
|
-
"name": "GeneralError",
|
|
16320
|
-
"message": "errorMessage",
|
|
16321
|
-
"properties": {
|
|
16322
|
-
"foo": "bar"
|
|
16323
|
-
}
|
|
16324
|
-
}
|
|
16325
|
-
}
|
|
16326
|
-
}
|
|
16327
|
-
}
|
|
16328
|
-
}
|
|
16329
|
-
},
|
|
16330
|
-
"500": {
|
|
16331
|
-
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16332
|
-
"content": {
|
|
16333
|
-
"application/json": {
|
|
16334
|
-
"schema": {
|
|
16335
|
-
"$ref": "#/components/schemas/Error"
|
|
16336
|
-
},
|
|
16337
|
-
"examples": {
|
|
16338
|
-
"exampleResponse": {
|
|
16339
|
-
"value": {
|
|
16340
|
-
"name": "InternalServerError",
|
|
16341
|
-
"message": "errorMessage"
|
|
16342
|
-
}
|
|
16343
|
-
}
|
|
16344
|
-
}
|
|
16345
|
-
}
|
|
15641
|
+
{
|
|
15642
|
+
"name": "limit",
|
|
15643
|
+
"description": "How many entries to return.",
|
|
15644
|
+
"in": "query",
|
|
15645
|
+
"required": false,
|
|
15646
|
+
"schema": {
|
|
15647
|
+
"type": "string"
|
|
15648
|
+
}
|
|
15649
|
+
},
|
|
15650
|
+
{
|
|
15651
|
+
"name": "cursor",
|
|
15652
|
+
"description": "Cursor to use for next chunk of data.",
|
|
15653
|
+
"in": "query",
|
|
15654
|
+
"required": false,
|
|
15655
|
+
"schema": {
|
|
15656
|
+
"type": "string"
|
|
16346
15657
|
}
|
|
15658
|
+
},
|
|
15659
|
+
{
|
|
15660
|
+
"name": "accept",
|
|
15661
|
+
"in": "header",
|
|
15662
|
+
"required": true,
|
|
15663
|
+
"schema": {
|
|
15664
|
+
"type": "string"
|
|
15665
|
+
},
|
|
15666
|
+
"style": "simple"
|
|
16347
15667
|
}
|
|
16348
|
-
}
|
|
16349
|
-
}
|
|
16350
|
-
},
|
|
16351
|
-
"/synchronised-storage/decryption-key": {
|
|
16352
|
-
"post": {
|
|
16353
|
-
"operationId": "synchronisedStorageGetDecryptionKeyRequest",
|
|
16354
|
-
"summary": "Request the decryption key.",
|
|
16355
|
-
"tags": [
|
|
16356
|
-
"Synchronised Storage"
|
|
16357
15668
|
],
|
|
16358
|
-
"
|
|
16359
|
-
|
|
16360
|
-
|
|
16361
|
-
"content": {
|
|
16362
|
-
"application/json": {
|
|
16363
|
-
"schema": {
|
|
16364
|
-
"$ref": "#/components/schemas/SyncChangeSet"
|
|
16365
|
-
}
|
|
16366
|
-
}
|
|
15669
|
+
"security": [
|
|
15670
|
+
{
|
|
15671
|
+
"jwtBearerAuthScheme": []
|
|
16367
15672
|
}
|
|
16368
|
-
|
|
15673
|
+
],
|
|
16369
15674
|
"responses": {
|
|
16370
15675
|
"200": {
|
|
16371
|
-
"description": "Response to
|
|
15676
|
+
"description": "Response to getting an auditable item stream entries objects.",
|
|
16372
15677
|
"content": {
|
|
16373
15678
|
"application/json": {
|
|
16374
15679
|
"schema": {
|
|
16375
|
-
"$ref": "
|
|
15680
|
+
"$ref": "https://schema.twindev.org/ais/AuditableItemStreamEntryObjectList"
|
|
16376
15681
|
},
|
|
16377
15682
|
"examples": {
|
|
16378
|
-
"
|
|
15683
|
+
"auditableItemStreamListEntryObjectsNoStreamResponseExample": {
|
|
16379
15684
|
"value": {
|
|
16380
|
-
"
|
|
15685
|
+
"@context": [
|
|
15686
|
+
"https://schema.org",
|
|
15687
|
+
"https://schema.twindev.org/ais/",
|
|
15688
|
+
"https://schema.twindev.org/common/"
|
|
15689
|
+
],
|
|
15690
|
+
"type": [
|
|
15691
|
+
"ItemList",
|
|
15692
|
+
"AuditableItemStreamEntryObjectList"
|
|
15693
|
+
],
|
|
15694
|
+
"itemListElement": [
|
|
15695
|
+
{
|
|
15696
|
+
"@context": "https://schema.org",
|
|
15697
|
+
"@type": "Event",
|
|
15698
|
+
"startDate": "2011-04-09T20:00:00Z",
|
|
15699
|
+
"description": "A description of the event"
|
|
15700
|
+
}
|
|
15701
|
+
]
|
|
16381
15702
|
}
|
|
16382
15703
|
}
|
|
16383
15704
|
}
|
|
@@ -16423,6 +15744,27 @@
|
|
|
16423
15744
|
}
|
|
16424
15745
|
}
|
|
16425
15746
|
},
|
|
15747
|
+
"404": {
|
|
15748
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
15749
|
+
"content": {
|
|
15750
|
+
"application/json": {
|
|
15751
|
+
"schema": {
|
|
15752
|
+
"$ref": "#/components/schemas/NotFoundResponse"
|
|
15753
|
+
},
|
|
15754
|
+
"examples": {
|
|
15755
|
+
"exampleResponse": {
|
|
15756
|
+
"value": {
|
|
15757
|
+
"name": "NotFoundError",
|
|
15758
|
+
"message": "errorMessage",
|
|
15759
|
+
"properties": {
|
|
15760
|
+
"notFoundId": "1"
|
|
15761
|
+
}
|
|
15762
|
+
}
|
|
15763
|
+
}
|
|
15764
|
+
}
|
|
15765
|
+
}
|
|
15766
|
+
}
|
|
15767
|
+
},
|
|
16426
15768
|
"500": {
|
|
16427
15769
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16428
15770
|
"content": {
|
|
@@ -16469,11 +15811,16 @@
|
|
|
16469
15811
|
"schema": {
|
|
16470
15812
|
"type": "string"
|
|
16471
15813
|
}
|
|
16472
|
-
}
|
|
16473
|
-
],
|
|
16474
|
-
"security": [
|
|
15814
|
+
},
|
|
16475
15815
|
{
|
|
16476
|
-
"
|
|
15816
|
+
"name": "authorization",
|
|
15817
|
+
"in": "header",
|
|
15818
|
+
"required": true,
|
|
15819
|
+
"schema": {
|
|
15820
|
+
"type": "string"
|
|
15821
|
+
},
|
|
15822
|
+
"style": "simple",
|
|
15823
|
+
"example": "Bearer <trust-token>"
|
|
16477
15824
|
}
|
|
16478
15825
|
],
|
|
16479
15826
|
"requestBody": {
|
|
@@ -16581,24 +15928,6 @@
|
|
|
16581
15928
|
}
|
|
16582
15929
|
}
|
|
16583
15930
|
},
|
|
16584
|
-
"401": {
|
|
16585
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
16586
|
-
"content": {
|
|
16587
|
-
"application/json": {
|
|
16588
|
-
"schema": {
|
|
16589
|
-
"$ref": "#/components/schemas/Error"
|
|
16590
|
-
},
|
|
16591
|
-
"examples": {
|
|
16592
|
-
"exampleResponse": {
|
|
16593
|
-
"value": {
|
|
16594
|
-
"name": "UnauthorizedError",
|
|
16595
|
-
"message": "errorMessage"
|
|
16596
|
-
}
|
|
16597
|
-
}
|
|
16598
|
-
}
|
|
16599
|
-
}
|
|
16600
|
-
}
|
|
16601
|
-
},
|
|
16602
15931
|
"500": {
|
|
16603
15932
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16604
15933
|
"content": {
|
|
@@ -16620,49 +15949,229 @@
|
|
|
16620
15949
|
}
|
|
16621
15950
|
}
|
|
16622
15951
|
},
|
|
16623
|
-
"/catalog/datasets/{datasetId}": {
|
|
16624
|
-
"get": {
|
|
16625
|
-
"operationId": "getDataset",
|
|
16626
|
-
"summary": "Retrieve a specific dataset by ID",
|
|
15952
|
+
"/catalog/datasets/{datasetId}": {
|
|
15953
|
+
"get": {
|
|
15954
|
+
"operationId": "getDataset",
|
|
15955
|
+
"summary": "Retrieve a specific dataset by ID",
|
|
15956
|
+
"tags": [
|
|
15957
|
+
"Federated Catalogue"
|
|
15958
|
+
],
|
|
15959
|
+
"parameters": [
|
|
15960
|
+
{
|
|
15961
|
+
"name": "datasetId",
|
|
15962
|
+
"description": "The unique identifier of the dataset.",
|
|
15963
|
+
"in": "path",
|
|
15964
|
+
"required": true,
|
|
15965
|
+
"schema": {
|
|
15966
|
+
"type": "string"
|
|
15967
|
+
},
|
|
15968
|
+
"style": "simple",
|
|
15969
|
+
"example": "urn:uuid:dataset-123"
|
|
15970
|
+
},
|
|
15971
|
+
{
|
|
15972
|
+
"name": "authorization",
|
|
15973
|
+
"in": "header",
|
|
15974
|
+
"required": true,
|
|
15975
|
+
"schema": {
|
|
15976
|
+
"type": "string"
|
|
15977
|
+
},
|
|
15978
|
+
"style": "simple",
|
|
15979
|
+
"example": "Bearer <trust-token>"
|
|
15980
|
+
}
|
|
15981
|
+
],
|
|
15982
|
+
"responses": {
|
|
15983
|
+
"200": {
|
|
15984
|
+
"description": "The response payload for the get dataset method.",
|
|
15985
|
+
"content": {
|
|
15986
|
+
"application/json": {
|
|
15987
|
+
"schema": {
|
|
15988
|
+
"$ref": "#/components/schemas/DatasetGetResponse"
|
|
15989
|
+
},
|
|
15990
|
+
"examples": {
|
|
15991
|
+
"getDatasetResponseExample": {
|
|
15992
|
+
"value": {
|
|
15993
|
+
"@context": "https://w3id.org/dspace/2025/1/context.jsonld",
|
|
15994
|
+
"@id": "urn:uuid:dataset-123",
|
|
15995
|
+
"@type": "dcat:Dataset",
|
|
15996
|
+
"dcterms:title": "Energy Consumption Data",
|
|
15997
|
+
"dcterms:description": "Historical energy consumption data"
|
|
15998
|
+
}
|
|
15999
|
+
}
|
|
16000
|
+
}
|
|
16001
|
+
}
|
|
16002
|
+
}
|
|
16003
|
+
},
|
|
16004
|
+
"400": {
|
|
16005
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
16006
|
+
"content": {
|
|
16007
|
+
"application/json": {
|
|
16008
|
+
"schema": {
|
|
16009
|
+
"$ref": "#/components/schemas/Error"
|
|
16010
|
+
},
|
|
16011
|
+
"examples": {
|
|
16012
|
+
"exampleResponse": {
|
|
16013
|
+
"value": {
|
|
16014
|
+
"name": "GeneralError",
|
|
16015
|
+
"message": "errorMessage",
|
|
16016
|
+
"properties": {
|
|
16017
|
+
"foo": "bar"
|
|
16018
|
+
}
|
|
16019
|
+
}
|
|
16020
|
+
}
|
|
16021
|
+
}
|
|
16022
|
+
}
|
|
16023
|
+
}
|
|
16024
|
+
},
|
|
16025
|
+
"500": {
|
|
16026
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16027
|
+
"content": {
|
|
16028
|
+
"application/json": {
|
|
16029
|
+
"schema": {
|
|
16030
|
+
"$ref": "#/components/schemas/Error"
|
|
16031
|
+
},
|
|
16032
|
+
"examples": {
|
|
16033
|
+
"exampleResponse": {
|
|
16034
|
+
"value": {
|
|
16035
|
+
"name": "InternalServerError",
|
|
16036
|
+
"message": "errorMessage"
|
|
16037
|
+
}
|
|
16038
|
+
}
|
|
16039
|
+
}
|
|
16040
|
+
}
|
|
16041
|
+
}
|
|
16042
|
+
}
|
|
16043
|
+
}
|
|
16044
|
+
},
|
|
16045
|
+
"delete": {
|
|
16046
|
+
"operationId": "removeDataset",
|
|
16047
|
+
"summary": "Remove a dataset from the catalogue by ID",
|
|
16048
|
+
"tags": [
|
|
16049
|
+
"Federated Catalogue"
|
|
16050
|
+
],
|
|
16051
|
+
"parameters": [
|
|
16052
|
+
{
|
|
16053
|
+
"name": "datasetId",
|
|
16054
|
+
"description": "The unique identifier of the dataset.",
|
|
16055
|
+
"in": "path",
|
|
16056
|
+
"required": true,
|
|
16057
|
+
"schema": {
|
|
16058
|
+
"type": "string"
|
|
16059
|
+
},
|
|
16060
|
+
"style": "simple",
|
|
16061
|
+
"example": "urn:uuid:dataset-123"
|
|
16062
|
+
},
|
|
16063
|
+
{
|
|
16064
|
+
"name": "authorization",
|
|
16065
|
+
"in": "header",
|
|
16066
|
+
"required": true,
|
|
16067
|
+
"schema": {
|
|
16068
|
+
"type": "string"
|
|
16069
|
+
},
|
|
16070
|
+
"style": "simple",
|
|
16071
|
+
"example": "Bearer <trust-token>"
|
|
16072
|
+
}
|
|
16073
|
+
],
|
|
16074
|
+
"responses": {
|
|
16075
|
+
"200": {
|
|
16076
|
+
"description": "The response payload for the remove dataset method.",
|
|
16077
|
+
"content": {
|
|
16078
|
+
"application/json": {
|
|
16079
|
+
"schema": {
|
|
16080
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
|
|
16081
|
+
}
|
|
16082
|
+
}
|
|
16083
|
+
}
|
|
16084
|
+
},
|
|
16085
|
+
"400": {
|
|
16086
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
16087
|
+
"content": {
|
|
16088
|
+
"application/json": {
|
|
16089
|
+
"schema": {
|
|
16090
|
+
"$ref": "#/components/schemas/Error"
|
|
16091
|
+
},
|
|
16092
|
+
"examples": {
|
|
16093
|
+
"exampleResponse": {
|
|
16094
|
+
"value": {
|
|
16095
|
+
"name": "GeneralError",
|
|
16096
|
+
"message": "errorMessage",
|
|
16097
|
+
"properties": {
|
|
16098
|
+
"foo": "bar"
|
|
16099
|
+
}
|
|
16100
|
+
}
|
|
16101
|
+
}
|
|
16102
|
+
}
|
|
16103
|
+
}
|
|
16104
|
+
}
|
|
16105
|
+
},
|
|
16106
|
+
"500": {
|
|
16107
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16108
|
+
"content": {
|
|
16109
|
+
"application/json": {
|
|
16110
|
+
"schema": {
|
|
16111
|
+
"$ref": "#/components/schemas/Error"
|
|
16112
|
+
},
|
|
16113
|
+
"examples": {
|
|
16114
|
+
"exampleResponse": {
|
|
16115
|
+
"value": {
|
|
16116
|
+
"name": "InternalServerError",
|
|
16117
|
+
"message": "errorMessage"
|
|
16118
|
+
}
|
|
16119
|
+
}
|
|
16120
|
+
}
|
|
16121
|
+
}
|
|
16122
|
+
}
|
|
16123
|
+
}
|
|
16124
|
+
}
|
|
16125
|
+
}
|
|
16126
|
+
},
|
|
16127
|
+
"/catalog/datasets": {
|
|
16128
|
+
"post": {
|
|
16129
|
+
"operationId": "setDataset",
|
|
16130
|
+
"summary": "Insert or update a dataset in the catalogue",
|
|
16627
16131
|
"tags": [
|
|
16628
16132
|
"Federated Catalogue"
|
|
16629
16133
|
],
|
|
16630
16134
|
"parameters": [
|
|
16631
16135
|
{
|
|
16632
|
-
"name": "
|
|
16633
|
-
"
|
|
16634
|
-
"in": "path",
|
|
16136
|
+
"name": "authorization",
|
|
16137
|
+
"in": "header",
|
|
16635
16138
|
"required": true,
|
|
16636
16139
|
"schema": {
|
|
16637
16140
|
"type": "string"
|
|
16638
16141
|
},
|
|
16639
16142
|
"style": "simple",
|
|
16640
|
-
"example": "
|
|
16143
|
+
"example": "Bearer <trust-token>"
|
|
16641
16144
|
}
|
|
16642
16145
|
],
|
|
16643
|
-
"
|
|
16644
|
-
|
|
16645
|
-
|
|
16146
|
+
"requestBody": {
|
|
16147
|
+
"description": "The request parameters for the set dataset method.",
|
|
16148
|
+
"required": true,
|
|
16149
|
+
"content": {
|
|
16150
|
+
"application/json": {
|
|
16151
|
+
"schema": {
|
|
16152
|
+
"$ref": "https://schema.twindev.org/dcat/DcatDataset"
|
|
16153
|
+
},
|
|
16154
|
+
"examples": {
|
|
16155
|
+
"setDatasetRequestExample": {
|
|
16156
|
+
"value": {
|
|
16157
|
+
"@context": "https://w3id.org/dspace/2025/1/context.jsonld",
|
|
16158
|
+
"@id": "urn:uuid:dataset-123",
|
|
16159
|
+
"@type": "dcat:Dataset",
|
|
16160
|
+
"dcterms:title": "Energy Consumption Data",
|
|
16161
|
+
"dcterms:description": "Historical energy consumption data"
|
|
16162
|
+
}
|
|
16163
|
+
}
|
|
16164
|
+
}
|
|
16165
|
+
}
|
|
16646
16166
|
}
|
|
16647
|
-
|
|
16167
|
+
},
|
|
16648
16168
|
"responses": {
|
|
16649
16169
|
"200": {
|
|
16650
|
-
"description": "The response payload for the
|
|
16170
|
+
"description": "The response payload for the set dataset method.",
|
|
16651
16171
|
"content": {
|
|
16652
16172
|
"application/json": {
|
|
16653
16173
|
"schema": {
|
|
16654
|
-
"$ref": "
|
|
16655
|
-
},
|
|
16656
|
-
"examples": {
|
|
16657
|
-
"getDatasetResponseExample": {
|
|
16658
|
-
"value": {
|
|
16659
|
-
"@context": "https://w3id.org/dspace/2025/1/context.jsonld",
|
|
16660
|
-
"@id": "urn:uuid:dataset-123",
|
|
16661
|
-
"@type": "dcat:Dataset",
|
|
16662
|
-
"dcterms:title": "Energy Consumption Data",
|
|
16663
|
-
"dcterms:description": "Historical energy consumption data"
|
|
16664
|
-
}
|
|
16665
|
-
}
|
|
16174
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
|
|
16666
16175
|
}
|
|
16667
16176
|
}
|
|
16668
16177
|
}
|
|
@@ -16688,24 +16197,6 @@
|
|
|
16688
16197
|
}
|
|
16689
16198
|
}
|
|
16690
16199
|
},
|
|
16691
|
-
"401": {
|
|
16692
|
-
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
16693
|
-
"content": {
|
|
16694
|
-
"application/json": {
|
|
16695
|
-
"schema": {
|
|
16696
|
-
"$ref": "#/components/schemas/Error"
|
|
16697
|
-
},
|
|
16698
|
-
"examples": {
|
|
16699
|
-
"exampleResponse": {
|
|
16700
|
-
"value": {
|
|
16701
|
-
"name": "UnauthorizedError",
|
|
16702
|
-
"message": "errorMessage"
|
|
16703
|
-
}
|
|
16704
|
-
}
|
|
16705
|
-
}
|
|
16706
|
-
}
|
|
16707
|
-
}
|
|
16708
|
-
},
|
|
16709
16200
|
"500": {
|
|
16710
16201
|
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
16711
16202
|
"content": {
|
|
@@ -21854,6 +21345,17 @@
|
|
|
21854
21345
|
],
|
|
21855
21346
|
"description": "The data to be used in the store."
|
|
21856
21347
|
},
|
|
21348
|
+
"DatasetGetResponse": {
|
|
21349
|
+
"anyOf": [
|
|
21350
|
+
{
|
|
21351
|
+
"$ref": "https://schema.twindev.org/dcat/DcatDataset"
|
|
21352
|
+
},
|
|
21353
|
+
{
|
|
21354
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
|
|
21355
|
+
}
|
|
21356
|
+
],
|
|
21357
|
+
"description": "The response payload containing the dataset or error."
|
|
21358
|
+
},
|
|
21857
21359
|
"DataspaceAppDataset": {
|
|
21858
21360
|
"description": "Stored dataset record returned by the Control Plane's dataset CRUD surface.",
|
|
21859
21361
|
"type": "object",
|
|
@@ -22025,17 +21527,6 @@
|
|
|
22025
21527
|
"q"
|
|
22026
21528
|
]
|
|
22027
21529
|
},
|
|
22028
|
-
"GetDatasetResponse": {
|
|
22029
|
-
"anyOf": [
|
|
22030
|
-
{
|
|
22031
|
-
"$ref": "https://schema.twindev.org/dcat/DcatDataset"
|
|
22032
|
-
},
|
|
22033
|
-
{
|
|
22034
|
-
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
|
|
22035
|
-
}
|
|
22036
|
-
],
|
|
22037
|
-
"description": "The response payload containing the dataset or error."
|
|
22038
|
-
},
|
|
22039
21530
|
"GetTransferProcessResponse": {
|
|
22040
21531
|
"oneOf": [
|
|
22041
21532
|
{
|
|
@@ -23664,116 +23155,6 @@
|
|
|
23664
23155
|
],
|
|
23665
23156
|
"description": "Transfer Process (DSP compliant) with state SUSPENDED, or error."
|
|
23666
23157
|
},
|
|
23667
|
-
"SyncChange": {
|
|
23668
|
-
"description": "The object definition for a sync change.",
|
|
23669
|
-
"type": "object",
|
|
23670
|
-
"properties": {
|
|
23671
|
-
"operation": {
|
|
23672
|
-
"$ref": "#/components/schemas/SyncChangeOperation"
|
|
23673
|
-
},
|
|
23674
|
-
"id": {
|
|
23675
|
-
"type": "string",
|
|
23676
|
-
"description": "The item id."
|
|
23677
|
-
},
|
|
23678
|
-
"entity": {
|
|
23679
|
-
"$ref": "#/components/schemas/SynchronisedEntityCore"
|
|
23680
|
-
}
|
|
23681
|
-
},
|
|
23682
|
-
"required": [
|
|
23683
|
-
"operation",
|
|
23684
|
-
"id"
|
|
23685
|
-
]
|
|
23686
|
-
},
|
|
23687
|
-
"SyncChangeOperation": {
|
|
23688
|
-
"description": "The operations for a change",
|
|
23689
|
-
"anyOf": [
|
|
23690
|
-
{
|
|
23691
|
-
"const": "set",
|
|
23692
|
-
"description": "An item was set in the storage."
|
|
23693
|
-
},
|
|
23694
|
-
{
|
|
23695
|
-
"const": "delete",
|
|
23696
|
-
"description": "An item was deleted from the storage."
|
|
23697
|
-
}
|
|
23698
|
-
]
|
|
23699
|
-
},
|
|
23700
|
-
"SyncChangeSet": {
|
|
23701
|
-
"description": "The object definition for a sync change set.",
|
|
23702
|
-
"type": "object",
|
|
23703
|
-
"properties": {
|
|
23704
|
-
"@context": {
|
|
23705
|
-
"const": "https://schema.twindev.org/synchronised-storage/",
|
|
23706
|
-
"description": "The LD Context for the change set."
|
|
23707
|
-
},
|
|
23708
|
-
"type": {
|
|
23709
|
-
"const": "ChangeSet",
|
|
23710
|
-
"description": "The LD Type for the change set."
|
|
23711
|
-
},
|
|
23712
|
-
"id": {
|
|
23713
|
-
"type": "string",
|
|
23714
|
-
"description": "The id of the change set."
|
|
23715
|
-
},
|
|
23716
|
-
"storageKey": {
|
|
23717
|
-
"type": "string",
|
|
23718
|
-
"description": "The storage key of the change set. This is used to identify the entities being synchronised."
|
|
23719
|
-
},
|
|
23720
|
-
"dateCreated": {
|
|
23721
|
-
"type": "string",
|
|
23722
|
-
"description": "The date the change set was created."
|
|
23723
|
-
},
|
|
23724
|
-
"dateModified": {
|
|
23725
|
-
"type": "string",
|
|
23726
|
-
"description": "The date the change set was last modified."
|
|
23727
|
-
},
|
|
23728
|
-
"nodeIdentity": {
|
|
23729
|
-
"type": "string",
|
|
23730
|
-
"description": "The identity of the node that created the change set."
|
|
23731
|
-
},
|
|
23732
|
-
"changes": {
|
|
23733
|
-
"type": "array",
|
|
23734
|
-
"items": {
|
|
23735
|
-
"$ref": "#/components/schemas/SyncChange"
|
|
23736
|
-
},
|
|
23737
|
-
"description": "The changes to apply after a snapshot."
|
|
23738
|
-
}
|
|
23739
|
-
},
|
|
23740
|
-
"required": [
|
|
23741
|
-
"@context",
|
|
23742
|
-
"type",
|
|
23743
|
-
"id",
|
|
23744
|
-
"storageKey",
|
|
23745
|
-
"dateCreated",
|
|
23746
|
-
"dateModified",
|
|
23747
|
-
"nodeIdentity",
|
|
23748
|
-
"changes"
|
|
23749
|
-
]
|
|
23750
|
-
},
|
|
23751
|
-
"SyncDecryptionKeyResponse": {
|
|
23752
|
-
"type": "object",
|
|
23753
|
-
"properties": {
|
|
23754
|
-
"decryptionKey": {
|
|
23755
|
-
"type": "string",
|
|
23756
|
-
"description": "The decryption key for the synchronised storage as base64."
|
|
23757
|
-
}
|
|
23758
|
-
},
|
|
23759
|
-
"required": [
|
|
23760
|
-
"decryptionKey"
|
|
23761
|
-
],
|
|
23762
|
-
"description": "The body of the response."
|
|
23763
|
-
},
|
|
23764
|
-
"SynchronisedEntityCore": {
|
|
23765
|
-
"description": "The base definition for synchronised entries.",
|
|
23766
|
-
"type": "object",
|
|
23767
|
-
"properties": {
|
|
23768
|
-
"dateModified": {
|
|
23769
|
-
"type": "string",
|
|
23770
|
-
"description": "The date the entry was modified."
|
|
23771
|
-
}
|
|
23772
|
-
},
|
|
23773
|
-
"required": [
|
|
23774
|
-
"dateModified"
|
|
23775
|
-
]
|
|
23776
|
-
},
|
|
23777
23158
|
"TelemetryAddMetricValueRequest": {
|
|
23778
23159
|
"type": "object",
|
|
23779
23160
|
"properties": {
|
|
@@ -23999,108 +23380,6 @@
|
|
|
23999
23380
|
],
|
|
24000
23381
|
"description": "The body of the request."
|
|
24001
23382
|
},
|
|
24002
|
-
"VerifiableStorageCreateRequest": {
|
|
24003
|
-
"type": "object",
|
|
24004
|
-
"properties": {
|
|
24005
|
-
"data": {
|
|
24006
|
-
"type": "string",
|
|
24007
|
-
"description": "The data for the verifiable storage item, this is a string serialized as base64."
|
|
24008
|
-
},
|
|
24009
|
-
"allowList": {
|
|
24010
|
-
"type": "array",
|
|
24011
|
-
"items": {
|
|
24012
|
-
"type": "string"
|
|
24013
|
-
},
|
|
24014
|
-
"description": "The list of identities that are allowed to modify the item."
|
|
24015
|
-
},
|
|
24016
|
-
"maxAllowListSize": {
|
|
24017
|
-
"type": "number",
|
|
24018
|
-
"description": "The maximum size of the allow list.",
|
|
24019
|
-
"default": 100
|
|
24020
|
-
},
|
|
24021
|
-
"namespace": {
|
|
24022
|
-
"type": "string",
|
|
24023
|
-
"description": "The namespace of the connector to use for the verifiable storage item, defaults to component configured namespace."
|
|
24024
|
-
}
|
|
24025
|
-
},
|
|
24026
|
-
"required": [
|
|
24027
|
-
"data"
|
|
24028
|
-
],
|
|
24029
|
-
"description": "The data to be stored."
|
|
24030
|
-
},
|
|
24031
|
-
"VerifiableStorageCreateResponse": {
|
|
24032
|
-
"type": "object",
|
|
24033
|
-
"properties": {
|
|
24034
|
-
"receipt": {
|
|
24035
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
24036
|
-
},
|
|
24037
|
-
"id": {
|
|
24038
|
-
"type": "string",
|
|
24039
|
-
"description": "The id of the verifiable storage item."
|
|
24040
|
-
}
|
|
24041
|
-
},
|
|
24042
|
-
"required": [
|
|
24043
|
-
"receipt",
|
|
24044
|
-
"id"
|
|
24045
|
-
],
|
|
24046
|
-
"description": "The data that was stored."
|
|
24047
|
-
},
|
|
24048
|
-
"VerifiableStorageGetRequest": {
|
|
24049
|
-
"type": "object",
|
|
24050
|
-
"properties": {
|
|
24051
|
-
"includeData": {
|
|
24052
|
-
"type": "boolean",
|
|
24053
|
-
"description": "The flag to include the data.",
|
|
24054
|
-
"default": true
|
|
24055
|
-
},
|
|
24056
|
-
"includeAllowList": {
|
|
24057
|
-
"type": "boolean",
|
|
24058
|
-
"description": "The flag to include the allow list.",
|
|
24059
|
-
"default": true
|
|
24060
|
-
}
|
|
24061
|
-
},
|
|
24062
|
-
"description": "The body optional param."
|
|
24063
|
-
},
|
|
24064
|
-
"VerifiableStorageGetResponse": {
|
|
24065
|
-
"type": "object",
|
|
24066
|
-
"properties": {
|
|
24067
|
-
"receipt": {
|
|
24068
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
24069
|
-
},
|
|
24070
|
-
"data": {
|
|
24071
|
-
"type": "string",
|
|
24072
|
-
"description": "The data of the verifiable storage item, this is a string serialized as base64."
|
|
24073
|
-
},
|
|
24074
|
-
"allowList": {
|
|
24075
|
-
"type": "array",
|
|
24076
|
-
"items": {
|
|
24077
|
-
"type": "string"
|
|
24078
|
-
},
|
|
24079
|
-
"description": "The list of identities that are allowed to modify the item."
|
|
24080
|
-
}
|
|
24081
|
-
},
|
|
24082
|
-
"required": [
|
|
24083
|
-
"receipt"
|
|
24084
|
-
],
|
|
24085
|
-
"description": "The data that was obtained."
|
|
24086
|
-
},
|
|
24087
|
-
"VerifiableStorageUpdateRequest": {
|
|
24088
|
-
"type": "object",
|
|
24089
|
-
"properties": {
|
|
24090
|
-
"data": {
|
|
24091
|
-
"type": "string",
|
|
24092
|
-
"description": "The data which is a string serialized as base64, leave empty if just updating the allow list."
|
|
24093
|
-
},
|
|
24094
|
-
"allowList": {
|
|
24095
|
-
"type": "array",
|
|
24096
|
-
"items": {
|
|
24097
|
-
"type": "string"
|
|
24098
|
-
},
|
|
24099
|
-
"description": "An updated list of identities that are allowed to modify the item, send an empty list to remove all entries."
|
|
24100
|
-
}
|
|
24101
|
-
},
|
|
24102
|
-
"description": "The data to be updated."
|
|
24103
|
-
},
|
|
24104
23383
|
"VerifyDepth": {
|
|
24105
23384
|
"description": "How deep to verify the signatures.",
|
|
24106
23385
|
"anyOf": [
|