@twin.org/node-core 0.0.3-next.28 → 0.0.3-next.29

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.
@@ -12,9 +12,9 @@ The engine server environment variables.
12
12
 
13
13
  ## Properties
14
14
 
15
- ### debug?
15
+ ### debug? {#debug}
16
16
 
17
- > `optional` **debug**: `string`
17
+ > `optional` **debug?**: `string`
18
18
 
19
19
  Start the engine in debug mode.
20
20
 
@@ -24,9 +24,9 @@ Start the engine in debug mode.
24
24
 
25
25
  ***
26
26
 
27
- ### silent?
27
+ ### silent? {#silent}
28
28
 
29
- > `optional` **silent**: `string`
29
+ > `optional` **silent?**: `string`
30
30
 
31
31
  Start the engine in silent mode.
32
32
 
@@ -36,9 +36,9 @@ Start the engine in silent mode.
36
36
 
37
37
  ***
38
38
 
39
- ### storageFileRoot?
39
+ ### storageFileRoot? {#storagefileroot}
40
40
 
41
- > `optional` **storageFileRoot**: `string`
41
+ > `optional` **storageFileRoot?**: `string`
42
42
 
43
43
  The root directory for storing items like state file.
44
44
 
@@ -48,9 +48,9 @@ The root directory for storing items like state file.
48
48
 
49
49
  ***
50
50
 
51
- ### stateFilename?
51
+ ### stateFilename? {#statefilename}
52
52
 
53
- > `optional` **stateFilename**: `string`
53
+ > `optional` **stateFilename?**: `string`
54
54
 
55
55
  The name of the state file.
56
56
 
@@ -60,9 +60,9 @@ The name of the state file.
60
60
 
61
61
  ***
62
62
 
63
- ### nodeIdentityEnabled?
63
+ ### nodeIdentityEnabled? {#nodeidentityenabled}
64
64
 
65
- > `optional` **nodeIdentityEnabled**: `string`
65
+ > `optional` **nodeIdentityEnabled?**: `string`
66
66
 
67
67
  Does the node have a unique ID, defaults to true.
68
68
 
@@ -72,9 +72,9 @@ Does the node have a unique ID, defaults to true.
72
72
 
73
73
  ***
74
74
 
75
- ### tenantEnabled?
75
+ ### tenantEnabled? {#tenantenabled}
76
76
 
77
- > `optional` **tenantEnabled**: `string`
77
+ > `optional` **tenantEnabled?**: `string`
78
78
 
79
79
  Is multi-tenant support enabled, defaults to false.
80
80
 
@@ -84,9 +84,9 @@ Is multi-tenant support enabled, defaults to false.
84
84
 
85
85
  ***
86
86
 
87
- ### entityStorageConnectorType?
87
+ ### entityStorageConnectorType? {#entitystorageconnectortype}
88
88
 
89
- > `optional` **entityStorageConnectorType**: `string`
89
+ > `optional` **entityStorageConnectorType?**: `string`
90
90
 
91
91
  The type of the entity storage to create, comma separate for more than one connector.
92
92
  values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
@@ -97,9 +97,9 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
97
97
 
98
98
  ***
99
99
 
100
- ### entityStorageConnectorDefault?
100
+ ### entityStorageConnectorDefault? {#entitystorageconnectordefault}
101
101
 
102
- > `optional` **entityStorageConnectorDefault**: `string`
102
+ > `optional` **entityStorageConnectorDefault?**: `string`
103
103
 
104
104
  The default entity storage connector to use, defaults to the first one in the list.
105
105
 
@@ -109,9 +109,9 @@ The default entity storage connector to use, defaults to the first one in the li
109
109
 
110
110
  ***
111
111
 
112
- ### entityStorageTablePrefix?
112
+ ### entityStorageTablePrefix? {#entitystoragetableprefix}
113
113
 
114
- > `optional` **entityStorageTablePrefix**: `string`
114
+ > `optional` **entityStorageTablePrefix?**: `string`
115
115
 
116
116
  A prefix for all the table in entity-storage, can be empty.
117
117
 
@@ -121,9 +121,9 @@ A prefix for all the table in entity-storage, can be empty.
121
121
 
122
122
  ***
123
123
 
124
- ### awsDynamodbAuthMode?
124
+ ### awsDynamodbAuthMode? {#awsdynamodbauthmode}
125
125
 
126
- > `optional` **awsDynamodbAuthMode**: `string`
126
+ > `optional` **awsDynamodbAuthMode?**: `string`
127
127
 
128
128
  AWS DynamoDB auth mode, either credentials or pod.
129
129
 
@@ -133,9 +133,9 @@ AWS DynamoDB auth mode, either credentials or pod.
133
133
 
134
134
  ***
135
135
 
136
- ### awsDynamodbAccessKeyId?
136
+ ### awsDynamodbAccessKeyId? {#awsdynamodbaccesskeyid}
137
137
 
138
- > `optional` **awsDynamodbAccessKeyId**: `string`
138
+ > `optional` **awsDynamodbAccessKeyId?**: `string`
139
139
 
140
140
  AWS Dynamo DB access key id.
141
141
 
@@ -145,9 +145,9 @@ AWS Dynamo DB access key id.
145
145
 
146
146
  ***
147
147
 
148
- ### awsDynamodbEndpoint?
148
+ ### awsDynamodbEndpoint? {#awsdynamodbendpoint}
149
149
 
150
- > `optional` **awsDynamodbEndpoint**: `string`
150
+ > `optional` **awsDynamodbEndpoint?**: `string`
151
151
 
152
152
  AWS Dynamo DB Endpoint if running local instance.
153
153
 
@@ -157,9 +157,9 @@ AWS Dynamo DB Endpoint if running local instance.
157
157
 
158
158
  ***
159
159
 
160
- ### awsDynamodbRegion?
160
+ ### awsDynamodbRegion? {#awsdynamodbregion}
161
161
 
162
- > `optional` **awsDynamodbRegion**: `string`
162
+ > `optional` **awsDynamodbRegion?**: `string`
163
163
 
164
164
  AWS Dynamo DB region.
165
165
 
@@ -169,9 +169,9 @@ AWS Dynamo DB region.
169
169
 
170
170
  ***
171
171
 
172
- ### awsDynamodbSecretAccessKey?
172
+ ### awsDynamodbSecretAccessKey? {#awsdynamodbsecretaccesskey}
173
173
 
174
- > `optional` **awsDynamodbSecretAccessKey**: `string`
174
+ > `optional` **awsDynamodbSecretAccessKey?**: `string`
175
175
 
176
176
  AWS Dynamo DB secret access key.
177
177
 
@@ -181,9 +181,9 @@ AWS Dynamo DB secret access key.
181
181
 
182
182
  ***
183
183
 
184
- ### awsDynamodbConnectionTimeoutMs?
184
+ ### awsDynamodbConnectionTimeoutMs? {#awsdynamodbconnectiontimeoutms}
185
185
 
186
- > `optional` **awsDynamodbConnectionTimeoutMs**: `string`
186
+ > `optional` **awsDynamodbConnectionTimeoutMs?**: `string`
187
187
 
188
188
  AWS Dynamo DB connection timeout.
189
189
 
@@ -193,9 +193,9 @@ AWS Dynamo DB connection timeout.
193
193
 
194
194
  ***
195
195
 
196
- ### azureCosmosdbKey?
196
+ ### azureCosmosdbKey? {#azurecosmosdbkey}
197
197
 
198
- > `optional` **azureCosmosdbKey**: `string`
198
+ > `optional` **azureCosmosdbKey?**: `string`
199
199
 
200
200
  Azure Cosmos DB key.
201
201
 
@@ -205,9 +205,9 @@ Azure Cosmos DB key.
205
205
 
206
206
  ***
207
207
 
208
- ### azureCosmosdbContainerId?
208
+ ### azureCosmosdbContainerId? {#azurecosmosdbcontainerid}
209
209
 
210
- > `optional` **azureCosmosdbContainerId**: `string`
210
+ > `optional` **azureCosmosdbContainerId?**: `string`
211
211
 
212
212
  Azure Cosmos DB container id.
213
213
 
@@ -217,9 +217,9 @@ Azure Cosmos DB container id.
217
217
 
218
218
  ***
219
219
 
220
- ### azureCosmosdbDatabaseId?
220
+ ### azureCosmosdbDatabaseId? {#azurecosmosdbdatabaseid}
221
221
 
222
- > `optional` **azureCosmosdbDatabaseId**: `string`
222
+ > `optional` **azureCosmosdbDatabaseId?**: `string`
223
223
 
224
224
  Azure Cosmos DB database id.
225
225
 
@@ -229,9 +229,9 @@ Azure Cosmos DB database id.
229
229
 
230
230
  ***
231
231
 
232
- ### azureCosmosdbEndpoint?
232
+ ### azureCosmosdbEndpoint? {#azurecosmosdbendpoint}
233
233
 
234
- > `optional` **azureCosmosdbEndpoint**: `string`
234
+ > `optional` **azureCosmosdbEndpoint?**: `string`
235
235
 
236
236
  Azure Cosmos DB endpoint.
237
237
 
@@ -241,9 +241,9 @@ Azure Cosmos DB endpoint.
241
241
 
242
242
  ***
243
243
 
244
- ### gcpFirestoreCollectionName?
244
+ ### gcpFirestoreCollectionName? {#gcpfirestorecollectionname}
245
245
 
