@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.
@@ -8,9 +8,9 @@ The environment variables for the node.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### debug?
11
+ ### debug? {#debug}
12
12
 
13
- > `optional` **debug**: `string`
13
+ > `optional` **debug?**: `string`
14
14
 
15
15
  Start the engine in debug mode.
16
16
 
@@ -20,9 +20,9 @@ Start the engine in debug mode.
20
20
 
21
21
  ***
22
22
 
23
- ### silent?
23
+ ### silent? {#silent}
24
24
 
25
- > `optional` **silent**: `string`
25
+ > `optional` **silent?**: `string`
26
26
 
27
27
  Start the engine in silent mode.
28
28
 
@@ -32,9 +32,9 @@ Start the engine in silent mode.
32
32
 
33
33
  ***
34
34
 
35
- ### storageFileRoot?
35
+ ### storageFileRoot? {#storagefileroot}
36
36
 
37
- > `optional` **storageFileRoot**: `string`
37
+ > `optional` **storageFileRoot?**: `string`
38
38
 
39
39
  The root directory for storing items like state file.
40
40
 
@@ -44,9 +44,9 @@ The root directory for storing items like state file.
44
44
 
45
45
  ***
46
46
 
47
- ### stateFilename?
47
+ ### stateFilename? {#statefilename}
48
48
 
49
- > `optional` **stateFilename**: `string`
49
+ > `optional` **stateFilename?**: `string`
50
50
 
51
51
  The name of the state file.
52
52
 
@@ -56,9 +56,9 @@ The name of the state file.
56
56
 
57
57
  ***
58
58
 
59
- ### nodeIdentityEnabled?
59
+ ### nodeIdentityEnabled? {#nodeidentityenabled}
60
60
 
61
- > `optional` **nodeIdentityEnabled**: `string`
61
+ > `optional` **nodeIdentityEnabled?**: `string`
62
62
 
63
63
  Does the node have a unique ID, defaults to true.
64
64
 
@@ -68,9 +68,9 @@ Does the node have a unique ID, defaults to true.
68
68
 
69
69
  ***
70
70
 
71
- ### tenantEnabled?
71
+ ### tenantEnabled? {#tenantenabled}
72
72
 
73
- > `optional` **tenantEnabled**: `string`
73
+ > `optional` **tenantEnabled?**: `string`
74
74
 
75
75
  Is multi-tenant support enabled, defaults to false.
76
76
 
@@ -80,9 +80,9 @@ Is multi-tenant support enabled, defaults to false.
80
80
 
81
81
  ***
82
82
 
83
- ### entityStorageConnectorType?
83
+ ### entityStorageConnectorType? {#entitystorageconnectortype}
84
84
 
85
- > `optional` **entityStorageConnectorType**: `string`
85
+ > `optional` **entityStorageConnectorType?**: `string`
86
86
 
87
87
  The type of the entity storage to create, comma separate for more than one connector.
88
88
  values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
@@ -93,9 +93,9 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
93
93
 
94
94
  ***
95
95
 
96
- ### entityStorageConnectorDefault?
96
+ ### entityStorageConnectorDefault? {#entitystorageconnectordefault}
97
97
 
98
- > `optional` **entityStorageConnectorDefault**: `string`
98
+ > `optional` **entityStorageConnectorDefault?**: `string`
99
99
 
100
100
  The default entity storage connector to use, defaults to the first one in the list.
101
101
 
@@ -105,9 +105,9 @@ The default entity storage connector to use, defaults to the first one in the li
105
105
 
106
106
  ***
107
107
 
108
- ### entityStorageTablePrefix?
108
+ ### entityStorageTablePrefix? {#entitystoragetableprefix}
109
109
 
110
- > `optional` **entityStorageTablePrefix**: `string`
110
+ > `optional` **entityStorageTablePrefix?**: `string`
111
111
 
112
112
  A prefix for all the table in entity-storage, can be empty.
113
113
 
@@ -117,9 +117,9 @@ A prefix for all the table in entity-storage, can be empty.
117
117
 
118
118
  ***
119
119
 
120
- ### awsDynamodbAuthMode?
120
+ ### awsDynamodbAuthMode? {#awsdynamodbauthmode}
121
121
 
122
- > `optional` **awsDynamodbAuthMode**: `string`
122
+ > `optional` **awsDynamodbAuthMode?**: `string`
123
123
 
124
124
  AWS DynamoDB auth mode, either credentials or pod.
125
125
 
@@ -129,9 +129,9 @@ AWS DynamoDB auth mode, either credentials or pod.
129
129
 
130
130
  ***
131
131
 
132
- ### awsDynamodbAccessKeyId?
132
+ ### awsDynamodbAccessKeyId? {#awsdynamodbaccesskeyid}
133
133
 
134
- > `optional` **awsDynamodbAccessKeyId**: `string`
134
+ > `optional` **awsDynamodbAccessKeyId?**: `string`
135
135
 
136
136
  AWS Dynamo DB access key id.
137
137
 
@@ -141,9 +141,9 @@ AWS Dynamo DB access key id.
141
141
 
142
142
  ***
143
143
 
144
- ### awsDynamodbEndpoint?
144
+ ### awsDynamodbEndpoint? {#awsdynamodbendpoint}
145
145
 
146
- > `optional` **awsDynamodbEndpoint**: `string`
146
+ > `optional` **awsDynamodbEndpoint?**: `string`
147
147
 
148
148
  AWS Dynamo DB Endpoint if running local instance.
149
149
 
@@ -153,9 +153,9 @@ AWS Dynamo DB Endpoint if running local instance.
153
153
 
154
154
  ***
155
155
 
156
- ### awsDynamodbRegion?
156
+ ### awsDynamodbRegion? {#awsdynamodbregion}
157
157
 
158
- > `optional` **awsDynamodbRegion**: `string`
158
+ > `optional` **awsDynamodbRegion?**: `string`
159
159
 
160
160
  AWS Dynamo DB region.
161
161
 
@@ -165,9 +165,9 @@ AWS Dynamo DB region.
165
165
 
166
166
  ***
167
167
 
168
- ### awsDynamodbSecretAccessKey?
168
+ ### awsDynamodbSecretAccessKey? {#awsdynamodbsecretaccesskey}
169
169
 
170
- > `optional` **awsDynamodbSecretAccessKey**: `string`
170
+ > `optional` **awsDynamodbSecretAccessKey?**: `string`
171
171
 
172
172
  AWS Dynamo DB secret access key.
173
173
 
@@ -177,9 +177,9 @@ AWS Dynamo DB secret access key.
177
177
 
178
178
  ***
179
179
 
180
- ### awsDynamodbConnectionTimeoutMs?
180
+ ### awsDynamodbConnectionTimeoutMs? {#awsdynamodbconnectiontimeoutms}
181
181
 
182
- > `optional` **awsDynamodbConnectionTimeoutMs**: `string`
182
+ > `optional` **awsDynamodbConnectionTimeoutMs?**: `string`
183
183
 
184
184
  AWS Dynamo DB connection timeout.
185
185
 
@@ -189,9 +189,9 @@ AWS Dynamo DB connection timeout.
189
189
 
190
190
  ***
191
191
 
192
- ### azureCosmosdbKey?
192
+ ### azureCosmosdbKey? {#azurecosmosdbkey}
193
193
 
194
- > `optional` **azureCosmosdbKey**: `string`
194
+ > `optional` **azureCosmosdbKey?**: `string`
195
195
 
196
196
  Azure Cosmos DB key.
197
197
 
@@ -201,9 +201,9 @@ Azure Cosmos DB key.
201
201
 
202
202
  ***
203
203
 
204
- ### azureCosmosdbContainerId?
204
+ ### azureCosmosdbContainerId? {#azurecosmosdbcontainerid}
205
205
 
206
- > `optional` **azureCosmosdbContainerId**: `string`
206
+ > `optional` **azureCosmosdbContainerId?**: `string`
207
207
 
208
208
  Azure Cosmos DB container id.
209
209
 
@@ -213,9 +213,9 @@ Azure Cosmos DB container id.
213
213
 
214
214
  ***
215
215
 
216
- ### azureCosmosdbDatabaseId?
216
+ ### azureCosmosdbDatabaseId? {#azurecosmosdbdatabaseid}
217
217
 
218
- > `optional` **azureCosmosdbDatabaseId**: `string`
218
+ > `optional` **azureCosmosdbDatabaseId?**: `string`
219
219
 
220
220
  Azure Cosmos DB database id.
221
221
 
@@ -225,9 +225,9 @@ Azure Cosmos DB database id.
225
225
 
226
226
  ***
227
227
 
228
- ### azureCosmosdbEndpoint?
228
+ ### azureCosmosdbEndpoint? {#azurecosmosdbendpoint}
229
229
 
230
- > `optional` **azureCosmosdbEndpoint**: `string`
230
+ > `optional` **azureCosmosdbEndpoint?**: `string`
231
231
 
232
232
  Azure Cosmos DB endpoint.
233
233
 
@@ -237,9 +237,9 @@ Azure Cosmos DB endpoint.
237
237
 
238
238
  ***
239
239
 
240
- ### gcpFirestoreCollectionName?
240
+ ### gcpFirestoreCollectionName? {#gcpfirestorecollectionname}
241
241
 
242
- > `optional` **gcpFirestoreCollectionName**: `string`
242
+ > `optional` **gcpFirestoreCollectionName?**: `string`
243
243
 
244
244
  GCP Firestore collection name.
245
245
 
@@ -249,9 +249,9 @@ GCP Firestore collection name.
249
249
 
250
250
  ***
251
251
 
252
- ### gcpFirestoreCredentials?
252
+ ### gcpFirestoreCredentials? {#gcpfirestorecredentials}
253
253
 
254
- > `optional` **gcpFirestoreCredentials**: `string`
254
+ > `optional` **gcpFirestoreCredentials?**: `string`
255
255
 
256
256
  GCP Firestore credentials.
