@redocly/config 0.29.0 → 0.30.0

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.
Files changed (21) hide show
  1. package/lib/default-theme-config-schema.d.ts +7 -1
  2. package/lib/ex-theme-config-schemas.d.ts +7 -1
  3. package/lib/ex-theme-config-schemas.js +2 -0
  4. package/lib/product-override-schema.d.ts +9 -5
  5. package/lib/redoc-config-schema.d.ts +0 -1
  6. package/lib/redoc-config-schema.js +0 -1
  7. package/lib/reunite-config-schema.d.ts +7 -4
  8. package/lib/reunite-config-schema.js +4 -1
  9. package/lib/root-config-schema.d.ts +54 -26
  10. package/lib/types/portal-shared-types.d.ts +2 -0
  11. package/lib-esm/default-theme-config-schema.d.ts +7 -1
  12. package/lib-esm/ex-theme-config-schemas.d.ts +7 -1
  13. package/lib-esm/ex-theme-config-schemas.js +2 -0
  14. package/lib-esm/product-override-schema.d.ts +9 -5
  15. package/lib-esm/redoc-config-schema.d.ts +0 -1
  16. package/lib-esm/redoc-config-schema.js +0 -1
  17. package/lib-esm/reunite-config-schema.d.ts +7 -4
  18. package/lib-esm/reunite-config-schema.js +4 -1
  19. package/lib-esm/root-config-schema.d.ts +54 -26
  20. package/lib-esm/types/portal-shared-types.d.ts +2 -0
  21. package/package.json +1 -1
package/lib/default-theme-config-schema.d.ts CHANGED
@@ -2930,7 +2930,6 @@ export declare const themeConfigSchema: {
2930
2930
  readonly type: "boolean";
2931
2931
  };
2932
2932
  };
2933
- readonly required: readonly ["languages"];
2934
2933
  readonly additionalProperties: false;
2935
2934
  };
2936
2935
  readonly ignoreNamedSchemas: {
@@ -3696,6 +3695,9 @@ export declare const themeConfigSchema: {
3696
3695
  readonly page: {
3697
3696
  readonly type: "string";
3698
3697
  };
3698
+ readonly icon: {
3699
+ readonly type: "string";
3700
+ };
3699
3701
  };
3700
3702
  readonly additionalProperties: false;
3701
3703
  readonly default: {};
@@ -5220,6 +5222,10 @@ export declare const themeConfigSchema: {
5220
5222
  readonly type: "string";
5221
5223
  };
5222
5224
  };
5225
+ readonly fromProjectUrl: {
5226
+ readonly type: "string";
5227
+ readonly format: "uri";
5228
+ };
5223
5229
  };
5224
5230
  };
5225
5231
  };
package/lib/ex-theme-config-schemas.d.ts CHANGED
@@ -2952,7 +2952,6 @@ export declare const openapiConfigSchema: {
2952
2952
  readonly type: "boolean";
2953
2953
  };
2954
2954
  };
2955
- readonly required: readonly ["languages"];
2956
2955
  readonly additionalProperties: false;
2957
2956
  };
2958
2957
  readonly ignoreNamedSchemas: {
@@ -3523,6 +3522,9 @@ export declare const breadcrumbsConfigSchema: {
3523
3522
  readonly page: {
3524
3523
  readonly type: "string";
3525
3524
  };
3525
+ readonly icon: {
3526
+ readonly type: "string";
3527
+ };
3526
3528
  };
3527
3529
  readonly additionalProperties: false;
3528
3530
  readonly default: {};
@@ -4336,5 +4338,9 @@ export declare const scorecardConfigSchema: {
4336
4338
  readonly type: "string";
4337
4339
  };
4338
4340
  };
4341
+ readonly fromProjectUrl: {
4342
+ readonly type: "string";
4343
+ readonly format: "uri";
4344
+ };
4339
4345
  };
4340
4346
  };
package/lib/ex-theme-config-schemas.js CHANGED
@@ -504,6 +504,7 @@ exports.breadcrumbsConfigSchema = {
504
504
  label: { type: 'string' },
505
505
  labelTranslationKey: { type: 'string' },
506
506
  page: { type: 'string' },
507
+ icon: { type: 'string' },
507
508
  },
508
509
  additionalProperties: false,
509
510
  default: {},
@@ -609,6 +610,7 @@ exports.scorecardConfigSchema = {
609
610
  type: 'array',
610
611
  items: { type: 'string' },
611
612
  },
613
+ fromProjectUrl: { type: 'string', format: 'uri' },
612
614
  },
613
615
  };
614
616
  //# sourceMappingURL=ex-theme-config-schemas.js.map
package/lib/product-override-schema.d.ts CHANGED
@@ -618,6 +618,9 @@ export declare const productThemeOverrideSchema: {
618
618
  readonly page: {
619
619
  readonly type: "string";
620
620
  };
621
+ readonly icon: {
622
+ readonly type: "string";
623
+ };
621
624
  };
622
625
  readonly additionalProperties: false;
623
626
  readonly default: {};
@@ -2408,7 +2411,6 @@ export declare const productThemeOverrideSchema: {
2408
2411
  readonly type: "boolean";
2409
2412
  };
2410
2413
  };
2411
- readonly required: readonly ["languages"];
2412
2414
  readonly additionalProperties: false;
2413
2415
  };
2414
2416
  readonly ignoreNamedSchemas: {
@@ -4656,7 +4658,6 @@ export declare const productConfigOverrideSchema: {
4656
4658
  readonly type: "boolean";
4657
4659
  };
4658
4660
  };
