@redocly/config 0.5.0 → 0.6.1

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

@@ -338,6 +338,7 @@ export declare const catalogFilterSchema: {
         readonly type: {
             readonly type: "string";
             readonly enum: readonly ["select", "checkboxes", "date-range"];
+            readonly default: "checkboxes";
         };
         readonly title: {
             readonly type: "string";
@@ -472,6 +473,7 @@ export declare const catalogSchema: {
                     readonly type: {
                         readonly type: "string";
                         readonly enum: readonly ["select", "checkboxes", "date-range"];
+                        readonly default: "checkboxes";
                     };
                     readonly title: {
                         readonly type: "string";
@@ -1474,7 +1476,7 @@ export declare const themeConfigSchema: {
                         };
                         readonly text: {
                             readonly type: "string";
-                            readonly default: "Next to {{label}}";
+                            readonly default: "Next page";
                         };
                     };
                     readonly additionalProperties: false;
@@ -1488,7 +1490,7 @@ export declare const themeConfigSchema: {
                         };
                         readonly text: {
                             readonly type: "string";
-                            readonly default: "Back to {{label}}";
+                            readonly default: "Previous page";
                         };
                     };
                     readonly additionalProperties: false;
@@ -1639,11 +1641,604 @@ export declare const themeConfigSchema: {
         };
         readonly openapi: {
             readonly type: "object";
-            readonly additionalProperties: true;
+            readonly properties: {
+                readonly licenseKey: {
+                    readonly type: "string";
+                };
+                readonly hideLoading: {
+                    readonly type: "boolean";
+                };
+                readonly disableRouter: {
+                    readonly type: "boolean";
+                };
+                readonly hideSidebar: {
+                    readonly type: "boolean";
+                };
+                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 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 additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly default: null;
+                    readonly nullable: true;
+                };
+                readonly hideReplay: {
+                    readonly type: "boolean";
+                };
+                readonly oAuth2RedirectURI: {
+                    readonly type: "string";
+                    readonly nullable: true;
+                };
+                readonly corsProxyUrl: {
+                    readonly type: "string";
+                };
+                readonly sortRequiredPropsFirst: {
+                    readonly type: "boolean";
+                };
+                readonly sanitize: {
+                    readonly type: "boolean";
+                };
+                readonly hideDownloadButtons: {
+                    readonly type: "boolean";
+                };
+                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 onlyRequiredInSamples: {
+                    readonly type: "boolean";
+                };
+                readonly generatedSamplesMaxDepth: {
+                    readonly oneOf: readonly [{
+                        readonly type: "number";
+                    }, {
+                        readonly type: "string";
+                    }];
+                };
+                readonly showExtensions: {
+                    readonly oneOf: readonly [{
+                        readonly type: "boolean";
+                    }, {
+                        readonly type: "string";
+                    }, {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    }];
+                };
+                readonly hideSchemaTitles: {
+                    readonly type: "boolean";
+                };
+                readonly jsonSamplesExpandLevel: {
+                    readonly oneOf: readonly [{
+                        readonly type: "number";
+                    }, {
+                        readonly type: "string";
+                    }];
+                };
+                readonly schemasExpansionLevel: {
+                    readonly oneOf: readonly [{
+                        readonly type: "number";
+                    }, {
+                        readonly type: "string";
+                    }];
+                };
+                readonly mockServer: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly url: {
+                            readonly type: "string";
+                        };
+                        readonly position: {
+                            readonly enum: readonly ["first", "last", "replace", "off"];
+                        };
+                        readonly description: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly maxDisplayedEnumValues: {
+                    readonly type: "number";
+                };
+                readonly schemaDefinitionsTagName: {
+                    readonly type: "string";
+                };
+                readonly layout: {
+                    readonly type: "string";
+                    readonly enum: readonly ["stacked", "three-panel"];
+                };
+                readonly hideInfoMetadata: {
+                    readonly type: "boolean";
+                };
+                readonly events: {
+                    readonly type: "object";
+                };
+                readonly skipBundle: {
+                    readonly type: "boolean";
+                };
+                readonly routingBasePath: {
+                    readonly type: "string";
+                };
+                readonly codeSamples: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly languages: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly lang: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["curl", "JavaScript", "Node.js", "Python", "Java8+Apache", "Java", "C#", "C#+Newtonsoft", "PHP", "Go", "Ruby", "R", "Payload"];
+                                    };
+                                    readonly label: {
+                                        readonly type: "string";
+                                    };
+                                    readonly options: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly indent: {
+                                                readonly type: "string";
+                                            };
+                                            readonly withImports: {
+                                                readonly type: "boolean";
+                                            };
+                                            readonly withComments: {
+                                                readonly type: "boolean";
+                                            };
+                                            readonly binary: {
+                                                readonly type: "boolean";
+                                            };
+                                            readonly credentials: {
+                                                readonly type: "string";
+                                                readonly enum: readonly ["omit", "same-origin", "include"];
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                                readonly required: readonly ["lang"];
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly skipOptionalParameters: {
+                            readonly type: "boolean";
+                        };
+                        readonly withOAuth2Call: {
+                            readonly type: "boolean";
+                        };
+                    };
+                    readonly required: readonly ["languages"];
+                    readonly additionalProperties: false;
+                };
+                readonly ignoreNamedSchemas: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    }, {
+                        readonly type: "string";
+                    }];
+                };
+                readonly hidePropertiesPrefix: {
+                    readonly type: "boolean";
+                };
+                readonly excludeFromSearch: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly additionalProperties: false;
         };
         readonly graphql: {
             readonly type: "object";
-            readonly additionalProperties: true;
+            readonly properties: {
+                readonly pagination: {
+                    readonly type: "string";
+                    readonly enum: readonly ["none", "section", "item"];
+                };
+                readonly navigation: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly contentPrefix: {
+                            readonly type: "string";
+                        };
+                        readonly menuPrefix: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly hidePaginationButtons: {
+                    readonly type: "boolean";
+                };
+                readonly menu: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly requireExactGroups: {
+                            readonly type: "boolean";
+                        };
+                        readonly groups: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly name: {
+                                        readonly type: "string";
+                                    };
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly queries: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly mutations: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly subscriptions: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly types: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly directives: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                                readonly required: readonly ["name"];
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly otherItemsGroupName: {
+                            readonly type: "string";
+                        };
+                        readonly initialLoadState: {
+                            readonly type: "string";
+                            readonly enum: readonly ["all-expanded", "default"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly sidebar: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                        };
+                    };
+                };
+                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 jsonSamplesExpandLevel: {
+                    readonly type: "number";
+                };
+                readonly sampleMaxInlineArgs: {
+                    readonly type: "number";
+                };
+                readonly licenseKey: {
+                    readonly type: "string";
+                };
+                readonly fieldExpandLevel: {
+                    readonly type: "number";
+                };
+                readonly baseUrlPath: {
+                    readonly type: "string";
+                };
+                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 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 additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly default: null;
+                    readonly nullable: true;
+                };
+            };
+            readonly additionalProperties: false;
         };
         readonly analytics: {
             readonly type: "object";
@@ -1883,21 +2478,13 @@ export declare const themeConfigSchema: {
                 };
             };
         };
-        readonly userProfile: {
+        readonly userMenu: {
             readonly type: "object";
             readonly properties: {
                 readonly hide: {
                     readonly type: "boolean";
                 };
-                readonly loginLabel: {
-                    readonly type: "string";
-                    readonly default: "Login";
-                };
-                readonly logoutLabel: {
-                    readonly type: "string";
-                    readonly default: "Logout";
-                };
-                readonly menu: {
+                readonly items: {
                     readonly type: "array";
                     readonly items: {
                         readonly type: "object";
@@ -1919,6 +2506,9 @@ export declare const themeConfigSchema: {
                     };
                     readonly default: readonly [];
                 };
+                readonly hideLoginButton: {
+                    readonly type: "boolean";
+                };
             };
             readonly additionalProperties: false;
             readonly default: {};
@@ -1984,6 +2574,7 @@ export declare const themeConfigSchema: {
                                     readonly type: {
                                         readonly type: "string";
                                         readonly enum: readonly ["select", "checkboxes", "date-range"];
+                                        readonly default: "checkboxes";
                                     };
                                     readonly title: {
                                         readonly type: "string";