@redocly/realm 0.77.7 → 0.78.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 (91) hide show
  1. package/CHANGELOG.md +24 -1
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/cli/translations/collect-config-translations.d.ts +1 -1
  4. package/dist/cli/translations/collect-config-translations.d.ts.map +1 -1
  5. package/dist/cli/translations/collect-config-translations.js +1 -1
  6. package/dist/cli/translations/collect-config-translations.js.map +1 -1
  7. package/dist/cli/translations/index.js +2 -2
  8. package/dist/cli/translations/index.js.map +1 -1
  9. package/dist/cli/translations/update-translations.js +1 -1
  10. package/dist/cli/translations/update-translations.js.map +1 -1
  11. package/dist/client/app/Sidebar/getMenuType.d.ts.map +1 -1
  12. package/dist/client/app/Sidebar/getMenuType.js +1 -1
  13. package/dist/client/app/Sidebar/getMenuType.js.map +1 -1
  14. package/dist/client/app/Sidebar/types.d.ts +1 -1
  15. package/dist/client/app/Sidebar/types.d.ts.map +1 -1
  16. package/dist/client/providers/page-data/hooks.d.ts +4 -3
  17. package/dist/client/providers/page-data/hooks.d.ts.map +1 -1
  18. package/dist/server/config/schema.d.ts +5 -3704
  19. package/dist/server/config/schema.d.ts.map +1 -1
  20. package/dist/server/config/schema.js +1 -1
  21. package/dist/server/config/schema.js.map +1 -1
  22. package/dist/server/content/content-provider.d.ts +35 -26
  23. package/dist/server/content/content-provider.d.ts.map +1 -1
  24. package/dist/server/content/content-provider.js +1 -1
  25. package/dist/server/content/content-provider.js.map +1 -1
  26. package/dist/server/plugins/analytics/ga/build-scripts.d.ts +1 -1
  27. package/dist/server/plugins/analytics/ga/build-scripts.d.ts.map +1 -1
  28. package/dist/server/plugins/config-parser/format-error.d.ts +3 -5
  29. package/dist/server/plugins/config-parser/format-error.d.ts.map +1 -1
  30. package/dist/server/plugins/config-parser/format-error.js +8 -6
  31. package/dist/server/plugins/config-parser/format-error.js.map +1 -1
  32. package/dist/server/plugins/config-parser/index.d.ts.map +1 -1
  33. package/dist/server/plugins/config-parser/index.js +1 -3
  34. package/dist/server/plugins/config-parser/index.js.map +1 -1
  35. package/dist/server/plugins/config-parser/safe-parse.d.ts.map +1 -1
  36. package/dist/server/plugins/config-parser/safe-parse.js +1 -1
  37. package/dist/server/plugins/config-parser/safe-parse.js.map +1 -1
  38. package/dist/server/plugins/default-theme/index.js +1 -1
  39. package/dist/server/plugins/default-theme/index.js.map +1 -1
  40. package/dist/server/plugins/default-theme/resolve-products-config.d.ts +1 -1
  41. package/dist/server/plugins/default-theme/resolve-products-config.d.ts.map +1 -1
  42. package/dist/server/plugins/default-theme/resolve-products-config.js +1 -1
  43. package/dist/server/plugins/default-theme/resolve-products-config.js.map +1 -1
  44. package/dist/server/plugins/dev-onboarding/api/adapters/apigee/types.d.ts +2 -4
  45. package/dist/server/plugins/dev-onboarding/api/adapters/apigee/types.d.ts.map +1 -1
  46. package/dist/server/plugins/dev-onboarding/api/adapters/apigee/types.js +1 -1
  47. package/dist/server/plugins/dev-onboarding/api/adapters/apigee/types.js.map +1 -1
  48. package/dist/server/plugins/markdown/get-server-props.d.ts +1 -1
  49. package/dist/server/plugins/markdown/types.d.ts +2 -8
  50. package/dist/server/plugins/markdown/types.d.ts.map +1 -1
  51. package/dist/server/plugins/openapi-docs/load-definition.js.map +1 -1
  52. package/dist/server/plugins/openapi-docs/template/helpers.d.ts.map +1 -1
  53. package/dist/server/plugins/openapi-docs/template/helpers.js.map +1 -1
  54. package/dist/server/plugins/scorecard/get-scorecard-config.d.ts +25 -4
  55. package/dist/server/plugins/scorecard/get-scorecard-config.d.ts.map +1 -1
  56. package/dist/server/plugins/scorecard/index.js +1 -1
  57. package/dist/server/plugins/scorecard/index.js.map +1 -1
  58. package/dist/server/plugins/scorecard/template/useData.d.ts +10 -2
  59. package/dist/server/plugins/scorecard/template/useData.d.ts.map +1 -1
  60. package/dist/server/plugins/scorecard/utils.d.ts +1 -1
  61. package/dist/server/plugins/scorecard/utils.d.ts.map +1 -1
  62. package/dist/server/plugins/scorecard/utils.js +1 -1
  63. package/dist/server/plugins/scorecard/utils.js.map +1 -1
  64. package/dist/server/store.d.ts +60 -19
  65. package/dist/server/store.d.ts.map +1 -1
  66. package/dist/server/store.js +1 -1
  67. package/dist/server/store.js.map +1 -1
  68. package/dist/server/utils/paths.js +1 -1
  69. package/dist/server/utils/paths.js.map +1 -1
  70. package/dist/server/utils/rbac.d.ts.map +1 -1
  71. package/dist/server/utils/rbac.js +1 -1
  72. package/dist/server/utils/rbac.js.map +1 -1
  73. package/dist/server/web-server/routes/dynamic-route.js +1 -1
  74. package/dist/server/web-server/routes/dynamic-route.js.map +1 -1
  75. package/dist/shared/constants.d.ts +1 -1
  76. package/dist/shared/constants.d.ts.map +1 -1
  77. package/dist/shared/constants.js +1 -1
  78. package/dist/shared/constants.js.map +1 -1
  79. package/dist/shared/types/global-data.d.ts +2 -5
  80. package/dist/shared/types/global-data.d.ts.map +1 -1
  81. package/dist/shared/types/global-data.js +1 -1
  82. package/dist/shared/types/global-data.js.map +1 -1
  83. package/dist/shared/types/nav.d.ts +2 -205
  84. package/dist/shared/types/nav.d.ts.map +1 -1
  85. package/dist/shared/types/nav.js +0 -1
  86. package/dist/shared/types/nav.js.map +1 -1
  87. package/package.json +8 -7
  88. package/dist/server/plugins/config-parser/validate-config-rules.d.ts +0 -3
  89. package/dist/server/plugins/config-parser/validate-config-rules.d.ts.map +0 -1
  90. package/dist/server/plugins/config-parser/validate-config-rules.js +0 -1
  91. package/dist/server/plugins/config-parser/validate-config-rules.js.map +0 -1
@@ -1,3712 +1,13 @@
1
+ import { rootRedoclyConfigSchema } from '@redocly/config';
1
2
  import type { GraphQLDocsUserSettings } from '@redocly/graphql-docs';
2
- import type { ThemeConfig } from '@redocly/theme';
3
3
  import type { RawOptions } from '@redocly/openapi-docs';