4659
- readonly required: readonly ["languages"];
4660
4661
  readonly additionalProperties: false;
4661
4662
  };
4662
4663
  readonly ignoreNamedSchemas: {
@@ -6904,7 +6905,6 @@ export declare const productConfigOverrideSchema: {
6904
6905
  readonly type: "boolean";
6905
6906
  };
6906
6907
  };
6907
- readonly required: readonly ["languages"];
6908
6908
  readonly additionalProperties: false;
6909
6909
  };
6910
6910
  readonly ignoreNamedSchemas: {
@@ -8004,6 +8004,9 @@ export declare const productConfigOverrideSchema: {
8004
8004
  readonly page: {
8005
8005
  readonly type: "string";
8006
8006
  };
8007
+ readonly icon: {
8008
+ readonly type: "string";
8009
+ };
8007
8010
  };
8008
8011
  readonly additionalProperties: false;
8009
8012
  readonly default: {};
@@ -9794,7 +9797,6 @@ export declare const productConfigOverrideSchema: {
9794
9797
  readonly type: "boolean";
9795
9798
  };
9796
9799
  };
9797
- readonly required: readonly ["languages"];
9798
9800
  readonly additionalProperties: false;
9799
9801
  };
9800
9802
  readonly ignoreNamedSchemas: {
@@ -10707,6 +10709,9 @@ export declare const productConfigOverrideSchema: {
10707
10709
  readonly page: {
10708
10710
  readonly type: "string";
10709
10711
  };
10712
+ readonly icon: {
10713
+ readonly type: "string";
10714
+ };
10710
10715
  };
10711
10716
  readonly additionalProperties: false;
10712
10717
  readonly default: {};
@@ -12497,7 +12502,6 @@ export declare const productConfigOverrideSchema: {
12497
12502
  readonly type: "boolean";
12498
12503
  };
12499
12504
  };
12500
- readonly required: readonly ["languages"];
12501
12505
  readonly additionalProperties: false;
12502
12506
  };
12503
12507
  readonly ignoreNamedSchemas: {
package/lib/redoc-config-schema.d.ts CHANGED
@@ -425,7 +425,6 @@ export declare const redocConfigSchema: {
425
425
  readonly type: "boolean";
426
426
  };
427
427
  };
428
- readonly required: readonly ["languages"];
429
428
  readonly additionalProperties: false;
430
429
  };
431
430
  readonly ignoreNamedSchemas: {
package/lib/redoc-config-schema.js CHANGED
@@ -51,7 +51,6 @@ const codeSamplesConfigSchema = {
51
51
  skipOptionalParameters: { type: 'boolean' },
52
52
  withOAuth2Call: { type: 'boolean' },
53
53
  },
54
- required: ['languages'],
55
54
  additionalProperties: false,
56
55
  };
57
56
  exports.downloadUrlsSchema = {
package/lib/reunite-config-schema.d.ts CHANGED
@@ -21,10 +21,6 @@ export declare const reuniteConfigSchema: {
21
21
  readonly ignoreRespectMonitoring: {
22
22
  readonly type: "boolean";
23
23
  };
24
- readonly projectUrl: {
25
- readonly type: "string";
26
- readonly format: "uri";
27
- };
28
24
  readonly jobs: {
29
25
  readonly type: "array";
30
26
  readonly items: {
@@ -108,6 +104,13 @@ export declare const reuniteConfigSchema: {
108
104
  readonly additionalProperties: false;
109
105
  };
110
106
  };
107
+ /**
108
+ * @deprecated Should use `scorecard.fromProjectUrl` instead
109
+ */
110
+ readonly projectUrl: {
111
+ readonly type: "string";
112
+ readonly format: "uri";
113
+ };
111
114
  };
112
115
  readonly additionalProperties: false;
113
116
  };
package/lib/reunite-config-schema.js CHANGED
@@ -64,7 +64,6 @@ exports.reuniteConfigSchema = {
64
64
  ignoreLinkChecker: { type: 'boolean' },
65
65
  ignoreMarkdocErrors: { type: 'boolean' },
66
66
  ignoreRespectMonitoring: { type: 'boolean' },
67
- projectUrl: { type: 'string', format: 'uri' },
68
67
  jobs: {
69
68
  type: 'array',
70
69
  items: {
@@ -89,6 +88,10 @@ exports.reuniteConfigSchema = {
89
88
  additionalProperties: false,
90
89
  },
91
90
  },
91
+ /**
92
+ * @deprecated Should use `scorecard.fromProjectUrl` instead
93
+ */
94
+ projectUrl: { type: 'string', format: 'uri' },
92
95
  },
93
96
  additionalProperties: false,
94
97
  };
package/lib/root-config-schema.d.ts CHANGED
@@ -2441,7 +2441,6 @@ export declare const apiConfigSchema: {
2441
2441
  readonly type: "boolean";
2442
2442
  };
2443
2443
  };
2444
- readonly required: readonly ["languages"];
2445
2444
  readonly additionalProperties: false;
2446
2445
  };
2447
2446
  readonly ignoreNamedSchemas: {
@@ -4692,7 +4691,6 @@ export declare const apiConfigSchema: {
4692
4691
  readonly type: "boolean";
4693
4692
  };
4694
4693
  };
4695
- readonly required: readonly ["languages"];
4696
4694
  readonly additionalProperties: false;
4697
4695
  };
4698
4696
  readonly ignoreNamedSchemas: {
@@ -9240,7 +9238,6 @@ export declare const redoclyConfigSchema: {
9240
9238
  readonly type: "boolean";
9241
9239
  };
9242
9240
  };