246
- > `optional` **gcpFirestoreCollectionName**: `string`
246
+ > `optional` **gcpFirestoreCollectionName?**: `string`
247
247
 
248
248
  GCP Firestore collection name.
249
249
 
@@ -253,9 +253,9 @@ GCP Firestore collection name.
253
253
 
254
254
  ***
255
255
 
256
- ### gcpFirestoreCredentials?
256
+ ### gcpFirestoreCredentials? {#gcpfirestorecredentials}
257
257
 
258
- > `optional` **gcpFirestoreCredentials**: `string`
258
+ > `optional` **gcpFirestoreCredentials?**: `string`
259
259
 
260
260
  GCP Firestore credentials.
261
261
 
@@ -265,9 +265,9 @@ GCP Firestore credentials.
265
265
 
266
266
  ***
267
267
 
268
- ### gcpFirestoreDatabaseId?
268
+ ### gcpFirestoreDatabaseId? {#gcpfirestoredatabaseid}
269
269
 
270
- > `optional` **gcpFirestoreDatabaseId**: `string`
270
+ > `optional` **gcpFirestoreDatabaseId?**: `string`
271
271
 
272
272
  GCP Firestore database id.
273
273
 
@@ -277,9 +277,9 @@ GCP Firestore database id.
277
277
 
278
278
  ***
279
279
 
280
- ### gcpFirestoreApiEndpoint?
280
+ ### gcpFirestoreApiEndpoint? {#gcpfirestoreapiendpoint}
281
281
 
282
- > `optional` **gcpFirestoreApiEndpoint**: `string`
282
+ > `optional` **gcpFirestoreApiEndpoint?**: `string`
283
283
 
284
284
  GCP Firestore endpoint.
285
285
 
@@ -289,9 +289,9 @@ GCP Firestore endpoint.
289
289
 
290
290
  ***
291
291
 
292
- ### gcpFirestoreProjectId?
292
+ ### gcpFirestoreProjectId? {#gcpfirestoreprojectid}
293
293
 
294
- > `optional` **gcpFirestoreProjectId**: `string`
294
+ > `optional` **gcpFirestoreProjectId?**: `string`
295
295
 
296
296
  GCP Firestore project id.
297
297
 
@@ -301,9 +301,9 @@ GCP Firestore project id.
301
301
 
302
302
  ***
303
303
 
304
- ### scylladbHosts?
304
+ ### scylladbHosts? {#scylladbhosts}
305
305
 
306
- > `optional` **scylladbHosts**: `string`
306
+ > `optional` **scylladbHosts?**: `string`
307
307
 
308
308
  ScyllaDB hosts as comma separated string.
309
309
 
@@ -313,9 +313,9 @@ ScyllaDB hosts as comma separated string.
313
313
 
314
314
  ***
315
315
 
316
- ### scylladbKeyspace?
316
+ ### scylladbKeyspace? {#scylladbkeyspace}
317
317
 
318
- > `optional` **scylladbKeyspace**: `string`
318
+ > `optional` **scylladbKeyspace?**: `string`
319
319
 
320
320
  ScyllaDB keyspace.
321
321
 
@@ -325,9 +325,9 @@ ScyllaDB keyspace.
325
325
 
326
326
  ***
327
327
 
328
- ### scylladbLocalDataCenter?
328
+ ### scylladbLocalDataCenter? {#scylladblocaldatacenter}
329
329
 
330
- > `optional` **scylladbLocalDataCenter**: `string`
330
+ > `optional` **scylladbLocalDataCenter?**: `string`
331
331
 
332
332
  ScyllaDB local data center.
333
333
 
@@ -337,9 +337,9 @@ ScyllaDB local data center.
337
337
 
338
338
  ***
339
339
 
340
- ### scylladbPort?
340
+ ### scylladbPort? {#scylladbport}
341
341
 
342
- > `optional` **scylladbPort**: `string`
342
+ > `optional` **scylladbPort?**: `string`
343
343
 
344
344
  ScyllaDB port.
345
345
 
@@ -349,9 +349,9 @@ ScyllaDB port.
349
349
 
350
350
  ***
351
351
 
352
- ### mySqlHost?
352
+ ### mySqlHost? {#mysqlhost}
353
353
 
354
- > `optional` **mySqlHost**: `string`
354
+ > `optional` **mySqlHost?**: `string`
355
355
 
356
356
  MySQL host.
357
357
 
@@ -361,9 +361,9 @@ MySQL host.
361
361
 
362
362
  ***
363
363
 
364
- ### mySqlPort?
364
+ ### mySqlPort? {#mysqlport}
365
365
 
366
- > `optional` **mySqlPort**: `number`
366
+ > `optional` **mySqlPort?**: `number`
367
367
 
368
368
  MySQL port.
369
369
 
@@ -373,9 +373,9 @@ MySQL port.
373
373
 
374
374
  ***
375
375
 
376
- ### mySqlUser?
376
+ ### mySqlUser? {#mysqluser}
377
377
 
378
- > `optional` **mySqlUser**: `string`
378
+ > `optional` **mySqlUser?**: `string`
379
379
 
380
380
  MySQL username.
381
381
 
@@ -385,9 +385,9 @@ MySQL username.
385
385
 
386
386
  ***
387
387
 
388
- ### mySqlPassword?
388
+ ### mySqlPassword? {#mysqlpassword}
389
389
 
390
- > `optional` **mySqlPassword**: `string`
390
+ > `optional` **mySqlPassword?**: `string`
391
391
 
392
392
  MySQL password.
393
393
 
@@ -397,9 +397,9 @@ MySQL password.
397
397
 
398
398
  ***
399
399
 
400
- ### mySqlDatabase?
400
+ ### mySqlDatabase? {#mysqldatabase}
401
401
 
402
- > `optional` **mySqlDatabase**: `string`
402
+ > `optional` **mySqlDatabase?**: `string`
403
403
 
404
404
  MySQL Database.
405
405
 
@@ -409,9 +409,9 @@ MySQL Database.
409
409
 
410
410
  ***
411
411
 
412
- ### mongoDbHost?
412
+ ### mongoDbHost? {#mongodbhost}
413
413
 
414
- > `optional` **mongoDbHost**: `string`
414
+ > `optional` **mongoDbHost?**: `string`
415
415
 
416
416
  MongoDB host.
417
417
 
@@ -421,9 +421,9 @@ MongoDB host.
421
421
 
422
422
  ***
423
423
 
424
- ### mongoDbPort?
424
+ ### mongoDbPort? {#mongodbport}
425
425
 
426
- > `optional` **mongoDbPort**: `number`
426
+ > `optional` **mongoDbPort?**: `number`
427
427
 
428
428
  MongoDB port.
429
429
 
@@ -433,9 +433,9 @@ MongoDB port.
433
433
 
434
434
  ***
435
435
 
436
- ### mongoDbUser?
436
+ ### mongoDbUser? {#mongodbuser}
437
437
 
438
- > `optional` **mongoDbUser**: `string`
438
+ > `optional` **mongoDbUser?**: `string`
439
439
 
440
440
  MongoDB username.
441
441
 
@@ -445,9 +445,9 @@ MongoDB username.
445
445
 
446
446
  ***
447
447
 
448
- ### mongoDbPassword?
448
+ ### mongoDbPassword? {#mongodbpassword}
449
449
 
450
- > `optional` **mongoDbPassword**: `string`
450
+ > `optional` **mongoDbPassword?**: `string`
451
451
 
452
452
  MongoDB password.
453
453
 
@@ -457,9 +457,9 @@ MongoDB password.
457
457
 
458
458
  ***
459
459
 
460
- ### mongoDbDatabase?
460
+ ### mongoDbDatabase? {#mongodbdatabase}
461
461
 
462
- > `optional` **mongoDbDatabase**: `string`
462
+ > `optional` **mongoDbDatabase?**: `string`
463
463
 
464
464
  MongoDB Database.
465
465
 
@@ -469,9 +469,9 @@ MongoDB Database.
469
469
 
470
470
  ***
471
471
 
472
- ### postgreSqlHost?
472
+ ### postgreSqlHost? {#postgresqlhost}
473
473
 
474
- > `optional` **postgreSqlHost**: `string`
474
+ > `optional` **postgreSqlHost?**: `string`
475
475
 
476
476
  PostgreSQl host.
477
477
 
@@ -481,9 +481,9 @@ PostgreSQl host.
481
481
 
482
482
  ***
483
483
 
484
- ### postgreSqlPort?
484
+ ### postgreSqlPort? {#postgresqlport}
485
485
 
486
- > `optional` **postgreSqlPort**: `number`
486
+ > `optional` **postgreSqlPort?**: `number`
487
487
 
488
488
  PostgreSQl port.
489
489
 
@@ -493,9 +493,9 @@ PostgreSQl port.
493
493
 
494
494
  ***
495
495
 
496
- ### postgreSqlUser?
496
+ ### postgreSqlUser? {#postgresqluser}
497
497
 
498
- > `optional` **postgreSqlUser**: `string`
498
+ > `optional` **postgreSqlUser?**: `string`
499
499
 
500
500
  PostgreSQl username.
501
501
 
@@ -505,9 +505,9 @@ PostgreSQl username.
505
505
 
506
506
  ***
507
507
 
508
- ### postgreSqlPassword?
508
+ ### postgreSqlPassword? {#postgresqlpassword}
509
509
 
510
- > `optional` **postgreSqlPassword**: `string`
510
+ > `optional` **postgreSqlPassword?**: `string`
511
511
 
