@redocly/config 0.11.0 → 0.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/default-theme-config-schema.d.ts +56 -8
- package/lib/ex-theme-config-schemas.d.ts +51 -4
- package/lib/ex-theme-config-schemas.js +25 -7
- package/lib/product-override-schema.d.ts +84 -12
- package/lib/root-config-schema.d.ts +231 -64
- package/lib/root-config-schema.js +8 -0
- package/lib/types.d.ts +2 -1
- package/lib-esm/default-theme-config-schema.d.ts +56 -8
- package/lib-esm/ex-theme-config-schemas.d.ts +51 -4
- package/lib-esm/ex-theme-config-schemas.js +24 -6
- package/lib-esm/product-override-schema.d.ts +84 -12
- package/lib-esm/root-config-schema.d.ts +231 -64
- package/lib-esm/root-config-schema.js +8 -0
- package/lib-esm/types.d.ts +2 -1
- package/package.json +1 -1
|
@@ -547,9 +547,7 @@ export declare const apiConfigSchema: {
|
|
|
547
547
|
readonly type: "string";
|
|
548
548
|
};
|
|
549
549
|
};
|
|
550
|
-
};
|
|
551
|
-
* @deprecated Should use `plugins` instead
|
|
552
|
-
*/
|
|
550
|
+
};
|
|
553
551
|
};
|
|
554
552
|
};
|
|
555
553
|
readonly colors: {
|
|
@@ -1065,6 +1063,9 @@ export declare const apiConfigSchema: {
|
|
|
1065
1063
|
readonly maxHeight: {
|
|
1066
1064
|
readonly type: "string";
|
|
1067
1065
|
};
|
|
1066
|
+
/**
|
|
1067
|
+
* @deprecated Should use `plugins` instead
|
|
1068
|
+
*/
|
|
1068
1069
|
readonly maxWidth: {
|
|
1069
1070
|
readonly type: "string";
|
|
1070
1071
|
};
|
|
@@ -2513,9 +2514,7 @@ export declare const apiConfigSchema: {
|
|
|
2513
2514
|
readonly type: "string";
|
|
2514
2515
|
};
|
|
2515
2516
|
};
|
|
2516
|
-
};
|
|
2517
|
-
* @deprecated Should use `plugins` instead
|
|
2518
|
-
*/
|
|
2517
|
+
};
|
|
2519
2518
|
};
|
|
2520
2519
|
};
|
|
2521
2520
|
readonly colors: {
|
|
@@ -3031,6 +3030,9 @@ export declare const apiConfigSchema: {
|
|
|
3031
3030
|
readonly maxHeight: {
|
|
3032
3031
|
readonly type: "string";
|
|
3033
3032
|
};
|
|
3033
|
+
/**
|
|
3034
|
+
* @deprecated Should use `plugins` instead
|
|
3035
|
+
*/
|
|
3034
3036
|
readonly maxWidth: {
|
|
3035
3037
|
readonly type: "string";
|
|
3036
3038
|
};
|
|
@@ -5291,9 +5293,7 @@ export declare const redoclyConfigSchema: {
|
|
|
5291
5293
|
readonly type: "string";
|
|
5292
5294
|
};
|
|
5293
5295
|
};
|
|
5294
|
-
};
|
|
5295
|
-
* @deprecated Should use `plugins` instead
|
|
5296
|
-
*/
|
|
5296
|
+
};
|
|
5297
5297
|
};
|
|
5298
5298
|
};
|
|
5299
5299
|
readonly colors: {
|
|
@@ -5809,6 +5809,9 @@ export declare const redoclyConfigSchema: {
|
|
|
5809
5809
|
readonly maxHeight: {
|
|
5810
5810
|
readonly type: "string";
|
|
5811
5811
|
};
|
|
5812
|
+
/**
|
|
5813
|
+
* @deprecated Should use `plugins` instead
|
|
5814
|
+
*/
|
|
5812
5815
|
readonly maxWidth: {
|
|
5813
5816
|
readonly type: "string";
|
|
5814
5817
|
};
|
|
@@ -7257,9 +7260,7 @@ export declare const redoclyConfigSchema: {
|
|
|
7257
7260
|
readonly type: "string";
|
|
7258
7261
|
};
|
|
7259
7262
|
};
|
|
7260
|
-
};
|
|
7261
|
-
* @deprecated Should use `plugins` instead
|
|
7262
|
-
*/
|
|
7263
|
+
};
|
|
7263
7264
|
};
|
|
7264
7265
|
};
|
|
7265
7266
|
readonly colors: {
|
|
@@ -7775,6 +7776,9 @@ export declare const redoclyConfigSchema: {
|
|
|
7775
7776
|
readonly maxHeight: {
|
|
7776
7777
|
readonly type: "string";
|
|
7777
7778
|
};
|
|
7779
|
+
/**
|
|
7780
|
+
* @deprecated Should use `plugins` instead
|
|
7781
|
+
*/
|
|
7778
7782
|
readonly maxWidth: {
|
|
7779
7783
|
readonly type: "string";
|
|
7780
7784
|
};
|
|
@@ -9644,6 +9648,13 @@ export declare const redoclyConfigSchema: {
|
|
|
9644
9648
|
readonly type: "object";
|
|
9645
9649
|
readonly additionalProperties: true;
|
|
9646
9650
|
};
|
|
9651
|
+
readonly metadataGlobs: {
|
|
9652
|
+
readonly type: "object";
|
|
9653
|
+
readonly additionalProperties: {
|
|
9654
|
+
readonly type: "object";
|
|
9655
|
+
readonly additionalProperties: true;
|
|
9656
|
+
};
|
|
9657
|
+
};
|
|
9647
9658
|
readonly ignore: {
|
|
9648
9659
|
readonly type: "array";
|
|
9649
9660
|
readonly items: {
|
|
@@ -10348,6 +10359,34 @@ export declare const redoclyConfigSchema: {
|
|
|
10348
10359
|
readonly hide: {
|
|
10349
10360
|
readonly type: "boolean";
|
|
10350
10361
|
};
|
|
10362
|
+
readonly engine: {
|
|
10363
|
+
readonly type: "string";
|
|
10364
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
10365
|
+
readonly default: "flexsearch";
|
|
10366
|
+
};
|
|
10367
|
+
readonly facets: {
|
|
10368
|
+
readonly type: "array";
|
|
10369
|
+
readonly items: {
|
|
10370
|
+
readonly type: "object";
|
|
10371
|
+
readonly required: readonly ["name", "field", "type"];
|
|
10372
|
+
readonly properties: {
|
|
10373
|
+
readonly name: {
|
|
10374
|
+
readonly type: "string";
|
|
10375
|
+
};
|
|
10376
|
+
readonly field: {
|
|
10377
|
+
readonly type: "string";
|
|
10378
|
+
};
|
|
10379
|
+
readonly type: {
|
|
10380
|
+
readonly type: "string";
|
|
10381
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
10382
|
+
};
|
|
10383
|
+
readonly isTop: {
|
|
10384
|
+
readonly type: "boolean";
|
|
10385
|
+
};
|
|
10386
|
+
};
|
|
10387
|
+
readonly additionalProperties: false;
|
|
10388
|
+
};
|
|
10389
|
+
};
|
|
10351
10390
|
readonly placement: {
|
|
10352
10391
|
readonly type: "string";
|
|
10353
10392
|
readonly default: "navbar";
|
|
@@ -10377,10 +10416,6 @@ export declare const redoclyConfigSchema: {
|
|
|
10377
10416
|
readonly required: readonly ["page"];
|
|
10378
10417
|
};
|
|
10379
10418
|
};
|
|
10380
|
-
readonly fuzzy: {
|
|
10381
|
-
readonly type: "boolean";
|
|
10382
|
-
readonly default: false;
|
|
10383
|
-
};
|
|
10384
10419
|
};
|
|
10385
10420
|
readonly additionalProperties: false;
|
|
10386
10421
|
};
|
|
@@ -10622,9 +10657,7 @@ export declare const redoclyConfigSchema: {
|
|
|
10622
10657
|
readonly type: "string";
|
|
10623
10658
|
};
|
|
10624
10659
|
};
|
|
10625
|
-
};
|
|
10626
|
-
* @deprecated Should use `plugins` instead
|
|
10627
|
-
*/
|
|
10660
|
+
};
|
|
10628
10661
|
};
|
|
10629
10662
|
};
|
|
10630
10663
|
readonly colors: {
|
|
@@ -11140,6 +11173,9 @@ export declare const redoclyConfigSchema: {
|
|
|
11140
11173
|
readonly maxHeight: {
|
|
11141
11174
|
readonly type: "string";
|
|
11142
11175
|
};
|
|
11176
|
+
/**
|
|
11177
|
+
* @deprecated Should use `plugins` instead
|
|
11178
|
+
*/
|
|
11143
11179
|
readonly maxWidth: {
|
|
11144
11180
|
readonly type: "string";
|
|
11145
11181
|
};
|
|
@@ -12704,9 +12740,7 @@ export declare const redoclyConfigSchema: {
|
|
|
12704
12740
|
readonly type: "object";
|
|
12705
12741
|
readonly properties: {
|
|
12706
12742
|
readonly includeInDevelopment: {
|
|
12707
|
-
readonly type: "boolean";
|
|
12708
|
-
* @deprecated properties moved to the root of the config
|
|
12709
|
-
*/
|
|
12743
|
+
readonly type: "boolean";
|
|
12710
12744
|
};
|
|
12711
12745
|
readonly trackingId: {
|
|
12712
12746
|
readonly type: "string";
|
|
@@ -13894,6 +13928,34 @@ export declare const redoclyConfigSchema: {
|
|
|
13894
13928
|
readonly hide: {
|
|
13895
13929
|
readonly type: "boolean";
|
|
13896
13930
|
};
|
|
13931
|
+
readonly engine: {
|
|
13932
|
+
readonly type: "string";
|
|
13933
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
13934
|
+
readonly default: "flexsearch";
|
|
13935
|
+
};
|
|
13936
|
+
readonly facets: {
|
|
13937
|
+
readonly type: "array";
|
|
13938
|
+
readonly items: {
|
|
13939
|
+
readonly type: "object";
|
|
13940
|
+
readonly required: readonly ["name", "field", "type"];
|
|
13941
|
+
readonly properties: {
|
|
13942
|
+
readonly name: {
|
|
13943
|
+
readonly type: "string";
|
|
13944
|
+
};
|
|
13945
|
+
readonly field: {
|
|
13946
|
+
readonly type: "string";
|
|
13947
|
+
};
|
|
13948
|
+
readonly type: {
|
|
13949
|
+
readonly type: "string";
|
|
13950
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
13951
|
+
};
|
|
13952
|
+
readonly isTop: {
|
|
13953
|
+
readonly type: "boolean";
|
|
13954
|
+
};
|
|
13955
|
+
};
|
|
13956
|
+
readonly additionalProperties: false;
|
|
13957
|
+
};
|
|
13958
|
+
};
|
|
13897
13959
|
readonly placement: {
|
|
13898
13960
|
readonly type: "string";
|
|
13899
13961
|
readonly default: "navbar";
|
|
@@ -13923,10 +13985,6 @@ export declare const redoclyConfigSchema: {
|
|
|
13923
13985
|
readonly required: readonly ["page"];
|
|
13924
13986
|
};
|
|
13925
13987
|
};
|
|
13926
|
-
readonly fuzzy: {
|
|
13927
|
-
readonly type: "boolean";
|
|
13928
|
-
readonly default: false;
|
|
13929
|
-
};
|
|
13930
13988
|
};
|
|
13931
13989
|
readonly additionalProperties: false;
|
|
13932
13990
|
};
|
|
@@ -14168,9 +14226,7 @@ export declare const redoclyConfigSchema: {
|
|
|
14168
14226
|
readonly type: "string";
|
|
14169
14227
|
};
|
|
14170
14228
|
};
|
|
14171
|
-
};
|
|
14172
|
-
* @deprecated Should use `plugins` instead
|
|
14173
|
-
*/
|
|
14229
|
+
};
|
|
14174
14230
|
};
|
|
14175
14231
|
};
|
|
14176
14232
|
readonly colors: {
|
|
@@ -14686,6 +14742,9 @@ export declare const redoclyConfigSchema: {
|
|
|
14686
14742
|
readonly maxHeight: {
|
|
14687
14743
|
readonly type: "string";
|
|
14688
14744
|
};
|
|
14745
|
+
/**
|
|
14746
|
+
* @deprecated Should use `plugins` instead
|
|
14747
|
+
*/
|
|
14689
14748
|
readonly maxWidth: {
|
|
14690
14749
|
readonly type: "string";
|
|
14691
14750
|
};
|
|
@@ -16250,9 +16309,7 @@ export declare const redoclyConfigSchema: {
|
|
|
16250
16309
|
readonly type: "object";
|
|
16251
16310
|
readonly properties: {
|
|
16252
16311
|
readonly includeInDevelopment: {
|
|
16253
|
-
readonly type: "boolean";
|
|
16254
|
-
* @deprecated properties moved to the root of the config
|
|
16255
|
-
*/
|
|
16312
|
+
readonly type: "boolean";
|
|
16256
16313
|
};
|
|
16257
16314
|
readonly trackingId: {
|
|
16258
16315
|
readonly type: "string";
|
|
@@ -17306,6 +17363,33 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
17306
17363
|
hide: {
|
|
17307
17364
|
type: "boolean";
|
|
17308
17365
|
};
|
|
17366
|
+
engine: {
|
|
17367
|
+
enum: ("flexsearch" | "typesense")[];
|
|
17368
|
+
type: "string";
|
|
17369
|
+
};
|
|
17370
|
+
facets: {
|
|
17371
|
+
items: {
|
|
17372
|
+
properties: {
|
|
17373
|
+
name: {
|
|
17374
|
+
type: "string";
|
|
17375
|
+
};
|
|
17376
|
+
type: {
|
|
17377
|
+
enum: ("multi-select" | "select" | "tags")[];
|
|
17378
|
+
type: "string";
|
|
17379
|
+
};
|
|
17380
|
+
field: {
|
|
17381
|
+
type: "string";
|
|
17382
|
+
};
|
|
17383
|
+
isTop: {
|
|
17384
|
+
type: "boolean";
|
|
17385
|
+
};
|
|
17386
|
+
};
|
|
17387
|
+
additionalProperties: false;
|
|
17388
|
+
type: "object";
|
|
17389
|
+
required: ("name" | "type" | "field")[];
|
|
17390
|
+
};
|
|
17391
|
+
type: "array";
|
|
17392
|
+
};
|
|
17309
17393
|
placement: {
|
|
17310
17394
|
type: "string";
|
|
17311
17395
|
};
|
|
@@ -17333,9 +17417,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
17333
17417
|
};
|
|
17334
17418
|
type: "array";
|
|
17335
17419
|
};
|
|
17336
|
-
fuzzy: {
|
|
17337
|
-
type: "boolean";
|
|
17338
|
-
};
|
|
17339
17420
|
};
|
|
17340
17421
|
additionalProperties: false;
|
|
17341
17422
|
type: "object";
|
|
@@ -23494,6 +23575,13 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
23494
23575
|
type: "object";
|
|
23495
23576
|
required: "defaultLocale"[];
|
|
23496
23577
|
};
|
|
23578
|
+
metadataGlobs: {
|
|
23579
|
+
additionalProperties: {
|
|
23580
|
+
additionalProperties: true;
|
|
23581
|
+
type: "object";
|
|
23582
|
+
};
|
|
23583
|
+
type: "object";
|
|
23584
|
+
};
|
|
23497
23585
|
ignore: {
|
|
23498
23586
|
items: {
|
|
23499
23587
|
type: "string";
|
|
@@ -23761,6 +23849,33 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
23761
23849
|
hide: {
|
|
23762
23850
|
type: "boolean";
|
|
23763
23851
|
};
|
|
23852
|
+
engine: {
|
|
23853
|
+
enum: ("flexsearch" | "typesense")[];
|
|
23854
|
+
type: "string";
|
|
23855
|
+
};
|
|
23856
|
+
facets: {
|
|
23857
|
+
items: {
|
|
23858
|
+
properties: {
|
|
23859
|
+
name: {
|
|
23860
|
+
type: "string";
|
|
23861
|
+
};
|
|
23862
|
+
type: {
|
|
23863
|
+
enum: ("multi-select" | "select" | "tags")[];
|
|
23864
|
+
type: "string";
|
|
23865
|
+
};
|
|
23866
|
+
field: {
|
|
23867
|
+
type: "string";
|
|
23868
|
+
};
|
|
23869
|
+
isTop: {
|
|
23870
|
+
type: "boolean";
|
|
23871
|
+
};
|
|
23872
|
+
};
|
|
23873
|
+
additionalProperties: false;
|
|
23874
|
+
type: "object";
|
|
23875
|
+
required: ("name" | "type" | "field")[];
|
|
23876
|
+
};
|
|
23877
|
+
type: "array";
|
|
23878
|
+
};
|
|
23764
23879
|
placement: {
|
|
23765
23880
|
type: "string";
|
|
23766
23881
|
};
|
|
@@ -23788,9 +23903,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
23788
23903
|
};
|
|
23789
23904
|
type: "array";
|
|
23790
23905
|
};
|
|
23791
|
-
fuzzy: {
|
|
23792
|
-
type: "boolean";
|
|
23793
|
-
};
|
|
23794
23906
|
};
|
|
23795
23907
|
additionalProperties: false;
|
|
23796
23908
|
type: "object";
|
|
@@ -26266,9 +26378,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
26266
26378
|
readonly type: "string";
|
|
26267
26379
|
};
|
|
26268
26380
|
};
|
|
26269
|
-
};
|
|
26270
|
-
* @deprecated Should use `plugins` instead
|
|
26271
|
-
*/
|
|
26381
|
+
};
|
|
26272
26382
|
};
|
|
26273
26383
|
};
|
|
26274
26384
|
readonly colors: {
|
|
@@ -26784,6 +26894,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
26784
26894
|
readonly maxHeight: {
|
|
26785
26895
|
readonly type: "string";
|
|
26786
26896
|
};
|
|
26897
|
+
/**
|
|
26898
|
+
* @deprecated Should use `plugins` instead
|
|
26899
|
+
*/
|
|
26787
26900
|
readonly maxWidth: {
|
|
26788
26901
|
readonly type: "string";
|
|
26789
26902
|
};
|
|
@@ -28232,9 +28345,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
28232
28345
|
readonly type: "string";
|
|
28233
28346
|
};
|
|
28234
28347
|
};
|
|
28235
|
-
};
|
|
28236
|
-
* @deprecated Should use `plugins` instead
|
|
28237
|
-
*/
|
|
28348
|
+
};
|
|
28238
28349
|
};
|
|
28239
28350
|
};
|
|
28240
28351
|
readonly colors: {
|
|
@@ -28750,6 +28861,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
28750
28861
|
readonly maxHeight: {
|
|
28751
28862
|
readonly type: "string";
|
|
28752
28863
|
};
|
|
28864
|
+
/**
|
|
28865
|
+
* @deprecated Should use `plugins` instead
|
|
28866
|
+
*/
|
|
28753
28867
|
readonly maxWidth: {
|
|
28754
28868
|
readonly type: "string";
|
|
28755
28869
|
};
|
|
@@ -30619,6 +30733,13 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
30619
30733
|
readonly type: "object";
|
|
30620
30734
|
readonly additionalProperties: true;
|
|
30621
30735
|
};
|
|
30736
|
+
readonly metadataGlobs: {
|
|
30737
|
+
readonly type: "object";
|
|
30738
|
+
readonly additionalProperties: {
|
|
30739
|
+
readonly type: "object";
|
|
30740
|
+
readonly additionalProperties: true;
|
|
30741
|
+
};
|
|
30742
|
+
};
|
|
30622
30743
|
readonly ignore: {
|
|
30623
30744
|
readonly type: "array";
|
|
30624
30745
|
readonly items: {
|
|
@@ -31323,6 +31444,34 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
31323
31444
|
readonly hide: {
|
|
31324
31445
|
readonly type: "boolean";
|
|
31325
31446
|
};
|
|
31447
|
+
readonly engine: {
|
|
31448
|
+
readonly type: "string";
|
|
31449
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
31450
|
+
readonly default: "flexsearch";
|
|
31451
|
+
};
|
|
31452
|
+
readonly facets: {
|
|
31453
|
+
readonly type: "array";
|
|
31454
|
+
readonly items: {
|
|
31455
|
+
readonly type: "object";
|
|
31456
|
+
readonly required: readonly ["name", "field", "type"];
|
|
31457
|
+
readonly properties: {
|
|
31458
|
+
readonly name: {
|
|
31459
|
+
readonly type: "string";
|
|
31460
|
+
};
|
|
31461
|
+
readonly field: {
|
|
31462
|
+
readonly type: "string";
|
|
31463
|
+
};
|
|
31464
|
+
readonly type: {
|
|
31465
|
+
readonly type: "string";
|
|
31466
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
31467
|
+
};
|
|
31468
|
+
readonly isTop: {
|
|
31469
|
+
readonly type: "boolean";
|
|
31470
|
+
};
|
|
31471
|
+
};
|
|
31472
|
+
readonly additionalProperties: false;
|
|
31473
|
+
};
|
|
31474
|
+
};
|
|
31326
31475
|
readonly placement: {
|
|
31327
31476
|
readonly type: "string";
|
|
31328
31477
|
readonly default: "navbar";
|
|
@@ -31352,10 +31501,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
31352
31501
|
readonly required: readonly ["page"];
|
|
31353
31502
|
};
|
|
31354
31503
|
};
|
|
31355
|
-
readonly fuzzy: {
|
|
31356
|
-
readonly type: "boolean";
|
|
31357
|
-
readonly default: false;
|
|
31358
|
-
};
|
|
31359
31504
|
};
|
|
31360
31505
|
readonly additionalProperties: false;
|
|
31361
31506
|
};
|
|
@@ -31597,9 +31742,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
31597
31742
|
readonly type: "string";
|
|
31598
31743
|
};
|
|
31599
31744
|
};
|
|
31600
|
-
};
|
|
31601
|
-
* @deprecated Should use `plugins` instead
|
|
31602
|
-
*/
|
|
31745
|
+
};
|
|
31603
31746
|
};
|
|
31604
31747
|
};
|
|
31605
31748
|
readonly colors: {
|
|
@@ -32115,6 +32258,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
32115
32258
|
readonly maxHeight: {
|
|
32116
32259
|
readonly type: "string";
|
|
32117
32260
|
};
|
|
32261
|
+
/**
|
|
32262
|
+
* @deprecated Should use `plugins` instead
|
|
32263
|
+
*/
|
|
32118
32264
|
readonly maxWidth: {
|
|
32119
32265
|
readonly type: "string";
|
|
32120
32266
|
};
|
|
@@ -33679,9 +33825,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
33679
33825
|
readonly type: "object";
|
|
33680
33826
|
readonly properties: {
|
|
33681
33827
|
readonly includeInDevelopment: {
|
|
33682
|
-
readonly type: "boolean";
|
|
33683
|
-
* @deprecated properties moved to the root of the config
|
|
33684
|
-
*/
|
|
33828
|
+
readonly type: "boolean";
|
|
33685
33829
|
};
|
|
33686
33830
|
readonly trackingId: {
|
|
33687
33831
|
readonly type: "string";
|
|
@@ -34869,6 +35013,34 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34869
35013
|
readonly hide: {
|
|
34870
35014
|
readonly type: "boolean";
|
|
34871
35015
|
};
|
|
35016
|
+
readonly engine: {
|
|
35017
|
+
readonly type: "string";
|
|
35018
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
35019
|
+
readonly default: "flexsearch";
|
|
35020
|
+
};
|
|
35021
|
+
readonly facets: {
|
|
35022
|
+
readonly type: "array";
|
|
35023
|
+
readonly items: {
|
|
35024
|
+
readonly type: "object";
|
|
35025
|
+
readonly required: readonly ["name", "field", "type"];
|
|
35026
|
+
readonly properties: {
|
|
35027
|
+
readonly name: {
|
|
35028
|
+
readonly type: "string";
|
|
35029
|
+
};
|
|
35030
|
+
readonly field: {
|
|
35031
|
+
readonly type: "string";
|
|
35032
|
+
};
|
|
35033
|
+
readonly type: {
|
|
35034
|
+
readonly type: "string";
|
|
35035
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
35036
|
+
};
|
|
35037
|
+
readonly isTop: {
|
|
35038
|
+
readonly type: "boolean";
|
|
35039
|
+
};
|
|
35040
|
+
};
|
|
35041
|
+
readonly additionalProperties: false;
|
|
35042
|
+
};
|
|
35043
|
+
};
|
|
34872
35044
|
readonly placement: {
|
|
34873
35045
|
readonly type: "string";
|
|
34874
35046
|
readonly default: "navbar";
|
|
@@ -34898,10 +35070,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34898
35070
|
readonly required: readonly ["page"];
|
|
34899
35071
|
};
|
|
34900
35072
|
};
|
|
34901
|
-
readonly fuzzy: {
|
|
34902
|
-
readonly type: "boolean";
|
|
34903
|
-
readonly default: false;
|
|
34904
|
-
};
|
|
34905
35073
|
};
|
|
34906
35074
|
readonly additionalProperties: false;
|
|
34907
35075
|
};
|
|
@@ -35143,9 +35311,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35143
35311
|
readonly type: "string";
|
|
35144
35312
|
};
|
|
35145
35313
|
};
|
|
35146
|
-
};
|
|
35147
|
-
* @deprecated Should use `plugins` instead
|
|
35148
|
-
*/
|
|
35314
|
+
};
|
|
35149
35315
|
};
|
|
35150
35316
|
};
|
|
35151
35317
|
readonly colors: {
|
|
@@ -35661,6 +35827,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35661
35827
|
readonly maxHeight: {
|
|
35662
35828
|
readonly type: "string";
|
|
35663
35829
|
};
|
|
35830
|
+
/**
|
|
35831
|
+
* @deprecated Should use `plugins` instead
|
|
35832
|
+
*/
|
|
35664
35833
|
readonly maxWidth: {
|
|
35665
35834
|
readonly type: "string";
|
|
35666
35835
|
};
|
|
@@ -37225,9 +37394,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
37225
37394
|
readonly type: "object";
|
|
37226
37395
|
readonly properties: {
|
|
37227
37396
|
readonly includeInDevelopment: {
|
|
37228
|
-
readonly type: "boolean";
|
|
37229
|
-
* @deprecated properties moved to the root of the config
|
|
37230
|
-
*/
|
|
37397
|
+
readonly type: "boolean";
|
|
37231
37398
|
};
|
|
37232
37399
|
readonly trackingId: {
|
|
37233
37400
|
readonly type: "string";
|
|
@@ -129,6 +129,13 @@ const metadataConfigSchema = {
|
|
|
129
129
|
type: 'object',
|
|
130
130
|
additionalProperties: true,
|
|
131
131
|
};
|
|
132
|
+
const metadataGlobsConfigSchema = {
|
|
133
|
+
type: 'object',
|
|
134
|
+
additionalProperties: {
|
|
135
|
+
type: 'object',
|
|
136
|
+
additionalProperties: true,
|
|
137
|
+
},
|
|
138
|
+
};
|
|
132
139
|
export const seoConfigSchema = {
|
|
133
140
|
type: 'object',
|
|
134
141
|
properties: {
|
|
@@ -342,6 +349,7 @@ export const redoclyConfigSchema = {
|
|
|
342
349
|
i18n: l10nConfigSchema,
|
|
343
350
|
l10n: l10nConfigSchema,
|
|
344
351
|
metadata: metadataConfigSchema,
|
|
352
|
+
metadataGlobs: metadataGlobsConfigSchema,
|
|
345
353
|
ignore: {
|
|
346
354
|
type: 'array',
|
|
347
355
|
items: {
|
package/lib-esm/types.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import type { productConfigOverrideSchema } from './product-override-schema';
|
|
|
4
4
|
import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
|
|
5
5
|
import type { RedocConfigTypes } from './redoc-types';
|
|
6
6
|
import type { GraphQLConfigTypes } from './graphql-types';
|
|
7
|
-
import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema } from './ex-theme-config-schemas';
|
|
7
|
+
import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from './ex-theme-config-schemas';
|
|
8
8
|
/**
|
|
9
9
|
* @deprecated left for backwards compatibility. To be removed in Realm 1.0
|
|
10
10
|
*/
|
|
@@ -24,6 +24,7 @@ export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchem
|
|
|
24
24
|
export type CatalogConfig = FromSchema<typeof catalogSchema>;
|
|
25
25
|
export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
|
|
26
26
|
export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
|
|
27
|
+
export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
|
|
27
28
|
export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
|
|
28
29
|
/**
|
|
29
30
|
* @deprecated properties moved to the root of the config
|