@redocly/config 0.10.1 → 0.11.0-rc.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 +48 -8
- package/lib/default-theme-config-schema.js +1 -1
- package/lib/ex-theme-config-schemas.d.ts +43 -4
- package/lib/ex-theme-config-schemas.js +23 -7
- package/lib/product-override-schema.d.ts +72 -12
- package/lib/root-config-schema.d.ts +158 -38
- package/lib/types.d.ts +2 -1
- package/lib-esm/apis-config.schema.d.ts +34513 -0
- package/lib-esm/apis-config.schema.js +390 -0
- package/lib-esm/default-theme-config-schema.d.ts +48 -8
- package/lib-esm/default-theme-config-schema.js +1 -1
- package/lib-esm/ex-theme-config-schemas.d.ts +43 -4
- package/lib-esm/ex-theme-config-schemas.js +22 -6
- package/lib-esm/product-override-schema.d.ts +72 -12
- package/lib-esm/root-config-schema.d.ts +225 -105
- package/lib-esm/root-config-types.d.ts +22809 -0
- package/lib-esm/root-config-types.js +383 -0
- package/lib-esm/types.d.ts +2 -1
- package/package.json +1 -1
|
@@ -696,6 +696,30 @@ export declare const themeConfigSchema: {
|
|
|
696
696
|
readonly hide: {
|
|
697
697
|
readonly type: "boolean";
|
|
698
698
|
};
|
|
699
|
+
readonly engine: {
|
|
700
|
+
readonly type: "string";
|
|
701
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
702
|
+
readonly default: "flexsearch";
|
|
703
|
+
};
|
|
704
|
+
readonly facets: {
|
|
705
|
+
readonly type: "array";
|
|
706
|
+
readonly items: {
|
|
707
|
+
readonly type: "object";
|
|
708
|
+
readonly required: readonly ["name", "field", "type"];
|
|
709
|
+
readonly properties: {
|
|
710
|
+
readonly name: {
|
|
711
|
+
readonly type: "string";
|
|
712
|
+
};
|
|
713
|
+
readonly field: {
|
|
714
|
+
readonly type: "string";
|
|
715
|
+
};
|
|
716
|
+
readonly type: {
|
|
717
|
+
readonly type: "string";
|
|
718
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
719
|
+
};
|
|
720
|
+
};
|
|
721
|
+
};
|
|
722
|
+
};
|
|
699
723
|
readonly placement: {
|
|
700
724
|
readonly type: "string";
|
|
701
725
|
readonly default: "navbar";
|
|
@@ -725,10 +749,6 @@ export declare const themeConfigSchema: {
|
|
|
725
749
|
readonly required: readonly ["page"];
|
|
726
750
|
};
|
|
727
751
|
};
|
|
728
|
-
readonly fuzzy: {
|
|
729
|
-
readonly type: "boolean";
|
|
730
|
-
readonly default: false;
|
|
731
|
-
};
|
|
732
752
|
};
|
|
733
753
|
readonly additionalProperties: false;
|
|
734
754
|
};
|
|
@@ -4238,6 +4258,30 @@ export declare const closedThemeConfigSchema: {
|
|
|
4238
4258
|
readonly hide: {
|
|
4239
4259
|
readonly type: "boolean";
|
|
4240
4260
|
};
|
|
4261
|
+
readonly engine: {
|
|
4262
|
+
readonly type: "string";
|
|
4263
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
4264
|
+
readonly default: "flexsearch";
|
|
4265
|
+
};
|
|
4266
|
+
readonly facets: {
|
|
4267
|
+
readonly type: "array";
|
|
4268
|
+
readonly items: {
|
|
4269
|
+
readonly type: "object";
|
|
4270
|
+
readonly required: readonly ["name", "field", "type"];
|
|
4271
|
+
readonly properties: {
|
|
4272
|
+
readonly name: {
|
|
4273
|
+
readonly type: "string";
|
|
4274
|
+
};
|
|
4275
|
+
readonly field: {
|
|
4276
|
+
readonly type: "string";
|
|
4277
|
+
};
|
|
4278
|
+
readonly type: {
|
|
4279
|
+
readonly type: "string";
|
|
4280
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
4281
|
+
};
|
|
4282
|
+
};
|
|
4283
|
+
};
|
|
4284
|
+
};
|
|
4241
4285
|
readonly placement: {
|
|
4242
4286
|
readonly type: "string";
|
|
4243
4287
|
readonly default: "navbar";
|
|
@@ -4267,10 +4311,6 @@ export declare const closedThemeConfigSchema: {
|
|
|
4267
4311
|
readonly required: readonly ["page"];
|
|
4268
4312
|
};
|
|
4269
4313
|
};
|
|
4270
|
-
readonly fuzzy: {
|
|
4271
|
-
readonly type: "boolean";
|
|
4272
|
-
readonly default: false;
|
|
4273
|
-
};
|
|
4274
4314
|
};
|
|
4275
4315
|
readonly additionalProperties: false;
|
|
4276
4316
|
};
|
|
@@ -38,5 +38,5 @@ exports.themeConfigSchema = {
|
|
|
38
38
|
},
|
|
39
39
|
additionalProperties: true,
|
|
40
40
|
};
|
|
41
|
-
exports.closedThemeConfigSchema = Object.assign(Object.assign({}, exports.themeConfigSchema), { additionalProperties: false });
|
|
41
|
+
exports.closedThemeConfigSchema = Object.assign(Object.assign({}, exports.themeConfigSchema), { additionalProperties: false }); //
|
|
42
42
|
//# sourceMappingURL=default-theme-config-schema.js.map
|
|
@@ -187,6 +187,25 @@ export declare const productConfigSchema: {
|
|
|
187
187
|
readonly additionalProperties: false;
|
|
188
188
|
readonly required: readonly ["name", "folder"];
|
|
189
189
|
};
|
|
190
|
+
export declare const searchFacetsConfigSchema: {
|
|
191
|
+
readonly type: "array";
|
|
192
|
+
readonly items: {
|
|
193
|
+
readonly type: "object";
|
|
194
|
+
readonly required: readonly ["name", "field", "type"];
|
|
195
|
+
readonly properties: {
|
|
196
|
+
readonly name: {
|
|
197
|
+
readonly type: "string";
|
|
198
|
+
};
|
|
199
|
+
readonly field: {
|
|
200
|
+
readonly type: "string";
|
|
201
|
+
};
|
|
202
|
+
readonly type: {
|
|
203
|
+
readonly type: "string";
|
|
204
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
205
|
+
};
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
};
|
|
190
209
|
export declare const logoConfigSchema: {
|
|
191
210
|
readonly type: "object";
|
|
192
211
|
readonly properties: {
|
|
@@ -773,6 +792,30 @@ export declare const searchConfigSchema: {
|
|
|
773
792
|
readonly hide: {
|
|
774
793
|
readonly type: "boolean";
|
|
775
794
|
};
|
|
795
|
+
readonly engine: {
|
|
796
|
+
readonly type: "string";
|
|
797
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
798
|
+
readonly default: "flexsearch";
|
|
799
|
+
};
|
|
800
|
+
readonly facets: {
|
|
801
|
+
readonly type: "array";
|
|
802
|
+
readonly items: {
|
|
803
|
+
readonly type: "object";
|
|
804
|
+
readonly required: readonly ["name", "field", "type"];
|
|
805
|
+
readonly properties: {
|
|
806
|
+
readonly name: {
|
|
807
|
+
readonly type: "string";
|
|
808
|
+
};
|
|
809
|
+
readonly field: {
|
|
810
|
+
readonly type: "string";
|
|
811
|
+
};
|
|
812
|
+
readonly type: {
|
|
813
|
+
readonly type: "string";
|
|
814
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
815
|
+
};
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
};
|
|
776
819
|
readonly placement: {
|
|
777
820
|
readonly type: "string";
|
|
778
821
|
readonly default: "navbar";
|
|
@@ -802,10 +845,6 @@ export declare const searchConfigSchema: {
|
|
|
802
845
|
readonly required: readonly ["page"];
|
|
803
846
|
};
|
|
804
847
|
};
|
|
805
|
-
readonly fuzzy: {
|
|
806
|
-
readonly type: "boolean";
|
|
807
|
-
readonly default: false;
|
|
808
|
-
};
|
|
809
848
|
};
|
|
810
849
|
readonly additionalProperties: false;
|
|
811
850
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
|
|
3
|
+
exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFacetsConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
|
|
4
4
|
const redoc_config_schema_1 = require("./redoc-config-schema");
|
|
5
5
|
const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
|
|
6
6
|
const hideConfigSchema = {
|
|
@@ -80,7 +80,22 @@ exports.productConfigSchema = {
|
|
|
80
80
|
additionalProperties: false,
|
|
81
81
|
required: ['name', 'folder'],
|
|
82
82
|
};
|
|
83
|
-
|
|
83
|
+
exports.searchFacetsConfigSchema = {
|
|
84
|
+
type: 'array',
|
|
85
|
+
items: {
|
|
86
|
+
type: 'object',
|
|
87
|
+
required: ['name', 'field', 'type'],
|
|
88
|
+
properties: {
|
|
89
|
+
name: { type: 'string' },
|
|
90
|
+
field: { type: 'string' },
|
|
91
|
+
type: {
|
|
92
|
+
type: 'string',
|
|
93
|
+
enum: ['input', 'multi-select', 'select', 'tags', 'switch', 'radio', 'checkbox'],
|
|
94
|
+
},
|
|
95
|
+
},
|
|
96
|
+
},
|
|
97
|
+
};
|
|
98
|
+
const searchSuggestedPageSchema = {
|
|
84
99
|
type: 'object',
|
|
85
100
|
properties: {
|
|
86
101
|
page: { type: 'string' },
|
|
@@ -158,7 +173,11 @@ exports.linksConfigSchema = {
|
|
|
158
173
|
};
|
|
159
174
|
exports.searchConfigSchema = {
|
|
160
175
|
type: 'object',
|
|
161
|
-
properties: Object.assign({
|
|
176
|
+
properties: Object.assign({ engine: {
|
|
177
|
+
type: 'string',
|
|
178
|
+
enum: ['flexsearch', 'typesense'],
|
|
179
|
+
default: 'flexsearch',
|
|
180
|
+
}, facets: exports.searchFacetsConfigSchema, placement: {
|
|
162
181
|
type: 'string',
|
|
163
182
|
default: 'navbar',
|
|
164
183
|
}, shortcuts: {
|
|
@@ -167,10 +186,7 @@ exports.searchConfigSchema = {
|
|
|
167
186
|
default: ['/'],
|
|
168
187
|
}, suggestedPages: {
|
|
169
188
|
type: 'array',
|
|
170
|
-
items:
|
|
171
|
-
}, fuzzy: {
|
|
172
|
-
type: 'boolean',
|
|
173
|
-
default: false,
|
|
189
|
+
items: searchSuggestedPageSchema,
|
|
174
190
|
} }, hideConfigSchema.properties),
|
|
175
191
|
additionalProperties: false,
|
|
176
192
|
};
|
|
@@ -421,6 +421,30 @@ export declare const productThemeOverrideSchema: {
|
|
|
421
421
|
readonly hide: {
|
|
422
422
|
readonly type: "boolean";
|
|
423
423
|
};
|
|
424
|
+
readonly engine: {
|
|
425
|
+
readonly type: "string";
|
|
426
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
427
|
+
readonly default: "flexsearch";
|
|
428
|
+
};
|
|
429
|
+
readonly facets: {
|
|
430
|
+
readonly type: "array";
|
|
431
|
+
readonly items: {
|
|
432
|
+
readonly type: "object";
|
|
433
|
+
readonly required: readonly ["name", "field", "type"];
|
|
434
|
+
readonly properties: {
|
|
435
|
+
readonly name: {
|
|
436
|
+
readonly type: "string";
|
|
437
|
+
};
|
|
438
|
+
readonly field: {
|
|
439
|
+
readonly type: "string";
|
|
440
|
+
};
|
|
441
|
+
readonly type: {
|
|
442
|
+
readonly type: "string";
|
|
443
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
444
|
+
};
|
|
445
|
+
};
|
|
446
|
+
};
|
|
447
|
+
};
|
|
424
448
|
readonly placement: {
|
|
425
449
|
readonly type: "string";
|
|
426
450
|
readonly default: "navbar";
|
|
@@ -450,10 +474,6 @@ export declare const productThemeOverrideSchema: {
|
|
|
450
474
|
readonly required: readonly ["page"];
|
|
451
475
|
};
|
|
452
476
|
};
|
|
453
|
-
readonly fuzzy: {
|
|
454
|
-
readonly type: "boolean";
|
|
455
|
-
readonly default: false;
|
|
456
|
-
};
|
|
457
477
|
};
|
|
458
478
|
readonly additionalProperties: false;
|
|
459
479
|
};
|
|
@@ -6758,6 +6778,30 @@ export declare const productConfigOverrideSchema: {
|
|
|
6758
6778
|
readonly hide: {
|
|
6759
6779
|
readonly type: "boolean";
|
|
6760
6780
|
};
|
|
6781
|
+
readonly engine: {
|
|
6782
|
+
readonly type: "string";
|
|
6783
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
6784
|
+
readonly default: "flexsearch";
|
|
6785
|
+
};
|
|
6786
|
+
readonly facets: {
|
|
6787
|
+
readonly type: "array";
|
|
6788
|
+
readonly items: {
|
|
6789
|
+
readonly type: "object";
|
|
6790
|
+
readonly required: readonly ["name", "field", "type"];
|
|
6791
|
+
readonly properties: {
|
|
6792
|
+
readonly name: {
|
|
6793
|
+
readonly type: "string";
|
|
6794
|
+
};
|
|
6795
|
+
readonly field: {
|
|
6796
|
+
readonly type: "string";
|
|
6797
|
+
};
|
|
6798
|
+
readonly type: {
|
|
6799
|
+
readonly type: "string";
|
|
6800
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
6801
|
+
};
|
|
6802
|
+
};
|
|
6803
|
+
};
|
|
6804
|
+
};
|
|
6761
6805
|
readonly placement: {
|
|
6762
6806
|
readonly type: "string";
|
|
6763
6807
|
readonly default: "navbar";
|
|
@@ -6787,10 +6831,6 @@ export declare const productConfigOverrideSchema: {
|
|
|
6787
6831
|
readonly required: readonly ["page"];
|
|
6788
6832
|
};
|
|
6789
6833
|
};
|
|
6790
|
-
readonly fuzzy: {
|
|
6791
|
-
readonly type: "boolean";
|
|
6792
|
-
readonly default: false;
|
|
6793
|
-
};
|
|
6794
6834
|
};
|
|
6795
6835
|
readonly additionalProperties: false;
|
|
6796
6836
|
};
|
|
@@ -9118,6 +9158,30 @@ export declare const productConfigOverrideSchema: {
|
|
|
9118
9158
|
readonly hide: {
|
|
9119
9159
|
readonly type: "boolean";
|
|
9120
9160
|
};
|
|
9161
|
+
readonly engine: {
|
|
9162
|
+
readonly type: "string";
|
|
9163
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
9164
|
+
readonly default: "flexsearch";
|
|
9165
|
+
};
|
|
9166
|
+
readonly facets: {
|
|
9167
|
+
readonly type: "array";
|
|
9168
|
+
readonly items: {
|
|
9169
|
+
readonly type: "object";
|
|
9170
|
+
readonly required: readonly ["name", "field", "type"];
|
|
9171
|
+
readonly properties: {
|
|
9172
|
+
readonly name: {
|
|
9173
|
+
readonly type: "string";
|
|
9174
|
+
};
|
|
9175
|
+
readonly field: {
|
|
9176
|
+
readonly type: "string";
|
|
9177
|
+
};
|
|
9178
|
+
readonly type: {
|
|
9179
|
+
readonly type: "string";
|
|
9180
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
9181
|
+
};
|
|
9182
|
+
};
|
|
9183
|
+
};
|
|
9184
|
+
};
|
|
9121
9185
|
readonly placement: {
|
|
9122
9186
|
readonly type: "string";
|
|
9123
9187
|
readonly default: "navbar";
|
|
@@ -9147,10 +9211,6 @@ export declare const productConfigOverrideSchema: {
|
|
|
9147
9211
|
readonly required: readonly ["page"];
|
|
9148
9212
|
};
|
|
9149
9213
|
};
|
|
9150
|
-
readonly fuzzy: {
|
|
9151
|
-
readonly type: "boolean";
|
|
9152
|
-
readonly default: false;
|
|
9153
|
-
};
|
|
9154
9214
|
};
|
|
9155
9215
|
readonly additionalProperties: false;
|
|
9156
9216
|
};
|
|
@@ -10185,7 +10185,9 @@ export declare const redoclyConfigSchema: {
|
|
|
10185
10185
|
};
|
|
10186
10186
|
};
|
|
10187
10187
|
};
|
|
10188
|
-
readonly additionalProperties: false;
|
|
10188
|
+
readonly additionalProperties: false; /**
|
|
10189
|
+
* @deprecated left for backwards compatibility
|
|
10190
|
+
*/
|
|
10189
10191
|
};
|
|
10190
10192
|
readonly links: {
|
|
10191
10193
|
readonly type: "array";
|
|
@@ -10348,6 +10350,30 @@ export declare const redoclyConfigSchema: {
|
|
|
10348
10350
|
readonly hide: {
|
|
10349
10351
|
readonly type: "boolean";
|
|
10350
10352
|
};
|
|
10353
|
+
readonly engine: {
|
|
10354
|
+
readonly type: "string";
|
|
10355
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
10356
|
+
readonly default: "flexsearch";
|
|
10357
|
+
};
|
|
10358
|
+
readonly facets: {
|
|
10359
|
+
readonly type: "array";
|
|
10360
|
+
readonly items: {
|
|
10361
|
+
readonly type: "object";
|
|
10362
|
+
readonly required: readonly ["name", "field", "type"];
|
|
10363
|
+
readonly properties: {
|
|
10364
|
+
readonly name: {
|
|
10365
|
+
readonly type: "string";
|
|
10366
|
+
};
|
|
10367
|
+
readonly field: {
|
|
10368
|
+
readonly type: "string";
|
|
10369
|
+
};
|
|
10370
|
+
readonly type: {
|
|
10371
|
+
readonly type: "string";
|
|
10372
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
10373
|
+
};
|
|
10374
|
+
};
|
|
10375
|
+
};
|
|
10376
|
+
};
|
|
10351
10377
|
readonly placement: {
|
|
10352
10378
|
readonly type: "string";
|
|
10353
10379
|
readonly default: "navbar";
|
|
@@ -10377,10 +10403,6 @@ export declare const redoclyConfigSchema: {
|
|
|
10377
10403
|
readonly required: readonly ["page"];
|
|
10378
10404
|
};
|
|
10379
10405
|
};
|
|
10380
|
-
readonly fuzzy: {
|
|
10381
|
-
readonly type: "boolean";
|
|
10382
|
-
readonly default: false;
|
|
10383
|
-
};
|
|
10384
10406
|
};
|
|
10385
10407
|
readonly additionalProperties: false;
|
|
10386
10408
|
};
|
|
@@ -12704,9 +12726,7 @@ export declare const redoclyConfigSchema: {
|
|
|
12704
12726
|
readonly type: "object";
|
|
12705
12727
|
readonly properties: {
|
|
12706
12728
|
readonly includeInDevelopment: {
|
|
12707
|
-
readonly type: "boolean";
|
|
12708
|
-
* @deprecated properties moved to the root of the config
|
|
12709
|
-
*/
|
|
12729
|
+
readonly type: "boolean";
|
|
12710
12730
|
};
|
|
12711
12731
|
readonly trackingId: {
|
|
12712
12732
|
readonly type: "string";
|
|
@@ -13727,7 +13747,9 @@ export declare const redoclyConfigSchema: {
|
|
|
13727
13747
|
};
|
|
13728
13748
|
};
|
|
13729
13749
|
};
|
|
13730
|
-
readonly additionalProperties: false;
|
|
13750
|
+
readonly additionalProperties: false; /**
|
|
13751
|
+
* @deprecated left for backwards compatibility
|
|
13752
|
+
*/
|
|
13731
13753
|
};
|
|
13732
13754
|
readonly links: {
|
|
13733
13755
|
readonly type: "array";
|
|
@@ -13890,6 +13912,30 @@ export declare const redoclyConfigSchema: {
|
|
|
13890
13912
|
readonly hide: {
|
|
13891
13913
|
readonly type: "boolean";
|
|
13892
13914
|
};
|
|
13915
|
+
readonly engine: {
|
|
13916
|
+
readonly type: "string";
|
|
13917
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
13918
|
+
readonly default: "flexsearch";
|
|
13919
|
+
};
|
|
13920
|
+
readonly facets: {
|
|
13921
|
+
readonly type: "array";
|
|
13922
|
+
readonly items: {
|
|
13923
|
+
readonly type: "object";
|
|
13924
|
+
readonly required: readonly ["name", "field", "type"];
|
|
13925
|
+
readonly properties: {
|
|
13926
|
+
readonly name: {
|
|
13927
|
+
readonly type: "string";
|
|
13928
|
+
};
|
|
13929
|
+
readonly field: {
|
|
13930
|
+
readonly type: "string";
|
|
13931
|
+
};
|
|
13932
|
+
readonly type: {
|
|
13933
|
+
readonly type: "string";
|
|
13934
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
13935
|
+
};
|
|
13936
|
+
};
|
|
13937
|
+
};
|
|
13938
|
+
};
|
|
13893
13939
|
readonly placement: {
|
|
13894
13940
|
readonly type: "string";
|
|
13895
13941
|
readonly default: "navbar";
|
|
@@ -13919,10 +13965,6 @@ export declare const redoclyConfigSchema: {
|
|
|
13919
13965
|
readonly required: readonly ["page"];
|
|
13920
13966
|
};
|
|
13921
13967
|
};
|
|
13922
|
-
readonly fuzzy: {
|
|
13923
|
-
readonly type: "boolean";
|
|
13924
|
-
readonly default: false;
|
|
13925
|
-
};
|
|
13926
13968
|
};
|
|
13927
13969
|
readonly additionalProperties: false;
|
|
13928
13970
|
};
|
|
@@ -16246,9 +16288,7 @@ export declare const redoclyConfigSchema: {
|
|
|
16246
16288
|
readonly type: "object";
|
|
16247
16289
|
readonly properties: {
|
|
16248
16290
|
readonly includeInDevelopment: {
|
|
16249
|
-
readonly type: "boolean";
|
|
16250
|
-
* @deprecated properties moved to the root of the config
|
|
16251
|
-
*/
|
|
16291
|
+
readonly type: "boolean";
|
|
16252
16292
|
};
|
|
16253
16293
|
readonly trackingId: {
|
|
16254
16294
|
readonly type: "string";
|
|
@@ -17302,6 +17342,29 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
17302
17342
|
hide: {
|
|
17303
17343
|
type: "boolean";
|
|
17304
17344
|
};
|
|
17345
|
+
engine: {
|
|
17346
|
+
enum: ("flexsearch" | "typesense")[];
|
|
17347
|
+
type: "string";
|
|
17348
|
+
};
|
|
17349
|
+
facets: {
|
|
17350
|
+
items: {
|
|
17351
|
+
properties: {
|
|
17352
|
+
name: {
|
|
17353
|
+
type: "string";
|
|
17354
|
+
};
|
|
17355
|
+
type: {
|
|
17356
|
+
enum: ("radio" | "checkbox" | "input" | "multi-select" | "select" | "tags" | "switch")[];
|
|
17357
|
+
type: "string";
|
|
17358
|
+
};
|
|
17359
|
+
field: {
|
|
17360
|
+
type: "string";
|
|
17361
|
+
};
|
|
17362
|
+
};
|
|
17363
|
+
type: "object";
|
|
17364
|
+
required: ("name" | "type" | "field")[];
|
|
17365
|
+
};
|
|
17366
|
+
type: "array";
|
|
17367
|
+
};
|
|
17305
17368
|
placement: {
|
|
17306
17369
|
type: "string";
|
|
17307
17370
|
};
|
|
@@ -17329,9 +17392,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
17329
17392
|
};
|
|
17330
17393
|
type: "array";
|
|
17331
17394
|
};
|
|
17332
|
-
fuzzy: {
|
|
17333
|
-
type: "boolean";
|
|
17334
|
-
};
|
|
17335
17395
|
};
|
|
17336
17396
|
additionalProperties: false;
|
|
17337
17397
|
type: "object";
|
|
@@ -23754,6 +23814,29 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
23754
23814
|
hide: {
|
|
23755
23815
|
type: "boolean";
|
|
23756
23816
|
};
|
|
23817
|
+
engine: {
|
|
23818
|
+
enum: ("flexsearch" | "typesense")[];
|
|
23819
|
+
type: "string";
|
|
23820
|
+
};
|
|
23821
|
+
facets: {
|
|
23822
|
+
items: {
|
|
23823
|
+
properties: {
|
|
23824
|
+
name: {
|
|
23825
|
+
type: "string";
|
|
23826
|
+
};
|
|
23827
|
+
type: {
|
|
23828
|
+
enum: ("radio" | "checkbox" | "input" | "multi-select" | "select" | "tags" | "switch")[];
|
|
23829
|
+
type: "string";
|
|
23830
|
+
};
|
|
23831
|
+
field: {
|
|
23832
|
+
type: "string";
|
|
23833
|
+
};
|
|
23834
|
+
};
|
|
23835
|
+
type: "object";
|
|
23836
|
+
required: ("name" | "type" | "field")[];
|
|
23837
|
+
};
|
|
23838
|
+
type: "array";
|
|
23839
|
+
};
|
|
23757
23840
|
placement: {
|
|
23758
23841
|
type: "string";
|
|
23759
23842
|
};
|
|
@@ -23781,9 +23864,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
23781
23864
|
};
|
|
23782
23865
|
type: "array";
|
|
23783
23866
|
};
|
|
23784
|
-
fuzzy: {
|
|
23785
|
-
type: "boolean";
|
|
23786
|
-
};
|
|
23787
23867
|
};
|
|
23788
23868
|
additionalProperties: false;
|
|
23789
23869
|
type: "object";
|
|
@@ -31153,7 +31233,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
31153
31233
|
};
|
|
31154
31234
|
};
|
|
31155
31235
|
};
|
|
31156
|
-
readonly additionalProperties: false;
|
|
31236
|
+
readonly additionalProperties: false; /**
|
|
31237
|
+
* @deprecated left for backwards compatibility
|
|
31238
|
+
*/
|
|
31157
31239
|
};
|
|
31158
31240
|
readonly links: {
|
|
31159
31241
|
readonly type: "array";
|
|
@@ -31316,6 +31398,30 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
31316
31398
|
readonly hide: {
|
|
31317
31399
|
readonly type: "boolean";
|
|
31318
31400
|
};
|
|
31401
|
+
readonly engine: {
|
|
31402
|
+
readonly type: "string";
|
|
31403
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
31404
|
+
readonly default: "flexsearch";
|
|
31405
|
+
};
|
|
31406
|
+
readonly facets: {
|
|
31407
|
+
readonly type: "array";
|
|
31408
|
+
readonly items: {
|
|
31409
|
+
readonly type: "object";
|
|
31410
|
+
readonly required: readonly ["name", "field", "type"];
|
|
31411
|
+
readonly properties: {
|
|
31412
|
+
readonly name: {
|
|
31413
|
+
readonly type: "string";
|
|
31414
|
+
};
|
|
31415
|
+
readonly field: {
|
|
31416
|
+
readonly type: "string";
|
|
31417
|
+
};
|
|
31418
|
+
readonly type: {
|
|
31419
|
+
readonly type: "string";
|
|
31420
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
31421
|
+
};
|
|
31422
|
+
};
|
|
31423
|
+
};
|
|
31424
|
+
};
|
|
31319
31425
|
readonly placement: {
|
|
31320
31426
|
readonly type: "string";
|
|
31321
31427
|
readonly default: "navbar";
|
|
@@ -31345,10 +31451,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
31345
31451
|
readonly required: readonly ["page"];
|
|
31346
31452
|
};
|
|
31347
31453
|
};
|
|
31348
|
-
readonly fuzzy: {
|
|
31349
|
-
readonly type: "boolean";
|
|
31350
|
-
readonly default: false;
|
|
31351
|
-
};
|
|
31352
31454
|
};
|
|
31353
31455
|
readonly additionalProperties: false;
|
|
31354
31456
|
};
|
|
@@ -33672,9 +33774,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
33672
33774
|
readonly type: "object";
|
|
33673
33775
|
readonly properties: {
|
|
33674
33776
|
readonly includeInDevelopment: {
|
|
33675
|
-
readonly type: "boolean";
|
|
33676
|
-
* @deprecated properties moved to the root of the config
|
|
33677
|
-
*/
|
|
33777
|
+
readonly type: "boolean";
|
|
33678
33778
|
};
|
|
33679
33779
|
readonly trackingId: {
|
|
33680
33780
|
readonly type: "string";
|
|
@@ -34695,7 +34795,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34695
34795
|
};
|
|
34696
34796
|
};
|
|
34697
34797
|
};
|
|
34698
|
-
readonly additionalProperties: false;
|
|
34798
|
+
readonly additionalProperties: false; /**
|
|
34799
|
+
* @deprecated left for backwards compatibility
|
|
34800
|
+
*/
|
|
34699
34801
|
};
|
|
34700
34802
|
readonly links: {
|
|
34701
34803
|
readonly type: "array";
|
|
@@ -34858,6 +34960,30 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34858
34960
|
readonly hide: {
|
|
34859
34961
|
readonly type: "boolean";
|
|
34860
34962
|
};
|
|
34963
|
+
readonly engine: {
|
|
34964
|
+
readonly type: "string";
|
|
34965
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
34966
|
+
readonly default: "flexsearch";
|
|
34967
|
+
};
|
|
34968
|
+
readonly facets: {
|
|
34969
|
+
readonly type: "array";
|
|
34970
|
+
readonly items: {
|
|
34971
|
+
readonly type: "object";
|
|
34972
|
+
readonly required: readonly ["name", "field", "type"];
|
|
34973
|
+
readonly properties: {
|
|
34974
|
+
readonly name: {
|
|
34975
|
+
readonly type: "string";
|
|
34976
|
+
};
|
|
34977
|
+
readonly field: {
|
|
34978
|
+
readonly type: "string";
|
|
34979
|
+
};
|
|
34980
|
+
readonly type: {
|
|
34981
|
+
readonly type: "string";
|
|
34982
|
+
readonly enum: readonly ["input", "multi-select", "select", "tags", "switch", "radio", "checkbox"];
|
|
34983
|
+
};
|
|
34984
|
+
};
|
|
34985
|
+
};
|
|
34986
|
+
};
|
|
34861
34987
|
readonly placement: {
|
|
34862
34988
|
readonly type: "string";
|
|
34863
34989
|
readonly default: "navbar";
|
|
@@ -34887,10 +35013,6 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34887
35013
|
readonly required: readonly ["page"];
|
|
34888
35014
|
};
|
|
34889
35015
|
};
|
|
34890
|
-
readonly fuzzy: {
|
|
34891
|
-
readonly type: "boolean";
|
|
34892
|
-
readonly default: false;
|
|
34893
|
-
};
|
|
34894
35016
|
};
|
|
34895
35017
|
readonly additionalProperties: false;
|
|
34896
35018
|
};
|
|
@@ -37214,9 +37336,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
37214
37336
|
readonly type: "object";
|
|
37215
37337
|
readonly properties: {
|
|
37216
37338
|
readonly includeInDevelopment: {
|
|
37217
|
-
readonly type: "boolean";
|
|
37218
|
-
* @deprecated properties moved to the root of the config
|
|
37219
|
-
*/
|
|
37339
|
+
readonly type: "boolean";
|
|
37220
37340
|
};
|
|
37221
37341
|
readonly trackingId: {
|
|
37222
37342
|
readonly type: "string";
|