9243
- readonly required: readonly ["languages"];
9244
9241
  readonly additionalProperties: false;
9245
9242
  };
9246
9243
  readonly ignoreNamedSchemas: {
@@ -10006,6 +10003,9 @@ export declare const redoclyConfigSchema: {
10006
10003
  readonly page: {
10007
10004
  readonly type: "string";
10008
10005
  };
10006
+ readonly icon: {
10007
+ readonly type: "string";
10008
+ };
10009
10009
  };
10010
10010
  readonly additionalProperties: false;
10011
10011
  readonly default: {};
@@ -11527,6 +11527,10 @@ export declare const redoclyConfigSchema: {
11527
11527
  readonly type: "string";
11528
11528
  };
11529
11529
  };
11530
+ readonly fromProjectUrl: {
11531
+ readonly type: "string";
11532
+ readonly format: "uri";
11533
+ };
11530
11534
  };
11531
11535
  };
11532
11536
  };
@@ -11555,10 +11559,6 @@ export declare const redoclyConfigSchema: {
11555
11559
  readonly ignoreRespectMonitoring: {
11556
11560
  readonly type: "boolean";
11557
11561
  };
11558
- readonly projectUrl: {
11559
- readonly type: "string";
11560
- readonly format: "uri";
11561
- };
11562
11562
  readonly jobs: {
11563
11563
  readonly type: "array";
11564
11564
  readonly items: {
@@ -11642,6 +11642,10 @@ export declare const redoclyConfigSchema: {
11642
11642
  readonly additionalProperties: false;
11643
11643
  };
11644
11644
  };
11645
+ readonly projectUrl: {
11646
+ readonly type: "string";
11647
+ readonly format: "uri";
11648
+ };
11645
11649
  };
11646
11650
  readonly additionalProperties: false;
11647
11651
  };
@@ -14565,7 +14569,6 @@ export declare const redoclyConfigSchema: {
14565
14569
  readonly type: "boolean";
14566
14570
  };
14567
14571
  };
14568
- readonly required: readonly ["languages"];
14569
14572
  readonly additionalProperties: false;
14570
14573
  };
14571
14574
  readonly ignoreNamedSchemas: {
@@ -15331,6 +15334,9 @@ export declare const redoclyConfigSchema: {
15331
15334
  readonly page: {
15332
15335
  readonly type: "string";
15333
15336
  };
15337
+ readonly icon: {
15338
+ readonly type: "string";
15339
+ };
15334
15340
  };
15335
15341
  readonly additionalProperties: false;
15336
15342
  readonly default: {};
@@ -16855,6 +16861,10 @@ export declare const redoclyConfigSchema: {
16855
16861
  readonly type: "string";
16856
16862
  };
16857
16863
  };
16864
+ readonly fromProjectUrl: {
16865
+ readonly type: "string";
16866
+ readonly format: "uri";
16867
+ };
16858
16868
  };
16859
16869
  };
16860
16870
  readonly preprocessors: {
@@ -19246,7 +19256,6 @@ export declare const redoclyConfigSchema: {
19246
19256
  readonly type: "boolean";
19247
19257
  };
19248
19258
  };
19249
- readonly required: readonly ["languages"];
19250
19259
  readonly additionalProperties: false;
19251
19260
  };
19252
19261
  readonly ignoreNamedSchemas: {
@@ -21497,7 +21506,6 @@ export declare const redoclyConfigSchema: {
21497
21506
  readonly type: "boolean";
21498
21507
  };
21499
21508
  };
21500
- readonly required: readonly ["languages"];
21501
21509
  readonly additionalProperties: false;
21502
21510
  };
21503
21511
  readonly ignoreNamedSchemas: {
@@ -24340,7 +24348,6 @@ export declare const rootRedoclyConfigSchema: {
24340
24348
  };
24341
24349
  additionalProperties: false;
24342
24350
  type: "object";
24343
- required: "languages"[];
24344
24351
  };
