@redocly/config 0.35.1 → 0.36.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/common.d.ts +16 -166
- package/lib/common.js +60 -19
- package/lib/default-theme-config-schema.d.ts +43 -0
- package/lib/default-theme-config-schema.js +1 -0
- package/lib/entities-catalog-config-schema.d.ts +4 -0
- package/lib/entities-catalog-config-schema.js +1 -0
- package/lib/ex-theme-config-schemas.d.ts +42 -0
- package/lib/ex-theme-config-schemas.js +44 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/reunite-config-schema.d.ts +12 -0
- package/lib/reunite-config-schema.js +9 -0
- package/lib/root-config-schema.d.ts +2668 -2574
- package/lib/root-config-schema.js +1 -1
- package/lib/types/catalog-entity-types.d.ts +1 -0
- package/lib/types/portal-shared-types.d.ts +1 -1
- package/lib-esm/common.d.ts +16 -166
- package/lib-esm/common.js +59 -18
- package/lib-esm/default-theme-config-schema.d.ts +43 -0
- package/lib-esm/default-theme-config-schema.js +2 -1
- package/lib-esm/entities-catalog-config-schema.d.ts +4 -0
- package/lib-esm/entities-catalog-config-schema.js +1 -0
- package/lib-esm/ex-theme-config-schemas.d.ts +42 -0
- package/lib-esm/ex-theme-config-schemas.js +43 -0
- package/lib-esm/index.d.ts +1 -0
- package/lib-esm/index.js +1 -0
- package/lib-esm/reunite-config-schema.d.ts +12 -0
- package/lib-esm/reunite-config-schema.js +9 -0
- package/lib-esm/root-config-schema.d.ts +2668 -2574
- package/lib-esm/root-config-schema.js +2 -2
- package/lib-esm/types/catalog-entity-types.d.ts +1 -0
- package/lib-esm/types/portal-shared-types.d.ts +1 -1
- package/package.json +2 -2
package/lib/common.d.ts
CHANGED
|
@@ -8,171 +8,21 @@ export declare const rulesSchema: {
|
|
|
8
8
|
}];
|
|
9
9
|
};
|
|
10
10
|
};
|
|
11
|
-
export declare const
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
}];
|
|
20
|
-
};
|
|
21
|
-
};
|
|
22
|
-
readonly oas2Rules: {
|
|
23
|
-
readonly type: "object";
|
|
24
|
-
readonly additionalProperties: {
|
|
25
|
-
readonly oneOf: readonly [{
|
|
26
|
-
readonly type: "string";
|
|
27
|
-
}, {
|
|
28
|
-
readonly type: "object";
|
|
29
|
-
}];
|
|
30
|
-
};
|
|
31
|
-
};
|
|
32
|
-
readonly oas3_0Rules: {
|
|
33
|
-
readonly type: "object";
|
|
34
|
-
readonly additionalProperties: {
|
|
35
|
-
readonly oneOf: readonly [{
|
|
36
|
-
readonly type: "string";
|
|
37
|
-
}, {
|
|
38
|
-
readonly type: "object";
|
|
39
|
-
}];
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
readonly oas3_1Rules: {
|
|
43
|
-
readonly type: "object";
|
|
44
|
-
readonly additionalProperties: {
|
|
45
|
-
readonly oneOf: readonly [{
|
|
46
|
-
readonly type: "string";
|
|
47
|
-
}, {
|
|
48
|
-
readonly type: "object";
|
|
49
|
-
}];
|
|
50
|
-
};
|
|
51
|
-
};
|
|
52
|
-
readonly oas3_2Rules: {
|
|
53
|
-
readonly type: "object";
|
|
54
|
-
readonly additionalProperties: {
|
|
55
|
-
readonly oneOf: readonly [{
|
|
56
|
-
readonly type: "string";
|
|
57
|
-
}, {
|
|
58
|
-
readonly type: "object";
|
|
59
|
-
}];
|
|
60
|
-
};
|
|
61
|
-
};
|
|
62
|
-
readonly async2Rules: {
|
|
63
|
-
readonly type: "object";
|
|
64
|
-
readonly additionalProperties: {
|
|
65
|
-
readonly oneOf: readonly [{
|
|
66
|
-
readonly type: "string";
|
|
67
|
-
}, {
|
|
68
|
-
readonly type: "object";
|
|
69
|
-
}];
|
|
70
|
-
};
|
|
71
|
-
};
|
|
72
|
-
readonly async3Rules: {
|
|
73
|
-
readonly type: "object";
|
|
74
|
-
readonly additionalProperties: {
|
|
75
|
-
readonly oneOf: readonly [{
|
|
76
|
-
readonly type: "string";
|
|
77
|
-
}, {
|
|
78
|
-
readonly type: "object";
|
|
79
|
-
}];
|
|
80
|
-
};
|
|
81
|
-
};
|
|
82
|
-
readonly arazzo1Rules: {
|
|
83
|
-
readonly type: "object";
|
|
84
|
-
readonly additionalProperties: {
|
|
85
|
-
readonly oneOf: readonly [{
|
|
86
|
-
readonly type: "string";
|
|
87
|
-
}, {
|
|
88
|
-
readonly type: "object";
|
|
89
|
-
}];
|
|
90
|
-
};
|
|
91
|
-
};
|
|
92
|
-
readonly overlay1Rules: {
|
|
93
|
-
readonly type: "object";
|
|
94
|
-
readonly additionalProperties: {
|
|
95
|
-
readonly oneOf: readonly [{
|
|
96
|
-
readonly type: "string";
|
|
97
|
-
}, {
|
|
98
|
-
readonly type: "object";
|
|
99
|
-
}];
|
|
100
|
-
};
|
|
101
|
-
};
|
|
102
|
-
};
|
|
103
|
-
export declare const preprocessorSchemas: {
|
|
104
|
-
readonly preprocessors: {
|
|
105
|
-
readonly type: "object";
|
|
106
|
-
readonly additionalProperties: true;
|
|
107
|
-
};
|
|
108
|
-
readonly oas2Preprocessors: {
|
|
109
|
-
readonly type: "object";
|
|
110
|
-
readonly additionalProperties: true;
|
|
111
|
-
};
|
|
112
|
-
readonly oas3_0Preprocessors: {
|
|
113
|
-
readonly type: "object";
|
|
114
|
-
readonly additionalProperties: true;
|
|
115
|
-
};
|
|
116
|
-
readonly oas3_1Preprocessors: {
|
|
117
|
-
readonly type: "object";
|
|
118
|
-
readonly additionalProperties: true;
|
|
119
|
-
};
|
|
120
|
-
readonly oas3_2Preprocessors: {
|
|
121
|
-
readonly type: "object";
|
|
122
|
-
readonly additionalProperties: true;
|
|
123
|
-
};
|
|
124
|
-
readonly async2Preprocessors: {
|
|
125
|
-
readonly type: "object";
|
|
126
|
-
readonly additionalProperties: true;
|
|
127
|
-
};
|
|
128
|
-
readonly async3Preprocessors: {
|
|
129
|
-
readonly type: "object";
|
|
130
|
-
readonly additionalProperties: true;
|
|
131
|
-
};
|
|
132
|
-
readonly arazzo1Preprocessors: {
|
|
133
|
-
readonly type: "object";
|
|
134
|
-
readonly additionalProperties: true;
|
|
135
|
-
};
|
|
136
|
-
readonly overlay1Preprocessors: {
|
|
137
|
-
readonly type: "object";
|
|
138
|
-
readonly additionalProperties: true;
|
|
139
|
-
};
|
|
11
|
+
export declare const ruleTypes: readonly ["rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "oas3_2Rules", "async2Rules", "async3Rules", "arazzo1Rules", "overlay1Rules"];
|
|
12
|
+
export type RuleTypes = (typeof ruleTypes)[number];
|
|
13
|
+
export declare const ruleSchemas: Record<RuleTypes, typeof rulesSchema>;
|
|
14
|
+
export declare const preprocessorTypes: readonly ["preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "oas3_2Preprocessors", "async2Preprocessors", "async3Preprocessors", "arazzo1Preprocessors", "overlay1Preprocessors"];
|
|
15
|
+
export type PreprocessorTypes = (typeof preprocessorTypes)[number];
|
|
16
|
+
declare const preprocessorSchema: {
|
|
17
|
+
readonly type: "object";
|
|
18
|
+
readonly additionalProperties: true;
|
|
140
19
|
};
|
|
141
|
-
export declare const
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
};
|
|
146
|
-
readonly oas2Decorators: {
|
|
147
|
-
readonly type: "object";
|
|
148
|
-
readonly additionalProperties: true;
|
|
149
|
-
};
|
|
150
|
-
readonly oas3_0Decorators: {
|
|
151
|
-
readonly type: "object";
|
|
152
|
-
readonly additionalProperties: true;
|
|
153
|
-
};
|
|
154
|
-
readonly oas3_1Decorators: {
|
|
155
|
-
readonly type: "object";
|
|
156
|
-
readonly additionalProperties: true;
|
|
157
|
-
};
|
|
158
|
-
readonly oas3_2Decorators: {
|
|
159
|
-
readonly type: "object";
|
|
160
|
-
readonly additionalProperties: true;
|
|
161
|
-
};
|
|
162
|
-
readonly async2Decorators: {
|
|
163
|
-
readonly type: "object";
|
|
164
|
-
readonly additionalProperties: true;
|
|
165
|
-
};
|
|
166
|
-
readonly async3Decorators: {
|
|
167
|
-
readonly type: "object";
|
|
168
|
-
readonly additionalProperties: true;
|
|
169
|
-
};
|
|
170
|
-
readonly arazzo1Decorators: {
|
|
171
|
-
readonly type: "object";
|
|
172
|
-
readonly additionalProperties: true;
|
|
173
|
-
};
|
|
174
|
-
readonly overlay1Decorators: {
|
|
175
|
-
readonly type: "object";
|
|
176
|
-
readonly additionalProperties: true;
|
|
177
|
-
};
|
|
20
|
+
export declare const preprocessorSchemas: Record<PreprocessorTypes, typeof preprocessorSchema>;
|
|
21
|
+
export declare const decoratorsSchema: {
|
|
22
|
+
readonly type: "object";
|
|
23
|
+
readonly additionalProperties: true;
|
|
178
24
|
};
|
|
25
|
+
export declare const decoratorTypes: readonly ["decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators", "oas3_2Decorators", "async2Decorators", "async3Decorators", "arazzo1Decorators", "overlay1Decorators"];
|
|
26
|
+
export type DecoratorTypes = (typeof decoratorTypes)[number];
|
|
27
|
+
export declare const decoratorsSchemas: Record<DecoratorTypes, typeof decoratorsSchema>;
|
|
28
|
+
export {};
|
package/lib/common.js
CHANGED
|
@@ -1,12 +1,23 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.decoratorsSchemas = exports.preprocessorSchemas = exports.ruleSchemas = exports.rulesSchema = void 0;
|
|
3
|
+
exports.decoratorsSchemas = exports.decoratorTypes = exports.decoratorsSchema = exports.preprocessorSchemas = exports.preprocessorTypes = exports.ruleSchemas = exports.ruleTypes = exports.rulesSchema = void 0;
|
|
4
4
|
exports.rulesSchema = {
|
|
5
5
|
type: 'object',
|
|
6
6
|
additionalProperties: {
|
|
7
7
|
oneOf: [{ type: 'string' }, { type: 'object' }],
|
|
8
8
|
},
|
|
9
9
|
};
|
|
10
|
+
exports.ruleTypes = [
|
|
11
|
+
'rules',
|
|
12
|
+
'oas2Rules',
|
|
13
|
+
'oas3_0Rules',
|
|
14
|
+
'oas3_1Rules',
|
|
15
|
+
'oas3_2Rules',
|
|
16
|
+
'async2Rules',
|
|
17
|
+
'async3Rules',
|
|
18
|
+
'arazzo1Rules',
|
|
19
|
+
'overlay1Rules',
|
|
20
|
+
];
|
|
10
21
|
exports.ruleSchemas = {
|
|
11
22
|
rules: exports.rulesSchema,
|
|
12
23
|
oas2Rules: exports.rulesSchema,
|
|
@@ -18,26 +29,56 @@ exports.ruleSchemas = {
|
|
|
18
29
|
arazzo1Rules: exports.rulesSchema,
|
|
19
30
|
overlay1Rules: exports.rulesSchema,
|
|
20
31
|
};
|
|
32
|
+
exports.preprocessorTypes = [
|
|
33
|
+
'preprocessors',
|
|
34
|
+
'oas2Preprocessors',
|
|
35
|
+
'oas3_0Preprocessors',
|
|
36
|
+
'oas3_1Preprocessors',
|
|
37
|
+
'oas3_2Preprocessors',
|
|
38
|
+
'async2Preprocessors',
|
|
39
|
+
'async3Preprocessors',
|
|
40
|
+
'arazzo1Preprocessors',
|
|
41
|
+
'overlay1Preprocessors',
|
|
42
|
+
];
|
|
43
|
+
const preprocessorSchema = {
|
|
44
|
+
type: 'object',
|
|
45
|
+
additionalProperties: true,
|
|
46
|
+
};
|
|
21
47
|
exports.preprocessorSchemas = {
|
|
22
|
-
preprocessors:
|
|
23
|
-
oas2Preprocessors:
|
|
24
|
-
oas3_0Preprocessors:
|
|
25
|
-
oas3_1Preprocessors:
|
|
26
|
-
oas3_2Preprocessors:
|
|
27
|
-
async2Preprocessors:
|
|
28
|
-
async3Preprocessors:
|
|
29
|
-
arazzo1Preprocessors:
|
|
30
|
-
overlay1Preprocessors:
|
|
48
|
+
preprocessors: preprocessorSchema,
|
|
49
|
+
oas2Preprocessors: preprocessorSchema,
|
|
50
|
+
oas3_0Preprocessors: preprocessorSchema,
|
|
51
|
+
oas3_1Preprocessors: preprocessorSchema,
|
|
52
|
+
oas3_2Preprocessors: preprocessorSchema,
|
|
53
|
+
async2Preprocessors: preprocessorSchema,
|
|
54
|
+
async3Preprocessors: preprocessorSchema,
|
|
55
|
+
arazzo1Preprocessors: preprocessorSchema,
|
|
56
|
+
overlay1Preprocessors: preprocessorSchema,
|
|
57
|
+
};
|
|
58
|
+
exports.decoratorsSchema = {
|
|
59
|
+
type: 'object',
|
|
60
|
+
additionalProperties: true,
|
|
31
61
|
};
|
|
62
|
+
exports.decoratorTypes = [
|
|
63
|
+
'decorators',
|
|
64
|
+
'oas2Decorators',
|
|
65
|
+
'oas3_0Decorators',
|
|
66
|
+
'oas3_1Decorators',
|
|
67
|
+
'oas3_2Decorators',
|
|
68
|
+
'async2Decorators',
|
|
69
|
+
'async3Decorators',
|
|
70
|
+
'arazzo1Decorators',
|
|
71
|
+
'overlay1Decorators',
|
|
72
|
+
];
|
|
32
73
|
exports.decoratorsSchemas = {
|
|
33
|
-
decorators:
|
|
34
|
-
oas2Decorators:
|
|
35
|
-
oas3_0Decorators:
|
|
36
|
-
oas3_1Decorators:
|
|
37
|
-
oas3_2Decorators:
|
|
38
|
-
async2Decorators:
|
|
39
|
-
async3Decorators:
|
|
40
|
-
arazzo1Decorators:
|
|
41
|
-
overlay1Decorators:
|
|
74
|
+
decorators: exports.decoratorsSchema,
|
|
75
|
+
oas2Decorators: exports.decoratorsSchema,
|
|
76
|
+
oas3_0Decorators: exports.decoratorsSchema,
|
|
77
|
+
oas3_1Decorators: exports.decoratorsSchema,
|
|
78
|
+
oas3_2Decorators: exports.decoratorsSchema,
|
|
79
|
+
async2Decorators: exports.decoratorsSchema,
|
|
80
|
+
async3Decorators: exports.decoratorsSchema,
|
|
81
|
+
arazzo1Decorators: exports.decoratorsSchema,
|
|
82
|
+
overlay1Decorators: exports.decoratorsSchema,
|
|
42
83
|
};
|
|
43
84
|
//# sourceMappingURL=common.js.map
|
|
@@ -942,6 +942,45 @@ export declare const themeConfigSchema: {
|
|
|
942
942
|
};
|
|
943
943
|
readonly additionalProperties: false;
|
|
944
944
|
};
|
|
945
|
+
readonly aiAssistant: {
|
|
946
|
+
readonly type: "object";
|
|
947
|
+
readonly properties: {
|
|
948
|
+
readonly hide: {
|
|
949
|
+
readonly type: "boolean";
|
|
950
|
+
};
|
|
951
|
+
readonly suggestions: {
|
|
952
|
+
readonly default: readonly [];
|
|
953
|
+
readonly type: "array";
|
|
954
|
+
readonly items: {
|
|
955
|
+
readonly type: "string";
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
readonly prompt: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
};
|
|
961
|
+
readonly trigger: {
|
|
962
|
+
readonly type: "object";
|
|
963
|
+
readonly properties: {
|
|
964
|
+
readonly hide: {
|
|
965
|
+
readonly type: "boolean";
|
|
966
|
+
readonly default: false;
|
|
967
|
+
};
|
|
968
|
+
readonly inputType: {
|
|
969
|
+
readonly type: "string";
|
|
970
|
+
readonly enum: readonly ["button", "icon"];
|
|
971
|
+
readonly default: "button";
|
|
972
|
+
};
|
|
973
|
+
readonly inputIcon: {
|
|
974
|
+
readonly type: "string";
|
|
975
|
+
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
976
|
+
readonly default: "redocly";
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
readonly additionalProperties: false;
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
readonly additionalProperties: false;
|
|
983
|
+
};
|
|
945
984
|
readonly colorMode: {
|
|
946
985
|
readonly type: "object";
|
|
947
986
|
readonly properties: {
|
|
@@ -3995,6 +4034,10 @@ export declare const themeConfigSchema: {
|
|
|
3995
4034
|
readonly entitiesCatalog: {
|
|
3996
4035
|
readonly type: "object";
|
|
3997
4036
|
readonly properties: {
|
|
4037
|
+
readonly show: {
|
|
4038
|
+
readonly type: "boolean";
|
|
4039
|
+
readonly default: false;
|
|
4040
|
+
};
|
|
3998
4041
|
readonly entityTypes: {
|
|
3999
4042
|
readonly type: "object";
|
|
4000
4043
|
readonly additionalProperties: {
|
|
@@ -24,6 +24,7 @@ exports.themeConfigSchema = {
|
|
|
24
24
|
links: ex_theme_config_schemas_1.linksConfigSchema,
|
|
25
25
|
feedback: feedback_config_schema_1.feedbackConfigSchema,
|
|
26
26
|
search: ex_theme_config_schemas_1.searchConfigSchema,
|
|
27
|
+
aiAssistant: ex_theme_config_schemas_1.aiAssistantSchema,
|
|
27
28
|
colorMode: ex_theme_config_schemas_1.colorModeConfigSchema,
|
|
28
29
|
navigation: ex_theme_config_schemas_1.navigationConfigSchema,
|
|
29
30
|
codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema,
|
|
@@ -478,6 +478,10 @@ export declare const entityCatalogEntityTypesSchema: {
|
|
|
478
478
|
export declare const entitiesCatalogConfigSchema: {
|
|
479
479
|
readonly type: "object";
|
|
480
480
|
readonly properties: {
|
|
481
|
+
readonly show: {
|
|
482
|
+
readonly type: "boolean";
|
|
483
|
+
readonly default: false;
|
|
484
|
+
};
|
|
481
485
|
readonly entityTypes: {
|
|
482
486
|
readonly type: "object";
|
|
483
487
|
readonly additionalProperties: {
|
|
@@ -164,6 +164,7 @@ exports.entityCatalogEntityTypesSchema = {
|
|
|
164
164
|
exports.entitiesCatalogConfigSchema = {
|
|
165
165
|
type: 'object',
|
|
166
166
|
properties: {
|
|
167
|
+
show: { type: 'boolean', default: false },
|
|
167
168
|
entityTypes: exports.entityCatalogEntityTypesSchema,
|
|
168
169
|
catalogs: {
|
|
169
170
|
type: 'object',
|
|
@@ -199,6 +199,9 @@ export declare const productConfigSchema: {
|
|
|
199
199
|
readonly additionalProperties: false;
|
|
200
200
|
readonly required: readonly ["name", "folder"];
|
|
201
201
|
};
|
|
202
|
+
/**
|
|
203
|
+
* @deprecated Use `aiAssistant` configuration instead of `search.ai`
|
|
204
|
+
*/
|
|
202
205
|
export declare const aiSearchConfigSchema: {
|
|
203
206
|
readonly type: "object";
|
|
204
207
|
readonly properties: {
|
|
@@ -964,6 +967,45 @@ export declare const searchConfigSchema: {
|
|
|
964
967
|
};
|
|
965
968
|
readonly additionalProperties: false;
|
|
966
969
|
};
|
|
970
|
+
export declare const aiAssistantSchema: {
|
|
971
|
+
readonly type: "object";
|
|
972
|
+
readonly properties: {
|
|
973
|
+
readonly hide: {
|
|
974
|
+
readonly type: "boolean";
|
|
975
|
+
};
|
|
976
|
+
readonly suggestions: {
|
|
977
|
+
readonly default: readonly [];
|
|
978
|
+
readonly type: "array";
|
|
979
|
+
readonly items: {
|
|
980
|
+
readonly type: "string";
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
readonly prompt: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
};
|
|
986
|
+
readonly trigger: {
|
|
987
|
+
readonly type: "object";
|
|
988
|
+
readonly properties: {
|
|
989
|
+
readonly hide: {
|
|
990
|
+
readonly type: "boolean";
|
|
991
|
+
readonly default: false;
|
|
992
|
+
};
|
|
993
|
+
readonly inputType: {
|
|
994
|
+
readonly type: "string";
|
|
995
|
+
readonly enum: readonly ["button", "icon"];
|
|
996
|
+
readonly default: "button";
|
|
997
|
+
};
|
|
998
|
+
readonly inputIcon: {
|
|
999
|
+
readonly type: "string";
|
|
1000
|
+
readonly enum: readonly ["chat", "sparkles", "redocly"];
|
|
1001
|
+
readonly default: "redocly";
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
readonly additionalProperties: false;
|
|
1005
|
+
};
|
|
1006
|
+
};
|
|
1007
|
+
readonly additionalProperties: false;
|
|
1008
|
+
};
|
|
967
1009
|
export declare const colorModeConfigSchema: {
|
|
968
1010
|
readonly type: "object";
|
|
969
1011
|
readonly properties: {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFiltersConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
|
|
3
|
+
exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.aiAssistantSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFiltersConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
|
|
4
4
|
const redoc_config_schema_1 = require("./redoc-config-schema");
|
|
5
5
|
const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
|
|
6
6
|
const common_1 = require("./common");
|
|
@@ -85,6 +85,9 @@ exports.productConfigSchema = {
|
|
|
85
85
|
additionalProperties: false,
|
|
86
86
|
required: ['name', 'folder'],
|
|
87
87
|
};
|
|
88
|
+
/**
|
|
89
|
+
* @deprecated Use `aiAssistant` configuration instead of `search.ai`
|
|
90
|
+
*/
|
|
88
91
|
exports.aiSearchConfigSchema = {
|
|
89
92
|
type: 'object',
|
|
90
93
|
properties: {
|
|
@@ -221,6 +224,46 @@ exports.searchConfigSchema = {
|
|
|
221
224
|
} }, hideConfigSchema.properties),
|
|
222
225
|
additionalProperties: false,
|
|
223
226
|
};
|
|
227
|
+
exports.aiAssistantSchema = {
|
|
228
|
+
type: 'object',
|
|
229
|
+
properties: {
|
|
230
|
+
hide: {
|
|
231
|
+
type: 'boolean',
|
|
232
|
+
// set default to false when removing search.ai backwards compatibility
|
|
233
|
+
},
|
|
234
|
+
suggestions: {
|
|
235
|
+
default: [],
|
|
236
|
+
type: 'array',
|
|
237
|
+
items: {
|
|
238
|
+
type: 'string',
|
|
239
|
+
},
|
|
240
|
+
},
|
|
241
|
+
prompt: {
|
|
242
|
+
type: 'string',
|
|
243
|
+
},
|
|
244
|
+
trigger: {
|
|
245
|
+
type: 'object',
|
|
246
|
+
properties: {
|
|
247
|
+
hide: {
|
|
248
|
+
type: 'boolean',
|
|
249
|
+
default: false,
|
|
250
|
+
},
|
|
251
|
+
inputType: {
|
|
252
|
+
type: 'string',
|
|
253
|
+
enum: ['button', 'icon'],
|
|
254
|
+
default: 'button',
|
|
255
|
+
},
|
|
256
|
+
inputIcon: {
|
|
257
|
+
type: 'string',
|
|
258
|
+
enum: ['chat', 'sparkles', 'redocly'],
|
|
259
|
+
default: 'redocly',
|
|
260
|
+
},
|
|
261
|
+
},
|
|
262
|
+
additionalProperties: false,
|
|
263
|
+
},
|
|
264
|
+
},
|
|
265
|
+
additionalProperties: false,
|
|
266
|
+
};
|
|
224
267
|
exports.colorModeConfigSchema = {
|
|
225
268
|
type: 'object',
|
|
226
269
|
properties: Object.assign({ ignoreDetection: { type: 'boolean' }, modes: {
|
package/lib/index.d.ts
CHANGED
|
@@ -2,5 +2,6 @@ export { productThemeOverrideSchema, productConfigOverrideSchema } from './produ
|
|
|
2
2
|
export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
|
|
3
3
|
export { redocConfigSchema } from './redoc-config-schema';
|
|
4
4
|
export * from './types';
|
|
5
|
+
export * from './common';
|
|
5
6
|
export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, } from './constants';
|
|
6
7
|
export * from './entities-catalog-entity-file-schema';
|
package/lib/index.js
CHANGED
|
@@ -24,6 +24,7 @@ Object.defineProperty(exports, "rootRedoclyConfigSchema", { enumerable: true, ge
|
|
|
24
24
|
var redoc_config_schema_1 = require("./redoc-config-schema");
|
|
25
25
|
Object.defineProperty(exports, "redocConfigSchema", { enumerable: true, get: function () { return redoc_config_schema_1.redocConfigSchema; } });
|
|
26
26
|
__exportStar(require("./types"), exports);
|
|
27
|
+
__exportStar(require("./common"), exports);
|
|
27
28
|
var constants_1 = require("./constants");
|
|
28
29
|
Object.defineProperty(exports, "ApigeeDevOnboardingIntegrationAuthType", { enumerable: true, get: function () { return constants_1.ApigeeDevOnboardingIntegrationAuthType; } });
|
|
29
30
|
Object.defineProperty(exports, "AuthProviderType", { enumerable: true, get: function () { return constants_1.AuthProviderType; } });
|
|
@@ -99,6 +99,18 @@ export declare const reuniteConfigSchema: {
|
|
|
99
99
|
};
|
|
100
100
|
};
|
|
101
101
|
};
|
|
102
|
+
readonly slo: {
|
|
103
|
+
readonly type: "object";
|
|
104
|
+
readonly properties: {
|
|
105
|
+
readonly warn: {
|
|
106
|
+
readonly type: "number";
|
|
107
|
+
};
|
|
108
|
+
readonly error: {
|
|
109
|
+
readonly type: "number";
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
readonly additionalProperties: false;
|
|
113
|
+
};
|
|
102
114
|
};
|
|
103
115
|
readonly required: readonly ["path", "trigger", "agent"];
|
|
104
116
|
readonly additionalProperties: false;
|
|
@@ -49,6 +49,14 @@ const jobTriggerBuildSchema = {
|
|
|
49
49
|
required: ['event'],
|
|
50
50
|
additionalProperties: false,
|
|
51
51
|
};
|
|
52
|
+
const sloSchema = {
|
|
53
|
+
type: 'object',
|
|
54
|
+
properties: {
|
|
55
|
+
warn: { type: 'number' },
|
|
56
|
+
error: { type: 'number' },
|
|
57
|
+
},
|
|
58
|
+
additionalProperties: false,
|
|
59
|
+
};
|
|
52
60
|
exports.reuniteConfigSchema = {
|
|
53
61
|
type: 'object',
|
|
54
62
|
properties: {
|
|
@@ -83,6 +91,7 @@ exports.reuniteConfigSchema = {
|
|
|
83
91
|
inputs: jobInputsSchema,
|
|
84
92
|
servers: jobServersSchema,
|
|
85
93
|
severity: jobSeveritySchema,
|
|
94
|
+
slo: sloSchema,
|
|
86
95
|
},
|
|
87
96
|
required: ['path', 'trigger', 'agent'],
|
|
88
97
|
additionalProperties: false,
|