257
257
 
@@ -261,9 +261,9 @@ GCP Firestore credentials.
261
261
 
262
262
  ***
263
263
 
264
- ### gcpFirestoreDatabaseId?
264
+ ### gcpFirestoreDatabaseId? {#gcpfirestoredatabaseid}
265
265
 
266
- > `optional` **gcpFirestoreDatabaseId**: `string`
266
+ > `optional` **gcpFirestoreDatabaseId?**: `string`
267
267
 
268
268
  GCP Firestore database id.
269
269
 
@@ -273,9 +273,9 @@ GCP Firestore database id.
273
273
 
274
274
  ***
275
275
 
276
- ### gcpFirestoreApiEndpoint?
276
+ ### gcpFirestoreApiEndpoint? {#gcpfirestoreapiendpoint}
277
277
 
278
- > `optional` **gcpFirestoreApiEndpoint**: `string`
278
+ > `optional` **gcpFirestoreApiEndpoint?**: `string`
279
279
 
280
280
  GCP Firestore endpoint.
281
281
 
@@ -285,9 +285,9 @@ GCP Firestore endpoint.
285
285
 
286
286
  ***
287
287
 
288
- ### gcpFirestoreProjectId?
288
+ ### gcpFirestoreProjectId? {#gcpfirestoreprojectid}
289
289
 
290
- > `optional` **gcpFirestoreProjectId**: `string`
290
+ > `optional` **gcpFirestoreProjectId?**: `string`
291
291
 
292
292
  GCP Firestore project id.
293
293
 
@@ -297,9 +297,9 @@ GCP Firestore project id.
297
297
 
298
298
  ***
299
299
 
300
- ### scylladbHosts?
300
+ ### scylladbHosts? {#scylladbhosts}
301
301
 
302
- > `optional` **scylladbHosts**: `string`
302
+ > `optional` **scylladbHosts?**: `string`
303
303
 
304
304
  ScyllaDB hosts as comma separated string.
305
305
 
@@ -309,9 +309,9 @@ ScyllaDB hosts as comma separated string.
309
309
 
310
310
  ***
311
311
 
312
- ### scylladbKeyspace?
312
+ ### scylladbKeyspace? {#scylladbkeyspace}
313
313
 
314
- > `optional` **scylladbKeyspace**: `string`
314
+ > `optional` **scylladbKeyspace?**: `string`
315
315
 
316
316
  ScyllaDB keyspace.
317
317
 
@@ -321,9 +321,9 @@ ScyllaDB keyspace.
321
321
 
322
322
  ***
323
323
 
324
- ### scylladbLocalDataCenter?
324
+ ### scylladbLocalDataCenter? {#scylladblocaldatacenter}
325
325
 
326
- > `optional` **scylladbLocalDataCenter**: `string`
326
+ > `optional` **scylladbLocalDataCenter?**: `string`
327
327
 
328
328
  ScyllaDB local data center.
329
329
 
@@ -333,9 +333,9 @@ ScyllaDB local data center.
333
333
 
334
334
  ***
335
335
 
336
- ### scylladbPort?
336
+ ### scylladbPort? {#scylladbport}
337
337
 
338
- > `optional` **scylladbPort**: `string`
338
+ > `optional` **scylladbPort?**: `string`
339
339
 
340
340
  ScyllaDB port.
341
341
 
@@ -345,9 +345,9 @@ ScyllaDB port.
345
345
 
346
346
  ***
347
347
 
348
- ### mySqlHost?
348
+ ### mySqlHost? {#mysqlhost}
349
349
 
350
- > `optional` **mySqlHost**: `string`
350
+ > `optional` **mySqlHost?**: `string`
351
351
 
352
352
  MySQL host.
353
353
 
@@ -357,9 +357,9 @@ MySQL host.
357
357
 
358
358
  ***
359
359
 
360
- ### mySqlPort?
360
+ ### mySqlPort? {#mysqlport}
361
361
 
362
- > `optional` **mySqlPort**: `number`
362
+ > `optional` **mySqlPort?**: `number`
363
363
 
364
364
  MySQL port.
365
365
 
@@ -369,9 +369,9 @@ MySQL port.
369
369
 
370
370
  ***
371
371
 
372
- ### mySqlUser?
372
+ ### mySqlUser? {#mysqluser}
373
373
 
374
- > `optional` **mySqlUser**: `string`
374
+ > `optional` **mySqlUser?**: `string`
375
375
 
376
376
  MySQL username.
377
377
 
@@ -381,9 +381,9 @@ MySQL username.
381
381
 
382
382
  ***
383
383
 
384
- ### mySqlPassword?
384
+ ### mySqlPassword? {#mysqlpassword}
385
385
 
386
- > `optional` **mySqlPassword**: `string`
386
+ > `optional` **mySqlPassword?**: `string`
387
387
 
388
388
  MySQL password.
389
389
 
@@ -393,9 +393,9 @@ MySQL password.
393
393
 
394
394
  ***
395
395
 
396
- ### mySqlDatabase?
396
+ ### mySqlDatabase? {#mysqldatabase}
397
397
 
398
- > `optional` **mySqlDatabase**: `string`
398
+ > `optional` **mySqlDatabase?**: `string`
399
399
 
400
400
  MySQL Database.
401
401
 
@@ -405,9 +405,9 @@ MySQL Database.
405
405
 
406
406
  ***
407
407
 
408
- ### mongoDbHost?
408
+ ### mongoDbHost? {#mongodbhost}
409
409
 
410
- > `optional` **mongoDbHost**: `string`
410
+ > `optional` **mongoDbHost?**: `string`
411
411
 
412
412
  MongoDB host.
413
413
 
@@ -417,9 +417,9 @@ MongoDB host.
417
417
 
418
418
  ***
419
419
 
420
- ### mongoDbPort?
420
+ ### mongoDbPort? {#mongodbport}
421
421
 
422
- > `optional` **mongoDbPort**: `number`
422
+ > `optional` **mongoDbPort?**: `number`
423
423
 
424
424
  MongoDB port.
425
425
 
@@ -429,9 +429,9 @@ MongoDB port.
429
429
 
430
430
  ***
431
431
 
432
- ### mongoDbUser?
432
+ ### mongoDbUser? {#mongodbuser}
433
433
 
434
- > `optional` **mongoDbUser**: `string`
434
+ > `optional` **mongoDbUser?**: `string`
435
435
 
436
436
  MongoDB username.
437
437
 
@@ -441,9 +441,9 @@ MongoDB username.
441
441
 
442
442
  ***
443
443
 
444
- ### mongoDbPassword?
444
+ ### mongoDbPassword? {#mongodbpassword}
445
445
 
446
- > `optional` **mongoDbPassword**: `string`
446
+ > `optional` **mongoDbPassword?**: `string`
447
447
 
448
448
  MongoDB password.
449
449
 
@@ -453,9 +453,9 @@ MongoDB password.
453
453
 
454
454
  ***
455
455
 
456
- ### mongoDbDatabase?
456
+ ### mongoDbDatabase? {#mongodbdatabase}
457
457
 
458
- > `optional` **mongoDbDatabase**: `string`
458
+ > `optional` **mongoDbDatabase?**: `string`
459
459
 
460
460
  MongoDB Database.
461
461
 
@@ -465,9 +465,9 @@ MongoDB Database.
465
465
 
466
466
  ***
467
467
 
468
- ### postgreSqlHost?
468
+ ### postgreSqlHost? {#postgresqlhost}
469
469
 
470
- > `optional` **postgreSqlHost**: `string`
470
+ > `optional` **postgreSqlHost?**: `string`
471
471
 
472
472
  PostgreSQl host.
473
473
 
@@ -477,9 +477,9 @@ PostgreSQl host.
477
477
 
478
478
  ***
479
479
 
480
- ### postgreSqlPort?
480
+ ### postgreSqlPort? {#postgresqlport}
481
481
 
482
- > `optional` **postgreSqlPort**: `number`
482
+ > `optional` **postgreSqlPort?**: `number`
483
483
 
484
484
  PostgreSQl port.
485
485
 
@@ -489,9 +489,9 @@ PostgreSQl port.
489
489
 
490
490
  ***
491
491
 
492
- ### postgreSqlUser?
492
+ ### postgreSqlUser? {#postgresqluser}
493
493
 
494
- > `optional` **postgreSqlUser**: `string`
494
+ > `optional` **postgreSqlUser?**: `string`
495
495
 
496
496
  PostgreSQl username.
497
497
 
@@ -501,9 +501,9 @@ PostgreSQl username.
501
501
 
502
502
  ***
503
503
 
504
- ### postgreSqlPassword?
504
+ ### postgreSqlPassword? {#postgresqlpassword}
505
505
 
506
- > `optional` **postgreSqlPassword**: `string`
506
+ > `optional` **postgreSqlPassword?**: `string`
507
507
 
508
508
  PostgreSQl password.
509
509
 
@@ -513,9 +513,9 @@ PostgreSQl password.
513
513
 
514
514
  ***
515
515
 
516
- ### postgreSqlDatabase?
516
+ ### postgreSqlDatabase? {#postgresqldatabase}
517
517
 
518
- > `optional` **postgreSqlDatabase**: `string`
518
+ > `optional` **postgreSqlDatabase?**: `string`
519
519
 
520
520
  PostgreSQl Database.
521
521
 
@@ -525,9 +525,9 @@ PostgreSQl Database.
525
525
 
526
526
  ***
527
527
 
528
- ### ipfsBearerToken?
528
+ ### ipfsBearerToken? {#ipfsbearertoken}
529
529
 
530
- > `optional` **ipfsBearerToken**: `string`
530
+ > `optional` **ipfsBearerToken?**: `string`
531
531
 
532
532
  The security token for accessing IPFS API.
533
533
 
@@ -537,9 +537,9 @@ The security token for accessing IPFS API.
537
537
 
538
538
  ***
539
539
 