24345
24352
  ignoreNamedSchemas: {
24346
24353
  oneOf: ({
@@ -25001,6 +25008,9 @@ export declare const rootRedoclyConfigSchema: {
25001
25008
  page: {
25002
25009
  type: "string";
25003
25010
  };
25011
+ icon: {
25012
+ type: "string";
25013
+ };
25004
25014
  labelTranslationKey: {
25005
25015
  type: "string";
25006
25016
  };
@@ -26018,6 +26028,10 @@ export declare const rootRedoclyConfigSchema: {
26018
26028
  };
26019
26029
  type: "array";
26020
26030
  };
26031
+ fromProjectUrl: {
26032
+ type: "string";
26033
+ format: "uri";
26034
+ };
26021
26035
  };
26022
26036
  additionalProperties: true;
26023
26037
  type: "object";
@@ -26703,10 +26717,6 @@ export declare const rootRedoclyConfigSchema: {
26703
26717
  ignoreRespectMonitoring: {
26704
26718
  type: "boolean";
26705
26719
  };
26706
- projectUrl: {
26707
- type: "string";
26708
- format: "uri";
26709
- };
26710
26720
  jobs: {
26711
26721
  items: {
26712
26722
  properties: {
@@ -26790,6 +26800,10 @@ export declare const rootRedoclyConfigSchema: {
26790
26800
  };
26791
26801
  type: "array";
26792
26802
  };
26803
+ projectUrl: {
26804
+ type: "string";
26805
+ format: "uri";
26806
+ };
26793
26807
  };
26794
26808
  additionalProperties: false;
26795
26809
  type: "object";
@@ -28909,7 +28923,6 @@ export declare const rootRedoclyConfigSchema: {
28909
28923
  };
28910
28924
  additionalProperties: false;
28911
28925
  type: "object";
28912
- required: "languages"[];
28913
28926
  };
28914
28927
  ignoreNamedSchemas: {
28915
28928
  oneOf: ({
@@ -29570,6 +29583,9 @@ export declare const rootRedoclyConfigSchema: {
29570
29583
  page: {
29571
29584
  type: "string";
29572
29585
  };
29586
+ icon: {
29587
+ type: "string";
29588
+ };
29573
29589
  labelTranslationKey: {
29574
29590
  type: "string";
29575
29591
  };
@@ -30587,6 +30603,10 @@ export declare const rootRedoclyConfigSchema: {
30587
30603
  };
30588
30604
  type: "array";
30589
30605
  };
30606
+ fromProjectUrl: {
30607
+ type: "string";
30608
+ format: "uri";
30609
+ };
30590
30610
  };
30591
30611
  additionalProperties: true;
30592
30612
  type: "object";
@@ -32385,7 +32405,6 @@ export declare const rootRedoclyConfigSchema: {
32385
32405
  };
32386
32406
  additionalProperties: false;
32387
32407
  type: "object";
32388
- required: "languages"[];
32389
32408
  };
32390
32409
  ignoreNamedSchemas: {
32391
32410
  oneOf: ({
@@ -34144,7 +34163,6 @@ export declare const rootRedoclyConfigSchema: {
34144
34163
  };
34145
34164
  additionalProperties: false;
34146
34165
  type: "object";
34147
- required: "languages"[];
34148
34166
  };
34149
34167
  ignoreNamedSchemas: {
34150
34168
  oneOf: ({
@@ -38057,7 +38075,6 @@ export declare const rootRedoclyConfigSchema: {
38057
38075
  readonly type: "boolean";
38058
38076
  };
38059
38077
  };
38060
- readonly required: readonly ["languages"];
38061
38078
  readonly additionalProperties: false;
38062
38079
  };
38063
38080
  readonly ignoreNamedSchemas: {
@@ -38823,6 +38840,9 @@ export declare const rootRedoclyConfigSchema: {
38823
38840
  readonly page: {
38824
38841
  readonly type: "string";
38825
38842
  };
38843
+ readonly icon: {
38844
+ readonly type: "string";
38845
+ };
38826
38846
  };
38827
38847
  readonly additionalProperties: false;
38828
38848
  readonly default: {};
@@ -40344,6 +40364,10 @@ export declare const rootRedoclyConfigSchema: {
40344
40364
  readonly type: "string";
40345
40365
  };
40346
40366
  };
40367
+ readonly fromProjectUrl: {
40368
+ readonly type: "string";
40369
+ readonly format: "uri";
40370
+ };
40347
40371
  };
40348
40372
  };
40349
40373
  };
@@ -40372,10 +40396,6 @@ export declare const rootRedoclyConfigSchema: {
40372
40396
  readonly ignoreRespectMonitoring: {
40373
40397
  readonly type: "boolean";
40374
40398
  };
40375
- readonly projectUrl: {
40376
- readonly type: "string";
40377
- readonly format: "uri";
40378
- };
40379
40399
  readonly jobs: {
40380
40400
  readonly type: "array";
40381
40401
  readonly items: {
@@ -40459,6 +40479,10 @@ export declare const rootRedoclyConfigSchema: {
40459
40479
  readonly additionalProperties: false;
40460
40480
  };
40461
40481
  };
40482
+ readonly projectUrl: {
40483
+ readonly type: "string";
40484
+ readonly format: "uri";
40485
+ };
40462
40486
  };
40463
40487
  readonly additionalProperties: false;
40464
40488
  };
@@ -43382,7 +43406,6 @@ export declare const rootRedoclyConfigSchema: {
43382
43406
  readonly type: "boolean";
43383
43407
  };
43384
43408
  };
43385
- readonly required: readonly ["languages"];
43386
43409
  readonly additionalProperties: false;
43387
43410
  };
43388
43411
  readonly ignoreNamedSchemas: {
@@ -44148,6 +44171,9 @@ export declare const rootRedoclyConfigSchema: {
44148
44171
  readonly page: {
44149
44172
  readonly type: "string";
44150
44173
  };
44174
+ readonly icon: {
44175
+ readonly type: "string";
44176
+ };
44151
44177
  };
44152
44178
  readonly additionalProperties: false;
44153
44179
  readonly default: {};
@@ -45672,6 +45698,10 @@ export declare const rootRedoclyConfigSchema: {
45672
45698
  readonly type: "string";
45673
45699
  };
45674
45700
  };
45701
+ readonly fromProjectUrl: {
45702
+ readonly type: "string";
45703
+ readonly format: "uri";
45704
+ };
45675
45705
  };
45676
45706
  };
45677
45707
  readonly preprocessors: {
@@ -48063,7 +48093,6 @@ export declare const rootRedoclyConfigSchema: {
48063
48093
  readonly type: "boolean";
48064
48094
  };
48065
48095
  };
48066
- readonly required: readonly ["languages"];
48067
48096
  readonly additionalProperties: false;
48068
48097
  };
48069
48098
  readonly ignoreNamedSchemas: {
@@ -50314,7 +50343,6 @@ export declare const rootRedoclyConfigSchema: {
50314
50343
  readonly type: "boolean";
50315
50344
  };
50316
50345
  };
