@redocly/config 0.34.0 → 0.35.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/lib/root-config-schema.d.ts +105 -0
- package/lib/root-config-schema.js +29 -1
- package/lib/types/api-functions-types.d.ts +9 -8
- package/lib-esm/root-config-schema.d.ts +105 -0
- package/lib-esm/root-config-schema.js +29 -1
- package/lib-esm/types/api-functions-types.d.ts +9 -8
- package/package.json +1 -1
|
@@ -17304,6 +17304,45 @@ export declare const redoclyConfigSchema: {
|
|
|
17304
17304
|
};
|
|
17305
17305
|
};
|
|
17306
17306
|
};
|
|
17307
|
+
readonly mcp: {
|
|
17308
|
+
readonly type: "object";
|
|
17309
|
+
readonly properties: {
|
|
17310
|
+
readonly hide: {
|
|
17311
|
+
readonly type: "boolean";
|
|
17312
|
+
readonly default: false;
|
|
17313
|
+
};
|
|
17314
|
+
readonly docs: {
|
|
17315
|
+
readonly type: "object";
|
|
17316
|
+
readonly properties: {
|
|
17317
|
+
readonly hide: {
|
|
17318
|
+
readonly type: "boolean";
|
|
17319
|
+
readonly default: false;
|
|
17320
|
+
};
|
|
17321
|
+
readonly name: {
|
|
17322
|
+
readonly type: "string";
|
|
17323
|
+
readonly default: "Docs MCP server";
|
|
17324
|
+
};
|
|
17325
|
+
readonly ignore: {
|
|
17326
|
+
readonly type: "array";
|
|
17327
|
+
readonly items: {
|
|
17328
|
+
readonly type: "string";
|
|
17329
|
+
};
|
|
17330
|
+
readonly default: readonly [];
|
|
17331
|
+
};
|
|
17332
|
+
};
|
|
17333
|
+
readonly additionalProperties: false;
|
|
17334
|
+
};
|
|
17335
|
+
};
|
|
17336
|
+
readonly additionalProperties: false;
|
|
17337
|
+
readonly default: {
|
|
17338
|
+
readonly hide: false;
|
|
17339
|
+
readonly docs: {
|
|
17340
|
+
readonly hide: false;
|
|
17341
|
+
readonly name: "MCP server";
|
|
17342
|
+
readonly ignore: readonly [];
|
|
17343
|
+
};
|
|
17344
|
+
};
|
|
17345
|
+
};
|
|
17307
17346
|
readonly preprocessors: {
|
|
17308
17347
|
readonly type: "object";
|
|
17309
17348
|
readonly additionalProperties: true;
|
|
@@ -30486,6 +30525,33 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
30486
30525
|
type: "object";
|
|
30487
30526
|
required: never[];
|
|
30488
30527
|
};
|
|
30528
|
+
mcp: {
|
|
30529
|
+
properties: {
|
|
30530
|
+
hide: {
|
|
30531
|
+
type: "boolean";
|
|
30532
|
+
};
|
|
30533
|
+
docs: {
|
|
30534
|
+
properties: {
|
|
30535
|
+
name: {
|
|
30536
|
+
type: "string";
|
|
30537
|
+
};
|
|
30538
|
+
ignore: {
|
|
30539
|
+
items: {
|
|
30540
|
+
type: "string";
|
|
30541
|
+
};
|
|
30542
|
+
type: "array";
|
|
30543
|
+
};
|
|
30544
|
+
hide: {
|
|
30545
|
+
type: "boolean";
|
|
30546
|
+
};
|
|
30547
|
+
};
|
|
30548
|
+
additionalProperties: false;
|
|
30549
|
+
type: "object";
|
|
30550
|
+
};
|
|
30551
|
+
};
|
|
30552
|
+
additionalProperties: false;
|
|
30553
|
+
type: "object";
|
|
30554
|
+
};
|
|
30489
30555
|
preprocessors: {
|
|
30490
30556
|
additionalProperties: true;
|
|
30491
30557
|
type: "object";
|
|
@@ -45461,6 +45527,45 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
45461
45527
|
};
|
|
45462
45528
|
};
|
|
45463
45529
|
};
|
|
45530
|
+
readonly mcp: {
|
|
45531
|
+
readonly type: "object";
|
|
45532
|
+
readonly properties: {
|
|
45533
|
+
readonly hide: {
|
|
45534
|
+
readonly type: "boolean";
|
|
45535
|
+
readonly default: false;
|
|
45536
|
+
};
|
|
45537
|
+
readonly docs: {
|
|
45538
|
+
readonly type: "object";
|
|
45539
|
+
readonly properties: {
|
|
45540
|
+
readonly hide: {
|
|
45541
|
+
readonly type: "boolean";
|
|
45542
|
+
readonly default: false;
|
|
45543
|
+
};
|
|
45544
|
+
readonly name: {
|
|
45545
|
+
readonly type: "string";
|
|
45546
|
+
readonly default: "Docs MCP server";
|
|
45547
|
+
};
|
|
45548
|
+
readonly ignore: {
|
|
45549
|
+
readonly type: "array";
|
|
45550
|
+
readonly items: {
|
|
45551
|
+
readonly type: "string";
|
|
45552
|
+
};
|
|
45553
|
+
readonly default: readonly [];
|
|
45554
|
+
};
|
|
45555
|
+
};
|
|
45556
|
+
readonly additionalProperties: false;
|
|
45557
|
+
};
|
|
45558
|
+
};
|
|
45559
|
+
readonly additionalProperties: false;
|
|
45560
|
+
readonly default: {
|
|
45561
|
+
readonly hide: false;
|
|
45562
|
+
readonly docs: {
|
|
45563
|
+
readonly hide: false;
|
|
45564
|
+
readonly name: "MCP server";
|
|
45565
|
+
readonly ignore: readonly [];
|
|
45566
|
+
};
|
|
45567
|
+
};
|
|
45568
|
+
};
|
|
45464
45569
|
readonly preprocessors: {
|
|
45465
45570
|
readonly type: "object";
|
|
45466
45571
|
readonly additionalProperties: true;
|
|
@@ -377,6 +377,34 @@ const responseHeaderSchema = {
|
|
|
377
377
|
additionalProperties: false,
|
|
378
378
|
required: ['name', 'value'],
|
|
379
379
|
};
|
|
380
|
+
const mcpConfigSchema = {
|
|
381
|
+
type: 'object',
|
|
382
|
+
properties: {
|
|
383
|
+
hide: { type: 'boolean', default: false },
|
|
384
|
+
docs: {
|
|
385
|
+
type: 'object',
|
|
386
|
+
properties: {
|
|
387
|
+
hide: { type: 'boolean', default: false },
|
|
388
|
+
name: { type: 'string', default: 'Docs MCP server' },
|
|
389
|
+
ignore: {
|
|
390
|
+
type: 'array',
|
|
391
|
+
items: { type: 'string' },
|
|
392
|
+
default: [],
|
|
393
|
+
},
|
|
394
|
+
},
|
|
395
|
+
additionalProperties: false,
|
|
396
|
+
},
|
|
397
|
+
},
|
|
398
|
+
additionalProperties: false,
|
|
399
|
+
default: {
|
|
400
|
+
hide: false,
|
|
401
|
+
docs: {
|
|
402
|
+
hide: false,
|
|
403
|
+
name: 'MCP server',
|
|
404
|
+
ignore: [],
|
|
405
|
+
},
|
|
406
|
+
},
|
|
407
|
+
};
|
|
380
408
|
exports.redoclyConfigSchema = {
|
|
381
409
|
type: 'object',
|
|
382
410
|
properties: Object.assign(Object.assign(Object.assign(Object.assign({
|
|
@@ -414,7 +442,7 @@ exports.redoclyConfigSchema = {
|
|
|
414
442
|
/**
|
|
415
443
|
* @deprecated Should use `catalogClassic` instead
|
|
416
444
|
*/
|
|
417
|
-
catalog: ex_theme_config_schemas_1.catalogsConfigSchema, entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, scorecard: ex_theme_config_schemas_1.scorecardConfigSchema }),
|
|
445
|
+
catalog: ex_theme_config_schemas_1.catalogsConfigSchema, entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, mcp: mcpConfigSchema }),
|
|
418
446
|
default: { redirects: {}, seo: exports.seoConfigSchema.default },
|
|
419
447
|
additionalProperties: true,
|
|
420
448
|
};
|
|
@@ -16,15 +16,16 @@ export type ApiFunctionsContextMethods = {
|
|
|
16
16
|
text: (data: string, code?: number) => Response;
|
|
17
17
|
redirect: (url: string, code?: number) => Response;
|
|
18
18
|
};
|
|
19
|
+
export type ApiFunctionsUser = {
|
|
20
|
+
teams: string[];
|
|
21
|
+
claims: Record<string, any>;
|
|
22
|
+
email: string | undefined;
|
|
23
|
+
idpAccessToken: string | undefined;
|
|
24
|
+
idpId: string | undefined;
|
|
25
|
+
isAuthenticated: boolean;
|
|
26
|
+
};
|
|
19
27
|
export type ApiFunctionsContext = {
|
|
20
|
-
user:
|
|
21
|
-
teams: string[];
|
|
22
|
-
claims: Record<string, any>;
|
|
23
|
-
email: string | undefined;
|
|
24
|
-
idpAccessToken: string | undefined;
|
|
25
|
-
idpId: string | undefined;
|
|
26
|
-
isAuthenticated: boolean;
|
|
27
|
-
};
|
|
28
|
+
user: ApiFunctionsUser;
|
|
28
29
|
config: RedoclyConfig;
|
|
29
30
|
params: Record<string, string | string[]>;
|
|
30
31
|
query: Record<string, string | string[]>;
|
|
@@ -17304,6 +17304,45 @@ export declare const redoclyConfigSchema: {
|
|
|
17304
17304
|
};
|
|
17305
17305
|
};
|
|
17306
17306
|
};
|
|
17307
|
+
readonly mcp: {
|
|
17308
|
+
readonly type: "object";
|
|
17309
|
+
readonly properties: {
|
|
17310
|
+
readonly hide: {
|
|
17311
|
+
readonly type: "boolean";
|
|
17312
|
+
readonly default: false;
|
|
17313
|
+
};
|
|
17314
|
+
readonly docs: {
|
|
17315
|
+
readonly type: "object";
|
|
17316
|
+
readonly properties: {
|
|
17317
|
+
readonly hide: {
|
|
17318
|
+
readonly type: "boolean";
|
|
17319
|
+
readonly default: false;
|
|
17320
|
+
};
|
|
17321
|
+
readonly name: {
|
|
17322
|
+
readonly type: "string";
|
|
17323
|
+
readonly default: "Docs MCP server";
|
|
17324
|
+
};
|
|
17325
|
+
readonly ignore: {
|
|
17326
|
+
readonly type: "array";
|
|
17327
|
+
readonly items: {
|
|
17328
|
+
readonly type: "string";
|
|
17329
|
+
};
|
|
17330
|
+
readonly default: readonly [];
|
|
17331
|
+
};
|
|
17332
|
+
};
|
|
17333
|
+
readonly additionalProperties: false;
|
|
17334
|
+
};
|
|
17335
|
+
};
|
|
17336
|
+
readonly additionalProperties: false;
|
|
17337
|
+
readonly default: {
|
|
17338
|
+
readonly hide: false;
|
|
17339
|
+
readonly docs: {
|
|
17340
|
+
readonly hide: false;
|
|
17341
|
+
readonly name: "MCP server";
|
|
17342
|
+
readonly ignore: readonly [];
|
|
17343
|
+
};
|
|
17344
|
+
};
|
|
17345
|
+
};
|
|
17307
17346
|
readonly preprocessors: {
|
|
17308
17347
|
readonly type: "object";
|
|
17309
17348
|
readonly additionalProperties: true;
|
|
@@ -30486,6 +30525,33 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
30486
30525
|
type: "object";
|
|
30487
30526
|
required: never[];
|
|
30488
30527
|
};
|
|
30528
|
+
mcp: {
|
|
30529
|
+
properties: {
|
|
30530
|
+
hide: {
|
|
30531
|
+
type: "boolean";
|
|
30532
|
+
};
|
|
30533
|
+
docs: {
|
|
30534
|
+
properties: {
|
|
30535
|
+
name: {
|
|
30536
|
+
type: "string";
|
|
30537
|
+
};
|
|
30538
|
+
ignore: {
|
|
30539
|
+
items: {
|
|
30540
|
+
type: "string";
|
|
30541
|
+
};
|
|
30542
|
+
type: "array";
|
|
30543
|
+
};
|
|
30544
|
+
hide: {
|
|
30545
|
+
type: "boolean";
|
|
30546
|
+
};
|
|
30547
|
+
};
|
|
30548
|
+
additionalProperties: false;
|
|
30549
|
+
type: "object";
|
|
30550
|
+
};
|
|
30551
|
+
};
|
|
30552
|
+
additionalProperties: false;
|
|
30553
|
+
type: "object";
|
|
30554
|
+
};
|
|
30489
30555
|
preprocessors: {
|
|
30490
30556
|
additionalProperties: true;
|
|
30491
30557
|
type: "object";
|
|
@@ -45461,6 +45527,45 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
45461
45527
|
};
|
|
45462
45528
|
};
|
|
45463
45529
|
};
|
|
45530
|
+
readonly mcp: {
|
|
45531
|
+
readonly type: "object";
|
|
45532
|
+
readonly properties: {
|
|
45533
|
+
readonly hide: {
|
|
45534
|
+
readonly type: "boolean";
|
|
45535
|
+
readonly default: false;
|
|
45536
|
+
};
|
|
45537
|
+
readonly docs: {
|
|
45538
|
+
readonly type: "object";
|
|
45539
|
+
readonly properties: {
|
|
45540
|
+
readonly hide: {
|
|
45541
|
+
readonly type: "boolean";
|
|
45542
|
+
readonly default: false;
|
|
45543
|
+
};
|
|
45544
|
+
readonly name: {
|
|
45545
|
+
readonly type: "string";
|
|
45546
|
+
readonly default: "Docs MCP server";
|
|
45547
|
+
};
|
|
45548
|
+
readonly ignore: {
|
|
45549
|
+
readonly type: "array";
|
|
45550
|
+
readonly items: {
|
|
45551
|
+
readonly type: "string";
|
|
45552
|
+
};
|
|
45553
|
+
readonly default: readonly [];
|
|
45554
|
+
};
|
|
45555
|
+
};
|
|
45556
|
+
readonly additionalProperties: false;
|
|
45557
|
+
};
|
|
45558
|
+
};
|
|
45559
|
+
readonly additionalProperties: false;
|
|
45560
|
+
readonly default: {
|
|
45561
|
+
readonly hide: false;
|
|
45562
|
+
readonly docs: {
|
|
45563
|
+
readonly hide: false;
|
|
45564
|
+
readonly name: "MCP server";
|
|
45565
|
+
readonly ignore: readonly [];
|
|
45566
|
+
};
|
|
45567
|
+
};
|
|
45568
|
+
};
|
|
45464
45569
|
readonly preprocessors: {
|
|
45465
45570
|
readonly type: "object";
|
|
45466
45571
|
readonly additionalProperties: true;
|
|
@@ -374,6 +374,34 @@ const responseHeaderSchema = {
|
|
|
374
374
|
additionalProperties: false,
|
|
375
375
|
required: ['name', 'value'],
|
|
376
376
|
};
|
|
377
|
+
const mcpConfigSchema = {
|
|
378
|
+
type: 'object',
|
|
379
|
+
properties: {
|
|
380
|
+
hide: { type: 'boolean', default: false },
|
|
381
|
+
docs: {
|
|
382
|
+
type: 'object',
|
|
383
|
+
properties: {
|
|
384
|
+
hide: { type: 'boolean', default: false },
|
|
385
|
+
name: { type: 'string', default: 'Docs MCP server' },
|
|
386
|
+
ignore: {
|
|
387
|
+
type: 'array',
|
|
388
|
+
items: { type: 'string' },
|
|
389
|
+
default: [],
|
|
390
|
+
},
|
|
391
|
+
},
|
|
392
|
+
additionalProperties: false,
|
|
393
|
+
},
|
|
394
|
+
},
|
|
395
|
+
additionalProperties: false,
|
|
396
|
+
default: {
|
|
397
|
+
hide: false,
|
|
398
|
+
docs: {
|
|
399
|
+
hide: false,
|
|
400
|
+
name: 'MCP server',
|
|
401
|
+
ignore: [],
|
|
402
|
+
},
|
|
403
|
+
},
|
|
404
|
+
};
|
|
377
405
|
export const redoclyConfigSchema = {
|
|
378
406
|
type: 'object',
|
|
379
407
|
properties: Object.assign(Object.assign(Object.assign(Object.assign({
|
|
@@ -411,7 +439,7 @@ export const redoclyConfigSchema = {
|
|
|
411
439
|
/**
|
|
412
440
|
* @deprecated Should use `catalogClassic` instead
|
|
413
441
|
*/
|
|
414
|
-
catalog: catalogsConfigSchema, entitiesCatalog: entitiesCatalogConfigSchema, catalogClassic: catalogsConfigSchema, scorecard: scorecardConfigSchema }),
|
|
442
|
+
catalog: catalogsConfigSchema, entitiesCatalog: entitiesCatalogConfigSchema, catalogClassic: catalogsConfigSchema, scorecard: scorecardConfigSchema, mcp: mcpConfigSchema }),
|
|
415
443
|
default: { redirects: {}, seo: seoConfigSchema.default },
|
|
416
444
|
additionalProperties: true,
|
|
417
445
|
};
|
|
@@ -16,15 +16,16 @@ export type ApiFunctionsContextMethods = {
|
|
|
16
16
|
text: (data: string, code?: number) => Response;
|
|
17
17
|
redirect: (url: string, code?: number) => Response;
|
|
18
18
|
};
|
|
19
|
+
export type ApiFunctionsUser = {
|
|
20
|
+
teams: string[];
|
|
21
|
+
claims: Record<string, any>;
|
|
22
|
+
email: string | undefined;
|
|
23
|
+
idpAccessToken: string | undefined;
|
|
24
|
+
idpId: string | undefined;
|
|
25
|
+
isAuthenticated: boolean;
|
|
26
|
+
};
|
|
19
27
|
export type ApiFunctionsContext = {
|
|
20
|
-
user:
|
|
21
|
-
teams: string[];
|
|
22
|
-
claims: Record<string, any>;
|
|
23
|
-
email: string | undefined;
|
|
24
|
-
idpAccessToken: string | undefined;
|
|
25
|
-
idpId: string | undefined;
|
|
26
|
-
isAuthenticated: boolean;
|
|
27
|
-
};
|
|
28
|
+
user: ApiFunctionsUser;
|
|
28
29
|
config: RedoclyConfig;
|
|
29
30
|
params: Record<string, string | string[]>;
|
|
30
31
|
query: Record<string, string | string[]>;
|