@redocly/config 0.44.0 → 0.44.2

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

@@ -6878,6 +6878,9 @@ export declare const redoclyConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
         readonly sso: {
             readonly oneOf: readonly [{
                 readonly type: "array";
@@ -6891,10 +6894,16 @@ export declare const redoclyConfigSchema: {
                 readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
             }];
         };
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
         readonly residency: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
         readonly logoutReturnUrl: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
@@ -10443,6 +10452,306 @@ export declare const redoclyConfigSchema: {
                     readonly type: "object";
                     readonly additionalProperties: false;
                 };
+                readonly asyncapi: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly downloadUrls: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly title: {
+                                        readonly type: "string";
+                                    };
+                                    readonly url: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly required: readonly ["url"];
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly apiLogo: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly imageUrl: {
+                                    readonly type: "string";
+                                };
+                                readonly href: {
+                                    readonly type: "string";
+                                };
+                                readonly altText: {
+                                    readonly type: "string";
+                                };
+                                readonly backgroundColor: {
+                                    readonly type: "string";
+                                };
+                            };
+                        };
+                        readonly jsonSamplesDepth: {
+                            readonly type: "number";
+                        };
+                        readonly samplesMaxInlineArgs: {
+                            readonly type: "number";
+                        };
+                        readonly fieldExpandLevel: {
+                            readonly type: "number";
+                        };
+                        readonly baseUrlPath: {
+                            readonly type: "string";
+                        };
+                        readonly metadata: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly apiId: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: true;
+                        };
+                        readonly feedback: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly type: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
+                                    readonly default: "sentiment";
+                                };
+                                readonly settings: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly submitText: {
+                                            readonly type: "string";
+                                        };
+                                        readonly buttonText: {
+                                            readonly type: "string";
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                            readonly minItems: 1;
+                                        };
+                                        readonly leftScaleLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly rightScaleLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly reasons: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly like: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly dislike: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly satisfied: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly neutral: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly dissatisfied: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly comment: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly likeLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly dislikeLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly satisfiedLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly neutralLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly dissatisfiedLabel: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly optionalEmail: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly placeholder: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly layout: {
+                            readonly type: "string";
+                            readonly enum: readonly ["stacked", "three-panel"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
                 readonly graphql: {
                     readonly type: "object";
                     readonly properties: {
@@ -21246,6 +21555,9 @@ export declare const redoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
         readonly rbac: {
             readonly type: "object";
             readonly properties: {
@@ -21484,6 +21796,9 @@ export declare const redoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
         readonly requiresLogin: {
             readonly type: "boolean";
         };
@@ -28075,6 +28390,152 @@ export declare const rootRedoclyConfigSchema: {
                                 additionalProperties: false;
                                 type: "object";
                             };
+                            asyncapi: {
+                                properties: {
+                                    layout: {
+                                        enum: ("stacked" | "three-panel")[];
+                                        type: "string";
+                                    };
+                                    metadata: {
+                                        properties: {
+                                            apiId: {
+                                                type: "string";
+                                            };
+                                        };
+                                        additionalProperties: true;
+                                        type: "object";
+                                    };
+                                    feedback: {
+                                        properties: {
+                                            type: {
+                                                enum: ("rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale")[];
+                                                type: "string";
+                                            };
+                                            hide: {
+                                                type: "boolean";
+                                            };
+                                            settings: {
+                                                properties: {
+                                                    comment: {
+                                                        properties: {
+                                                            label: /*elided*/ any;
+                                                            hide: /*elided*/ any;
+                                                            likeLabel: /*elided*/ any;
+                                                            dislikeLabel: /*elided*/ any;
+                                                            satisfiedLabel: /*elided*/ any;
+                                                            neutralLabel: /*elided*/ any;
+                                                            dissatisfiedLabel: /*elided*/ any;
+                                                        };
+                                                        additionalProperties: false;
+                                                        type: "object";
+                                                    };
+                                                    reasons: {
+                                                        properties: {
+                                                            label: /*elided*/ any;
+                                                            items: /*elided*/ any;
+                                                            hide: /*elided*/ any;
+                                                            component: /*elided*/ any;
+                                                            like: /*elided*/ any;
+                                                            dislike: /*elided*/ any;
+                                                            satisfied: /*elided*/ any;
+                                                            neutral: /*elided*/ any;
+                                                            dissatisfied: /*elided*/ any;
+                                                        };
+                                                        additionalProperties: false;
+                                                        type: "object";
+                                                    };
+                                                    label: {
+                                                        type: "string";
+                                                    };
+                                                    items: {
+                                                        items: {
+                                                            type: "string";
+                                                        };
+                                                        type: "array";
+                                                        minItems: 1;
+                                                    };
+                                                    submitText: {
+                                                        type: "string";
+                                                    };
+                                                    buttonText: {
+                                                        type: "string";
+                                                    };
+                                                    component: {
+                                                        enum: ("radio" | "checkbox")[];
+                                                        type: "string";
+                                                    };
+                                                    leftScaleLabel: {
+                                                        type: "string";
+                                                    };
+                                                    rightScaleLabel: {
+                                                        type: "string";
+                                                    };
+                                                    optionalEmail: {
+                                                        properties: {
+                                                            label: /*elided*/ any;
+                                                            hide: /*elided*/ any;
+                                                            placeholder: /*elided*/ any;
+                                                        };
+                                                        additionalProperties: false;
+                                                        type: "object";
+                                                    };
+                                                };
+                                                additionalProperties: false;
+                                                type: "object";
+                                            };
+                                        };
+                                        additionalProperties: false;
+                                        type: "object";
+                                    };
+                                    downloadUrls: {
+                                        items: {
+                                            properties: {
+                                                url: {
+                                                    type: "string";
+                                                };
+                                                title: {
+                                                    type: "string";
+                                                };
+                                            };
+                                            additionalProperties: false;
+                                            type: "object";
+                                            required: "url"[];
+                                        };
+                                        type: "array";
+                                    };
+                                    apiLogo: {
+                                        properties: {
+                                            backgroundColor: {
+                                                type: "string";
+                                            };
+                                            href: {
+                                                type: "string";
+                                            };
+                                            imageUrl: {
+                                                type: "string";
+                                            };
+                                            altText: {
+                                                type: "string";
+                                            };
+                                        };
+                                        type: "object";
+                                    };
+                                    jsonSamplesDepth: {
+                                        type: "number";
+                                    };
+                                    samplesMaxInlineArgs: {
+                                        type: "number";
+                                    };
+                                    fieldExpandLevel: {
+                                        type: "number";
+                                    };
+                                    baseUrlPath: {
+                                        type: "string";
+                                    };
+                                };
+                                additionalProperties: false;
+                                type: "object";
+                            };
                             graphql: {
                                 properties: {
                                     layout: {
@@ -40139,6 +40600,9 @@ export declare const rootRedoclyConfigSchema: {
                 };
             };
         };
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
         readonly sso: {
             readonly oneOf: readonly [{
                 readonly type: "array";
@@ -40152,10 +40616,16 @@ export declare const rootRedoclyConfigSchema: {
                 readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
             }];
         };
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
         readonly residency: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
         readonly logoutReturnUrl: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
@@ -43704,6 +44174,306 @@ export declare const rootRedoclyConfigSchema: {
                     readonly type: "object";
                     readonly additionalProperties: false;
                 };
+                readonly asyncapi: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly downloadUrls: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly title: {
+                                        readonly type: "string";
+                                    };
+                                    readonly url: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly required: readonly ["url"];
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly apiLogo: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly imageUrl: {
+                                    readonly type: "string";
+                                };
+                                readonly href: {
+                                    readonly type: "string";
+                                };
+                                readonly altText: {
+                                    readonly type: "string";
+                                };
+                                readonly backgroundColor: {
+                                    readonly type: "string";
+                                };
+                            };
+                        };
+                        readonly jsonSamplesDepth: {
+                            readonly type: "number";
+                        };
+                        readonly samplesMaxInlineArgs: {
+                            readonly type: "number";
+                        };
+                        readonly fieldExpandLevel: {
+                            readonly type: "number";
+                        };
+                        readonly baseUrlPath: {
+                            readonly type: "string";
+                        };
+                        readonly metadata: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly apiId: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: true;
+                        };
+                        readonly feedback: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly type: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
+                                    readonly default: "sentiment";
+                                };
+                                readonly settings: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly submitText: {
+                                            readonly type: "string";
+                                        };
+                                        readonly buttonText: {
+                                            readonly type: "string";
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                            readonly minItems: 1;
+                                        };
+                                        readonly leftScaleLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly rightScaleLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly reasons: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly like: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly dislike: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly satisfied: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly neutral: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly dissatisfied: {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly hide: {
+                                                            readonly type: "boolean";
+                                                            readonly default: false;
+                                                        };
+                                                        readonly component: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["radio", "checkbox"];
+                                                            readonly default: "checkbox";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly items: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly additionalProperties: false;
+                                                };
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly comment: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly likeLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly dislikeLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly satisfiedLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly neutralLabel: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly dissatisfiedLabel: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly optionalEmail: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly placeholder: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly layout: {
+                            readonly type: "string";
+                            readonly enum: readonly ["stacked", "three-panel"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
                 readonly graphql: {
                     readonly type: "object";
                     readonly properties: {
@@ -54507,6 +55277,9 @@ export declare const rootRedoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
         readonly rbac: {
             readonly type: "object";
             readonly properties: {
@@ -54745,6 +55518,9 @@ export declare const rootRedoclyConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
         readonly requiresLogin: {
             readonly type: "boolean";
         };