540
- ### ipfsApiUrl?
540
+ ### ipfsApiUrl? {#ipfsapiurl}
541
541
 
542
- > `optional` **ipfsApiUrl**: `string`
542
+ > `optional` **ipfsApiUrl?**: `string`
543
543
 
544
544
  The url for accessing IPFS API.
545
545
 
@@ -549,9 +549,9 @@ The url for accessing IPFS API.
549
549
 
550
550
  ***
551
551
 
552
- ### blobStorageConnectorType?
552
+ ### blobStorageConnectorType? {#blobstorageconnectortype}
553
553
 
554
- > `optional` **blobStorageConnectorType**: `string`
554
+ > `optional` **blobStorageConnectorType?**: `string`
555
555
 
556
556
  The type of the entity storage to create, comma separate for more than one connector.
557
557
  values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
@@ -562,9 +562,9 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
562
562
 
563
563
  ***
564
564
 
565
- ### blobStorageConnectorDefault?
565
+ ### blobStorageConnectorDefault? {#blobstorageconnectordefault}
566
566
 
567
- > `optional` **blobStorageConnectorDefault**: `string`
567
+ > `optional` **blobStorageConnectorDefault?**: `string`
568
568
 
569
569
  The default blob storage connector to use, defaults to the first one in the list.
570
570
 
@@ -574,9 +574,9 @@ The default blob storage connector to use, defaults to the first one in the list
574
574
 
575
575
  ***
576
576
 
577
- ### blobStorageConnectorPublic?
577
+ ### blobStorageConnectorPublic? {#blobstorageconnectorpublic}
578
578
 
579
- > `optional` **blobStorageConnectorPublic**: `string`
579
+ > `optional` **blobStorageConnectorPublic?**: `string`
580
580
 
581
581
  Blog storage connector which has public access.
582
582
 
@@ -586,9 +586,9 @@ Blog storage connector which has public access.
586
586
 
587
587
  ***
588
588
 
589
- ### blobStorageEnableEncryption?
589
+ ### blobStorageEnableEncryption? {#blobstorageenableencryption}
590
590
 
591
- > `optional` **blobStorageEnableEncryption**: `string`
591
+ > `optional` **blobStorageEnableEncryption?**: `string`
592
592
 
593
593
  Enable encryption for the blob storage.
594
594
 
@@ -598,9 +598,9 @@ Enable encryption for the blob storage.
598
598
 
599
599
  ***
600
600
 
601
- ### blobStorageEncryptionKeyId?
601
+ ### blobStorageEncryptionKeyId? {#blobstorageencryptionkeyid}
602
602
 
603
- > `optional` **blobStorageEncryptionKeyId**: `string`
603
+ > `optional` **blobStorageEncryptionKeyId?**: `string`
604
604
 
605
605
  The id of the encryption key for the blob storage.
606
606
 
@@ -610,9 +610,9 @@ The id of the encryption key for the blob storage.
610
610
 
611
611
  ***
612
612
 
613
- ### blobStoragePrefix?
613
+ ### blobStoragePrefix? {#blobstorageprefix}
614
614
 
615
- > `optional` **blobStoragePrefix**: `string`
615
+ > `optional` **blobStoragePrefix?**: `string`
616
616
 
617
617
  A prefix for all the blobs in blob-storage, can be empty.
618
618
 
@@ -622,9 +622,9 @@ A prefix for all the blobs in blob-storage, can be empty.
622
622
 
623
623
  ***
624
624
 
625
- ### awsS3Region?
625
+ ### awsS3Region? {#awss3region}
626
626
 
627
- > `optional` **awsS3Region**: `string`
627
+ > `optional` **awsS3Region?**: `string`
628
628
 
629
629
  AWS S3 region.
630
630
 
@@ -634,9 +634,9 @@ AWS S3 region.
634
634
 
635
635
  ***
636
636
 
637
- ### awsS3BucketName?
637
+ ### awsS3BucketName? {#awss3bucketname}
638
638
 
639
- > `optional` **awsS3BucketName**: `string`
639
+ > `optional` **awsS3BucketName?**: `string`
640
640
 
641
641
  AWS S3 bucket name.
642
642
 
@@ -646,9 +646,9 @@ AWS S3 bucket name.
646
646
 
647
647
  ***
648
648
 
649
- ### awsS3AuthMode?
649
+ ### awsS3AuthMode? {#awss3authmode}
650
650
 
651
- > `optional` **awsS3AuthMode**: `string`
651
+ > `optional` **awsS3AuthMode?**: `string`
652
652
 
653
653
  AWS S3 auth mode, either credentials or pod, defaults to credentials.
654
654
 
@@ -658,9 +658,9 @@ AWS S3 auth mode, either credentials or pod, defaults to credentials.
658
658
 
659
659
  ***
660
660
 
661
- ### awsS3AccessKeyId?
661
+ ### awsS3AccessKeyId? {#awss3accesskeyid}
662
662
 
663
- > `optional` **awsS3AccessKeyId**: `string`
663
+ > `optional` **awsS3AccessKeyId?**: `string`
664
664
 
665
665
  AWS S3 access key id.
666
666
 
@@ -670,9 +670,9 @@ AWS S3 access key id.
670
670
 
671
671
  ***
672
672
 
673
- ### awsS3SecretAccessKey?
673
+ ### awsS3SecretAccessKey? {#awss3secretaccesskey}
674
674
 
675
- > `optional` **awsS3SecretAccessKey**: `string`
675
+ > `optional` **awsS3SecretAccessKey?**: `string`
676
676
 
677
677
  AWS S3 secret access key.
678
678
 
@@ -682,9 +682,9 @@ AWS S3 secret access key.
682
682
 
683
683
  ***
684
684
 
685
- ### awsS3Endpoint?
685
+ ### awsS3Endpoint? {#awss3endpoint}
686
686
 
687
- > `optional` **awsS3Endpoint**: `string`
687
+ > `optional` **awsS3Endpoint?**: `string`
688
688
 
689
689
  AWS S3 endpoint.
690
690
 
@@ -694,9 +694,9 @@ AWS S3 endpoint.
694
694
 
695
695
  ***
696
696
 
697
- ### azureStorageAccountKey?
697
+ ### azureStorageAccountKey? {#azurestorageaccountkey}
698
698
 
699
- > `optional` **azureStorageAccountKey**: `string`
699
+ > `optional` **azureStorageAccountKey?**: `string`
700
700
 
701
701
  Azure Storage account key.
702
702
 
@@ -706,9 +706,9 @@ Azure Storage account key.
706
706
 
707
707
  ***
708
708
 
709
- ### azureStorageAccountName?
709
+ ### azureStorageAccountName? {#azurestorageaccountname}
710
710
 
711
- > `optional` **azureStorageAccountName**: `string`
711
+ > `optional` **azureStorageAccountName?**: `string`
712
712
 
713
713
  Azure Storage account name.
714
714
 
@@ -718,9 +718,9 @@ Azure Storage account name.
718
718
 
719
719
  ***
720
720
 
721
- ### azureStorageContainerName?
721
+ ### azureStorageContainerName? {#azurestoragecontainername}
722
722
 
723
- > `optional` **azureStorageContainerName**: `string`
723
+ > `optional` **azureStorageContainerName?**: `string`
724
724
 
725
725
  Azure Storage container.
726
726
 
@@ -730,9 +730,9 @@ Azure Storage container.
730
730
 
731
731
  ***
732
732
 
733
- ### azureStorageEndpoint?
733
+ ### azureStorageEndpoint? {#azurestorageendpoint}
734
734
 
735
- > `optional` **azureStorageEndpoint**: `string`
735
+ > `optional` **azureStorageEndpoint?**: `string`
736
736
 
737
737
  Azure Storage endpoint.
738
738
 
@@ -742,9 +742,9 @@ Azure Storage endpoint.
742
742
 
743
743
  ***
744
744
 
745
- ### gcpStorageBucketName?
745
+ ### gcpStorageBucketName? {#gcpstoragebucketname}
746
746
 
747
- > `optional` **gcpStorageBucketName**: `string`
747
+ > `optional` **gcpStorageBucketName?**: `string`
748
748
 
749
749
  GCP Storage bucket.
750
750
 
@@ -754,9 +754,9 @@ GCP Storage bucket.
754
754
 
755
755
  ***
756
756
 
757
- ### gcpStorageCredentials?
757
+ ### gcpStorageCredentials? {#gcpstoragecredentials}
758
758
 
759
- > `optional` **gcpStorageCredentials**: `string`
759
+ > `optional` **gcpStorageCredentials?**: `string`
760
760
 
761
761
  GCP Storage credentials.
762
762
 
@@ -766,9 +766,9 @@ GCP Storage credentials.
766
766
 
767
767
  ***
768
768
 
769
- ### gcpStorageEndpoint?
769
+ ### gcpStorageEndpoint? {#gcpstorageendpoint}
770
770
 
771
- > `optional` **gcpStorageEndpoint**: `string`
771
+ > `optional` **gcpStorageEndpoint?**: `string`
772
772
 
773
773
  GCP Storage endpoint.
774
774
 
@@ -778,9 +778,9 @@ GCP Storage endpoint.
778
778
 
779
779
  ***
780
780
 
781
- ### gcpStorageProjectId?
781
+ ### gcpStorageProjectId? {#gcpstorageprojectid}
782
782
 
783
- > `optional` **gcpStorageProjectId**: `string`
783
+ > `optional` **gcpStorageProjectId?**: `string`
784
784
 
785
785
  GCP Storage project id.
786
786
 
@@ -790,9 +790,9 @@ GCP Storage project id.
790
790
 
791
791
  ***
792
792
 
793
- ### vaultConnector?
793
+ ### vaultConnector? {#vaultconnector}
794
794
 
795
- > `optional` **vaultConnector**: `string`
795
+ > `optional` **vaultConnector?**: `string`
796
796
 
797
797
  The type of the default vault connector: entity-storage, hashicorp.