50317
- readonly required: readonly ["languages"];
50318
50346
  readonly additionalProperties: false;
50319
50347
  };
50320
50348
  readonly ignoreNamedSchemas: {
package/lib/types/portal-shared-types.d.ts CHANGED
@@ -301,7 +301,9 @@ export type APIOptions = {
301
301
  export type MenuStyle = 'drilldown' | 'drilldown-header';
302
302
  export type BreadcrumbItem = {
303
303
  label: string;
304
+ labelTranslationKey?: string;
304
305
  link?: string;
306
+ icon?: string;
305
307
  };
306
308
  export type ProductThemeOverrideConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback'> & {
307
309
  analytics?: {
package/lib-esm/default-theme-config-schema.d.ts CHANGED
@@ -2930,7 +2930,6 @@ export declare const themeConfigSchema: {
2930
2930
  readonly type: "boolean";
2931
2931
  };
2932
2932
  };
2933
- readonly required: readonly ["languages"];
2934
2933
  readonly additionalProperties: false;
2935
2934
  };
2936
2935
  readonly ignoreNamedSchemas: {
@@ -3696,6 +3695,9 @@ export declare const themeConfigSchema: {
3696
3695
  readonly page: {
3697
3696
  readonly type: "string";
3698
3697
  };
3698
+ readonly icon: {
3699
+ readonly type: "string";
3700
+ };
3699
3701
  };
3700
3702
  readonly additionalProperties: false;
3701
3703
  readonly default: {};
@@ -5220,6 +5222,10 @@ export declare const themeConfigSchema: {
5220
5222
  readonly type: "string";
5221
5223
  };
5222
5224
  };
5225
+ readonly fromProjectUrl: {
5226
+ readonly type: "string";
5227
+ readonly format: "uri";
5228
+ };
5223
5229
  };
5224
5230
  };
5225
5231
  };
package/lib-esm/ex-theme-config-schemas.d.ts CHANGED
@@ -2952,7 +2952,6 @@ export declare const openapiConfigSchema: {
2952
2952
  readonly type: "boolean";
2953
2953
  };
2954
2954
  };
2955
- readonly required: readonly ["languages"];
2956
2955
  readonly additionalProperties: false;
2957
2956
  };
2958
2957
  readonly ignoreNamedSchemas: {
@@ -3523,6 +3522,9 @@ export declare const breadcrumbsConfigSchema: {
3523
3522
  readonly page: {
3524
3523
  readonly type: "string";
3525
3524
  };
3525
+ readonly icon: {
3526
+ readonly type: "string";
3527
+ };
3526
3528
  };
3527
3529
  readonly additionalProperties: false;
3528
3530
  readonly default: {};
@@ -4336,5 +4338,9 @@ export declare const scorecardConfigSchema: {
4336
4338
  readonly type: "string";
4337
4339
  };
4338
4340
  };
4341
+ readonly fromProjectUrl: {
4342
+ readonly type: "string";
4343
+ readonly format: "uri";
4344
+ };
4339
4345
  };
4340
4346
  };
package/lib-esm/ex-theme-config-schemas.js CHANGED
@@ -501,6 +501,7 @@ export const breadcrumbsConfigSchema = {
501
501
  label: { type: 'string' },
502
502
  labelTranslationKey: { type: 'string' },
503
503
  page: { type: 'string' },
504
+ icon: { type: 'string' },
504
505
  },
505
506
  additionalProperties: false,
506
507
  default: {},
@@ -606,6 +607,7 @@ export const scorecardConfigSchema = {
606
607
  type: 'array',
607
608
  items: { type: 'string' },
608
609
  },
610
+ fromProjectUrl: { type: 'string', format: 'uri' },
609
611
  },
610
612
  };
611
613
  //# sourceMappingURL=ex-theme-config-schemas.js.map
package/lib-esm/product-override-schema.d.ts CHANGED
@@ -618,6 +618,9 @@ export declare const productThemeOverrideSchema: {
618
618
  readonly page: {
619
619
  readonly type: "string";
620
620
  };
621
+ readonly icon: {
622
+ readonly type: "string";
623
+ };
621
624
  };
622
625
  readonly additionalProperties: false;
623
626
  readonly default: {};
@@ -2408,7 +2411,6 @@ export declare const productThemeOverrideSchema: {
2408
2411
  readonly type: "boolean";
2409
2412
  };
2410
2413
  };
2411
- readonly required: readonly ["languages"];
2412
2414
  readonly additionalProperties: false;
2413
2415
  };
2414
2416
  readonly ignoreNamedSchemas: {
@@ -4656,7 +4658,6 @@ export declare const productConfigOverrideSchema: {
4656
4658
  readonly type: "boolean";
4657
4659
  };
4658
4660
  };
4659
- readonly required: readonly ["languages"];
4660
4661
  readonly additionalProperties: false;
4661
4662
  };
4662
4663
  readonly ignoreNamedSchemas: {
@@ -6904,7 +6905,6 @@ export declare const productConfigOverrideSchema: {
6904
6905
  readonly type: "boolean";
6905
6906
  };
6906
6907
  };
6907
- readonly required: readonly ["languages"];
6908
6908
  readonly additionalProperties: false;
6909
6909
  };
6910
6910
  readonly ignoreNamedSchemas: {
@@ -8004,6 +8004,9 @@ export declare const productConfigOverrideSchema: {
8004
8004
  readonly page: {
8005
8005
  readonly type: "string";
8006
8006
  };
8007
+ readonly icon: {
8008
+ readonly type: "string";
8009
+ };
8007
8010
  };
8008
8011
  readonly additionalProperties: false;
8009
8012
  readonly default: {};
@@ -9794,7 +9797,6 @@ export declare const productConfigOverrideSchema: {
9794
9797
  readonly type: "boolean";
9795
9798
  };
9796
9799
  };