512
512
  PostgreSQl password.
513
513
 
@@ -517,9 +517,9 @@ PostgreSQl password.
517
517
 
518
518
  ***
519
519
 
520
- ### postgreSqlDatabase?
520
+ ### postgreSqlDatabase? {#postgresqldatabase}
521
521
 
522
- > `optional` **postgreSqlDatabase**: `string`
522
+ > `optional` **postgreSqlDatabase?**: `string`
523
523
 
524
524
  PostgreSQl Database.
525
525
 
@@ -529,9 +529,9 @@ PostgreSQl Database.
529
529
 
530
530
  ***
531
531
 
532
- ### ipfsBearerToken?
532
+ ### ipfsBearerToken? {#ipfsbearertoken}
533
533
 
534
- > `optional` **ipfsBearerToken**: `string`
534
+ > `optional` **ipfsBearerToken?**: `string`
535
535
 
536
536
  The security token for accessing IPFS API.
537
537
 
@@ -541,9 +541,9 @@ The security token for accessing IPFS API.
541
541
 
542
542
  ***
543
543
 
544
- ### ipfsApiUrl?
544
+ ### ipfsApiUrl? {#ipfsapiurl}
545
545
 
546
- > `optional` **ipfsApiUrl**: `string`
546
+ > `optional` **ipfsApiUrl?**: `string`
547
547
 
548
548
  The url for accessing IPFS API.
549
549
 
@@ -553,9 +553,9 @@ The url for accessing IPFS API.
553
553
 
554
554
  ***
555
555
 
556
- ### blobStorageConnectorType?
556
+ ### blobStorageConnectorType? {#blobstorageconnectortype}
557
557
 
558
- > `optional` **blobStorageConnectorType**: `string`
558
+ > `optional` **blobStorageConnectorType?**: `string`
559
559
 
560
560
  The type of the entity storage to create, comma separate for more than one connector.
561
561
  values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
@@ -566,9 +566,9 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
566
566
 
567
567
  ***
568
568
 
569
- ### blobStorageConnectorDefault?
569
+ ### blobStorageConnectorDefault? {#blobstorageconnectordefault}
570
570
 
571
- > `optional` **blobStorageConnectorDefault**: `string`
571
+ > `optional` **blobStorageConnectorDefault?**: `string`
572
572
 
573
573
  The default blob storage connector to use, defaults to the first one in the list.
574
574
 
@@ -578,9 +578,9 @@ The default blob storage connector to use, defaults to the first one in the list
578
578
 
579
579
  ***
580
580
 
581
- ### blobStorageConnectorPublic?
581
+ ### blobStorageConnectorPublic? {#blobstorageconnectorpublic}
582
582
 
583
- > `optional` **blobStorageConnectorPublic**: `string`
583
+ > `optional` **blobStorageConnectorPublic?**: `string`
584
584
 
585
585
  Blog storage connector which has public access.
586
586
 
@@ -590,9 +590,9 @@ Blog storage connector which has public access.
590
590
 
591
591
  ***
592
592
 
593
- ### blobStorageEnableEncryption?
593
+ ### blobStorageEnableEncryption? {#blobstorageenableencryption}
594
594
 
595
- > `optional` **blobStorageEnableEncryption**: `string`
595
+ > `optional` **blobStorageEnableEncryption?**: `string`
596
596
 
597
597
  Enable encryption for the blob storage.
598
598
 
@@ -602,9 +602,9 @@ Enable encryption for the blob storage.
602
602
 
603
603
  ***
604
604
 
605
- ### blobStorageEncryptionKeyId?
605
+ ### blobStorageEncryptionKeyId? {#blobstorageencryptionkeyid}
606
606
 
607
- > `optional` **blobStorageEncryptionKeyId**: `string`
607
+ > `optional` **blobStorageEncryptionKeyId?**: `string`
608
608
 
609
609
  The id of the encryption key for the blob storage.
610
610
 
@@ -614,9 +614,9 @@ The id of the encryption key for the blob storage.
614
614
 
615
615
  ***
616
616
 
617
- ### blobStoragePrefix?
617
+ ### blobStoragePrefix? {#blobstorageprefix}
618
618
 
619
- > `optional` **blobStoragePrefix**: `string`
619
+ > `optional` **blobStoragePrefix?**: `string`
620
620
 
621
621
  A prefix for all the blobs in blob-storage, can be empty.
622
622
 
@@ -626,9 +626,9 @@ A prefix for all the blobs in blob-storage, can be empty.
626
626
 
627
627
  ***
628
628
 
629
- ### awsS3Region?
629
+ ### awsS3Region? {#awss3region}
630
630
 
631
- > `optional` **awsS3Region**: `string`
631
+ > `optional` **awsS3Region?**: `string`
632
632
 
633
633
  AWS S3 region.
634
634
 
@@ -638,9 +638,9 @@ AWS S3 region.
638
638
 
639
639
  ***
640
640
 
641
- ### awsS3BucketName?
641
+ ### awsS3BucketName? {#awss3bucketname}
642
642
 
643
- > `optional` **awsS3BucketName**: `string`
643
+ > `optional` **awsS3BucketName?**: `string`
644
644
 
645
645
  AWS S3 bucket name.
646
646
 
@@ -650,9 +650,9 @@ AWS S3 bucket name.
650
650
 
651
651
  ***
652
652
 
653
- ### awsS3AuthMode?
653
+ ### awsS3AuthMode? {#awss3authmode}
654
654
 
655
- > `optional` **awsS3AuthMode**: `string`
655
+ > `optional` **awsS3AuthMode?**: `string`
656
656
 
657
657
  AWS S3 auth mode, either credentials or pod, defaults to credentials.
658
658
 
@@ -662,9 +662,9 @@ AWS S3 auth mode, either credentials or pod, defaults to credentials.
662
662
 
663
663
  ***
664
664
 
665
- ### awsS3AccessKeyId?
665
+ ### awsS3AccessKeyId? {#awss3accesskeyid}
666
666
 
667
- > `optional` **awsS3AccessKeyId**: `string`
667
+ > `optional` **awsS3AccessKeyId?**: `string`
668
668
 
669
669
  AWS S3 access key id.
670
670
 
@@ -674,9 +674,9 @@ AWS S3 access key id.
674
674
 
675
675
  ***
676
676
 
677
- ### awsS3SecretAccessKey?
677
+ ### awsS3SecretAccessKey? {#awss3secretaccesskey}
678
678
 
679
- > `optional` **awsS3SecretAccessKey**: `string`
679
+ > `optional` **awsS3SecretAccessKey?**: `string`
680
680
 
681
681
  AWS S3 secret access key.
682
682
 
@@ -686,9 +686,9 @@ AWS S3 secret access key.
686
686
 
687
687
  ***
688
688
 
689
- ### awsS3Endpoint?
689
+ ### awsS3Endpoint? {#awss3endpoint}
690
690
 
691
- > `optional` **awsS3Endpoint**: `string`
691
+ > `optional` **awsS3Endpoint?**: `string`
692
692
 
693
693
  AWS S3 endpoint.
694
694
 
@@ -698,9 +698,9 @@ AWS S3 endpoint.
698
698
 
699
699
  ***
700
700
 
701
- ### azureStorageAccountKey?
701
+ ### azureStorageAccountKey? {#azurestorageaccountkey}
702
702
 
703
- > `optional` **azureStorageAccountKey**: `string`
703
+ > `optional` **azureStorageAccountKey?**: `string`
704
704
 
705
705
  Azure Storage account key.
706
706
 
@@ -710,9 +710,9 @@ Azure Storage account key.
710
710
 
711
711
  ***
712
712
 
713
- ### azureStorageAccountName?
713
+ ### azureStorageAccountName? {#azurestorageaccountname}
714
714
 
715
- > `optional` **azureStorageAccountName**: `string`
715
+ > `optional` **azureStorageAccountName?**: `string`
716
716
 
717
717
  Azure Storage account name.
718
718
 
@@ -722,9 +722,9 @@ Azure Storage account name.
722
722
 
723
723
  ***
724
724
 
725
- ### azureStorageContainerName?
725
+ ### azureStorageContainerName? {#azurestoragecontainername}
726
726
 
727
- > `optional` **azureStorageContainerName**: `string`
727
+ > `optional` **azureStorageContainerName?**: `string`
728
728
 
729
729
  Azure Storage container.
730
730
 
@@ -734,9 +734,9 @@ Azure Storage container.
734
734
 
735
735
  ***
736
736
 
737
- ### azureStorageEndpoint?
737
+ ### azureStorageEndpoint? {#azurestorageendpoint}
738
738
 
739
- > `optional` **azureStorageEndpoint**: `string`
739
+ > `optional` **azureStorageEndpoint?**: `string`
740
740
 
741
741
  Azure Storage endpoint.
742
742
 
@@ -746,9 +746,9 @@ Azure Storage endpoint.
746
746
 
747
747
  ***
748
748
 
749
- ### gcpStorageBucketName?
749
+ ### gcpStorageBucketName? {#gcpstoragebucketname}
750
750
 
751
- > `optional` **gcpStorageBucketName**: `string`
751
+ > `optional` **gcpStorageBucketName?**: `string`
752
752
 
753
753
  GCP Storage bucket.
754
754
 
@@ -758,9 +758,9 @@ GCP Storage bucket.
758
758
 
759
759
  ***
760
760
 
