@redocly/revel-reef 0.124.0-next.8 → 0.124.0

package/dist/server/plugins/catalog-entities/schemas/file-schemas.d.ts

@@ -82,8 +82,7 @@ export declare const entityRelationFileSchema: {
     readonly properties: {
         readonly type: {
             readonly type: "string";
-            readonly minLength: 2;
-            readonly maxLength: 50;
+            readonly enum: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];
         };
         readonly key: {
             readonly type: "string";
@@ -95,7 +94,11 @@ export declare const entityRelationFileSchema: {
     readonly additionalProperties: false;
 };
 export declare const entityFileSchema: {
-    readonly anyOf: readonly [{
+    readonly type: "object";
+    readonly discriminator: {
+        readonly propertyName: "type";
+    };
+    readonly oneOf: readonly [{
         readonly type: "object";
         readonly properties: {
             readonly type: {
@@ -113,75 +116,111 @@ export declare const entityFileSchema: {
                 readonly additionalProperties: true;
             };
             readonly key: {
-                type: string;
-                pattern: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly minLength: 2;
+                readonly maxLength: 150;
             };
             readonly title: {
-                type: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly minLength: 3;
+                readonly maxLength: 200;
             };
             readonly summary: {
-                type: string[];
-                minLength: number;
-                maxLength: number;
+                readonly type: readonly ["string", "null"];
+                readonly minLength: 1;
+                readonly maxLength: 500;
             };
             readonly tags: {
-                type: string[];
-                items: {
-                    type: string;
-                    minLength: number;
-                    maxLength: number;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 50;
                 };
             };
             readonly git: {
-                type: string[];
-                items: {
-                    type: string;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
                 };
             };
             readonly contact: {
-                type: string[];
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly slack: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly channels: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly minLength: 3;
+                                                readonly maxLength: 150;
+                                            };
+                                        };
+                                        readonly required: readonly ["name"];
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["channels"];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }];
             };
             readonly links: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        url: {
-                            type: string;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly label: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 150;
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                            };
                         };
+                        readonly required: readonly ["label", "url"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
             readonly relations: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        type: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        key: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];
+                            };
+                            readonly key: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 100;
+                            };
                         };
+                        readonly required: readonly ["type", "key"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
         };
         readonly required: readonly ["key", "title", "type", "metadata"];
@@ -197,7 +236,7 @@ export declare const entityFileSchema: {
                 readonly properties: {
                     readonly method: {
                         readonly type: "string";
-                        readonly enum: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"];
+                        readonly enum: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "MUTATION", "QUERY", "SUBSCRIBE", "PUBLISH"];
                         readonly description: "HTTP method of the API operation";
                     };
                     readonly path: {
@@ -223,75 +262,111 @@ export declare const entityFileSchema: {
                 readonly additionalProperties: true;
             };
             readonly key: {
-                type: string;
-                pattern: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly minLength: 2;
+                readonly maxLength: 150;
             };
             readonly title: {
-                type: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly minLength: 3;
+                readonly maxLength: 200;
             };
             readonly summary: {
-                type: string[];
-                minLength: number;
-                maxLength: number;
+                readonly type: readonly ["string", "null"];
+                readonly minLength: 1;
+                readonly maxLength: 500;
             };
             readonly tags: {
-                type: string[];
-                items: {
-                    type: string;
-                    minLength: number;
-                    maxLength: number;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 50;
                 };
             };
             readonly git: {
-                type: string[];
-                items: {
-                    type: string;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
                 };
             };
             readonly contact: {
-                type: string[];
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly slack: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly channels: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly minLength: 3;
+                                                readonly maxLength: 150;
+                                            };
+                                        };
+                                        readonly required: readonly ["name"];
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["channels"];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }];
             };
             readonly links: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        url: {
-                            type: string;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly label: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 150;
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                            };
                         };
+                        readonly required: readonly ["label", "url"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
             readonly relations: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        type: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        key: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];
+                            };
+                            readonly key: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 100;
+                            };
                         };
+                        readonly required: readonly ["type", "key"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
         };
         readonly required: readonly ["key", "title", "type", "metadata"];