798
798
 
@@ -802,9 +802,9 @@ The type of the default vault connector: entity-storage, hashicorp.
802
802
 
803
803
  ***
804
804
 
805
- ### vaultPrefix?
805
+ ### vaultPrefix? {#vaultprefix}
806
806
 
807
- > `optional` **vaultPrefix**: `string`
807
+ > `optional` **vaultPrefix?**: `string`
808
808
 
809
809
  Prefix to prepend to entries in the vault.
810
810
 
@@ -814,9 +814,9 @@ Prefix to prepend to entries in the vault.
814
814
 
815
815
  ***
816
816
 
817
- ### hashicorpVaultToken?
817
+ ### hashicorpVaultToken? {#hashicorpvaulttoken}
818
818
 
819
- > `optional` **hashicorpVaultToken**: `string`
819
+ > `optional` **hashicorpVaultToken?**: `string`
820
820
 
821
821
  Hashicorp Vault token.
822
822
 
@@ -826,9 +826,9 @@ Hashicorp Vault token.
826
826
 
827
827
  ***
828
828
 
829
- ### hashicorpVaultEndpoint?
829
+ ### hashicorpVaultEndpoint? {#hashicorpvaultendpoint}
830
830
 
831
- > `optional` **hashicorpVaultEndpoint**: `string`
831
+ > `optional` **hashicorpVaultEndpoint?**: `string`
832
832
 
833
833
  Hashicorp Vault endpoint.
834
834
 
@@ -838,9 +838,9 @@ Hashicorp Vault endpoint.
838
838
 
839
839
  ***
840
840
 
841
- ### loggingConnector?
841
+ ### loggingConnector? {#loggingconnector}
842
842
 
843
- > `optional` **loggingConnector**: `string`
843
+ > `optional` **loggingConnector?**: `string`
844
844
 
845
845
  The type of logging task connector, can be a comma separated list: console, entity-storage.
846
846
 
@@ -850,9 +850,9 @@ The type of logging task connector, can be a comma separated list: console, enti
850
850
 
851
851
  ***
852
852
 
853
- ### eventBusConnector?
853
+ ### eventBusConnector? {#eventbusconnector}
854
854
 
855
- > `optional` **eventBusConnector**: `string`
855
+ > `optional` **eventBusConnector?**: `string`
856
856
 
857
857
  The type of event bus connector: local.
858
858
 
@@ -862,9 +862,9 @@ The type of event bus connector: local.
862
862
 
863
863
  ***
864
864
 
865
- ### eventBusComponent?
865
+ ### eventBusComponent? {#eventbuscomponent}
866
866
 
867
- > `optional` **eventBusComponent**: `string`
867
+ > `optional` **eventBusComponent?**: `string`
868
868
 
869
869
  The type of event bus component: service.
870
870
 
@@ -874,9 +874,9 @@ The type of event bus component: service.
874
874
 
875
875
  ***
876
876
 
877
- ### messagingEnabled?
877
+ ### messagingEnabled? {#messagingenabled}
878
878
 
879
- > `optional` **messagingEnabled**: `string`
879
+ > `optional` **messagingEnabled?**: `string`
880
880
 
881
881
  Are the messaging components enabled, defaults to false.
882
882
 
@@ -886,9 +886,9 @@ Are the messaging components enabled, defaults to false.
886
886
 
887
887
  ***
888
888
 
889
- ### awsSesRegion?
889
+ ### awsSesRegion? {#awssesregion}
890
890
 
891
- > `optional` **awsSesRegion**: `string`
891
+ > `optional` **awsSesRegion?**: `string`
892
892
 
893
893
  AWS SES region.
894
894
 
@@ -898,9 +898,9 @@ AWS SES region.
898
898
 
899
899
  ***
900
900
 
901
- ### awsSesAuthMode?
901
+ ### awsSesAuthMode? {#awssesauthmode}
902
902
 
903
- > `optional` **awsSesAuthMode**: `string`
903
+ > `optional` **awsSesAuthMode?**: `string`
904
904
 
905
905
  AWS SES auth mode, either credentials or pod, defaults to credentials.
906
906
 
@@ -910,9 +910,9 @@ AWS SES auth mode, either credentials or pod, defaults to credentials.
910
910
 
911
911
  ***
912
912
 
913
- ### awsSesSecretAccessKey?
913
+ ### awsSesSecretAccessKey? {#awssessecretaccesskey}
914
914
 
915
- > `optional` **awsSesSecretAccessKey**: `string`
915
+ > `optional` **awsSesSecretAccessKey?**: `string`
916
916
 
917
917
  AWS SES secret access key.
918
918
 
@@ -922,9 +922,9 @@ AWS SES secret access key.
922
922
 
923
923
  ***
924
924
 
925
- ### awsSesAccessKeyId?
925
+ ### awsSesAccessKeyId? {#awssesaccesskeyid}
926
926
 
927
- > `optional` **awsSesAccessKeyId**: `string`
927
+ > `optional` **awsSesAccessKeyId?**: `string`
928
928
 
929
929
  AWS SES access key id.
930
930
 
@@ -934,9 +934,9 @@ AWS SES access key id.
934
934
 
935
935
  ***
936
936
 
937
- ### awsSesEndpoint?
937
+ ### awsSesEndpoint? {#awssesendpoint}
938
938
 
939
- > `optional` **awsSesEndpoint**: `string`
939
+ > `optional` **awsSesEndpoint?**: `string`
940
940
 
941
941
  AWS SES endpoint.
942
942
 
@@ -946,9 +946,9 @@ AWS SES endpoint.
946
946
 
947
947
  ***
948
948
 
949
- ### awsMessagingPushNotificationApplications?
949
+ ### awsMessagingPushNotificationApplications? {#awsmessagingpushnotificationapplications}
950
950
 
951
- > `optional` **awsMessagingPushNotificationApplications**: `string`
951
+ > `optional` **awsMessagingPushNotificationApplications?**: `string`
952
952
 
953
953
  The applications for the push notifications reference a separate json with @json: prefix.
954
954
 
@@ -958,9 +958,9 @@ The applications for the push notifications reference a separate json with @json
958
958
 
959
959
  ***
960
960
 
961
- ### messagingEmailConnector?
961
+ ### messagingEmailConnector? {#messagingemailconnector}
962
962
 
963
- > `optional` **messagingEmailConnector**: `string`
963
+ > `optional` **messagingEmailConnector?**: `string`
964
964
 
965
965
  The type of messaging email connector: entity-storage, aws.
966
966
 
@@ -970,9 +970,9 @@ The type of messaging email connector: entity-storage, aws.
970
970
 
971
971
  ***
972
972
 
973
- ### messagingSmsConnector?
973
+ ### messagingSmsConnector? {#messagingsmsconnector}
974
974
 
975
- > `optional` **messagingSmsConnector**: `string`
975
+ > `optional` **messagingSmsConnector?**: `string`
976
976
 
977
977
  The type of messaging sms connector: entity-storage, aws.
978
978
 
@@ -982,9 +982,9 @@ The type of messaging sms connector: entity-storage, aws.
982
982
 
983
983
  ***
984
984
 
985
- ### messagingPushNotificationConnector?
985
+ ### messagingPushNotificationConnector? {#messagingpushnotificationconnector}
986
986
 
987
- > `optional` **messagingPushNotificationConnector**: `string`
987
+ > `optional` **messagingPushNotificationConnector?**: `string`
988
988
 
989
989
  The type of messaging push notification connector: entity-storage, aws.
990
990
 
@@ -994,9 +994,9 @@ The type of messaging push notification connector: entity-storage, aws.
994
994
 
995
995
  ***
996
996
 
997
- ### telemetryConnector?
997
+ ### telemetryConnector? {#telemetryconnector}
998
998
 
999
- > `optional` **telemetryConnector**: `string`
999
+ > `optional` **telemetryConnector?**: `string`
1000
1000
 
1001
1001
  The type of telemetry connector: entity-storage.
1002
1002
 
@@ -1006,9 +1006,9 @@ The type of telemetry connector: entity-storage.
1006
1006
 
1007
1007
  ***
1008
1008
 
1009
- ### faucetConnector?
1009
+ ### faucetConnector? {#faucetconnector}
1010
1010
 
1011
- > `optional` **faucetConnector**: `string`
1011
+ > `optional` **faucetConnector?**: `string`
1012
1012
 
1013
1013
  The type of faucet connector: entity-storage, iota.
1014
1014
 
@@ -1018,9 +1018,9 @@ The type of faucet connector: entity-storage, iota.
1018
1018
 
1019
1019
  ***
1020
1020
 
1021
- ### walletConnector?
1021
+ ### walletConnector? {#walletconnector}
1022
1022
 
1023
- > `optional` **walletConnector**: `string`
1023
+ > `optional` **walletConnector?**: `string`
1024
1024
 
1025
1025
  The type of wallet connector: entity-storage, iota.
1026
1026
 
@@ -1030,9 +1030,9 @@ The type of wallet connector: entity-storage, iota.
1030
1030
 
1031
1031
  ***
1032
1032
 
1033
- ### nftConnector?
1033
+ ### nftConnector? {#nftconnector}
1034
1034
 
1035
- > `optional` **nftConnector**: `string`
1035
+ > `optional` **nftConnector?**: `string`
1036
1036
 
1037
1037
  The type of NFT connector: entity-storage, iota.
1038
1038
 
@@ -1042,9 +1042,9 @@ The type of NFT connector: entity-storage, iota.
1042
1042
 
1043
1043
  ***
1044
1044
 
1045
- ### identityConnector?
1045
+ ### identityConnector? {#identityconnector}
1046
1046
 
1047
- > `optional` **identityConnector**: `string`
1047
+ > `optional` **identityConnector?**: `string`
1048
1048
 
1049
1049
  The type of identity connector: entity-storage, iota.
1050
1050
 
@@ -1054,9 +1054,9 @@ The type of identity connector: entity-storage, iota.
1054
1054
 
