@redocly/config 0.50.1 → 0.52.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 (47) hide show
  1. package/lib/asyncapi-config-schema.d.ts +10 -27
  2. package/lib/common.d.ts +120 -120
  3. package/lib/constants/identity-provider-slug.d.ts +2 -1
  4. package/lib/constants/shared.d.ts +1 -0
  5. package/lib/default-theme-config-schema.d.ts +520 -621
  6. package/lib/entities-catalog-config-schema.d.ts +60 -72
  7. package/lib/entities-catalog-entity-file-schema.d.ts +74 -67
  8. package/lib/ex-theme-config-schemas.d.ts +266 -354
  9. package/lib/feedback-config-schema.d.ts +9 -29
  10. package/lib/graphql-config-schema.d.ts +11 -28
  11. package/lib/index.d.ts +2 -2
  12. package/lib/index.js +1 -1
  13. package/lib/product-override-schema.d.ts +4203 -4461
  14. package/lib/redoc-config-schema.d.ts +14 -33
  15. package/lib/reference-docs-config-schema.d.ts +14 -10
  16. package/lib/reunite-config-schema.d.ts +11 -12
  17. package/lib/root-config-schema.d.ts +22685 -17296
  18. package/lib/scorecards-config-schema.d.ts +168 -108
  19. package/lib/types/config-types.d.ts +2 -1
  20. package/lib/types/index.d.ts +1 -0
  21. package/lib/types/json-schema-types.d.ts +69 -0
  22. package/lib/types/portal-shared-types.d.ts +3 -0
  23. package/lib-esm/asyncapi-config-schema.d.ts +10 -27
  24. package/lib-esm/common.d.ts +120 -120
  25. package/lib-esm/constants/identity-provider-slug.d.ts +2 -1
  26. package/lib-esm/constants/shared.d.ts +1 -0
  27. package/lib-esm/default-theme-config-schema.d.ts +520 -621
  28. package/lib-esm/entities-catalog-config-schema.d.ts +60 -72
  29. package/lib-esm/entities-catalog-entity-file-schema.d.ts +74 -67
  30. package/lib-esm/ex-theme-config-schemas.d.ts +266 -354
  31. package/lib-esm/feedback-config-schema.d.ts +9 -29
  32. package/lib-esm/graphql-config-schema.d.ts +11 -28
  33. package/lib-esm/index.d.ts +2 -2
  34. package/lib-esm/index.js +1 -1
  35. package/lib-esm/product-override-schema.d.ts +4203 -4461
  36. package/lib-esm/redoc-config-schema.d.ts +14 -33
  37. package/lib-esm/reference-docs-config-schema.d.ts +14 -10
  38. package/lib-esm/reunite-config-schema.d.ts +11 -12
  39. package/lib-esm/root-config-schema.d.ts +22685 -17296
  40. package/lib-esm/scorecards-config-schema.d.ts +168 -108
  41. package/lib-esm/types/config-types.d.ts +2 -1
  42. package/lib-esm/types/index.d.ts +1 -0
  43. package/lib-esm/types/json-schema-types.d.ts +69 -0
  44. package/lib-esm/types/portal-shared-types.d.ts +3 -0
  45. package/package.json +2 -2
  46. package/lib/remove-property-recursively.d.ts +0 -5
  47. package/lib-esm/remove-property-recursively.d.ts +0 -5
package/lib/redoc-config-schema.d.ts CHANGED
@@ -10,7 +10,7 @@ export declare const downloadUrlsSchema: {
10
10
  readonly type: 'string';
11
11
  };
12
12
  };
13
- readonly required: readonly ['url'];
13
+ readonly required: readonly ["url"];
14
14
  readonly additionalProperties: false;
15
15
  };
16
16
  };