761
- ### gcpStorageCredentials?
761
+ ### gcpStorageCredentials? {#gcpstoragecredentials}
762
762
 
763
- > `optional` **gcpStorageCredentials**: `string`
763
+ > `optional` **gcpStorageCredentials?**: `string`
764
764
 
765
765
  GCP Storage credentials.
766
766
 
@@ -770,9 +770,9 @@ GCP Storage credentials.
770
770
 
771
771
  ***
772
772
 
773
- ### gcpStorageEndpoint?
773
+ ### gcpStorageEndpoint? {#gcpstorageendpoint}
774
774
 
775
- > `optional` **gcpStorageEndpoint**: `string`
775
+ > `optional` **gcpStorageEndpoint?**: `string`
776
776
 
777
777
  GCP Storage endpoint.
778
778
 
@@ -782,9 +782,9 @@ GCP Storage endpoint.
782
782
 
783
783
  ***
784
784
 
785
- ### gcpStorageProjectId?
785
+ ### gcpStorageProjectId? {#gcpstorageprojectid}
786
786
 
787
- > `optional` **gcpStorageProjectId**: `string`
787
+ > `optional` **gcpStorageProjectId?**: `string`
788
788
 
789
789
  GCP Storage project id.
790
790
 
@@ -794,9 +794,9 @@ GCP Storage project id.
794
794
 
795
795
  ***
796
796
 
797
- ### vaultConnector?
797
+ ### vaultConnector? {#vaultconnector}
798
798
 
799
- > `optional` **vaultConnector**: `string`
799
+ > `optional` **vaultConnector?**: `string`
800
800
 
801
801
  The type of the default vault connector: entity-storage, hashicorp.
802
802
 
@@ -806,9 +806,9 @@ The type of the default vault connector: entity-storage, hashicorp.
806
806
 
807
807
  ***
808
808
 
809
- ### vaultPrefix?
809
+ ### vaultPrefix? {#vaultprefix}
810
810
 
811
- > `optional` **vaultPrefix**: `string`
811
+ > `optional` **vaultPrefix?**: `string`
812
812
 
813
813
  Prefix to prepend to entries in the vault.
814
814
 
@@ -818,9 +818,9 @@ Prefix to prepend to entries in the vault.
818
818
 
819
819
  ***
820
820
 
821
- ### hashicorpVaultToken?
821
+ ### hashicorpVaultToken? {#hashicorpvaulttoken}
822
822
 
823
- > `optional` **hashicorpVaultToken**: `string`
823
+ > `optional` **hashicorpVaultToken?**: `string`
824
824
 
825
825
  Hashicorp Vault token.
826
826
 
@@ -830,9 +830,9 @@ Hashicorp Vault token.
830
830
 
831
831
  ***
832
832
 
833
- ### hashicorpVaultEndpoint?
833
+ ### hashicorpVaultEndpoint? {#hashicorpvaultendpoint}
834
834
 
835
- > `optional` **hashicorpVaultEndpoint**: `string`
835
+ > `optional` **hashicorpVaultEndpoint?**: `string`
836
836
 
837
837
  Hashicorp Vault endpoint.
838
838
 
@@ -842,9 +842,9 @@ Hashicorp Vault endpoint.
842
842
 
843
843
  ***
844
844
 
845
- ### loggingConnector?
845
+ ### loggingConnector? {#loggingconnector}
846
846
 
847
- > `optional` **loggingConnector**: `string`
847
+ > `optional` **loggingConnector?**: `string`
848
848
 
849
849
  The type of logging task connector, can be a comma separated list: console, entity-storage.
850
850
 
@@ -854,9 +854,9 @@ The type of logging task connector, can be a comma separated list: console, enti
854
854
 
855
855
  ***
856
856
 
857
- ### eventBusConnector?
857
+ ### eventBusConnector? {#eventbusconnector}
858
858
 
859
- > `optional` **eventBusConnector**: `string`
859
+ > `optional` **eventBusConnector?**: `string`
860
860
 
861
861
  The type of event bus connector: local.
862
862
 
@@ -866,9 +866,9 @@ The type of event bus connector: local.
866
866
 
867
867
  ***
868
868
 
869
- ### eventBusComponent?
869
+ ### eventBusComponent? {#eventbuscomponent}
870
870
 
871
- > `optional` **eventBusComponent**: `string`
871
+ > `optional` **eventBusComponent?**: `string`
872
872
 
873
873
  The type of event bus component: service.
874
874
 
@@ -878,9 +878,9 @@ The type of event bus component: service.
878
878
 
879
879
  ***
880
880
 
881
- ### messagingEnabled?
881
+ ### messagingEnabled? {#messagingenabled}
882
882
 
883
- > `optional` **messagingEnabled**: `string`
883
+ > `optional` **messagingEnabled?**: `string`
884
884
 
885
885
  Are the messaging components enabled, defaults to false.
886
886
 
@@ -890,9 +890,9 @@ Are the messaging components enabled, defaults to false.
890
890
 
891
891
  ***
892
892
 
893
- ### awsSesRegion?
893
+ ### awsSesRegion? {#awssesregion}
894
894
 
895
- > `optional` **awsSesRegion**: `string`
895
+ > `optional` **awsSesRegion?**: `string`
896
896
 
897
897
  AWS SES region.
898
898
 
@@ -902,9 +902,9 @@ AWS SES region.
902
902
 
903
903
  ***
904
904
 
905
- ### awsSesAuthMode?
905
+ ### awsSesAuthMode? {#awssesauthmode}
906
906
 
907
- > `optional` **awsSesAuthMode**: `string`
907
+ > `optional` **awsSesAuthMode?**: `string`
908
908
 
909
909
  AWS SES auth mode, either credentials or pod, defaults to credentials.
910
910
 
@@ -914,9 +914,9 @@ AWS SES auth mode, either credentials or pod, defaults to credentials.
914
914
 
915
915
  ***
916
916
 
917
- ### awsSesSecretAccessKey?
917
+ ### awsSesSecretAccessKey? {#awssessecretaccesskey}
918
918
 
919
- > `optional` **awsSesSecretAccessKey**: `string`
919
+ > `optional` **awsSesSecretAccessKey?**: `string`
920
920
 
921
921
  AWS SES secret access key.
922
922
 
@@ -926,9 +926,9 @@ AWS SES secret access key.
926
926
 
927
927
  ***
928
928
 
929
- ### awsSesAccessKeyId?
929
+ ### awsSesAccessKeyId? {#awssesaccesskeyid}
930
930
 
931
- > `optional` **awsSesAccessKeyId**: `string`
931
+ > `optional` **awsSesAccessKeyId?**: `string`
932
932
 
933
933
  AWS SES access key id.
934
934
 
@@ -938,9 +938,9 @@ AWS SES access key id.
938
938
 
939
939
  ***
940
940
 
941
- ### awsSesEndpoint?
941
+ ### awsSesEndpoint? {#awssesendpoint}
942
942
 
943
- > `optional` **awsSesEndpoint**: `string`
943
+ > `optional` **awsSesEndpoint?**: `string`
944
944
 
945
945
  AWS SES endpoint.
946
946
 
@@ -950,9 +950,9 @@ AWS SES endpoint.
950
950
 
951
951
  ***
952
952
 
953
- ### awsMessagingPushNotificationApplications?
953
+ ### awsMessagingPushNotificationApplications? {#awsmessagingpushnotificationapplications}
954
954
 
955
- > `optional` **awsMessagingPushNotificationApplications**: `string`
955
+ > `optional` **awsMessagingPushNotificationApplications?**: `string`
956
956
 
957
957
  The applications for the push notifications reference a separate json with @json: prefix.
958
958
 
@@ -962,9 +962,9 @@ The applications for the push notifications reference a separate json with @json
962
962
 
963
963
  ***
964
964
 
965
- ### messagingEmailConnector?
965
+ ### messagingEmailConnector? {#messagingemailconnector}
966
966
 
967
- > `optional` **messagingEmailConnector**: `string`
967
+ > `optional` **messagingEmailConnector?**: `string`
968
968
 
969
969
  The type of messaging email connector: entity-storage, aws.
970
970
 
@@ -974,9 +974,9 @@ The type of messaging email connector: entity-storage, aws.
974
974
 
975
975
  ***
976
976
 
977
- ### messagingSmsConnector?
977
+ ### messagingSmsConnector? {#messagingsmsconnector}
978
978
 
979
- > `optional` **messagingSmsConnector**: `string`
979
+ > `optional` **messagingSmsConnector?**: `string`
980
980
 
981
981
  The type of messaging sms connector: entity-storage, aws.
982
982
 
@@ -986,9 +986,9 @@ The type of messaging sms connector: entity-storage, aws.
986
986
 
987
987
  ***
988
988
 
989
- ### messagingPushNotificationConnector?
989
+ ### messagingPushNotificationConnector? {#messagingpushnotificationconnector}
990
990
 
991
- > `optional` **messagingPushNotificationConnector**: `string`
991
+ > `optional` **messagingPushNotificationConnector?**: `string`
992
992
 
993
993
  The type of messaging push notification connector: entity-storage, aws.
994
994
 
@@ -998,9 +998,9 @@ The type of messaging push notification connector: entity-storage, aws.
998
998
 
999
999
  ***
1000
1000
 
1001
- ### telemetryConnector?
1001
+ ### telemetryConnector? {#telemetryconnector}
1002
1002
 
