@redocly/config 0.36.1 → 0.37.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/default-theme-config-schema.d.ts +3 -3
- package/lib/entities-catalog-entity-file-schema.d.ts +670 -409
- package/lib/entities-catalog-entity-file-schema.js +36 -26
- package/lib/ex-theme-config-schemas.d.ts +3 -3
- package/lib/ex-theme-config-schemas.js +3 -3
- package/lib/root-config-schema.d.ts +14 -14
- package/lib/types/portal-shared-types.d.ts +2 -2
- package/lib-esm/default-theme-config-schema.d.ts +3 -3
- package/lib-esm/entities-catalog-entity-file-schema.d.ts +670 -409
- package/lib-esm/entities-catalog-entity-file-schema.js +35 -25
- package/lib-esm/ex-theme-config-schemas.d.ts +3 -3
- package/lib-esm/ex-theme-config-schemas.js +3 -3
- package/lib-esm/root-config-schema.d.ts +14 -14
- package/lib-esm/types/portal-shared-types.d.ts +2 -2
- package/package.json +2 -2
|
@@ -73,7 +73,6 @@ export const dataSchemaMetadataSchema = {
|
|
|
73
73
|
description: 'SDL of the data structure',
|
|
74
74
|
},
|
|
75
75
|
},
|
|
76
|
-
anyOf: [{ required: ['schema'] }, { required: ['sdl'] }],
|
|
77
76
|
required: ['specType'],
|
|
78
77
|
additionalProperties: true,
|
|
79
78
|
};
|
|
@@ -185,18 +184,22 @@ export const entityBaseProperties = {
|
|
|
185
184
|
minLength: 2,
|
|
186
185
|
maxLength: 150,
|
|
187
186
|
},
|
|
187
|
+
type: {
|
|
188
|
+
type: 'string',
|
|
189
|
+
enum: ['user', 'data-schema', 'api-operation', 'api-description', 'service', 'domain', 'team'],
|
|
190
|
+
},
|
|
188
191
|
title: {
|
|
189
192
|
type: 'string',
|
|
190
193
|
minLength: 2,
|
|
191
194
|
maxLength: 200,
|
|
192
195
|
},
|
|
193
196
|
summary: {
|
|
194
|
-
type:
|
|
197
|
+
type: 'string',
|
|
195
198
|
minLength: 1,
|
|
196
199
|
maxLength: 500,
|
|
197
200
|
},
|
|
198
201
|
tags: {
|
|
199
|
-
type:
|
|
202
|
+
type: 'array',
|
|
200
203
|
items: {
|
|
201
204
|
type: 'string',
|
|
202
205
|
minLength: 1,
|
|
@@ -204,31 +207,23 @@ export const entityBaseProperties = {
|
|
|
204
207
|
},
|
|
205
208
|
},
|
|
206
209
|
git: {
|
|
207
|
-
type:
|
|
210
|
+
type: 'array',
|
|
208
211
|
items: {
|
|
209
212
|
type: 'string',
|
|
210
213
|
},
|
|
211
214
|
},
|
|
212
|
-
contact:
|
|
213
|
-
anyOf: [{ type: 'null' }, entityContactFileSchema],
|
|
214
|
-
},
|
|
215
|
+
contact: entityContactFileSchema,
|
|
215
216
|
links: {
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
{
|
|
219
|
-
type: 'array',
|
|
220
|
-
items: entityLinkFileSchema,
|
|
221
|
-
},
|
|
222
|
-
],
|
|
217
|
+
type: 'array',
|
|
218
|
+
items: entityLinkFileSchema,
|
|
223
219
|
},
|
|
224
220
|
relations: {
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
],
|
|
221
|
+
type: 'array',
|
|
222
|
+
items: entityRelationFileSchema,
|
|
223
|
+
},
|
|
224
|
+
metadata: {
|
|
225
|
+
type: 'object',
|
|
226
|
+
additionalProperties: true,
|
|
232
227
|
},
|
|
233
228
|
};
|
|
234
229
|
export const entityFileSchema = {
|
|
@@ -263,13 +258,28 @@ export const entityFileSchema = {
|
|
|
263
258
|
},
|
|
264
259
|
{
|
|
265
260
|
type: 'object',
|
|
266
|
-
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: {
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
261
|
+
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'service' } }),
|
|
262
|
+
required: ['key', 'title', 'type'],
|
|
263
|
+
additionalProperties: false,
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
type: 'object',
|
|
267
|
+
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'domain' } }),
|
|
268
|
+
required: ['key', 'title', 'type'],
|
|
269
|
+
additionalProperties: false,
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
type: 'object',
|
|
273
|
+
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'team' } }),
|
|
270
274
|
required: ['key', 'title', 'type'],
|
|
271
275
|
additionalProperties: false,
|
|
272
276
|
},
|
|
273
277
|
],
|
|
274
278
|
};
|
|
279
|
+
export const entityFileDefaultSchema = {
|
|
280
|
+
type: 'object',
|
|
281
|
+
properties: Object.assign({}, entityBaseProperties),
|
|
282
|
+
required: ['key', 'title', 'type'],
|
|
283
|
+
additionalProperties: false,
|
|
284
|
+
};
|
|
275
285
|
//# sourceMappingURL=entities-catalog-entity-file-schema.js.map
|
|
@@ -1022,7 +1022,7 @@ export declare const aiAssistantSchema: {
|
|
|
1022
1022
|
readonly inputIcon: {
|
|
1023
1023
|
readonly type: "string";
|
|
1024
1024
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
1025
|
-
readonly default: "
|
|
1025
|
+
readonly default: "sparkles";
|
|
1026
1026
|
};
|
|
1027
1027
|
};
|
|
1028
1028
|
readonly additionalProperties: false;
|
|
@@ -1085,9 +1085,9 @@ export declare const navigationConfigSchema: {
|
|
|
1085
1085
|
readonly type: "array";
|
|
1086
1086
|
readonly items: {
|
|
1087
1087
|
readonly type: "string";
|
|
1088
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
1088
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
1089
1089
|
};
|
|
1090
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
1090
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
1091
1091
|
};
|
|
1092
1092
|
readonly hide: {
|
|
1093
1093
|
readonly type: "boolean";
|
|
@@ -254,7 +254,7 @@ export const aiAssistantSchema = {
|
|
|
254
254
|
inputIcon: {
|
|
255
255
|
type: 'string',
|
|
256
256
|
enum: ['chat', 'sparkles', 'redocly'],
|
|
257
|
-
default: '
|
|
257
|
+
default: 'sparkles',
|
|
258
258
|
},
|
|
259
259
|
},
|
|
260
260
|
additionalProperties: false,
|
|
@@ -277,9 +277,9 @@ const navigationActionsConfigSchema = {
|
|
|
277
277
|
type: 'array',
|
|
278
278
|
items: {
|
|
279
279
|
type: 'string',
|
|
280
|
-
enum: ['copy', 'view', 'chatgpt', 'claude'],
|
|
280
|
+
enum: ['copy', 'view', 'chatgpt', 'claude', 'docs-mcp-cursor', 'docs-mcp-vscode'],
|
|
281
281
|
},
|
|
282
|
-
default: ['copy', 'view', 'chatgpt', 'claude'],
|
|
282
|
+
default: ['copy', 'view', 'chatgpt', 'claude', 'docs-mcp-cursor', 'docs-mcp-vscode'],
|
|
283
283
|
} }),
|
|
284
284
|
additionalProperties: false,
|
|
285
285
|
};
|
|
@@ -7342,7 +7342,7 @@ export declare const redoclyConfigSchema: {
|
|
|
7342
7342
|
readonly inputIcon: {
|
|
7343
7343
|
readonly type: "string";
|
|
7344
7344
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
7345
|
-
readonly default: "
|
|
7345
|
+
readonly default: "sparkles";
|
|
7346
7346
|
};
|
|
7347
7347
|
};
|
|
7348
7348
|
readonly additionalProperties: false;
|
|
@@ -7405,9 +7405,9 @@ export declare const redoclyConfigSchema: {
|
|
|
7405
7405
|
readonly type: "array";
|
|
7406
7406
|
readonly items: {
|
|
7407
7407
|
readonly type: "string";
|
|
7408
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
7408
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
7409
7409
|
};
|
|
7410
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
7410
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
7411
7411
|
};
|
|
7412
7412
|
readonly hide: {
|
|
7413
7413
|
readonly type: "boolean";
|
|
@@ -12987,7 +12987,7 @@ export declare const redoclyConfigSchema: {
|
|
|
12987
12987
|
readonly inputIcon: {
|
|
12988
12988
|
readonly type: "string";
|
|
12989
12989
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
12990
|
-
readonly default: "
|
|
12990
|
+
readonly default: "sparkles";
|
|
12991
12991
|
};
|
|
12992
12992
|
};
|
|
12993
12993
|
readonly additionalProperties: false;
|
|
@@ -13050,9 +13050,9 @@ export declare const redoclyConfigSchema: {
|
|
|
13050
13050
|
readonly type: "array";
|
|
13051
13051
|
readonly items: {
|
|
13052
13052
|
readonly type: "string";
|
|
13053
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
13053
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
13054
13054
|
};
|
|
13055
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
13055
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
13056
13056
|
};
|
|
13057
13057
|
readonly hide: {
|
|
13058
13058
|
readonly type: "boolean";
|
|
@@ -25141,7 +25141,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
25141
25141
|
properties: {
|
|
25142
25142
|
items: {
|
|
25143
25143
|
items: {
|
|
25144
|
-
enum: ("copy" | "view" | "chatgpt" | "claude")[];
|
|
25144
|
+
enum: ("copy" | "view" | "chatgpt" | "claude" | "docs-mcp-cursor" | "docs-mcp-vscode")[];
|
|
25145
25145
|
type: "string";
|
|
25146
25146
|
};
|
|
25147
25147
|
type: "array";
|
|
@@ -30166,7 +30166,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
30166
30166
|
properties: {
|
|
30167
30167
|
items: {
|
|
30168
30168
|
items: {
|
|
30169
|
-
enum: ("copy" | "view" | "chatgpt" | "claude")[];
|
|
30169
|
+
enum: ("copy" | "view" | "chatgpt" | "claude" | "docs-mcp-cursor" | "docs-mcp-vscode")[];
|
|
30170
30170
|
type: "string";
|
|
30171
30171
|
};
|
|
30172
30172
|
type: "array";
|
|
@@ -35837,7 +35837,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35837
35837
|
readonly inputIcon: {
|
|
35838
35838
|
readonly type: "string";
|
|
35839
35839
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
35840
|
-
readonly default: "
|
|
35840
|
+
readonly default: "sparkles";
|
|
35841
35841
|
};
|
|
35842
35842
|
};
|
|
35843
35843
|
readonly additionalProperties: false;
|
|
@@ -35900,9 +35900,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
35900
35900
|
readonly type: "array";
|
|
35901
35901
|
readonly items: {
|
|
35902
35902
|
readonly type: "string";
|
|
35903
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
35903
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
35904
35904
|
};
|
|
35905
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
35905
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
35906
35906
|
};
|
|
35907
35907
|
readonly hide: {
|
|
35908
35908
|
readonly type: "boolean";
|
|
@@ -41482,7 +41482,7 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
41482
41482
|
readonly inputIcon: {
|
|
41483
41483
|
readonly type: "string";
|
|
41484
41484
|
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
41485
|
-
readonly default: "
|
|
41485
|
+
readonly default: "sparkles";
|
|
41486
41486
|
};
|
|
41487
41487
|
};
|
|
41488
41488
|
readonly additionalProperties: false;
|
|
@@ -41545,9 +41545,9 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
41545
41545
|
readonly type: "array";
|
|
41546
41546
|
readonly items: {
|
|
41547
41547
|
readonly type: "string";
|
|
41548
|
-
readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
|
|
41548
|
+
readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
41549
41549
|
};
|
|
41550
|
-
readonly default: readonly ["copy", "view", "chatgpt", "claude"];
|
|
41550
|
+
readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
|
|
41551
41551
|
};
|
|
41552
41552
|
readonly hide: {
|
|
41553
41553
|
readonly type: "boolean";
|
|
@@ -3,7 +3,7 @@ import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../c
|
|
|
3
3
|
import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
|
|
4
4
|
import type { CatalogEntityConfig } from './catalog-entity-types';
|
|
5
5
|
export * from './code-walkthrough-types';
|
|
6
|
-
export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'entitiesCatalog'> & {
|
|
6
|
+
export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'entitiesCatalog' | 'mcp'> & {
|
|
7
7
|
auth?: {
|
|
8
8
|
idpsInfo?: {
|
|
9
9
|
idpId: string;
|
|
@@ -170,7 +170,7 @@ export type PageProps = {
|
|
|
170
170
|
frontmatter?: Omit<PageProps, 'frontmatter'> & {
|
|
171
171
|
settings?: any;
|
|
172
172
|
} & Partial<UiAccessibleConfig> & {
|
|
173
|
-
navigation?: {
|
|
173
|
+
navigation?: Partial<UiAccessibleConfig['navigation']> & {
|
|
174
174
|
nextButton?: {
|
|
175
175
|
link?: string;
|
|
176
176
|
label?: string;
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/config",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.37.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"module": "./lib-esm/index.js",
|
|
7
7
|
"types": "./lib/index.d.ts",
|
|
8
8
|
"devDependencies": {
|
|
9
9
|
"@markdoc/markdoc": "0.5.2",
|
|
10
|
-
"@types/node": "22.
|
|
10
|
+
"@types/node": "22.18.13",
|
|
11
11
|
"@types/react": "^19.1.4",
|
|
12
12
|
"react-router-dom": "^6.21.1",
|
|
13
13
|
"rimraf": "5.0.7",
|