@redocly/openapi-core 1.0.2 → 1.2.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.
- package/CHANGELOG.md +22 -0
- package/lib/bundle.d.ts +2 -2
- package/lib/bundle.js +24 -22
- package/lib/config/builtIn.js +4 -0
- package/lib/config/config-resolvers.js +19 -6
- package/lib/config/config.d.ts +9 -9
- package/lib/config/config.js +32 -17
- package/lib/config/rules.d.ts +2 -2
- package/lib/config/types.d.ts +9 -3
- package/lib/format/codeframes.d.ts +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +7 -6
- package/lib/lint.js +10 -16
- package/lib/oas-types.d.ts +16 -10
- package/lib/oas-types.js +52 -26
- package/lib/rules/async2/channels-kebab-case.d.ts +2 -0
- package/lib/rules/async2/channels-kebab-case.js +19 -0
- package/lib/rules/async2/index.d.ts +12 -0
- package/lib/rules/async2/index.js +22 -0
- package/lib/rules/async2/no-channel-trailing-slash.d.ts +2 -0
- package/lib/rules/async2/no-channel-trailing-slash.js +16 -0
- package/lib/rules/common/no-path-trailing-slash.js +2 -2
- package/lib/rules/common/scalar-property-missing-example.js +1 -1
- package/lib/rules/common/spec.d.ts +2 -2
- package/lib/rules/common/spec.js +3 -3
- package/lib/rules/common/tags-alphabetical.js +5 -2
- package/lib/rules/oas2/index.js +1 -1
- package/lib/rules/oas2/remove-unused-components.js +4 -1
- package/lib/rules/oas3/index.js +1 -1
- package/lib/rules/oas3/remove-unused-components.js +4 -1
- package/lib/rules/utils.d.ts +1 -1
- package/lib/types/asyncapi.d.ts +2 -0
- package/lib/types/asyncapi.js +1027 -0
- package/lib/types/portal-config-schema.d.ts +2533 -0
- package/lib/types/portal-config-schema.js +304 -0
- package/lib/types/redocly-yaml.js +26 -20
- package/lib/types/{config-external-schemas.d.ts → theme-config.d.ts} +140 -575
- package/lib/types/{config-external-schemas.js → theme-config.js} +55 -261
- package/lib/typings/asyncapi.d.ts +21 -0
- package/lib/typings/asyncapi.js +2 -0
- package/lib/visitors.d.ts +12 -0
- package/lib/walk.d.ts +3 -3
- package/package.json +3 -2
- package/src/__tests__/lint.test.ts +38 -6
- package/src/bundle.ts +27 -28
- package/src/config/__tests__/__snapshots__/config.test.ts.snap +24 -0
- package/src/config/__tests__/config.test.ts +15 -4
- package/src/config/builtIn.ts +4 -0
- package/src/config/config-resolvers.ts +25 -6
- package/src/config/config.ts +51 -27
- package/src/config/rules.ts +2 -2
- package/src/config/types.ts +14 -4
- package/src/index.ts +7 -1
- package/src/lint.ts +13 -22
- package/src/oas-types.ts +59 -21
- package/src/rules/async2/__tests__/channels-kebab-case.test.ts +141 -0
- package/src/rules/async2/__tests__/no-channel-trailing-slash.test.ts +97 -0
- package/src/rules/async2/channels-kebab-case.ts +18 -0
- package/src/rules/async2/index.ts +22 -0
- package/src/rules/async2/no-channel-trailing-slash.ts +15 -0
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +41 -0
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +58 -0
- package/src/rules/common/no-path-trailing-slash.ts +2 -2
- package/src/rules/common/scalar-property-missing-example.ts +2 -2
- package/src/rules/common/spec.ts +2 -2
- package/src/rules/common/tags-alphabetical.ts +8 -4
- package/src/rules/oas2/__tests__/remove-unused-components.test.ts +155 -0
- package/src/rules/oas2/index.ts +2 -2
- package/src/rules/oas2/remove-unused-components.ts +6 -1
- package/src/rules/oas3/__tests__/remove-unused-components.test.ts +171 -0
- package/src/rules/oas3/index.ts +2 -2
- package/src/rules/oas3/remove-unused-components.ts +6 -1
- package/src/types/asyncapi.ts +1136 -0
- package/src/types/portal-config-schema.ts +343 -0
- package/src/types/redocly-yaml.ts +23 -34
- package/src/types/{config-external-schemas.ts → theme-config.ts} +60 -294
- package/src/typings/asyncapi.ts +26 -0
- package/src/visitors.ts +22 -0
- package/src/walk.ts +3 -3
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,2533 @@
|
|
|
1
|
+
import { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType } from '../config';
|
|
2
|
+
export declare const ssoConfigSchema: {
|
|
3
|
+
readonly type: "object";
|
|
4
|
+
readonly additionalProperties: {
|
|
5
|
+
readonly oneOf: readonly [{
|
|
6
|
+
readonly type: "object";
|
|
7
|
+
readonly properties: {
|
|
8
|
+
readonly type: {
|
|
9
|
+
readonly type: "string";
|
|
10
|
+
readonly const: AuthProviderType.OIDC;
|
|
11
|
+
};
|
|
12
|
+
readonly title: {
|
|
13
|
+
readonly type: "string";
|
|
14
|
+
};
|
|
15
|
+
readonly configurationUrl: {
|
|
16
|
+
readonly type: "string";
|
|
17
|
+
readonly minLength: 1;
|
|
18
|
+
};
|
|
19
|
+
readonly configuration: {
|
|
20
|
+
readonly type: "object";
|
|
21
|
+
readonly properties: {
|
|
22
|
+
readonly end_session_endpoint: {
|
|
23
|
+
readonly type: "string";
|
|
24
|
+
};
|
|
25
|
+
readonly token_endpoint: {
|
|
26
|
+
readonly type: "string";
|
|
27
|
+
};
|
|
28
|
+
readonly authorization_endpoint: {
|
|
29
|
+
readonly type: "string";
|
|
30
|
+
};
|
|
31
|
+
readonly jwks_uri: {
|
|
32
|
+
readonly type: "string";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
|
|
36
|
+
readonly additionalProperties: true;
|
|
37
|
+
};
|
|
38
|
+
readonly clientId: {
|
|
39
|
+
readonly type: "string";
|
|
40
|
+
readonly minLength: 1;
|
|
41
|
+
};
|
|
42
|
+
readonly clientSecret: {
|
|
43
|
+
readonly type: "string";
|
|
44
|
+
readonly minLength: 1;
|
|
45
|
+
};
|
|
46
|
+
readonly teamsClaimName: {
|
|
47
|
+
readonly type: "string";
|
|
48
|
+
};
|
|
49
|
+
readonly teamsClaimMap: {
|
|
50
|
+
readonly type: "object";
|
|
51
|
+
readonly additionalProperties: {
|
|
52
|
+
readonly type: "string";
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
readonly defaultTeams: {
|
|
56
|
+
readonly type: "array";
|
|
57
|
+
readonly items: {
|
|
58
|
+
readonly type: "string";
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
readonly scopes: {
|
|
62
|
+
readonly type: "array";
|
|
63
|
+
readonly items: {
|
|
64
|
+
readonly type: "string";
|
|
65
|
+
};
|
|
66
|
+
};
|
|
67
|
+
readonly tokenExpirationTime: {
|
|
68
|
+
readonly type: "number";
|
|
69
|
+
};
|
|
70
|
+
readonly authorizationRequestCustomParams: {
|
|
71
|
+
readonly type: "object";
|
|
72
|
+
readonly additionalProperties: {
|
|
73
|
+
readonly type: "string";
|
|
74
|
+
};
|
|
75
|
+
};
|
|
76
|
+
readonly tokenRequestCustomParams: {
|
|
77
|
+
readonly type: "object";
|
|
78
|
+
readonly additionalProperties: {
|
|
79
|
+
readonly type: "string";
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
readonly audience: {
|
|
83
|
+
readonly type: "array";
|
|
84
|
+
readonly items: {
|
|
85
|
+
readonly type: "string";
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
readonly required: readonly ["type", "clientId", "clientSecret"];
|
|
90
|
+
readonly oneOf: readonly [{
|
|
91
|
+
readonly required: readonly ["configurationUrl"];
|
|
92
|
+
}, {
|
|
93
|
+
readonly required: readonly ["configuration"];
|
|
94
|
+
}];
|
|
95
|
+
readonly additionalProperties: false;
|
|
96
|
+
}, {
|
|
97
|
+
readonly type: "object";
|
|
98
|
+
readonly properties: {
|
|
99
|
+
readonly type: {
|
|
100
|
+
readonly type: "string";
|
|
101
|
+
readonly const: AuthProviderType.SAML2;
|
|
102
|
+
};
|
|
103
|
+
readonly title: {
|
|
104
|
+
readonly type: "string";
|
|
105
|
+
};
|
|
106
|
+
readonly issuerId: {
|
|
107
|
+
readonly type: "string";
|
|
108
|
+
};
|
|
109
|
+
readonly entityId: {
|
|
110
|
+
readonly type: "string";
|
|
111
|
+
};
|
|
112
|
+
readonly ssoUrl: {
|
|
113
|
+
readonly type: "string";
|
|
114
|
+
};
|
|
115
|
+
readonly x509PublicCert: {
|
|
116
|
+
readonly type: "string";
|
|
117
|
+
};
|
|
118
|
+
readonly teamsAttributeName: {
|
|
119
|
+
readonly type: "string";
|
|
120
|
+
readonly default: "https://redocly.com/sso/teams";
|
|
121
|
+
};
|
|
122
|
+
readonly teamsAttributeMap: {
|
|
123
|
+
readonly type: "object";
|
|
124
|
+
readonly additionalProperties: {
|
|
125
|
+
readonly type: "string";
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
readonly defaultTeams: {
|
|
129
|
+
readonly type: "array";
|
|
130
|
+
readonly items: {
|
|
131
|
+
readonly type: "string";
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
readonly additionalProperties: false;
|
|
136
|
+
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
|
|
137
|
+
}, {
|
|
138
|
+
readonly type: "object";
|
|
139
|
+
readonly properties: {
|
|
140
|
+
readonly type: {
|
|
141
|
+
readonly type: "string";
|
|
142
|
+
readonly const: AuthProviderType.BASIC;
|
|
143
|
+
};
|
|
144
|
+
readonly title: {
|
|
145
|
+
readonly type: "string";
|
|
146
|
+
};
|
|
147
|
+
readonly credentials: {
|
|
148
|
+
readonly type: "array";
|
|
149
|
+
readonly items: {
|
|
150
|
+
readonly type: "object";
|
|
151
|
+
readonly properties: {
|
|
152
|
+
readonly username: {
|
|
153
|
+
readonly type: "string";
|
|
154
|
+
};
|
|
155
|
+
readonly password: {
|
|
156
|
+
readonly type: "string";
|
|
157
|
+
};
|
|
158
|
+
readonly passwordHash: {
|
|
159
|
+
readonly type: "string";
|
|
160
|
+
};
|
|
161
|
+
readonly teams: {
|
|
162
|
+
readonly type: "array";
|
|
163
|
+
readonly items: {
|
|
164
|
+
readonly type: "string";
|
|
165
|
+
};
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
readonly required: readonly ["username"];
|
|
169
|
+
readonly additionalProperties: false;
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
};
|
|
173
|
+
readonly required: readonly ["type", "credentials"];
|
|
174
|
+
readonly additionalProperties: false;
|
|
175
|
+
}];
|
|
176
|
+
readonly discriminator: {
|
|
177
|
+
readonly propertyName: "type";
|
|
178
|
+
};
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
export declare const apiConfigSchema: {
|
|
182
|
+
readonly type: "object";
|
|
183
|
+
readonly properties: {
|
|
184
|
+
readonly root: {
|
|
185
|
+
readonly type: "string";
|
|
186
|
+
};
|
|
187
|
+
readonly rbac: {
|
|
188
|
+
readonly type: "object";
|
|
189
|
+
readonly additionalProperties: true;
|
|
190
|
+
};
|
|
191
|
+
readonly theme: {
|
|
192
|
+
readonly type: "object";
|
|
193
|
+
readonly properties: {
|
|
194
|
+
readonly openapi: {
|
|
195
|
+
readonly type: "object";
|
|
196
|
+
readonly additionalProperties: true;
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
readonly additionalProperties: false;
|
|
200
|
+
};
|
|
201
|
+
readonly title: {
|
|
202
|
+
readonly type: "string";
|
|
203
|
+
};
|
|
204
|
+
readonly metadata: {
|
|
205
|
+
readonly type: "object";
|
|
206
|
+
readonly additionalProperties: true;
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
readonly additionalProperties: true;
|
|
210
|
+
readonly required: readonly ["root"];
|
|
211
|
+
};
|
|
212
|
+
export declare const redoclyConfigSchema: {
|
|
213
|
+
readonly type: "object";
|
|
214
|
+
readonly properties: {
|
|
215
|
+
readonly licenseKey: {
|
|
216
|
+
readonly type: "string";
|
|
217
|
+
};
|
|
218
|
+
readonly theme: {
|
|
219
|
+
readonly type: "object";
|
|
220
|
+
readonly default: {};
|
|
221
|
+
};
|
|
222
|
+
readonly redirects: {
|
|
223
|
+
readonly type: "object";
|
|
224
|
+
readonly additionalProperties: {
|
|
225
|
+
readonly type: "object";
|
|
226
|
+
readonly properties: {
|
|
227
|
+
readonly to: {
|
|
228
|
+
readonly type: "string";
|
|
229
|
+
};
|
|
230
|
+
readonly type: {
|
|
231
|
+
readonly type: "number";
|
|
232
|
+
readonly default: 301;
|
|
233
|
+
};
|
|
234
|
+
};
|
|
235
|
+
readonly required: readonly ["to"];
|
|
236
|
+
readonly additionalProperties: false;
|
|
237
|
+
};
|
|
238
|
+
readonly default: {};
|
|
239
|
+
};
|
|
240
|
+
readonly seo: {
|
|
241
|
+
readonly type: "object";
|
|
242
|
+
readonly properties: {
|
|
243
|
+
readonly title: {
|
|
244
|
+
readonly type: "string";
|
|
245
|
+
};
|
|
246
|
+
readonly description: {
|
|
247
|
+
readonly type: "string";
|
|
248
|
+
};
|
|
249
|
+
readonly siteUrl: {
|
|
250
|
+
readonly type: "string";
|
|
251
|
+
};
|
|
252
|
+
readonly image: {
|
|
253
|
+
readonly type: "string";
|
|
254
|
+
};
|
|
255
|
+
readonly keywords: {
|
|
256
|
+
readonly type: "array";
|
|
257
|
+
readonly items: {
|
|
258
|
+
readonly type: "string";
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
readonly lang: {
|
|
262
|
+
readonly type: "string";
|
|
263
|
+
};
|
|
264
|
+
readonly jsonLd: {
|
|
265
|
+
readonly type: "object";
|
|
266
|
+
};
|
|
267
|
+
readonly meta: {
|
|
268
|
+
readonly type: "array";
|
|
269
|
+
readonly items: {
|
|
270
|
+
readonly type: "object";
|
|
271
|
+
readonly properties: {
|
|
272
|
+
readonly name: {
|
|
273
|
+
readonly type: "string";
|
|
274
|
+
};
|
|
275
|
+
readonly content: {
|
|
276
|
+
readonly type: "string";
|
|
277
|
+
};
|
|
278
|
+
};
|
|
279
|
+
readonly required: readonly ["name", "content"];
|
|
280
|
+
readonly additionalProperties: false;
|
|
281
|
+
};
|
|
282
|
+
};
|
|
283
|
+
};
|
|
284
|
+
readonly additionalProperties: false;
|
|
285
|
+
};
|
|
286
|
+
readonly rbac: {
|
|
287
|
+
readonly type: "object";
|
|
288
|
+
readonly properties: {
|
|
289
|
+
readonly defaults: {
|
|
290
|
+
readonly type: "object";
|
|
291
|
+
readonly additionalProperties: {
|
|
292
|
+
readonly type: "string";
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
readonly additionalProperties: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly additionalProperties: {
|
|
299
|
+
readonly type: "string";
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
readonly responseHeaders: {
|
|
304
|
+
readonly type: "object";
|
|
305
|
+
readonly additionalProperties: {
|
|
306
|
+
readonly type: "array";
|
|
307
|
+
readonly items: {
|
|
308
|
+
readonly type: "object";
|
|
309
|
+
readonly properties: {
|
|
310
|
+
readonly name: {
|
|
311
|
+
readonly type: "string";
|
|
312
|
+
};
|
|
313
|
+
readonly value: {
|
|
314
|
+
readonly type: "string";
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
readonly additionalProperties: false;
|
|
318
|
+
readonly required: readonly ["name", "value"];
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
};
|
|
322
|
+
readonly mockServer: {
|
|
323
|
+
readonly type: "object";
|
|
324
|
+
readonly properties: {
|
|
325
|
+
readonly off: {
|
|
326
|
+
readonly type: "boolean";
|
|
327
|
+
readonly default: false;
|
|
328
|
+
};
|
|
329
|
+
readonly position: {
|
|
330
|
+
readonly type: "string";
|
|
331
|
+
readonly enum: readonly ["first", "last", "replace", "off"];
|
|
332
|
+
readonly default: "first";
|
|
333
|
+
};
|
|
334
|
+
readonly strictExamples: {
|
|
335
|
+
readonly type: "boolean";
|
|
336
|
+
readonly default: false;
|
|
337
|
+
};
|
|
338
|
+
readonly errorIfForcedExampleNotFound: {
|
|
339
|
+
readonly type: "boolean";
|
|
340
|
+
readonly default: false;
|
|
341
|
+
};
|
|
342
|
+
readonly description: {
|
|
343
|
+
readonly type: "string";
|
|
344
|
+
};
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
readonly apis: {
|
|
348
|
+
readonly type: "object";
|
|
349
|
+
readonly additionalProperties: {
|
|
350
|
+
readonly type: "object";
|
|
351
|
+
readonly properties: {
|
|
352
|
+
readonly root: {
|
|
353
|
+
readonly type: "string";
|
|
354
|
+
};
|
|
355
|
+
readonly rbac: {
|
|
356
|
+
readonly type: "object";
|
|
357
|
+
readonly additionalProperties: true;
|
|
358
|
+
};
|
|
359
|
+
readonly theme: {
|
|
360
|
+
readonly type: "object";
|
|
361
|
+
readonly properties: {
|
|
362
|
+
readonly openapi: {
|
|
363
|
+
readonly type: "object";
|
|
364
|
+
readonly additionalProperties: true;
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
readonly additionalProperties: false;
|
|
368
|
+
};
|
|
369
|
+
readonly title: {
|
|
370
|
+
readonly type: "string";
|
|
371
|
+
};
|
|
372
|
+
readonly metadata: {
|
|
373
|
+
readonly type: "object";
|
|
374
|
+
readonly additionalProperties: true;
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
readonly additionalProperties: true;
|
|
378
|
+
readonly required: readonly ["root"];
|
|
379
|
+
};
|
|
380
|
+
};
|
|
381
|
+
readonly sso: {
|
|
382
|
+
readonly type: "object";
|
|
383
|
+
readonly additionalProperties: {
|
|
384
|
+
readonly oneOf: readonly [{
|
|
385
|
+
readonly type: "object";
|
|
386
|
+
readonly properties: {
|
|
387
|
+
readonly type: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly const: AuthProviderType.OIDC;
|
|
390
|
+
};
|
|
391
|
+
readonly title: {
|
|
392
|
+
readonly type: "string";
|
|
393
|
+
};
|
|
394
|
+
readonly configurationUrl: {
|
|
395
|
+
readonly type: "string";
|
|
396
|
+
readonly minLength: 1;
|
|
397
|
+
};
|
|
398
|
+
readonly configuration: {
|
|
399
|
+
readonly type: "object";
|
|
400
|
+
readonly properties: {
|
|
401
|
+
readonly end_session_endpoint: {
|
|
402
|
+
readonly type: "string";
|
|
403
|
+
};
|
|
404
|
+
readonly token_endpoint: {
|
|
405
|
+
readonly type: "string";
|
|
406
|
+
};
|
|
407
|
+
readonly authorization_endpoint: {
|
|
408
|
+
readonly type: "string";
|
|
409
|
+
};
|
|
410
|
+
readonly jwks_uri: {
|
|
411
|
+
readonly type: "string";
|
|
412
|
+
};
|
|
413
|
+
};
|
|
414
|
+
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
|
|
415
|
+
readonly additionalProperties: true;
|
|
416
|
+
};
|
|
417
|
+
readonly clientId: {
|
|
418
|
+
readonly type: "string";
|
|
419
|
+
readonly minLength: 1;
|
|
420
|
+
};
|
|
421
|
+
readonly clientSecret: {
|
|
422
|
+
readonly type: "string";
|
|
423
|
+
readonly minLength: 1;
|
|
424
|
+
};
|
|
425
|
+
readonly teamsClaimName: {
|
|
426
|
+
readonly type: "string";
|
|
427
|
+
};
|
|
428
|
+
readonly teamsClaimMap: {
|
|
429
|
+
readonly type: "object";
|
|
430
|
+
readonly additionalProperties: {
|
|
431
|
+
readonly type: "string";
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
readonly defaultTeams: {
|
|
435
|
+
readonly type: "array";
|
|
436
|
+
readonly items: {
|
|
437
|
+
readonly type: "string";
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
readonly scopes: {
|
|
441
|
+
readonly type: "array";
|
|
442
|
+
readonly items: {
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
};
|
|
445
|
+
};
|
|
446
|
+
readonly tokenExpirationTime: {
|
|
447
|
+
readonly type: "number";
|
|
448
|
+
};
|
|
449
|
+
readonly authorizationRequestCustomParams: {
|
|
450
|
+
readonly type: "object";
|
|
451
|
+
readonly additionalProperties: {
|
|
452
|
+
readonly type: "string";
|
|
453
|
+
};
|
|
454
|
+
};
|
|
455
|
+
readonly tokenRequestCustomParams: {
|
|
456
|
+
readonly type: "object";
|
|
457
|
+
readonly additionalProperties: {
|
|
458
|
+
readonly type: "string";
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
readonly audience: {
|
|
462
|
+
readonly type: "array";
|
|
463
|
+
readonly items: {
|
|
464
|
+
readonly type: "string";
|
|
465
|
+
};
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
readonly required: readonly ["type", "clientId", "clientSecret"];
|
|
469
|
+
readonly oneOf: readonly [{
|
|
470
|
+
readonly required: readonly ["configurationUrl"];
|
|
471
|
+
}, {
|
|
472
|
+
readonly required: readonly ["configuration"];
|
|
473
|
+
}];
|
|
474
|
+
readonly additionalProperties: false;
|
|
475
|
+
}, {
|
|
476
|
+
readonly type: "object";
|
|
477
|
+
readonly properties: {
|
|
478
|
+
readonly type: {
|
|
479
|
+
readonly type: "string";
|
|
480
|
+
readonly const: AuthProviderType.SAML2;
|
|
481
|
+
};
|
|
482
|
+
readonly title: {
|
|
483
|
+
readonly type: "string";
|
|
484
|
+
};
|
|
485
|
+
readonly issuerId: {
|
|
486
|
+
readonly type: "string";
|
|
487
|
+
};
|
|
488
|
+
readonly entityId: {
|
|
489
|
+
readonly type: "string";
|
|
490
|
+
};
|
|
491
|
+
readonly ssoUrl: {
|
|
492
|
+
readonly type: "string";
|
|
493
|
+
};
|
|
494
|
+
readonly x509PublicCert: {
|
|
495
|
+
readonly type: "string";
|
|
496
|
+
};
|
|
497
|
+
readonly teamsAttributeName: {
|
|
498
|
+
readonly type: "string";
|
|
499
|
+
readonly default: "https://redocly.com/sso/teams";
|
|
500
|
+
};
|
|
501
|
+
readonly teamsAttributeMap: {
|
|
502
|
+
readonly type: "object";
|
|
503
|
+
readonly additionalProperties: {
|
|
504
|
+
readonly type: "string";
|
|
505
|
+
};
|
|
506
|
+
};
|
|
507
|
+
readonly defaultTeams: {
|
|
508
|
+
readonly type: "array";
|
|
509
|
+
readonly items: {
|
|
510
|
+
readonly type: "string";
|
|
511
|
+
};
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
readonly additionalProperties: false;
|
|
515
|
+
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
|
|
516
|
+
}, {
|
|
517
|
+
readonly type: "object";
|
|
518
|
+
readonly properties: {
|
|
519
|
+
readonly type: {
|
|
520
|
+
readonly type: "string";
|
|
521
|
+
readonly const: AuthProviderType.BASIC;
|
|
522
|
+
};
|
|
523
|
+
readonly title: {
|
|
524
|
+
readonly type: "string";
|
|
525
|
+
};
|
|
526
|
+
readonly credentials: {
|
|
527
|
+
readonly type: "array";
|
|
528
|
+
readonly items: {
|
|
529
|
+
readonly type: "object";
|
|
530
|
+
readonly properties: {
|
|
531
|
+
readonly username: {
|
|
532
|
+
readonly type: "string";
|
|
533
|
+
};
|
|
534
|
+
readonly password: {
|
|
535
|
+
readonly type: "string";
|
|
536
|
+
};
|
|
537
|
+
readonly passwordHash: {
|
|
538
|
+
readonly type: "string";
|
|
539
|
+
};
|
|
540
|
+
readonly teams: {
|
|
541
|
+
readonly type: "array";
|
|
542
|
+
readonly items: {
|
|
543
|
+
readonly type: "string";
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
};
|
|
547
|
+
readonly required: readonly ["username"];
|
|
548
|
+
readonly additionalProperties: false;
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
};
|
|
552
|
+
readonly required: readonly ["type", "credentials"];
|
|
553
|
+
readonly additionalProperties: false;
|
|
554
|
+
}];
|
|
555
|
+
readonly discriminator: {
|
|
556
|
+
readonly propertyName: "type";
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
readonly developerOnboarding: {
|
|
561
|
+
readonly type: "object";
|
|
562
|
+
readonly required: readonly ["adapters"];
|
|
563
|
+
readonly additionalProperties: false;
|
|
564
|
+
readonly properties: {
|
|
565
|
+
readonly adapters: {
|
|
566
|
+
readonly type: "array";
|
|
567
|
+
readonly items: {
|
|
568
|
+
readonly type: "object";
|
|
569
|
+
readonly oneOf: readonly [{
|
|
570
|
+
readonly type: "object";
|
|
571
|
+
readonly properties: {
|
|
572
|
+
readonly type: {
|
|
573
|
+
readonly type: "string";
|
|
574
|
+
readonly const: "APIGEE_X";
|
|
575
|
+
};
|
|
576
|
+
readonly apiUrl: {
|
|
577
|
+
readonly type: "string";
|
|
578
|
+
};
|
|
579
|
+
readonly stage: {
|
|
580
|
+
readonly type: "string";
|
|
581
|
+
readonly default: "non-production";
|
|
582
|
+
};
|
|
583
|
+
readonly organizationName: {
|
|
584
|
+
readonly type: "string";
|
|
585
|
+
};
|
|
586
|
+
readonly ignoreApiProducts: {
|
|
587
|
+
readonly type: "array";
|
|
588
|
+
readonly items: {
|
|
589
|
+
readonly type: "string";
|
|
590
|
+
};
|
|
591
|
+
};
|
|
592
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
593
|
+
readonly type: "boolean";
|
|
594
|
+
readonly default: false;
|
|
595
|
+
};
|
|
596
|
+
readonly auth: {
|
|
597
|
+
readonly type: "object";
|
|
598
|
+
readonly oneOf: readonly [{
|
|
599
|
+
readonly type: "object";
|
|
600
|
+
readonly properties: {
|
|
601
|
+
readonly type: {
|
|
602
|
+
readonly type: "string";
|
|
603
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
604
|
+
};
|
|
605
|
+
readonly tokenEndpoint: {
|
|
606
|
+
readonly type: "string";
|
|
607
|
+
};
|
|
608
|
+
readonly clientId: {
|
|
609
|
+
readonly type: "string";
|
|
610
|
+
};
|
|
611
|
+
readonly clientSecret: {
|
|
612
|
+
readonly type: "string";
|
|
613
|
+
};
|
|
614
|
+
};
|
|
615
|
+
readonly additionalProperties: false;
|
|
616
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
617
|
+
}, {
|
|
618
|
+
readonly type: "object";
|
|
619
|
+
readonly properties: {
|
|
620
|
+
readonly type: {
|
|
621
|
+
readonly type: "string";
|
|
622
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
623
|
+
};
|
|
624
|
+
readonly serviceAccountEmail: {
|
|
625
|
+
readonly type: "string";
|
|
626
|
+
};
|
|
627
|
+
readonly serviceAccountPrivateKey: {
|
|
628
|
+
readonly type: "string";
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
readonly additionalProperties: false;
|
|
632
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
633
|
+
}];
|
|
634
|
+
readonly discriminator: {
|
|
635
|
+
readonly propertyName: "type";
|
|
636
|
+
};
|
|
637
|
+
};
|
|
638
|
+
};
|
|
639
|
+
readonly additionalProperties: false;
|
|
640
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
641
|
+
}, {
|
|
642
|
+
readonly properties: {
|
|
643
|
+
readonly type: {
|
|
644
|
+
readonly type: "string";
|
|
645
|
+
readonly const: "APIGEE_EDGE";
|
|
646
|
+
};
|
|
647
|
+
readonly apiUrl: {
|
|
648
|
+
readonly type: "string";
|
|
649
|
+
};
|
|
650
|
+
readonly stage: {
|
|
651
|
+
readonly type: "string";
|
|
652
|
+
readonly default: "non-production";
|
|
653
|
+
};
|
|
654
|
+
readonly organizationName: {
|
|
655
|
+
readonly type: "string";
|
|
656
|
+
};
|
|
657
|
+
readonly ignoreApiProducts: {
|
|
658
|
+
readonly type: "array";
|
|
659
|
+
readonly items: {
|
|
660
|
+
readonly type: "string";
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
664
|
+
readonly type: "boolean";
|
|
665
|
+
readonly default: false;
|
|
666
|
+
};
|
|
667
|
+
readonly auth: {
|
|
668
|
+
readonly type: "object";
|
|
669
|
+
readonly oneOf: readonly [{
|
|
670
|
+
readonly type: "object";
|
|
671
|
+
readonly properties: {
|
|
672
|
+
readonly type: {
|
|
673
|
+
readonly type: "string";
|
|
674
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
675
|
+
};
|
|
676
|
+
readonly tokenEndpoint: {
|
|
677
|
+
readonly type: "string";
|
|
678
|
+
};
|
|
679
|
+
readonly clientId: {
|
|
680
|
+
readonly type: "string";
|
|
681
|
+
};
|
|
682
|
+
readonly clientSecret: {
|
|
683
|
+
readonly type: "string";
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
readonly additionalProperties: false;
|
|
687
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
688
|
+
}, {
|
|
689
|
+
readonly type: "object";
|
|
690
|
+
readonly properties: {
|
|
691
|
+
readonly type: {
|
|
692
|
+
readonly type: "string";
|
|
693
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
694
|
+
};
|
|
695
|
+
readonly serviceAccountEmail: {
|
|
696
|
+
readonly type: "string";
|
|
697
|
+
};
|
|
698
|
+
readonly serviceAccountPrivateKey: {
|
|
699
|
+
readonly type: "string";
|
|
700
|
+
};
|
|
701
|
+
};
|
|
702
|
+
readonly additionalProperties: false;
|
|
703
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
704
|
+
}];
|
|
705
|
+
readonly discriminator: {
|
|
706
|
+
readonly propertyName: "type";
|
|
707
|
+
};
|
|
708
|
+
};
|
|
709
|
+
};
|
|
710
|
+
readonly type: "object";
|
|
711
|
+
readonly additionalProperties: false;
|
|
712
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
713
|
+
}, {
|
|
714
|
+
readonly type: "object";
|
|
715
|
+
readonly properties: {
|
|
716
|
+
readonly type: {
|
|
717
|
+
readonly type: "string";
|
|
718
|
+
readonly const: "GRAVITEE";
|
|
719
|
+
};
|
|
720
|
+
readonly apiBaseUrl: {
|
|
721
|
+
readonly type: "string";
|
|
722
|
+
};
|
|
723
|
+
readonly env: {
|
|
724
|
+
readonly type: "string";
|
|
725
|
+
};
|
|
726
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
727
|
+
readonly type: "boolean";
|
|
728
|
+
readonly default: false;
|
|
729
|
+
};
|
|
730
|
+
readonly stage: {
|
|
731
|
+
readonly type: "string";
|
|
732
|
+
readonly default: "non-production";
|
|
733
|
+
};
|
|
734
|
+
readonly auth: {
|
|
735
|
+
readonly type: "object";
|
|
736
|
+
readonly properties: {
|
|
737
|
+
readonly static: {
|
|
738
|
+
readonly type: "string";
|
|
739
|
+
};
|
|
740
|
+
};
|
|
741
|
+
};
|
|
742
|
+
};
|
|
743
|
+
readonly additionalProperties: false;
|
|
744
|
+
readonly required: readonly ["type", "apiBaseUrl"];
|
|
745
|
+
}];
|
|
746
|
+
readonly discriminator: {
|
|
747
|
+
readonly propertyName: "type";
|
|
748
|
+
};
|
|
749
|
+
};
|
|
750
|
+
};
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
readonly i18n: {
|
|
754
|
+
readonly type: "object";
|
|
755
|
+
readonly properties: {
|
|
756
|
+
readonly defaultLocale: {
|
|
757
|
+
readonly type: "string";
|
|
758
|
+
};
|
|
759
|
+
readonly locales: {
|
|
760
|
+
readonly type: "array";
|
|
761
|
+
readonly items: {
|
|
762
|
+
readonly type: "object";
|
|
763
|
+
readonly properties: {
|
|
764
|
+
readonly code: {
|
|
765
|
+
readonly type: "string";
|
|
766
|
+
};
|
|
767
|
+
readonly name: {
|
|
768
|
+
readonly type: "string";
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
readonly required: readonly ["code"];
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
readonly additionalProperties: false;
|
|
776
|
+
readonly required: readonly ["defaultLocale", "locales"];
|
|
777
|
+
};
|
|
778
|
+
readonly metadata: {
|
|
779
|
+
readonly type: "object";
|
|
780
|
+
readonly additionalProperties: true;
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
readonly default: {};
|
|
784
|
+
readonly additionalProperties: true;
|
|
785
|
+
};
|
|
786
|
+
export declare const environmentSchema: {
|
|
787
|
+
readonly oneOf: readonly [{
|
|
788
|
+
readonly additionalProperties: false;
|
|
789
|
+
readonly type: "object";
|
|
790
|
+
readonly properties: {
|
|
791
|
+
readonly licenseKey: {
|
|
792
|
+
readonly type: "string";
|
|
793
|
+
};
|
|
794
|
+
readonly theme: {
|
|
795
|
+
readonly type: "object";
|
|
796
|
+
readonly default: {};
|
|
797
|
+
};
|
|
798
|
+
readonly redirects: {
|
|
799
|
+
readonly type: "object";
|
|
800
|
+
readonly additionalProperties: {
|
|
801
|
+
readonly type: "object";
|
|
802
|
+
readonly properties: {
|
|
803
|
+
readonly to: {
|
|
804
|
+
readonly type: "string";
|
|
805
|
+
};
|
|
806
|
+
readonly type: {
|
|
807
|
+
readonly type: "number";
|
|
808
|
+
readonly default: 301;
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
readonly required: readonly ["to"];
|
|
812
|
+
readonly additionalProperties: false;
|
|
813
|
+
};
|
|
814
|
+
readonly default: {};
|
|
815
|
+
};
|
|
816
|
+
readonly seo: {
|
|
817
|
+
readonly type: "object";
|
|
818
|
+
readonly properties: {
|
|
819
|
+
readonly title: {
|
|
820
|
+
readonly type: "string";
|
|
821
|
+
};
|
|
822
|
+
readonly description: {
|
|
823
|
+
readonly type: "string";
|
|
824
|
+
};
|
|
825
|
+
readonly siteUrl: {
|
|
826
|
+
readonly type: "string";
|
|
827
|
+
};
|
|
828
|
+
readonly image: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
};
|
|
831
|
+
readonly keywords: {
|
|
832
|
+
readonly type: "array";
|
|
833
|
+
readonly items: {
|
|
834
|
+
readonly type: "string";
|
|
835
|
+
};
|
|
836
|
+
};
|
|
837
|
+
readonly lang: {
|
|
838
|
+
readonly type: "string";
|
|
839
|
+
};
|
|
840
|
+
readonly jsonLd: {
|
|
841
|
+
readonly type: "object";
|
|
842
|
+
};
|
|
843
|
+
readonly meta: {
|
|
844
|
+
readonly type: "array";
|
|
845
|
+
readonly items: {
|
|
846
|
+
readonly type: "object";
|
|
847
|
+
readonly properties: {
|
|
848
|
+
readonly name: {
|
|
849
|
+
readonly type: "string";
|
|
850
|
+
};
|
|
851
|
+
readonly content: {
|
|
852
|
+
readonly type: "string";
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
readonly required: readonly ["name", "content"];
|
|
856
|
+
readonly additionalProperties: false;
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
readonly additionalProperties: false;
|
|
861
|
+
};
|
|
862
|
+
readonly rbac: {
|
|
863
|
+
readonly type: "object";
|
|
864
|
+
readonly properties: {
|
|
865
|
+
readonly defaults: {
|
|
866
|
+
readonly type: "object";
|
|
867
|
+
readonly additionalProperties: {
|
|
868
|
+
readonly type: "string";
|
|
869
|
+
};
|
|
870
|
+
};
|
|
871
|
+
};
|
|
872
|
+
readonly additionalProperties: {
|
|
873
|
+
readonly type: "object";
|
|
874
|
+
readonly additionalProperties: {
|
|
875
|
+
readonly type: "string";
|
|
876
|
+
};
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
readonly responseHeaders: {
|
|
880
|
+
readonly type: "object";
|
|
881
|
+
readonly additionalProperties: {
|
|
882
|
+
readonly type: "array";
|
|
883
|
+
readonly items: {
|
|
884
|
+
readonly type: "object";
|
|
885
|
+
readonly properties: {
|
|
886
|
+
readonly name: {
|
|
887
|
+
readonly type: "string";
|
|
888
|
+
};
|
|
889
|
+
readonly value: {
|
|
890
|
+
readonly type: "string";
|
|
891
|
+
};
|
|
892
|
+
};
|
|
893
|
+
readonly additionalProperties: false;
|
|
894
|
+
readonly required: readonly ["name", "value"];
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
readonly mockServer: {
|
|
899
|
+
readonly type: "object";
|
|
900
|
+
readonly properties: {
|
|
901
|
+
readonly off: {
|
|
902
|
+
readonly type: "boolean";
|
|
903
|
+
readonly default: false;
|
|
904
|
+
};
|
|
905
|
+
readonly position: {
|
|
906
|
+
readonly type: "string";
|
|
907
|
+
readonly enum: readonly ["first", "last", "replace", "off"];
|
|
908
|
+
readonly default: "first";
|
|
909
|
+
};
|
|
910
|
+
readonly strictExamples: {
|
|
911
|
+
readonly type: "boolean";
|
|
912
|
+
readonly default: false;
|
|
913
|
+
};
|
|
914
|
+
readonly errorIfForcedExampleNotFound: {
|
|
915
|
+
readonly type: "boolean";
|
|
916
|
+
readonly default: false;
|
|
917
|
+
};
|
|
918
|
+
readonly description: {
|
|
919
|
+
readonly type: "string";
|
|
920
|
+
};
|
|
921
|
+
};
|
|
922
|
+
};
|
|
923
|
+
readonly apis: {
|
|
924
|
+
readonly type: "object";
|
|
925
|
+
readonly additionalProperties: {
|
|
926
|
+
readonly type: "object";
|
|
927
|
+
readonly properties: {
|
|
928
|
+
readonly root: {
|
|
929
|
+
readonly type: "string";
|
|
930
|
+
};
|
|
931
|
+
readonly rbac: {
|
|
932
|
+
readonly type: "object";
|
|
933
|
+
readonly additionalProperties: true;
|
|
934
|
+
};
|
|
935
|
+
readonly theme: {
|
|
936
|
+
readonly type: "object";
|
|
937
|
+
readonly properties: {
|
|
938
|
+
readonly openapi: {
|
|
939
|
+
readonly type: "object";
|
|
940
|
+
readonly additionalProperties: true;
|
|
941
|
+
};
|
|
942
|
+
};
|
|
943
|
+
readonly additionalProperties: false;
|
|
944
|
+
};
|
|
945
|
+
readonly title: {
|
|
946
|
+
readonly type: "string";
|
|
947
|
+
};
|
|
948
|
+
readonly metadata: {
|
|
949
|
+
readonly type: "object";
|
|
950
|
+
readonly additionalProperties: true;
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
readonly additionalProperties: true;
|
|
954
|
+
readonly required: readonly ["root"];
|
|
955
|
+
};
|
|
956
|
+
};
|
|
957
|
+
readonly sso: {
|
|
958
|
+
readonly type: "object";
|
|
959
|
+
readonly additionalProperties: {
|
|
960
|
+
readonly oneOf: readonly [{
|
|
961
|
+
readonly type: "object";
|
|
962
|
+
readonly properties: {
|
|
963
|
+
readonly type: {
|
|
964
|
+
readonly type: "string";
|
|
965
|
+
readonly const: AuthProviderType.OIDC;
|
|
966
|
+
};
|
|
967
|
+
readonly title: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
};
|
|
970
|
+
readonly configurationUrl: {
|
|
971
|
+
readonly type: "string";
|
|
972
|
+
readonly minLength: 1;
|
|
973
|
+
};
|
|
974
|
+
readonly configuration: {
|
|
975
|
+
readonly type: "object";
|
|
976
|
+
readonly properties: {
|
|
977
|
+
readonly end_session_endpoint: {
|
|
978
|
+
readonly type: "string";
|
|
979
|
+
};
|
|
980
|
+
readonly token_endpoint: {
|
|
981
|
+
readonly type: "string";
|
|
982
|
+
};
|
|
983
|
+
readonly authorization_endpoint: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
};
|
|
986
|
+
readonly jwks_uri: {
|
|
987
|
+
readonly type: "string";
|
|
988
|
+
};
|
|
989
|
+
};
|
|
990
|
+
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
|
|
991
|
+
readonly additionalProperties: true;
|
|
992
|
+
};
|
|
993
|
+
readonly clientId: {
|
|
994
|
+
readonly type: "string";
|
|
995
|
+
readonly minLength: 1;
|
|
996
|
+
};
|
|
997
|
+
readonly clientSecret: {
|
|
998
|
+
readonly type: "string";
|
|
999
|
+
readonly minLength: 1;
|
|
1000
|
+
};
|
|
1001
|
+
readonly teamsClaimName: {
|
|
1002
|
+
readonly type: "string";
|
|
1003
|
+
};
|
|
1004
|
+
readonly teamsClaimMap: {
|
|
1005
|
+
readonly type: "object";
|
|
1006
|
+
readonly additionalProperties: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
};
|
|
1009
|
+
};
|
|
1010
|
+
readonly defaultTeams: {
|
|
1011
|
+
readonly type: "array";
|
|
1012
|
+
readonly items: {
|
|
1013
|
+
readonly type: "string";
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
readonly scopes: {
|
|
1017
|
+
readonly type: "array";
|
|
1018
|
+
readonly items: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
};
|
|
1021
|
+
};
|
|
1022
|
+
readonly tokenExpirationTime: {
|
|
1023
|
+
readonly type: "number";
|
|
1024
|
+
};
|
|
1025
|
+
readonly authorizationRequestCustomParams: {
|
|
1026
|
+
readonly type: "object";
|
|
1027
|
+
readonly additionalProperties: {
|
|
1028
|
+
readonly type: "string";
|
|
1029
|
+
};
|
|
1030
|
+
};
|
|
1031
|
+
readonly tokenRequestCustomParams: {
|
|
1032
|
+
readonly type: "object";
|
|
1033
|
+
readonly additionalProperties: {
|
|
1034
|
+
readonly type: "string";
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
readonly audience: {
|
|
1038
|
+
readonly type: "array";
|
|
1039
|
+
readonly items: {
|
|
1040
|
+
readonly type: "string";
|
|
1041
|
+
};
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
readonly required: readonly ["type", "clientId", "clientSecret"];
|
|
1045
|
+
readonly oneOf: readonly [{
|
|
1046
|
+
readonly required: readonly ["configurationUrl"];
|
|
1047
|
+
}, {
|
|
1048
|
+
readonly required: readonly ["configuration"];
|
|
1049
|
+
}];
|
|
1050
|
+
readonly additionalProperties: false;
|
|
1051
|
+
}, {
|
|
1052
|
+
readonly type: "object";
|
|
1053
|
+
readonly properties: {
|
|
1054
|
+
readonly type: {
|
|
1055
|
+
readonly type: "string";
|
|
1056
|
+
readonly const: AuthProviderType.SAML2;
|
|
1057
|
+
};
|
|
1058
|
+
readonly title: {
|
|
1059
|
+
readonly type: "string";
|
|
1060
|
+
};
|
|
1061
|
+
readonly issuerId: {
|
|
1062
|
+
readonly type: "string";
|
|
1063
|
+
};
|
|
1064
|
+
readonly entityId: {
|
|
1065
|
+
readonly type: "string";
|
|
1066
|
+
};
|
|
1067
|
+
readonly ssoUrl: {
|
|
1068
|
+
readonly type: "string";
|
|
1069
|
+
};
|
|
1070
|
+
readonly x509PublicCert: {
|
|
1071
|
+
readonly type: "string";
|
|
1072
|
+
};
|
|
1073
|
+
readonly teamsAttributeName: {
|
|
1074
|
+
readonly type: "string";
|
|
1075
|
+
readonly default: "https://redocly.com/sso/teams";
|
|
1076
|
+
};
|
|
1077
|
+
readonly teamsAttributeMap: {
|
|
1078
|
+
readonly type: "object";
|
|
1079
|
+
readonly additionalProperties: {
|
|
1080
|
+
readonly type: "string";
|
|
1081
|
+
};
|
|
1082
|
+
};
|
|
1083
|
+
readonly defaultTeams: {
|
|
1084
|
+
readonly type: "array";
|
|
1085
|
+
readonly items: {
|
|
1086
|
+
readonly type: "string";
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
};
|
|
1090
|
+
readonly additionalProperties: false;
|
|
1091
|
+
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
|
|
1092
|
+
}, {
|
|
1093
|
+
readonly type: "object";
|
|
1094
|
+
readonly properties: {
|
|
1095
|
+
readonly type: {
|
|
1096
|
+
readonly type: "string";
|
|
1097
|
+
readonly const: AuthProviderType.BASIC;
|
|
1098
|
+
};
|
|
1099
|
+
readonly title: {
|
|
1100
|
+
readonly type: "string";
|
|
1101
|
+
};
|
|
1102
|
+
readonly credentials: {
|
|
1103
|
+
readonly type: "array";
|
|
1104
|
+
readonly items: {
|
|
1105
|
+
readonly type: "object";
|
|
1106
|
+
readonly properties: {
|
|
1107
|
+
readonly username: {
|
|
1108
|
+
readonly type: "string";
|
|
1109
|
+
};
|
|
1110
|
+
readonly password: {
|
|
1111
|
+
readonly type: "string";
|
|
1112
|
+
};
|
|
1113
|
+
readonly passwordHash: {
|
|
1114
|
+
readonly type: "string";
|
|
1115
|
+
};
|
|
1116
|
+
readonly teams: {
|
|
1117
|
+
readonly type: "array";
|
|
1118
|
+
readonly items: {
|
|
1119
|
+
readonly type: "string";
|
|
1120
|
+
};
|
|
1121
|
+
};
|
|
1122
|
+
};
|
|
1123
|
+
readonly required: readonly ["username"];
|
|
1124
|
+
readonly additionalProperties: false;
|
|
1125
|
+
};
|
|
1126
|
+
};
|
|
1127
|
+
};
|
|
1128
|
+
readonly required: readonly ["type", "credentials"];
|
|
1129
|
+
readonly additionalProperties: false;
|
|
1130
|
+
}];
|
|
1131
|
+
readonly discriminator: {
|
|
1132
|
+
readonly propertyName: "type";
|
|
1133
|
+
};
|
|
1134
|
+
};
|
|
1135
|
+
};
|
|
1136
|
+
readonly developerOnboarding: {
|
|
1137
|
+
readonly type: "object";
|
|
1138
|
+
readonly required: readonly ["adapters"];
|
|
1139
|
+
readonly additionalProperties: false;
|
|
1140
|
+
readonly properties: {
|
|
1141
|
+
readonly adapters: {
|
|
1142
|
+
readonly type: "array";
|
|
1143
|
+
readonly items: {
|
|
1144
|
+
readonly type: "object";
|
|
1145
|
+
readonly oneOf: readonly [{
|
|
1146
|
+
readonly type: "object";
|
|
1147
|
+
readonly properties: {
|
|
1148
|
+
readonly type: {
|
|
1149
|
+
readonly type: "string";
|
|
1150
|
+
readonly const: "APIGEE_X";
|
|
1151
|
+
};
|
|
1152
|
+
readonly apiUrl: {
|
|
1153
|
+
readonly type: "string";
|
|
1154
|
+
};
|
|
1155
|
+
readonly stage: {
|
|
1156
|
+
readonly type: "string";
|
|
1157
|
+
readonly default: "non-production";
|
|
1158
|
+
};
|
|
1159
|
+
readonly organizationName: {
|
|
1160
|
+
readonly type: "string";
|
|
1161
|
+
};
|
|
1162
|
+
readonly ignoreApiProducts: {
|
|
1163
|
+
readonly type: "array";
|
|
1164
|
+
readonly items: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
};
|
|
1167
|
+
};
|
|
1168
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
1169
|
+
readonly type: "boolean";
|
|
1170
|
+
readonly default: false;
|
|
1171
|
+
};
|
|
1172
|
+
readonly auth: {
|
|
1173
|
+
readonly type: "object";
|
|
1174
|
+
readonly oneOf: readonly [{
|
|
1175
|
+
readonly type: "object";
|
|
1176
|
+
readonly properties: {
|
|
1177
|
+
readonly type: {
|
|
1178
|
+
readonly type: "string";
|
|
1179
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
1180
|
+
};
|
|
1181
|
+
readonly tokenEndpoint: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
};
|
|
1184
|
+
readonly clientId: {
|
|
1185
|
+
readonly type: "string";
|
|
1186
|
+
};
|
|
1187
|
+
readonly clientSecret: {
|
|
1188
|
+
readonly type: "string";
|
|
1189
|
+
};
|
|
1190
|
+
};
|
|
1191
|
+
readonly additionalProperties: false;
|
|
1192
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
1193
|
+
}, {
|
|
1194
|
+
readonly type: "object";
|
|
1195
|
+
readonly properties: {
|
|
1196
|
+
readonly type: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
1199
|
+
};
|
|
1200
|
+
readonly serviceAccountEmail: {
|
|
1201
|
+
readonly type: "string";
|
|
1202
|
+
};
|
|
1203
|
+
readonly serviceAccountPrivateKey: {
|
|
1204
|
+
readonly type: "string";
|
|
1205
|
+
};
|
|
1206
|
+
};
|
|
1207
|
+
readonly additionalProperties: false;
|
|
1208
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
1209
|
+
}];
|
|
1210
|
+
readonly discriminator: {
|
|
1211
|
+
readonly propertyName: "type";
|
|
1212
|
+
};
|
|
1213
|
+
};
|
|
1214
|
+
};
|
|
1215
|
+
readonly additionalProperties: false;
|
|
1216
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
1217
|
+
}, {
|
|
1218
|
+
readonly properties: {
|
|
1219
|
+
readonly type: {
|
|
1220
|
+
readonly type: "string";
|
|
1221
|
+
readonly const: "APIGEE_EDGE";
|
|
1222
|
+
};
|
|
1223
|
+
readonly apiUrl: {
|
|
1224
|
+
readonly type: "string";
|
|
1225
|
+
};
|
|
1226
|
+
readonly stage: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly default: "non-production";
|
|
1229
|
+
};
|
|
1230
|
+
readonly organizationName: {
|
|
1231
|
+
readonly type: "string";
|
|
1232
|
+
};
|
|
1233
|
+
readonly ignoreApiProducts: {
|
|
1234
|
+
readonly type: "array";
|
|
1235
|
+
readonly items: {
|
|
1236
|
+
readonly type: "string";
|
|
1237
|
+
};
|
|
1238
|
+
};
|
|
1239
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
1240
|
+
readonly type: "boolean";
|
|
1241
|
+
readonly default: false;
|
|
1242
|
+
};
|
|
1243
|
+
readonly auth: {
|
|
1244
|
+
readonly type: "object";
|
|
1245
|
+
readonly oneOf: readonly [{
|
|
1246
|
+
readonly type: "object";
|
|
1247
|
+
readonly properties: {
|
|
1248
|
+
readonly type: {
|
|
1249
|
+
readonly type: "string";
|
|
1250
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
1251
|
+
};
|
|
1252
|
+
readonly tokenEndpoint: {
|
|
1253
|
+
readonly type: "string";
|
|
1254
|
+
};
|
|
1255
|
+
readonly clientId: {
|
|
1256
|
+
readonly type: "string";
|
|
1257
|
+
};
|
|
1258
|
+
readonly clientSecret: {
|
|
1259
|
+
readonly type: "string";
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
readonly additionalProperties: false;
|
|
1263
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
1264
|
+
}, {
|
|
1265
|
+
readonly type: "object";
|
|
1266
|
+
readonly properties: {
|
|
1267
|
+
readonly type: {
|
|
1268
|
+
readonly type: "string";
|
|
1269
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
1270
|
+
};
|
|
1271
|
+
readonly serviceAccountEmail: {
|
|
1272
|
+
readonly type: "string";
|
|
1273
|
+
};
|
|
1274
|
+
readonly serviceAccountPrivateKey: {
|
|
1275
|
+
readonly type: "string";
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
readonly additionalProperties: false;
|
|
1279
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
1280
|
+
}];
|
|
1281
|
+
readonly discriminator: {
|
|
1282
|
+
readonly propertyName: "type";
|
|
1283
|
+
};
|
|
1284
|
+
};
|
|
1285
|
+
};
|
|
1286
|
+
readonly type: "object";
|
|
1287
|
+
readonly additionalProperties: false;
|
|
1288
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
1289
|
+
}, {
|
|
1290
|
+
readonly type: "object";
|
|
1291
|
+
readonly properties: {
|
|
1292
|
+
readonly type: {
|
|
1293
|
+
readonly type: "string";
|
|
1294
|
+
readonly const: "GRAVITEE";
|
|
1295
|
+
};
|
|
1296
|
+
readonly apiBaseUrl: {
|
|
1297
|
+
readonly type: "string";
|
|
1298
|
+
};
|
|
1299
|
+
readonly env: {
|
|
1300
|
+
readonly type: "string";
|
|
1301
|
+
};
|
|
1302
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
1303
|
+
readonly type: "boolean";
|
|
1304
|
+
readonly default: false;
|
|
1305
|
+
};
|
|
1306
|
+
readonly stage: {
|
|
1307
|
+
readonly type: "string";
|
|
1308
|
+
readonly default: "non-production";
|
|
1309
|
+
};
|
|
1310
|
+
readonly auth: {
|
|
1311
|
+
readonly type: "object";
|
|
1312
|
+
readonly properties: {
|
|
1313
|
+
readonly static: {
|
|
1314
|
+
readonly type: "string";
|
|
1315
|
+
};
|
|
1316
|
+
};
|
|
1317
|
+
};
|
|
1318
|
+
};
|
|
1319
|
+
readonly additionalProperties: false;
|
|
1320
|
+
readonly required: readonly ["type", "apiBaseUrl"];
|
|
1321
|
+
}];
|
|
1322
|
+
readonly discriminator: {
|
|
1323
|
+
readonly propertyName: "type";
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
};
|
|
1327
|
+
};
|
|
1328
|
+
};
|
|
1329
|
+
readonly i18n: {
|
|
1330
|
+
readonly type: "object";
|
|
1331
|
+
readonly properties: {
|
|
1332
|
+
readonly defaultLocale: {
|
|
1333
|
+
readonly type: "string";
|
|
1334
|
+
};
|
|
1335
|
+
readonly locales: {
|
|
1336
|
+
readonly type: "array";
|
|
1337
|
+
readonly items: {
|
|
1338
|
+
readonly type: "object";
|
|
1339
|
+
readonly properties: {
|
|
1340
|
+
readonly code: {
|
|
1341
|
+
readonly type: "string";
|
|
1342
|
+
};
|
|
1343
|
+
readonly name: {
|
|
1344
|
+
readonly type: "string";
|
|
1345
|
+
};
|
|
1346
|
+
};
|
|
1347
|
+
readonly required: readonly ["code"];
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
readonly additionalProperties: false;
|
|
1352
|
+
readonly required: readonly ["defaultLocale", "locales"];
|
|
1353
|
+
};
|
|
1354
|
+
readonly metadata: {
|
|
1355
|
+
readonly type: "object";
|
|
1356
|
+
readonly additionalProperties: true;
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
readonly default: {};
|
|
1360
|
+
}, {
|
|
1361
|
+
readonly type: "object";
|
|
1362
|
+
readonly properties: {
|
|
1363
|
+
readonly $ref: {
|
|
1364
|
+
readonly type: "string";
|
|
1365
|
+
};
|
|
1366
|
+
};
|
|
1367
|
+
readonly required: readonly ["$ref"];
|
|
1368
|
+
readonly additionalProperties: false;
|
|
1369
|
+
}];
|
|
1370
|
+
};
|
|
1371
|
+
export declare const rootRedoclyConfigSchema: {
|
|
1372
|
+
readonly properties: {
|
|
1373
|
+
readonly env: {
|
|
1374
|
+
readonly type: "object";
|
|
1375
|
+
readonly additionalProperties: {
|
|
1376
|
+
readonly oneOf: readonly [{
|
|
1377
|
+
readonly additionalProperties: false;
|
|
1378
|
+
readonly type: "object";
|
|
1379
|
+
readonly properties: {
|
|
1380
|
+
readonly licenseKey: {
|
|
1381
|
+
readonly type: "string";
|
|
1382
|
+
};
|
|
1383
|
+
readonly theme: {
|
|
1384
|
+
readonly type: "object";
|
|
1385
|
+
readonly default: {};
|
|
1386
|
+
};
|
|
1387
|
+
readonly redirects: {
|
|
1388
|
+
readonly type: "object";
|
|
1389
|
+
readonly additionalProperties: {
|
|
1390
|
+
readonly type: "object";
|
|
1391
|
+
readonly properties: {
|
|
1392
|
+
readonly to: {
|
|
1393
|
+
readonly type: "string";
|
|
1394
|
+
};
|
|
1395
|
+
readonly type: {
|
|
1396
|
+
readonly type: "number";
|
|
1397
|
+
readonly default: 301;
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["to"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1402
|
+
};
|
|
1403
|
+
readonly default: {};
|
|
1404
|
+
};
|
|
1405
|
+
readonly seo: {
|
|
1406
|
+
readonly type: "object";
|
|
1407
|
+
readonly properties: {
|
|
1408
|
+
readonly title: {
|
|
1409
|
+
readonly type: "string";
|
|
1410
|
+
};
|
|
1411
|
+
readonly description: {
|
|
1412
|
+
readonly type: "string";
|
|
1413
|
+
};
|
|
1414
|
+
readonly siteUrl: {
|
|
1415
|
+
readonly type: "string";
|
|
1416
|
+
};
|
|
1417
|
+
readonly image: {
|
|
1418
|
+
readonly type: "string";
|
|
1419
|
+
};
|
|
1420
|
+
readonly keywords: {
|
|
1421
|
+
readonly type: "array";
|
|
1422
|
+
readonly items: {
|
|
1423
|
+
readonly type: "string";
|
|
1424
|
+
};
|
|
1425
|
+
};
|
|
1426
|
+
readonly lang: {
|
|
1427
|
+
readonly type: "string";
|
|
1428
|
+
};
|
|
1429
|
+
readonly jsonLd: {
|
|
1430
|
+
readonly type: "object";
|
|
1431
|
+
};
|
|
1432
|
+
readonly meta: {
|
|
1433
|
+
readonly type: "array";
|
|
1434
|
+
readonly items: {
|
|
1435
|
+
readonly type: "object";
|
|
1436
|
+
readonly properties: {
|
|
1437
|
+
readonly name: {
|
|
1438
|
+
readonly type: "string";
|
|
1439
|
+
};
|
|
1440
|
+
readonly content: {
|
|
1441
|
+
readonly type: "string";
|
|
1442
|
+
};
|
|
1443
|
+
};
|
|
1444
|
+
readonly required: readonly ["name", "content"];
|
|
1445
|
+
readonly additionalProperties: false;
|
|
1446
|
+
};
|
|
1447
|
+
};
|
|
1448
|
+
};
|
|
1449
|
+
readonly additionalProperties: false;
|
|
1450
|
+
};
|
|
1451
|
+
readonly rbac: {
|
|
1452
|
+
readonly type: "object";
|
|
1453
|
+
readonly properties: {
|
|
1454
|
+
readonly defaults: {
|
|
1455
|
+
readonly type: "object";
|
|
1456
|
+
readonly additionalProperties: {
|
|
1457
|
+
readonly type: "string";
|
|
1458
|
+
};
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
readonly additionalProperties: {
|
|
1462
|
+
readonly type: "object";
|
|
1463
|
+
readonly additionalProperties: {
|
|
1464
|
+
readonly type: "string";
|
|
1465
|
+
};
|
|
1466
|
+
};
|
|
1467
|
+
};
|
|
1468
|
+
readonly responseHeaders: {
|
|
1469
|
+
readonly type: "object";
|
|
1470
|
+
readonly additionalProperties: {
|
|
1471
|
+
readonly type: "array";
|
|
1472
|
+
readonly items: {
|
|
1473
|
+
readonly type: "object";
|
|
1474
|
+
readonly properties: {
|
|
1475
|
+
readonly name: {
|
|
1476
|
+
readonly type: "string";
|
|
1477
|
+
};
|
|
1478
|
+
readonly value: {
|
|
1479
|
+
readonly type: "string";
|
|
1480
|
+
};
|
|
1481
|
+
};
|
|
1482
|
+
readonly additionalProperties: false;
|
|
1483
|
+
readonly required: readonly ["name", "value"];
|
|
1484
|
+
};
|
|
1485
|
+
};
|
|
1486
|
+
};
|
|
1487
|
+
readonly mockServer: {
|
|
1488
|
+
readonly type: "object";
|
|
1489
|
+
readonly properties: {
|
|
1490
|
+
readonly off: {
|
|
1491
|
+
readonly type: "boolean";
|
|
1492
|
+
readonly default: false;
|
|
1493
|
+
};
|
|
1494
|
+
readonly position: {
|
|
1495
|
+
readonly type: "string";
|
|
1496
|
+
readonly enum: readonly ["first", "last", "replace", "off"];
|
|
1497
|
+
readonly default: "first";
|
|
1498
|
+
};
|
|
1499
|
+
readonly strictExamples: {
|
|
1500
|
+
readonly type: "boolean";
|
|
1501
|
+
readonly default: false;
|
|
1502
|
+
};
|
|
1503
|
+
readonly errorIfForcedExampleNotFound: {
|
|
1504
|
+
readonly type: "boolean";
|
|
1505
|
+
readonly default: false;
|
|
1506
|
+
};
|
|
1507
|
+
readonly description: {
|
|
1508
|
+
readonly type: "string";
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
};
|
|
1512
|
+
readonly apis: {
|
|
1513
|
+
readonly type: "object";
|
|
1514
|
+
readonly additionalProperties: {
|
|
1515
|
+
readonly type: "object";
|
|
1516
|
+
readonly properties: {
|
|
1517
|
+
readonly root: {
|
|
1518
|
+
readonly type: "string";
|
|
1519
|
+
};
|
|
1520
|
+
readonly rbac: {
|
|
1521
|
+
readonly type: "object";
|
|
1522
|
+
readonly additionalProperties: true;
|
|
1523
|
+
};
|
|
1524
|
+
readonly theme: {
|
|
1525
|
+
readonly type: "object";
|
|
1526
|
+
readonly properties: {
|
|
1527
|
+
readonly openapi: {
|
|
1528
|
+
readonly type: "object";
|
|
1529
|
+
readonly additionalProperties: true;
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
readonly additionalProperties: false;
|
|
1533
|
+
};
|
|
1534
|
+
readonly title: {
|
|
1535
|
+
readonly type: "string";
|
|
1536
|
+
};
|
|
1537
|
+
readonly metadata: {
|
|
1538
|
+
readonly type: "object";
|
|
1539
|
+
readonly additionalProperties: true;
|
|
1540
|
+
};
|
|
1541
|
+
};
|
|
1542
|
+
readonly additionalProperties: true;
|
|
1543
|
+
readonly required: readonly ["root"];
|
|
1544
|
+
};
|
|
1545
|
+
};
|
|
1546
|
+
readonly sso: {
|
|
1547
|
+
readonly type: "object";
|
|
1548
|
+
readonly additionalProperties: {
|
|
1549
|
+
readonly oneOf: readonly [{
|
|
1550
|
+
readonly type: "object";
|
|
1551
|
+
readonly properties: {
|
|
1552
|
+
readonly type: {
|
|
1553
|
+
readonly type: "string";
|
|
1554
|
+
readonly const: AuthProviderType.OIDC;
|
|
1555
|
+
};
|
|
1556
|
+
readonly title: {
|
|
1557
|
+
readonly type: "string";
|
|
1558
|
+
};
|
|
1559
|
+
readonly configurationUrl: {
|
|
1560
|
+
readonly type: "string";
|
|
1561
|
+
readonly minLength: 1;
|
|
1562
|
+
};
|
|
1563
|
+
readonly configuration: {
|
|
1564
|
+
readonly type: "object";
|
|
1565
|
+
readonly properties: {
|
|
1566
|
+
readonly end_session_endpoint: {
|
|
1567
|
+
readonly type: "string";
|
|
1568
|
+
};
|
|
1569
|
+
readonly token_endpoint: {
|
|
1570
|
+
readonly type: "string";
|
|
1571
|
+
};
|
|
1572
|
+
readonly authorization_endpoint: {
|
|
1573
|
+
readonly type: "string";
|
|
1574
|
+
};
|
|
1575
|
+
readonly jwks_uri: {
|
|
1576
|
+
readonly type: "string";
|
|
1577
|
+
};
|
|
1578
|
+
};
|
|
1579
|
+
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
|
|
1580
|
+
readonly additionalProperties: true;
|
|
1581
|
+
};
|
|
1582
|
+
readonly clientId: {
|
|
1583
|
+
readonly type: "string";
|
|
1584
|
+
readonly minLength: 1;
|
|
1585
|
+
};
|
|
1586
|
+
readonly clientSecret: {
|
|
1587
|
+
readonly type: "string";
|
|
1588
|
+
readonly minLength: 1;
|
|
1589
|
+
};
|
|
1590
|
+
readonly teamsClaimName: {
|
|
1591
|
+
readonly type: "string";
|
|
1592
|
+
};
|
|
1593
|
+
readonly teamsClaimMap: {
|
|
1594
|
+
readonly type: "object";
|
|
1595
|
+
readonly additionalProperties: {
|
|
1596
|
+
readonly type: "string";
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
readonly defaultTeams: {
|
|
1600
|
+
readonly type: "array";
|
|
1601
|
+
readonly items: {
|
|
1602
|
+
readonly type: "string";
|
|
1603
|
+
};
|
|
1604
|
+
};
|
|
1605
|
+
readonly scopes: {
|
|
1606
|
+
readonly type: "array";
|
|
1607
|
+
readonly items: {
|
|
1608
|
+
readonly type: "string";
|
|
1609
|
+
};
|
|
1610
|
+
};
|
|
1611
|
+
readonly tokenExpirationTime: {
|
|
1612
|
+
readonly type: "number";
|
|
1613
|
+
};
|
|
1614
|
+
readonly authorizationRequestCustomParams: {
|
|
1615
|
+
readonly type: "object";
|
|
1616
|
+
readonly additionalProperties: {
|
|
1617
|
+
readonly type: "string";
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
readonly tokenRequestCustomParams: {
|
|
1621
|
+
readonly type: "object";
|
|
1622
|
+
readonly additionalProperties: {
|
|
1623
|
+
readonly type: "string";
|
|
1624
|
+
};
|
|
1625
|
+
};
|
|
1626
|
+
readonly audience: {
|
|
1627
|
+
readonly type: "array";
|
|
1628
|
+
readonly items: {
|
|
1629
|
+
readonly type: "string";
|
|
1630
|
+
};
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
readonly required: readonly ["type", "clientId", "clientSecret"];
|
|
1634
|
+
readonly oneOf: readonly [{
|
|
1635
|
+
readonly required: readonly ["configurationUrl"];
|
|
1636
|
+
}, {
|
|
1637
|
+
readonly required: readonly ["configuration"];
|
|
1638
|
+
}];
|
|
1639
|
+
readonly additionalProperties: false;
|
|
1640
|
+
}, {
|
|
1641
|
+
readonly type: "object";
|
|
1642
|
+
readonly properties: {
|
|
1643
|
+
readonly type: {
|
|
1644
|
+
readonly type: "string";
|
|
1645
|
+
readonly const: AuthProviderType.SAML2;
|
|
1646
|
+
};
|
|
1647
|
+
readonly title: {
|
|
1648
|
+
readonly type: "string";
|
|
1649
|
+
};
|
|
1650
|
+
readonly issuerId: {
|
|
1651
|
+
readonly type: "string";
|
|
1652
|
+
};
|
|
1653
|
+
readonly entityId: {
|
|
1654
|
+
readonly type: "string";
|
|
1655
|
+
};
|
|
1656
|
+
readonly ssoUrl: {
|
|
1657
|
+
readonly type: "string";
|
|
1658
|
+
};
|
|
1659
|
+
readonly x509PublicCert: {
|
|
1660
|
+
readonly type: "string";
|
|
1661
|
+
};
|
|
1662
|
+
readonly teamsAttributeName: {
|
|
1663
|
+
readonly type: "string";
|
|
1664
|
+
readonly default: "https://redocly.com/sso/teams";
|
|
1665
|
+
};
|
|
1666
|
+
readonly teamsAttributeMap: {
|
|
1667
|
+
readonly type: "object";
|
|
1668
|
+
readonly additionalProperties: {
|
|
1669
|
+
readonly type: "string";
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
readonly defaultTeams: {
|
|
1673
|
+
readonly type: "array";
|
|
1674
|
+
readonly items: {
|
|
1675
|
+
readonly type: "string";
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1678
|
+
};
|
|
1679
|
+
readonly additionalProperties: false;
|
|
1680
|
+
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
|
|
1681
|
+
}, {
|
|
1682
|
+
readonly type: "object";
|
|
1683
|
+
readonly properties: {
|
|
1684
|
+
readonly type: {
|
|
1685
|
+
readonly type: "string";
|
|
1686
|
+
readonly const: AuthProviderType.BASIC;
|
|
1687
|
+
};
|
|
1688
|
+
readonly title: {
|
|
1689
|
+
readonly type: "string";
|
|
1690
|
+
};
|
|
1691
|
+
readonly credentials: {
|
|
1692
|
+
readonly type: "array";
|
|
1693
|
+
readonly items: {
|
|
1694
|
+
readonly type: "object";
|
|
1695
|
+
readonly properties: {
|
|
1696
|
+
readonly username: {
|
|
1697
|
+
readonly type: "string";
|
|
1698
|
+
};
|
|
1699
|
+
readonly password: {
|
|
1700
|
+
readonly type: "string";
|
|
1701
|
+
};
|
|
1702
|
+
readonly passwordHash: {
|
|
1703
|
+
readonly type: "string";
|
|
1704
|
+
};
|
|
1705
|
+
readonly teams: {
|
|
1706
|
+
readonly type: "array";
|
|
1707
|
+
readonly items: {
|
|
1708
|
+
readonly type: "string";
|
|
1709
|
+
};
|
|
1710
|
+
};
|
|
1711
|
+
};
|
|
1712
|
+
readonly required: readonly ["username"];
|
|
1713
|
+
readonly additionalProperties: false;
|
|
1714
|
+
};
|
|
1715
|
+
};
|
|
1716
|
+
};
|
|
1717
|
+
readonly required: readonly ["type", "credentials"];
|
|
1718
|
+
readonly additionalProperties: false;
|
|
1719
|
+
}];
|
|
1720
|
+
readonly discriminator: {
|
|
1721
|
+
readonly propertyName: "type";
|
|
1722
|
+
};
|
|
1723
|
+
};
|
|
1724
|
+
};
|
|
1725
|
+
readonly developerOnboarding: {
|
|
1726
|
+
readonly type: "object";
|
|
1727
|
+
readonly required: readonly ["adapters"];
|
|
1728
|
+
readonly additionalProperties: false;
|
|
1729
|
+
readonly properties: {
|
|
1730
|
+
readonly adapters: {
|
|
1731
|
+
readonly type: "array";
|
|
1732
|
+
readonly items: {
|
|
1733
|
+
readonly type: "object";
|
|
1734
|
+
readonly oneOf: readonly [{
|
|
1735
|
+
readonly type: "object";
|
|
1736
|
+
readonly properties: {
|
|
1737
|
+
readonly type: {
|
|
1738
|
+
readonly type: "string";
|
|
1739
|
+
readonly const: "APIGEE_X";
|
|
1740
|
+
};
|
|
1741
|
+
readonly apiUrl: {
|
|
1742
|
+
readonly type: "string";
|
|
1743
|
+
};
|
|
1744
|
+
readonly stage: {
|
|
1745
|
+
readonly type: "string";
|
|
1746
|
+
readonly default: "non-production";
|
|
1747
|
+
};
|
|
1748
|
+
readonly organizationName: {
|
|
1749
|
+
readonly type: "string";
|
|
1750
|
+
};
|
|
1751
|
+
readonly ignoreApiProducts: {
|
|
1752
|
+
readonly type: "array";
|
|
1753
|
+
readonly items: {
|
|
1754
|
+
readonly type: "string";
|
|
1755
|
+
};
|
|
1756
|
+
};
|
|
1757
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
1758
|
+
readonly type: "boolean";
|
|
1759
|
+
readonly default: false;
|
|
1760
|
+
};
|
|
1761
|
+
readonly auth: {
|
|
1762
|
+
readonly type: "object";
|
|
1763
|
+
readonly oneOf: readonly [{
|
|
1764
|
+
readonly type: "object";
|
|
1765
|
+
readonly properties: {
|
|
1766
|
+
readonly type: {
|
|
1767
|
+
readonly type: "string";
|
|
1768
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
1769
|
+
};
|
|
1770
|
+
readonly tokenEndpoint: {
|
|
1771
|
+
readonly type: "string";
|
|
1772
|
+
};
|
|
1773
|
+
readonly clientId: {
|
|
1774
|
+
readonly type: "string";
|
|
1775
|
+
};
|
|
1776
|
+
readonly clientSecret: {
|
|
1777
|
+
readonly type: "string";
|
|
1778
|
+
};
|
|
1779
|
+
};
|
|
1780
|
+
readonly additionalProperties: false;
|
|
1781
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
1782
|
+
}, {
|
|
1783
|
+
readonly type: "object";
|
|
1784
|
+
readonly properties: {
|
|
1785
|
+
readonly type: {
|
|
1786
|
+
readonly type: "string";
|
|
1787
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
1788
|
+
};
|
|
1789
|
+
readonly serviceAccountEmail: {
|
|
1790
|
+
readonly type: "string";
|
|
1791
|
+
};
|
|
1792
|
+
readonly serviceAccountPrivateKey: {
|
|
1793
|
+
readonly type: "string";
|
|
1794
|
+
};
|
|
1795
|
+
};
|
|
1796
|
+
readonly additionalProperties: false;
|
|
1797
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
1798
|
+
}];
|
|
1799
|
+
readonly discriminator: {
|
|
1800
|
+
readonly propertyName: "type";
|
|
1801
|
+
};
|
|
1802
|
+
};
|
|
1803
|
+
};
|
|
1804
|
+
readonly additionalProperties: false;
|
|
1805
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
1806
|
+
}, {
|
|
1807
|
+
readonly properties: {
|
|
1808
|
+
readonly type: {
|
|
1809
|
+
readonly type: "string";
|
|
1810
|
+
readonly const: "APIGEE_EDGE";
|
|
1811
|
+
};
|
|
1812
|
+
readonly apiUrl: {
|
|
1813
|
+
readonly type: "string";
|
|
1814
|
+
};
|
|
1815
|
+
readonly stage: {
|
|
1816
|
+
readonly type: "string";
|
|
1817
|
+
readonly default: "non-production";
|
|
1818
|
+
};
|
|
1819
|
+
readonly organizationName: {
|
|
1820
|
+
readonly type: "string";
|
|
1821
|
+
};
|
|
1822
|
+
readonly ignoreApiProducts: {
|
|
1823
|
+
readonly type: "array";
|
|
1824
|
+
readonly items: {
|
|
1825
|
+
readonly type: "string";
|
|
1826
|
+
};
|
|
1827
|
+
};
|
|
1828
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
1829
|
+
readonly type: "boolean";
|
|
1830
|
+
readonly default: false;
|
|
1831
|
+
};
|
|
1832
|
+
readonly auth: {
|
|
1833
|
+
readonly type: "object";
|
|
1834
|
+
readonly oneOf: readonly [{
|
|
1835
|
+
readonly type: "object";
|
|
1836
|
+
readonly properties: {
|
|
1837
|
+
readonly type: {
|
|
1838
|
+
readonly type: "string";
|
|
1839
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
1840
|
+
};
|
|
1841
|
+
readonly tokenEndpoint: {
|
|
1842
|
+
readonly type: "string";
|
|
1843
|
+
};
|
|
1844
|
+
readonly clientId: {
|
|
1845
|
+
readonly type: "string";
|
|
1846
|
+
};
|
|
1847
|
+
readonly clientSecret: {
|
|
1848
|
+
readonly type: "string";
|
|
1849
|
+
};
|
|
1850
|
+
};
|
|
1851
|
+
readonly additionalProperties: false;
|
|
1852
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
1853
|
+
}, {
|
|
1854
|
+
readonly type: "object";
|
|
1855
|
+
readonly properties: {
|
|
1856
|
+
readonly type: {
|
|
1857
|
+
readonly type: "string";
|
|
1858
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
1859
|
+
};
|
|
1860
|
+
readonly serviceAccountEmail: {
|
|
1861
|
+
readonly type: "string";
|
|
1862
|
+
};
|
|
1863
|
+
readonly serviceAccountPrivateKey: {
|
|
1864
|
+
readonly type: "string";
|
|
1865
|
+
};
|
|
1866
|
+
};
|
|
1867
|
+
readonly additionalProperties: false;
|
|
1868
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
1869
|
+
}];
|
|
1870
|
+
readonly discriminator: {
|
|
1871
|
+
readonly propertyName: "type";
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
};
|
|
1875
|
+
readonly type: "object";
|
|
1876
|
+
readonly additionalProperties: false;
|
|
1877
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
1878
|
+
}, {
|
|
1879
|
+
readonly type: "object";
|
|
1880
|
+
readonly properties: {
|
|
1881
|
+
readonly type: {
|
|
1882
|
+
readonly type: "string";
|
|
1883
|
+
readonly const: "GRAVITEE";
|
|
1884
|
+
};
|
|
1885
|
+
readonly apiBaseUrl: {
|
|
1886
|
+
readonly type: "string";
|
|
1887
|
+
};
|
|
1888
|
+
readonly env: {
|
|
1889
|
+
readonly type: "string";
|
|
1890
|
+
};
|
|
1891
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
1892
|
+
readonly type: "boolean";
|
|
1893
|
+
readonly default: false;
|
|
1894
|
+
};
|
|
1895
|
+
readonly stage: {
|
|
1896
|
+
readonly type: "string";
|
|
1897
|
+
readonly default: "non-production";
|
|
1898
|
+
};
|
|
1899
|
+
readonly auth: {
|
|
1900
|
+
readonly type: "object";
|
|
1901
|
+
readonly properties: {
|
|
1902
|
+
readonly static: {
|
|
1903
|
+
readonly type: "string";
|
|
1904
|
+
};
|
|
1905
|
+
};
|
|
1906
|
+
};
|
|
1907
|
+
};
|
|
1908
|
+
readonly additionalProperties: false;
|
|
1909
|
+
readonly required: readonly ["type", "apiBaseUrl"];
|
|
1910
|
+
}];
|
|
1911
|
+
readonly discriminator: {
|
|
1912
|
+
readonly propertyName: "type";
|
|
1913
|
+
};
|
|
1914
|
+
};
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
};
|
|
1918
|
+
readonly i18n: {
|
|
1919
|
+
readonly type: "object";
|
|
1920
|
+
readonly properties: {
|
|
1921
|
+
readonly defaultLocale: {
|
|
1922
|
+
readonly type: "string";
|
|
1923
|
+
};
|
|
1924
|
+
readonly locales: {
|
|
1925
|
+
readonly type: "array";
|
|
1926
|
+
readonly items: {
|
|
1927
|
+
readonly type: "object";
|
|
1928
|
+
readonly properties: {
|
|
1929
|
+
readonly code: {
|
|
1930
|
+
readonly type: "string";
|
|
1931
|
+
};
|
|
1932
|
+
readonly name: {
|
|
1933
|
+
readonly type: "string";
|
|
1934
|
+
};
|
|
1935
|
+
};
|
|
1936
|
+
readonly required: readonly ["code"];
|
|
1937
|
+
};
|
|
1938
|
+
};
|
|
1939
|
+
};
|
|
1940
|
+
readonly additionalProperties: false;
|
|
1941
|
+
readonly required: readonly ["defaultLocale", "locales"];
|
|
1942
|
+
};
|
|
1943
|
+
readonly metadata: {
|
|
1944
|
+
readonly type: "object";
|
|
1945
|
+
readonly additionalProperties: true;
|
|
1946
|
+
};
|
|
1947
|
+
};
|
|
1948
|
+
readonly default: {};
|
|
1949
|
+
}, {
|
|
1950
|
+
readonly type: "object";
|
|
1951
|
+
readonly properties: {
|
|
1952
|
+
readonly $ref: {
|
|
1953
|
+
readonly type: "string";
|
|
1954
|
+
};
|
|
1955
|
+
};
|
|
1956
|
+
readonly required: readonly ["$ref"];
|
|
1957
|
+
readonly additionalProperties: false;
|
|
1958
|
+
}];
|
|
1959
|
+
};
|
|
1960
|
+
};
|
|
1961
|
+
readonly licenseKey: {
|
|
1962
|
+
readonly type: "string";
|
|
1963
|
+
};
|
|
1964
|
+
readonly theme: {
|
|
1965
|
+
readonly type: "object";
|
|
1966
|
+
readonly default: {};
|
|
1967
|
+
};
|
|
1968
|
+
readonly redirects: {
|
|
1969
|
+
readonly type: "object";
|
|
1970
|
+
readonly additionalProperties: {
|
|
1971
|
+
readonly type: "object";
|
|
1972
|
+
readonly properties: {
|
|
1973
|
+
readonly to: {
|
|
1974
|
+
readonly type: "string";
|
|
1975
|
+
};
|
|
1976
|
+
readonly type: {
|
|
1977
|
+
readonly type: "number";
|
|
1978
|
+
readonly default: 301;
|
|
1979
|
+
};
|
|
1980
|
+
};
|
|
1981
|
+
readonly required: readonly ["to"];
|
|
1982
|
+
readonly additionalProperties: false;
|
|
1983
|
+
};
|
|
1984
|
+
readonly default: {};
|
|
1985
|
+
};
|
|
1986
|
+
readonly seo: {
|
|
1987
|
+
readonly type: "object";
|
|
1988
|
+
readonly properties: {
|
|
1989
|
+
readonly title: {
|
|
1990
|
+
readonly type: "string";
|
|
1991
|
+
};
|
|
1992
|
+
readonly description: {
|
|
1993
|
+
readonly type: "string";
|
|
1994
|
+
};
|
|
1995
|
+
readonly siteUrl: {
|
|
1996
|
+
readonly type: "string";
|
|
1997
|
+
};
|
|
1998
|
+
readonly image: {
|
|
1999
|
+
readonly type: "string";
|
|
2000
|
+
};
|
|
2001
|
+
readonly keywords: {
|
|
2002
|
+
readonly type: "array";
|
|
2003
|
+
readonly items: {
|
|
2004
|
+
readonly type: "string";
|
|
2005
|
+
};
|
|
2006
|
+
};
|
|
2007
|
+
readonly lang: {
|
|
2008
|
+
readonly type: "string";
|
|
2009
|
+
};
|
|
2010
|
+
readonly jsonLd: {
|
|
2011
|
+
readonly type: "object";
|
|
2012
|
+
};
|
|
2013
|
+
readonly meta: {
|
|
2014
|
+
readonly type: "array";
|
|
2015
|
+
readonly items: {
|
|
2016
|
+
readonly type: "object";
|
|
2017
|
+
readonly properties: {
|
|
2018
|
+
readonly name: {
|
|
2019
|
+
readonly type: "string";
|
|
2020
|
+
};
|
|
2021
|
+
readonly content: {
|
|
2022
|
+
readonly type: "string";
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
readonly required: readonly ["name", "content"];
|
|
2026
|
+
readonly additionalProperties: false;
|
|
2027
|
+
};
|
|
2028
|
+
};
|
|
2029
|
+
};
|
|
2030
|
+
readonly additionalProperties: false;
|
|
2031
|
+
};
|
|
2032
|
+
readonly rbac: {
|
|
2033
|
+
readonly type: "object";
|
|
2034
|
+
readonly properties: {
|
|
2035
|
+
readonly defaults: {
|
|
2036
|
+
readonly type: "object";
|
|
2037
|
+
readonly additionalProperties: {
|
|
2038
|
+
readonly type: "string";
|
|
2039
|
+
};
|
|
2040
|
+
};
|
|
2041
|
+
};
|
|
2042
|
+
readonly additionalProperties: {
|
|
2043
|
+
readonly type: "object";
|
|
2044
|
+
readonly additionalProperties: {
|
|
2045
|
+
readonly type: "string";
|
|
2046
|
+
};
|
|
2047
|
+
};
|
|
2048
|
+
};
|
|
2049
|
+
readonly responseHeaders: {
|
|
2050
|
+
readonly type: "object";
|
|
2051
|
+
readonly additionalProperties: {
|
|
2052
|
+
readonly type: "array";
|
|
2053
|
+
readonly items: {
|
|
2054
|
+
readonly type: "object";
|
|
2055
|
+
readonly properties: {
|
|
2056
|
+
readonly name: {
|
|
2057
|
+
readonly type: "string";
|
|
2058
|
+
};
|
|
2059
|
+
readonly value: {
|
|
2060
|
+
readonly type: "string";
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
readonly additionalProperties: false;
|
|
2064
|
+
readonly required: readonly ["name", "value"];
|
|
2065
|
+
};
|
|
2066
|
+
};
|
|
2067
|
+
};
|
|
2068
|
+
readonly mockServer: {
|
|
2069
|
+
readonly type: "object";
|
|
2070
|
+
readonly properties: {
|
|
2071
|
+
readonly off: {
|
|
2072
|
+
readonly type: "boolean";
|
|
2073
|
+
readonly default: false;
|
|
2074
|
+
};
|
|
2075
|
+
readonly position: {
|
|
2076
|
+
readonly type: "string";
|
|
2077
|
+
readonly enum: readonly ["first", "last", "replace", "off"];
|
|
2078
|
+
readonly default: "first";
|
|
2079
|
+
};
|
|
2080
|
+
readonly strictExamples: {
|
|
2081
|
+
readonly type: "boolean";
|
|
2082
|
+
readonly default: false;
|
|
2083
|
+
};
|
|
2084
|
+
readonly errorIfForcedExampleNotFound: {
|
|
2085
|
+
readonly type: "boolean";
|
|
2086
|
+
readonly default: false;
|
|
2087
|
+
};
|
|
2088
|
+
readonly description: {
|
|
2089
|
+
readonly type: "string";
|
|
2090
|
+
};
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
readonly apis: {
|
|
2094
|
+
readonly type: "object";
|
|
2095
|
+
readonly additionalProperties: {
|
|
2096
|
+
readonly type: "object";
|
|
2097
|
+
readonly properties: {
|
|
2098
|
+
readonly root: {
|
|
2099
|
+
readonly type: "string";
|
|
2100
|
+
};
|
|
2101
|
+
readonly rbac: {
|
|
2102
|
+
readonly type: "object";
|
|
2103
|
+
readonly additionalProperties: true;
|
|
2104
|
+
};
|
|
2105
|
+
readonly theme: {
|
|
2106
|
+
readonly type: "object";
|
|
2107
|
+
readonly properties: {
|
|
2108
|
+
readonly openapi: {
|
|
2109
|
+
readonly type: "object";
|
|
2110
|
+
readonly additionalProperties: true;
|
|
2111
|
+
};
|
|
2112
|
+
};
|
|
2113
|
+
readonly additionalProperties: false;
|
|
2114
|
+
};
|
|
2115
|
+
readonly title: {
|
|
2116
|
+
readonly type: "string";
|
|
2117
|
+
};
|
|
2118
|
+
readonly metadata: {
|
|
2119
|
+
readonly type: "object";
|
|
2120
|
+
readonly additionalProperties: true;
|
|
2121
|
+
};
|
|
2122
|
+
};
|
|
2123
|
+
readonly additionalProperties: true;
|
|
2124
|
+
readonly required: readonly ["root"];
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
2127
|
+
readonly sso: {
|
|
2128
|
+
readonly type: "object";
|
|
2129
|
+
readonly additionalProperties: {
|
|
2130
|
+
readonly oneOf: readonly [{
|
|
2131
|
+
readonly type: "object";
|
|
2132
|
+
readonly properties: {
|
|
2133
|
+
readonly type: {
|
|
2134
|
+
readonly type: "string";
|
|
2135
|
+
readonly const: AuthProviderType.OIDC;
|
|
2136
|
+
};
|
|
2137
|
+
readonly title: {
|
|
2138
|
+
readonly type: "string";
|
|
2139
|
+
};
|
|
2140
|
+
readonly configurationUrl: {
|
|
2141
|
+
readonly type: "string";
|
|
2142
|
+
readonly minLength: 1;
|
|
2143
|
+
};
|
|
2144
|
+
readonly configuration: {
|
|
2145
|
+
readonly type: "object";
|
|
2146
|
+
readonly properties: {
|
|
2147
|
+
readonly end_session_endpoint: {
|
|
2148
|
+
readonly type: "string";
|
|
2149
|
+
};
|
|
2150
|
+
readonly token_endpoint: {
|
|
2151
|
+
readonly type: "string";
|
|
2152
|
+
};
|
|
2153
|
+
readonly authorization_endpoint: {
|
|
2154
|
+
readonly type: "string";
|
|
2155
|
+
};
|
|
2156
|
+
readonly jwks_uri: {
|
|
2157
|
+
readonly type: "string";
|
|
2158
|
+
};
|
|
2159
|
+
};
|
|
2160
|
+
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
|
|
2161
|
+
readonly additionalProperties: true;
|
|
2162
|
+
};
|
|
2163
|
+
readonly clientId: {
|
|
2164
|
+
readonly type: "string";
|
|
2165
|
+
readonly minLength: 1;
|
|
2166
|
+
};
|
|
2167
|
+
readonly clientSecret: {
|
|
2168
|
+
readonly type: "string";
|
|
2169
|
+
readonly minLength: 1;
|
|
2170
|
+
};
|
|
2171
|
+
readonly teamsClaimName: {
|
|
2172
|
+
readonly type: "string";
|
|
2173
|
+
};
|
|
2174
|
+
readonly teamsClaimMap: {
|
|
2175
|
+
readonly type: "object";
|
|
2176
|
+
readonly additionalProperties: {
|
|
2177
|
+
readonly type: "string";
|
|
2178
|
+
};
|
|
2179
|
+
};
|
|
2180
|
+
readonly defaultTeams: {
|
|
2181
|
+
readonly type: "array";
|
|
2182
|
+
readonly items: {
|
|
2183
|
+
readonly type: "string";
|
|
2184
|
+
};
|
|
2185
|
+
};
|
|
2186
|
+
readonly scopes: {
|
|
2187
|
+
readonly type: "array";
|
|
2188
|
+
readonly items: {
|
|
2189
|
+
readonly type: "string";
|
|
2190
|
+
};
|
|
2191
|
+
};
|
|
2192
|
+
readonly tokenExpirationTime: {
|
|
2193
|
+
readonly type: "number";
|
|
2194
|
+
};
|
|
2195
|
+
readonly authorizationRequestCustomParams: {
|
|
2196
|
+
readonly type: "object";
|
|
2197
|
+
readonly additionalProperties: {
|
|
2198
|
+
readonly type: "string";
|
|
2199
|
+
};
|
|
2200
|
+
};
|
|
2201
|
+
readonly tokenRequestCustomParams: {
|
|
2202
|
+
readonly type: "object";
|
|
2203
|
+
readonly additionalProperties: {
|
|
2204
|
+
readonly type: "string";
|
|
2205
|
+
};
|
|
2206
|
+
};
|
|
2207
|
+
readonly audience: {
|
|
2208
|
+
readonly type: "array";
|
|
2209
|
+
readonly items: {
|
|
2210
|
+
readonly type: "string";
|
|
2211
|
+
};
|
|
2212
|
+
};
|
|
2213
|
+
};
|
|
2214
|
+
readonly required: readonly ["type", "clientId", "clientSecret"];
|
|
2215
|
+
readonly oneOf: readonly [{
|
|
2216
|
+
readonly required: readonly ["configurationUrl"];
|
|
2217
|
+
}, {
|
|
2218
|
+
readonly required: readonly ["configuration"];
|
|
2219
|
+
}];
|
|
2220
|
+
readonly additionalProperties: false;
|
|
2221
|
+
}, {
|
|
2222
|
+
readonly type: "object";
|
|
2223
|
+
readonly properties: {
|
|
2224
|
+
readonly type: {
|
|
2225
|
+
readonly type: "string";
|
|
2226
|
+
readonly const: AuthProviderType.SAML2;
|
|
2227
|
+
};
|
|
2228
|
+
readonly title: {
|
|
2229
|
+
readonly type: "string";
|
|
2230
|
+
};
|
|
2231
|
+
readonly issuerId: {
|
|
2232
|
+
readonly type: "string";
|
|
2233
|
+
};
|
|
2234
|
+
readonly entityId: {
|
|
2235
|
+
readonly type: "string";
|
|
2236
|
+
};
|
|
2237
|
+
readonly ssoUrl: {
|
|
2238
|
+
readonly type: "string";
|
|
2239
|
+
};
|
|
2240
|
+
readonly x509PublicCert: {
|
|
2241
|
+
readonly type: "string";
|
|
2242
|
+
};
|
|
2243
|
+
readonly teamsAttributeName: {
|
|
2244
|
+
readonly type: "string";
|
|
2245
|
+
readonly default: "https://redocly.com/sso/teams";
|
|
2246
|
+
};
|
|
2247
|
+
readonly teamsAttributeMap: {
|
|
2248
|
+
readonly type: "object";
|
|
2249
|
+
readonly additionalProperties: {
|
|
2250
|
+
readonly type: "string";
|
|
2251
|
+
};
|
|
2252
|
+
};
|
|
2253
|
+
readonly defaultTeams: {
|
|
2254
|
+
readonly type: "array";
|
|
2255
|
+
readonly items: {
|
|
2256
|
+
readonly type: "string";
|
|
2257
|
+
};
|
|
2258
|
+
};
|
|
2259
|
+
};
|
|
2260
|
+
readonly additionalProperties: false;
|
|
2261
|
+
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
|
|
2262
|
+
}, {
|
|
2263
|
+
readonly type: "object";
|
|
2264
|
+
readonly properties: {
|
|
2265
|
+
readonly type: {
|
|
2266
|
+
readonly type: "string";
|
|
2267
|
+
readonly const: AuthProviderType.BASIC;
|
|
2268
|
+
};
|
|
2269
|
+
readonly title: {
|
|
2270
|
+
readonly type: "string";
|
|
2271
|
+
};
|
|
2272
|
+
readonly credentials: {
|
|
2273
|
+
readonly type: "array";
|
|
2274
|
+
readonly items: {
|
|
2275
|
+
readonly type: "object";
|
|
2276
|
+
readonly properties: {
|
|
2277
|
+
readonly username: {
|
|
2278
|
+
readonly type: "string";
|
|
2279
|
+
};
|
|
2280
|
+
readonly password: {
|
|
2281
|
+
readonly type: "string";
|
|
2282
|
+
};
|
|
2283
|
+
readonly passwordHash: {
|
|
2284
|
+
readonly type: "string";
|
|
2285
|
+
};
|
|
2286
|
+
readonly teams: {
|
|
2287
|
+
readonly type: "array";
|
|
2288
|
+
readonly items: {
|
|
2289
|
+
readonly type: "string";
|
|
2290
|
+
};
|
|
2291
|
+
};
|
|
2292
|
+
};
|
|
2293
|
+
readonly required: readonly ["username"];
|
|
2294
|
+
readonly additionalProperties: false;
|
|
2295
|
+
};
|
|
2296
|
+
};
|
|
2297
|
+
};
|
|
2298
|
+
readonly required: readonly ["type", "credentials"];
|
|
2299
|
+
readonly additionalProperties: false;
|
|
2300
|
+
}];
|
|
2301
|
+
readonly discriminator: {
|
|
2302
|
+
readonly propertyName: "type";
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
};
|
|
2306
|
+
readonly developerOnboarding: {
|
|
2307
|
+
readonly type: "object";
|
|
2308
|
+
readonly required: readonly ["adapters"];
|
|
2309
|
+
readonly additionalProperties: false;
|
|
2310
|
+
readonly properties: {
|
|
2311
|
+
readonly adapters: {
|
|
2312
|
+
readonly type: "array";
|
|
2313
|
+
readonly items: {
|
|
2314
|
+
readonly type: "object";
|
|
2315
|
+
readonly oneOf: readonly [{
|
|
2316
|
+
readonly type: "object";
|
|
2317
|
+
readonly properties: {
|
|
2318
|
+
readonly type: {
|
|
2319
|
+
readonly type: "string";
|
|
2320
|
+
readonly const: "APIGEE_X";
|
|
2321
|
+
};
|
|
2322
|
+
readonly apiUrl: {
|
|
2323
|
+
readonly type: "string";
|
|
2324
|
+
};
|
|
2325
|
+
readonly stage: {
|
|
2326
|
+
readonly type: "string";
|
|
2327
|
+
readonly default: "non-production";
|
|
2328
|
+
};
|
|
2329
|
+
readonly organizationName: {
|
|
2330
|
+
readonly type: "string";
|
|
2331
|
+
};
|
|
2332
|
+
readonly ignoreApiProducts: {
|
|
2333
|
+
readonly type: "array";
|
|
2334
|
+
readonly items: {
|
|
2335
|
+
readonly type: "string";
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2338
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
2339
|
+
readonly type: "boolean";
|
|
2340
|
+
readonly default: false;
|
|
2341
|
+
};
|
|
2342
|
+
readonly auth: {
|
|
2343
|
+
readonly type: "object";
|
|
2344
|
+
readonly oneOf: readonly [{
|
|
2345
|
+
readonly type: "object";
|
|
2346
|
+
readonly properties: {
|
|
2347
|
+
readonly type: {
|
|
2348
|
+
readonly type: "string";
|
|
2349
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
2350
|
+
};
|
|
2351
|
+
readonly tokenEndpoint: {
|
|
2352
|
+
readonly type: "string";
|
|
2353
|
+
};
|
|
2354
|
+
readonly clientId: {
|
|
2355
|
+
readonly type: "string";
|
|
2356
|
+
};
|
|
2357
|
+
readonly clientSecret: {
|
|
2358
|
+
readonly type: "string";
|
|
2359
|
+
};
|
|
2360
|
+
};
|
|
2361
|
+
readonly additionalProperties: false;
|
|
2362
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
2363
|
+
}, {
|
|
2364
|
+
readonly type: "object";
|
|
2365
|
+
readonly properties: {
|
|
2366
|
+
readonly type: {
|
|
2367
|
+
readonly type: "string";
|
|
2368
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
2369
|
+
};
|
|
2370
|
+
readonly serviceAccountEmail: {
|
|
2371
|
+
readonly type: "string";
|
|
2372
|
+
};
|
|
2373
|
+
readonly serviceAccountPrivateKey: {
|
|
2374
|
+
readonly type: "string";
|
|
2375
|
+
};
|
|
2376
|
+
};
|
|
2377
|
+
readonly additionalProperties: false;
|
|
2378
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
2379
|
+
}];
|
|
2380
|
+
readonly discriminator: {
|
|
2381
|
+
readonly propertyName: "type";
|
|
2382
|
+
};
|
|
2383
|
+
};
|
|
2384
|
+
};
|
|
2385
|
+
readonly additionalProperties: false;
|
|
2386
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
2387
|
+
}, {
|
|
2388
|
+
readonly properties: {
|
|
2389
|
+
readonly type: {
|
|
2390
|
+
readonly type: "string";
|
|
2391
|
+
readonly const: "APIGEE_EDGE";
|
|
2392
|
+
};
|
|
2393
|
+
readonly apiUrl: {
|
|
2394
|
+
readonly type: "string";
|
|
2395
|
+
};
|
|
2396
|
+
readonly stage: {
|
|
2397
|
+
readonly type: "string";
|
|
2398
|
+
readonly default: "non-production";
|
|
2399
|
+
};
|
|
2400
|
+
readonly organizationName: {
|
|
2401
|
+
readonly type: "string";
|
|
2402
|
+
};
|
|
2403
|
+
readonly ignoreApiProducts: {
|
|
2404
|
+
readonly type: "array";
|
|
2405
|
+
readonly items: {
|
|
2406
|
+
readonly type: "string";
|
|
2407
|
+
};
|
|
2408
|
+
};
|
|
2409
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
2410
|
+
readonly type: "boolean";
|
|
2411
|
+
readonly default: false;
|
|
2412
|
+
};
|
|
2413
|
+
readonly auth: {
|
|
2414
|
+
readonly type: "object";
|
|
2415
|
+
readonly oneOf: readonly [{
|
|
2416
|
+
readonly type: "object";
|
|
2417
|
+
readonly properties: {
|
|
2418
|
+
readonly type: {
|
|
2419
|
+
readonly type: "string";
|
|
2420
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2;
|
|
2421
|
+
};
|
|
2422
|
+
readonly tokenEndpoint: {
|
|
2423
|
+
readonly type: "string";
|
|
2424
|
+
};
|
|
2425
|
+
readonly clientId: {
|
|
2426
|
+
readonly type: "string";
|
|
2427
|
+
};
|
|
2428
|
+
readonly clientSecret: {
|
|
2429
|
+
readonly type: "string";
|
|
2430
|
+
};
|
|
2431
|
+
};
|
|
2432
|
+
readonly additionalProperties: false;
|
|
2433
|
+
readonly required: readonly ["type", "tokenEndpoint", "clientId", "clientSecret"];
|
|
2434
|
+
}, {
|
|
2435
|
+
readonly type: "object";
|
|
2436
|
+
readonly properties: {
|
|
2437
|
+
readonly type: {
|
|
2438
|
+
readonly type: "string";
|
|
2439
|
+
readonly const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT;
|
|
2440
|
+
};
|
|
2441
|
+
readonly serviceAccountEmail: {
|
|
2442
|
+
readonly type: "string";
|
|
2443
|
+
};
|
|
2444
|
+
readonly serviceAccountPrivateKey: {
|
|
2445
|
+
readonly type: "string";
|
|
2446
|
+
};
|
|
2447
|
+
};
|
|
2448
|
+
readonly additionalProperties: false;
|
|
2449
|
+
readonly required: readonly ["type", "serviceAccountEmail", "serviceAccountPrivateKey"];
|
|
2450
|
+
}];
|
|
2451
|
+
readonly discriminator: {
|
|
2452
|
+
readonly propertyName: "type";
|
|
2453
|
+
};
|
|
2454
|
+
};
|
|
2455
|
+
};
|
|
2456
|
+
readonly type: "object";
|
|
2457
|
+
readonly additionalProperties: false;
|
|
2458
|
+
readonly required: readonly ["type", "organizationName", "auth"];
|
|
2459
|
+
}, {
|
|
2460
|
+
readonly type: "object";
|
|
2461
|
+
readonly properties: {
|
|
2462
|
+
readonly type: {
|
|
2463
|
+
readonly type: "string";
|
|
2464
|
+
readonly const: "GRAVITEE";
|
|
2465
|
+
};
|
|
2466
|
+
readonly apiBaseUrl: {
|
|
2467
|
+
readonly type: "string";
|
|
2468
|
+
};
|
|
2469
|
+
readonly env: {
|
|
2470
|
+
readonly type: "string";
|
|
2471
|
+
};
|
|
2472
|
+
readonly allowApiProductsOutsideCatalog: {
|
|
2473
|
+
readonly type: "boolean";
|
|
2474
|
+
readonly default: false;
|
|
2475
|
+
};
|
|
2476
|
+
readonly stage: {
|
|
2477
|
+
readonly type: "string";
|
|
2478
|
+
readonly default: "non-production";
|
|
2479
|
+
};
|
|
2480
|
+
readonly auth: {
|
|
2481
|
+
readonly type: "object";
|
|
2482
|
+
readonly properties: {
|
|
2483
|
+
readonly static: {
|
|
2484
|
+
readonly type: "string";
|
|
2485
|
+
};
|
|
2486
|
+
};
|
|
2487
|
+
};
|
|
2488
|
+
};
|
|
2489
|
+
readonly additionalProperties: false;
|
|
2490
|
+
readonly required: readonly ["type", "apiBaseUrl"];
|
|
2491
|
+
}];
|
|
2492
|
+
readonly discriminator: {
|
|
2493
|
+
readonly propertyName: "type";
|
|
2494
|
+
};
|
|
2495
|
+
};
|
|
2496
|
+
};
|
|
2497
|
+
};
|
|
2498
|
+
};
|
|
2499
|
+
readonly i18n: {
|
|
2500
|
+
readonly type: "object";
|
|
2501
|
+
readonly properties: {
|
|
2502
|
+
readonly defaultLocale: {
|
|
2503
|
+
readonly type: "string";
|
|
2504
|
+
};
|
|
2505
|
+
readonly locales: {
|
|
2506
|
+
readonly type: "array";
|
|
2507
|
+
readonly items: {
|
|
2508
|
+
readonly type: "object";
|
|
2509
|
+
readonly properties: {
|
|
2510
|
+
readonly code: {
|
|
2511
|
+
readonly type: "string";
|
|
2512
|
+
};
|
|
2513
|
+
readonly name: {
|
|
2514
|
+
readonly type: "string";
|
|
2515
|
+
};
|
|
2516
|
+
};
|
|
2517
|
+
readonly required: readonly ["code"];
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2521
|
+
readonly additionalProperties: false;
|
|
2522
|
+
readonly required: readonly ["defaultLocale", "locales"];
|
|
2523
|
+
};
|
|
2524
|
+
readonly metadata: {
|
|
2525
|
+
readonly type: "object";
|
|
2526
|
+
readonly additionalProperties: true;
|
|
2527
|
+
};
|
|
2528
|
+
};
|
|
2529
|
+
readonly default: {};
|
|
2530
|
+
readonly required: readonly ["redirects"];
|
|
2531
|
+
readonly type: "object";
|
|
2532
|
+
readonly additionalProperties: true;
|
|
2533
|
+
};
|