1003
- > `optional` **telemetryConnector**: `string`
1003
+ > `optional` **telemetryConnector?**: `string`
1004
1004
 
1005
1005
  The type of telemetry connector: entity-storage.
1006
1006
 
@@ -1010,9 +1010,9 @@ The type of telemetry connector: entity-storage.
1010
1010
 
1011
1011
  ***
1012
1012
 
1013
- ### faucetConnector?
1013
+ ### faucetConnector? {#faucetconnector}
1014
1014
 
1015
- > `optional` **faucetConnector**: `string`
1015
+ > `optional` **faucetConnector?**: `string`
1016
1016
 
1017
1017
  The type of faucet connector: entity-storage, iota.
1018
1018
 
@@ -1022,9 +1022,9 @@ The type of faucet connector: entity-storage, iota.
1022
1022
 
1023
1023
  ***
1024
1024
 
1025
- ### walletConnector?
1025
+ ### walletConnector? {#walletconnector}
1026
1026
 
1027
- > `optional` **walletConnector**: `string`
1027
+ > `optional` **walletConnector?**: `string`
1028
1028
 
1029
1029
  The type of wallet connector: entity-storage, iota.
1030
1030
 
@@ -1034,9 +1034,9 @@ The type of wallet connector: entity-storage, iota.
1034
1034
 
1035
1035
  ***
1036
1036
 
1037
- ### nftConnector?
1037
+ ### nftConnector? {#nftconnector}
1038
1038
 
1039
- > `optional` **nftConnector**: `string`
1039
+ > `optional` **nftConnector?**: `string`
1040
1040
 
1041
1041
  The type of NFT connector: entity-storage, iota.
1042
1042
 
@@ -1046,9 +1046,9 @@ The type of NFT connector: entity-storage, iota.
1046
1046
 
1047
1047
  ***
1048
1048
 
1049
- ### identityConnector?
1049
+ ### identityConnector? {#identityconnector}
1050
1050
 
1051
- > `optional` **identityConnector**: `string`
1051
+ > `optional` **identityConnector?**: `string`
1052
1052
 
1053
1053
  The type of identity connector: entity-storage, iota.
1054
1054
 
@@ -1058,9 +1058,9 @@ The type of identity connector: entity-storage, iota.
1058
1058
 
1059
1059
  ***
1060
1060
 
1061
- ### identityWalletAddressIndex?
1061
+ ### identityWalletAddressIndex? {#identitywalletaddressindex}
1062
1062
 
1063
- > `optional` **identityWalletAddressIndex**: `string`
1063
+ > `optional` **identityWalletAddressIndex?**: `string`
1064
1064
 
1065
1065
  The index of the wallet address to use, defaults to 0.
1066
1066
 
@@ -1070,9 +1070,9 @@ The index of the wallet address to use, defaults to 0.
1070
1070
 
1071
1071
  ***
1072
1072
 
1073
- ### identityResolverConnector?
1073
+ ### identityResolverConnector? {#identityresolverconnector}
1074
1074
 
1075
- > `optional` **identityResolverConnector**: `string`
1075
+ > `optional` **identityResolverConnector?**: `string`
1076
1076
 
1077
1077
  The type of identity resolver connector: entity-storage, iota.
1078
1078
 
@@ -1082,9 +1082,9 @@ The type of identity resolver connector: entity-storage, iota.
1082
1082
 
1083
1083
  ***
1084
1084
 
1085
- ### verifiableStorageConnector?
1085
+ ### verifiableStorageConnector? {#verifiablestorageconnector}
1086
1086
 
1087
- > `optional` **verifiableStorageConnector**: `string`
1087
+ > `optional` **verifiableStorageConnector?**: `string`
1088
1088
 
1089
1089
  The type of verifiable storage connector: entity-storage, iota.
1090
1090
 
@@ -1094,9 +1094,9 @@ The type of verifiable storage connector: entity-storage, iota.
1094
1094
 
1095
1095
  ***
1096
1096
 
1097
- ### iotaFaucetEndpoint?
1097
+ ### iotaFaucetEndpoint? {#iotafaucetendpoint}
1098
1098
 
1099
- > `optional` **iotaFaucetEndpoint**: `string`
1099
+ > `optional` **iotaFaucetEndpoint?**: `string`
1100
1100
 
1101
1101
  IOTA Faucet Endpoint.
1102
1102
 
@@ -1106,9 +1106,9 @@ IOTA Faucet Endpoint.
1106
1106
 
1107
1107
  ***
1108
1108
 
1109
- ### iotaNodeEndpoint?
1109
+ ### iotaNodeEndpoint? {#iotanodeendpoint}
1110
1110
 
1111
- > `optional` **iotaNodeEndpoint**: `string`
1111
+ > `optional` **iotaNodeEndpoint?**: `string`
1112
1112
 
1113
1113
  IOTA Node Endpoint.
1114
1114
 
@@ -1118,9 +1118,9 @@ IOTA Node Endpoint.
1118
1118
 
1119
1119
  ***
1120
1120
 
1121
- ### iotaNetwork?
1121
+ ### iotaNetwork? {#iotanetwork}
1122
1122
 
1123
- > `optional` **iotaNetwork**: `string`
1123
+ > `optional` **iotaNetwork?**: `string`
1124
1124
 
1125
1125
  IOTA network.
1126
1126
 
@@ -1130,9 +1130,9 @@ IOTA network.
1130
1130
 
1131
1131
  ***
1132
1132
 
1133
- ### iotaCoinType?
1133
+ ### iotaCoinType? {#iotacointype}
1134
1134
 
1135
- > `optional` **iotaCoinType**: `string`
1135
+ > `optional` **iotaCoinType?**: `string`
1136
1136
 
1137
1137
  IOTA coin type.
1138
1138
 
@@ -1142,9 +1142,9 @@ IOTA coin type.
1142
1142
 
1143
1143
  ***
1144
1144
 
1145
- ### iotaExplorerEndpoint?
1145
+ ### iotaExplorerEndpoint? {#iotaexplorerendpoint}
1146
1146
 
1147
- > `optional` **iotaExplorerEndpoint**: `string`
1147
+ > `optional` **iotaExplorerEndpoint?**: `string`
1148
1148
 
1149
1149
  IOTA Explorer Endpoint.
1150
1150
 
@@ -1154,9 +1154,9 @@ IOTA Explorer Endpoint.
1154
1154
 
1155
1155
  ***
1156
1156
 
1157
- ### iotaGasStationEndpoint?
1157
+ ### iotaGasStationEndpoint? {#iotagasstationendpoint}
1158
1158
 
1159
- > `optional` **iotaGasStationEndpoint**: `string`
1159
+ > `optional` **iotaGasStationEndpoint?**: `string`
1160
1160
 
1161
1161
  IOTA Gas Station Endpoint.
1162
1162
 
@@ -1166,9 +1166,9 @@ IOTA Gas Station Endpoint.
1166
1166
 
1167
1167
  ***
1168
1168
 
1169
- ### iotaGasStationAuthToken?
1169
+ ### iotaGasStationAuthToken? {#iotagasstationauthtoken}
1170
1170
 
1171
- > `optional` **iotaGasStationAuthToken**: `string`
1171
+ > `optional` **iotaGasStationAuthToken?**: `string`
1172
1172
 
1173
1173
  IOTA Gas Station Authentication Token.
1174
1174
 
@@ -1178,9 +1178,9 @@ IOTA Gas Station Authentication Token.
1178
1178
 
1179
1179
  ***
1180
1180
 
1181
- ### universalResolverEndpoint?
1181
+ ### universalResolverEndpoint? {#universalresolverendpoint}
1182
1182
 
1183
- > `optional` **universalResolverEndpoint**: `string`
1183
+ > `optional` **universalResolverEndpoint?**: `string`
1184
1184
 
1185
1185
  Universal Resolver Endpoint.
1186
1186
 
@@ -1190,9 +1190,9 @@ Universal Resolver Endpoint.
1190
1190
 
1191
1191
  ***
1192
1192
 
1193
- ### identityProfileConnector?
1193
+ ### identityProfileConnector? {#identityprofileconnector}
1194
1194
 
1195
- > `optional` **identityProfileConnector**: `string`
1195
+ > `optional` **identityProfileConnector?**: `string`
1196
1196
 
1197
1197
  The type of identity profile connector: entity-storage.
1198
1198
 
@@ -1202,9 +1202,9 @@ The type of identity profile connector: entity-storage.
1202
1202
 
1203
1203
  ***
1204
1204
 
1205
- ### immutableProofVerificationMethodId?
1205
+ ### immutableProofVerificationMethodId? {#immutableproofverificationmethodid}
1206
1206
 
1207
- > `optional` **immutableProofVerificationMethodId**: `string`
1207
+ > `optional` **immutableProofVerificationMethodId?**: `string`
1208
1208
 
1209
1209
  The identity verification method id to use with immutable proofs.
1210
1210
 
@@ -1214,9 +1214,9 @@ The identity verification method id to use with immutable proofs.
1214
1214
 
1215
1215
  ***
1216
1216
 
1217
- ### attestationConnector?
1217
+ ### attestationConnector? {#attestationconnector}
1218
1218
 
1219
- > `optional` **attestationConnector**: `string`
1219
+ > `optional` **attestationConnector?**: `string`
1220
1220
 
1221
1221
  The type of attestation connector: entity-storage, iota.
1222
1222
 
@@ -1226,9 +1226,9 @@ The type of attestation connector: entity-storage, iota.
1226
1226
 
