@redocly/config 0.39.0 → 0.40.0

package/lib/default-theme-config-schema.d.ts

@@ -3457,6 +3457,58 @@ export declare const themeConfigSchema: {
                 readonly showBuiltInDirectives: {
                     readonly type: "boolean";
                 };
+                readonly info: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly title: {
+                            readonly type: "string";
+                        };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly description: {
+                            readonly type: "string";
+                        };
+                        readonly termsOfService: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                        };
+                        readonly contact: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                };
+                                readonly url: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                };
+                                readonly email: {
+                                    readonly type: "string";
+                                    readonly format: "email";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly license: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                };
+                                readonly url: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                };
+                                readonly identifier: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
             };
             readonly additionalProperties: false;
         };
@@ -5285,6 +5337,9 @@ export declare const themeConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `scorecardClassic` instead
+         */
         readonly scorecard: {
             readonly type: "object";
             readonly additionalProperties: true;
@@ -5545,6 +5600,255 @@ export declare const themeConfigSchema: {
                 };
             };
         };
+        readonly scorecardClassic: {
+            readonly type: "object";
+            readonly additionalProperties: true;
+            readonly required: readonly [];
+            readonly properties: {
+                readonly ignoreNonCompliant: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+                readonly teamMetadataProperty: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly property: {
+                            readonly type: "string";
+                        };
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly default: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly levels: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["name"];
+                        readonly properties: {
+                            readonly decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas2Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_0Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_1Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_2Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async2Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async3Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly arazzo1Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly overlay1Decorators: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas2Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_0Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_1Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly oas3_2Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async2Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly async3Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly arazzo1Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly overlay1Preprocessors: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas2Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas3_0Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas3_1Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly oas3_2Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly async2Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly async3Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly arazzo1Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly overlay1Rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                            };
+                            readonly name: {
+                                readonly type: "string";
+                            };
+                            readonly color: {
+                                readonly type: "string";
+                            };
+                            readonly extends: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly targets: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["where"];
+                        readonly properties: {
+                            readonly minimumLevel: {
+                                readonly type: "string";
+                            };
+                            readonly rules: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                            readonly where: {
+                                readonly type: "object";
+                                readonly required: readonly ["metadata"];
+                                readonly properties: {
+                                    readonly metadata: {
+                                        readonly type: "object";
+                                        readonly additionalProperties: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly ignore: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly fromProjectUrl: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                };
+            };
+        };
     };
     readonly additionalProperties: true;
 };

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

@@ -41,8 +41,12 @@ exports.themeConfigSchema = {
         catalog: ex_theme_config_schemas_1.catalogsConfigSchema,
         entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema,
         catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema,
+        /**
+         * @deprecated Should use `scorecardClassic` instead
+         */
         scorecard: ex_theme_config_schemas_1.scorecardConfigSchema,
         scorecards: ex_theme_config_schemas_1.scorecardsConfigSchema,
+        scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema,
     },
     additionalProperties: true,
 };

package/lib/entities-catalog-entity-file-schema.d.ts

@@ -171,11 +171,20 @@ export declare const entityRelationFileSchema: {
             readonly minLength: 2;
             readonly maxLength: 100;
         };
