@redocly/config 0.36.0 → 0.36.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.
@@ -6487,6 +6487,10 @@ export declare const redoclyConfigSchema: {
6487
6487
  readonly type: "string";
6488
6488
  };
6489
6489
  };
6490
+ readonly additionalProps: {
6491
+ readonly type: "object";
6492
+ readonly additionalProperties: true;
6493
+ };
6490
6494
  };
6491
6495
  };
6492
6496
  };
@@ -6571,6 +6575,10 @@ export declare const redoclyConfigSchema: {
6571
6575
  readonly type: "string";
6572
6576
  };
6573
6577
  };
6578
+ readonly additionalProps: {
6579
+ readonly type: "object";
6580
+ readonly additionalProperties: true;
6581
+ };
6574
6582
  };
6575
6583
  readonly type: "object";
6576
6584
  };
@@ -6700,6 +6708,10 @@ export declare const redoclyConfigSchema: {
6700
6708
  readonly type: "string";
6701
6709
  };
6702
6710
  };
6711
+ readonly additionalProps: {
6712
+ readonly type: "object";
6713
+ readonly additionalProperties: true;
6714
+ };
6703
6715
  };
6704
6716
  };
6705
6717
  };
@@ -6784,6 +6796,10 @@ export declare const redoclyConfigSchema: {
6784
6796
  readonly type: "string";
6785
6797
  };
6786
6798
  };
6799
+ readonly additionalProps: {
6800
+ readonly type: "object";
6801
+ readonly additionalProperties: true;
6802
+ };
6787
6803
  };
6788
6804
  readonly type: "object";
6789
6805
  };
@@ -10119,6 +10135,9 @@ export declare const redoclyConfigSchema: {
10119
10135
  readonly additionalProperties: true;
10120
10136
  readonly required: readonly ["slug", "items"];
10121
10137
  readonly properties: {
10138
+ readonly show: {
10139
+ readonly type: "boolean";
10140
+ };
10122
10141
  readonly slug: {
10123
10142
  readonly type: "string";
10124
10143
  };
@@ -10271,6 +10290,10 @@ export declare const redoclyConfigSchema: {
10271
10290
  readonly type: "string";
10272
10291
  };
10273
10292
  };
10293
+ readonly additionalProps: {
10294
+ readonly type: "object";
10295
+ readonly additionalProperties: true;
10296
+ };
10274
10297
  };
10275
10298
  };
10276
10299
  };
@@ -10355,6 +10378,10 @@ export declare const redoclyConfigSchema: {
10355
10378
  readonly type: "string";
10356
10379
  };
10357
10380
  };
10381
+ readonly additionalProps: {
10382
+ readonly type: "object";
10383
+ readonly additionalProperties: true;
10384
+ };
10358
10385
  };
10359
10386
  readonly type: "object";
10360
10387
  };
@@ -11335,6 +11362,9 @@ export declare const redoclyConfigSchema: {
11335
11362
  readonly additionalProperties: true;
11336
11363
  readonly required: readonly ["slug", "items"];
11337
11364
  readonly properties: {
11365
+ readonly show: {
11366
+ readonly type: "boolean";
11367
+ };
11338
11368
  readonly slug: {
11339
11369
  readonly type: "string";
11340
11370
  };
@@ -11487,6 +11517,10 @@ export declare const redoclyConfigSchema: {
11487
11517
  readonly type: "string";
11488
11518
  };
11489
11519
  };
11520
+ readonly additionalProps: {
11521
+ readonly type: "object";
11522
+ readonly additionalProperties: true;
11523
+ };
11490
11524
  };
11491
11525
  };
11492
11526
  };
@@ -11571,6 +11605,10 @@ export declare const redoclyConfigSchema: {
11571
11605
  readonly type: "string";
11572
11606
  };
11573
11607
  };
11608
+ readonly additionalProps: {
11609
+ readonly type: "object";
11610
+ readonly additionalProperties: true;
11611
+ };
11574
11612
  };
11575
11613
  readonly type: "object";
11576
11614
  };
@@ -12094,6 +12132,10 @@ export declare const redoclyConfigSchema: {
12094
12132
  readonly type: "string";
12095
12133
  };