1227
1227
  ***
1228
1228
 
1229
- ### attestationVerificationMethodId?
1229
+ ### attestationVerificationMethodId? {#attestationverificationmethodid}
1230
1230
 
1231
- > `optional` **attestationVerificationMethodId**: `string`
1231
+ > `optional` **attestationVerificationMethodId?**: `string`
1232
1232
 
1233
1233
  The identity verification method id to use with attestation.
1234
1234
 
@@ -1238,9 +1238,9 @@ The identity verification method id to use with attestation.
1238
1238
 
1239
1239
  ***
1240
1240
 
1241
- ### dataProcessingEnabled?
1241
+ ### dataProcessingEnabled? {#dataprocessingenabled}
1242
1242
 
1243
- > `optional` **dataProcessingEnabled**: `string`
1243
+ > `optional` **dataProcessingEnabled?**: `string`
1244
1244
 
1245
1245
  Is the data processing enabled, defaults to false.
1246
1246
 
@@ -1250,9 +1250,9 @@ Is the data processing enabled, defaults to false.
1250
1250
 
1251
1251
  ***
1252
1252
 
1253
- ### dataConverterConnectors?
1253
+ ### dataConverterConnectors? {#dataconverterconnectors}
1254
1254
 
1255
- > `optional` **dataConverterConnectors**: `string`
1255
+ > `optional` **dataConverterConnectors?**: `string`
1256
1256
 
1257
1257
  The type of the default data converters, can be a comma separated list: json, xml.
1258
1258
 
@@ -1262,9 +1262,9 @@ The type of the default data converters, can be a comma separated list: json, xm
1262
1262
 
1263
1263
  ***
1264
1264
 
1265
- ### dataExtractorConnectors?
1265
+ ### dataExtractorConnectors? {#dataextractorconnectors}
1266
1266
 
1267
- > `optional` **dataExtractorConnectors**: `string`
1267
+ > `optional` **dataExtractorConnectors?**: `string`
1268
1268
 
1269
1269
  The type of the default data extractor, can be a comma separated list: json-path.
1270
1270
 
@@ -1274,9 +1274,9 @@ The type of the default data extractor, can be a comma separated list: json-path
1274
1274
 
1275
1275
  ***
1276
1276
 
1277
- ### auditableItemGraphEnabled?
1277
+ ### auditableItemGraphEnabled? {#auditableitemgraphenabled}
1278
1278
 
1279
- > `optional` **auditableItemGraphEnabled**: `string`
1279
+ > `optional` **auditableItemGraphEnabled?**: `string`
1280
1280
 
1281
1281
  Is the auditable item graph enabled, defaults to false.
1282
1282
 
@@ -1286,9 +1286,9 @@ Is the auditable item graph enabled, defaults to false.
1286
1286
 
1287
1287
  ***
1288
1288
 
1289
- ### auditableItemStreamEnabled?
1289
+ ### auditableItemStreamEnabled? {#auditableitemstreamenabled}
1290
1290
 
1291
- > `optional` **auditableItemStreamEnabled**: `string`
1291
+ > `optional` **auditableItemStreamEnabled?**: `string`
1292
1292
 
1293
1293
  Is the auditable item stream enabled, defaults to false.
1294
1294
 
@@ -1298,9 +1298,9 @@ Is the auditable item stream enabled, defaults to false.
1298
1298
 
1299
1299
  ***
1300
1300
 
1301
- ### documentManagementEnabled?
1301
+ ### documentManagementEnabled? {#documentmanagementenabled}
1302
1302
 
1303
- > `optional` **documentManagementEnabled**: `string`
1303
+ > `optional` **documentManagementEnabled?**: `string`
1304
1304
 
1305
1305
  Is the document management enabled, defaults to false.
1306
1306
 
@@ -1310,9 +1310,9 @@ Is the document management enabled, defaults to false.
1310
1310
 
1311
1311
  ***
1312
1312
 
1313
- ### synchronisedStorageEnabled?
1313
+ ### synchronisedStorageEnabled? {#synchronisedstorageenabled}
1314
1314
 
1315
- > `optional` **synchronisedStorageEnabled**: `string`
1315
+ > `optional` **synchronisedStorageEnabled?**: `string`
1316
1316
 
1317
1317
  Is the synchronised storage enabled, defaults to false.
1318
1318
 
@@ -1322,9 +1322,9 @@ Is the synchronised storage enabled, defaults to false.
1322
1322
 
1323
1323
  ***
1324
1324
 
1325
- ### synchronisedStorageTrustedUrl?
1325
+ ### synchronisedStorageTrustedUrl? {#synchronisedstoragetrustedurl}
1326
1326
 
1327
- > `optional` **synchronisedStorageTrustedUrl**: `string`
1327
+ > `optional` **synchronisedStorageTrustedUrl?**: `string`
1328
1328
 
1329
1329
  Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
1330
1330
 
@@ -1334,9 +1334,9 @@ Url which points to the api for a trusted synchronised storage node, not require
1334
1334
 
1335
1335
  ***
1336
1336
 
1337
- ### synchronisedStorageVerifiableStorageKeyId?
1337
+ ### synchronisedStorageVerifiableStorageKeyId? {#synchronisedstorageverifiablestoragekeyid}
1338
1338
 
1339
- > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
1339
+ > `optional` **synchronisedStorageVerifiableStorageKeyId?**: `string`
1340
1340
 
1341
1341
  The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
1342
1342
  This only required if using a custom verifiable storage item, otherwise it will default to the network name.
@@ -1347,9 +1347,9 @@ This only required if using a custom verifiable storage item, otherwise it will
1347
1347
 
1348
1348
  ***
1349
1349
 
1350
- ### synchronisedStorageBlobStorageEncryptionKeyId?
1350
+ ### synchronisedStorageBlobStorageEncryptionKeyId? {#synchronisedstorageblobstorageencryptionkeyid}
1351
1351
 
1352
- > `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
1352
+ > `optional` **synchronisedStorageBlobStorageEncryptionKeyId?**: `string`
1353
1353
 
1354
1354
  The key from the vault which is used to encrypt the synchronised storage blobs.
1355
1355
  Only required for trusted nodes, as regular nodes will request from the trusted nodes.
@@ -1361,9 +1361,9 @@ Defaults to synchronised-storage-blob-encryption
1361
1361
 
1362
1362
  ***
1363
1363
 
1364
- ### synchronisedStorageBlobStorageKey?
1364
+ ### synchronisedStorageBlobStorageKey? {#synchronisedstorageblobstoragekey}
1365
1365
 
1366
- > `optional` **synchronisedStorageBlobStorageKey**: `string`
1366
+ > `optional` **synchronisedStorageBlobStorageKey?**: `string`
1367
1367
 
1368
1368
  The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
1369
1369
  Only required for trusted nodes, as regular nodes will not write encrypted data.
@@ -1374,57 +1374,81 @@ Only required for trusted nodes, as regular nodes will not write encrypted data.
1374
1374
 
1375
1375
  ***
1376
1376
 
1377
- ### synchronisedStorageEntityUpdateIntervalMinutes?
1377
+ ### synchronisedStorageEntityUpdateIntervalMinutes? {#synchronisedstorageentityupdateintervalminutes}
1378
1378
 
1379
- > `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
1379
+ > `optional` **synchronisedStorageEntityUpdateIntervalMinutes?**: `string`
1380
1380
 
1381
1381
  How often to check for entity updates in minutes.
1382
1382
 
1383
+ #### Default
1384
+
1385
+ ```ts
1386
+ 5
1387
+ ```
1388
+
1383
1389
  #### Inherited from
1384
1390
 