1055
1055
  ***
1056
1056
 
1057
- ### identityWalletAddressIndex?
1057
+ ### identityWalletAddressIndex? {#identitywalletaddressindex}
1058
1058
 
1059
- > `optional` **identityWalletAddressIndex**: `string`
1059
+ > `optional` **identityWalletAddressIndex?**: `string`
1060
1060
 
1061
1061
  The index of the wallet address to use, defaults to 0.
1062
1062
 
@@ -1066,9 +1066,9 @@ The index of the wallet address to use, defaults to 0.
1066
1066
 
1067
1067
  ***
1068
1068
 
1069
- ### identityResolverConnector?
1069
+ ### identityResolverConnector? {#identityresolverconnector}
1070
1070
 
1071
- > `optional` **identityResolverConnector**: `string`
1071
+ > `optional` **identityResolverConnector?**: `string`
1072
1072
 
1073
1073
  The type of identity resolver connector: entity-storage, iota.
1074
1074
 
@@ -1078,9 +1078,9 @@ The type of identity resolver connector: entity-storage, iota.
1078
1078
 
1079
1079
  ***
1080
1080
 
1081
- ### verifiableStorageConnector?
1081
+ ### verifiableStorageConnector? {#verifiablestorageconnector}
1082
1082
 
1083
- > `optional` **verifiableStorageConnector**: `string`
1083
+ > `optional` **verifiableStorageConnector?**: `string`
1084
1084
 
1085
1085
  The type of verifiable storage connector: entity-storage, iota.
1086
1086
 
@@ -1090,9 +1090,9 @@ The type of verifiable storage connector: entity-storage, iota.
1090
1090
 
1091
1091
  ***
1092
1092
 
1093
- ### iotaFaucetEndpoint?
1093
+ ### iotaFaucetEndpoint? {#iotafaucetendpoint}
1094
1094
 
1095
- > `optional` **iotaFaucetEndpoint**: `string`
1095
+ > `optional` **iotaFaucetEndpoint?**: `string`
1096
1096
 
1097
1097
  IOTA Faucet Endpoint.
1098
1098
 
@@ -1102,9 +1102,9 @@ IOTA Faucet Endpoint.
1102
1102
 
1103
1103
  ***
1104
1104
 
1105
- ### iotaNodeEndpoint?
1105
+ ### iotaNodeEndpoint? {#iotanodeendpoint}
1106
1106
 
1107
- > `optional` **iotaNodeEndpoint**: `string`
1107
+ > `optional` **iotaNodeEndpoint?**: `string`
1108
1108
 
1109
1109
  IOTA Node Endpoint.
1110
1110
 
@@ -1114,9 +1114,9 @@ IOTA Node Endpoint.
1114
1114
 
1115
1115
  ***
1116
1116
 
1117
- ### iotaNetwork?
1117
+ ### iotaNetwork? {#iotanetwork}
1118
1118
 
1119
- > `optional` **iotaNetwork**: `string`
1119
+ > `optional` **iotaNetwork?**: `string`
1120
1120
 
1121
1121
  IOTA network.
1122
1122
 
@@ -1126,9 +1126,9 @@ IOTA network.
1126
1126
 
1127
1127
  ***
1128
1128
 
1129
- ### iotaCoinType?
1129
+ ### iotaCoinType? {#iotacointype}
1130
1130
 
1131
- > `optional` **iotaCoinType**: `string`
1131
+ > `optional` **iotaCoinType?**: `string`
1132
1132
 
1133
1133
  IOTA coin type.
1134
1134
 
@@ -1138,9 +1138,9 @@ IOTA coin type.
1138
1138
 
1139
1139
  ***
1140
1140
 
1141
- ### iotaExplorerEndpoint?
1141
+ ### iotaExplorerEndpoint? {#iotaexplorerendpoint}
1142
1142
 
1143
- > `optional` **iotaExplorerEndpoint**: `string`
1143
+ > `optional` **iotaExplorerEndpoint?**: `string`
1144
1144
 
1145
1145
  IOTA Explorer Endpoint.
1146
1146
 
@@ -1150,9 +1150,9 @@ IOTA Explorer Endpoint.
1150
1150
 
1151
1151
  ***
1152
1152
 
1153
- ### iotaGasStationEndpoint?
1153
+ ### iotaGasStationEndpoint? {#iotagasstationendpoint}
1154
1154
 
1155
- > `optional` **iotaGasStationEndpoint**: `string`
1155
+ > `optional` **iotaGasStationEndpoint?**: `string`
1156
1156
 
1157
1157
  IOTA Gas Station Endpoint.
1158
1158
 
@@ -1162,9 +1162,9 @@ IOTA Gas Station Endpoint.
1162
1162
 
1163
1163
  ***
1164
1164
 
1165
- ### iotaGasStationAuthToken?
1165
+ ### iotaGasStationAuthToken? {#iotagasstationauthtoken}
1166
1166
 
1167
- > `optional` **iotaGasStationAuthToken**: `string`
1167
+ > `optional` **iotaGasStationAuthToken?**: `string`
1168
1168
 
1169
1169
  IOTA Gas Station Authentication Token.
1170
1170
 
@@ -1174,9 +1174,9 @@ IOTA Gas Station Authentication Token.
1174
1174
 
1175
1175
  ***
1176
1176
 
1177
- ### universalResolverEndpoint?
1177
+ ### universalResolverEndpoint? {#universalresolverendpoint}
1178
1178
 
1179
- > `optional` **universalResolverEndpoint**: `string`
1179
+ > `optional` **universalResolverEndpoint?**: `string`
1180
1180
 
1181
1181
  Universal Resolver Endpoint.
1182
1182
 
@@ -1186,9 +1186,9 @@ Universal Resolver Endpoint.
1186
1186
 
1187
1187
  ***
1188
1188
 
1189
- ### identityProfileConnector?
1189
+ ### identityProfileConnector? {#identityprofileconnector}
1190
1190
 
1191
- > `optional` **identityProfileConnector**: `string`
1191
+ > `optional` **identityProfileConnector?**: `string`
1192
1192
 
1193
1193
  The type of identity profile connector: entity-storage.
1194
1194
 
@@ -1198,9 +1198,9 @@ The type of identity profile connector: entity-storage.
1198
1198
 
1199
1199
  ***
1200
1200
 
1201
- ### immutableProofVerificationMethodId?
1201
+ ### immutableProofVerificationMethodId? {#immutableproofverificationmethodid}
1202
1202
 
1203
- > `optional` **immutableProofVerificationMethodId**: `string`
1203
+ > `optional` **immutableProofVerificationMethodId?**: `string`
1204
1204
 
1205
1205
  The identity verification method id to use with immutable proofs.
1206
1206
 
@@ -1210,9 +1210,9 @@ The identity verification method id to use with immutable proofs.
1210
1210
 
1211
1211
  ***
1212
1212
 
1213
- ### attestationConnector?
1213
+ ### attestationConnector? {#attestationconnector}
1214
1214
 
1215
- > `optional` **attestationConnector**: `string`
1215
+ > `optional` **attestationConnector?**: `string`
1216
1216
 
1217
1217
  The type of attestation connector: entity-storage, iota.
1218
1218
 
@@ -1222,9 +1222,9 @@ The type of attestation connector: entity-storage, iota.
1222
1222
 
1223
1223
  ***
1224
1224
 
1225
- ### attestationVerificationMethodId?
1225
+ ### attestationVerificationMethodId? {#attestationverificationmethodid}
1226
1226
 
1227
- > `optional` **attestationVerificationMethodId**: `string`
1227
+ > `optional` **attestationVerificationMethodId?**: `string`
1228
1228
 
1229
1229
  The identity verification method id to use with attestation.
1230
1230
 
@@ -1234,9 +1234,9 @@ The identity verification method id to use with attestation.
1234
1234
 
1235
1235
  ***
1236
1236
 
1237
- ### dataProcessingEnabled?
1237
+ ### dataProcessingEnabled? {#dataprocessingenabled}
1238
1238
 
1239
- > `optional` **dataProcessingEnabled**: `string`
1239
+ > `optional` **dataProcessingEnabled?**: `string`
1240
1240
 
1241
1241
  Is the data processing enabled, defaults to false.
1242
1242
 
@@ -1246,9 +1246,9 @@ Is the data processing enabled, defaults to false.
1246
1246
 
1247
1247
  ***
1248
1248
 
1249
- ### dataConverterConnectors?
1249
+ ### dataConverterConnectors? {#dataconverterconnectors}
1250
1250
 
1251
- > `optional` **dataConverterConnectors**: `string`
1251
+ > `optional` **dataConverterConnectors?**: `string`
1252
1252
 
1253
1253
  The type of the default data converters, can be a comma separated list: json, xml.
1254
1254
 
@@ -1258,9 +1258,9 @@ The type of the default data converters, can be a comma separated list: json, xm
1258
1258
 
1259
1259
  ***
1260
1260
 
1261
- ### dataExtractorConnectors?
1261
+ ### dataExtractorConnectors? {#dataextractorconnectors}
1262
1262
 
1263
- > `optional` **dataExtractorConnectors**: `string`
1263
+ > `optional` **dataExtractorConnectors?**: `string`
1264
1264
 
1265
1265
  The type of the default data extractor, can be a comma separated list: json-path.
1266
1266
 
@@ -1270,9 +1270,9 @@ The type of the default data extractor, can be a comma separated list: json-path
1270
1270
 
1271
1271
  ***
1272
1272
 
1273
- ### auditableItemGraphEnabled?
1273
+ ### auditableItemGraphEnabled? {#auditableitemgraphenabled}
1274
1274
 
1275
- > `optional` **auditableItemGraphEnabled**: `string`
1275
+ > `optional` **auditableItemGraphEnabled?**: `string`
1276
1276
 
1277
1277
  Is the auditable item graph enabled, defaults to false.
1278
1278
 