12096
12134
  };
12135
+ readonly additionalProps: {
12136
+ readonly type: "object";
12137
+ readonly additionalProperties: true;
12138
+ };
12097
12139
  };
12098
12140
  };
12099
12141
  };
@@ -12178,6 +12220,10 @@ export declare const redoclyConfigSchema: {
12178
12220
  readonly type: "string";
12179
12221
  };
12180
12222
  };
12223
+ readonly additionalProps: {
12224
+ readonly type: "object";
12225
+ readonly additionalProperties: true;
12226
+ };
12181
12227
  };
12182
12228
  readonly type: "object";
12183
12229
  };
@@ -12307,6 +12353,10 @@ export declare const redoclyConfigSchema: {
12307
12353
  readonly type: "string";
12308
12354
  };
12309
12355
  };
12356
+ readonly additionalProps: {
12357
+ readonly type: "object";
12358
+ readonly additionalProperties: true;
12359
+ };
12310
12360
  };
12311
12361
  };
12312
12362
  };
@@ -12391,6 +12441,10 @@ export declare const redoclyConfigSchema: {
12391
12441
  readonly type: "string";
12392
12442
  };
12393
12443
  };
12444
+ readonly additionalProps: {
12445
+ readonly type: "object";
12446
+ readonly additionalProperties: true;
12447
+ };
12394
12448
  };
12395
12449
  readonly type: "object";
12396
12450
  };
@@ -15729,6 +15783,9 @@ export declare const redoclyConfigSchema: {
15729
15783
  readonly additionalProperties: true;
15730
15784
  readonly required: readonly ["slug", "items"];
15731
15785
  readonly properties: {
15786
+ readonly show: {
15787
+ readonly type: "boolean";
15788
+ };
15732
15789
  readonly slug: {
15733
15790
  readonly type: "string";
15734
15791
  };
@@ -15881,6 +15938,10 @@ export declare const redoclyConfigSchema: {
15881
15938
  readonly type: "string";
15882
15939
  };
15883
15940
  };
15941
+ readonly additionalProps: {
15942
+ readonly type: "object";
15943
+ readonly additionalProperties: true;
15944
+ };
15884
15945
  };
15885
15946
  };
15886
15947
  };
@@ -15965,6 +16026,10 @@ export declare const redoclyConfigSchema: {
15965
16026
  readonly type: "string";
15966
16027
  };
15967
16028
  };
16029
+ readonly additionalProps: {
16030
+ readonly type: "object";
16031
+ readonly additionalProperties: true;
16032
+ };
15968
16033
  };
15969
16034
  readonly type: "object";
15970
16035
  };
@@ -16945,6 +17010,9 @@ export declare const redoclyConfigSchema: {
16945
17010
  readonly additionalProperties: true;
16946
17011
  readonly required: readonly ["slug", "items"];
16947
17012
  readonly properties: {
17013
+ readonly show: {
17014
+ readonly type: "boolean";
17015
+ };
16948
17016
  readonly slug: {
16949
17017
  readonly type: "string";
16950
17018
  };
@@ -17097,6 +17165,10 @@ export declare const redoclyConfigSchema: {
17097
17165
  readonly type: "string";
17098
17166
  };
17099
17167
  };
17168
+ readonly additionalProps: {
17169
+ readonly type: "object";
17170
+ readonly additionalProperties: true;
17171
+ };
17100
17172
  };
17101
17173
  };
17102
17174
  };
@@ -17181,6 +17253,10 @@ export declare const redoclyConfigSchema: {
17181
17253
  readonly type: "string";
17182
17254
  };
17183
17255
  };
17256
+ readonly additionalProps: {
17257
+ readonly type: "object";
17258
+ readonly additionalProperties: true;
17259
+ };
17184
17260
  };
17185
17261
  readonly type: "object";
17186
17262
  };
@@ -22998,6 +23074,7 @@ export declare const rootRedoclyConfigSchema: {
22998
23074
  selectFirstItemOnExpand: /*elided*/ any;
22999
23075
  flatten: /*elided*/ any;
23000
23076
  linkedSidebars: /*elided*/ any;
23077
+ additionalProps: /*elided*/ any;
23001
23078
  };
