@apistudio/apim-cli
Version:
CLI for API Management Products
1,313 lines (1,312 loc) • 170 kB
TypeScript
export declare const navItemsSchema: {
readonly type: "array";
readonly items: {
readonly properties: {
readonly items: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly page: {
readonly type: "string";
};
readonly directory: {
readonly type: "string";
};
readonly disconnect: {
readonly type: "boolean";
readonly default: false;
};
readonly group: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly href: {
readonly type: "string";
};
readonly external: {
readonly type: "boolean";
};
readonly labelTranslationKey: {
readonly type: "string";
};
readonly groupTranslationKey: {
readonly type: "string";
};
readonly icon: {
readonly oneOf: readonly [{
readonly type: "string";
}, {
readonly type: "object";
readonly properties: {
readonly srcSet: {
readonly type: "string";
};
};
readonly required: readonly ["srcSet"];
}];
};
readonly separator: {
readonly type: "string";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "top";
};
readonly version: {
readonly type: "string";
};
readonly menuStyle: {
readonly type: "string";
readonly enum: readonly ["drilldown"];
};
readonly expanded: {
readonly type: "string";
readonly const: "always";
};
readonly selectFirstItemOnExpand: {
readonly type: "boolean";
};
readonly flatten: {
readonly type: "boolean";
};
readonly linkedSidebars: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly items: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly additionalProperties: true;
};
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
};
};
};
readonly page: {
readonly type: "string";
};
readonly directory: {
readonly type: "string";
};
readonly disconnect: {
readonly type: "boolean";
readonly default: false;
};
readonly group: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly href: {
readonly type: "string";
};
readonly external: {
readonly type: "boolean";
};
readonly labelTranslationKey: {
readonly type: "string";
};
readonly groupTranslationKey: {
readonly type: "string";
};
readonly icon: {
readonly oneOf: readonly [{
readonly type: "string";
}, {
readonly type: "object";
readonly properties: {
readonly srcSet: {
readonly type: "string";
};
};
readonly required: readonly ["srcSet"];
}];
};
readonly separator: {
readonly type: "string";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "top";
};
readonly version: {
readonly type: "string";
};
readonly menuStyle: {
readonly type: "string";
readonly enum: readonly ["drilldown"];
};
readonly expanded: {
readonly type: "string";
readonly const: "always";
};
readonly selectFirstItemOnExpand: {
readonly type: "boolean";
};
readonly flatten: {
readonly type: "boolean";
};
readonly linkedSidebars: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
};
readonly type: "object";
};
};
export declare const productConfigSchema: {
readonly type: "object";
readonly properties: {
readonly name: {
readonly type: "string";
};
readonly icon: {
readonly type: "string";
};
readonly folder: {
readonly type: "string";
};
};
readonly additionalProperties: false;
readonly required: readonly ["name", "folder"];
};
export declare const aiSearchConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
readonly default: false;
};
readonly suggestions: {
readonly default: readonly [];
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly prompt: {
readonly type: "string";
};
};
readonly additionalProperties: false;
};
export declare const searchFacetsConfigSchema: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly required: readonly ["name", "field", "type"];
readonly properties: {
readonly name: {
readonly type: "string";
};
readonly field: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
readonly enum: readonly ["multi-select", "select", "tags"];
};
};
readonly additionalProperties: false;
};
};
export declare const searchFiltersConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly facets: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly required: readonly ["name", "field", "type"];
readonly properties: {
readonly name: {
readonly type: "string";
};
readonly field: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
readonly enum: readonly ["multi-select", "select", "tags"];
};
};
readonly additionalProperties: false;
};
};
};
readonly additionalProperties: false;
};
export declare const logoConfigSchema: {
readonly type: "object";
readonly properties: {
readonly image: {
readonly type: "string";
};
readonly srcSet: {
readonly type: "string";
};
readonly altText: {
readonly type: "string";
};
readonly link: {
readonly type: "string";
};
readonly favicon: {
readonly type: "string";
};
};
readonly additionalProperties: false;
};
export declare const navbarConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly items: {
readonly type: "array";
readonly items: {
readonly properties: {
readonly items: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly page: {
readonly type: "string";
};
readonly directory: {
readonly type: "string";
};
readonly disconnect: {
readonly type: "boolean";
readonly default: false;
};
readonly group: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly href: {
readonly type: "string";
};
readonly external: {
readonly type: "boolean";
};
readonly labelTranslationKey: {
readonly type: "string";
};
readonly groupTranslationKey: {
readonly type: "string";
};
readonly icon: {
readonly oneOf: readonly [{
readonly type: "string";
}, {
readonly type: "object";
readonly properties: {
readonly srcSet: {
readonly type: "string";
};
};
readonly required: readonly ["srcSet"];
}];
};
readonly separator: {
readonly type: "string";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "top";
};
readonly version: {
readonly type: "string";
};
readonly menuStyle: {
readonly type: "string";
readonly enum: readonly ["drilldown"];
};
readonly expanded: {
readonly type: "string";
readonly const: "always";
};
readonly selectFirstItemOnExpand: {
readonly type: "boolean";
};
readonly flatten: {
readonly type: "boolean";
};
readonly linkedSidebars: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly items: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly additionalProperties: true;
};
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
};
};
};
readonly page: {
readonly type: "string";
};
readonly directory: {
readonly type: "string";
};
readonly disconnect: {
readonly type: "boolean";
readonly default: false;
};
readonly group: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly href: {
readonly type: "string";
};
readonly external: {
readonly type: "boolean";
};
readonly labelTranslationKey: {
readonly type: "string";
};
readonly groupTranslationKey: {
readonly type: "string";
};
readonly icon: {
readonly oneOf: readonly [{
readonly type: "string";
}, {
readonly type: "object";
readonly properties: {
readonly srcSet: {
readonly type: "string";
};
};
readonly required: readonly ["srcSet"];
}];
};
readonly separator: {
readonly type: "string";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "top";
};
readonly version: {
readonly type: "string";
};
readonly menuStyle: {
readonly type: "string";
readonly enum: readonly ["drilldown"];
};
readonly expanded: {
readonly type: "string";
readonly const: "always";
};
readonly selectFirstItemOnExpand: {
readonly type: "boolean";
};
readonly flatten: {
readonly type: "boolean";
};
readonly linkedSidebars: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
};
readonly type: "object";
};
};
};
readonly additionalProperties: false;
};
export declare const productsConfigSchema: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "object";
readonly properties: {
readonly name: {
readonly type: "string";
};
readonly icon: {
readonly type: "string";
};
readonly folder: {
readonly type: "string";
};
};
readonly additionalProperties: false;
readonly required: readonly ["name", "folder"];
};
};
export declare const footerConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly items: {
readonly type: "array";
readonly items: {
readonly properties: {
readonly items: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly page: {
readonly type: "string";
};
readonly directory: {
readonly type: "string";
};
readonly disconnect: {
readonly type: "boolean";
readonly default: false;
};
readonly group: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly href: {
readonly type: "string";
};
readonly external: {
readonly type: "boolean";
};
readonly labelTranslationKey: {
readonly type: "string";
};
readonly groupTranslationKey: {
readonly type: "string";
};
readonly icon: {
readonly oneOf: readonly [{
readonly type: "string";
}, {
readonly type: "object";
readonly properties: {
readonly srcSet: {
readonly type: "string";
};
};
readonly required: readonly ["srcSet"];
}];
};
readonly separator: {
readonly type: "string";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "top";
};
readonly version: {
readonly type: "string";
};
readonly menuStyle: {
readonly type: "string";
readonly enum: readonly ["drilldown"];
};
readonly expanded: {
readonly type: "string";
readonly const: "always";
};
readonly selectFirstItemOnExpand: {
readonly type: "boolean";
};
readonly flatten: {
readonly type: "boolean";
};
readonly linkedSidebars: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly items: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly additionalProperties: true;
};
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
};
};
};
readonly page: {
readonly type: "string";
};
readonly directory: {
readonly type: "string";
};
readonly disconnect: {
readonly type: "boolean";
readonly default: false;
};
readonly group: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly href: {
readonly type: "string";
};
readonly external: {
readonly type: "boolean";
};
readonly labelTranslationKey: {
readonly type: "string";
};
readonly groupTranslationKey: {
readonly type: "string";
};
readonly icon: {
readonly oneOf: readonly [{
readonly type: "string";
}, {
readonly type: "object";
readonly properties: {
readonly srcSet: {
readonly type: "string";
};
};
readonly required: readonly ["srcSet"];
}];
};
readonly separator: {
readonly type: "string";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "top";
};
readonly version: {
readonly type: "string";
};
readonly menuStyle: {
readonly type: "string";
readonly enum: readonly ["drilldown"];
};
readonly expanded: {
readonly type: "string";
readonly const: "always";
};
readonly selectFirstItemOnExpand: {
readonly type: "boolean";
};
readonly flatten: {
readonly type: "boolean";
};
readonly linkedSidebars: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
};
readonly type: "object";
};
};
readonly copyrightText: {
readonly type: "string";
};
readonly logo: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
};
readonly additionalProperties: false;
};
};
readonly additionalProperties: false;
};
export declare const sidebarConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly separatorLine: {
readonly type: "boolean";
};
readonly linePosition: {
readonly type: "string";
readonly enum: readonly ["top", "bottom"];
readonly default: "bottom";
};
};
readonly additionalProperties: false;
};
export declare const scriptsConfigSchema: {
readonly type: "object";
readonly properties: {
readonly head: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly src: {
readonly type: "string";
};
readonly async: {
readonly type: "boolean";
};
readonly crossorigin: {
readonly type: "string";
};
readonly defer: {
readonly type: "boolean";
};
readonly fetchpriority: {
readonly type: "string";
};
readonly integrity: {
readonly type: "string";
};
readonly module: {
readonly type: "boolean";
};
readonly nomodule: {
readonly type: "boolean";
};
readonly nonce: {
readonly type: "string";
};
readonly referrerpolicy: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
};
};
readonly required: readonly ["src"];
readonly additionalProperties: true;
};
};
readonly body: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly src: {
readonly type: "string";
};
readonly async: {
readonly type: "boolean";
};
readonly crossorigin: {
readonly type: "string";
};
readonly defer: {
readonly type: "boolean";
};
readonly fetchpriority: {
readonly type: "string";
};
readonly integrity: {
readonly type: "string";
};
readonly module: {
readonly type: "boolean";
};
readonly nomodule: {
readonly type: "boolean";
};
readonly nonce: {
readonly type: "string";
};
readonly referrerpolicy: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
};
};
readonly required: readonly ["src"];
readonly additionalProperties: true;
};
};
};
readonly additionalProperties: false;
};
export declare const linksConfigSchema: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly href: {
readonly type: "string";
};
readonly as: {
readonly type: "string";
};
readonly crossorigin: {
readonly type: "string";
};
readonly fetchpriority: {
readonly type: "string";
};
readonly hreflang: {
readonly type: "string";
};
readonly imagesizes: {
readonly type: "string";
};
readonly imagesrcset: {
readonly type: "string";
};
readonly integrity: {
readonly type: "string";
};
readonly media: {
readonly type: "string";
};
readonly prefetch: {
readonly type: "string";
};
readonly referrerpolicy: {
readonly type: "string";
};
readonly rel: {
readonly type: "string";
};
readonly sizes: {
readonly type: "string";
};
readonly title: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
};
};
readonly required: readonly ["href"];
readonly additionalProperties: true;
};
};
export declare const searchConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly engine: {
readonly type: "string";
readonly enum: readonly ["flexsearch", "typesense"];
readonly default: "flexsearch";
};
readonly ai: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
readonly default: false;
};
readonly suggestions: {
readonly default: readonly [];
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly prompt: {
readonly type: "string";
};
};
readonly additionalProperties: false;
};
readonly filters: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly facets: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly required: readonly ["name", "field", "type"];
readonly properties: {
readonly name: {
readonly type: "string";
};
readonly field: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
readonly enum: readonly ["multi-select", "select", "tags"];
};
};
readonly additionalProperties: false;
};
};
};
readonly additionalProperties: false;
};
readonly placement: {
readonly type: "string";
readonly default: "navbar";
};
readonly shortcuts: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
readonly default: readonly ["/"];
};
readonly suggestedPages: {
readonly type: "array";
readonly items: {
readonly type: "object";
readonly properties: {
readonly page: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
readonly labelTranslationKey: {
readonly type: "string";
};
};
readonly required: readonly ["page"];
};
};
};
readonly additionalProperties: false;
};
export declare const colorModeConfigSchema: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly ignoreDetection: {
readonly type: "boolean";
};
readonly modes: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
readonly default: readonly ["light", "dark"];
};
};
readonly additionalProperties: false;
};
export declare const navigationConfigSchema: {
readonly type: "object";
readonly properties: {
readonly nextButton: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly text: {
readonly type: "string";
readonly default: "Next page";
};
};
readonly additionalProperties: false;
readonly default: {};
};
readonly previousButton: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly text: {
readonly type: "string";
readonly default: "Previous page";
};
};
readonly additionalProperties: false;
readonly default: {};
};
};
readonly additionalProperties: false;
};
export declare const codeSnippetConfigSchema: {
readonly type: "object";
readonly properties: {
readonly elementFormat: {
readonly type: "string";
readonly default: "icon";
};
readonly copy: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
};
readonly additionalProperties: false;
readonly default: {
readonly hide: false;
};
};
readonly report: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly tooltipText: {
readonly type: "string";
};
readonly buttonText: {
readonly type: "string";
};
readonly label: {
readonly type: "string";
};
};
readonly additionalProperties: false;
readonly default: {
readonly hide: false;
};
};
readonly expand: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
};
readonly additionalProperties: false;
readonly default: {
readonly hide: false;
};
};
readonly collapse: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
};
readonly additionalProperties: false;
readonly default: {
readonly hide: false;
};
};
};
readonly additionalProperties: false;
};
export declare const markdownConfigSchema: {
readonly type: "object";
readonly properties: {
readonly frontMatterKeysToResolve: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
readonly default: readonly ["image", "links"];
};
readonly partialsFolders: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
readonly default: readonly ["_partials"];
};
readonly lastUpdatedBlock: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly format: {
readonly type: "string";
readonly enum: readonly ["timeago", "iso", "long", "short"];
readonly default: "timeago";
};
readonly locale: {
readonly type: "string";
};
};
readonly additionalProperties: false;
readonly default: {};
};
readonly toc: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly header: {
readonly type: "string";
readonly default: "On this page";
};
readonly depth: {
readonly type: "integer";
readonly default: 3;
readonly minimum: 1;
};
};
readonly additionalProperties: false;
readonly default: {};
};
readonly editPage: {
readonly type: "object";
readonly properties: {
readonly hide: {
readonly type: "boolean";
};
readonly baseUrl: {
readonly type: "string";
};
};
readonly additionalProperties: false;
readonly default: {};
};
};
readonly additionalProperties: false;
readonly default: {};
};
export declare const openapiConfigSchema: {
readonly properties: {
readonly theme: {
readonly type: "object";
readonly properties: {
readonly breakpoints: {
readonly type: "object";
readonly properties: {
readonly small: {
readonly type: "string";
};
readonly medium: {
readonly type: "string";
};
readonly large: {
readonly type: "string";
};
};
};
readonly codeBlock: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";
};
readonly borderRadius: {
readonly type: "string";
};
readonly tokens: {
readonly type: "object";
readonly properties: {
readonly fontFamily: {
readonly type: "string";
};
readonly fontSize: {
readonly type: "string";
};
readonly fontWeight: {
readonly type: "string";
};
readonly lineHeight: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
};
};
};
};
readonly colors: {
readonly type: "object";
readonly properties: {
readonly accent: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly border: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly error: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly http: {
readonly type: "object";
readonly properties: {
readonly basic: {
readonly type: "string";
};
readonly delete: {
readonly type: "string";
};
readonly get: {
readonly type: "string";
};
readonly head: {
readonly type: "string";
};
readonly link: {
readonly type: "string";
};
readonly options: {
readonly type: "string";
};
readonly patch: {
readonly type: "string";
};
readonly post: {
readonly type: "string";
};
readonly put: {
readonly type: "string";
};
};
};
readonly primary: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly responses: {
readonly type: "object";