@@ -1282,9 +1282,9 @@ Is the auditable item graph enabled, defaults to false.
1282
1282
 
1283
1283
  ***
1284
1284
 
1285
- ### auditableItemStreamEnabled?
1285
+ ### auditableItemStreamEnabled? {#auditableitemstreamenabled}
1286
1286
 
1287
- > `optional` **auditableItemStreamEnabled**: `string`
1287
+ > `optional` **auditableItemStreamEnabled?**: `string`
1288
1288
 
1289
1289
  Is the auditable item stream enabled, defaults to false.
1290
1290
 
@@ -1294,9 +1294,9 @@ Is the auditable item stream enabled, defaults to false.
1294
1294
 
1295
1295
  ***
1296
1296
 
1297
- ### documentManagementEnabled?
1297
+ ### documentManagementEnabled? {#documentmanagementenabled}
1298
1298
 
1299
- > `optional` **documentManagementEnabled**: `string`
1299
+ > `optional` **documentManagementEnabled?**: `string`
1300
1300
 
1301
1301
  Is the document management enabled, defaults to false.
1302
1302
 
@@ -1306,9 +1306,9 @@ Is the document management enabled, defaults to false.
1306
1306
 
1307
1307
  ***
1308
1308
 
1309
- ### synchronisedStorageEnabled?
1309
+ ### synchronisedStorageEnabled? {#synchronisedstorageenabled}
1310
1310
 
1311
- > `optional` **synchronisedStorageEnabled**: `string`
1311
+ > `optional` **synchronisedStorageEnabled?**: `string`
1312
1312
 
1313
1313
  Is the synchronised storage enabled, defaults to false.
1314
1314
 
@@ -1318,9 +1318,9 @@ Is the synchronised storage enabled, defaults to false.
1318
1318
 
1319
1319
  ***
1320
1320
 
1321
- ### synchronisedStorageTrustedUrl?
1321
+ ### synchronisedStorageTrustedUrl? {#synchronisedstoragetrustedurl}
1322
1322
 
1323
- > `optional` **synchronisedStorageTrustedUrl**: `string`
1323
+ > `optional` **synchronisedStorageTrustedUrl?**: `string`
1324
1324
 
1325
1325
  Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
1326
1326
 
@@ -1330,9 +1330,9 @@ Url which points to the api for a trusted synchronised storage node, not require
1330
1330
 
1331
1331
  ***
1332
1332
 
1333
- ### synchronisedStorageVerifiableStorageKeyId?
1333
+ ### synchronisedStorageVerifiableStorageKeyId? {#synchronisedstorageverifiablestoragekeyid}
1334
1334
 
1335
- > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
1335
+ > `optional` **synchronisedStorageVerifiableStorageKeyId?**: `string`
1336
1336
 
1337
1337
  The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
1338
1338
  This only required if using a custom verifiable storage item, otherwise it will default to the network name.
@@ -1343,9 +1343,9 @@ This only required if using a custom verifiable storage item, otherwise it will
1343
1343
 
1344
1344
  ***
1345
1345
 
1346
- ### synchronisedStorageBlobStorageEncryptionKeyId?
1346
+ ### synchronisedStorageBlobStorageEncryptionKeyId? {#synchronisedstorageblobstorageencryptionkeyid}
1347
1347
 
1348
- > `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
1348
+ > `optional` **synchronisedStorageBlobStorageEncryptionKeyId?**: `string`
1349
1349
 
1350
1350
  The key from the vault which is used to encrypt the synchronised storage blobs.
1351
1351
  Only required for trusted nodes, as regular nodes will request from the trusted nodes.
@@ -1357,9 +1357,9 @@ Defaults to synchronised-storage-blob-encryption
1357
1357
 
1358
1358
  ***
1359
1359
 
1360
- ### synchronisedStorageBlobStorageKey?
1360
+ ### synchronisedStorageBlobStorageKey? {#synchronisedstorageblobstoragekey}
1361
1361
 
1362
- > `optional` **synchronisedStorageBlobStorageKey**: `string`
1362
+ > `optional` **synchronisedStorageBlobStorageKey?**: `string`
1363
1363
 
1364
1364
  The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
1365
1365
  Only required for trusted nodes, as regular nodes will not write encrypted data.
@@ -1370,57 +1370,81 @@ Only required for trusted nodes, as regular nodes will not write encrypted data.
1370
1370
 
1371
1371
  ***
1372
1372
 
1373
- ### synchronisedStorageEntityUpdateIntervalMinutes?
1373
+ ### synchronisedStorageEntityUpdateIntervalMinutes? {#synchronisedstorageentityupdateintervalminutes}
1374
1374
 
1375
- > `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
1375
+ > `optional` **synchronisedStorageEntityUpdateIntervalMinutes?**: `string`
1376
1376
 
1377
1377
  How often to check for entity updates in minutes.
1378
1378
 
1379
+ #### Default
1380
+
1381
+ ```ts
1382
+ 5
1383
+ ```
1384
+
1379
1385
  #### Inherited from
1380
1386
 