23002
23079
  type: "object";
23003
23080
  };
@@ -23077,6 +23154,10 @@ export declare const rootRedoclyConfigSchema: {
23077
23154
  };
23078
23155
  type: "array";
23079
23156
  };
23157
+ additionalProps: {
23158
+ additionalProperties: true;
23159
+ type: "object";
23160
+ };
23080
23161
  };
23081
23162
  type: "object";
23082
23163
  };
@@ -24531,6 +24612,7 @@ export declare const rootRedoclyConfigSchema: {
24531
24612
  selectFirstItemOnExpand: /*elided*/ any;
24532
24613
  flatten: /*elided*/ any;
24533
24614
  linkedSidebars: /*elided*/ any;
24615
+ additionalProps: /*elided*/ any;
24534
24616
  };
24535
24617
  type: "object";
24536
24618
  };
@@ -24610,6 +24692,10 @@ export declare const rootRedoclyConfigSchema: {
24610
24692
  };
24611
24693
  type: "array";
24612
24694
  };
24695
+ additionalProps: {
24696
+ additionalProperties: true;
24697
+ type: "object";
24698
+ };
24613
24699
  };
24614
24700
  type: "object";
24615
24701
  };
@@ -25573,6 +25659,10 @@ export declare const rootRedoclyConfigSchema: {
25573
25659
  items: /*elided*/ any;
25574
25660
  type: "array";
25575
25661
  };
25662
+ additionalProps: {
25663
+ additionalProperties: true;
25664
+ type: "object";
25665
+ };
25576
25666
  };
25577
25667
  type: "object";
25578
25668
  };
@@ -25627,6 +25717,9 @@ export declare const rootRedoclyConfigSchema: {
25627
25717
  };
25628
25718
  type: "array";
25629
25719
  };
25720
+ show: {
25721
+ type: "boolean";
25722
+ };
25630
25723
  groupByFirstFilter: {
25631
25724
  type: "boolean";
25632
25725
  };
@@ -26245,6 +26338,10 @@ export declare const rootRedoclyConfigSchema: {
26245
26338
  items: /*elided*/ any;
26246
26339
  type: "array";
26247
26340
  };
26341
+ additionalProps: {
26342
+ additionalProperties: true;
26343
+ type: "object";
26344
+ };
26248
26345
  };
26249
26346
  type: "object";
26250
26347
  };
@@ -26299,6 +26396,9 @@ export declare const rootRedoclyConfigSchema: {
26299
26396
  };
26300
26397
  type: "array";
26301
26398
  };
26399
+ show: {
26400
+ type: "boolean";
26401
+ };
26302
26402
  groupByFirstFilter: {
26303
26403
  type: "boolean";
26304
26404
  };
@@ -26764,6 +26864,10 @@ export declare const rootRedoclyConfigSchema: {
26764
26864
  };
26765
26865
  type: "array";
26766
26866
  };
26867
+ additionalProps: {
26868
+ additionalProperties: true;
26869
+ type: "object";
26870
+ };
26767
26871
  };
26768
26872
  type: "object";
26769
26873
  };
@@ -26845,6 +26949,10 @@ export declare const rootRedoclyConfigSchema: {
26845
26949
  };
26846
26950
  type: "array";
26847
26951
  };
26952
+ additionalProps: {
26953
+ additionalProperties: true;
26954
+ type: "object";
26955
+ };
26848
26956
  };
26849
26957
  type: "object";
26850
26958
  };
@@ -29464,6 +29572,10 @@ export declare const rootRedoclyConfigSchema: {
29464
29572
  };
29465
29573
  type: "array";
29466
29574
  };
29575
+ additionalProps: {
29576
+ additionalProperties: true;
29577
+ type: "object";
29578
+ };
29467
29579
  };
29468
29580
  type: "object";
29469
29581
  };
@@ -29545,6 +29657,10 @@ export declare const rootRedoclyConfigSchema: {
29545
29657
  };
29546
29658
  type: "array";
29547
29659
  };
29660
+ additionalProps: {
29661
+ additionalProperties: true;
29662
+ type: "object";
29663
+ };
29548
29664
  };