9797
- readonly required: readonly ["languages"];
9798
9800
  readonly additionalProperties: false;
9799
9801
  };
9800
9802
  readonly ignoreNamedSchemas: {
@@ -10707,6 +10709,9 @@ export declare const productConfigOverrideSchema: {
10707
10709
  readonly page: {
10708
10710
  readonly type: "string";
10709
10711
  };
10712
+ readonly icon: {
10713
+ readonly type: "string";
10714
+ };
10710
10715
  };
10711
10716
  readonly additionalProperties: false;
10712
10717
  readonly default: {};
@@ -12497,7 +12502,6 @@ export declare const productConfigOverrideSchema: {
12497
12502
  readonly type: "boolean";
12498
12503
  };
12499
12504
  };
12500
- readonly required: readonly ["languages"];
12501
12505
  readonly additionalProperties: false;
12502
12506
  };
12503
12507
  readonly ignoreNamedSchemas: {
package/lib-esm/redoc-config-schema.d.ts CHANGED
@@ -425,7 +425,6 @@ export declare const redocConfigSchema: {
425
425
  readonly type: "boolean";
426
426
  };
427
427
  };
428
- readonly required: readonly ["languages"];
429
428
  readonly additionalProperties: false;
430
429
  };
431
430
  readonly ignoreNamedSchemas: {
package/lib-esm/redoc-config-schema.js CHANGED
@@ -48,7 +48,6 @@ const codeSamplesConfigSchema = {
48
48
  skipOptionalParameters: { type: 'boolean' },
49
49
  withOAuth2Call: { type: 'boolean' },
50
50
  },
51
- required: ['languages'],
52
51
  additionalProperties: false,
53
52
  };
54
53
  export const downloadUrlsSchema = {
package/lib-esm/reunite-config-schema.d.ts CHANGED
@@ -21,10 +21,6 @@ export declare const reuniteConfigSchema: {
21
21
  readonly ignoreRespectMonitoring: {
22
22
  readonly type: "boolean";
23
23
  };
24
- readonly projectUrl: {
25
- readonly type: "string";
26
- readonly format: "uri";
27
- };
28
24
  readonly jobs: {
29
25
  readonly type: "array";
30
26
  readonly items: {
@@ -108,6 +104,13 @@ export declare const reuniteConfigSchema: {
108
104
  readonly additionalProperties: false;
109
105
  };
110
106
  };
107
+ /**
108
+ * @deprecated Should use `scorecard.fromProjectUrl` instead
109
+ */
110
+ readonly projectUrl: {
111
+ readonly type: "string";
112
+ readonly format: "uri";
113
+ };
111
114
  };
112
115
  readonly additionalProperties: false;
113
116
  };
package/lib-esm/reunite-config-schema.js CHANGED
@@ -61,7 +61,6 @@ export const reuniteConfigSchema = {
61
61
  ignoreLinkChecker: { type: 'boolean' },
62
62
  ignoreMarkdocErrors: { type: 'boolean' },
63
63
  ignoreRespectMonitoring: { type: 'boolean' },
64
- projectUrl: { type: 'string', format: 'uri' },
65
64
  jobs: {
66
65
  type: 'array',
67
66
  items: {
@@ -86,6 +85,10 @@ export const reuniteConfigSchema = {
86
85
  additionalProperties: false,
87
86
  },
88
87
  },
88
+ /**
89
+ * @deprecated Should use `scorecard.fromProjectUrl` instead
90
+ */
91
+ projectUrl: { type: 'string', format: 'uri' },
89
92
  },
90
93
  additionalProperties: false,
91
94
  };
package/lib-esm/root-config-schema.d.ts CHANGED
@@ -2441,7 +2441,6 @@ export declare const apiConfigSchema: {
2441
2441
  readonly type: "boolean";
2442
2442
  };
2443
2443
  };
2444
- readonly required: readonly ["languages"];
2445
2444
  readonly additionalProperties: false;
2446
2445
  };
2447
2446
  readonly ignoreNamedSchemas: {
@@ -4692,7 +4691,6 @@ export declare const apiConfigSchema: {
4692
4691
  readonly type: "boolean";
4693
4692
  };
4694
4693
  };
4695
- readonly required: readonly ["languages"];
4696
4694
  readonly additionalProperties: false;
4697
4695
  };
4698
4696
  readonly ignoreNamedSchemas: {
@@ -9240,7 +9238,6 @@ export declare const redoclyConfigSchema: {
9240
9238
  readonly type: "boolean";
9241
9239
  };
9242
9240
  };
9243
- readonly required: readonly ["languages"];
9244
9241
  readonly additionalProperties: false;
9245
9242
  };
9246
9243
  readonly ignoreNamedSchemas: {
@@ -10006,6 +10003,9 @@ export declare const redoclyConfigSchema: {
10006
10003
  readonly page: {
10007
10004
  readonly type: "string";
10008
10005
  };
10006
+ readonly icon: {
10007
+ readonly type: "string";
10008
+ };
10009
10009
  };
10010
10010
  readonly additionalProperties: false;
10011
10011
  readonly default: {};
@@ -11527,6 +11527,10 @@ export declare const redoclyConfigSchema: {
11527
11527
  readonly type: "string";
11528
11528
  };
11529
11529
  };