1381
1387
  [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
1382
1388
 
1383
1389
  ***
1384
1390
 
1385
- ### synchronisedStorageConsolidationIntervalMinutes?
1391
+ ### synchronisedStorageConsolidationIntervalMinutes? {#synchronisedstorageconsolidationintervalminutes}
1386
1392
 
1387
- > `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
1393
+ > `optional` **synchronisedStorageConsolidationIntervalMinutes?**: `string`
1388
1394
 
1389
1395
  Interval to perform consolidation of changesets, only used if this is a trusted node.
1390
1396
 
1397
+ #### Default
1398
+
1399
+ ```ts
1400
+ 60
1401
+ ```
1402
+
1391
1403
  #### Inherited from
1392
1404
 
1393
1405
  [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
1394
1406
 
1395
1407
  ***
1396
1408
 
1397
- ### synchronisedStorageConsolidationBatchSize?
1409
+ ### synchronisedStorageConsolidationBatchSize? {#synchronisedstorageconsolidationbatchsize}
1398
1410
 
1399
- > `optional` **synchronisedStorageConsolidationBatchSize**: `string`
1411
+ > `optional` **synchronisedStorageConsolidationBatchSize?**: `string`
1400
1412
 
1401
1413
  The number of entities to process in a single consolidation batch, only used if this is a trusted node.
1402
1414
 
1415
+ #### Default
1416
+
1417
+ ```ts
1418
+ 1000
1419
+ ```
1420
+
1403
1421
  #### Inherited from
1404
1422
 
1405
1423
  [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
1406
1424
 
1407
1425
  ***
1408
1426
 
1409
- ### synchronisedStorageMaxConsolidations?
1427
+ ### synchronisedStorageMaxConsolidations? {#synchronisedstoragemaxconsolidations}
1410
1428
 
1411
- > `optional` **synchronisedStorageMaxConsolidations**: `string`
1429
+ > `optional` **synchronisedStorageMaxConsolidations?**: `string`
1412
1430
 
1413
1431
  The maximum number of consolidations to keep in storage, only used if this is a trusted node.
1414
1432
 
1433
+ #### Default
1434
+
1435
+ ```ts
1436
+ 5
1437
+ ```
1438
+
1415
1439
  #### Inherited from
1416
1440
 
1417
1441
  [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineServerEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
1418
1442
 
1419
1443
  ***
1420
1444
 
1421
- ### federatedCatalogueEnabled?
1445
+ ### federatedCatalogueEnabled? {#federatedcatalogueenabled}
1422
1446
 
1423
- > `optional` **federatedCatalogueEnabled**: `string`
1447
+ > `optional` **federatedCatalogueEnabled?**: `string`
1424
1448
 
1425
1449
  Is the federated catalogue enabled, defaults to false.
1426
1450
 
@@ -1430,9 +1454,9 @@ Is the federated catalogue enabled, defaults to false.
1430
1454
 
1431
1455
  ***
1432
1456
 
1433
- ### federatedCatalogueFilters?
1457
+ ### federatedCatalogueFilters? {#federatedcataloguefilters}
1434
1458
 
1435
- > `optional` **federatedCatalogueFilters**: `string`
1459
+ > `optional` **federatedCatalogueFilters?**: `string`
1436
1460
 
1437
1461
  Federated catalog filters, command separated list of filters to add.
1438
1462
 
@@ -1442,9 +1466,9 @@ Federated catalog filters, command separated list of filters to add.
1442
1466
 
1443
1467
  ***
1444
1468
 
1445
- ### trustEnabled?
1469
+ ### trustEnabled? {#trustenabled}
1446
1470
 
1447
- > `optional` **trustEnabled**: `string`
1471
+ > `optional` **trustEnabled?**: `string`
1448
1472
 
1449
1473
  Is the trust management enabled, defaults to false.
1450
1474
 
@@ -1454,9 +1478,9 @@ Is the trust management enabled, defaults to false.
1454
1478
 
1455
1479
  ***
1456
1480
 
1457
- ### trustGenerators?
1481
+ ### trustGenerators? {#trustgenerators}
1458
1482
 
1459
- > `optional` **trustGenerators**: `string`
1483
+ > `optional` **trustGenerators?**: `string`
1460
1484
 
1461
1485
  The trust generators to add to the factory, comma separated list.
1462
1486
 
@@ -1466,9 +1490,9 @@ The trust generators to add to the factory, comma separated list.
1466
1490
 
1467
1491
  ***
1468
1492
 
1469
- ### trustVerifiers?
1493
+ ### trustVerifiers? {#trustverifiers}
1470
1494
 
1471
- > `optional` **trustVerifiers**: `string`
1495
+ > `optional` **trustVerifiers?**: `string`
1472
1496
 
1473
1497
  The trust verifiers to add to the factory, comma separated list.
1474
1498
 
@@ -1478,9 +1502,9 @@ The trust verifiers to add to the factory, comma separated list.
1478
1502
 
1479
1503
  ***
1480
1504
 
1481
- ### trustVerificationMethodId?
1505
+ ### trustVerificationMethodId? {#trustverificationmethodid}
1482
1506
 
1483
- > `optional` **trustVerificationMethodId**: `string`
1507
+ > `optional` **trustVerificationMethodId?**: `string`
1484
1508
 
1485
1509
  The verification method to use for trust identities.
1486
1510
  Defaults to trust-assertion.
@@ -1491,9 +1515,9 @@ Defaults to trust-assertion.
1491
1515
 
1492
1516
  ***
1493
1517
 
1494
- ### trustJwtTtlSeconds?
1518
+ ### trustJwtTtlSeconds? {#trustjwtttlseconds}
1495
1519
 
1496
- > `optional` **trustJwtTtlSeconds**: `string`
1520
+ > `optional` **trustJwtTtlSeconds?**: `string`
1497
1521
 
1498
1522
  The trust time to live for generating JWTs.
1499
1523
  Defaults to undefined for never expiring.
@@ -1504,9 +1528,9 @@ Defaults to undefined for never expiring.
1504
1528
 
1505
1529
  ***
1506
1530
 
1507
- ### rightsManagementEnabled?
1531
+ ### rightsManagementEnabled? {#rightsmanagementenabled}
1508
1532
 
1509
- > `optional` **rightsManagementEnabled**: `string`
1533
+ > `optional` **rightsManagementEnabled?**: `string`
1510
1534
 
1511
1535
  Is the rights management enabled, defaults to false.
1512
1536
 
@@ -1516,9 +1540,9 @@ Is the rights management enabled, defaults to false.
1516
1540
 
1517
1541
  ***
1518
1542
 
1519
- ### rightsManagementCallbackPath?
1543
+ ### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
1520
1544
 
1521
- > `optional` **rightsManagementCallbackPath**: `string`
1545
+ > `optional` **rightsManagementCallbackPath?**: `string`
1522
1546
 
1523
1547
  What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
1524
1548
 
@@ -1528,9 +1552,9 @@ What is the callback path for rights management negotiations, will be combined w
1528
1552
 
1529
1553
  ***
1530
1554
 
1531
- ### rightsManagementPolicyInformationSources?
1555
+ ### rightsManagementPolicyInformationSources? {#rightsmanagementpolicyinformationsources}
1532
1556
 
1533
- > `optional` **rightsManagementPolicyInformationSources**: `string`
1557
+ > `optional` **rightsManagementPolicyInformationSources?**: `string`
1534
1558
 
1535
1559
  The rights management policy information sources to add to the factory.
1536
1560
 
@@ -1540,9 +1564,9 @@ The rights management policy information sources to add to the factory.
1540
1564
 
1541
1565
  ***
1542
1566
 
1543
- ### rightsManagementPolicyNegotiators?
1567
+ ### rightsManagementPolicyNegotiators? {#rightsmanagementpolicynegotiators}
1544
1568
 
1545
- > `optional` **rightsManagementPolicyNegotiators**: `string`
1569
+ > `optional` **rightsManagementPolicyNegotiators?**: `string`
1546
1570
 
1547
1571
  The rights management policy negotiators sources to add to the factory.
1548
1572
 
@@ -1552,9 +1576,9 @@ The rights management policy negotiators sources to add to the factory.
1552
1576
 
1553
1577
  ***
1554
1578
 
1555
- ### rightsManagementPolicyRequesters?
1579
+ ### rightsManagementPolicyRequesters? {#rightsmanagementpolicyrequesters}
1556
1580
 
1557
- > `optional` **rightsManagementPolicyRequesters**: `string`
1581
+ > `optional` **rightsManagementPolicyRequesters?**: `string`
1558
1582
 
1559
1583
  The rights management policy requesters to add to the factory.
1560
1584
 
@@ -1564,9 +1588,9 @@ The rights management policy requesters to add to the factory.
1564
1588
 
1565
1589
  ***
1566
1590
 
1567
- ### rightsManagementPolicyExecutionActions?
1591
+ ### rightsManagementPolicyExecutionActions? {#rightsmanagementpolicyexecutionactions}
1568
1592
 
1569
- > `optional` **rightsManagementPolicyExecutionActions**: `string`
1593
+ > `optional` **rightsManagementPolicyExecutionActions?**: `string`
1570
1594
 
1571
1595
  The rights management policy execution actions to add to the factory.
1572
1596
 
@@ -1576,9 +1600,9 @@ The rights management policy execution actions to add to the factory.
1576
1600
 
1577
1601
  ***
1578
1602
 
1579
- ### rightsManagementPolicyEnforcementProcessors?
1603
+ ### rightsManagementPolicyEnforcementProcessors? {#rightsmanagementpolicyenforcementprocessors}
1580
1604
 
1581
- > `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
1605
+ > `optional` **rightsManagementPolicyEnforcementProcessors?**: `string`
1582
1606
 
1583
1607
  The rights management policy enforcement processors to add to the factory.
1584
1608
 
@@ -1588,9 +1612,9 @@ The rights management policy enforcement processors to add to the factory.
1588
1612
 
1589
1613
  ***
1590
1614
 
1591
- ### rightsManagementPolicyArbiters?
1615
+ ### rightsManagementPolicyArbiters? {#rightsmanagementpolicyarbiters}
1592
1616
 
1593
- > `optional` **rightsManagementPolicyArbiters**: `string`
1617
+ > `optional` **rightsManagementPolicyArbiters?**: `string`
1594
1618
 
1595
1619
  The rights management policy arbiters to add to the factory.
1596
1620
 
@@ -1600,9 +1624,9 @@ The rights management policy arbiters to add to the factory.
1600
1624
 
1601
1625
  ***
1602
1626
 
1603
- ### rightsManagementPolicyObligationEnforcers?
1627
+ ### rightsManagementPolicyObligationEnforcers? {#rightsmanagementpolicyobligationenforcers}
1604
1628
 
1605
- > `optional` **rightsManagementPolicyObligationEnforcers**: `string`
1629
+ > `optional` **rightsManagementPolicyObligationEnforcers?**: `string`
1606
1630
 
1607
1631
  The rights management policy obligation enforcers to add to the factory.
1608
1632
 
@@ -1612,9 +1636,9 @@ The rights management policy obligation enforcers to add to the factory.
1612
1636
 
1613
1637
  ***
1614
1638
 
1615
- ### backgroundTasksEnabled?
1639
+ ### backgroundTasksEnabled? {#backgroundtasksenabled}
1616
1640
 
1617
- > `optional` **backgroundTasksEnabled**: `string`
1641
+ > `optional` **backgroundTasksEnabled?**: `string`
1618
1642
 
1619
1643
  Are background tasks enabled, defaults to false.
1620
1644
 
@@ -1624,9 +1648,9 @@ Are background tasks enabled, defaults to false.
1624
1648
 
1625
1649
  ***
1626
1650
 
1627
- ### taskSchedulerEnabled?
1651
+ ### taskSchedulerEnabled? {#taskschedulerenabled}
1628
1652
 
1629
- > `optional` **taskSchedulerEnabled**: `string`
1653
+ > `optional` **taskSchedulerEnabled?**: `string`
1630
1654
 
1631
1655
  Is the task scheduler enabled, defaults to false.
1632
1656
 
@@ -1636,9 +1660,9 @@ Is the task scheduler enabled, defaults to false.
1636
1660
 
1637
1661
  ***
1638
1662
 
1639
- ### dataspaceEnabled?
1663
+ ### dataspaceEnabled? {#dataspaceenabled}
1640
1664
 
1641
- > `optional` **dataspaceEnabled**: `string`
1665
+ > `optional` **dataspaceEnabled?**: `string`
1642
1666
 
1643
1667
  Is the dataspace enabled, defaults to false.
1644
1668
 
@@ -1648,33 +1672,45 @@ Is the dataspace enabled, defaults to false.
1648
1672
 
1649
1673
  ***
1650
1674
 
1651
- ### dataspaceRetainActivityLogsFor?
1675
+ ### dataspaceRetainActivityLogsFor? {#dataspaceretainactivitylogsfor}
1652
1676
 
1653
- > `optional` **dataspaceRetainActivityLogsFor**: `string`
1677
+ > `optional` **dataspaceRetainActivityLogsFor?**: `string`
1654
1678
 
1655
1679
  The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1656
1680
 
1681
+ #### Default
1682
+
1683
+ ```ts
1684
+ 10
1685
+ ```
1686
+
1657
1687
  #### Inherited from
1658
1688
 
1659
1689
  [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataspaceRetainActivityLogsFor`](IEngineServerEnvironmentVariables.md#dataspaceretainactivitylogsfor)
1660
1690
 
1661
1691
  ***
1662
1692
 
1663
- ### dataspaceActivityLogsCleanUpInterval?
1693
+ ### dataspaceActivityLogsCleanUpInterval? {#dataspaceactivitylogscleanupinterval}
1664
1694
 
1665
- > `optional` **dataspaceActivityLogsCleanUpInterval**: `string`
1695
+ > `optional` **dataspaceActivityLogsCleanUpInterval?**: `string`
1666
1696
 
1667
1697
  The interval for cleaning up the activity logs.
1668
1698
 
1699
+ #### Default
1700
+
1701
+ ```ts
1702
+ 60
1703
+ ```
1704
+
1669
1705
  #### Inherited from
1670
1706
 
1671
1707
  [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataspaceActivityLogsCleanUpInterval`](IEngineServerEnvironmentVariables.md#dataspaceactivitylogscleanupinterval)
1672
1708
 
1673
1709
  ***
1674
1710
 
1675
- ### dataspaceDataPlanePath?
1711
+ ### dataspaceDataPlanePath? {#dataspacedataplanepath}
1676
1712
 
1677
- > `optional` **dataspaceDataPlanePath**: `string`
1713
+ > `optional` **dataspaceDataPlanePath?**: `string`
1678
1714
 
1679
1715
  The data plane path for PULL transfers (path only, not full URL).
1680
1716
  Will be combined with public origin from hosting component.
@@ -1687,9 +1723,9 @@ Example: "dataspace/entities"
1687
1723
 
1688
1724
  ***
1689
1725
 
1690
- ### extensions?
1726
+ ### extensions? {#extensions}
1691
1727
 
1692
- > `optional` **extensions**: `string`
1728
+ > `optional` **extensions?**: `string`
1693
1729
 
1694
1730
  A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
1695
1731
 
@@ -1699,9 +1735,9 @@ A comma separated list of additional node extensions to load, the initialiseExte
1699
1735
 
1700
1736
  ***
1701
1737
 
1702
- ### port?
1738
+ ### port? {#port}
1703
1739
 
1704
- > `optional` **port**: `string`
1740
+ > `optional` **port?**: `string`
1705
1741
 
1706
1742
  The port to serve the API from.
1707
1743
 
@@ -1711,9 +1747,9 @@ 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
 
@@ -1723,9 +1759,9 @@ The host to serve the API from.
1723
1759
 
1724
1760
  ***
1725
1761
 
1726
- ### corsOrigins?
1762
+ ### corsOrigins? {#corsorigins}
1727
1763
 
1728
- > `optional` **corsOrigins**: `string`
1764
+ > `optional` **corsOrigins?**: `string`
1729
1765
 
1730
1766
  The CORS origins to allow, defaults to *.
1731
1767
 
@@ -1735,9 +1771,9 @@ The CORS origins to allow, defaults to *.
1735
1771
 
1736
1772
  ***
1737
1773
 
1738
- ### httpMethods?
1774
+ ### httpMethods? {#httpmethods}
1739
1775
 
1740
- > `optional` **httpMethods**: `string`
1776
+ > `optional` **httpMethods?**: `string`
1741
1777
 
1742
1778
  The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
1743
1779
 
@@ -1747,9 +1783,9 @@ The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
1747
1783
 
1748
1784
  ***
1749
1785
 
1750
- ### httpAllowedHeaders?
1786
+ ### httpAllowedHeaders? {#httpallowedheaders}
1751
1787
 
1752
- > `optional` **httpAllowedHeaders**: `string`
1788
+ > `optional` **httpAllowedHeaders?**: `string`
1753
1789
 
1754
1790
  The CORS headers to allow.
1755
1791
 
@@ -1759,9 +1795,9 @@ The CORS headers to allow.
1759
1795
 
1760
1796
  ***
1761
1797
 
1762
- ### httpExposedHeaders?
1798
+ ### httpExposedHeaders? {#httpexposedheaders}
1763
1799
 
1764
- > `optional` **httpExposedHeaders**: `string`
1800
+ > `optional` **httpExposedHeaders?**: `string`
1765
1801
 
1766
1802
  The CORS headers to expose.
1767
1803
 
@@ -1771,9 +1807,9 @@ The CORS headers to expose.
1771
1807
 
1772
1808
  ***
1773
1809
 
1774
- ### publicOrigin?
1810
+ ### publicOrigin? {#publicorigin}
1775
1811
 
1776
- > `optional` **publicOrigin**: `string`
1812
+ > `optional` **publicOrigin?**: `string`
1777
1813
 
1778
1814
  The public origin URL for the API e.g. https://api.example.com:1234
1779
1815
 
@@ -1783,9 +1819,9 @@ The public origin URL for the API e.g. https://api.example.com:1234
1783
1819
 
1784
1820
  ***
1785
1821
 
1786
- ### authAdminProcessorType?
1822
+ ### authAdminProcessorType? {#authadminprocessortype}
1787
1823
 
1788
- > `optional` **authAdminProcessorType**: `string`
1824
+ > `optional` **authAdminProcessorType?**: `string`
1789
1825
 
1790
1826
  The type of auth admin processor to use on the API: entity-storage.
1791
1827
 
@@ -1795,9 +1831,9 @@ The type of auth admin processor to use on the API: entity-storage.
1795
1831
 
1796
1832
  ***
1797
1833
 
1798
- ### authProcessorType?
1834
+ ### authProcessorType? {#authprocessortype}
1799
1835
 
1800
- > `optional` **authProcessorType**: `string`
1836
+ > `optional` **authProcessorType?**: `string`
1801
1837
 
1802
1838
  The type of auth processor to use on the API: entity-storage.
1803
1839
 
@@ -1807,9 +1843,9 @@ The type of auth processor to use on the API: entity-storage.
1807
1843
 
1808
1844
  ***
1809
1845
 
1810
- ### authSigningKeyId?
1846
+ ### authSigningKeyId? {#authsigningkeyid}
1811
1847
 
1812
- > `optional` **authSigningKeyId**: `string`
1848
+ > `optional` **authSigningKeyId?**: `string`
1813
1849
 
1814
1850
  The id of the key in the vault to use for signing in auth operations.
1815
1851
 
@@ -1819,9 +1855,9 @@ The id of the key in the vault to use for signing in auth operations.
1819
1855
 
1820
1856
  ***
1821
1857
 
1822
- ### mimeTypeProcessors?
1858
+ ### mimeTypeProcessors? {#mimetypeprocessors}
1823
1859
 
1824
- > `optional` **mimeTypeProcessors**: `string`
1860
+ > `optional` **mimeTypeProcessors?**: `string`
1825
1861
 
1826
1862
  Additional MIME type processors to include, comma separated.
1827
1863
 
@@ -1831,9 +1867,9 @@ Additional MIME type processors to include, comma separated.
1831
1867
 
1832
1868
  ***
1833
1869
 
1834
- ### routeLoggingIncludeBody?
1870
+ ### routeLoggingIncludeBody? {#routeloggingincludebody}
1835
1871
 
1836
- > `optional` **routeLoggingIncludeBody**: `string`
1872
+ > `optional` **routeLoggingIncludeBody?**: `string`
1837
1873
 
1838
1874
  Include the body in the REST logging output, useful for debugging.
1839
1875
 
@@ -1843,9 +1879,9 @@ Include the body in the REST logging output, useful for debugging.
1843
1879
 
1844
1880
  ***
1845
1881
 
1846
- ### routeLoggingFullBase64?
1882
+ ### routeLoggingFullBase64? {#routeloggingfullbase64}
1847
1883
 
1848
- > `optional` **routeLoggingFullBase64**: `string`
1884
+ > `optional` **routeLoggingFullBase64?**: `string`
1849
1885
 
1850
1886
  Include the full base 64 output in the REST logging output, useful for debugging.
1851
1887
 
@@ -1855,9 +1891,9 @@ Include the full base 64 output in the REST logging output, useful for debugging
1855
1891
 
1856
1892
  ***
1857
1893
 
1858
- ### routeLoggingObfuscateProperties?
1894
+ ### routeLoggingObfuscateProperties? {#routeloggingobfuscateproperties}
1859
1895
 
1860
- > `optional` **routeLoggingObfuscateProperties**: `string`
1896
+ > `optional` **routeLoggingObfuscateProperties?**: `string`
1861
1897
 
1862
1898
  List of properties to obfuscate in the REST logging output, comma separated.
1863
1899
 
@@ -1867,40 +1903,70 @@ List of properties to obfuscate in the REST logging output, comma separated.
1867
1903
 
1868
1904
  ***
1869
1905
 
1870
- ### extensionsMaxSizeMb?
1906
+ ### extensionsMaxSizeMb? {#extensionsmaxsizemb}
1871
1907
 
1872
- > `optional` **extensionsMaxSizeMb**: `number`
1908
+ > `optional` **extensionsMaxSizeMb?**: `number`
1873
1909
 
1874
1910
  Maximum size in MB for HTTPS extensions downloads.
1875
1911
 
1912
+ #### Default
1913
+
1914
+ ```ts
1915
+ 10
1916
+ ```
1917
+
1876
1918
  ***
1877
1919
 
1878
- ### extensionsClearCache?
1920
+ ### extensionsClearCache? {#extensionsclearcache}
1879
1921
 
1880
- > `optional` **extensionsClearCache**: `boolean`
1922
+ > `optional` **extensionsClearCache?**: `boolean`
1881
1923
 
1882
1924
  Whether to clear the extensions cache on startup.
1883
1925
 
1926
+ #### Default
1927
+
1928
+ ```ts
1929
+ false
1930
+ ```
1931
+
1884
1932
  ***
1885
1933
 
1886
- ### extensionsCacheDirectory?
1934
+ ### extensionsCacheDirectory? {#extensionscachedirectory}
1887
1935
 
1888
- > `optional` **extensionsCacheDirectory**: `string`
1936
+ > `optional` **extensionsCacheDirectory?**: `string`
1889
1937
 
1890
1938
  Custom directory for extensions cache storage.
1891
1939
 
1940
+ #### Default
1941
+
1942
+ ```ts
1943
+ ".tmp"
1944
+ ```
1945
+
1892
1946
  ***
1893
1947
 
1894
- ### extensionsCacheTtlHours?
1948
+ ### extensionsCacheTtlHours? {#extensionscachettlhours}
1895
1949
 
1896
- > `optional` **extensionsCacheTtlHours**: `number`
1950
+ > `optional` **extensionsCacheTtlHours?**: `number`
1897
1951
 
1898
1952
  TTL in hours for HTTPS extensions cache.
1899
1953
 
1954
+ #### Default
1955
+
1956
+ ```ts
1957
+ 24
1958
+ ```
1959
+
1900
1960
  ***
1901
1961
 
1902
- ### extensionsForceRefresh?
1962
+ ### extensionsForceRefresh? {#extensionsforcerefresh}
1903
1963
 
1904
- > `optional` **extensionsForceRefresh**: `boolean`
1964
+ > `optional` **extensionsForceRefresh?**: `boolean`
1905
1965
 
1906
1966
  Force refresh of all cached extensions.
1967
+
1968
+ #### Default
1969
+
1970
+ ```ts
1971
+ false
1972
+ ```