29549
29665
  type: "object";
29550
29666
  };
@@ -30528,6 +30644,7 @@ export declare const rootRedoclyConfigSchema: {
30528
30644
  selectFirstItemOnExpand: /*elided*/ any;
30529
30645
  flatten: /*elided*/ any;
30530
30646
  linkedSidebars: /*elided*/ any;
30647
+ additionalProps: /*elided*/ any;
30531
30648
  };
30532
30649
  type: "object";
30533
30650
  };
@@ -30607,6 +30724,10 @@ export declare const rootRedoclyConfigSchema: {
30607
30724
  };
30608
30725
  type: "array";
30609
30726
  };
30727
+ additionalProps: {
30728
+ additionalProperties: true;
30729
+ type: "object";
30730
+ };
30610
30731
  };
30611
30732
  type: "object";
30612
30733
  };
@@ -30665,6 +30786,9 @@ export declare const rootRedoclyConfigSchema: {
30665
30786
  };
30666
30787
  type: "array";
30667
30788
  };
30789
+ show: {
30790
+ type: "boolean";
30791
+ };
30668
30792
  groupByFirstFilter: {
30669
30793
  type: "boolean";
30670
30794
  };
@@ -31598,6 +31722,7 @@ export declare const rootRedoclyConfigSchema: {
31598
31722
  selectFirstItemOnExpand: /*elided*/ any;
31599
31723
  flatten: /*elided*/ any;
31600
31724
  linkedSidebars: /*elided*/ any;
31725
+ additionalProps: /*elided*/ any;
31601
31726
  };
31602
31727
  type: "object";
31603
31728
  };
@@ -31677,6 +31802,10 @@ export declare const rootRedoclyConfigSchema: {
31677
31802
  };
31678
31803
  type: "array";
31679
31804
  };
31805
+ additionalProps: {
31806
+ additionalProperties: true;
31807
+ type: "object";
31808
+ };
31680
31809
  };
31681
31810
  type: "object";
31682
31811
  };
@@ -31735,6 +31864,9 @@ export declare const rootRedoclyConfigSchema: {
31735
31864
  };
31736
31865
  type: "array";
31737
31866
  };
31867
+ show: {
31868
+ type: "boolean";
31869
+ };
31738
31870
  groupByFirstFilter: {
31739
31871
  type: "boolean";
31740
31872
  };
@@ -34850,6 +34982,10 @@ export declare const rootRedoclyConfigSchema: {
34850
34982
  readonly type: "string";
34851
34983
  };
34852
34984
  };
34985
+ readonly additionalProps: {
34986
+ readonly type: "object";
34987
+ readonly additionalProperties: true;
34988
+ };
34853
34989
  };
34854
34990
  };
34855
34991
  };
@@ -34934,6 +35070,10 @@ export declare const rootRedoclyConfigSchema: {
34934
35070
  readonly type: "string";
34935
35071
  };
34936
35072
  };
35073
+ readonly additionalProps: {
35074
+ readonly type: "object";
35075
+ readonly additionalProperties: true;
35076
+ };
34937
35077
  };
34938
35078
  readonly type: "object";
34939
35079
  };
@@ -35063,6 +35203,10 @@ export declare const rootRedoclyConfigSchema: {
35063
35203
  readonly type: "string";
35064
35204
  };
35065
35205
  };
35206
+ readonly additionalProps: {
35207
+ readonly type: "object";
35208
+ readonly additionalProperties: true;
35209
+ };
35066
35210
  };
35067
35211
  };
35068
35212
  };
@@ -35147,6 +35291,10 @@ export declare const rootRedoclyConfigSchema: {
35147
35291
  readonly type: "string";
35148
35292
  };
35149
35293
  };
35294
+ readonly additionalProps: {
35295
+ readonly type: "object";
35296
+ readonly additionalProperties: true;
35297
+ };
35150
35298
  };
35151
35299
  readonly type: "object";
35152
35300
  };