@@ -34,12 +34,10 @@ export declare const redocConfigSchema: {
34
34
  readonly properties: {
35
35
  readonly hide: {
36
36
  readonly type: 'boolean';
37
- readonly default: false;
38
37
  };
39
38
  readonly type: {
40
39
  readonly type: 'string';
41
- readonly enum: readonly ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'];
42
- readonly default: 'sentiment';
40
+ readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
43
41
  };
44
42
  readonly settings: {
45
43
  readonly type: 'object';
@@ -55,8 +53,7 @@ export declare const redocConfigSchema: {
55
53
  };
56
54
  readonly component: {
57
55
  readonly type: 'string';
58
- readonly enum: readonly ['radio', 'checkbox'];
59
- readonly default: 'checkbox';
56
+ readonly enum: readonly ["radio", "checkbox"];
60
57
  };
61
58
  readonly items: {
62
59
  readonly type: 'array';
@@ -76,12 +73,10 @@ export declare const redocConfigSchema: {
76
73
  readonly properties: {
77
74
  readonly hide: {
78
75
  readonly type: 'boolean';
79
- readonly default: false;
80
76
  };
81
77
  readonly component: {
82
78
  readonly type: 'string';
83
- readonly enum: readonly ['radio', 'checkbox'];
84
- readonly default: 'checkbox';
79
+ readonly enum: readonly ["radio", "checkbox"];
85
80
  };
86
81
  readonly label: {
87
82
  readonly type: 'string';
@@ -97,12 +92,10 @@ export declare const redocConfigSchema: {
97
92
  readonly properties: {
98
93
  readonly hide: {
99
94
  readonly type: 'boolean';
100
- readonly default: false;
101
95
  };
102
96
  readonly component: {
103
97
  readonly type: 'string';
104
- readonly enum: readonly ['radio', 'checkbox'];
105
- readonly default: 'checkbox';
98
+ readonly enum: readonly ["radio", "checkbox"];
106
99
  };
107
100
  readonly label: {
108
101
  readonly type: 'string';
@@ -121,12 +114,10 @@ export declare const redocConfigSchema: {
121
114
  readonly properties: {
122
115
  readonly hide: {
123
116
  readonly type: 'boolean';
124
- readonly default: false;
125
117
  };
126
118
  readonly component: {
127
119
  readonly type: 'string';
128
- readonly enum: readonly ['radio', 'checkbox'];
129
- readonly default: 'checkbox';
120
+ readonly enum: readonly ["radio", "checkbox"];
130
121
  };
131
122
  readonly label: {
132
123
  readonly type: 'string';
@@ -145,12 +136,10 @@ export declare const redocConfigSchema: {
145
136
  readonly properties: {
146
137
  readonly hide: {
147
138
  readonly type: 'boolean';
148
- readonly default: false;
149
139
  };
150
140
  readonly component: {
151
141
  readonly type: 'string';
152
- readonly enum: readonly ['radio', 'checkbox'];
153
- readonly default: 'checkbox';
142
+ readonly enum: readonly ["radio", "checkbox"];
154
143
  };
155
144
  readonly label: {
156
145
  readonly type: 'string';
@@ -169,12 +158,10 @@ export declare const redocConfigSchema: {
169
158
  readonly properties: {
170
159
  readonly hide: {
171
160
  readonly type: 'boolean';
172
- readonly default: false;
173
161
  };
174
162
  readonly component: {
175
163
  readonly type: 'string';
176
- readonly enum: readonly ['radio', 'checkbox'];
177
- readonly default: 'checkbox';
164
+ readonly enum: readonly ["radio", "checkbox"];
178
165
  };
179
166
  readonly label: {
180
167
  readonly type: 'string';
@@ -193,12 +180,10 @@ export declare const redocConfigSchema: {
193
180
  readonly properties: {
194
181
  readonly hide: {
195
182
  readonly type: 'boolean';
196
- readonly default: false;
197
183
  };
198
184
  readonly component: {
199
185
  readonly type: 'string';
200
- readonly enum: readonly ['radio', 'checkbox'];
201
- readonly default: 'checkbox';
186
+ readonly enum: readonly ["radio", "checkbox"];
202
187
  };
203
188
  readonly label: {
204
189
  readonly type: 'string';
@@ -220,7 +205,6 @@ export declare const redocConfigSchema: {
220
205
  readonly properties: {
221
206
  readonly hide: {
222
207
  readonly type: 'boolean';
223
- readonly default: false;
224
208
  };
225
209
  readonly label: {
226
210
  readonly type: 'string';
@@ -248,7 +232,6 @@ export declare const redocConfigSchema: {
248
232
  readonly properties: {
249
233
  readonly hide: {
250
234
  readonly type: 'boolean';
251
- readonly default: false;
252
235
  };
253
236
  readonly label: {
254
237
  readonly type: 'string';
@@ -270,7 +253,6 @@ export declare const redocConfigSchema: {
270
253
  };
271
254
  readonly oAuth2RedirectURI: {
272
255
  readonly type: 'string';
273
- readonly nullable: true;
274
256
  };
275
257
  readonly corsProxyUrl: {
276
258
  readonly type: 'string';
@@ -296,7 +278,7 @@ export declare const redocConfigSchema: {
296
278
  readonly type: 'string';
297
279
  };
298
280
  };
299
- readonly required: readonly ['url'];
281
+ readonly required: readonly ["url"];
300
282
  readonly additionalProperties: false;
301
283
  };
302
284
  };
@@ -347,7 +329,7 @@ export declare const redocConfigSchema: {
347
329
  };
348
330
  readonly position: {
349
331
  readonly type: 'string';
350
- readonly enum: readonly ['first', 'last', 'replace', 'off'];
332
+ readonly enum: readonly ["first", "last", "replace", "off"];
351
333
  };
352
334
  readonly description: {
353
335
  readonly type: 'string';
@@ -362,7 +344,7 @@ export declare const redocConfigSchema: {
362
344
  };
363
345
  readonly layout: {
364
346
  readonly type: 'string';
365
- readonly enum: readonly ['stacked', 'three-panel'];
347
+ readonly enum: readonly ["stacked", "three-panel"];
366
348
  };
367
349
  readonly hideInfoMetadata: {
368
350
  readonly type: 'boolean';
@@ -386,7 +368,6 @@ export declare const redocConfigSchema: {
386
368
  readonly properties: {
387
369
  readonly lang: {
388
370
  readonly type: 'string';
389
- readonly examples: readonly ['curl', 'JavaScript', 'Node.js', 'Python', 'Java8+Apache', 'Java', 'C#', 'C#+Newtonsoft', 'PHP', 'Go', 'Ruby', 'R', 'Payload'];
390
371
  };
391
372
  readonly label: {
392
373
  readonly type: 'string';
@@ -408,13 +389,13 @@ export declare const redocConfigSchema: {
408
389
  };
409
390
  readonly credentials: {
410
391
  readonly type: 'string';
411
- readonly enum: readonly ['omit', 'same-origin', 'include'];
392
+ readonly enum: readonly ["omit", "same-origin", "include"];
412
393
  };
413
394
  };
414
395
  readonly additionalProperties: false;
415
396
  };
416
397
  };
417
- readonly required: readonly ['lang'];
398
+ readonly required: readonly ["lang"];
418
399
  readonly additionalProperties: false;
419
400
  };
420
401
  };
package/lib/reference-docs-config-schema.d.ts CHANGED
@@ -844,7 +844,7 @@ export declare const deprecatedRefDocsSchema: {
844
844
  };
845
845
  readonly wordBreak: {
846
846
  readonly type: 'string';
847
- readonly enum: readonly ['break-all', 'break-word', 'keep-all', 'normal', 'revert', 'unset', 'inherit', 'initial'];
847
+ readonly enum: readonly ["break-all", "break-word", "keep-all", "normal", "revert", "unset", "inherit", "initial"];
848
848
  };
849
849
  readonly wrap: {
850
850
  readonly type: 'boolean';
@@ -1014,11 +1014,12 @@ export declare const deprecatedRefDocsSchema: {
1014
1014
  };
1015
1015
  readonly smoothing: {
1016
1016
  readonly type: 'string';
1017
- readonly enum: readonly ['auto', 'none', 'antialiased', 'subpixel-antialiased', 'grayscale'];
1017
+ readonly enum: readonly ["auto", "none", "antialiased", "subpixel-antialiased", "grayscale"];
1018
1018
  };
1019
1019
  };
1020
1020
  };
1021
1021
  readonly links: {
1022
+ readonly type: 'object';
1022
1023
  readonly properties: {
1023
1024
  readonly color: {
1024
1025
  readonly type: 'string';
@@ -1026,6 +1027,7 @@ export declare const deprecatedRefDocsSchema: {
1026
1027
  };
1027
1028
  };
1028
1029
  readonly codeSample: {
1030
+ readonly type: 'object';
1029
1031
  readonly properties: {
1030
1032
  readonly backgroundColor: {
1031
1033
  readonly type: 'string';
@@ -1085,14 +1087,15 @@ export declare const deprecatedRefDocsSchema: {
1085
1087
  readonly type: 'string';
1086
1088
  };
1087
1089
  readonly lang: {
1088
- readonly enum: readonly ['curl', 'C#', 'Go', 'Java', 'Java8+Apache', 'JavaScript', 'Node.js', 'PHP', 'Python', 'R', 'Ruby'];
1090
+ readonly type: 'string';
1091
+ readonly enum: readonly ["curl", "C#", "Go", "Java", "Java8+Apache", "JavaScript", "Node.js", "PHP", "Python", "R", "Ruby"];
1089
1092
  };
1090
1093
  };
1091
- readonly required: readonly ['lang'];
1094
+ readonly required: readonly ["lang"];
1092
1095
  };
1093
1096
  };
1094
1097
  };
1095
- readonly required: readonly ['languages'];
1098
+ readonly required: readonly ["languages"];
1096
1099
  };
1097
1100
  readonly generatedPayloadSamplesMaxDepth: {
1098
1101
  readonly type: 'number';
@@ -1204,7 +1207,8 @@ export declare const deprecatedRefDocsSchema: {
1204
1207
  readonly type: 'object';
1205
1208
  };
1206
1209
  readonly pagination: {
1207
- readonly enum: readonly ['none', 'section', 'item'];
1210
+ readonly type: 'string';
1211
+ readonly enum: readonly ["none", "section", "item"];
1208
1212
  };
1209
1213
  readonly pathInMiddlePanel: {
1210
1214
  readonly type: 'boolean';
@@ -1258,7 +1262,7 @@ export declare const deprecatedRefDocsSchema: {
1258
1262
  };
1259
1263
  readonly searchMode: {
1260
1264
  readonly type: 'string';
1261
- readonly enum: readonly ['default', 'path-only'];
1265
+ readonly enum: readonly ["default", "path-only"];
1262
1266
  };
1263
1267
  readonly searchOperationTitleBoost: {
1264
1268
  readonly type: 'number';
@@ -1311,7 +1315,7 @@ export declare const deprecatedRefDocsSchema: {
1311
1315
  readonly type: 'string';
1312
1316
  };
1313
1317
  };
1314
- readonly required: readonly ['label', 'link'];
1318
+ readonly required: readonly ["label", "link"];
1315
1319
  };
1316
1320
  };
1317
1321
  readonly end: {
@@ -1329,14 +1333,14 @@ export declare const deprecatedRefDocsSchema: {
1329
1333
  readonly type: 'string';
1330
1334
  };
1331
1335
  };
1332
- readonly required: readonly ['label', 'link'];
1336
+ readonly required: readonly ["label", "link"];
1333
1337
  };
1334
1338
  };
1335
1339
  };
1336
1340
  };
1337
1341
  readonly sideNavStyle: {
1338
1342
  readonly type: 'string';
1339
- readonly enum: readonly ['summary-only', 'path-first', 'id-only', 'path-only'];
1343
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
1340
1344
  };
1341
1345
  readonly simpleOneOfTypeLabel: {
1342
1346
  readonly type: 'boolean';
package/lib/reunite-config-schema.d.ts CHANGED
@@ -4,7 +4,6 @@ export declare const reuniteConfigSchema: {
4
4
  readonly ignoreLint: {
5
5
  readonly oneOf: readonly [{
6
6
  readonly type: 'boolean';
7
- readonly default: false;
8
7
  }, {
9
8
  readonly type: 'object';
10
9
  readonly additionalProperties: {
@@ -32,7 +31,7 @@ export declare const reuniteConfigSchema: {
32
31
  };
33
32
  readonly agent: {
34
33
  readonly type: 'string';
35
- readonly enum: readonly ['respect'];
34
+ readonly enum: readonly ["respect"];
36
35
  };
37
36
  readonly trigger: {
38
37
  readonly oneOf: readonly [{
@@ -40,24 +39,24 @@ export declare const reuniteConfigSchema: {
40
39
  readonly properties: {
41
40
  readonly event: {
42
41
  readonly type: 'string';
43
- readonly enum: readonly ['schedule'];
42
+ readonly enum: readonly ["schedule"];
44
43
  };
45
44
  readonly interval: {
46
45
  readonly type: 'string';
47
- readonly enum: readonly ['1m', '2m', '5m', '10m', '15m', '30m', '1h', '3h', '6h', '12h', '1d', '7d'];
46
+ readonly enum: readonly ["1m", "2m", "5m", "10m", "15m", "30m", "1h", "3h", "6h", "12h", "1d", "7d"];
48
47
  };
49
48
  };
50
- readonly required: readonly ['event'];
49
+ readonly required: readonly ["event"];
51
50
  readonly additionalProperties: false;
52
51
  }, {
53
52
  readonly type: 'object';
54
53
  readonly properties: {
55
54
  readonly event: {
56
55
  readonly type: 'string';
57
- readonly enum: readonly ['build'];
56
+ readonly enum: readonly ["build"];
58
57
  };
59
58
  };
60
- readonly required: readonly ['event'];
59
+ readonly required: readonly ["event"];
61
60
  readonly additionalProperties: false;
62
61
  }];
63
62
  };
@@ -83,19 +82,19 @@ export declare const reuniteConfigSchema: {
83
82
  readonly properties: {
84
83
  readonly schemaCheck: {
85
84
  readonly type: 'string';
86
- readonly enum: readonly ['error', 'warn', 'off'];
85
+ readonly enum: readonly ["error", "warn", "off"];
87
86
  };
88
87
  readonly statusCodeCheck: {
89
88
  readonly type: 'string';
90
- readonly enum: readonly ['error', 'warn', 'off'];
89
+ readonly enum: readonly ["error", "warn", "off"];
91
90
  };
92
91
  readonly contentTypeCheck: {
93
92
  readonly type: 'string';
94
- readonly enum: readonly ['error', 'warn', 'off'];
93
+ readonly enum: readonly ["error", "warn", "off"];
95
94
  };
96
95
  readonly successCriteriaCheck: {
97
96
  readonly type: 'string';
98
- readonly enum: readonly ['error', 'warn', 'off'];
97
+ readonly enum: readonly ["error", "warn", "off"];
99
98
  };
100
99
  };
101
100
  };
@@ -112,7 +111,7 @@ export declare const reuniteConfigSchema: {
112
111
  readonly additionalProperties: false;
113
112
  };
114
113
  };
115
- readonly required: readonly ['path', 'trigger', 'agent'];
114
+ readonly required: readonly ["path", "trigger", "agent"];
116
115
  readonly additionalProperties: false;
117
116
  };
118
117
  };