-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.sdk.json
1069 lines (1069 loc) · 38.5 KB
/
swagger.sdk.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"basePath": "/blockchain/proof/0.10",
"paths": {
"/existence/{configName}/content": {
"post": {
"summary": "Verify content",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Verify content. Please provide the content in the request. You also have to provide whether you have hashed the content yourself, or whether is should be done on the server side",
"operationId": "verifyUsingContent",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/VerifyContentResponse"},
"description": "Content exists or not"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid verification request"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The configName for this operation",
"type": "string",
"required": true
},
{
"schema": {"$ref": "#/definitions/ContentRequest"},
"in": "body",
"name": "existence",
"description": "Verify content using the current settings",
"required": true
},
{
"in": "header",
"name": "requestId",
"description": "Optional request id",
"type": "string",
"required": false
},
{
"in": "header",
"name": "base64Secret",
"description": "An alternate secret key in base64 format that overrides the value in your configuration.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "suppliedSignature",
"description": "An alternate supplied Signature in base64 format that overrides the signature generation.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "keyId",
"description": "An alternate crypto keys API id that will be used for signature generation.",
"type": "string",
"required": false
}
],
"tags": ["Verification"],
"consumes": ["application/json;charset=UTF-8"]
},
"put": {
"summary": "Register content",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Register content. Please provide the content in the request. You also have to provide whether you have hashed the content yourself, or whether is should be done on the server side",
"operationId": "registerUsingContent",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/RegisterContentResponse"},
"description": "Content already registered"
},
"202": {
"schema": {"$ref": "#/definitions/RegisterContentResponse"},
"description": "Registration request received"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid registration request"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The configuration name this operation",
"type": "string",
"required": true
},
{
"schema": {"$ref": "#/definitions/ContentRequest"},
"in": "body",
"name": "existence",
"description": "Register content using the current settings",
"required": true
},
{
"in": "header",
"name": "requestId",
"description": "Optional request id",
"type": "string",
"required": false
},
{
"in": "header",
"name": "base64Secret",
"description": "An alternate secret key in base64 format that overrides the value in your configuration.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "suppliedSignature",
"description": "An alternate supplied Signature in base64 format that overrides the signature generation.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "keyId",
"description": "An alternate crypto keys API id that will be used for signature generation.",
"type": "string",
"required": false
}
],
"tags": ["Registration"],
"consumes": ["application/json;charset=UTF-8"]
}
},
"/existence/{configName}/streams/multipart": {
"post": {
"summary": "Verify bytestream/file hash",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Verify a hash of content by supplying a file or some other binary data. Hashing will be done on the server side. Please note that the binary data itself will not be stored, only the hash. Use the registerUsingContent endpoint if you'd like to store content",
"operationId": "verifyUsingStream",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/VerifyContentResponse"},
"description": "Content exists or not"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid verification request"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The configuration name this operation",
"type": "string",
"required": true
},
{
"in": "formData",
"name": "stream",
"description": "The binary data (not hashed). Hashing will be done on the server side. The binary data will not be stored",
"type": "file",
"required": true
},
{
"in": "query",
"name": "fileName",
"description": "Optional input file name. Needed when using bytestreams instead of filestreams",
"type": "string",
"required": false
},
{
"in": "header",
"name": "requestId",
"description": "Optional request id",
"type": "string",
"required": false
},
{
"in": "header",
"name": "base64Secret",
"description": "An alternate secret key in base64 format that overrides the value in your configuration.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "suppliedSignature",
"description": "An alternate supplied Signature in base64 format that overrides the signature generation.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "keyId",
"description": "An alternate crypto keys API id that will be used for signature generation.",
"type": "string",
"required": false
}
],
"tags": ["Verification"],
"consumes": ["multipart/form-data"]
},
"put": {
"summary": "Register bytestream/file hash",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Register a hash of content by supplying a file or some other binary data. Hashing will be done on the server side. Please note that the binary data itself will not be stored, only the hash. Use the registerUsingContent endpoint if you'd like to store content",
"operationId": "registerUsingStream",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/RegisterContentResponse"},
"description": "Content already registered"
},
"202": {
"schema": {"$ref": "#/definitions/RegisterContentResponse"},
"description": "Registration request received"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid registration request"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The configuration name this operation",
"type": "string",
"required": true
},
{
"in": "formData",
"name": "stream",
"description": "The binary data (not hashed). Hashing will be done on the server side. The binary data will not be stored",
"type": "file",
"required": true
},
{
"in": "query",
"name": "fileName",
"description": "Optional input file name. Needed when using bytestreams instead of filestreams",
"type": "string",
"required": false
},
{
"in": "header",
"name": "requestId",
"description": "Optional request id",
"type": "string",
"required": false
},
{
"in": "header",
"name": "base64Secret",
"description": "An alternate secret key in base64 format that overrides the value in your configuration.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "suppliedSignature",
"description": "An alternate supplied Signature in base64 format that overrides the signature generation.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "keyId",
"description": "An alternate crypto keys API id that will be used for signature generation.",
"type": "string",
"required": false
}
],
"tags": ["Registration"],
"consumes": ["multipart/form-data"]
}
},
"/config": {"post": {
"summary": "Create a new configuration",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Create a new configuration",
"operationId": "createConfiguration",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/ConfigurationResponse"},
"description": "Configuration already exists"
},
"202": {
"schema": {"$ref": "#/definitions/ConfigurationResponse"},
"description": "Configuration request received. Since we do register on the blockchain and this takes some time you will get back a 202 instead of a 201"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid configuration request"
}
},
"parameters": [{
"schema": {"$ref": "#/definitions/CreateConfigurationRequest"},
"in": "body",
"name": "request",
"description": "Create a new Proof of Existence configuration using the provided settings. The context points to a context of the Easy Blockchain API. When you have no own context, simply use 'multichain' without the quotes as context. You will be using our multichain ledger then, which is recomended during development/testing",
"required": true
}],
"tags": ["Configuration"],
"consumes": ["application/json;charset=UTF-8"]
}},
"/existence/{configName}/streams/location": {
"post": {
"summary": "Verify hash using the Storage API",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Verify a hash of file/blob by supplying a Stream location of the Storage API. This Stream Location maps to a location of a file/blob on some remote cloud storage. Hashing will be done on the server side Please note that the binary data itself will not be stored, only the hash. Use the registerUsingContent endpoint if you'd like to store content",
"operationId": "verifyUsingLocation",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/VerifyContentResponse"},
"description": "Content exists or not"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid verification request"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The context for this operation",
"type": "string",
"required": true
},
{
"schema": {"$ref": "#/definitions/StreamLocation"},
"in": "body",
"name": "streamLocation",
"description": "The stream location on storage",
"required": true
},
{
"in": "header",
"name": "requestId",
"description": "Optional request id",
"type": "string",
"required": false
},
{
"in": "header",
"name": "base64Secret",
"description": "An alternate secret key in base64 format that overrides the value in your configuration.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "suppliedSignature",
"description": "An alternate supplied Signature in base64 format that overrides the signature generation.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "keyId",
"description": "An alternate crypto keys API id that will be used for signature generation.",
"type": "string",
"required": false
}
],
"tags": ["Verification"],
"consumes": ["application/json;charset=UTF-8"]
},
"put": {
"summary": "Register hash using the Storage API",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Register a hash of file/blob by supplying a Stream location of the Storage API. This Stream Location maps to a location of a file/blob on some remote cloud storage. Hashing will be done on the server side Please note that the binary data itself will not be stored, only the hash. Use the registerUsingContent endpoint if you'd like to store content",
"operationId": "registerUsingLocation",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/RegisterContentResponse"},
"description": "Content already registered"
},
"202": {
"schema": {"$ref": "#/definitions/RegisterContentResponse"},
"description": "Registration request received"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid registration request"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The configuration name this operation",
"type": "string",
"required": true
},
{
"schema": {"$ref": "#/definitions/StreamLocation"},
"in": "body",
"name": "streamLocation",
"description": "The stream locations on storage",
"required": true
},
{
"in": "header",
"name": "requestId",
"description": "Optional request id",
"type": "string",
"required": false
},
{
"in": "header",
"name": "base64Secret",
"description": "An alternate secret key in base64 format that overrides the value in your configuration.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "suppliedSignature",
"description": "An alternate supplied Signature in base64 format that overrides the signature generation.",
"type": "string",
"required": false
},
{
"in": "header",
"name": "keyId",
"description": "An alternate crypto keys API id that will be used for signature generation.",
"type": "string",
"required": false
}
],
"tags": ["Registration"],
"consumes": ["application/json;charset=UTF-8"]
}
},
"/config/{configName}": {
"post": {
"summary": "Partially update a configuration",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Update a configuration for registration/verification. Does not allow changing the context, access mode or context name. If, and only if, content-extraction-settings are provided, they will be updated. If, and only if, initial-settings are provided, they will be updated.",
"operationId": "updateConfiguration",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/ConfigurationResponse"},
"description": "The configuration"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid request"
},
"404": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Configuration not found"
}
},
"parameters": [
{
"in": "path",
"name": "configName",
"description": "The configuration name for this operation",
"type": "string",
"required": true
},
{
"schema": {"$ref": "#/definitions/UpdateConfigurationRequest"},
"in": "body",
"name": "request",
"description": "Update an existing Proof of Existence configuration using the provided settings. The context points to a context of the Easy Blockchain API. When you have no own context, simply use 'multichain' without the quotes as context. You will be using our multichain ledger then, which is recommended during development/testing",
"required": true
}
],
"tags": ["Configuration"],
"consumes": ["application/json"]
},
"get": {
"summary": "Get configuration",
"security": [{"oauth2schema": ["global"]}],
"produces": ["application/json;charset=UTF-8"],
"description": "Get the configuration for registration/verification",
"operationId": "getConfiguration",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/ConfigurationResponse"},
"description": "The configuration"
},
"400": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Invalid request"
},
"404": {
"schema": {"$ref": "#/definitions/ErrorResponse"},
"description": "Configuration not found"
}
},
"parameters": [{
"in": "path",
"name": "configName",
"description": "The configuration name for this operation",
"type": "string",
"required": true
}],
"tags": ["Configuration"],
"consumes": ["application/json"]
}
}
},
"host": "gw.api.cloud.sphereon.com",
"schemes": ["https"],
"securityDefinitions": {"oauth2schema": {
"tokenUrl": "https://gw.api.cloud.sphereon.com/token",
"scopes": {"global": "accessEverything"},
"type": "oauth2",
"flow": "application"
}},
"definitions": {
"CommittedChain": {
"description": "Committed Chain",
"type": "object",
"properties": {
"chainId": {
"description": "Chain Id",
"readOnly": true,
"type": "string"
},
"context": {
"description": "The context",
"readOnly": true,
"type": "string"
}
}
},
"ConfigurationResponse": {
"description": "Committed context and settings response",
"type": "object",
"required": ["configuration"],
"properties": {"configuration": {"$ref": "#/definitions/Configuration"}}
},
"Configuration": {
"description": "The stored chainSettings from the chainSettings chain",
"type": "object",
"required": [
"accessMode",
"chainSettings",
"context",
"id",
"name",
"validFrom"
],
"properties": {
"singleProofChain": {
"readOnly": true,
"$ref": "#/definitions/CommittedChain"
},
"chainSettings": {
"readOnly": true,
"$ref": "#/definitions/ChainSettings"
},
"context": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"contentExtractionSettings": {"$ref": "#/definitions/ContentExtractionSettings"},
"id": {
"readOnly": true,
"type": "string"
},
"validFrom": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"accessMode": {
"readOnly": true,
"type": "string",
"enum": [
"PUBLIC",
"PRIVATE"
]
}
}
},
"ChainSettings": {
"description": "Existence ChainSettings. Normally you only supply them once during chain creation or during a settings update. You can also supply them during a content request, but then it is up to you to also supply the correct setting during verify",
"type": "object",
"required": [
"contentRegistrationChainTypes",
"signatureSettings",
"version"
],
"properties": {
"singleProofChain": {
"description": "The proof chain Id linked to the current configuration. This is a shared proof chain for all registrations/hashes. Only when the single proof chain type has been configured.",
"type": "string"
},
"contentRegistrationChainTypes": {
"description": "A set of content registration chain types. This can be a single proof chain for all hashes, a more powerful chain per hash, or both",
"type": "array",
"items": {
"type": "string",
"enum": [
"PER_HASH_PROOF_CHAIN",
"SINGLE_PROOF_CHAIN"
]
}
},
"signatureSettings": {
"description": "Settings that determine how the signature should be registered/verified",
"$ref": "#/definitions/SignatureSettings"
},
"version": {
"format": "int32",
"description": "The settings version (only 1 for now)",
"type": "integer",
"enum": [1]
},
"hashAlgorithm": {
"description": "The hashing method used for the content. We always return and expect the hash in base64 form",
"type": "string",
"enum": [
"SHA_256",
"SHA_512"
]
}
}
},
"Error": {
"description": "An error",
"type": "object",
"required": [
"code",
"level",
"message"
],
"properties": {
"code": {"type": "string"},
"level": {
"type": "string",
"enum": [
"INFO",
"WARNING",
"FATAL"
]
},
"cause": {"$ref": "#/definitions/Error"},
"message": {"type": "string"}
}
},
"StreamLocation": {
"description": "Location record of data stream",
"type": "object",
"properties": {
"folderPath": {"type": "string"},
"filename": {"type": "string"},
"id": {
"readOnly": true,
"type": "string"
},
"containerId": {"type": "string"},
"originalFilename": {"type": "string"}
}
},
"ContentExtractionSettings": {
"description": "Content extraction Settings. Normally proofs are done solely on the full binary content of the file itself. Sometimes you want to look at particular parts of the file. For instance the content of a PDF file. Adobe PDF changes the file on save as, whilst the contents stays the same",
"type": "object",
"required": [
"binaryComparison",
"contentExtraction"
],
"properties": {
"binaryComparison": {
"description": "Whether to do a binary comparison on the file",
"type": "boolean",
"example": false
},
"contentExtraction": {
"description": "Whether to try a content extraction comparison on the file",
"type": "boolean",
"example": false
},
"minimumContentExtractionCharacters": {
"format": "int32",
"description": "When using content extraction. Only apply it to content that is larger than the amount of characters specified in here. Please note that you want enough entropy when using content extraction. We suggest to not go lower than this value",
"type": "integer"
}
}
},
"SignatureSettings": {
"description": "How to calculate the signature",
"type": "object",
"required": ["signatureType"],
"properties": {
"base64Secret": {
"description": "An alternate Secret key that overrides the value in your configuration in base64. Used for generating a signature with a base64Secret",
"type": "string"
},
"keyConfig": {
"description": "Crypto keys config name when KEY_NAME_ONLY is supplied for key qualification",
"type": "string"
},
"suppliedSignature": {
"description": "Only use this if you calculate your own signature. Otherwise always leave this blank! We will use the signature as is for registration/verification",
"type": "string"
},
"signatureType": {
"description": "How to calculate the signature during registration and verification. Defaults to the configured value if omitted",
"type": "string",
"enum": [
"KEY_ID",
"SUPPLIED",
"SECRET",
"NONE"
]
},
"keyId": {
"description": "Use a symmetric or asymmetric key from the crypto keys API to generate the signature.",
"type": "string"
},
"keyQualification": {
"description": "This determines whether yoy use fully qualified keyIds of the crypto-keys API in form (config/keys/keyname/version) or that you only use the keyname and provide the configuration here. The later means we will use the latest version by default",
"type": "string",
"enum": [
"KEY_NAME_ONLY",
"FULLY_QUALIFIED_KEY_ID"
]
}
}
},
"ErrorResponse": {
"description": "The error response",
"type": "object",
"properties": {"errors": {
"type": "array",
"items": {"$ref": "#/definitions/Error"}
}}
},
"UpdateConfigurationRequest": {
"description": "Partially update a context configuration",
"type": "object",
"properties": {
"initialSettings": {
"description": "The initial context settings.",
"$ref": "#/definitions/ChainSettings"
},
"contentExtractionSettings": {"$ref": "#/definitions/ContentExtractionSettings"}
}
},
"VerifyContentResponse": {
"description": "Verify Content response",
"type": "object",
"required": [
"base64Signature",
"contentRegistrationChainTypes",
"contextName",
"hash",
"hexSignature",
"signatureType"
],
"properties": {
"registrationTime": {
"format": "date-time",
"description": "This is the first registration time from the singleProofChain or the perHashProofChain",
"readOnly": true,
"type": "string"
},
"contextName": {"type": "string"},
"singleProofChain": {
"description": "This is the single proof chain where all hashes are stored in a single chain (if configured)",
"$ref": "#/definitions/CommittedEntry"
},
"contentRegistrationChainTypes": {
"description": "A set of content registration targets",
"type": "array",
"items": {
"type": "string",
"enum": [
"PER_HASH_PROOF_CHAIN",
"SINGLE_PROOF_CHAIN"
]
}
},
"signatureType": {
"description": "The signature type from the request or the default from the settings",
"readOnly": true,
"type": "string",
"enum": [
"KEY_ID",
"SUPPLIED",
"SECRET",
"NONE"
]
},
"perHashProofChain": {
"description": "This is the proof chain specific for the current hash, so a chain per hash (if configured)",
"$ref": "#/definitions/CommittedEntry"
},
"requestId": {"type": "string"},
"base64Signature": {
"description": "The calculated signature in base64 form",
"readOnly": true,
"type": "string"
},
"registrationState": {
"description": "This is the registration state from the singleProofChain or the perHashProofChain. If one of the chains has a registration this will return REGISTERED",
"readOnly": true,
"type": "string",
"enum": [
"NOT_REGISTERED",
"PENDING",
"REGISTERED"
]
},
"signatureState": {
"description": "This is the signature state.",
"type": "string",
"enum": [
"NOT_FOUND",
"UNSIGNED",
"INVALID",
"VERIFIED"
]
},
"hash": {
"description": "The hash in base64 format that you supplied or that was calculated. This is the actual hash for the content",
"readOnly": true,
"type": "string"
},
"signatureStateMessage": {
"description": "This is a message describing the signature state.",
"type": "string"
},
"hexSignature": {
"description": "The calculated signature in hex form",
"readOnly": true,
"type": "string"
}
}
},
"ContentRequest": {
"description": "Content existence request",
"type": "object",
"required": [
"content",
"hashProvider"
],
"properties": {
"fileName": {
"description": "Optional fileName. Used when content extraction is enabled and SERVER hashing is being used. This allows better content extraction of binary file formats like Office files. Do not use when using CLIENT as hashProvider",
"type": "string"
},
"hashProvider": {
"description": "When CLIENT is supplied the content should already have been hashed by you. When SERVER is supplied we will hash the content. Please note that we do not validate the hash when you supply it",
"type": "string",
"enum": [
"SERVER",
"CLIENT"
]
},
"signatureSettings": {
"description": "Optional signature settings like signature type",
"$ref": "#/definitions/SignatureSettings"
},
"content": {
"format": "byte",
"description": "The content to register in base64.",
"type": "string"
}
}
},
"CommittedEntry": {
"description": "Commited Entry",
"type": "object",
"required": [
"entryId",
"registrationState"
],
"properties": {
"registrationTime": {
"format": "date-time",
"description": "The registration time of the entry. Only when registration has occurred ofcourse",
"readOnly": true,
"type": "string"
},
"chainId": {
"description": "Chain Id",
"readOnly": true,
"type": "string"
},
"context": {
"description": "The context",
"readOnly": true,
"type": "string"
},
"registrationState": {
"description": "The registration state of the entry",
"readOnly": true,
"type": "string",
"enum": [
"NOT_REGISTERED",
"PENDING",
"REGISTERED"
]
},
"signatureState": {
"description": "This is the signature state.",
"type": "string",
"enum": [
"NOT_FOUND",
"UNSIGNED",
"INVALID",
"VERIFIED"
]
},
"signatureStateMessage": {
"description": "This is a message describing the signature state.",
"type": "string"
},
"entryId": {
"description": "The entry Id for the registration",
"readOnly": true,
"type": "string"
}
}
},
"RegisterContentResponse": {
"description": "Committed Content response",
"type": "object",
"required": [
"base64Signature",
"contextName",
"hash",
"hexSignature",
"signatureType"
],
"properties": {
"contextName": {"type": "string"},
"singleProofChain": {
"description": "This is the single proof chain where all hashes are stored (if configured)",
"$ref": "#/definitions/CommittedEntry"
},
"contentRegistrationChainTypes": {
"description": "A set of content registration targets",
"type": "array",
"items": {
"type": "string",
"enum": [
"PER_HASH_PROOF_CHAIN",
"SINGLE_PROOF_CHAIN"
]
}
},
"requestId": {"type": "string"},
"signatureType": {
"description": "The signature type from the request or the default from the settings",
"readOnly": true,
"type": "string",
"enum": [
"KEY_ID",
"SUPPLIED",
"SECRET",
"NONE"
]
},
"perHashProofChain": {
"description": "This is the proof chain specific for the current hash (if configured)",
"$ref": "#/definitions/CommittedEntry"
},
"base64Signature": {
"description": "The calculated signature in base64 form",
"readOnly": true,
"type": "string"
},
"hash": {
"description": "The hash in base64 format that you supplied or that was calculated. This is the actual hash for the content",
"readOnly": true,
"type": "string"
},
"hexSignature": {
"description": "The calculated signature in hex form",
"readOnly": true,
"type": "string"
}
}
},
"CreateConfigurationRequest": {
"description": "Create a context configuration",
"type": "object",
"required": [