@@ -38482,6 +38630,9 @@ export declare const rootRedoclyConfigSchema: {
38482
38630
  readonly additionalProperties: true;
38483
38631
  readonly required: readonly ["slug", "items"];
38484
38632
  readonly properties: {
38633
+ readonly show: {
38634
+ readonly type: "boolean";
38635
+ };
38485
38636
  readonly slug: {
38486
38637
  readonly type: "string";
38487
38638
  };
@@ -38634,6 +38785,10 @@ export declare const rootRedoclyConfigSchema: {
38634
38785
  readonly type: "string";
38635
38786
  };
38636
38787
  };
38788
+ readonly additionalProps: {
38789
+ readonly type: "object";
38790
+ readonly additionalProperties: true;
38791
+ };
38637
38792
  };
38638
38793
  };
38639
38794
  };
@@ -38718,6 +38873,10 @@ export declare const rootRedoclyConfigSchema: {
38718
38873
  readonly type: "string";
38719
38874
  };
38720
38875
  };
38876
+ readonly additionalProps: {
38877
+ readonly type: "object";
38878
+ readonly additionalProperties: true;
38879
+ };
38721
38880
  };
38722
38881
  readonly type: "object";
38723
38882
  };
@@ -39698,6 +39857,9 @@ export declare const rootRedoclyConfigSchema: {
39698
39857
  readonly additionalProperties: true;
39699
39858
  readonly required: readonly ["slug", "items"];
39700
39859
  readonly properties: {
39860
+ readonly show: {
39861
+ readonly type: "boolean";
39862
+ };
39701
39863
  readonly slug: {
39702
39864
  readonly type: "string";
39703
39865
  };
@@ -39850,6 +40012,10 @@ export declare const rootRedoclyConfigSchema: {
39850
40012
  readonly type: "string";
39851
40013
  };
39852
40014
  };
40015
+ readonly additionalProps: {
40016
+ readonly type: "object";
40017
+ readonly additionalProperties: true;
40018
+ };
39853
40019
  };
39854
40020
  };
39855
40021
  };
@@ -39934,6 +40100,10 @@ export declare const rootRedoclyConfigSchema: {
39934
40100
  readonly type: "string";
39935
40101
  };
39936
40102
  };
40103
+ readonly additionalProps: {
40104
+ readonly type: "object";
40105
+ readonly additionalProperties: true;
40106
+ };
39937
40107
  };
39938
40108
  readonly type: "object";
39939
40109
  };
@@ -40457,6 +40627,10 @@ export declare const rootRedoclyConfigSchema: {
40457
40627
  readonly type: "string";
40458
40628
  };
40459
40629
  };
40630
+ readonly additionalProps: {
40631
+ readonly type: "object";
40632
+ readonly additionalProperties: true;
40633
+ };
40460
40634
  };
40461
40635
  };
40462
40636
  };
@@ -40541,6 +40715,10 @@ export declare const rootRedoclyConfigSchema: {
40541
40715
  readonly type: "string";
40542
40716
  };
40543
40717
  };
40718
+ readonly additionalProps: {
40719
+ readonly type: "object";
40720
+ readonly additionalProperties: true;
40721
+ };
40544
40722
  };
40545
40723
  readonly type: "object";
40546
40724
  };
@@ -40670,6 +40848,10 @@ export declare const rootRedoclyConfigSchema: {
40670
40848
  readonly type: "string";
40671
40849
  };
40672
40850
  };
40851
+ readonly additionalProps: {
40852
+ readonly type: "object";
40853
+ readonly additionalProperties: true;
40854
+ };
40673
40855
  };
40674
40856
  };
40675
40857
  };
@@ -40754,6 +40936,10 @@ export declare const rootRedoclyConfigSchema: {
40754
40936
  readonly type: "string";
40755
40937
  };
40756
40938
  };
40939
+ readonly additionalProps: {
40940
+ readonly type: "object";
40941
+ readonly additionalProperties: true;
40942
+ };
40757
40943
  };
40758
40944
  readonly type: "object";
40759
40945
  };