11530
+ readonly fromProjectUrl: {
11531
+ readonly type: "string";
11532
+ readonly format: "uri";
11533
+ };
11530
11534
  };
11531
11535
  };
11532
11536
  };
@@ -11555,10 +11559,6 @@ export declare const redoclyConfigSchema: {
11555
11559
  readonly ignoreRespectMonitoring: {
11556
11560
  readonly type: "boolean";
11557
11561
  };
11558
- readonly projectUrl: {
11559
- readonly type: "string";
11560
- readonly format: "uri";
11561
- };
11562
11562
  readonly jobs: {
11563
11563
  readonly type: "array";
11564
11564
  readonly items: {
@@ -11642,6 +11642,10 @@ export declare const redoclyConfigSchema: {
11642
11642
  readonly additionalProperties: false;
11643
11643
  };
11644
11644
  };
11645
+ readonly projectUrl: {
11646
+ readonly type: "string";
11647
+ readonly format: "uri";
11648
+ };
11645
11649
  };
11646
11650
  readonly additionalProperties: false;
11647
11651
  };
@@ -14565,7 +14569,6 @@ export declare const redoclyConfigSchema: {
14565
14569
  readonly type: "boolean";
14566
14570
  };
14567
14571
  };
14568
- readonly required: readonly ["languages"];
14569
14572
  readonly additionalProperties: false;
14570
14573
  };
14571
14574
  readonly ignoreNamedSchemas: {
@@ -15331,6 +15334,9 @@ export declare const redoclyConfigSchema: {
15331
15334
  readonly page: {
15332
15335
  readonly type: "string";
15333
15336
  };
15337
+ readonly icon: {
15338
+ readonly type: "string";
15339
+ };
15334
15340
  };
15335
15341
  readonly additionalProperties: false;
15336
15342
  readonly default: {};
@@ -16855,6 +16861,10 @@ export declare const redoclyConfigSchema: {
16855
16861
  readonly type: "string";
16856
16862
  };
16857
16863
  };
16864
+ readonly fromProjectUrl: {
16865
+ readonly type: "string";
16866
+ readonly format: "uri";
16867
+ };
16858
16868
  };
16859
16869
  };
16860
16870
  readonly preprocessors: {
@@ -19246,7 +19256,6 @@ export declare const redoclyConfigSchema: {
19246
19256
  readonly type: "boolean";
19247
19257
  };
19248
19258
  };
19249
- readonly required: readonly ["languages"];
19250
19259
  readonly additionalProperties: false;
19251
19260
  };
19252
19261
  readonly ignoreNamedSchemas: {
@@ -21497,7 +21506,6 @@ export declare const redoclyConfigSchema: {
21497
21506
  readonly type: "boolean";
21498
21507
  };
21499
21508
  };
21500
- readonly required: readonly ["languages"];
21501
21509
  readonly additionalProperties: false;
21502
21510
  };
21503
21511
  readonly ignoreNamedSchemas: {
@@ -24340,7 +24348,6 @@ export declare const rootRedoclyConfigSchema: {
24340
24348
  };
24341
24349
  additionalProperties: false;
24342
24350
  type: "object";
24343
- required: "languages"[];
24344
24351
  };
