@redocly/config 0.41.2 → 0.41.4
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/constants.d.ts +22 -0
- package/lib/constants.js +23 -1
- package/lib/default-theme-config-schema.d.ts +69 -18
- package/lib/entities-catalog-entity-file-schema.d.ts +105 -0
- package/lib/entities-catalog-entity-file-schema.js +27 -41
- package/lib/index.d.ts +1 -1
- package/lib/index.js +2 -1
- package/lib/root-config-schema.d.ts +294 -78
- package/lib/scorecards-config-schema.d.ts +138 -36
- package/lib/scorecards-config-schema.js +15 -11
- package/lib-esm/constants.d.ts +22 -0
- package/lib-esm/constants.js +22 -0
- package/lib-esm/default-theme-config-schema.d.ts +69 -18
- package/lib-esm/entities-catalog-entity-file-schema.d.ts +105 -0
- package/lib-esm/entities-catalog-entity-file-schema.js +28 -42
- package/lib-esm/index.d.ts +1 -1
- package/lib-esm/index.js +1 -1
- package/lib-esm/root-config-schema.d.ts +294 -78
- package/lib-esm/scorecards-config-schema.d.ts +138 -36
- package/lib-esm/scorecards-config-schema.js +15 -11
- package/package.json +3 -3
- package/lib/types/scorecards-types.d.ts +0 -3
- package/lib/types/scorecards-types.js +0 -3
- package/lib-esm/types/scorecards-types.d.ts +0 -3
- package/lib-esm/types/scorecards-types.js +0 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { ENTITY_RELATION_TYPES } from './constants';
|
|
1
|
+
import { ENTITY_RELATION_TYPES, NODE_TYPE_NAMES } from './constants';
|
|
2
2
|
export const userMetadataSchema = {
|
|
3
3
|
type: 'object',
|
|
4
|
+
nodeTypeName: NODE_TYPE_NAMES.USER_ENTITY_METADATA,
|
|
4
5
|
properties: {
|
|
5
6
|
email: {
|
|
6
7
|
type: 'string',
|
|
@@ -12,6 +13,7 @@ export const userMetadataSchema = {
|
|
|
12
13
|
};
|
|
13
14
|
export const apiDescriptionMetadataSchema = {
|
|
14
15
|
type: 'object',
|
|
16
|
+
nodeTypeName: NODE_TYPE_NAMES.API_DESCRIPTION_METADATA,
|
|
15
17
|
properties: {
|
|
16
18
|
specType: {
|
|
17
19
|
type: 'string',
|
|
@@ -28,6 +30,7 @@ export const apiDescriptionMetadataSchema = {
|
|
|
28
30
|
};
|
|
29
31
|
export const apiOperationMetadataSchema = {
|
|
30
32
|
type: 'object',
|
|
33
|
+
nodeTypeName: NODE_TYPE_NAMES.API_OPERATION_METADATA,
|
|
31
34
|
properties: {
|
|
32
35
|
method: {
|
|
33
36
|
type: 'string',
|
|
@@ -58,6 +61,7 @@ export const apiOperationMetadataSchema = {
|
|
|
58
61
|
};
|
|
59
62
|
export const dataSchemaMetadataSchema = {
|
|
60
63
|
type: 'object',
|
|
64
|
+
nodeTypeName: NODE_TYPE_NAMES.DATA_SCHEMA_METADATA,
|
|
61
65
|
properties: {
|
|
62
66
|
specType: {
|
|
63
67
|
type: 'string',
|
|
@@ -78,37 +82,33 @@ export const dataSchemaMetadataSchema = {
|
|
|
78
82
|
};
|
|
79
83
|
export const defaultMetadataSchema = {
|
|
80
84
|
type: 'object',
|
|
85
|
+
properties: {},
|
|
86
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY_METADATA,
|
|
81
87
|
additionalProperties: true,
|
|
82
88
|
};
|
|
83
89
|
export const slackChannelFileSchema = {
|
|
84
90
|
type: 'object',
|
|
91
|
+
nodeTypeName: NODE_TYPE_NAMES.SLACK_CHANNEL,
|
|
85
92
|
properties: {
|
|
86
93
|
name: {
|
|
87
94
|
type: 'string',
|
|
88
95
|
minLength: 2,
|
|
89
96
|
maxLength: 150,
|
|
90
97
|
},
|
|
98
|
+
url: {
|
|
99
|
+
type: 'string',
|
|
100
|
+
},
|
|
91
101
|
},
|
|
92
102
|
required: ['name'],
|
|
93
103
|
additionalProperties: false,
|
|
94
104
|
};
|
|
95
105
|
export const slackContactFileSchema = {
|
|
96
106
|
type: 'object',
|
|
107
|
+
nodeTypeName: NODE_TYPE_NAMES.SLACK_CONTACT,
|
|
97
108
|
properties: {
|
|
98
109
|
channels: {
|
|
99
110
|
type: 'array',
|
|
100
|
-
items:
|
|
101
|
-
type: 'object',
|
|
102
|
-
properties: {
|
|
103
|
-
name: {
|
|
104
|
-
type: 'string',
|
|
105
|
-
minLength: 2,
|
|
106
|
-
maxLength: 150,
|
|
107
|
-
},
|
|
108
|
-
},
|
|
109
|
-
required: ['name'],
|
|
110
|
-
additionalProperties: false,
|
|
111
|
-
},
|
|
111
|
+
items: slackChannelFileSchema,
|
|
112
112
|
},
|
|
113
113
|
},
|
|
114
114
|
required: ['channels'],
|
|
@@ -116,37 +116,15 @@ export const slackContactFileSchema = {
|
|
|
116
116
|
};
|
|
117
117
|
export const entityContactFileSchema = {
|
|
118
118
|
type: 'object',
|
|
119
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY_CONTACT,
|
|
119
120
|
properties: {
|
|
120
|
-
slack:
|
|
121
|
-
type: 'object',
|
|
122
|
-
properties: {
|
|
123
|
-
channels: {
|
|
124
|
-
type: 'array',
|
|
125
|
-
items: {
|
|
126
|
-
type: 'object',
|
|
127
|
-
properties: {
|
|
128
|
-
name: {
|
|
129
|
-
type: 'string',
|
|
130
|
-
minLength: 2,
|
|
131
|
-
maxLength: 150,
|
|
132
|
-
},
|
|
133
|
-
url: {
|
|
134
|
-
type: 'string',
|
|
135
|
-
},
|
|
136
|
-
},
|
|
137
|
-
required: ['name'],
|
|
138
|
-
additionalProperties: false,
|
|
139
|
-
},
|
|
140
|
-
},
|
|
141
|
-
},
|
|
142
|
-
required: ['channels'],
|
|
143
|
-
additionalProperties: false,
|
|
144
|
-
},
|
|
121
|
+
slack: slackContactFileSchema,
|
|
145
122
|
},
|
|
146
123
|
additionalProperties: false,
|
|
147
124
|
};
|
|
148
125
|
export const entityLinkFileSchema = {
|
|
149
126
|
type: 'object',
|
|
127
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY_LINK,
|
|
150
128
|
properties: {
|
|
151
129
|
label: {
|
|
152
130
|
type: 'string',
|
|
@@ -162,6 +140,7 @@ export const entityLinkFileSchema = {
|
|
|
162
140
|
};
|
|
163
141
|
export const entityRelationFileSchema = {
|
|
164
142
|
type: 'object',
|
|
143
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY_RELATION,
|
|
165
144
|
properties: {
|
|
166
145
|
type: {
|
|
167
146
|
type: 'string',
|
|
@@ -224,16 +203,15 @@ export const entityBaseProperties = {
|
|
|
224
203
|
contact: entityContactFileSchema,
|
|
225
204
|
links: {
|
|
226
205
|
type: 'array',
|
|
206
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY_LINK_LIST,
|
|
227
207
|
items: entityLinkFileSchema,
|
|
228
208
|
},
|
|
229
209
|
relations: {
|
|
230
210
|
type: 'array',
|
|
211
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY_RELATION_LIST,
|
|
231
212
|
items: entityRelationFileSchema,
|
|
232
213
|
},
|
|
233
|
-
metadata:
|
|
234
|
-
type: 'object',
|
|
235
|
-
additionalProperties: true,
|
|
236
|
-
},
|
|
214
|
+
metadata: defaultMetadataSchema,
|
|
237
215
|
};
|
|
238
216
|
export const entityFileSchema = {
|
|
239
217
|
type: 'object',
|
|
@@ -246,39 +224,46 @@ export const entityFileSchema = {
|
|
|
246
224
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'user' }, metadata: userMetadataSchema }),
|
|
247
225
|
required: ['key', 'title', 'type', 'metadata'],
|
|
248
226
|
additionalProperties: false,
|
|
227
|
+
nodeTypeName: NODE_TYPE_NAMES.USER_ENTITY,
|
|
249
228
|
},
|
|
250
229
|
{
|
|
251
230
|
type: 'object',
|
|
231
|
+
nodeTypeName: NODE_TYPE_NAMES.API_OPERATION_ENTITY,
|
|
252
232
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-operation' }, metadata: apiOperationMetadataSchema }),
|
|
253
233
|
required: ['key', 'title', 'type', 'metadata'],
|
|
254
234
|
additionalProperties: false,
|
|
255
235
|
},
|
|
256
236
|
{
|
|
257
237
|
type: 'object',
|
|
238
|
+
nodeTypeName: NODE_TYPE_NAMES.DATA_SCHEMA_ENTITY,
|
|
258
239
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'data-schema' }, metadata: dataSchemaMetadataSchema }),
|
|
259
240
|
required: ['key', 'title', 'type', 'metadata'],
|
|
260
241
|
additionalProperties: false,
|
|
261
242
|
},
|
|
262
243
|
{
|
|
263
244
|
type: 'object',
|
|
245
|
+
nodeTypeName: NODE_TYPE_NAMES.API_DESCRIPTION_ENTITY,
|
|
264
246
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-description' }, metadata: apiDescriptionMetadataSchema }),
|
|
265
247
|
required: ['key', 'title', 'type', 'metadata'],
|
|
266
248
|
additionalProperties: false,
|
|
267
249
|
},
|
|
268
250
|
{
|
|
269
251
|
type: 'object',
|
|
252
|
+
nodeTypeName: NODE_TYPE_NAMES.SERVICE_ENTITY,
|
|
270
253
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'service' } }),
|
|
271
254
|
required: ['key', 'title', 'type'],
|
|
272
255
|
additionalProperties: false,
|
|
273
256
|
},
|
|
274
257
|
{
|
|
275
258
|
type: 'object',
|
|
259
|
+
nodeTypeName: NODE_TYPE_NAMES.DOMAIN_ENTITY,
|
|
276
260
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'domain' } }),
|
|
277
261
|
required: ['key', 'title', 'type'],
|
|
278
262
|
additionalProperties: false,
|
|
279
263
|
},
|
|
280
264
|
{
|
|
281
265
|
type: 'object',
|
|
266
|
+
nodeTypeName: NODE_TYPE_NAMES.TEAM_ENTITY,
|
|
282
267
|
properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'team' } }),
|
|
283
268
|
required: ['key', 'title', 'type'],
|
|
284
269
|
additionalProperties: false,
|
|
@@ -287,6 +272,7 @@ export const entityFileSchema = {
|
|
|
287
272
|
};
|
|
288
273
|
export const entityFileDefaultSchema = {
|
|
289
274
|
type: 'object',
|
|
275
|
+
nodeTypeName: NODE_TYPE_NAMES.ENTITY,
|
|
290
276
|
properties: Object.assign({}, entityBaseProperties),
|
|
291
277
|
required: ['key', 'title', 'type'],
|
|
292
278
|
additionalProperties: false,
|
package/lib-esm/index.d.ts
CHANGED
|
@@ -3,5 +3,5 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema'
|
|
|
3
3
|
export { redocConfigSchema } from './redoc-config-schema';
|
|
4
4
|
export * from './types';
|
|
5
5
|
export * from './common';
|
|
6
|
-
export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, } from './constants';
|
|
6
|
+
export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, NODE_TYPE_NAMES, } from './constants';
|
|
7
7
|
export * from './entities-catalog-entity-file-schema';
|
package/lib-esm/index.js
CHANGED
|
@@ -3,6 +3,6 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema'
|
|
|
3
3
|
export { redocConfigSchema } from './redoc-config-schema';
|
|
4
4
|
export * from './types';
|
|
5
5
|
export * from './common';
|
|
6
|
-
export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, } from './constants';
|
|
6
|
+
export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, NODE_TYPE_NAMES, } from './constants';
|
|
7
7
|
export * from './entities-catalog-entity-file-schema';
|
|
8
8
|
//# sourceMappingURL=index.js.map
|