@apistudio/apim-cli
Version:
CLI for API Management Products
434 lines (433 loc) • 19.4 kB
TypeScript
export declare const redocConfigSchema: {
readonly type: "object";
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 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 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 type: "string";
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;
};