24345
24352
  ignoreNamedSchemas: {
24346
24353
  oneOf: ({
@@ -25001,6 +25008,9 @@ export declare const rootRedoclyConfigSchema: {
25001
25008
  page: {
25002
25009
  type: "string";
25003
25010
  };
25011
+ icon: {
25012
+ type: "string";
25013
+ };
25004
25014
  labelTranslationKey: {
25005
25015
  type: "string";
25006
25016
  };
@@ -26018,6 +26028,10 @@ export declare const rootRedoclyConfigSchema: {
26018
26028
  };
26019
26029
  type: "array";
26020
26030
  };
26031
+ fromProjectUrl: {
26032
+ type: "string";
26033
+ format: "uri";
26034
+ };
26021
26035
  };
26022
26036
  additionalProperties: true;
26023
26037
  type: "object";
@@ -26703,10 +26717,6 @@ export declare const rootRedoclyConfigSchema: {
26703
26717
  ignoreRespectMonitoring: {
26704
26718
  type: "boolean";
26705
26719
  };
26706
- projectUrl: {
26707
- type: "string";
26708
- format: "uri";
26709
- };
26710
26720
  jobs: {
26711
26721
  items: {
26712
26722
  properties: {
@@ -26790,6 +26800,10 @@ export declare const rootRedoclyConfigSchema: {
26790
26800
  };
26791
26801
  type: "array";
26792
26802
  };
26803
+ projectUrl: {
26804
+ type: "string";
26805
+ format: "uri";
26806
+ };
26793
26807
  };
26794
26808
  additionalProperties: false;
26795
26809
  type: "object";
@@ -28909,7 +28923,6 @@ export declare const rootRedoclyConfigSchema: {
28909
28923
  };
28910
28924
  additionalProperties: false;
28911
28925
  type: "object";
28912
- required: "languages"[];
28913
28926
  };
28914
28927
  ignoreNamedSchemas: {
28915
28928
  oneOf: ({
@@ -29570,6 +29583,9 @@ export declare const rootRedoclyConfigSchema: {
29570
29583
  page: {
29571
29584
  type: "string";
29572
29585
  };
29586
+ icon: {
29587
+ type: "string";
29588
+ };
29573
29589
  labelTranslationKey: {
29574
29590
  type: "string";
29575
29591
  };
@@ -30587,6 +30603,10 @@ export declare const rootRedoclyConfigSchema: {
30587
30603
  };
30588
30604
  type: "array";
30589
30605
  };
30606
+ fromProjectUrl: {
30607
+ type: "string";
30608
+ format: "uri";
30609
+ };
30590
30610
  };
30591
30611
  additionalProperties: true;
30592
30612
  type: "object";
@@ -32385,7 +32405,6 @@ export declare const rootRedoclyConfigSchema: {
32385
32405
  };
32386
32406
  additionalProperties: false;
32387
32407
  type: "object";
32388
- required: "languages"[];
32389
32408
  };
32390
32409
  ignoreNamedSchemas: {
32391
32410
  oneOf: ({
@@ -34144,7 +34163,6 @@ export declare const rootRedoclyConfigSchema: {
34144
34163
  };
34145
34164
  additionalProperties: false;
34146
34165
  type: "object";
34147
- required: "languages"[];
34148
34166
  };
34149
34167
  ignoreNamedSchemas: {
34150
34168
  oneOf: ({
@@ -38057,7 +38075,6 @@ export declare const rootRedoclyConfigSchema: {
38057
38075
  readonly type: "boolean";
38058
38076
  };
38059
38077
  };
38060
- readonly required: readonly ["languages"];
38061
38078
  readonly additionalProperties: false;
38062
38079
  };
38063
38080
  readonly ignoreNamedSchemas: {
@@ -38823,6 +38840,9 @@ export declare const rootRedoclyConfigSchema: {
38823
38840
  readonly page: {
38824
38841
  readonly type: "string";
38825
38842
  };
38843
+ readonly icon: {
38844
+ readonly type: "string";
38845
+ };
38826
38846
  };
38827
38847
  readonly additionalProperties: false;
38828
38848
  readonly default: {};
@@ -40344,6 +40364,10 @@ export declare const rootRedoclyConfigSchema: {
40344
40364
  readonly type: "string";
40345
40365
  };
40346
40366
  };
40367
+ readonly fromProjectUrl: {
40368
+ readonly type: "string";
40369
+ readonly format: "uri";
40370
+ };
40347
40371
  };
40348
40372
  };
40349
40373
  };
@@ -40372,10 +40396,6 @@ export declare const rootRedoclyConfigSchema: {
40372
40396
  readonly ignoreRespectMonitoring: {
40373
40397
  readonly type: "boolean";
40374
40398
  };
40375
- readonly projectUrl: {
40376
- readonly type: "string";
40377
- readonly format: "uri";
40378
- };
40379
40399
  readonly jobs: {
40380
40400
  readonly type: "array";
40381
40401
  readonly items: {
@@ -40459,6 +40479,10 @@ export declare const rootRedoclyConfigSchema: {
40459
40479
  readonly additionalProperties: false;
40460
40480
  };
40461
40481
  };
40482
+ readonly projectUrl: {
40483
+ readonly type: "string";
40484
+ readonly format: "uri";
40485
+ };
40462
40486
  };
40463
40487
  readonly additionalProperties: false;
40464
40488
  };
@@ -43382,7 +43406,6 @@ export declare const rootRedoclyConfigSchema: {
43382
43406
  readonly type: "boolean";
43383
43407
  };
43384
43408
  };
43385
- readonly required: readonly ["languages"];
43386
43409
  readonly additionalProperties: false;
43387
43410
  };
43388
43411
  readonly ignoreNamedSchemas: {
@@ -44148,6 +44171,9 @@ export declare const rootRedoclyConfigSchema: {
44148
44171
  readonly page: {
44149
44172
  readonly type: "string";
44150
44173
  };
44174
+ readonly icon: {
44175
+ readonly type: "string";
44176
+ };
44151
44177
  };
44152
44178
  readonly additionalProperties: false;
44153
44179
  readonly default: {};
@@ -45672,6 +45698,10 @@ export declare const rootRedoclyConfigSchema: {
45672
45698
  readonly type: "string";
45673
45699
  };
45674
45700
  };
45701
+ readonly fromProjectUrl: {
45702
+ readonly type: "string";
45703
+ readonly format: "uri";
45704
+ };
45675
45705
  };
45676
45706
  };
45677
45707
  readonly preprocessors: {
@@ -48063,7 +48093,6 @@ export declare const rootRedoclyConfigSchema: {
48063
48093
  readonly type: "boolean";
48064
48094
  };
48065
48095
  };
48066
- readonly required: readonly ["languages"];
48067
48096
  readonly additionalProperties: false;
48068
48097
  };
48069
48098
  readonly ignoreNamedSchemas: {
@@ -50314,7 +50343,6 @@ export declare const rootRedoclyConfigSchema: {
50314
50343
  readonly type: "boolean";
50315
50344
  };
50316
50345
  };
50317
- readonly required: readonly ["languages"];
50318
50346
  readonly additionalProperties: false;
50319
50347
  };
50320
50348
  readonly ignoreNamedSchemas: {
package/lib-esm/types/portal-shared-types.d.ts CHANGED
@@ -301,7 +301,9 @@ export type APIOptions = {
301
301
  export type MenuStyle = 'drilldown' | 'drilldown-header';
302
302
  export type BreadcrumbItem = {
303
303
  label: string;
304
+ labelTranslationKey?: string;
304
305
  link?: string;
306
+ icon?: string;
305
307
  };
306
308
  export type ProductThemeOverrideConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback'> & {
307
309
  analytics?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.29.0",
3
+ "version": "0.30.0",
4
4
  "license": "MIT",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./lib-esm/index.js",