@@ -319,75 +394,111 @@ export declare const entityFileSchema: {
                 readonly additionalProperties: true;
             };
             readonly key: {
-                type: string;
-                pattern: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly minLength: 2;
+                readonly maxLength: 150;
             };
             readonly title: {
-                type: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly minLength: 3;
+                readonly maxLength: 200;
             };
             readonly summary: {
-                type: string[];
-                minLength: number;
-                maxLength: number;
+                readonly type: readonly ["string", "null"];
+                readonly minLength: 1;
+                readonly maxLength: 500;
             };
             readonly tags: {
-                type: string[];
-                items: {
-                    type: string;
-                    minLength: number;
-                    maxLength: number;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 50;
                 };
             };
             readonly git: {
-                type: string[];
-                items: {
-                    type: string;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
                 };
             };
             readonly contact: {
-                type: string[];
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly slack: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly channels: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly minLength: 3;
+                                                readonly maxLength: 150;
+                                            };
+                                        };
+                                        readonly required: readonly ["name"];
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["channels"];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }];
             };
             readonly links: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        url: {
-                            type: string;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly label: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 150;
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                            };
                         };
+                        readonly required: readonly ["label", "url"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
             readonly relations: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        type: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        key: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];
+                            };
+                            readonly key: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 100;
+                            };
                         };
+                        readonly required: readonly ["type", "key"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
         };
         readonly required: readonly ["key", "title", "type", "metadata"];
@@ -419,75 +530,111 @@ export declare const entityFileSchema: {
                 readonly additionalProperties: true;
             };
             readonly key: {
-                type: string;
-                pattern: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly minLength: 2;
+                readonly maxLength: 150;
             };
             readonly title: {
-                type: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly minLength: 3;
+                readonly maxLength: 200;
             };
             readonly summary: {
-                type: string[];
-                minLength: number;
-                maxLength: number;
+                readonly type: readonly ["string", "null"];
+                readonly minLength: 1;
+                readonly maxLength: 500;
             };
             readonly tags: {
-                type: string[];
-                items: {
-                    type: string;
-                    minLength: number;
-                    maxLength: number;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 50;
                 };
             };
             readonly git: {
-                type: string[];
-                items: {
-                    type: string;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
                 };
             };
             readonly contact: {
-                type: string[];
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly slack: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly channels: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly minLength: 3;
+                                                readonly maxLength: 150;
+                                            };
+                                        };
+                                        readonly required: readonly ["name"];
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["channels"];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }];
             };
             readonly links: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        url: {
-                            type: string;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly label: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 150;
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                            };
                         };
+                        readonly required: readonly ["label", "url"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
             readonly relations: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        type: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        key: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];
+                            };
+                            readonly key: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 100;
+                            };
                         };
+                        readonly required: readonly ["type", "key"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
         };
         readonly required: readonly ["key", "title", "type", "metadata"];
@@ -503,75 +650,111 @@ export declare const entityFileSchema: {
                 readonly additionalProperties: true;
             };
             readonly key: {
-                type: string;
-                pattern: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly minLength: 2;
+                readonly maxLength: 150;
             };
             readonly title: {
-                type: string;
-                minLength: number;
-                maxLength: number;
+                readonly type: "string";
+                readonly minLength: 3;
+                readonly maxLength: 200;
             };
             readonly summary: {
-                type: string[];
-                minLength: number;
-                maxLength: number;
+                readonly type: readonly ["string", "null"];
+                readonly minLength: 1;
+                readonly maxLength: 500;
             };
             readonly tags: {
-                type: string[];
-                items: {
-                    type: string;
-                    minLength: number;
-                    maxLength: number;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 50;
                 };
             };
             readonly git: {
-                type: string[];
-                items: {
-                    type: string;
+                readonly type: readonly ["array", "null"];
+                readonly items: {
+                    readonly type: "string";
                 };
             };
             readonly contact: {
-                type: string[];
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly slack: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly channels: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly minLength: 3;
+                                                readonly maxLength: 150;
+                                            };
+                                        };
+                                        readonly required: readonly ["name"];
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["channels"];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }];
             };
             readonly links: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        url: {
-                            type: string;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly label: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 150;
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                            };
                         };
+                        readonly required: readonly ["label", "url"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
             readonly relations: {
-                type: string[];
-                items: {
-                    type: string;
-                    properties: {
-                        type: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
-                        };
-                        key: {
-                            type: string;
-                            minLength: number;
-                            maxLength: number;
+                readonly anyOf: readonly [{
+                    readonly type: "null";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy"];
+                            };
+                            readonly key: {
+                                readonly type: "string";
+                                readonly minLength: 3;
+                                readonly maxLength: 100;
+                            };
                         };
+                        readonly required: readonly ["type", "key"];
+                        readonly additionalProperties: false;
                     };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
+                }];
             };
         };
         readonly required: readonly ["key", "title", "type"];