1385
1391
  [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
1386
1392
 
1387
1393
  ***
1388
1394
 
1389
- ### synchronisedStorageConsolidationIntervalMinutes?
1395
+ ### synchronisedStorageConsolidationIntervalMinutes? {#synchronisedstorageconsolidationintervalminutes}
1390
1396
 
1391
- > `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
1397
+ > `optional` **synchronisedStorageConsolidationIntervalMinutes?**: `string`
1392
1398
 
1393
1399
  Interval to perform consolidation of changesets, only used if this is a trusted node.
1394
1400
 
1401
+ #### Default
1402
+
1403
+ ```ts
1404
+ 60
1405
+ ```
1406
+
1395
1407
  #### Inherited from
1396
1408
 
1397
1409
  [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
1398
1410
 
1399
1411
  ***
1400
1412
 
1401
- ### synchronisedStorageConsolidationBatchSize?
1413
+ ### synchronisedStorageConsolidationBatchSize? {#synchronisedstorageconsolidationbatchsize}
1402
1414
 
1403
- > `optional` **synchronisedStorageConsolidationBatchSize**: `string`
1415
+ > `optional` **synchronisedStorageConsolidationBatchSize?**: `string`
1404
1416
 
1405
1417
  The number of entities to process in a single consolidation batch, only used if this is a trusted node.
1406
1418
 
1419
+ #### Default
1420
+
1421
+ ```ts
1422
+ 1000
1423
+ ```
1424
+
1407
1425
  #### Inherited from
1408
1426
 
1409
1427
  [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
1410
1428
 
1411
1429
  ***
1412
1430
 
1413
- ### synchronisedStorageMaxConsolidations?
1431
+ ### synchronisedStorageMaxConsolidations? {#synchronisedstoragemaxconsolidations}
1414
1432
 
1415
- > `optional` **synchronisedStorageMaxConsolidations**: `string`
1433
+ > `optional` **synchronisedStorageMaxConsolidations?**: `string`
1416
1434
 
1417
1435
  The maximum number of consolidations to keep in storage, only used if this is a trusted node.
1418
1436
 
1437
+ #### Default
1438
+
1439
+ ```ts
1440
+ 5
1441
+ ```
1442
+
1419
1443
  #### Inherited from
1420
1444
 
1421
1445
  [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
1422
1446
 
1423
1447
  ***
1424
1448
 
1425
- ### federatedCatalogueEnabled?
1449
+ ### federatedCatalogueEnabled? {#federatedcatalogueenabled}
1426
1450
 
1427
- > `optional` **federatedCatalogueEnabled**: `string`
1451
+ > `optional` **federatedCatalogueEnabled?**: `string`
1428
1452
 
1429
1453
  Is the federated catalogue enabled, defaults to false.
1430
1454
 
@@ -1434,9 +1458,9 @@ Is the federated catalogue enabled, defaults to false.
1434
1458
 
1435
1459
  ***
1436
1460
 
1437
- ### federatedCatalogueFilters?
1461
+ ### federatedCatalogueFilters? {#federatedcataloguefilters}
1438
1462
 
1439
- > `optional` **federatedCatalogueFilters**: `string`
1463
+ > `optional` **federatedCatalogueFilters?**: `string`
1440
1464
 
1441
1465
  Federated catalog filters, command separated list of filters to add.
1442
1466
 
@@ -1446,9 +1470,9 @@ Federated catalog filters, command separated list of filters to add.
1446
1470
 
1447
1471
  ***
1448
1472
 
1449
- ### trustEnabled?
1473
+ ### trustEnabled? {#trustenabled}
1450
1474
 
1451
- > `optional` **trustEnabled**: `string`
1475
+ > `optional` **trustEnabled?**: `string`
1452
1476
 
1453
1477
  Is the trust management enabled, defaults to false.
1454
1478
 
@@ -1458,9 +1482,9 @@ Is the trust management enabled, defaults to false.
1458
1482
 
1459
1483
  ***
1460
1484
 
1461
- ### trustGenerators?
1485
+ ### trustGenerators? {#trustgenerators}
1462
1486
 
1463
- > `optional` **trustGenerators**: `string`
1487
+ > `optional` **trustGenerators?**: `string`
1464
1488
 
1465
1489
  The trust generators to add to the factory, comma separated list.
1466
1490
 
@@ -1470,9 +1494,9 @@ The trust generators to add to the factory, comma separated list.
1470
1494
 
1471
1495
  ***
1472
1496
 
1473
- ### trustVerifiers?
1497
+ ### trustVerifiers? {#trustverifiers}
1474
1498
 
1475
- > `optional` **trustVerifiers**: `string`
1499
+ > `optional` **trustVerifiers?**: `string`
1476
1500
 
1477
1501
  The trust verifiers to add to the factory, comma separated list.
1478
1502
 
@@ -1482,9 +1506,9 @@ The trust verifiers to add to the factory, comma separated list.
1482
1506
 
1483
1507
  ***
1484
1508
 
1485
- ### trustVerificationMethodId?
1509
+ ### trustVerificationMethodId? {#trustverificationmethodid}
1486
1510
 
1487
- > `optional` **trustVerificationMethodId**: `string`
1511
+ > `optional` **trustVerificationMethodId?**: `string`
1488
1512
 
1489
1513
  The verification method to use for trust identities.
1490
1514
  Defaults to trust-assertion.
@@ -1495,9 +1519,9 @@ Defaults to trust-assertion.
1495
1519
 
1496
1520
  ***
1497
1521
 
1498
- ### trustJwtTtlSeconds?
1522
+ ### trustJwtTtlSeconds? {#trustjwtttlseconds}
1499
1523
 
1500
- > `optional` **trustJwtTtlSeconds**: `string`
1524
+ > `optional` **trustJwtTtlSeconds?**: `string`
1501
1525
 
1502
1526
  The trust time to live for generating JWTs.
1503
1527
  Defaults to undefined for never expiring.
@@ -1508,9 +1532,9 @@ Defaults to undefined for never expiring.
1508
1532
 
1509
1533
  ***
1510
1534
 
1511
- ### rightsManagementEnabled?
1535
+ ### rightsManagementEnabled? {#rightsmanagementenabled}
1512
1536
 
1513
- > `optional` **rightsManagementEnabled**: `string`
1537
+ > `optional` **rightsManagementEnabled?**: `string`
1514
1538
 
1515
1539
  Is the rights management enabled, defaults to false.
1516
1540
 
@@ -1520,9 +1544,9 @@ Is the rights management enabled, defaults to false.
1520
1544
 
1521
1545
  ***
1522
1546
 
1523
- ### rightsManagementCallbackPath?
1547
+ ### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
1524
1548
 
1525
- > `optional` **rightsManagementCallbackPath**: `string`
1549
+ > `optional` **rightsManagementCallbackPath?**: `string`
1526
1550
 
1527
1551
  What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
1528
1552
 
@@ -1532,9 +1556,9 @@ What is the callback path for rights management negotiations, will be combined w
1532
1556
 
1533
1557
  ***
1534
1558
 
1535
- ### rightsManagementPolicyInformationSources?
1559
+ ### rightsManagementPolicyInformationSources? {#rightsmanagementpolicyinformationsources}
1536
1560
 
1537
- > `optional` **rightsManagementPolicyInformationSources**: `string`
1561
+ > `optional` **rightsManagementPolicyInformationSources?**: `string`
1538
1562
 
1539
1563
  The rights management policy information sources to add to the factory.
1540
1564
 
@@ -1544,9 +1568,9 @@ The rights management policy information sources to add to the factory.
1544
1568
 
1545
1569
  ***
1546
1570
 
1547
- ### rightsManagementPolicyNegotiators?
1571
+ ### rightsManagementPolicyNegotiators? {#rightsmanagementpolicynegotiators}
1548
1572
 
1549
- > `optional` **rightsManagementPolicyNegotiators**: `string`
1573
+ > `optional` **rightsManagementPolicyNegotiators?**: `string`
1550
1574
 
1551
1575
  The rights management policy negotiators sources to add to the factory.
1552
1576
 
@@ -1556,9 +1580,9 @@ The rights management policy negotiators sources to add to the factory.
1556
1580
 
1557
1581
  ***
1558
1582
 
1559
- ### rightsManagementPolicyRequesters?
1583
+ ### rightsManagementPolicyRequesters? {#rightsmanagementpolicyrequesters}
1560
1584
 
1561
- > `optional` **rightsManagementPolicyRequesters**: `string`
1585
+ > `optional` **rightsManagementPolicyRequesters?**: `string`
1562
1586
 
1563
1587
  The rights management policy requesters to add to the factory.
1564
1588
 
@@ -1568,9 +1592,9 @@ The rights management policy requesters to add to the factory.
1568
1592
 
1569
1593
  ***
1570
1594
 
1571
- ### rightsManagementPolicyExecutionActions?
1595
+ ### rightsManagementPolicyExecutionActions? {#rightsmanagementpolicyexecutionactions}
1572
1596
 
1573
- > `optional` **rightsManagementPolicyExecutionActions**: `string`
1597
+ > `optional` **rightsManagementPolicyExecutionActions?**: `string`
1574
1598
 
1575
1599
  The rights management policy execution actions to add to the factory.
1576
1600
 
@@ -1580,9 +1604,9 @@ The rights management policy execution actions to add to the factory.
1580
1604
 
1581
1605
  ***
1582
1606
 
1583
- ### rightsManagementPolicyEnforcementProcessors?
1607
+ ### rightsManagementPolicyEnforcementProcessors? {#rightsmanagementpolicyenforcementprocessors}
1584
1608
 
1585
- > `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
1609
+ > `optional` **rightsManagementPolicyEnforcementProcessors?**: `string`
1586
1610
 
1587
1611
  The rights management policy enforcement processors to add to the factory.
1588
1612
 
@@ -1592,9 +1616,9 @@ The rights management policy enforcement processors to add to the factory.
1592
1616
 
1593
1617
  ***
1594
1618
 
1595
- ### rightsManagementPolicyArbiters?
1619
+ ### rightsManagementPolicyArbiters? {#rightsmanagementpolicyarbiters}
1596
1620
 
1597
- > `optional` **rightsManagementPolicyArbiters**: `string`
1621
+ > `optional` **rightsManagementPolicyArbiters?**: `string`
1598
1622
 
1599
1623
  The rights management policy arbiters to add to the factory.
1600
1624
 
@@ -1604,9 +1628,9 @@ The rights management policy arbiters to add to the factory.
1604
1628
 
1605
1629
  ***
1606
1630
 
1607
- ### rightsManagementPolicyObligationEnforcers?
1631
+ ### rightsManagementPolicyObligationEnforcers? {#rightsmanagementpolicyobligationenforcers}
1608
1632
 
1609
- > `optional` **rightsManagementPolicyObligationEnforcers**: `string`
1633
+ > `optional` **rightsManagementPolicyObligationEnforcers?**: `string`
1610
1634
 
1611
1635
  The rights management policy obligation enforcers to add to the factory.
1612
1636
 
@@ -1616,9 +1640,9 @@ The rights management policy obligation enforcers to add to the factory.
1616
1640
 
1617
1641
  ***
1618
1642
 
1619
- ### backgroundTasksEnabled?
1643
+ ### backgroundTasksEnabled? {#backgroundtasksenabled}
1620
1644
 
1621
- > `optional` **backgroundTasksEnabled**: `string`
1645
+ > `optional` **backgroundTasksEnabled?**: `string`
1622
1646
 
1623
1647
  Are background tasks enabled, defaults to false.
1624
1648
 
@@ -1628,9 +1652,9 @@ Are background tasks enabled, defaults to false.
1628
1652
 
1629
1653
  ***
1630
1654
 
1631
- ### taskSchedulerEnabled?
1655
+ ### taskSchedulerEnabled? {#taskschedulerenabled}
1632
1656
 
1633
- > `optional` **taskSchedulerEnabled**: `string`
1657
+ > `optional` **taskSchedulerEnabled?**: `string`
1634
1658
 
1635
1659
  Is the task scheduler enabled, defaults to false.
1636
1660
 
@@ -1640,9 +1664,9 @@ Is the task scheduler enabled, defaults to false.
1640
1664
 
1641
1665
  ***
1642
1666
 
1643
- ### dataspaceEnabled?
1667
+ ### dataspaceEnabled? {#dataspaceenabled}
1644
1668
 
1645
- > `optional` **dataspaceEnabled**: `string`
1669
+ > `optional` **dataspaceEnabled?**: `string`
1646
1670
 
1647
1671
  Is the dataspace enabled, defaults to false.
1648
1672
 
@@ -1652,33 +1676,45 @@ Is the dataspace enabled, defaults to false.
1652
1676
 
1653
1677
  ***
1654
1678
 
1655
- ### dataspaceRetainActivityLogsFor?
1679
+ ### dataspaceRetainActivityLogsFor? {#dataspaceretainactivitylogsfor}
1656
1680
 
1657
- > `optional` **dataspaceRetainActivityLogsFor**: `string`
1681
+ > `optional` **dataspaceRetainActivityLogsFor?**: `string`
1658
1682
 
1659
1683
  The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1660
1684
 
1685
+ #### Default
1686
+
1687
+ ```ts
1688
+ 10
1689
+ ```
1690
+
1661
1691
  #### Inherited from
1662
1692
 
1663
1693
  [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceretainactivitylogsfor)
1664
1694
 
1665
1695
  ***
1666
1696
 
1667
- ### dataspaceActivityLogsCleanUpInterval?
1697
+ ### dataspaceActivityLogsCleanUpInterval? {#dataspaceactivitylogscleanupinterval}
1668
1698
 
1669
- > `optional` **dataspaceActivityLogsCleanUpInterval**: `string`
1699
+ > `optional` **dataspaceActivityLogsCleanUpInterval?**: `string`
1670
1700
 
1671
1701
  The interval for cleaning up the activity logs.
1672
1702
 
1703
+ #### Default
1704
+
1705
+ ```ts
1706
+ 60
1707
+ ```
1708
+
1673
1709
  #### Inherited from
1674
1710
 
1675
1711
  [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceactivitylogscleanupinterval)
1676
1712
 
1677
1713
  ***
1678
1714
 
1679
- ### dataspaceDataPlanePath?
1715
+ ### dataspaceDataPlanePath? {#dataspacedataplanepath}
1680
1716
 
1681
- > `optional` **dataspaceDataPlanePath**: `string`
1717
+ > `optional` **dataspaceDataPlanePath?**: `string`
1682
1718
 
1683
1719
  The data plane path for PULL transfers (path only, not full URL).
1684
1720
  Will be combined with public origin from hosting component.
@@ -1691,9 +1727,9 @@ Example: "dataspace/entities"
1691
1727
 
1692
1728
  ***
1693
1729
 
1694
- ### extensions?
1730
+ ### extensions? {#extensions}
1695
1731
 
1696
- > `optional` **extensions**: `string`
1732
+ > `optional` **extensions?**: `string`
1697
1733
 
1698
1734
  A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
1699
1735
 
@@ -1703,112 +1739,112 @@ A comma separated list of additional node extensions to load, the initialiseExte
1703
1739
 
1704
1740
  ***
1705
1741
 
1706
- ### port?
1742
+ ### port? {#port}
1707
1743
 
1708
- > `optional` **port**: `string`
1744
+ > `optional` **port?**: `string`
1709
1745
 
1710
1746
  The port to serve the API from.
1711
1747
 
1712
1748
  ***
1713
1749
 
1714
- ### host?
1750
+ ### host? {#host}
1715
1751
 
1716
- > `optional` **host**: `string`
1752
+ > `optional` **host?**: `string`
1717
1753
 
1718
1754
  The host to serve the API from.
1719
1755
 
1720
1756
  ***
1721
1757
 
1722
- ### corsOrigins?
1758
+ ### corsOrigins? {#corsorigins}
1723
1759
 
1724
- > `optional` **corsOrigins**: `string`
1760
+ > `optional` **corsOrigins?**: `string`
1725
1761
 
1726
1762
  The CORS origins to allow, defaults to *.
1727
1763
 
1728
1764
  ***
1729
1765
 
1730
- ### httpMethods?
1766
+ ### httpMethods? {#httpmethods}
1731
1767
 
1732
- > `optional` **httpMethods**: `string`
1768
+ > `optional` **httpMethods?**: `string`
1733
1769
 
1734
1770
  The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
1735
1771
 
1736
1772
  ***
1737
1773
 
1738
- ### httpAllowedHeaders?
1774
+ ### httpAllowedHeaders? {#httpallowedheaders}
1739
1775
 
1740
- > `optional` **httpAllowedHeaders**: `string`
1776
+ > `optional` **httpAllowedHeaders?**: `string`
1741
1777
 
1742
1778
  The CORS headers to allow.
1743
1779
 
1744
1780
  ***
1745
1781
 
1746
- ### httpExposedHeaders?
1782
+ ### httpExposedHeaders? {#httpexposedheaders}
1747
1783
 
1748
- > `optional` **httpExposedHeaders**: `string`
1784
+ > `optional` **httpExposedHeaders?**: `string`
1749
1785
 
1750
1786
  The CORS headers to expose.
1751
1787
 
1752
1788
  ***
1753
1789
 
1754
- ### publicOrigin?
1790
+ ### publicOrigin? {#publicorigin}
1755
1791
 
1756
- > `optional` **publicOrigin**: `string`
1792
+ > `optional` **publicOrigin?**: `string`
1757
1793
 
1758
1794
  The public origin URL for the API e.g. https://api.example.com:1234
1759
1795
 
1760
1796
  ***
1761
1797
 
1762
- ### authAdminProcessorType?
1798
+ ### authAdminProcessorType? {#authadminprocessortype}
1763
1799
 
1764
- > `optional` **authAdminProcessorType**: `string`
1800
+ > `optional` **authAdminProcessorType?**: `string`
1765
1801
 
1766
1802
  The type of auth admin processor to use on the API: entity-storage.
1767
1803
 
1768
1804
  ***
1769
1805
 
1770
- ### authProcessorType?
1806
+ ### authProcessorType? {#authprocessortype}
1771
1807
 
1772
- > `optional` **authProcessorType**: `string`
1808
+ > `optional` **authProcessorType?**: `string`
1773
1809
 
1774
1810
  The type of auth processor to use on the API: entity-storage.
1775
1811
 
1776
1812
  ***
1777
1813
 
1778
- ### authSigningKeyId?
1814
+ ### authSigningKeyId? {#authsigningkeyid}
1779
1815
 
1780
- > `optional` **authSigningKeyId**: `string`
1816
+ > `optional` **authSigningKeyId?**: `string`
1781
1817
 
1782
1818
  The id of the key in the vault to use for signing in auth operations.
1783
1819
 
1784
1820
  ***
1785
1821
 
1786
- ### mimeTypeProcessors?
1822
+ ### mimeTypeProcessors? {#mimetypeprocessors}
1787
1823
 
1788
- > `optional` **mimeTypeProcessors**: `string`
1824
+ > `optional` **mimeTypeProcessors?**: `string`
1789
1825
 
1790
1826
  Additional MIME type processors to include, comma separated.
1791
1827
 
1792
1828
  ***
1793
1829
 
1794
- ### routeLoggingIncludeBody?
1830
+ ### routeLoggingIncludeBody? {#routeloggingincludebody}
1795
1831
 
1796
- > `optional` **routeLoggingIncludeBody**: `string`
1832
+ > `optional` **routeLoggingIncludeBody?**: `string`
1797
1833
 
1798
1834
  Include the body in the REST logging output, useful for debugging.
1799
1835
 
1800
1836
  ***
1801
1837
 
1802
- ### routeLoggingFullBase64?
1838
+ ### routeLoggingFullBase64? {#routeloggingfullbase64}
1803
1839
 
1804
- > `optional` **routeLoggingFullBase64**: `string`
1840
+ > `optional` **routeLoggingFullBase64?**: `string`
1805
1841
 
1806
1842
  Include the full base 64 output in the REST logging output, useful for debugging.
1807
1843
 
1808
1844
  ***
1809
1845
 
1810
- ### routeLoggingObfuscateProperties?
1846
+ ### routeLoggingObfuscateProperties? {#routeloggingobfuscateproperties}
1811
1847
 
1812
- > `optional` **routeLoggingObfuscateProperties**: `string`
1848
+ > `optional` **routeLoggingObfuscateProperties?**: `string`
1813
1849
 
1814
1850
  List of properties to obfuscate in the REST logging output, comma separated.