@redocly/config 0.43.0 → 0.44.0

package/lib/default-theme-config-schema.js

@@ -46,8 +46,8 @@ exports.themeConfigSchema = {
          * @deprecated Should use `scorecardClassic` instead
          */
         scorecard: ex_theme_config_schemas_1.scorecardConfigSchema,
-        scorecards: scorecards_config_schema_1.scorecardsConfigSchema,
         scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema,
+        scorecards: scorecards_config_schema_1.scorecardsConfigSchema,
     },
     additionalProperties: true,
 };

package/lib/entities-catalog-entity-file-schema.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.entityFileDefaultSchema = exports.entityFileSchema = exports.entityBaseProperties = exports.entityRelationFileSchema = exports.entityLinkFileSchema = exports.entityContactFileSchema = exports.slackContactFileSchema = exports.slackChannelFileSchema = exports.defaultMetadataSchema = exports.dataSchemaMetadataSchema = exports.apiOperationMetadataSchema = exports.apiDescriptionMetadataSchema = exports.userMetadataSchema = void 0;
-const constants_1 = require("./constants");
+const entities_1 = require("./constants/entities");
 exports.userMetadataSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.USER_ENTITY_METADATA,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntityMetadata,
     properties: {
         email: {
             type: 'string',
@@ -16,7 +16,7 @@ exports.userMetadataSchema = {
 };
 exports.apiDescriptionMetadataSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.API_DESCRIPTION_METADATA,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntityMetadata,
     properties: {
         specType: {
             type: 'string',
@@ -33,7 +33,7 @@ exports.apiDescriptionMetadataSchema = {
 };
 exports.apiOperationMetadataSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.API_OPERATION_METADATA,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntityMetadata,
     properties: {
         method: {
             type: 'string',
@@ -64,7 +64,7 @@ exports.apiOperationMetadataSchema = {
 };
 exports.dataSchemaMetadataSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.DATA_SCHEMA_METADATA,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntityMetadata,
     properties: {
         specType: {
             type: 'string',
@@ -86,12 +86,12 @@ exports.dataSchemaMetadataSchema = {
 exports.defaultMetadataSchema = {
     type: 'object',
     properties: {},
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_METADATA,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityMetadata,
     additionalProperties: true,
 };
 exports.slackChannelFileSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.SLACK_CHANNEL,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackChannel,
     properties: {
         name: {
             type: 'string',
@@ -107,7 +107,7 @@ exports.slackChannelFileSchema = {
 };
 exports.slackContactFileSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.SLACK_CONTACT,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackContact,
     properties: {
         channels: {
             type: 'array',
@@ -119,7 +119,7 @@ exports.slackContactFileSchema = {
 };
 exports.entityContactFileSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_CONTACT,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityContact,
     properties: {
         slack: exports.slackContactFileSchema,
     },
@@ -127,7 +127,7 @@ exports.entityContactFileSchema = {
 };
 exports.entityLinkFileSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_LINK,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLink,
     properties: {
         label: {
             type: 'string',
@@ -143,11 +143,11 @@ exports.entityLinkFileSchema = {
 };
 exports.entityRelationFileSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_RELATION,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelation,
     properties: {
         type: {
             type: 'string',
-            enum: constants_1.ENTITY_RELATION_TYPES,
+            enum: entities_1.ENTITY_RELATION_TYPES,
         },
         key: {
             type: 'string',
@@ -206,12 +206,12 @@ exports.entityBaseProperties = {
     contact: exports.entityContactFileSchema,
     links: {
         type: 'array',
-        nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_LINK_LIST,
+        nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLinkList,
         items: exports.entityLinkFileSchema,
     },
     relations: {
         type: 'array',
-        nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_RELATION_LIST,
+        nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelationList,
         items: exports.entityRelationFileSchema,
     },
     metadata: exports.defaultMetadataSchema,
@@ -227,46 +227,46 @@ exports.entityFileSchema = {
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'user' }, metadata: exports.userMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.USER_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntity,
         },
         {
             type: 'object',
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.API_OPERATION_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntity,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-operation' }, metadata: exports.apiOperationMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.DATA_SCHEMA_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntity,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'data-schema' }, metadata: exports.dataSchemaMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.API_DESCRIPTION_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntity,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-description' }, metadata: exports.apiDescriptionMetadataSchema }),
             required: ['key', 'title', 'type', 'metadata'],
             additionalProperties: false,
         },
         {
             type: 'object',
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.SERVICE_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ServiceEntity,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'service' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
         },
         {
             type: 'object',
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.DOMAIN_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DomainEntity,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'domain' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
         },
         {
             type: 'object',
-            nodeTypeName: constants_1.NODE_TYPE_NAMES.TEAM_ENTITY,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.TeamEntity,
             properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'team' } }),
             required: ['key', 'title', 'type'],
             additionalProperties: false,
@@ -275,7 +275,7 @@ exports.entityFileSchema = {
 };
 exports.entityFileDefaultSchema = {
     type: 'object',
-    nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY,
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.Entity,
     properties: Object.assign({}, exports.entityBaseProperties),
     required: ['key', 'title', 'type'],
     additionalProperties: false,

package/lib/ex-theme-config-schemas.d.ts

@@ -4202,6 +4202,9 @@ export declare const catalogsConfigSchema: {
     };
 };
 export declare const scorecardConfigSchema: {
+    readonly nodeTypeName: "ScorecardClassic";
+    readonly description: "Add and create sets of rules and test your API description files against them. With these rules you can maintain quality across your existing APIs and ensure that newly-added or updated APIs match your criteria. An API scorecard can include multiple sets of rules, corresponding to different quality levels.";
+    readonly documentationLink: "https://redocly.com/docs/realm/config/scorecard-classic";
     readonly type: "object";
     readonly additionalProperties: true;
     readonly required: readonly [];
@@ -4214,6 +4217,9 @@ export declare const scorecardConfigSchema: {
             readonly default: false;
         };
         readonly teamMetadataProperty: {
+            readonly nodeTypeName: "ScorecardClassicTeamMetadataProperty";
+            readonly description: "Provide custom team label and team metadata property.";
+            readonly documentationLink: "https://redocly.com/docs/realm/config/scorecard-classic#team-metadata-object";
             readonly type: "object";
             readonly properties: {
                 readonly property: {
@@ -4228,92 +4234,126 @@ export declare const scorecardConfigSchema: {
             };
         };
         readonly levels: {
+            readonly nodeTypeName: "ScorecardClassicLevelList";
+            readonly description: "List of levels to score against.";
             readonly type: "array";
             readonly items: {
+                readonly nodeTypeName: "ScorecardClassicLevel";
+                readonly documentationLink: "https://redocly.com/docs/realm/config/scorecard-classic#level-object";
                 readonly type: "object";
                 readonly required: readonly ["name"];
                 readonly properties: {
-                    readonly decorators: {
+                    readonly extends: {
+                        readonly nodeTypeName: undefined;
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Use extends to inherit rules and their configurations from other rulesets.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/extends";
+                    };
+                    readonly preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas2Decorators: {
+                    readonly oas2Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas3_0Decorators: {
+                    readonly oas3_0Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas3_1Decorators: {
+                    readonly oas3_1Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas3_2Decorators: {
+                    readonly oas3_2Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly async2Decorators: {
+                    readonly async2Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly async3Decorators: {
+                    readonly async3Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly arazzo1Decorators: {
+                    readonly arazzo1Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly overlay1Decorators: {
+                    readonly overlay1Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly openrpc1Decorators: {
+                    readonly openrpc1Preprocessors: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly preprocessors: {
+                    readonly decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas2Preprocessors: {
+                    readonly oas2Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas3_0Preprocessors: {
+                    readonly oas3_0Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas3_1Preprocessors: {
+                    readonly oas3_1Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly oas3_2Preprocessors: {
+                    readonly oas3_2Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly async2Preprocessors: {
+                    readonly async2Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly async3Preprocessors: {
+                    readonly async3Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly arazzo1Preprocessors: {
+                    readonly arazzo1Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly overlay1Preprocessors: {
+                    readonly overlay1Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
-                    readonly openrpc1Preprocessors: {
+                    readonly openrpc1Decorators: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: true;
                     };
                     readonly rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4322,8 +4362,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly oas2Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4332,8 +4375,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly oas3_0Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4342,8 +4388,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly oas3_1Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4352,8 +4401,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly oas3_2Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4362,8 +4414,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly async2Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4372,8 +4427,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly async3Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4382,8 +4440,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly arazzo1Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4392,8 +4453,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly overlay1Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4402,8 +4466,11 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly openrpc1Rules: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "object";
                         readonly additionalProperties: {
                             readonly oneOf: readonly [{
@@ -4412,6 +4479,8 @@ export declare const scorecardConfigSchema: {
                                 readonly type: "object";
                             }];
                         };
+                        readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
                     };
                     readonly name: {
                         readonly type: "string";
@@ -4419,19 +4488,16 @@ export declare const scorecardConfigSchema: {
                     readonly color: {
                         readonly type: "string";
                     };
-                    readonly extends: {
-                        readonly type: "array";
-                        readonly items: {
-                            readonly type: "string";
-                        };
-                    };
                 };
                 readonly additionalProperties: false;
             };
         };
         readonly targets: {
+            readonly nodeTypeName: "ScorecardClassicTargetList";
+            readonly description: "Provide custom `minimumLevel` for specific targets.";
             readonly type: "array";
             readonly items: {
+                readonly nodeTypeName: "ScorecardClassicTarget";
                 readonly type: "object";
                 readonly required: readonly ["where"];
                 readonly properties: {
@@ -4443,10 +4509,14 @@ export declare const scorecardConfigSchema: {
                         readonly additionalProperties: true;
                     };
                     readonly where: {
+                        readonly nodeTypeName: "ScorecardClassicTargetWhere";
+                        readonly description: "Specify which API descriptions to apply the `minimumLevel` to based on the metadata.";
+                        readonly documentationLink: "https://redocly.com/docs/realm/config/scorecard-classic#where-object";
                         readonly type: "object";
                         readonly required: readonly ["metadata"];
                         readonly properties: {
                             readonly metadata: {
+                                readonly nodeTypeName: "ScorecardClassicTargetWhereMetadata";
                                 readonly type: "object";
                                 readonly additionalProperties: {
                                     readonly type: "string";

package/lib/ex-theme-config-schemas.js

@@ -4,6 +4,7 @@ exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSc
 const redoc_config_schema_1 = require("./redoc-config-schema");
 const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
 const common_1 = require("./common");
+const config_1 = require("./constants/config");
 const hideConfigSchema = {
     type: 'object',
     properties: {
@@ -606,6 +607,9 @@ exports.catalogsConfigSchema = {
     },
 };
 exports.scorecardConfigSchema = {
+    nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassic,
+    description: 'Add and create sets of rules and test your API description files against them. With these rules you can maintain quality across your existing APIs and ensure that newly-added or updated APIs match your criteria. An API scorecard can include multiple sets of rules, corresponding to different quality levels.',
+    documentationLink: 'https://redocly.com/docs/realm/config/scorecard-classic',
     type: 'object',
     additionalProperties: true,
     required: [],
@@ -615,6 +619,9 @@ exports.scorecardConfigSchema = {
          */
         ignoreNonCompliant: { type: 'boolean', default: false },
         teamMetadataProperty: {
+            nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicTeamMetadataProperty,
+            description: 'Provide custom team label and team metadata property.',
+            documentationLink: 'https://redocly.com/docs/realm/config/scorecard-classic#team-metadata-object',
             type: 'object',
             properties: {
                 property: { type: 'string' },
@@ -623,27 +630,41 @@ exports.scorecardConfigSchema = {
             },
         },
         levels: {
+            nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicLevelList,
+            description: 'List of levels to score against.',
             type: 'array',
             items: {
+                nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicLevel,
+                documentationLink: 'https://redocly.com/docs/realm/config/scorecard-classic#level-object',
                 type: 'object',
                 required: ['name'],
-                properties: Object.assign(Object.assign(Object.assign({ name: { type: 'string' }, color: { type: 'string' }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.preprocessorSchemas), common_1.decoratorsSchemas),
+                properties: Object.assign({ name: { type: 'string' }, color: { type: 'string' } }, common_1.configGovernanceSchema),
                 additionalProperties: false,
             },
         },
         targets: {
+            nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicTargetList,
+            description: 'Provide custom `minimumLevel` for specific targets.',
             type: 'array',
             items: {
+                nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicTarget,
                 type: 'object',
                 required: ['where'],
                 properties: {
                     minimumLevel: { type: 'string' },
                     rules: { type: 'object', additionalProperties: true },
                     where: {
+                        nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicTargetWhere,
+                        description: 'Specify which API descriptions to apply the `minimumLevel` to based on the metadata.',
+                        documentationLink: 'https://redocly.com/docs/realm/config/scorecard-classic#where-object',
                         type: 'object',
                         required: ['metadata'],
                         properties: {
-                            metadata: { type: 'object', additionalProperties: { type: 'string' } },
+                            metadata: {
+                                nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.ScorecardClassicTargetWhereMetadata,
+                                type: 'object',
+                                additionalProperties: { type: 'string' },
+                            },
                         },
                         additionalProperties: false,
                     },

package/lib/index.d.ts

@@ -3,5 +3,7 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema'
 export { redocConfigSchema } from './redoc-config-schema';
 export * from './types';
 export * from './common';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, NODE_TYPE_NAMES, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants/shared';
+export { CONFIG_NODE_TYPE_NAMES } from './constants/config';
+export { ENTITY_RELATION_TYPES, ENTITY_NODE_TYPE_NAMES } from './constants/entities';
 export * from './entities-catalog-entity-file-schema';

package/lib/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NODE_TYPE_NAMES = exports.ENTITY_RELATION_TYPES = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.redocConfigSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = void 0;
+exports.ENTITY_NODE_TYPE_NAMES = exports.ENTITY_RELATION_TYPES = exports.CONFIG_NODE_TYPE_NAMES = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.redocConfigSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = void 0;
 var product_override_schema_1 = require("./product-override-schema");
 Object.defineProperty(exports, "productThemeOverrideSchema", { enumerable: true, get: function () { return product_override_schema_1.productThemeOverrideSchema; } });
 Object.defineProperty(exports, "productConfigOverrideSchema", { enumerable: true, get: function () { return product_override_schema_1.productConfigOverrideSchema; } });
@@ -25,14 +25,17 @@ var redoc_config_schema_1 = require("./redoc-config-schema");
 Object.defineProperty(exports, "redocConfigSchema", { enumerable: true, get: function () { return redoc_config_schema_1.redocConfigSchema; } });
 __exportStar(require("./types"), exports);
 __exportStar(require("./common"), exports);
-var constants_1 = require("./constants");
-Object.defineProperty(exports, "ApigeeDevOnboardingIntegrationAuthType", { enumerable: true, get: function () { return constants_1.ApigeeDevOnboardingIntegrationAuthType; } });
-Object.defineProperty(exports, "AuthProviderType", { enumerable: true, get: function () { return constants_1.AuthProviderType; } });
-Object.defineProperty(exports, "DEFAULT_TEAM_CLAIM_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_TEAM_CLAIM_NAME; } });
-Object.defineProperty(exports, "LayoutVariant", { enumerable: true, get: function () { return constants_1.LayoutVariant; } });
-Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_TEAMS_RBAC; } });
-Object.defineProperty(exports, "REDOCLY_ROUTE_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_ROUTE_RBAC; } });
-Object.defineProperty(exports, "ENTITY_RELATION_TYPES", { enumerable: true, get: function () { return constants_1.ENTITY_RELATION_TYPES; } });
-Object.defineProperty(exports, "NODE_TYPE_NAMES", { enumerable: true, get: function () { return constants_1.NODE_TYPE_NAMES; } });
+var shared_1 = require("./constants/shared");
+Object.defineProperty(exports, "ApigeeDevOnboardingIntegrationAuthType", { enumerable: true, get: function () { return shared_1.ApigeeDevOnboardingIntegrationAuthType; } });
+Object.defineProperty(exports, "AuthProviderType", { enumerable: true, get: function () { return shared_1.AuthProviderType; } });
+Object.defineProperty(exports, "DEFAULT_TEAM_CLAIM_NAME", { enumerable: true, get: function () { return shared_1.DEFAULT_TEAM_CLAIM_NAME; } });
+Object.defineProperty(exports, "LayoutVariant", { enumerable: true, get: function () { return shared_1.LayoutVariant; } });
+Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return shared_1.REDOCLY_TEAMS_RBAC; } });
+Object.defineProperty(exports, "REDOCLY_ROUTE_RBAC", { enumerable: true, get: function () { return shared_1.REDOCLY_ROUTE_RBAC; } });
+var config_1 = require("./constants/config");
+Object.defineProperty(exports, "CONFIG_NODE_TYPE_NAMES", { enumerable: true, get: function () { return config_1.CONFIG_NODE_TYPE_NAMES; } });
+var entities_1 = require("./constants/entities");
+Object.defineProperty(exports, "ENTITY_RELATION_TYPES", { enumerable: true, get: function () { return entities_1.ENTITY_RELATION_TYPES; } });
+Object.defineProperty(exports, "ENTITY_NODE_TYPE_NAMES", { enumerable: true, get: function () { return entities_1.ENTITY_NODE_TYPE_NAMES; } });
 __exportStar(require("./entities-catalog-entity-file-schema"), exports);
 //# sourceMappingURL=index.js.map