4
- import type { FromSchema } from 'json-schema-to-ts';
5
- import { AuthProviderType } from '../../shared/types/global-data.js';
6
- import { ApigeeDevOnboardingIntegrationAuthType } from '../plugins/dev-onboarding/api/adapters/apigee/types.js';
7
- declare const oidcIssuerMetadataSchema: {
8
- readonly type: "object";
9
- readonly properties: {
10
- readonly end_session_endpoint: {
11
- readonly type: "string";
12
- };
13
- readonly token_endpoint: {
14
- readonly type: "string";
15
- };
16
- readonly authorization_endpoint: {
17
- readonly type: "string";
18
- };
19
- readonly jwks_uri: {
20
- readonly type: "string";
21
- };
22
- };
23
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
24
- readonly additionalProperties: true;
25
- };
26
- declare const oidcProviderConfigSchema: {
27
- readonly type: "object";
28
- readonly properties: {
29
- readonly type: {
30
- readonly type: "string";
31
- readonly const: AuthProviderType.OIDC;
32
- };
33
- readonly title: {
34
- readonly type: "string";
35
- };
36
- readonly pkce: {
37
- readonly type: "boolean";
38
- readonly default: false;
39
- };
40
- readonly configurationUrl: {
41
- readonly type: "string";
42
- readonly minLength: 1;
43
- };
44
- readonly configuration: {
45
- readonly type: "object";
46
- readonly properties: {
47
- readonly end_session_endpoint: {
48
- readonly type: "string";
49
- };
50
- readonly token_endpoint: {
51
- readonly type: "string";
52
- };
53
- readonly authorization_endpoint: {
54
- readonly type: "string";
55
- };
56
- readonly jwks_uri: {
57
- readonly type: "string";
58
- };
59
- };
60
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
61
- readonly additionalProperties: true;
62
- };
63
- readonly clientId: {
64
- readonly type: "string";
65
- readonly minLength: 1;
66
- };
67
- readonly clientSecret: {
68
- readonly type: "string";
69
- readonly minLength: 0;
70
- };
71
- readonly teamsClaimName: {
72
- readonly type: "string";
73
- };
74
- readonly teamsClaimMap: {
75
- readonly type: "object";
76
- readonly additionalProperties: {
77
- readonly type: "string";
78
- };
79
- };
80
- readonly defaultTeams: {
81
- readonly type: "array";
82
- readonly items: {
83
- readonly type: "string";
84
- };
85
- };
86
- readonly scopes: {
87
- readonly type: "array";
88
- readonly items: {
89
- readonly type: "string";
90
- };
91
- };
92
- readonly tokenExpirationTime: {
93
- readonly type: "number";
94
- };
95
- readonly authorizationRequestCustomParams: {
96
- readonly type: "object";
97
- readonly additionalProperties: {
98
- readonly type: "string";
99
- };
100
- };
101
- readonly tokenRequestCustomParams: {
102
- readonly type: "object";
103
- readonly additionalProperties: {
104
- readonly type: "string";
105
- };
106
- };
107
- readonly audience: {
108
- readonly type: "array";
109
- readonly items: {
110
- readonly type: "string";
111
- };
112
- };
113
- };
114
- readonly required: readonly ["type", "clientId"];
115
- readonly oneOf: readonly [{
116
- readonly required: readonly ["configurationUrl"];
117
- }, {
118
- readonly required: readonly ["configuration"];
119
- }];
120
- readonly additionalProperties: false;
121
- };
122
- declare const saml2ProviderConfigSchema: {
123
- readonly type: "object";
124
- readonly properties: {
125
- readonly type: {
126
- readonly type: "string";
127
- readonly const: AuthProviderType.SAML2;
128
- };
129
- readonly title: {
130
- readonly type: "string";
131
- };
132
- readonly issuerId: {
133
- readonly type: "string";
134
- };
135
- readonly entityId: {
136
- readonly type: "string";
137
- };
138
- readonly ssoUrl: {
139
- readonly type: "string";
140
- };
141
- readonly x509PublicCert: {
142
- readonly type: "string";
143
- };
144
- readonly teamsAttributeName: {
145
- readonly type: "string";
146
- readonly default: "https://redocly.com/sso/teams";
147
- };
148
- readonly teamsAttributeMap: {
149
- readonly type: "object";
150
- readonly additionalProperties: {
151
- readonly type: "string";
152
- };
153
- };
154
- readonly defaultTeams: {
155
- readonly type: "array";
156
- readonly items: {
157
- readonly type: "string";
158
- };
159
- };
160
- };
161
- readonly additionalProperties: false;
162
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
163
- };
164
- declare const basicAuthProviderConfigSchema: {
165
- readonly type: "object";
166
- readonly properties: {
167
- readonly type: {
168
- readonly type: "string";
169
- readonly const: AuthProviderType.BASIC;
170
- };
171
- readonly title: {
172
- readonly type: "string";
173
- };
174
- readonly credentials: {
175
- readonly type: "array";
176
- readonly items: {
177
- readonly type: "object";
178
- readonly properties: {
179
- readonly username: {
180
- readonly type: "string";
181
- };
182
- readonly password: {
183
- readonly type: "string";
184
- };
185
- readonly passwordHash: {
186
- readonly type: "string";
187
- };
188
- readonly teams: {
189
- readonly type: "array";
190
- readonly items: {
191
- readonly type: "string";
192
- };
193
- };
194
- };
195
- readonly required: readonly ["username"];
196
- readonly additionalProperties: false;
197
- };
198
- };
199
- };
200
- readonly required: readonly ["type", "credentials"];
201
- readonly additionalProperties: false;
202
- };
203
- declare const authProviderConfigSchema: {
204
- readonly oneOf: readonly [{
205
- readonly type: "object";
206
- readonly properties: {
207
- readonly type: {
208
- readonly type: "string";
209
- readonly const: AuthProviderType.OIDC;
210
- };
211
- readonly title: {
212
- readonly type: "string";
213
- };
214
- readonly pkce: {
215
- readonly type: "boolean";
216
- readonly default: false;
217
- };
218
- readonly configurationUrl: {
219
- readonly type: "string";
220
- readonly minLength: 1;
221
- };
222
- readonly configuration: {
223
- readonly type: "object";
224
- readonly properties: {
225
- readonly end_session_endpoint: {
226
- readonly type: "string";
227
- };
228
- readonly token_endpoint: {
229
- readonly type: "string";
230
- };
231
- readonly authorization_endpoint: {
232
- readonly type: "string";
233
- };
234
- readonly jwks_uri: {
235
- readonly type: "string";
236
- };
237
- };
238
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
239
- readonly additionalProperties: true;
240
- };
241
- readonly clientId: {
242
- readonly type: "string";
243
- readonly minLength: 1;
244
- };
245
- readonly clientSecret: {
246
- readonly type: "string";
247
- readonly minLength: 0;
248
- };
249
- readonly teamsClaimName: {
250
- readonly type: "string";
251
- };
252
- readonly teamsClaimMap: {
253
- readonly type: "object";
254
- readonly additionalProperties: {
255
- readonly type: "string";
256
- };
257
- };
258
- readonly defaultTeams: {
259
- readonly type: "array";
260
- readonly items: {
261
- readonly type: "string";
262
- };
263
- };
264
- readonly scopes: {
265
- readonly type: "array";
266
- readonly items: {
267
- readonly type: "string";
268
- };
269
- };
270
- readonly tokenExpirationTime: {
271
- readonly type: "number";
272
- };
273
- readonly authorizationRequestCustomParams: {
274
- readonly type: "object";
275
- readonly additionalProperties: {
276
- readonly type: "string";
277
- };
278
- };
279
- readonly tokenRequestCustomParams: {
280
- readonly type: "object";
281
- readonly additionalProperties: {
282
- readonly type: "string";
283
- };
284
- };
285
- readonly audience: {
286
- readonly type: "array";
287
- readonly items: {
288
- readonly type: "string";
289
- };
290
- };
291
- };
292
- readonly required: readonly ["type", "clientId"];
293
- readonly oneOf: readonly [{
294
- readonly required: readonly ["configurationUrl"];
295
- }, {
296
- readonly required: readonly ["configuration"];
297
- }];
298
- readonly additionalProperties: false;
299
- }, {
300
- readonly type: "object";
301
- readonly properties: {
302
- readonly type: {
303
- readonly type: "string";
304
- readonly const: AuthProviderType.SAML2;
305
- };
306
- readonly title: {
307
- readonly type: "string";
308
- };
309
- readonly issuerId: {
310
- readonly type: "string";
311
- };
312
- readonly entityId: {
313
- readonly type: "string";
314
- };
315
- readonly ssoUrl: {
316
- readonly type: "string";
317
- };
318
- readonly x509PublicCert: {
319
- readonly type: "string";
320
- };
321
- readonly teamsAttributeName: {
322
- readonly type: "string";
323
- readonly default: "https://redocly.com/sso/teams";
324
- };
325
- readonly teamsAttributeMap: {
326
- readonly type: "object";
327
- readonly additionalProperties: {
328
- readonly type: "string";
329
- };
330
- };
331
- readonly defaultTeams: {
332
- readonly type: "array";
333
- readonly items: {
334
- readonly type: "string";
335
- };
336
- };
337
- };
338
- readonly additionalProperties: false;
339
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
340
- }, {
341
- readonly type: "object";
342
- readonly properties: {
343
- readonly type: {
344
- readonly type: "string";
345
- readonly const: AuthProviderType.BASIC;
346
- };
347
- readonly title: {
348
- readonly type: "string";
349
- };
350
- readonly credentials: {
351
- readonly type: "array";
352
- readonly items: {
353
- readonly type: "object";
354
- readonly properties: {
355
- readonly username: {
356
- readonly type: "string";
357
- };
358
- readonly password: {
359
- readonly type: "string";
360
- };
361
- readonly passwordHash: {
362
- readonly type: "string";
363
- };
364
- readonly teams: {
365
- readonly type: "array";
366
- readonly items: {
367
- readonly type: "string";
368
- };
369
- };
370
- };
371
- readonly required: readonly ["username"];
372
- readonly additionalProperties: false;
373
- };
374
- };
375
- };
376
- readonly required: readonly ["type", "credentials"];
377
- readonly additionalProperties: false;
378
- }];
379
- readonly discriminator: {
380
- readonly propertyName: "type";
381
- };
382
- };
383
- export declare const ssoOnPremConfigSchema: {
384
- readonly type: "object";
385
- readonly additionalProperties: {
386
- readonly oneOf: readonly [{
387
- readonly type: "object";
388
- readonly properties: {
389
- readonly type: {
390
- readonly type: "string";
391
- readonly const: AuthProviderType.OIDC;
392
- };
393
- readonly title: {
394
- readonly type: "string";
395
- };
396
- readonly pkce: {
397
- readonly type: "boolean";
398
- readonly default: false;
399
- };
400
- readonly configurationUrl: {
401
- readonly type: "string";
402
- readonly minLength: 1;
403
- };
404
- readonly configuration: {
405
- readonly type: "object";
406
- readonly properties: {
407
- readonly end_session_endpoint: {
408
- readonly type: "string";
409
- };
410
- readonly token_endpoint: {
411
- readonly type: "string";
412
- };
413
- readonly authorization_endpoint: {
414
- readonly type: "string";
415
- };
416
- readonly jwks_uri: {
417
- readonly type: "string";
418
- };
419
- };
420
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
421
- readonly additionalProperties: true;
422
- };
423
- readonly clientId: {
424
- readonly type: "string";
425
- readonly minLength: 1;
426
- };
427
- readonly clientSecret: {
428
- readonly type: "string";
429
- readonly minLength: 0;
430
- };
431
- readonly teamsClaimName: {
432
- readonly type: "string";
433
- };
434
- readonly teamsClaimMap: {
435
- readonly type: "object";
436
- readonly additionalProperties: {
437
- readonly type: "string";
438
- };
439
- };
440
- readonly defaultTeams: {
441
- readonly type: "array";
442
- readonly items: {
443
- readonly type: "string";
444
- };
445
- };
446
- readonly scopes: {
447
- readonly type: "array";
448
- readonly items: {
449
- readonly type: "string";
450
- };
451
- };
452
- readonly tokenExpirationTime: {
453
- readonly type: "number";
454
- };
455
- readonly authorizationRequestCustomParams: {
456
- readonly type: "object";
457
- readonly additionalProperties: {
458
- readonly type: "string";
459
- };
460
- };
461
- readonly tokenRequestCustomParams: {
462
- readonly type: "object";
463
- readonly additionalProperties: {
464
- readonly type: "string";
465
- };
466
- };
467
- readonly audience: {
468
- readonly type: "array";
469
- readonly items: {
470
- readonly type: "string";
471
- };
472
- };
473
- };
474
- readonly required: readonly ["type", "clientId"];
475
- readonly oneOf: readonly [{
476
- readonly required: readonly ["configurationUrl"];
477
- }, {
478
- readonly required: readonly ["configuration"];
479
- }];
480
- readonly additionalProperties: false;
481
- }, {
482
- readonly type: "object";
483
- readonly properties: {
484
- readonly type: {
485
- readonly type: "string";
486
- readonly const: AuthProviderType.SAML2;
487
- };
488
- readonly title: {
489
- readonly type: "string";
490
- };
491
- readonly issuerId: {
492
- readonly type: "string";
493
- };
494
- readonly entityId: {
495
- readonly type: "string";
496
- };
497
- readonly ssoUrl: {
498
- readonly type: "string";
499
- };
500
- readonly x509PublicCert: {
501
- readonly type: "string";
502
- };
503
- readonly teamsAttributeName: {
504
- readonly type: "string";
505
- readonly default: "https://redocly.com/sso/teams";
506
- };
507
- readonly teamsAttributeMap: {
508
- readonly type: "object";
509
- readonly additionalProperties: {
510
- readonly type: "string";
511
- };
512
- };
513
- readonly defaultTeams: {
514
- readonly type: "array";
515
- readonly items: {
516
- readonly type: "string";
517
- };
518
- };
519
- };
520
- readonly additionalProperties: false;
521
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
522
- }, {
523
- readonly type: "object";
524
- readonly properties: {
525
- readonly type: {
526
- readonly type: "string";
527
- readonly const: AuthProviderType.BASIC;
528
- };
529
- readonly title: {
530
- readonly type: "string";
531
- };
532
- readonly credentials: {
533
- readonly type: "array";
534
- readonly items: {
535
- readonly type: "object";
536
- readonly properties: {
537
- readonly username: {
538
- readonly type: "string";
539
- };
540
- readonly password: {
541
- readonly type: "string";
542
- };
543
- readonly passwordHash: {
544
- readonly type: "string";
545
- };
546
- readonly teams: {
547
- readonly type: "array";
548
- readonly items: {
549
- readonly type: "string";
550
- };
551
- };
552
- };
553
- readonly required: readonly ["username"];
554
- readonly additionalProperties: false;
555
- };
556
- };
557
- };
558
- readonly required: readonly ["type", "credentials"];
559
- readonly additionalProperties: false;
560
- }];
561
- readonly discriminator: {
562
- readonly propertyName: "type";
563
- };
564
- };
565
- };
566
- export declare const ssoConfigSchema: {
567
- readonly type: readonly ["array", "string"];
568
- readonly oneOf: readonly [{
569
- readonly type: "array";
570
- readonly items: {
571
- readonly type: "string";
572
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
573
- };
574
- readonly uniqueItems: true;
575
- }, {
576
- readonly type: "string";
577
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
578
- }];
579
- };
580
- declare const redirectConfigSchema: {
581
- readonly type: "object";
582
- readonly properties: {
583
- readonly to: {
584
- readonly type: "string";
585
- };
586
- readonly type: {
587
- readonly type: "number";
588
- readonly default: 301;
589
- };
590
- };
591
- readonly additionalProperties: false;
592
- };
593
- declare const redirectsConfigSchema: {
594
- readonly type: "object";
595
- readonly additionalProperties: {
596
- readonly type: "object";
597
- readonly properties: {
598
- readonly to: {
599
- readonly type: "string";
600
- };
601
- readonly type: {
602
- readonly type: "number";
603
- readonly default: 301;
604
- };
605
- };
606
- readonly additionalProperties: false;
607
- };
608
- readonly default: {};
609
- };
610
- declare const apiConfigSchema: {
611
- readonly type: "object";
612
- readonly properties: {
613
- readonly root: {
614
- readonly type: "string";
615
- };
616
- readonly output: {
617
- readonly type: "string";
618
- readonly pattern: "(.ya?ml|.json)$";
619
- };
620
- readonly rbac: {
621
- readonly type: "object";
622
- readonly additionalProperties: true;
623
- };
624
- readonly theme: {
625
- readonly type: "object";
626
- readonly properties: {
627
- readonly openapi: {
628
- readonly type: "object";
629
- readonly additionalProperties: true;
630
- };
631
- };
632
- readonly additionalProperties: false;
633
- };
634
- readonly title: {
635
- readonly type: "string";
636
- };
637
- readonly metadata: {
638
- readonly type: "object";
639
- readonly additionalProperties: true;
640
- };
641
- };
642
- readonly additionalProperties: true;
643
- readonly required: readonly ["root"];
644
- };
645
- declare const seoConfigSchema: {
646
- readonly type: "object";
647
- readonly properties: {
648
- readonly title: {
649
- readonly type: "string";
650
- };
651
- readonly description: {
652
- readonly type: "string";
653
- };
654
- readonly siteUrl: {
655
- readonly type: "string";
656
- };
657
- readonly image: {
658
- readonly type: "string";
659
- };
660
- readonly keywords: {
661
- readonly oneOf: readonly [{
662
- readonly type: "array";
663
- readonly items: {
664
- readonly type: "string";
665
- };
666
- }, {
667
- readonly type: "string";
668
- }];
669
- };
670
- readonly lang: {
671
- readonly type: "string";
672
- };
673
- readonly jsonLd: {
674
- readonly type: "object";
675
- };
676
- readonly meta: {
677
- readonly type: "array";
678
- readonly items: {
679
- readonly type: "object";
680
- readonly properties: {
681
- readonly name: {
682
- readonly type: "string";
683
- };
684
- readonly content: {
685
- readonly type: "string";
686
- };
687
- };
688
- readonly required: readonly ["name", "content"];
689
- readonly additionalProperties: false;
690
- };
691
- };
692
- };
693
- readonly additionalProperties: false;
694
- };
695
- export type ApiConfig = FromSchema<typeof apiConfigSchema> & {
4
+ import type { ApiConfig as BasicApiConfig, RedoclyConfig, RedirectConfig, SeoConfig, SsoConfig, Saml2ProviderConfig, RbacScopeItems, AuthProviderConfig, BasicAuthProviderConfig, OidcIssuerMetadata, OidcProviderConfig, RbacConfig, RedirectsConfig, DevOnboardingAdapterConfig, I18nConfig, GraviteeAdapterConfig, ApigeeAdapterAuthOauth2, ApigeeAdapterAuthServiceAccount, ApigeeAdapterConfig } from '@redocly/config';
5
+ export type { RedoclyConfig, RedirectConfig, SeoConfig, SsoConfig, Saml2ProviderConfig, RbacScopeItems, AuthProviderConfig, BasicAuthProviderConfig, OidcIssuerMetadata, OidcProviderConfig, RbacConfig, RedirectsConfig, DevOnboardingAdapterConfig, I18nConfig, GraviteeAdapterConfig, ApigeeAdapterAuthOauth2, ApigeeAdapterAuthServiceAccount, ApigeeAdapterConfig, };
6
+ export type ApiConfig = BasicApiConfig & {
696
7
  theme: {
697
8
  openapi?: RawOptions;
698
9
  graphql?: GraphQLDocsUserSettings;
699
10
  };
700
11
  };
701
- declare const rbacScopeItemsSchema: {
702
- readonly type: "object";
703
- readonly additionalProperties: {
704
- readonly type: "string";
705
- };
706
- };
707
- declare const rbacConfigSchema: {
708
- readonly type: "object";
709
- readonly properties: {
710
- readonly cms: {
711
- readonly type: "object";
712
- readonly additionalProperties: {
713
- readonly type: "string";
714
- };
715
- };
716
- readonly content: {
717
- readonly type: "object";
718
- readonly properties: {
719
- readonly '**': {
720
- readonly type: "object";
721
- readonly additionalProperties: {
722
- readonly type: "string";
723
- };
724
- };
725
- };
726
- readonly additionalProperties: {
727
- readonly type: "object";
728
- readonly additionalProperties: {
729
- readonly type: "string";
730
- };
731
- };
732
- };
733
- };
734
- readonly additionalProperties: {
735
- readonly type: "object";
736
- readonly additionalProperties: {
737
- readonly type: "string";
738
- };
739
- };
740
- };
741
- declare const graviteeAdapterConfigSchema: {
742
- readonly type: "object";
743
- readonly properties: {
744
- readonly type: {
745
- readonly type: "string";
746
- readonly const: "GRAVITEE";
747
- };
748
- readonly apiBaseUrl: {
749
- readonly type: "string";
750
- };
751
- readonly env: {
752
- readonly type: "string";
753
- };
754
- readonly allowApiProductsOutsideCatalog: {
755
- readonly type: "boolean";
756
- readonly default: false;
757
- };
758
- readonly stage: {
759
- readonly type: "string";
760
- readonly default: "non-production";
761
- };
762
- readonly auth: {
763
- readonly type: "object";
764
- readonly properties: {
765
- readonly static: {
766
- readonly type: "string";
767
- };
768
- };
769
- };
770
- };
771
- readonly additionalProperties: false;
772
- readonly required: readonly ["type", "apiBaseUrl"];
773
- };
774
- declare const apigeeAdapterAuthOauth2Schema: {
775
- readonly type: "object";
776
- readonly properties: {
777
- readonly type: {
778
- readonly type: "string";
779
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
780
- };
781
- readonly tokenEndpoint: {
782
- readonly type: "string";
783
- };
784
- readonly clientId: {
785
- readonly type: "string";
786
- };
787
- readonly clientSecret: {
788
- readonly type: "string";
789
- };
790
- };
791
- readonly additionalProperties: false;
792
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
793
- };
794
- declare const apigeeAdapterAuthServiceAccountSchema: {
795
- readonly type: "object";
796
- readonly properties: {
797
- readonly type: {
798
- readonly type: "string";
799
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
800
- };
801
- readonly serviceAccountEmail: {
802
- readonly type: "string";
803
- };
804
- readonly serviceAccountPrivateKey: {
805
- readonly type: "string";
806
- };
807
- };
808
- readonly additionalProperties: false;
809
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
810
- };
811
- declare const apigeeXAdapterConfigSchema: {
812
- readonly type: "object";
813
- readonly properties: {
814
- readonly type: {
815
- readonly type: "string";
816
- readonly const: "APIGEE_X";
817
- };
818
- readonly apiUrl: {
819
- readonly type: "string";
820
- };
821
- readonly stage: {
822
- readonly type: "string";
823
- readonly default: "non-production";
824
- };
825
- readonly organizationName: {
826
- readonly type: "string";
827
- };
828
- readonly ignoreApiProducts: {
829
- readonly type: "array";
830
- readonly items: {
831
- readonly type: "string";
832
- };
833
- };
834
- readonly allowApiProductsOutsideCatalog: {
835
- readonly type: "boolean";
836
- readonly default: false;
837
- };
838
- readonly auth: {
839
- readonly type: "object";
840
- readonly oneOf: readonly [{
841
- readonly type: "object";
842
- readonly properties: {
843
- readonly type: {
844
- readonly type: "string";
845
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
846
- };
847
- readonly tokenEndpoint: {
848
- readonly type: "string";
849
- };
850
- readonly clientId: {
851
- readonly type: "string";
852
- };
853
- readonly clientSecret: {
854
- readonly type: "string";
855
- };
856
- };
857
- readonly additionalProperties: false;
858
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
859
- }, {
860
- readonly type: "object";
861
- readonly properties: {
862
- readonly type: {
863
- readonly type: "string";
864
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
865
- };
866
- readonly serviceAccountEmail: {
867
- readonly type: "string";
868
- };
869
- readonly serviceAccountPrivateKey: {
870
- readonly type: "string";
871
- };
872
- };
873
- readonly additionalProperties: false;
874
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
875
- }];
876
- readonly discriminator: {
877
- readonly propertyName: "type";
878
- };
879
- };
880
- };
881
- readonly additionalProperties: false;
882
- readonly required: readonly ["type", "organizationName", "auth"];
883
- };
884
- declare const apigeeEdgeAdapterConfigSchema: {
885
- readonly properties: {
886
- readonly type: {
887
- readonly type: "string";
888
- readonly const: "APIGEE_EDGE";
889
- };
890
- readonly apiUrl: {
891
- readonly type: "string";
892
- };
893
- readonly stage: {
894
- readonly type: "string";
895
- readonly default: "non-production";
896
- };
897
- readonly organizationName: {
898
- readonly type: "string";
899
- };
900
- readonly ignoreApiProducts: {
901
- readonly type: "array";
902
- readonly items: {
903
- readonly type: "string";
904
- };
905
- };
906
- readonly allowApiProductsOutsideCatalog: {
907
- readonly type: "boolean";
908
- readonly default: false;
909
- };
910
- readonly auth: {
911
- readonly type: "object";
912
- readonly oneOf: readonly [{
913
- readonly type: "object";
914
- readonly properties: {
915
- readonly type: {
916
- readonly type: "string";
917
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
918
- };
919
- readonly tokenEndpoint: {
920
- readonly type: "string";
921
- };
922
- readonly clientId: {
923
- readonly type: "string";
924
- };
925
- readonly clientSecret: {
926
- readonly type: "string";
927
- };
928
- };
929
- readonly additionalProperties: false;
930
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
931
- }, {
932
- readonly type: "object";
933
- readonly properties: {
934
- readonly type: {
935
- readonly type: "string";
936
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
937
- };
938
- readonly serviceAccountEmail: {
939
- readonly type: "string";
940
- };
941
- readonly serviceAccountPrivateKey: {
942
- readonly type: "string";
943
- };
944
- };
945
- readonly additionalProperties: false;
946
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
947
- }];
948
- readonly discriminator: {
949
- readonly propertyName: "type";
950
- };
951
- };
952
- };
953
- readonly type: "object";
954
- readonly additionalProperties: false;
955
- readonly required: readonly ["type", "organizationName", "auth"];
956
- };
957
- declare const devOnboardingAdapterConfigSchema: {
958
- readonly type: "object";
959
- readonly oneOf: readonly [{
960
- readonly type: "object";
961
- readonly properties: {
962
- readonly type: {
963
- readonly type: "string";
964
- readonly const: "APIGEE_X";
965
- };
966
- readonly apiUrl: {
967
- readonly type: "string";
968
- };
969
- readonly stage: {
970
- readonly type: "string";
971
- readonly default: "non-production";
972
- };
973
- readonly organizationName: {
974
- readonly type: "string";
975
- };
976
- readonly ignoreApiProducts: {
977
- readonly type: "array";
978
- readonly items: {
979
- readonly type: "string";
980
- };
981
- };
982
- readonly allowApiProductsOutsideCatalog: {
983
- readonly type: "boolean";
984
- readonly default: false;
985
- };
986
- readonly auth: {
987
- readonly type: "object";
988
- readonly oneOf: readonly [{
989
- readonly type: "object";
990
- readonly properties: {
991
- readonly type: {
992
- readonly type: "string";
993
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
994
- };
995
- readonly tokenEndpoint: {
996
- readonly type: "string";
997
- };
998
- readonly clientId: {
999
- readonly type: "string";
1000
- };
1001
- readonly clientSecret: {
1002
- readonly type: "string";
1003
- };
1004
- };
1005
- readonly additionalProperties: false;
1006
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
1007
- }, {
1008
- readonly type: "object";
1009
- readonly properties: {
1010
- readonly type: {
1011
- readonly type: "string";
1012
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
1013
- };
1014
- readonly serviceAccountEmail: {
1015
- readonly type: "string";
1016
- };
1017
- readonly serviceAccountPrivateKey: {
1018
- readonly type: "string";
1019
- };
1020
- };
1021
- readonly additionalProperties: false;
1022
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
1023
- }];
1024
- readonly discriminator: {
1025
- readonly propertyName: "type";
1026
- };
1027
- };
1028
- };
1029
- readonly additionalProperties: false;
1030
- readonly required: readonly ["type", "organizationName", "auth"];
1031
- }, {
1032
- readonly properties: {
1033
- readonly type: {
1034
- readonly type: "string";
1035
- readonly const: "APIGEE_EDGE";
1036
- };
1037
- readonly apiUrl: {
1038
- readonly type: "string";
1039
- };
1040
- readonly stage: {
1041
- readonly type: "string";
1042
- readonly default: "non-production";
1043
- };
1044
- readonly organizationName: {
1045
- readonly type: "string";
1046
- };
1047
- readonly ignoreApiProducts: {
1048
- readonly type: "array";
1049
- readonly items: {
1050
- readonly type: "string";
1051
- };
1052
- };
1053
- readonly allowApiProductsOutsideCatalog: {
1054
- readonly type: "boolean";
1055
- readonly default: false;
1056
- };
1057
- readonly auth: {
1058
- readonly type: "object";
1059
- readonly oneOf: readonly [{
1060
- readonly type: "object";
1061
- readonly properties: {
1062
- readonly type: {
1063
- readonly type: "string";
1064
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
1065
- };
1066
- readonly tokenEndpoint: {
1067
- readonly type: "string";
1068
- };
1069
- readonly clientId: {
1070
- readonly type: "string";
1071
- };
1072
- readonly clientSecret: {
1073
- readonly type: "string";
1074
- };
1075
- };
1076
- readonly additionalProperties: false;
1077
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
1078
- }, {
1079
- readonly type: "object";
1080
- readonly properties: {
1081
- readonly type: {
1082
- readonly type: "string";
1083
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
1084
- };
1085
- readonly serviceAccountEmail: {
1086
- readonly type: "string";
1087
- };
1088
- readonly serviceAccountPrivateKey: {
1089
- readonly type: "string";
1090
- };
1091
- };
1092
- readonly additionalProperties: false;
1093
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
1094
- }];
1095
- readonly discriminator: {
1096
- readonly propertyName: "type";
1097
- };
1098
- };
1099
- };
1100
- readonly type: "object";
1101
- readonly additionalProperties: false;
1102
- readonly required: readonly ["type", "organizationName", "auth"];
1103
- }, {
1104
- readonly type: "object";
1105
- readonly properties: {
1106
- readonly type: {
1107
- readonly type: "string";
1108
- readonly const: "GRAVITEE";
1109
- };
1110
- readonly apiBaseUrl: {
1111
- readonly type: "string";
1112
- };
1113
- readonly env: {
1114
- readonly type: "string";
1115
- };
1116
- readonly allowApiProductsOutsideCatalog: {
1117
- readonly type: "boolean";
1118
- readonly default: false;
1119
- };
1120
- readonly stage: {
1121
- readonly type: "string";
1122
- readonly default: "non-production";
1123
- };
1124
- readonly auth: {
1125
- readonly type: "object";
1126
- readonly properties: {
1127
- readonly static: {
1128
- readonly type: "string";
1129
- };
1130
- };
1131
- };
1132
- };
1133
- readonly additionalProperties: false;
1134
- readonly required: readonly ["type", "apiBaseUrl"];
1135
- }];
1136
- readonly discriminator: {
1137
- readonly propertyName: "type";
1138
- };
1139
- };
1140
- declare const i18ConfigSchema: {
1141
- readonly type: "object";
1142
- readonly properties: {
1143
- readonly defaultLocale: {
1144
- readonly type: "string";
1145
- };
1146
- readonly locales: {
1147
- readonly type: "array";
1148
- readonly items: {
1149
- readonly type: "object";
1150
- readonly properties: {
1151
- readonly code: {
1152
- readonly type: "string";
1153
- };
1154
- readonly name: {
1155
- readonly type: "string";
1156
- };
1157
- };
1158
- readonly required: readonly ["code"];
1159
- };
1160
- };
1161
- };
1162
- readonly additionalProperties: false;
1163
- readonly required: readonly ["defaultLocale"];
1164
- };
1165
- export declare const redoclyConfigSchema: {
1166
- readonly type: "object";
1167
- readonly properties: {
1168
- readonly licenseKey: {
1169
- readonly type: "string";
1170
- };
1171
- readonly theme: {
1172
- readonly type: "object";
1173
- readonly default: {};
1174
- };
1175
- readonly redirects: {
1176
- readonly type: "object";
1177
- readonly additionalProperties: {
1178
- readonly type: "object";
1179
- readonly properties: {
1180
- readonly to: {
1181
- readonly type: "string";
1182
- };
1183
- readonly type: {
1184
- readonly type: "number";
1185
- readonly default: 301;
1186
- };
1187
- };
1188
- readonly additionalProperties: false;
1189
- };
1190
- readonly default: {};
1191
- };
1192
- readonly seo: {
1193
- readonly type: "object";
1194
- readonly properties: {
1195
- readonly title: {
1196
- readonly type: "string";
1197
- };
1198
- readonly description: {
1199
- readonly type: "string";
1200
- };
1201
- readonly siteUrl: {
1202
- readonly type: "string";
1203
- };
1204
- readonly image: {
1205
- readonly type: "string";
1206
- };
1207
- readonly keywords: {
1208
- readonly oneOf: readonly [{
1209
- readonly type: "array";
1210
- readonly items: {
1211
- readonly type: "string";
1212
- };
1213
- }, {
1214
- readonly type: "string";
1215
- }];
1216
- };
1217
- readonly lang: {
1218
- readonly type: "string";
1219
- };
1220
- readonly jsonLd: {
1221
- readonly type: "object";
1222
- };
1223
- readonly meta: {
1224
- readonly type: "array";
1225
- readonly items: {
1226
- readonly type: "object";
1227
- readonly properties: {
1228
- readonly name: {
1229
- readonly type: "string";
1230
- };
1231
- readonly content: {
1232
- readonly type: "string";
1233
- };
1234
- };
1235
- readonly required: readonly ["name", "content"];
1236
- readonly additionalProperties: false;
1237
- };
1238
- };
1239
- };
1240
- readonly additionalProperties: false;
1241
- };
1242
- readonly rbac: {
1243
- readonly type: "object";
1244
- readonly properties: {
1245
- readonly cms: {
1246
- readonly type: "object";
1247
- readonly additionalProperties: {
1248
- readonly type: "string";
1249
- };
1250
- };
1251
- readonly content: {
1252
- readonly type: "object";
1253
- readonly properties: {
1254
- readonly '**': {
1255
- readonly type: "object";
1256
- readonly additionalProperties: {
1257
- readonly type: "string";
1258
- };
1259
- };
1260
- };
1261
- readonly additionalProperties: {
1262
- readonly type: "object";
1263
- readonly additionalProperties: {
1264
- readonly type: "string";
1265
- };
1266
- };
1267
- };
1268
- };
1269
- readonly additionalProperties: {
1270
- readonly type: "object";
1271
- readonly additionalProperties: {
1272
- readonly type: "string";
1273
- };
1274
- };
1275
- };
1276
- readonly responseHeaders: {
1277
- readonly type: "object";
1278
- readonly additionalProperties: {
1279
- readonly type: "array";
1280
- readonly items: {
1281
- readonly type: "object";
1282
- readonly properties: {
1283
- readonly name: {
1284
- readonly type: "string";
1285
- };
1286
- readonly value: {
1287
- readonly type: "string";
1288
- };
1289
- };
1290
- readonly additionalProperties: false;
1291
- readonly required: readonly ["name", "value"];
1292
- };
1293
- };
1294
- };
1295
- readonly mockServer: {
1296
- readonly type: "object";
1297
- readonly properties: {
1298
- readonly off: {
1299
- readonly type: "boolean";
1300
- readonly default: false;
1301
- };
1302
- readonly position: {
1303
- readonly type: "string";
1304
- readonly enum: readonly ["first", "last", "replace", "off"];
1305
- readonly default: "first";
1306
- };
1307
- readonly strictExamples: {
1308
- readonly type: "boolean";
1309
- readonly default: false;
1310
- };
1311
- readonly errorIfForcedExampleNotFound: {
1312
- readonly type: "boolean";
1313
- readonly default: false;
1314
- };
1315
- readonly description: {
1316
- readonly type: "string";
1317
- };
1318
- };
1319
- };
1320
- readonly apis: {
1321
- readonly type: "object";
1322
- readonly additionalProperties: {
1323
- readonly type: "object";
1324
- readonly properties: {
1325
- readonly root: {
1326
- readonly type: "string";
1327
- };
1328
- readonly output: {
1329
- readonly type: "string";
1330
- readonly pattern: "(.ya?ml|.json)$";
1331
- };
1332
- readonly rbac: {
1333
- readonly type: "object";
1334
- readonly additionalProperties: true;
1335
- };
1336
- readonly theme: {
1337
- readonly type: "object";
1338
- readonly properties: {
1339
- readonly openapi: {
1340
- readonly type: "object";
1341
- readonly additionalProperties: true;
1342
- };
1343
- };
1344
- readonly additionalProperties: false;
1345
- };
1346
- readonly title: {
1347
- readonly type: "string";
1348
- };
1349
- readonly metadata: {
1350
- readonly type: "object";
1351
- readonly additionalProperties: true;
1352
- };
1353
- };
1354
- readonly additionalProperties: true;
1355
- readonly required: readonly ["root"];
1356
- };
1357
- };
1358
- readonly ssoOnPrem: {
1359
- readonly type: "object";
1360
- readonly additionalProperties: {
1361
- readonly oneOf: readonly [{
1362
- readonly type: "object";
1363
- readonly properties: {
1364
- readonly type: {
1365
- readonly type: "string";
1366
- readonly const: AuthProviderType.OIDC;
1367
- };
1368
- readonly title: {
1369
- readonly type: "string";
1370
- };
1371
- readonly pkce: {
1372
- readonly type: "boolean";
1373
- readonly default: false;
1374
- };
1375
- readonly configurationUrl: {
1376
- readonly type: "string";
1377
- readonly minLength: 1;
1378
- };
1379
- readonly configuration: {
1380
- readonly type: "object";
1381
- readonly properties: {
1382
- readonly end_session_endpoint: {
1383
- readonly type: "string";
1384
- };
1385
- readonly token_endpoint: {
1386
- readonly type: "string";
1387
- };
1388
- readonly authorization_endpoint: {
1389
- readonly type: "string";
1390
- };
1391
- readonly jwks_uri: {
1392
- readonly type: "string";
1393
- };
1394
- };
1395
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
1396
- readonly additionalProperties: true;
1397
- };
1398
- readonly clientId: {
1399
- readonly type: "string";
1400
- readonly minLength: 1;
1401
- };
1402
- readonly clientSecret: {
1403
- readonly type: "string";
1404
- readonly minLength: 0;
1405
- };
1406
- readonly teamsClaimName: {
1407
- readonly type: "string";
1408
- };
1409
- readonly teamsClaimMap: {
1410
- readonly type: "object";
1411
- readonly additionalProperties: {
1412
- readonly type: "string";
1413
- };
1414
- };
1415
- readonly defaultTeams: {
1416
- readonly type: "array";
1417
- readonly items: {
1418
- readonly type: "string";
1419
- };
1420
- };
1421
- readonly scopes: {
1422
- readonly type: "array";
1423
- readonly items: {
1424
- readonly type: "string";
1425
- };
1426
- };
1427
- readonly tokenExpirationTime: {
1428
- readonly type: "number";
1429
- };
1430
- readonly authorizationRequestCustomParams: {
1431
- readonly type: "object";
1432
- readonly additionalProperties: {
1433
- readonly type: "string";
1434
- };
1435
- };
1436
- readonly tokenRequestCustomParams: {
1437
- readonly type: "object";
1438
- readonly additionalProperties: {
1439
- readonly type: "string";
1440
- };
1441
- };
1442
- readonly audience: {
1443
- readonly type: "array";
1444
- readonly items: {
1445
- readonly type: "string";
1446
- };
1447
- };
1448
- };
1449
- readonly required: readonly ["type", "clientId"];
1450
- readonly oneOf: readonly [{
1451
- readonly required: readonly ["configurationUrl"];
1452
- }, {
1453
- readonly required: readonly ["configuration"];
1454
- }];
1455
- readonly additionalProperties: false;
1456
- }, {
1457
- readonly type: "object";
1458
- readonly properties: {
1459
- readonly type: {
1460
- readonly type: "string";
1461
- readonly const: AuthProviderType.SAML2;
1462
- };
1463
- readonly title: {
1464
- readonly type: "string";
1465
- };
1466
- readonly issuerId: {
1467
- readonly type: "string";
1468
- };
1469
- readonly entityId: {
1470
- readonly type: "string";
1471
- };
1472
- readonly ssoUrl: {
1473
- readonly type: "string";
1474
- };
1475
- readonly x509PublicCert: {
1476
- readonly type: "string";
1477
- };
1478
- readonly teamsAttributeName: {
1479
- readonly type: "string";
1480
- readonly default: "https://redocly.com/sso/teams";
1481
- };
1482
- readonly teamsAttributeMap: {
1483
- readonly type: "object";
1484
- readonly additionalProperties: {
1485
- readonly type: "string";
1486
- };
1487
- };
1488
- readonly defaultTeams: {
1489
- readonly type: "array";
1490
- readonly items: {
1491
- readonly type: "string";
1492
- };
1493
- };
1494
- };
1495
- readonly additionalProperties: false;
1496
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
1497
- }, {
1498
- readonly type: "object";
1499
- readonly properties: {
1500
- readonly type: {
1501
- readonly type: "string";
1502
- readonly const: AuthProviderType.BASIC;
1503
- };
1504
- readonly title: {
1505
- readonly type: "string";
1506
- };
1507
- readonly credentials: {
1508
- readonly type: "array";
1509
- readonly items: {
1510
- readonly type: "object";
1511
- readonly properties: {
1512
- readonly username: {
1513
- readonly type: "string";
1514
- };
1515
- readonly password: {
1516
- readonly type: "string";
1517
- };
1518
- readonly passwordHash: {
1519
- readonly type: "string";
1520
- };
1521
- readonly teams: {
1522
- readonly type: "array";
1523
- readonly items: {
1524
- readonly type: "string";
1525
- };
1526
- };
1527
- };
1528
- readonly required: readonly ["username"];
1529
- readonly additionalProperties: false;
1530
- };
1531
- };
1532
- };
1533
- readonly required: readonly ["type", "credentials"];
1534
- readonly additionalProperties: false;
1535
- }];
1536
- readonly discriminator: {
1537
- readonly propertyName: "type";
1538
- };
1539
- };
1540
- };
1541
- readonly sso: {
1542
- readonly type: readonly ["array", "string"];
1543
- readonly oneOf: readonly [{
1544
- readonly type: "array";
1545
- readonly items: {
1546
- readonly type: "string";
1547
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
1548
- };
1549
- readonly uniqueItems: true;
1550
- }, {
1551
- readonly type: "string";
1552
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
1553
- }];
1554
- };
1555
- readonly residency: {
1556
- readonly type: "string";
1557
- };
1558
- readonly developerOnboarding: {
1559
- readonly type: "object";
1560
- readonly required: readonly ["adapters"];
1561
- readonly additionalProperties: false;
1562
- readonly properties: {
1563
- readonly adapters: {
1564
- readonly type: "array";
1565
- readonly items: {
1566
- readonly type: "object";
1567
- readonly oneOf: readonly [{
1568
- readonly type: "object";
1569
- readonly properties: {
1570
- readonly type: {
1571
- readonly type: "string";
1572
- readonly const: "APIGEE_X";
1573
- };
1574
- readonly apiUrl: {
1575
- readonly type: "string";
1576
- };
1577
- readonly stage: {
1578
- readonly type: "string";
1579
- readonly default: "non-production";
1580
- };
1581
- readonly organizationName: {
1582
- readonly type: "string";
1583
- };
1584
- readonly ignoreApiProducts: {
1585
- readonly type: "array";
1586
- readonly items: {
1587
- readonly type: "string";
1588
- };
1589
- };
1590
- readonly allowApiProductsOutsideCatalog: {
1591
- readonly type: "boolean";
1592
- readonly default: false;
1593
- };
1594
- readonly auth: {
1595
- readonly type: "object";
1596
- readonly oneOf: readonly [{
1597
- readonly type: "object";
1598
- readonly properties: {
1599
- readonly type: {
1600
- readonly type: "string";
1601
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
1602
- };
1603
- readonly tokenEndpoint: {
1604
- readonly type: "string";
1605
- };
1606
- readonly clientId: {
1607
- readonly type: "string";
1608
- };
1609
- readonly clientSecret: {
1610
- readonly type: "string";
1611
- };
1612
- };
1613
- readonly additionalProperties: false;
1614
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
1615
- }, {
1616
- readonly type: "object";
1617
- readonly properties: {
1618
- readonly type: {
1619
- readonly type: "string";
1620
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
1621
- };
1622
- readonly serviceAccountEmail: {
1623
- readonly type: "string";
1624
- };
1625
- readonly serviceAccountPrivateKey: {
1626
- readonly type: "string";
1627
- };
1628
- };
1629
- readonly additionalProperties: false;
1630
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
1631
- }];
1632
- readonly discriminator: {
1633
- readonly propertyName: "type";
1634
- };
1635
- };
1636
- };
1637
- readonly additionalProperties: false;
1638
- readonly required: readonly ["type", "organizationName", "auth"];
1639
- }, {
1640
- readonly properties: {
1641
- readonly type: {
1642
- readonly type: "string";
1643
- readonly const: "APIGEE_EDGE";
1644
- };
1645
- readonly apiUrl: {
1646
- readonly type: "string";
1647
- };
1648
- readonly stage: {
1649
- readonly type: "string";
1650
- readonly default: "non-production";
1651
- };
1652
- readonly organizationName: {
1653
- readonly type: "string";
1654
- };
1655
- readonly ignoreApiProducts: {
1656
- readonly type: "array";
1657
- readonly items: {
1658
- readonly type: "string";
1659
- };
1660
- };
1661
- readonly allowApiProductsOutsideCatalog: {
1662
- readonly type: "boolean";
1663
- readonly default: false;
1664
- };
1665
- readonly auth: {
1666
- readonly type: "object";
1667
- readonly oneOf: readonly [{
1668
- readonly type: "object";
1669
- readonly properties: {
1670
- readonly type: {
1671
- readonly type: "string";
1672
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
1673
- };
1674
- readonly tokenEndpoint: {
1675
- readonly type: "string";
1676
- };
1677
- readonly clientId: {
1678
- readonly type: "string";
1679
- };
1680
- readonly clientSecret: {
1681
- readonly type: "string";
1682
- };
1683
- };
1684
- readonly additionalProperties: false;
1685
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
1686
- }, {
1687
- readonly type: "object";
1688
- readonly properties: {
1689
- readonly type: {
1690
- readonly type: "string";
1691
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
1692
- };
1693
- readonly serviceAccountEmail: {
1694
- readonly type: "string";
1695
- };
1696
- readonly serviceAccountPrivateKey: {
1697
- readonly type: "string";
1698
- };
1699
- };
1700
- readonly additionalProperties: false;
1701
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
1702
- }];
1703
- readonly discriminator: {
1704
- readonly propertyName: "type";
1705
- };
1706
- };
1707
- };
1708
- readonly type: "object";
1709
- readonly additionalProperties: false;
1710
- readonly required: readonly ["type", "organizationName", "auth"];
1711
- }, {
1712
- readonly type: "object";
1713
- readonly properties: {
1714
- readonly type: {
1715
- readonly type: "string";
1716
- readonly const: "GRAVITEE";
1717
- };
1718
- readonly apiBaseUrl: {
1719
- readonly type: "string";
1720
- };
1721
- readonly env: {
1722
- readonly type: "string";
1723
- };
1724
- readonly allowApiProductsOutsideCatalog: {
1725
- readonly type: "boolean";
1726
- readonly default: false;
1727
- };
1728
- readonly stage: {
1729
- readonly type: "string";
1730
- readonly default: "non-production";
1731
- };
1732
- readonly auth: {
1733
- readonly type: "object";
1734
- readonly properties: {
1735
- readonly static: {
1736
- readonly type: "string";
1737
- };
1738
- };
1739
- };
1740
- };
1741
- readonly additionalProperties: false;
1742
- readonly required: readonly ["type", "apiBaseUrl"];
1743
- }];
1744
- readonly discriminator: {
1745
- readonly propertyName: "type";
1746
- };
1747
- };
1748
- };
1749
- };
1750
- };
1751
- readonly i18n: {
1752
- readonly type: "object";
1753
- readonly properties: {
1754
- readonly defaultLocale: {
1755
- readonly type: "string";
1756
- };
1757
- readonly locales: {
1758
- readonly type: "array";
1759
- readonly items: {
1760
- readonly type: "object";
1761
- readonly properties: {
1762
- readonly code: {
1763
- readonly type: "string";
1764
- };
1765
- readonly name: {
1766
- readonly type: "string";
1767
- };
1768
- };
1769
- readonly required: readonly ["code"];
1770
- };
1771
- };
1772
- };
1773
- readonly additionalProperties: false;
1774
- readonly required: readonly ["defaultLocale"];
1775
- };
1776
- readonly metadata: {
1777
- readonly type: "object";
1778
- readonly additionalProperties: true;
1779
- };
1780
- readonly ignore: {
1781
- readonly type: "array";
1782
- readonly items: {
1783
- readonly type: "string";
1784
- };
1785
- };
1786
- };
1787
- readonly default: {};
1788
- readonly additionalProperties: true;
1789
- };
1790
- export declare const environmentSchema: {
1791
- readonly oneOf: readonly [{
1792
- readonly additionalProperties: false;
1793
- readonly type: "object";
1794
- readonly properties: {
1795
- readonly licenseKey: {
1796
- readonly type: "string";
1797
- };
1798
- readonly theme: {
1799
- readonly type: "object";
1800
- readonly default: {};
1801
- };
1802
- readonly redirects: {
1803
- readonly type: "object";
1804
- readonly additionalProperties: {
1805
- readonly type: "object";
1806
- readonly properties: {
1807
- readonly to: {
1808
- readonly type: "string";
1809
- };
1810
- readonly type: {
1811
- readonly type: "number";
1812
- readonly default: 301;
1813
- };
1814
- };
1815
- readonly additionalProperties: false;
1816
- };
1817
- readonly default: {};
1818
- };
1819
- readonly seo: {
1820
- readonly type: "object";
1821
- readonly properties: {
1822
- readonly title: {
1823
- readonly type: "string";
1824
- };
1825
- readonly description: {
1826
- readonly type: "string";
1827
- };
1828
- readonly siteUrl: {
1829
- readonly type: "string";
1830
- };
1831
- readonly image: {
1832
- readonly type: "string";
1833
- };
1834
- readonly keywords: {
1835
- readonly oneOf: readonly [{
1836
- readonly type: "array";
1837
- readonly items: {
1838
- readonly type: "string";
1839
- };
1840
- }, {
1841
- readonly type: "string";
1842
- }];
1843
- };
1844
- readonly lang: {
1845
- readonly type: "string";
1846
- };
1847
- readonly jsonLd: {
1848
- readonly type: "object";
1849
- };
1850
- readonly meta: {
1851
- readonly type: "array";
1852
- readonly items: {
1853
- readonly type: "object";
1854
- readonly properties: {
1855
- readonly name: {
1856
- readonly type: "string";
1857
- };
1858
- readonly content: {
1859
- readonly type: "string";
1860
- };
1861
- };
1862
- readonly required: readonly ["name", "content"];
1863
- readonly additionalProperties: false;
1864
- };
1865
- };
1866
- };
1867
- readonly additionalProperties: false;
1868
- };
1869
- readonly rbac: {
1870
- readonly type: "object";
1871
- readonly properties: {
1872
- readonly cms: {
1873
- readonly type: "object";
1874
- readonly additionalProperties: {
1875
- readonly type: "string";
1876
- };
1877
- };
1878
- readonly content: {
1879
- readonly type: "object";
1880
- readonly properties: {
1881
- readonly '**': {
1882
- readonly type: "object";
1883
- readonly additionalProperties: {
1884
- readonly type: "string";
1885
- };
1886
- };
1887
- };
1888
- readonly additionalProperties: {
1889
- readonly type: "object";
1890
- readonly additionalProperties: {
1891
- readonly type: "string";
1892
- };
1893
- };
1894
- };
1895
- };
1896
- readonly additionalProperties: {
1897
- readonly type: "object";
1898
- readonly additionalProperties: {
1899
- readonly type: "string";
1900
- };
1901
- };
1902
- };
1903
- readonly responseHeaders: {
1904
- readonly type: "object";
1905
- readonly additionalProperties: {
1906
- readonly type: "array";
1907
- readonly items: {
1908
- readonly type: "object";
1909
- readonly properties: {
1910
- readonly name: {
1911
- readonly type: "string";
1912
- };
1913
- readonly value: {
1914
- readonly type: "string";
1915
- };
1916
- };
1917
- readonly additionalProperties: false;
1918
- readonly required: readonly ["name", "value"];
1919
- };
1920
- };
1921
- };
1922
- readonly mockServer: {
1923
- readonly type: "object";
1924
- readonly properties: {
1925
- readonly off: {
1926
- readonly type: "boolean";
1927
- readonly default: false;
1928
- };
1929
- readonly position: {
1930
- readonly type: "string";
1931
- readonly enum: readonly ["first", "last", "replace", "off"];
1932
- readonly default: "first";
1933
- };
1934
- readonly strictExamples: {
1935
- readonly type: "boolean";
1936
- readonly default: false;
1937
- };
1938
- readonly errorIfForcedExampleNotFound: {
1939
- readonly type: "boolean";
1940
- readonly default: false;
1941
- };
1942
- readonly description: {
1943
- readonly type: "string";
1944
- };
1945
- };
1946
- };
1947
- readonly apis: {
1948
- readonly type: "object";
1949
- readonly additionalProperties: {
1950
- readonly type: "object";
1951
- readonly properties: {
1952
- readonly root: {
1953
- readonly type: "string";
1954
- };
1955
- readonly output: {
1956
- readonly type: "string";
1957
- readonly pattern: "(.ya?ml|.json)$";
1958
- };
1959
- readonly rbac: {
1960
- readonly type: "object";
1961
- readonly additionalProperties: true;
1962
- };
1963
- readonly theme: {
1964
- readonly type: "object";
1965
- readonly properties: {
1966
- readonly openapi: {
1967
- readonly type: "object";
1968
- readonly additionalProperties: true;
1969
- };
1970
- };
1971
- readonly additionalProperties: false;
1972
- };
1973
- readonly title: {
1974
- readonly type: "string";
1975
- };
1976
- readonly metadata: {
1977
- readonly type: "object";
1978
- readonly additionalProperties: true;
1979
- };
1980
- };
1981
- readonly additionalProperties: true;
1982
- readonly required: readonly ["root"];
1983
- };
1984
- };
1985
- readonly ssoOnPrem: {
1986
- readonly type: "object";
1987
- readonly additionalProperties: {
1988
- readonly oneOf: readonly [{
1989
- readonly type: "object";
1990
- readonly properties: {
1991
- readonly type: {
1992
- readonly type: "string";
1993
- readonly const: AuthProviderType.OIDC;
1994
- };
1995
- readonly title: {
1996
- readonly type: "string";
1997
- };
1998
- readonly pkce: {
1999
- readonly type: "boolean";
2000
- readonly default: false;
2001
- };
2002
- readonly configurationUrl: {
2003
- readonly type: "string";
2004
- readonly minLength: 1;
2005
- };
2006
- readonly configuration: {
2007
- readonly type: "object";
2008
- readonly properties: {
2009
- readonly end_session_endpoint: {
2010
- readonly type: "string";
2011
- };
2012
- readonly token_endpoint: {
2013
- readonly type: "string";
2014
- };
2015
- readonly authorization_endpoint: {
2016
- readonly type: "string";
2017
- };
2018
- readonly jwks_uri: {
2019
- readonly type: "string";
2020
- };
2021
- };
2022
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
2023
- readonly additionalProperties: true;
2024
- };
2025
- readonly clientId: {
2026
- readonly type: "string";
2027
- readonly minLength: 1;
2028
- };
2029
- readonly clientSecret: {
2030
- readonly type: "string";
2031
- readonly minLength: 0;
2032
- };
2033
- readonly teamsClaimName: {
2034
- readonly type: "string";
2035
- };
2036
- readonly teamsClaimMap: {
2037
- readonly type: "object";
2038
- readonly additionalProperties: {
2039
- readonly type: "string";
2040
- };
2041
- };
2042
- readonly defaultTeams: {
2043
- readonly type: "array";
2044
- readonly items: {
2045
- readonly type: "string";
2046
- };
2047
- };
2048
- readonly scopes: {
2049
- readonly type: "array";
2050
- readonly items: {
2051
- readonly type: "string";
2052
- };
2053
- };
2054
- readonly tokenExpirationTime: {
2055
- readonly type: "number";
2056
- };
2057
- readonly authorizationRequestCustomParams: {
2058
- readonly type: "object";
2059
- readonly additionalProperties: {
2060
- readonly type: "string";
2061
- };
2062
- };
2063
- readonly tokenRequestCustomParams: {
2064
- readonly type: "object";
2065
- readonly additionalProperties: {
2066
- readonly type: "string";
2067
- };
2068
- };
2069
- readonly audience: {
2070
- readonly type: "array";
2071
- readonly items: {
2072
- readonly type: "string";
2073
- };
2074
- };
2075
- };
2076
- readonly required: readonly ["type", "clientId"];
2077
- readonly oneOf: readonly [{
2078
- readonly required: readonly ["configurationUrl"];
2079
- }, {
2080
- readonly required: readonly ["configuration"];
2081
- }];
2082
- readonly additionalProperties: false;
2083
- }, {
2084
- readonly type: "object";
2085
- readonly properties: {
2086
- readonly type: {
2087
- readonly type: "string";
2088
- readonly const: AuthProviderType.SAML2;
2089
- };
2090
- readonly title: {
2091
- readonly type: "string";
2092
- };
2093
- readonly issuerId: {
2094
- readonly type: "string";
2095
- };
2096
- readonly entityId: {
2097
- readonly type: "string";
2098
- };
2099
- readonly ssoUrl: {
2100
- readonly type: "string";
2101
- };
2102
- readonly x509PublicCert: {
2103
- readonly type: "string";
2104
- };
2105
- readonly teamsAttributeName: {
2106
- readonly type: "string";
2107
- readonly default: "https://redocly.com/sso/teams";
2108
- };
2109
- readonly teamsAttributeMap: {
2110
- readonly type: "object";
2111
- readonly additionalProperties: {
2112
- readonly type: "string";
2113
- };
2114
- };
2115
- readonly defaultTeams: {
2116
- readonly type: "array";
2117
- readonly items: {
2118
- readonly type: "string";
2119
- };
2120
- };
2121
- };
2122
- readonly additionalProperties: false;
2123
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
2124
- }, {
2125
- readonly type: "object";
2126
- readonly properties: {
2127
- readonly type: {
2128
- readonly type: "string";
2129
- readonly const: AuthProviderType.BASIC;
2130
- };
2131
- readonly title: {
2132
- readonly type: "string";
2133
- };
2134
- readonly credentials: {
2135
- readonly type: "array";
2136
- readonly items: {
2137
- readonly type: "object";
2138
- readonly properties: {
2139
- readonly username: {
2140
- readonly type: "string";
2141
- };
2142
- readonly password: {
2143
- readonly type: "string";
2144
- };
2145
- readonly passwordHash: {
2146
- readonly type: "string";
2147
- };
2148
- readonly teams: {
2149
- readonly type: "array";
2150
- readonly items: {
2151
- readonly type: "string";
2152
- };
2153
- };
2154
- };
2155
- readonly required: readonly ["username"];
2156
- readonly additionalProperties: false;
2157
- };
2158
- };
2159
- };
2160
- readonly required: readonly ["type", "credentials"];
2161
- readonly additionalProperties: false;
2162
- }];
2163
- readonly discriminator: {
2164
- readonly propertyName: "type";
2165
- };
2166
- };
2167
- };
2168
- readonly sso: {
2169
- readonly type: readonly ["array", "string"];
2170
- readonly oneOf: readonly [{
2171
- readonly type: "array";
2172
- readonly items: {
2173
- readonly type: "string";
2174
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
2175
- };
2176
- readonly uniqueItems: true;
2177
- }, {
2178
- readonly type: "string";
2179
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
2180
- }];
2181
- };
2182
- readonly residency: {
2183
- readonly type: "string";
2184
- };
2185
- readonly developerOnboarding: {
2186
- readonly type: "object";
2187
- readonly required: readonly ["adapters"];
2188
- readonly additionalProperties: false;
2189
- readonly properties: {
2190
- readonly adapters: {
2191
- readonly type: "array";
2192
- readonly items: {
2193
- readonly type: "object";
2194
- readonly oneOf: readonly [{
2195
- readonly type: "object";
2196
- readonly properties: {
2197
- readonly type: {
2198
- readonly type: "string";
2199
- readonly const: "APIGEE_X";
2200
- };
2201
- readonly apiUrl: {
2202
- readonly type: "string";
2203
- };
2204
- readonly stage: {
2205
- readonly type: "string";
2206
- readonly default: "non-production";
2207
- };
2208
- readonly organizationName: {
2209
- readonly type: "string";
2210
- };
2211
- readonly ignoreApiProducts: {
2212
- readonly type: "array";
2213
- readonly items: {
2214
- readonly type: "string";
2215
- };
2216
- };
2217
- readonly allowApiProductsOutsideCatalog: {
2218
- readonly type: "boolean";
2219
- readonly default: false;
2220
- };
2221
- readonly auth: {
2222
- readonly type: "object";
2223
- readonly oneOf: readonly [{
2224
- readonly type: "object";
2225
- readonly properties: {
2226
- readonly type: {
2227
- readonly type: "string";
2228
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
2229
- };
2230
- readonly tokenEndpoint: {
2231
- readonly type: "string";
2232
- };
2233
- readonly clientId: {
2234
- readonly type: "string";
2235
- };
2236
- readonly clientSecret: {
2237
- readonly type: "string";
2238
- };
2239
- };
2240
- readonly additionalProperties: false;
2241
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
2242
- }, {
2243
- readonly type: "object";
2244
- readonly properties: {
2245
- readonly type: {
2246
- readonly type: "string";
2247
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
2248
- };
2249
- readonly serviceAccountEmail: {
2250
- readonly type: "string";
2251
- };
2252
- readonly serviceAccountPrivateKey: {
2253
- readonly type: "string";
2254
- };
2255
- };
2256
- readonly additionalProperties: false;
2257
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
2258
- }];
2259
- readonly discriminator: {
2260
- readonly propertyName: "type";
2261
- };
2262
- };
2263
- };
2264
- readonly additionalProperties: false;
2265
- readonly required: readonly ["type", "organizationName", "auth"];
2266
- }, {
2267
- readonly properties: {
2268
- readonly type: {
2269
- readonly type: "string";
2270
- readonly const: "APIGEE_EDGE";
2271
- };
2272
- readonly apiUrl: {
2273
- readonly type: "string";
2274
- };
2275
- readonly stage: {
2276
- readonly type: "string";
2277
- readonly default: "non-production";
2278
- };
2279
- readonly organizationName: {
2280
- readonly type: "string";
2281
- };
2282
- readonly ignoreApiProducts: {
2283
- readonly type: "array";
2284
- readonly items: {
2285
- readonly type: "string";
2286
- };
2287
- };
2288
- readonly allowApiProductsOutsideCatalog: {
2289
- readonly type: "boolean";
2290
- readonly default: false;
2291
- };
2292
- readonly auth: {
2293
- readonly type: "object";
2294
- readonly oneOf: readonly [{
2295
- readonly type: "object";
2296
- readonly properties: {
2297
- readonly type: {
2298
- readonly type: "string";
2299
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
2300
- };
2301
- readonly tokenEndpoint: {
2302
- readonly type: "string";
2303
- };
2304
- readonly clientId: {
2305
- readonly type: "string";
2306
- };
2307
- readonly clientSecret: {
2308
- readonly type: "string";
2309
- };
2310
- };
2311
- readonly additionalProperties: false;
2312
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
2313
- }, {
2314
- readonly type: "object";
2315
- readonly properties: {
2316
- readonly type: {
2317
- readonly type: "string";
2318
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
2319
- };
2320
- readonly serviceAccountEmail: {
2321
- readonly type: "string";
2322
- };
2323
- readonly serviceAccountPrivateKey: {
2324
- readonly type: "string";
2325
- };
2326
- };
2327
- readonly additionalProperties: false;
2328
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
2329
- }];
2330
- readonly discriminator: {
2331
- readonly propertyName: "type";
2332
- };
2333
- };
2334
- };
2335
- readonly type: "object";
2336
- readonly additionalProperties: false;
2337
- readonly required: readonly ["type", "organizationName", "auth"];
2338
- }, {
2339
- readonly type: "object";
2340
- readonly properties: {
2341
- readonly type: {
2342
- readonly type: "string";
2343
- readonly const: "GRAVITEE";
2344
- };
2345
- readonly apiBaseUrl: {
2346
- readonly type: "string";
2347
- };
2348
- readonly env: {
2349
- readonly type: "string";
2350
- };
2351
- readonly allowApiProductsOutsideCatalog: {
2352
- readonly type: "boolean";
2353
- readonly default: false;
2354
- };
2355
- readonly stage: {
2356
- readonly type: "string";
2357
- readonly default: "non-production";
2358
- };
2359
- readonly auth: {
2360
- readonly type: "object";
2361
- readonly properties: {
2362
- readonly static: {
2363
- readonly type: "string";
2364
- };
2365
- };
2366
- };
2367
- };
2368
- readonly additionalProperties: false;
2369
- readonly required: readonly ["type", "apiBaseUrl"];
2370
- }];
2371
- readonly discriminator: {
2372
- readonly propertyName: "type";
2373
- };
2374
- };
2375
- };
2376
- };
2377
- };
2378
- readonly i18n: {
2379
- readonly type: "object";
2380
- readonly properties: {
2381
- readonly defaultLocale: {
2382
- readonly type: "string";
2383
- };
2384
- readonly locales: {
2385
- readonly type: "array";
2386
- readonly items: {
2387
- readonly type: "object";
2388
- readonly properties: {
2389
- readonly code: {
2390
- readonly type: "string";
2391
- };
2392
- readonly name: {
2393
- readonly type: "string";
2394
- };
2395
- };
2396
- readonly required: readonly ["code"];
2397
- };
2398
- };
2399
- };
2400
- readonly additionalProperties: false;
2401
- readonly required: readonly ["defaultLocale"];
2402
- };
2403
- readonly metadata: {
2404
- readonly type: "object";
2405
- readonly additionalProperties: true;
2406
- };
2407
- readonly ignore: {
2408
- readonly type: "array";
2409
- readonly items: {
2410
- readonly type: "string";
2411
- };
2412
- };
2413
- };
2414
- readonly default: {};
2415
- }, {
2416
- readonly type: "object";
2417
- readonly properties: {
2418
- readonly $ref: {
2419
- readonly type: "string";
2420
- };
2421
- };
2422
- readonly required: readonly ["$ref"];
2423
- readonly additionalProperties: false;
2424
- }];
2425
- };
2426
- export declare const rootRedoclyConfigSchema: {
2427
- readonly properties: {
2428
- readonly env: {
2429
- readonly type: "object";
2430
- readonly additionalProperties: {
2431
- readonly oneOf: readonly [{
2432
- readonly additionalProperties: false;
2433
- readonly type: "object";
2434
- readonly properties: {
2435
- readonly licenseKey: {
2436
- readonly type: "string";
2437
- };
2438
- readonly theme: {
2439
- readonly type: "object";
2440
- readonly default: {};
2441
- };
2442
- readonly redirects: {
2443
- readonly type: "object";
2444
- readonly additionalProperties: {
2445
- readonly type: "object";
2446
- readonly properties: {
2447
- readonly to: {
2448
- readonly type: "string";
2449
- };
2450
- readonly type: {
2451
- readonly type: "number";
2452
- readonly default: 301;
2453
- };
2454
- };
2455
- readonly additionalProperties: false;
2456
- };
2457
- readonly default: {};
2458
- };
2459
- readonly seo: {
2460
- readonly type: "object";
2461
- readonly properties: {
2462
- readonly title: {
2463
- readonly type: "string";
2464
- };
2465
- readonly description: {
2466
- readonly type: "string";
2467
- };
2468
- readonly siteUrl: {
2469
- readonly type: "string";
2470
- };
2471
- readonly image: {
2472
- readonly type: "string";
2473
- };
2474
- readonly keywords: {
2475
- readonly oneOf: readonly [{
2476
- readonly type: "array";
2477
- readonly items: {
2478
- readonly type: "string";
2479
- };
2480
- }, {
2481
- readonly type: "string";
2482
- }];
2483
- };
2484
- readonly lang: {
2485
- readonly type: "string";
2486
- };
2487
- readonly jsonLd: {
2488
- readonly type: "object";
2489
- };
2490
- readonly meta: {
2491
- readonly type: "array";
2492
- readonly items: {
2493
- readonly type: "object";
2494
- readonly properties: {
2495
- readonly name: {
2496
- readonly type: "string";
2497
- };
2498
- readonly content: {
2499
- readonly type: "string";
2500
- };
2501
- };
2502
- readonly required: readonly ["name", "content"];
2503
- readonly additionalProperties: false;
2504
- };
2505
- };
2506
- };
2507
- readonly additionalProperties: false;
2508
- };
2509
- readonly rbac: {
2510
- readonly type: "object";
2511
- readonly properties: {
2512
- readonly cms: {
2513
- readonly type: "object";
2514
- readonly additionalProperties: {
2515
- readonly type: "string";
2516
- };
2517
- };
2518
- readonly content: {
2519
- readonly type: "object";
2520
- readonly properties: {
2521
- readonly '**': {
2522
- readonly type: "object";
2523
- readonly additionalProperties: {
2524
- readonly type: "string";
2525
- };
2526
- };
2527
- };
2528
- readonly additionalProperties: {
2529
- readonly type: "object";
2530
- readonly additionalProperties: {
2531
- readonly type: "string";
2532
- };
2533
- };
2534
- };
2535
- };
2536
- readonly additionalProperties: {
2537
- readonly type: "object";
2538
- readonly additionalProperties: {
2539
- readonly type: "string";
2540
- };
2541
- };
2542
- };
2543
- readonly responseHeaders: {
2544
- readonly type: "object";
2545
- readonly additionalProperties: {
2546
- readonly type: "array";
2547
- readonly items: {
2548
- readonly type: "object";
2549
- readonly properties: {
2550
- readonly name: {
2551
- readonly type: "string";
2552
- };
2553
- readonly value: {
2554
- readonly type: "string";
2555
- };
2556
- };
2557
- readonly additionalProperties: false;
2558
- readonly required: readonly ["name", "value"];
2559
- };
2560
- };
2561
- };
2562
- readonly mockServer: {
2563
- readonly type: "object";
2564
- readonly properties: {
2565
- readonly off: {
2566
- readonly type: "boolean";
2567
- readonly default: false;
2568
- };
2569
- readonly position: {
2570
- readonly type: "string";
2571
- readonly enum: readonly ["first", "last", "replace", "off"];
2572
- readonly default: "first";
2573
- };
2574
- readonly strictExamples: {
2575
- readonly type: "boolean";
2576
- readonly default: false;
2577
- };
2578
- readonly errorIfForcedExampleNotFound: {
2579
- readonly type: "boolean";
2580
- readonly default: false;
2581
- };
2582
- readonly description: {
2583
- readonly type: "string";
2584
- };
2585
- };
2586
- };
2587
- readonly apis: {
2588
- readonly type: "object";
2589
- readonly additionalProperties: {
2590
- readonly type: "object";
2591
- readonly properties: {
2592
- readonly root: {
2593
- readonly type: "string";
2594
- };
2595
- readonly output: {
2596
- readonly type: "string";
2597
- readonly pattern: "(.ya?ml|.json)$";
2598
- };
2599
- readonly rbac: {
2600
- readonly type: "object";
2601
- readonly additionalProperties: true;
2602
- };
2603
- readonly theme: {
2604
- readonly type: "object";
2605
- readonly properties: {
2606
- readonly openapi: {
2607
- readonly type: "object";
2608
- readonly additionalProperties: true;
2609
- };
2610
- };
2611
- readonly additionalProperties: false;
2612
- };
2613
- readonly title: {
2614
- readonly type: "string";
2615
- };
2616
- readonly metadata: {
2617
- readonly type: "object";
2618
- readonly additionalProperties: true;
2619
- };
2620
- };
2621
- readonly additionalProperties: true;
2622
- readonly required: readonly ["root"];
2623
- };
2624
- };
2625
- readonly ssoOnPrem: {
2626
- readonly type: "object";
2627
- readonly additionalProperties: {
2628
- readonly oneOf: readonly [{
2629
- readonly type: "object";
2630
- readonly properties: {
2631
- readonly type: {
2632
- readonly type: "string";
2633
- readonly const: AuthProviderType.OIDC;
2634
- };
2635
- readonly title: {
2636
- readonly type: "string";
2637
- };
2638
- readonly pkce: {
2639
- readonly type: "boolean";
2640
- readonly default: false;
2641
- };
2642
- readonly configurationUrl: {
2643
- readonly type: "string";
2644
- readonly minLength: 1;
2645
- };
2646
- readonly configuration: {
2647
- readonly type: "object";
2648
- readonly properties: {
2649
- readonly end_session_endpoint: {
2650
- readonly type: "string";
2651
- };
2652
- readonly token_endpoint: {
2653
- readonly type: "string";
2654
- };
2655
- readonly authorization_endpoint: {
2656
- readonly type: "string";
2657
- };
2658
- readonly jwks_uri: {
2659
- readonly type: "string";
2660
- };
2661
- };
2662
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
2663
- readonly additionalProperties: true;
2664
- };
2665
- readonly clientId: {
2666
- readonly type: "string";
2667
- readonly minLength: 1;
2668
- };
2669
- readonly clientSecret: {
2670
- readonly type: "string";
2671
- readonly minLength: 0;
2672
- };
2673
- readonly teamsClaimName: {
2674
- readonly type: "string";
2675
- };
2676
- readonly teamsClaimMap: {
2677
- readonly type: "object";
2678
- readonly additionalProperties: {
2679
- readonly type: "string";
2680
- };
2681
- };
2682
- readonly defaultTeams: {
2683
- readonly type: "array";
2684
- readonly items: {
2685
- readonly type: "string";
2686
- };
2687
- };
2688
- readonly scopes: {
2689
- readonly type: "array";
2690
- readonly items: {
2691
- readonly type: "string";
2692
- };
2693
- };
2694
- readonly tokenExpirationTime: {
2695
- readonly type: "number";
2696
- };
2697
- readonly authorizationRequestCustomParams: {
2698
- readonly type: "object";
2699
- readonly additionalProperties: {
2700
- readonly type: "string";
2701
- };
2702
- };
2703
- readonly tokenRequestCustomParams: {
2704
- readonly type: "object";
2705
- readonly additionalProperties: {
2706
- readonly type: "string";
2707
- };
2708
- };
2709
- readonly audience: {
2710
- readonly type: "array";
2711
- readonly items: {
2712
- readonly type: "string";
2713
- };
2714
- };
2715
- };
2716
- readonly required: readonly ["type", "clientId"];
2717
- readonly oneOf: readonly [{
2718
- readonly required: readonly ["configurationUrl"];
2719
- }, {
2720
- readonly required: readonly ["configuration"];
2721
- }];
2722
- readonly additionalProperties: false;
2723
- }, {
2724
- readonly type: "object";
2725
- readonly properties: {
2726
- readonly type: {
2727
- readonly type: "string";
2728
- readonly const: AuthProviderType.SAML2;
2729
- };
2730
- readonly title: {
2731
- readonly type: "string";
2732
- };
2733
- readonly issuerId: {
2734
- readonly type: "string";
2735
- };
2736
- readonly entityId: {
2737
- readonly type: "string";
2738
- };
2739
- readonly ssoUrl: {
2740
- readonly type: "string";
2741
- };
2742
- readonly x509PublicCert: {
2743
- readonly type: "string";
2744
- };
2745
- readonly teamsAttributeName: {
2746
- readonly type: "string";
2747
- readonly default: "https://redocly.com/sso/teams";
2748
- };
2749
- readonly teamsAttributeMap: {
2750
- readonly type: "object";
2751
- readonly additionalProperties: {
2752
- readonly type: "string";
2753
- };
2754
- };
2755
- readonly defaultTeams: {
2756
- readonly type: "array";
2757
- readonly items: {
2758
- readonly type: "string";
2759
- };
2760
- };
2761
- };
2762
- readonly additionalProperties: false;
2763
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
2764
- }, {
2765
- readonly type: "object";
2766
- readonly properties: {
2767
- readonly type: {
2768
- readonly type: "string";
2769
- readonly const: AuthProviderType.BASIC;
2770
- };
2771
- readonly title: {
2772
- readonly type: "string";
2773
- };
2774
- readonly credentials: {
2775
- readonly type: "array";
2776
- readonly items: {
2777
- readonly type: "object";
2778
- readonly properties: {
2779
- readonly username: {
2780
- readonly type: "string";
2781
- };
2782
- readonly password: {
2783
- readonly type: "string";
2784
- };
2785
- readonly passwordHash: {
2786
- readonly type: "string";
2787
- };
2788
- readonly teams: {
2789
- readonly type: "array";
2790
- readonly items: {
2791
- readonly type: "string";
2792
- };
2793
- };
2794
- };
2795
- readonly required: readonly ["username"];
2796
- readonly additionalProperties: false;
2797
- };
2798
- };
2799
- };
2800
- readonly required: readonly ["type", "credentials"];
2801
- readonly additionalProperties: false;
2802
- }];
2803
- readonly discriminator: {
2804
- readonly propertyName: "type";
2805
- };
2806
- };
2807
- };
2808
- readonly sso: {
2809
- readonly type: readonly ["array", "string"];
2810
- readonly oneOf: readonly [{
2811
- readonly type: "array";
2812
- readonly items: {
2813
- readonly type: "string";
2814
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
2815
- };
2816
- readonly uniqueItems: true;
2817
- }, {
2818
- readonly type: "string";
2819
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
2820
- }];
2821
- };
2822
- readonly residency: {
2823
- readonly type: "string";
2824
- };
2825
- readonly developerOnboarding: {
2826
- readonly type: "object";
2827
- readonly required: readonly ["adapters"];
2828
- readonly additionalProperties: false;
2829
- readonly properties: {
2830
- readonly adapters: {
2831
- readonly type: "array";
2832
- readonly items: {
2833
- readonly type: "object";
2834
- readonly oneOf: readonly [{
2835
- readonly type: "object";
2836
- readonly properties: {
2837
- readonly type: {
2838
- readonly type: "string";
2839
- readonly const: "APIGEE_X";
2840
- };
2841
- readonly apiUrl: {
2842
- readonly type: "string";
2843
- };
2844
- readonly stage: {
2845
- readonly type: "string";
2846
- readonly default: "non-production";
2847
- };
2848
- readonly organizationName: {
2849
- readonly type: "string";
2850
- };
2851
- readonly ignoreApiProducts: {
2852
- readonly type: "array";
2853
- readonly items: {
2854
- readonly type: "string";
2855
- };
2856
- };
2857
- readonly allowApiProductsOutsideCatalog: {
2858
- readonly type: "boolean";
2859
- readonly default: false;
2860
- };
2861
- readonly auth: {
2862
- readonly type: "object";
2863
- readonly oneOf: readonly [{
2864
- readonly type: "object";
2865
- readonly properties: {
2866
- readonly type: {
2867
- readonly type: "string";
2868
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
2869
- };
2870
- readonly tokenEndpoint: {
2871
- readonly type: "string";
2872
- };
2873
- readonly clientId: {
2874
- readonly type: "string";
2875
- };
2876
- readonly clientSecret: {
2877
- readonly type: "string";
2878
- };
2879
- };
2880
- readonly additionalProperties: false;
2881
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
2882
- }, {
2883
- readonly type: "object";
2884
- readonly properties: {
2885
- readonly type: {
2886
- readonly type: "string";
2887
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
2888
- };
2889
- readonly serviceAccountEmail: {
2890
- readonly type: "string";
2891
- };
2892
- readonly serviceAccountPrivateKey: {
2893
- readonly type: "string";
2894
- };
2895
- };
2896
- readonly additionalProperties: false;
2897
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
2898
- }];
2899
- readonly discriminator: {
2900
- readonly propertyName: "type";
2901
- };
2902
- };
2903
- };
2904
- readonly additionalProperties: false;
2905
- readonly required: readonly ["type", "organizationName", "auth"];
2906
- }, {
2907
- readonly properties: {
2908
- readonly type: {
2909
- readonly type: "string";
2910
- readonly const: "APIGEE_EDGE";
2911
- };
2912
- readonly apiUrl: {
2913
- readonly type: "string";
2914
- };
2915
- readonly stage: {
2916
- readonly type: "string";
2917
- readonly default: "non-production";
2918
- };
2919
- readonly organizationName: {
2920
- readonly type: "string";
2921
- };
2922
- readonly ignoreApiProducts: {
2923
- readonly type: "array";
2924
- readonly items: {
2925
- readonly type: "string";
2926
- };
2927
- };
2928
- readonly allowApiProductsOutsideCatalog: {
2929
- readonly type: "boolean";
2930
- readonly default: false;
2931
- };
2932
- readonly auth: {
2933
- readonly type: "object";
2934
- readonly oneOf: readonly [{
2935
- readonly type: "object";
2936
- readonly properties: {
2937
- readonly type: {
2938
- readonly type: "string";
2939
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
2940
- };
2941
- readonly tokenEndpoint: {
2942
- readonly type: "string";
2943
- };
2944
- readonly clientId: {
2945
- readonly type: "string";
2946
- };
2947
- readonly clientSecret: {
2948
- readonly type: "string";
2949
- };
2950
- };
2951
- readonly additionalProperties: false;
2952
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
2953
- }, {
2954
- readonly type: "object";
2955
- readonly properties: {
2956
- readonly type: {
2957
- readonly type: "string";
2958
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
2959
- };
2960
- readonly serviceAccountEmail: {
2961
- readonly type: "string";
2962
- };
2963
- readonly serviceAccountPrivateKey: {
2964
- readonly type: "string";
2965
- };
2966
- };
2967
- readonly additionalProperties: false;
2968
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
2969
- }];
2970
- readonly discriminator: {
2971
- readonly propertyName: "type";
2972
- };
2973
- };
2974
- };
2975
- readonly type: "object";
2976
- readonly additionalProperties: false;
2977
- readonly required: readonly ["type", "organizationName", "auth"];
2978
- }, {
2979
- readonly type: "object";
2980
- readonly properties: {
2981
- readonly type: {
2982
- readonly type: "string";
2983
- readonly const: "GRAVITEE";
2984
- };
2985
- readonly apiBaseUrl: {
2986
- readonly type: "string";
2987
- };
2988
- readonly env: {
2989
- readonly type: "string";
2990
- };
2991
- readonly allowApiProductsOutsideCatalog: {
2992
- readonly type: "boolean";
2993
- readonly default: false;
2994
- };
2995
- readonly stage: {
2996
- readonly type: "string";
2997
- readonly default: "non-production";
2998
- };
2999
- readonly auth: {
3000
- readonly type: "object";
3001
- readonly properties: {
3002
- readonly static: {
3003
- readonly type: "string";
3004
- };
3005
- };
3006
- };
3007
- };
3008
- readonly additionalProperties: false;
3009
- readonly required: readonly ["type", "apiBaseUrl"];
3010
- }];
3011
- readonly discriminator: {
3012
- readonly propertyName: "type";
3013
- };
3014
- };
3015
- };
3016
- };
3017
- };
3018
- readonly i18n: {
3019
- readonly type: "object";
3020
- readonly properties: {
3021
- readonly defaultLocale: {
3022
- readonly type: "string";
3023
- };
3024
- readonly locales: {
3025
- readonly type: "array";
3026
- readonly items: {
3027
- readonly type: "object";
3028
- readonly properties: {
3029
- readonly code: {
3030
- readonly type: "string";
3031
- };
3032
- readonly name: {
3033
- readonly type: "string";
3034
- };
3035
- };
3036
- readonly required: readonly ["code"];
3037
- };
3038
- };
3039
- };
3040
- readonly additionalProperties: false;
3041
- readonly required: readonly ["defaultLocale"];
3042
- };
3043
- readonly metadata: {
3044
- readonly type: "object";
3045
- readonly additionalProperties: true;
3046
- };
3047
- readonly ignore: {
3048
- readonly type: "array";
3049
- readonly items: {
3050
- readonly type: "string";
3051
- };
3052
- };
3053
- };
3054
- readonly default: {};
3055
- }, {
3056
- readonly type: "object";
3057
- readonly properties: {
3058
- readonly $ref: {
3059
- readonly type: "string";
3060
- };
3061
- };
3062
- readonly required: readonly ["$ref"];
3063
- readonly additionalProperties: false;
3064
- }];
3065
- };
3066
- };
3067
- readonly licenseKey: {
3068
- readonly type: "string";
3069
- };
3070
- readonly theme: {
3071
- readonly type: "object";
3072
- readonly default: {};
3073
- };
3074
- readonly redirects: {
3075
- readonly type: "object";
3076
- readonly additionalProperties: {
3077
- readonly type: "object";
3078
- readonly properties: {
3079
- readonly to: {
3080
- readonly type: "string";
3081
- };
3082
- readonly type: {
3083
- readonly type: "number";
3084
- readonly default: 301;
3085
- };
3086
- };
3087
- readonly additionalProperties: false;
3088
- };
3089
- readonly default: {};
3090
- };
3091
- readonly seo: {
3092
- readonly type: "object";
3093
- readonly properties: {
3094
- readonly title: {
3095
- readonly type: "string";
3096
- };
3097
- readonly description: {
3098
- readonly type: "string";
3099
- };
3100
- readonly siteUrl: {
3101
- readonly type: "string";
3102
- };
3103
- readonly image: {
3104
- readonly type: "string";
3105
- };
3106
- readonly keywords: {
3107
- readonly oneOf: readonly [{
3108
- readonly type: "array";
3109
- readonly items: {
3110
- readonly type: "string";
3111
- };
3112
- }, {
3113
- readonly type: "string";
3114
- }];
3115
- };
3116
- readonly lang: {
3117
- readonly type: "string";
3118
- };
3119
- readonly jsonLd: {
3120
- readonly type: "object";
3121
- };
3122
- readonly meta: {
3123
- readonly type: "array";
3124
- readonly items: {
3125
- readonly type: "object";
3126
- readonly properties: {
3127
- readonly name: {
3128
- readonly type: "string";
3129
- };
3130
- readonly content: {
3131
- readonly type: "string";
3132
- };
3133
- };
3134
- readonly required: readonly ["name", "content"];
3135
- readonly additionalProperties: false;
3136
- };
3137
- };
3138
- };
3139
- readonly additionalProperties: false;
3140
- };
3141
- readonly rbac: {
3142
- readonly type: "object";
3143
- readonly properties: {
3144
- readonly cms: {
3145
- readonly type: "object";
3146
- readonly additionalProperties: {
3147
- readonly type: "string";
3148
- };
3149
- };
3150
- readonly content: {
3151
- readonly type: "object";
3152
- readonly properties: {
3153
- readonly '**': {
3154
- readonly type: "object";
3155
- readonly additionalProperties: {
3156
- readonly type: "string";
3157
- };
3158
- };
3159
- };
3160
- readonly additionalProperties: {
3161
- readonly type: "object";
3162
- readonly additionalProperties: {
3163
- readonly type: "string";
3164
- };
3165
- };
3166
- };
3167
- };
3168
- readonly additionalProperties: {
3169
- readonly type: "object";
3170
- readonly additionalProperties: {
3171
- readonly type: "string";
3172
- };
3173
- };
3174
- };
3175
- readonly responseHeaders: {
3176
- readonly type: "object";
3177
- readonly additionalProperties: {
3178
- readonly type: "array";
3179
- readonly items: {
3180
- readonly type: "object";
3181
- readonly properties: {
3182
- readonly name: {
3183
- readonly type: "string";
3184
- };
3185
- readonly value: {
3186
- readonly type: "string";
3187
- };
3188
- };
3189
- readonly additionalProperties: false;
3190
- readonly required: readonly ["name", "value"];
3191
- };
3192
- };
3193
- };
3194
- readonly mockServer: {
3195
- readonly type: "object";
3196
- readonly properties: {
3197
- readonly off: {
3198
- readonly type: "boolean";
3199
- readonly default: false;
3200
- };
3201
- readonly position: {
3202
- readonly type: "string";
3203
- readonly enum: readonly ["first", "last", "replace", "off"];
3204
- readonly default: "first";
3205
- };
3206
- readonly strictExamples: {
3207
- readonly type: "boolean";
3208
- readonly default: false;
3209
- };
3210
- readonly errorIfForcedExampleNotFound: {
3211
- readonly type: "boolean";
3212
- readonly default: false;
3213
- };
3214
- readonly description: {
3215
- readonly type: "string";
3216
- };
3217
- };
3218
- };
3219
- readonly apis: {
3220
- readonly type: "object";
3221
- readonly additionalProperties: {
3222
- readonly type: "object";
3223
- readonly properties: {
3224
- readonly root: {
3225
- readonly type: "string";
3226
- };
3227
- readonly output: {
3228
- readonly type: "string";
3229
- readonly pattern: "(.ya?ml|.json)$";
3230
- };
3231
- readonly rbac: {
3232
- readonly type: "object";
3233
- readonly additionalProperties: true;
3234
- };
3235
- readonly theme: {
3236
- readonly type: "object";
3237
- readonly properties: {
3238
- readonly openapi: {
3239
- readonly type: "object";
3240
- readonly additionalProperties: true;
3241
- };
3242
- };
3243
- readonly additionalProperties: false;
3244
- };
3245
- readonly title: {
3246
- readonly type: "string";
3247
- };
3248
- readonly metadata: {
3249
- readonly type: "object";
3250
- readonly additionalProperties: true;
3251
- };
3252
- };
3253
- readonly additionalProperties: true;
3254
- readonly required: readonly ["root"];
3255
- };
3256
- };
3257
- readonly ssoOnPrem: {
3258
- readonly type: "object";
3259
- readonly additionalProperties: {
3260
- readonly oneOf: readonly [{
3261
- readonly type: "object";
3262
- readonly properties: {
3263
- readonly type: {
3264
- readonly type: "string";
3265
- readonly const: AuthProviderType.OIDC;
3266
- };
3267
- readonly title: {
3268
- readonly type: "string";
3269
- };
3270
- readonly pkce: {
3271
- readonly type: "boolean";
3272
- readonly default: false;
3273
- };
3274
- readonly configurationUrl: {
3275
- readonly type: "string";
3276
- readonly minLength: 1;
3277
- };
3278
- readonly configuration: {
3279
- readonly type: "object";
3280
- readonly properties: {
3281
- readonly end_session_endpoint: {
3282
- readonly type: "string";
3283
- };
3284
- readonly token_endpoint: {
3285
- readonly type: "string";
3286
- };
3287
- readonly authorization_endpoint: {
3288
- readonly type: "string";
3289
- };
3290
- readonly jwks_uri: {
3291
- readonly type: "string";
3292
- };
3293
- };
3294
- readonly required: readonly ["token_endpoint", "authorization_endpoint"];
3295
- readonly additionalProperties: true;
3296
- };
3297
- readonly clientId: {
3298
- readonly type: "string";
3299
- readonly minLength: 1;
3300
- };
3301
- readonly clientSecret: {
3302
- readonly type: "string";
3303
- readonly minLength: 0;
3304
- };
3305
- readonly teamsClaimName: {
3306
- readonly type: "string";
3307
- };
3308
- readonly teamsClaimMap: {
3309
- readonly type: "object";
3310
- readonly additionalProperties: {
3311
- readonly type: "string";
3312
- };
3313
- };
3314
- readonly defaultTeams: {
3315
- readonly type: "array";
3316
- readonly items: {
3317
- readonly type: "string";
3318
- };
3319
- };
3320
- readonly scopes: {
3321
- readonly type: "array";
3322
- readonly items: {
3323
- readonly type: "string";
3324
- };
3325
- };
3326
- readonly tokenExpirationTime: {
3327
- readonly type: "number";
3328
- };
3329
- readonly authorizationRequestCustomParams: {
3330
- readonly type: "object";
3331
- readonly additionalProperties: {
3332
- readonly type: "string";
3333
- };
3334
- };
3335
- readonly tokenRequestCustomParams: {
3336
- readonly type: "object";
3337
- readonly additionalProperties: {
3338
- readonly type: "string";
3339
- };
3340
- };
3341
- readonly audience: {
3342
- readonly type: "array";
3343
- readonly items: {
3344
- readonly type: "string";
3345
- };
3346
- };
3347
- };
3348
- readonly required: readonly ["type", "clientId"];
3349
- readonly oneOf: readonly [{
3350
- readonly required: readonly ["configurationUrl"];
3351
- }, {
3352
- readonly required: readonly ["configuration"];
3353
- }];
3354
- readonly additionalProperties: false;
3355
- }, {
3356
- readonly type: "object";
3357
- readonly properties: {
3358
- readonly type: {
3359
- readonly type: "string";
3360
- readonly const: AuthProviderType.SAML2;
3361
- };
3362
- readonly title: {
3363
- readonly type: "string";
3364
- };
3365
- readonly issuerId: {
3366
- readonly type: "string";
3367
- };
3368
- readonly entityId: {
3369
- readonly type: "string";
3370
- };
3371
- readonly ssoUrl: {
3372
- readonly type: "string";
3373
- };
3374
- readonly x509PublicCert: {
3375
- readonly type: "string";
3376
- };
3377
- readonly teamsAttributeName: {
3378
- readonly type: "string";
3379
- readonly default: "https://redocly.com/sso/teams";
3380
- };
3381
- readonly teamsAttributeMap: {
3382
- readonly type: "object";
3383
- readonly additionalProperties: {
3384
- readonly type: "string";
3385
- };
3386
- };
3387
- readonly defaultTeams: {
3388
- readonly type: "array";
3389
- readonly items: {
3390
- readonly type: "string";
3391
- };
3392
- };
3393
- };
3394
- readonly additionalProperties: false;
3395
- readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
3396
- }, {
3397
- readonly type: "object";
3398
- readonly properties: {
3399
- readonly type: {
3400
- readonly type: "string";
3401
- readonly const: AuthProviderType.BASIC;
3402
- };
3403
- readonly title: {
3404
- readonly type: "string";
3405
- };
3406
- readonly credentials: {
3407
- readonly type: "array";
3408
- readonly items: {
3409
- readonly type: "object";
3410
- readonly properties: {
3411
- readonly username: {
3412
- readonly type: "string";
3413
- };
3414
- readonly password: {
3415
- readonly type: "string";
3416
- };
3417
- readonly passwordHash: {
3418
- readonly type: "string";
3419
- };
3420
- readonly teams: {
3421
- readonly type: "array";
3422
- readonly items: {
3423
- readonly type: "string";
3424
- };
3425
- };
3426
- };
3427
- readonly required: readonly ["username"];
3428
- readonly additionalProperties: false;
3429
- };
3430
- };
3431
- };
3432
- readonly required: readonly ["type", "credentials"];
3433
- readonly additionalProperties: false;
3434
- }];
3435
- readonly discriminator: {
3436
- readonly propertyName: "type";
3437
- };
3438
- };
3439
- };
3440
- readonly sso: {
3441
- readonly type: readonly ["array", "string"];
3442
- readonly oneOf: readonly [{
3443
- readonly type: "array";
3444
- readonly items: {
3445
- readonly type: "string";
3446
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
3447
- };
3448
- readonly uniqueItems: true;
3449
- }, {
3450
- readonly type: "string";
3451
- readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
3452
- }];
3453
- };
3454
- readonly residency: {
3455
- readonly type: "string";
3456
- };
3457
- readonly developerOnboarding: {
3458
- readonly type: "object";
3459
- readonly required: readonly ["adapters"];
3460
- readonly additionalProperties: false;
3461
- readonly properties: {
3462
- readonly adapters: {
3463
- readonly type: "array";
3464
- readonly items: {
3465
- readonly type: "object";
3466
- readonly oneOf: readonly [{
3467
- readonly type: "object";
3468
- readonly properties: {
3469
- readonly type: {
3470
- readonly type: "string";
3471
- readonly const: "APIGEE_X";
3472
- };
3473
- readonly apiUrl: {
3474
- readonly type: "string";
3475
- };
3476
- readonly stage: {
3477
- readonly type: "string";
3478
- readonly default: "non-production";
3479
- };
3480
- readonly organizationName: {
3481
- readonly type: "string";
3482
- };
3483
- readonly ignoreApiProducts: {
3484
- readonly type: "array";
3485
- readonly items: {
3486
- readonly type: "string";
3487
- };
3488
- };
3489
- readonly allowApiProductsOutsideCatalog: {
3490
- readonly type: "boolean";
3491
- readonly default: false;
3492
- };
3493
- readonly auth: {
3494
- readonly type: "object";
3495
- readonly oneOf: readonly [{
3496
- readonly type: "object";
3497
- readonly properties: {
3498
- readonly type: {
3499
- readonly type: "string";
3500
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
3501
- };
3502
- readonly tokenEndpoint: {
3503
- readonly type: "string";
3504
- };
3505
- readonly clientId: {
3506
- readonly type: "string";
3507
- };
3508
- readonly clientSecret: {
3509
- readonly type: "string";
3510
- };
3511
- };
3512
- readonly additionalProperties: false;
3513
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
3514
- }, {
3515
- readonly type: "object";
3516
- readonly properties: {
3517
- readonly type: {
3518
- readonly type: "string";
3519
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
3520
- };
3521
- readonly serviceAccountEmail: {
3522
- readonly type: "string";
3523
- };
3524
- readonly serviceAccountPrivateKey: {
3525
- readonly type: "string";
3526
- };
3527
- };
3528
- readonly additionalProperties: false;
3529
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
3530
- }];
3531
- readonly discriminator: {
3532
- readonly propertyName: "type";
3533
- };
3534
- };
3535
- };
3536
- readonly additionalProperties: false;
3537
- readonly required: readonly ["type", "organizationName", "auth"];
3538
- }, {
3539
- readonly properties: {
3540
- readonly type: {
3541
- readonly type: "string";
3542
- readonly const: "APIGEE_EDGE";
3543
- };
3544
- readonly apiUrl: {
3545
- readonly type: "string";
3546
- };
3547
- readonly stage: {
3548
- readonly type: "string";
3549
- readonly default: "non-production";
3550
- };
3551
- readonly organizationName: {
3552
- readonly type: "string";
3553
- };
3554
- readonly ignoreApiProducts: {
3555
- readonly type: "array";
3556
- readonly items: {
3557
- readonly type: "string";
3558
- };
3559
- };
3560
- readonly allowApiProductsOutsideCatalog: {
3561
- readonly type: "boolean";
3562
- readonly default: false;
3563
- };
3564
- readonly auth: {
3565
- readonly type: "object";
3566
- readonly oneOf: readonly [{
3567
- readonly type: "object";
3568
- readonly properties: {
3569
- readonly type: {
3570
- readonly type: "string";
3571
- readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
3572
- };
3573
- readonly tokenEndpoint: {
3574
- readonly type: "string";
3575
- };
3576
- readonly clientId: {
3577
- readonly type: "string";
3578
- };
3579
- readonly clientSecret: {
3580
- readonly type: "string";
3581
- };
3582
- };
3583
- readonly additionalProperties: false;
3584
- readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
3585
- }, {
3586
- readonly type: "object";
3587
- readonly properties: {
3588
- readonly type: {
3589
- readonly type: "string";
3590
- readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
3591
- };
3592
- readonly serviceAccountEmail: {
3593
- readonly type: "string";
3594
- };
3595
- readonly serviceAccountPrivateKey: {
3596
- readonly type: "string";
3597
- };
3598
- };
3599
- readonly additionalProperties: false;
3600
- readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
3601
- }];
3602
- readonly discriminator: {
3603
- readonly propertyName: "type";
3604
- };
3605
- };
3606
- };
3607
- readonly type: "object";
3608
- readonly additionalProperties: false;
3609
- readonly required: readonly ["type", "organizationName", "auth"];
3610
- }, {
3611
- readonly type: "object";
3612
- readonly properties: {
3613
- readonly type: {
3614
- readonly type: "string";
3615
- readonly const: "GRAVITEE";
3616
- };
3617
- readonly apiBaseUrl: {
3618
- readonly type: "string";
3619
- };
3620
- readonly env: {
3621
- readonly type: "string";
3622
- };
3623
- readonly allowApiProductsOutsideCatalog: {
3624
- readonly type: "boolean";
3625
- readonly default: false;
3626
- };
3627
- readonly stage: {
3628
- readonly type: "string";
3629
- readonly default: "non-production";
3630
- };
3631
- readonly auth: {
3632
- readonly type: "object";
3633
- readonly properties: {
3634
- readonly static: {
3635
- readonly type: "string";
3636
- };
3637
- };
3638
- };
3639
- };
3640
- readonly additionalProperties: false;
3641
- readonly required: readonly ["type", "apiBaseUrl"];
3642
- }];
3643
- readonly discriminator: {
3644
- readonly propertyName: "type";
3645
- };
3646
- };
3647
- };
3648
- };
3649
- };
3650
- readonly i18n: {
3651
- readonly type: "object";
3652
- readonly properties: {
3653
- readonly defaultLocale: {
3654
- readonly type: "string";
3655
- };
3656
- readonly locales: {
3657
- readonly type: "array";
3658
- readonly items: {
3659
- readonly type: "object";
3660
- readonly properties: {
3661
- readonly code: {
3662
- readonly type: "string";
3663
- };
3664
- readonly name: {
3665
- readonly type: "string";
3666
- };
3667
- };
3668
- readonly required: readonly ["code"];
3669
- };
3670
- };
3671
- };
3672
- readonly additionalProperties: false;
3673
- readonly required: readonly ["defaultLocale"];
3674
- };
3675
- readonly metadata: {
3676
- readonly type: "object";
3677
- readonly additionalProperties: true;
3678
- };
3679
- readonly ignore: {
3680
- readonly type: "array";
3681
- readonly items: {
3682
- readonly type: "string";
3683
- };
3684
- };
3685
- };
3686
- readonly default: {};
3687
- readonly required: readonly ["redirects"];
3688
- readonly type: "object";
3689
- readonly additionalProperties: true;
3690
- };
3691
- export type RedoclyConfig<T = ThemeConfig> = FromSchema<typeof rootRedoclyConfigSchema> & {
3692
- theme?: T;
3693
- };
3694
- export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
3695
- export type RedirectsConfig = FromSchema<typeof redirectsConfigSchema>;
3696
- export type AuthProviderConfig = FromSchema<typeof authProviderConfigSchema>;
3697
- export type BasicAuthProviderConfig = FromSchema<typeof basicAuthProviderConfigSchema>;
3698
- export type OidcProviderConfig = FromSchema<typeof oidcProviderConfigSchema>;
3699
- export type Saml2ProviderConfig = FromSchema<typeof saml2ProviderConfigSchema>;
3700
- export type SeoConfig = FromSchema<typeof seoConfigSchema>;
3701
- export type RbacConfig = FromSchema<typeof rbacConfigSchema>;
3702
- export type RbacScopeItems = FromSchema<typeof rbacScopeItemsSchema>;
3703
- export type OidcIssuerMetadata = FromSchema<typeof oidcIssuerMetadataSchema>;
3704
- export type DevOnboardingAdapterConfig = FromSchema<typeof devOnboardingAdapterConfigSchema>;
3705
- export type GraviteeAdapterConfig = FromSchema<typeof graviteeAdapterConfigSchema>;
3706
- export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema | typeof apigeeEdgeAdapterConfigSchema>;
3707
- export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
3708
- export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
3709
- export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
3710
- export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
3711
- export {};
12
+ export { rootRedoclyConfigSchema };
3712
13
  //# sourceMappingURL=schema.d.ts.map