+        readonly version: {
+            readonly type: "string";
+        };
+        readonly revision: {
+            readonly type: "string";
+        };
     };
     readonly required: readonly ["type", "key"];
     readonly additionalProperties: false;
 };
 export declare const entityBaseProperties: {
+    readonly version: {
+        readonly type: "string";
+    };
     readonly key: {
         readonly type: "string";
         readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -273,6 +282,12 @@ export declare const entityBaseProperties: {
                     readonly minLength: 2;
                     readonly maxLength: 100;
                 };
+                readonly version: {
+                    readonly type: "string";
+                };
+                readonly revision: {
+                    readonly type: "string";
+                };
             };
             readonly required: readonly ["type", "key"];
             readonly additionalProperties: false;
@@ -305,6 +320,9 @@ export declare const entityFileSchema: {
                 readonly required: readonly ["email"];
                 readonly additionalProperties: true;
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -398,6 +416,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -442,6 +466,9 @@ export declare const entityFileSchema: {
                 readonly required: readonly ["method", "path"];
                 readonly additionalProperties: true;
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -535,6 +562,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -569,6 +602,9 @@ export declare const entityFileSchema: {
                 readonly required: readonly ["specType"];
                 readonly additionalProperties: true;
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -662,6 +698,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -692,6 +734,9 @@ export declare const entityFileSchema: {
                 readonly required: readonly ["specType", "descriptionFile"];
                 readonly additionalProperties: true;
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -785,6 +830,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -799,6 +850,9 @@ export declare const entityFileSchema: {
             readonly type: {
                 readonly const: "service";
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -892,6 +946,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -910,6 +970,9 @@ export declare const entityFileSchema: {
             readonly type: {
                 readonly const: "domain";
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -1003,6 +1066,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -1021,6 +1090,9 @@ export declare const entityFileSchema: {
             readonly type: {
                 readonly const: "team";
             };
+            readonly version: {
+                readonly type: "string";
+            };
             readonly key: {
                 readonly type: "string";
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -1114,6 +1186,12 @@ export declare const entityFileSchema: {
                             readonly minLength: 2;
                             readonly maxLength: 100;
                         };
+                        readonly version: {
+                            readonly type: "string";
+                        };
+                        readonly revision: {
+                            readonly type: "string";
+                        };
                     };
                     readonly required: readonly ["type", "key"];
                     readonly additionalProperties: false;
@@ -1131,6 +1209,9 @@ export declare const entityFileSchema: {
 export declare const entityFileDefaultSchema: {
     readonly type: "object";
     readonly properties: {
+        readonly version: {
+            readonly type: "string";
+        };
         readonly key: {
             readonly type: "string";
             readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -1228,6 +1309,12 @@ export declare const entityFileDefaultSchema: {
                         readonly minLength: 2;
                         readonly maxLength: 100;
                     };
+                    readonly version: {
+                        readonly type: "string";
+                    };
+                    readonly revision: {
+                        readonly type: "string";
+                    };
                 };
                 readonly required: readonly ["type", "key"];
                 readonly additionalProperties: false;

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

@@ -175,12 +175,21 @@ exports.entityRelationFileSchema = {
             minLength: 2,
             maxLength: 100,
         },
+        version: {
+            type: 'string',
+        },
+        revision: {
+            type: 'string',
+        },
     },
     required: ['type', 'key'],
     additionalProperties: false,
 };
 // Base entity schema properties
 exports.entityBaseProperties = {
+    version: {
+        type: 'string',
+    },
     key: {
         type: 'string',
         pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$',

package/lib/graphql-config-schema.d.ts

@@ -445,6 +445,58 @@ export declare const graphqlConfigSchema: {
         readonly showBuiltInDirectives: {
             readonly type: "boolean";
         };
+        readonly info: {
+            readonly type: "object";
+            readonly properties: {
+                readonly title: {
+                    readonly type: "string";
+                };
+                readonly version: {
+                    readonly type: "string";
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+                readonly termsOfService: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                };
+                readonly contact: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly name: {
+                            readonly type: "string";
+                        };
+                        readonly url: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                        };
+                        readonly email: {
+                            readonly type: "string";
+                            readonly format: "email";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly license: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly name: {
+                            readonly type: "string";
+                        };
+                        readonly url: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                        };
+                        readonly identifier: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly additionalProperties: false;
+        };
     };
     readonly additionalProperties: false;
 };

package/lib/graphql-config-schema.js

@@ -54,6 +54,36 @@ const menuGroupingConfig = {
     required: ['requireExactGroups', 'groups', 'otherItemsGroupName'],
     additionalProperties: false,
 };
+const graphqlContactConfigSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        url: { type: 'string', format: 'uri' },
+        email: { type: 'string', format: 'email' },
+    },
+    additionalProperties: false,
+};
+const graphqlLicenseConfigSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        url: { type: 'string', format: 'uri' },
+        identifier: { type: 'string' },
+    },
+    additionalProperties: false,
+};
+const graphqlInfoConfigSchema = {
+    type: 'object',
+    properties: {
+        title: { type: 'string' },
+        version: { type: 'string' },
+        description: { type: 'string' },
+        termsOfService: { type: 'string', format: 'uri' },
+        contact: graphqlContactConfigSchema,
+        license: graphqlLicenseConfigSchema,
+    },
+    additionalProperties: false,
+};
 exports.graphqlConfigSchema = {
     type: 'object',
     properties: {
@@ -120,6 +150,7 @@ exports.graphqlConfigSchema = {
         showBuiltInDirectives: {
             type: 'boolean',
         },
+        info: graphqlInfoConfigSchema,
     },
     additionalProperties: false,
 };