@@ -44092,6 +44278,9 @@ export declare const rootRedoclyConfigSchema: {
44092
44278
  readonly additionalProperties: true;
44093
44279
  readonly required: readonly ["slug", "items"];
44094
44280
  readonly properties: {
44281
+ readonly show: {
44282
+ readonly type: "boolean";
44283
+ };
44095
44284
  readonly slug: {
44096
44285
  readonly type: "string";
44097
44286
  };
@@ -44244,6 +44433,10 @@ export declare const rootRedoclyConfigSchema: {
44244
44433
  readonly type: "string";
44245
44434
  };
44246
44435
  };
44436
+ readonly additionalProps: {
44437
+ readonly type: "object";
44438
+ readonly additionalProperties: true;
44439
+ };
44247
44440
  };
44248
44441
  };
44249
44442
  };
@@ -44328,6 +44521,10 @@ export declare const rootRedoclyConfigSchema: {
44328
44521
  readonly type: "string";
44329
44522
  };
44330
44523
  };
44524
+ readonly additionalProps: {
44525
+ readonly type: "object";
44526
+ readonly additionalProperties: true;
44527
+ };
44331
44528
  };
44332
44529
  readonly type: "object";
44333
44530
  };
@@ -45308,6 +45505,9 @@ export declare const rootRedoclyConfigSchema: {
45308
45505
  readonly additionalProperties: true;
45309
45506
  readonly required: readonly ["slug", "items"];
45310
45507
  readonly properties: {
45508
+ readonly show: {
45509
+ readonly type: "boolean";
45510
+ };
45311
45511
  readonly slug: {
45312
45512
  readonly type: "string";
45313
45513
  };
@@ -45460,6 +45660,10 @@ export declare const rootRedoclyConfigSchema: {
45460
45660
  readonly type: "string";
45461
45661
  };
45462
45662
  };
45663
+ readonly additionalProps: {
45664
+ readonly type: "object";
45665
+ readonly additionalProperties: true;
45666
+ };
45463
45667
  };
45464
45668
  };
45465
45669
  };
@@ -45544,6 +45748,10 @@ export declare const rootRedoclyConfigSchema: {
45544
45748
  readonly type: "string";
45545
45749
  };
45546
45750
  };
45751
+ readonly additionalProps: {
45752
+ readonly type: "object";
45753
+ readonly additionalProperties: true;
45754
+ };
45547
45755
  };
45548
45756
  readonly type: "object";
45549
45757
  };
@@ -30,6 +30,14 @@ export type ApiFunctionsContext = {
30
30
  params: Record<string, string | string[]>;
31
31
  query: Record<string, string | string[]>;
32
32
  cookies: Record<string, string>;
33
+ /**
34
+ * @deprecated `telemetry` is deprecated.
35
+ */
36
+ telemetry?: {
37
+ sendCustomMessage: (data: {
38
+ name: string;
39
+ } & Record<string, string | number>) => void;
40
+ };
33
41
  } & ApiFunctionsContextMethods;
34
42
  export type ApiRoutesHandler = (request: Request, context: ApiFunctionsContext,
35
43
  /**
@@ -54,6 +54,7 @@ export type ResolvedNavLinkItem = {
54
54
  };
55
55
  linkedSidebars?: string[];
56
56
  languageInsensitive?: boolean;
57
+ additionalProps?: Record<string, unknown>;
57
58
  };
58
59
  export type ItemBadge = {
59
60
  name: string;
@@ -90,6 +91,7 @@ export type ResolvedNavGroupItem = {
90
91
  };
91
92
  linkedSidebars?: string[];
92
93
  languageInsensitive?: boolean;
94
+ additionalProps?: Record<string, unknown>;
93
95
  };
94
96
  export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
95
97
  type: 'separator';
@@ -112,6 +114,7 @@ export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
112
114
  external?: boolean;
113
115
  srcSet?: string;
114
116
  languageInsensitive?: boolean;
117
+ additionalProps?: Record<string, unknown>;
115
118
  [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
116
119
  [REDOCLY_ROUTE_RBAC]?: {
117
120
  slug?: string;
@@ -253,6 +256,7 @@ export type NavItem = {
253
256
  linkedSidebars?: string[];
254
257
  $ref?: string;
255
258
  disconnect?: boolean;
259
+ additionalProps?: Record<string, unknown>;
256
260
  };
257
261
  export interface LogoConfig {
258
262
  image?: string;