forked from SchemaStore/schemastore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
app-config.json
4776 lines (4776 loc) · 194 KB
/
app-config.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/app-config.json",
"title": "Application Configuration Schema",
"type": "object",
"description": "This is the schema describing the structure of the app-config.yaml configuration file.",
"properties": {
"app": {
"type": "object",
"description": "Generic frontend configuration.",
"properties": {
"baseUrl": {
"type": "string",
"description": "The public absolute root URL that the frontend."
},
"title": {
"type": "string",
"description": "The title of the app, as shown in the Backstage web interface."
},
"datadogRum": {
"type": "object",
"description": "Datadog RUM events configuration",
"properties": {
"env": {
"type": "string",
"description": "Environment for Datadog RUM events"
},
"clientToken": {
"type": "string",
"description": "clientToken for Datadog RUM events"
},
"applicationId": {
"type": "string",
"description": "applicationId for Datadog RUM events"
},
"site": {
"type": "string",
"description": "site for Datadog RUM events"
}
}
},
"listen": {
"type": "object",
"description": "Listening configuration for local development",
"properties": {
"host": {
"type": "string",
"description": "The host that the frontend should be bound to. Only used for local development."
},
"port": {
"type": "number",
"description": "The port that the frontend should be bound to. Only used for local development."
}
}
},
"https": {
"type": "object",
"description": "Only used for local development. The https object is passed to webpack in order to enable using https on localhost.",
"properties": {
"certificate": {
"type": "object",
"description": "Parent object containing certificate and the private key",
"properties": {
"key": {
"type": "string",
"description": "Https Certificate private key. Use $file to load in a file"
},
"cert": {
"type": "string",
"description": "Https Certificate. Use $file to load in a file"
}
}
}
}
},
"support": {
"description": "Information about support of this Backstage instance and how to contact the integrator team.",
"type": "object",
"properties": {
"url": {
"description": "The primary support url.",
"type": "string"
},
"items": {
"description": "A list of categorized support item groupings.",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"description": "The title of the support item grouping.",
"type": "string"
},
"icon": {
"description": "An optional icon for the support item grouping.",
"type": "string"
},
"links": {
"description": "A list of support links for the Backstage instance inside this grouping.",
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
}
}
}
}
}
},
"extensions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"attachTo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "string"
}
}
},
"disabled": {
"type": "boolean"
},
"config": {}
}
},
{
"type": "boolean"
}
]
}
},
{
"type": "string"
}
]
}
},
"analytics": {
"type": "object",
"properties": {
"ga": {
"type": "object",
"properties": {
"trackingId": {
"description": "Google Analytics tracking ID, e.g. UA-000000-0",
"type": "string"
},
"scriptSrc": {
"description": "URL to Google Analytics analytics.js script\nDefaults to fetching from GA source (eg. https://www.google-analytics.com/analytics.js)",
"type": "string"
},
"identity": {
"description": "Controls how the identityApi is used when sending data to GA:\n\n- `disabled`: (Default) Explicitly prevents a user's identity from\n being used when capturing events in GA.\n- `optional`: Pageviews and hits are forwarded to GA as they happen\n and only include user identity metadata once known. Guarantees\n that hits are captured for all sessions, even if no sign in\n occurs, but may result in dropped hits in User ID views.\n- `required`: All pageviews and hits are deferred until an identity\n is known. Guarantees that all data sent to GA correlates to a user\n identity, but prevents GA from receiving events for sessions in\n which a user does not sign in. An `identityApi` instance must be\n passed during instantiation when set to this value.",
"enum": ["disabled", "optional", "required"],
"type": "string"
},
"virtualSearchPageView": {
"description": "Controls whether to send virtual pageviews on `search` events.\nCan be used to enable Site Search in GA.",
"type": "object",
"properties": {
"mode": {
"description": "- `disabled`: (Default) no virtual pageviews are sent\n- `only`: Sends virtual pageview _instead_ of the `search` event\n- `both`: Sends both the `search` event _and_ the virtual pageview",
"enum": ["both", "disabled", "only"],
"type": "string"
},
"mountPath": {
"description": "Specifies on which path the main Search page is mounted.\nDefaults to `/search`.",
"type": "string"
},
"searchQuery": {
"description": "Specifies which query param is used for the term query in the virtual pageview URL.\nDefaults to `query`.",
"type": "string"
},
"categoryQuery": {
"description": "Specifies which query param is used for the category query in the virtual pageview URL.\nSkipped by default.",
"type": "string"
}
}
},
"debug": {
"description": "Whether or not to log analytics debug statements to the console.\nDefaults to false.",
"type": "boolean"
},
"testMode": {
"description": "Prevents events from actually being sent when set to true. Defaults\nto false.",
"type": "boolean"
},
"customDimensionsMetrics": {
"description": "Configuration informing how Analytics Context and Event Attributes\nmetadata will be captured in Google Analytics.",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "Specifies whether the corresponding metadata should be collected\nas a Google Analytics custom dimension or custom metric.",
"enum": ["dimension", "metric"],
"type": "string"
},
"index": {
"description": "The index of the Google Analytics custom dimension or metric that\nthe metadata should be written to.",
"type": "number"
},
"source": {
"description": "Specifies whether the desired value lives as an attribute on the\nAnalytics Context or the Event's Attributes.",
"enum": ["attributes", "context"],
"type": "string"
},
"key": {
"description": "The property of the context or attributes that should be captured.\ne.g. to capture the Plugin ID associated with an event, the source\nshould be set to \"context\" and the key should be set to pluginId.",
"type": "string"
}
}
}
}
}
},
"ga4": {
"type": "object",
"properties": {
"measurementId": {
"description": "Google Analytics measurement ID, e.g. G-000000-0",
"type": "string"
},
"identity": {
"description": "Controls how the identityApi is used when sending data to GA:\n\n- `disabled`: (Default) Explicitly prevents a user's identity from\n being used when capturing events in GA.\n- `optional`: Pageviews and hits are forwarded to GA as they happen\n and only include user identity metadata once known. Guarantees\n that hits are captured for all sessions, even if no sign in\n occurs, but may result in dropped hits in User ID views.\n- `required`: All pageviews and hits are deferred until an identity\n is known. Guarantees that all data sent to GA correlates to a user\n identity, but prevents GA from receiving events for sessions in\n which a user does not sign in. An `identityApi` instance must be\n passed during instantiation when set to this value.",
"enum": ["disabled", "optional", "required"],
"type": "string"
},
"debug": {
"description": "Whether to log analytics debug statements to the console.\nDefaults to false.",
"type": "boolean"
},
"testMode": {
"description": "Prevents events from actually being sent when set to true. Defaults\nto false.",
"type": "boolean"
},
"contentGrouping": {
"description": "Content grouping definition\nFeature available in Google Analytics 4\nMore information https://support.google.com/analytics/answer/11523339?hl=en\nData can be grouped by pluginId, routeRef\nTakes 24 hours before metrics shows up in GA dashboard\nSpecifies the dimension to be used for content grouping\nCan be one of pluginId, extension or routeRef",
"enum": ["extension", "pluginId", "routeRef"],
"type": "string"
},
"allowedContexts": {
"description": "Configuration informing how Analytics Context and Event Attributes\nmetadata will be captured in Google Analytics.\nContexts that will be sent as parameters in the event.\ncontext-name will be prefixed by c_, for example, pluginId will be c_pluginId in the event.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "array",
"items": [
{
"type": "string",
"enum": ["*"]
}
],
"minItems": 1,
"maxItems": 1
}
]
},
"allowedAttributes": {
"description": "Attributes that will be sent as parameters in the event\nattribute-name will be prefixed by a_, for example , testAttribute will be c_testAttribute in the event.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "array",
"items": [
{
"type": "string",
"enum": ["*"]
}
],
"minItems": 1,
"maxItems": 1
}
]
}
}
},
"newRelic": {
"type": "object",
"properties": {
"endpoint": {
"description": "Data ingestion endpoint to use, either bam.eu01.nr-data.net (EU) or bam.nr-data.net (US)",
"enum": ["bam.eu01.nr-data.net", "bam.nr-data.net"],
"type": "string"
},
"accountId": {
"description": "New Relic Account ID, e.g. 1234567",
"type": "string"
},
"applicationId": {
"description": "New Relic Application ID, e.g. 987654321",
"type": "string"
},
"licenseKey": {
"description": "New Relic License Key, e.g. NRJS-12a3456bc78de9123f4",
"type": "string"
},
"distributedTracingEnabled": {
"description": "Whether to enabled distributed tracing, defaults to false",
"type": "boolean"
},
"cookiesEnabled": {
"description": "Whether to enabled tracing of cookies, defaults to false",
"type": "boolean"
}
}
}
}
},
"packageName": {
"description": "The name of the app package (in most Backstage repositories, this is the\n\"name\" field in `packages/app/package.json`) that content should be served\nfrom. The same app package should be added as a dependency to the backend\npackage in order for it to be accessible at runtime.\n\nIn a typical setup with a single app package, this will default to 'app'.",
"type": "string"
},
"disableConfigInjection": {
"description": "Disables the configuration injection. This can be useful if you're running in an environment\nwith a read-only filesystem, or for some other reason don't want configuration to be injected.\n\nNote that this will cause the configuration used when building the app bundle to be used, unless\na separate configuration loading strategy is set up.\n\nThis also disables configuration injection though `APP_CONFIG_` environment variables.",
"type": "boolean"
},
"disableStaticFallbackCache": {
"description": "By default the app backend plugin will cache previously deployed static assets in the database.\nIf you disable this, it is recommended to set a `staticFallbackHandler` instead.",
"type": "boolean"
}
}
},
"allure": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
}
}
},
"firehydrant": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
}
}
},
"lighthouse": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
}
}
},
"nomad": {
"type": "object",
"properties": {
"addr": {
"type": "string",
"description": "The address of the Nomad API. See: https://developer.hashicorp.com/nomad/api-docs#addressing-and-ports"
},
"token": {
"type": "string",
"description": "The token to call the Nomad API with. See: https://developer.hashicorp.com/nomad/api-docs#authentication"
}
}
},
"auth": {
"type": "object",
"description": "Configuration that provides information on available configured authentication providers.",
"properties": {
"providers": {
"type": "object",
"description": "The available auth-provider options and attributes",
"additionalProperties": {
"type": "object",
"additionalProperties": true
},
"properties": {
"google": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"callbackUrl": {
"type": "string"
}
}
}
},
"github": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"callbackUrl": {
"type": "string"
},
"enterpriseInstanceUrl": {
"type": "string"
}
}
}
},
"saml": {
"type": "object",
"properties": {
"entryPoint": {
"type": "string"
},
"logoutUrl": {
"type": "string"
},
"issuer": {
"type": "string"
},
"cert": {
"type": "string"
},
"audience": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"authnContext": {
"type": "array",
"items": {
"type": "string"
}
},
"identifierFormat": {
"type": "string"
},
"decryptionPvk": {
"type": "string"
},
"signatureAlgorithm": {
"enum": ["sha256", "sha512"],
"type": "string"
},
"digestAlgorithm": {
"type": "string"
},
"acceptedClockSkewMs": {
"type": "number"
}
}
},
"okta": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"audience": {
"type": "string"
},
"authServerId": {
"type": "string"
},
"idp": {
"type": "string"
},
"callbackUrl": {
"type": "string"
}
}
}
},
"oauth2": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"authorizationUrl": {
"type": "string"
},
"tokenUrl": {
"type": "string"
},
"scope": {
"type": "string"
},
"disableRefresh": {
"type": "boolean"
},
"includeBasicAuth": {
"type": "boolean"
}
}
}
},
"oidc": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"callbackUrl": {
"type": "string"
},
"metadataUrl": {
"type": "string"
},
"tokenEndpointAuthMethod": {
"type": "string"
},
"tokenSignedResponseAlg": {
"type": "string"
},
"scope": {
"type": "string"
},
"prompt": {
"type": "string"
}
}
}
},
"auth0": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"domain": {
"type": "string"
},
"callbackUrl": {
"type": "string"
},
"audience": {
"type": "string"
},
"connection": {
"type": "string"
},
"connectionScope": {
"type": "string"
}
}
}
},
"microsoft": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"callbackUrl": {
"type": "string"
}
}
}
},
"onelogin": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuer": {
"type": "string"
},
"callbackUrl": {
"type": "string"
}
}
}
},
"awsalb": {
"type": "object",
"properties": {
"iss": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"cfaccess": {
"type": "object",
"properties": {
"teamName": {
"type": "string"
}
}
},
"gcpIap": {
"description": "Configuration for the Google Cloud Platform Identity-Aware Proxy (IAP) auth provider.",
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"audience": {
"description": "The audience to use when validating incoming JWT tokens.\nSee https://backstage.io/docs/auth/google/gcp-iap-auth",
"type": "string"
},
"jwtHeader": {
"description": "The name of the header to read the JWT token from, defaults to `'x-goog-iap-jwt-assertion'`.",
"type": "string"
}
}
}
},
"gitlab": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"audience": {
"type": "string"
},
"callbackUrl": {
"type": "string"
}
}
}
}
}
},
"environment": {
"description": "The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.\ndefault value: 'development'\noptional values: 'development' | 'production'",
"type": "string"
},
"session": {
"type": "object",
"properties": {
"secret": {
"description": "The secret attribute of session object.",
"type": "string"
}
}
},
"identityTokenAlgorithm": {
"description": "JWS \"alg\" (Algorithm) Header Parameter value. Defaults to ES256.\nMust match one of the algorithms defined for IdentityClient.\nWhen setting a different algorithm, check if the `key` field\nof the `signing_keys` table can fit the length of the generated keys.\nIf not, add a knex migration file in the migrations folder.\nMore info on supported algorithms: https://github.com/panva/jose",
"type": "string"
},
"keyStore": {
"description": "To control how to store JWK data in auth-backend",
"type": "object",
"properties": {
"provider": {
"enum": ["database", "firestore", "memory"],
"type": "string"
},
"firestore": {
"type": "object",
"properties": {
"host": {
"description": "The host to connect to",
"type": "string"
},
"port": {
"description": "The port to connect to",
"type": "number"
},
"ssl": {
"description": "Whether to use SSL when connecting.",
"type": "boolean"
},
"projectId": {
"description": "The Google Cloud Project ID",
"type": "string"
},
"keyFilename": {
"description": "Local file containing the Service Account credentials.\nYou can omit this value to automatically read from\nGOOGLE_APPLICATION_CREDENTIALS env which is useful for local\ndevelopment.",
"type": "string"
},
"path": {
"description": "The path to use for the collection. Defaults to 'sessions'",
"type": "string"
},
"timeout": {
"description": "Timeout used for database operations. Defaults to 10000ms",
"type": "number"
}
}
}
}
}
}
},
"backend": {
"type": "object",
"description": "Generic backend configuration.",
"properties": {
"auth": {
"description": "Backend configuration for when request authentication is enabled",
"type": "object",
"properties": {
"keys": {
"description": "Keys shared by all backends for signing and validating backend tokens.",
"type": "array",
"items": {
"type": "object",
"properties": {
"secret": {
"description": "Secret for generating tokens. Should be a base64 string, recommended\nlength is 24 bytes.",
"type": "string"
}
}
}
}
}
},
"baseUrl": {
"type": "string",
"description": "The public absolute root URL that the backend is reachable at, from the browser's perspective."
},
"listen": {
"description": "Address that the backend should listen to.",
"anyOf": [
{
"type": "object",
"properties": {
"host": {
"description": "Address of the interface that the backend should bind to.",
"type": "string"
},
"port": {
"description": "Port that the backend should listen to.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
}
}
},
{
"type": "string"
}
]
},
"https": {
"description": "HTTPS configuration for the backend. If omitted the backend will serve HTTP.\n\nSetting this to `true` will cause self-signed certificates to be generated, which\ncan be useful for local development or other non-production scenarios.",
"anyOf": [
{
"type": "object",
"properties": {
"certificate": {
"description": "Certificate configuration",
"type": "object",
"properties": {
"cert": {
"description": "PEM encoded certificate. Use $file to load in a file",
"type": "string"
},
"key": {
"description": "PEM encoded certificate key. Use $file to load in a file.",
"type": "string"
}
}
}
}
},
{
"enum": [true],
"type": "boolean"
}
]
},
"database": {
"description": "Database connection configuration, select base database type using the `client` field",
"type": "object",
"properties": {
"client": {
"description": "Default database client to use",
"enum": ["better-sqlite3", "pg", "sqlite3"],
"type": "string"
},
"connection": {
"description": "Base database connection string, or object with individual connection properties",
"anyOf": [
{
"type": "object",
"additionalProperties": {},
"properties": {
"password": {
"description": "Password that belongs to the client User",
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"prefix": {
"description": "Database name prefix override",
"type": "string"
},
"ensureExists": {
"description": "Whether to ensure the given database exists by creating it if it does not.\nDefaults to true if unspecified.",
"type": "boolean"
},
"pluginDivisionMode": {
"description": "How plugins databases are managed/divided in the provided database instance.\n\n`database` -> Plugins are each given their own database to manage their schemas/tables.\n\n`schema` -> Plugins will be given their own schema (in the specified/default database)\n to manage their tables.\n\nNOTE: Currently only supported by the `pg` client.",
"default": "database",
"enum": ["database", "schema"],
"type": "string"
},
"role": {
"description": "Configures the ownership of newly created schemas in pg databases.",
"type": "string"
},
"knexConfig": {
"description": "Arbitrary config object to pass to knex when initializing\n(https://knexjs.org/#Installation-client). Most notable is the debug\nand asyncStackTraces booleans",
"type": "object",
"additionalProperties": true
},
"plugin": {
"description": "Plugin specific database configuration and client override",
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"client": {
"description": "Database client override",
"enum": ["better-sqlite3", "pg", "sqlite3"],
"type": "string"
},
"connection": {
"description": "Database connection string or Knex object override",
"anyOf": [
{
"type": "object",
"properties": {},
"additionalProperties": true
},
{
"type": "string"
}
]
},
"ensureExists": {
"description": "Whether to ensure the given database exists by creating it if it does not.\nDefaults to base config if unspecified.",
"type": "boolean"
},
"knexConfig": {
"description": "Arbitrary config object to pass to knex when initializing\n(https://knexjs.org/#Installation-client). Most notable is the\ndebug and asyncStackTraces booleans.\n\nThis is merged recursively into the base knexConfig",
"type": "object",
"additionalProperties": true
},
"role": {
"description": "Configures the ownership of newly created schemas in pg databases.",
"type": "string"
}
}
}
}
}
},
"cache": {
"description": "Cache connection configuration, select cache type using the `store` field",
"anyOf": [
{
"type": "object",
"properties": {
"store": {
"type": "string",
"enum": ["memory"]
}
}
},
{
"type": "object",
"properties": {
"store": {
"type": "string",
"enum": ["redis"]
},
"connection": {
"description": "A redis connection string in the form `redis://user:pass@host:port`.",
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"store": {
"type": "string",
"enum": ["memcache"]
},
"connection": {
"description": "A memcache connection string in the form `user:pass@host:port`.",
"type": "string"
}
}
}
]
},
"cors": {
"type": "object",
"properties": {
"origin": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"methods": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{