import { AutorestNormalizedConfiguration } from "../autorest-normalized-configuration"; import { ConfigurationSchemaProcessor } from "./processor"; import { RawConfiguration } from "./types"; export declare const AUTOREST_CONFIGURATION_CATEGORIES: { logging: { name: string; }; installation: { name: string; }; core: { name: string; }; feature: { name: string; }; extensions: { name: string; description: string; }; }; export declare const SUPPORTED_EXTENSIONS_SCHEMA: { readonly csharp: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate C# client code"; }; readonly go: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Go client code"; }; readonly java: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Java client code"; }; readonly python: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Python client code"; }; readonly az: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Az cli code"; }; readonly typescript: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate TypeScript client code"; }; readonly azureresourceschema: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Azurer resource schemas"; }; readonly "model-validator": { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Validates an OpenAPI document against linked examples (see https://github.com/Azure/azure-rest-api-specs/search?q=x-ms-examples "; }; readonly "azure-validator": { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Validates an OpenAPI document against guidelines to improve quality (and optionally Azure guidelines)"; }; }; export declare const AUTOREST_CONFIGURATION_SCHEMA: { /** * Verbosity category */ readonly verbose: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display verbose logging information"; }; readonly debug: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display debug logging information"; }; readonly level: { readonly type: "string"; readonly category: "logging"; readonly enum: readonly ["debug", "verbose", "information", "warning", "error", "fatal"]; readonly description: "Set logging level"; }; readonly "message-format": { readonly type: "string"; readonly category: "logging"; readonly description: "Format of logging messages"; readonly enum: readonly ["json", "regular"]; }; /** * Manage installation category */ readonly info: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display information about the installed version of autorest and its extensions"; }; readonly "list-available": { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display available AutoRest versions"; }; readonly reset: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Removes all autorest extensions and downloads the latest version of the autorest-core extension"; }; readonly preview: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Enables using autorest extensions that are not yet released"; }; readonly latest: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Install the latest autorest-core extension"; }; readonly force: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Force the re-installation of the autorest-core extension and frameworks"; }; readonly version: { readonly type: "string"; readonly category: "installation"; readonly description: "Use the specified version of the autorest-core extension"; }; readonly use: { readonly type: "array"; readonly category: "installation"; readonly items: { readonly type: "string"; }; readonly description: "Specify an extension to load and use. Format: --use=[@] (e.g. --use=@autorest/modelerfour@~4.19.0)"; }; readonly "use-extension": { readonly type: "dictionary"; readonly category: "installation"; readonly description: "Specify extension to load and use. Format: {\"\": \"\"}"; readonly items: { readonly type: "string"; }; }; /** * Core settings */ readonly help: { readonly type: "boolean"; readonly category: "core"; readonly description: "Display help (combine with flags like --csharp to get further details about specific functionality)"; }; readonly memory: { readonly type: "string"; readonly category: "core"; readonly description: "Configure max memory allowed for autorest process(s)"; }; readonly "input-file": { readonly type: "array"; readonly category: "core"; readonly description: "OpenAPI file to use as input (use this setting repeatedly to pass multiple files at once)"; readonly items: { readonly type: "string"; }; }; readonly "output-folder": { readonly type: "string"; readonly category: "core"; readonly description: "Target folder for generated artifacts; default: \"/generated\""; }; readonly "github-auth-token": { readonly type: "string"; readonly category: "core"; readonly description: "OAuth token to use when pointing AutoRest at files living in a private GitHub repository"; }; readonly "azure-arm": { readonly type: "boolean"; readonly category: "core"; readonly description: "Generate code in Azure flavor"; }; readonly "header-text": { readonly type: "string"; readonly category: "core"; readonly description: "Text to include as a header comment in generated files (magic strings:MICROSOFTMIT, MICROSOFT_APACHE, MICROSOFT_MIT_NO_VERSION, MICROSOFT_APACHE_NO_VERSION, MICROSOFT_MIT_NOCODEGEN)"; }; readonly "openapi-type": { readonly type: "string"; readonly category: "core"; readonly description: "Open API Type: \"arm\" or \"data-plane\""; }; readonly "output-converted-oai3": { readonly type: "boolean"; readonly category: "core"; readonly description: "If enabled and the input-files are swager 2.0 this will output the resulting OpenAPI3.0 converted files to the output-folder"; }; readonly eol: { readonly type: "string"; readonly category: "core"; readonly enum: readonly ["default", "lf", "crlf"]; readonly description: "Change the end of line character for generated output."; }; readonly title: { readonly type: "string"; readonly category: "core"; readonly description: "Override the service client's name listed in the swagger under title."; }; readonly "override-client-name": { readonly type: "string"; readonly category: "core"; readonly description: "Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files"; }; readonly directive: { readonly type: "array"; readonly category: "core"; readonly items: { readonly type: "object"; readonly properties: { readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly suppress: { readonly type: "array"; readonly deprecated: true; readonly items: { readonly type: "string"; }; }; readonly transform: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "text-transform": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly test: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly debug: { readonly type: "boolean"; readonly description: "Debug this directive. When set to true autorest will log additional information regarding that directive."; }; }; }; }; readonly require: { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to include."; readonly items: { readonly type: "string"; }; }; readonly "try-require": { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to try to include. Will not fail if the configuration file doesn't exist."; readonly items: { readonly type: "string"; readonly description: "Additional configuration files to include."; }; }; readonly "declare-directive": { readonly type: "dictionary"; readonly category: "core"; readonly description: "Declare some reusable directives (https://github.com/Azure/autorest/blob/main/packages/libs/configuration/resources/directives.md#how-it-works)"; readonly items: { readonly type: "string"; }; }; readonly "output-artifact": { readonly type: "array"; readonly category: "core"; readonly description: "Additional artifact type to emit to the output-folder"; readonly items: { readonly type: "string"; }; }; readonly "allow-no-input": { readonly type: "boolean"; }; readonly "exclude-file": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "base-folder": { readonly type: "string"; }; readonly stats: { readonly type: "boolean"; readonly category: "core"; readonly description: "Output some statistics about current autorest run."; }; readonly profile: { readonly type: "array"; readonly category: "core"; readonly description: "Reserved for future use."; readonly items: { readonly type: "string"; }; }; readonly suppressions: { readonly type: "array"; readonly category: "core"; readonly description: "List of warning/error code to ignore."; readonly items: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; }; readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly where: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "string"; }; }; }; }; readonly "output-file": { readonly type: "string"; }; /** * Feature flags */ readonly "deduplicate-inline-models": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Deduplicate inline models"; }; readonly "include-x-ms-examples-original-file": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Include x-ms-original-file property in x-ms-examples"; }; /** * Ignore. */ readonly "pass-thru": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; export type AutorestRawConfiguration = RawConfiguration & { [key: string]: any; }; export declare const AUTOREST_CONFIGURATION_DEFINITION: { categories: { logging: { name: string; }; installation: { name: string; }; core: { name: string; }; feature: { name: string; }; extensions: { name: string; description: string; }; }; schema: { /** * Verbosity category */ readonly verbose: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display verbose logging information"; }; readonly debug: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display debug logging information"; }; readonly level: { readonly type: "string"; readonly category: "logging"; readonly enum: readonly ["debug", "verbose", "information", "warning", "error", "fatal"]; readonly description: "Set logging level"; }; readonly "message-format": { readonly type: "string"; readonly category: "logging"; readonly description: "Format of logging messages"; readonly enum: readonly ["json", "regular"]; }; /** * Manage installation category */ readonly info: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display information about the installed version of autorest and its extensions"; }; readonly "list-available": { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display available AutoRest versions"; }; readonly reset: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Removes all autorest extensions and downloads the latest version of the autorest-core extension"; }; readonly preview: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Enables using autorest extensions that are not yet released"; }; readonly latest: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Install the latest autorest-core extension"; }; readonly force: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Force the re-installation of the autorest-core extension and frameworks"; }; readonly version: { readonly type: "string"; readonly category: "installation"; readonly description: "Use the specified version of the autorest-core extension"; }; readonly use: { readonly type: "array"; readonly category: "installation"; readonly items: { readonly type: "string"; }; readonly description: "Specify an extension to load and use. Format: --use=[@] (e.g. --use=@autorest/modelerfour@~4.19.0)"; }; readonly "use-extension": { readonly type: "dictionary"; readonly category: "installation"; readonly description: "Specify extension to load and use. Format: {\"\": \"\"}"; readonly items: { readonly type: "string"; }; }; /** * Core settings */ readonly help: { readonly type: "boolean"; readonly category: "core"; readonly description: "Display help (combine with flags like --csharp to get further details about specific functionality)"; }; readonly memory: { readonly type: "string"; readonly category: "core"; readonly description: "Configure max memory allowed for autorest process(s)"; }; readonly "input-file": { readonly type: "array"; readonly category: "core"; readonly description: "OpenAPI file to use as input (use this setting repeatedly to pass multiple files at once)"; readonly items: { readonly type: "string"; }; }; readonly "output-folder": { readonly type: "string"; readonly category: "core"; readonly description: "Target folder for generated artifacts; default: \"/generated\""; }; readonly "github-auth-token": { readonly type: "string"; readonly category: "core"; readonly description: "OAuth token to use when pointing AutoRest at files living in a private GitHub repository"; }; readonly "azure-arm": { readonly type: "boolean"; readonly category: "core"; readonly description: "Generate code in Azure flavor"; }; readonly "header-text": { readonly type: "string"; readonly category: "core"; readonly description: "Text to include as a header comment in generated files (magic strings:MICROSOFTMIT, MICROSOFT_APACHE, MICROSOFT_MIT_NO_VERSION, MICROSOFT_APACHE_NO_VERSION, MICROSOFT_MIT_NOCODEGEN)"; }; readonly "openapi-type": { readonly type: "string"; readonly category: "core"; readonly description: "Open API Type: \"arm\" or \"data-plane\""; }; readonly "output-converted-oai3": { readonly type: "boolean"; readonly category: "core"; readonly description: "If enabled and the input-files are swager 2.0 this will output the resulting OpenAPI3.0 converted files to the output-folder"; }; readonly eol: { readonly type: "string"; readonly category: "core"; readonly enum: readonly ["default", "lf", "crlf"]; readonly description: "Change the end of line character for generated output."; }; readonly title: { readonly type: "string"; readonly category: "core"; readonly description: "Override the service client's name listed in the swagger under title."; }; readonly "override-client-name": { readonly type: "string"; readonly category: "core"; readonly description: "Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files"; }; readonly directive: { readonly type: "array"; readonly category: "core"; readonly items: { readonly type: "object"; readonly properties: { readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly suppress: { readonly type: "array"; readonly deprecated: true; readonly items: { readonly type: "string"; }; }; readonly transform: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "text-transform": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly test: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly debug: { readonly type: "boolean"; readonly description: "Debug this directive. When set to true autorest will log additional information regarding that directive."; }; }; }; }; readonly require: { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to include."; readonly items: { readonly type: "string"; }; }; readonly "try-require": { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to try to include. Will not fail if the configuration file doesn't exist."; readonly items: { readonly type: "string"; readonly description: "Additional configuration files to include."; }; }; readonly "declare-directive": { readonly type: "dictionary"; readonly category: "core"; readonly description: "Declare some reusable directives (https://github.com/Azure/autorest/blob/main/packages/libs/configuration/resources/directives.md#how-it-works)"; readonly items: { readonly type: "string"; }; }; readonly "output-artifact": { readonly type: "array"; readonly category: "core"; readonly description: "Additional artifact type to emit to the output-folder"; readonly items: { readonly type: "string"; }; }; readonly "allow-no-input": { readonly type: "boolean"; }; readonly "exclude-file": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "base-folder": { readonly type: "string"; }; readonly stats: { readonly type: "boolean"; readonly category: "core"; readonly description: "Output some statistics about current autorest run."; }; readonly profile: { readonly type: "array"; readonly category: "core"; readonly description: "Reserved for future use."; readonly items: { readonly type: "string"; }; }; readonly suppressions: { readonly type: "array"; readonly category: "core"; readonly description: "List of warning/error code to ignore."; readonly items: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; }; readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly where: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "string"; }; }; }; }; readonly "output-file": { readonly type: "string"; }; /** * Feature flags */ readonly "deduplicate-inline-models": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Deduplicate inline models"; }; readonly "include-x-ms-examples-original-file": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Include x-ms-original-file property in x-ms-examples"; }; /** * Ignore. */ readonly "pass-thru": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; }; export declare const AUTOREST_CONFIGURATION_DEFINITION_FOR_HELP: { categories: { logging: { name: string; }; installation: { name: string; }; core: { name: string; }; feature: { name: string; }; extensions: { name: string; description: string; }; }; schema: { csharp: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate C# client code"; }; go: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Go client code"; }; java: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Java client code"; }; python: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Python client code"; }; az: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Az cli code"; }; typescript: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate TypeScript client code"; }; azureresourceschema: { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Generate Azurer resource schemas"; }; "model-validator": { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Validates an OpenAPI document against linked examples (see https://github.com/Azure/azure-rest-api-specs/search?q=x-ms-examples "; }; "azure-validator": { readonly type: "boolean"; readonly category: "extensions"; readonly description: "Validates an OpenAPI document against guidelines to improve quality (and optionally Azure guidelines)"; }; verbose: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display verbose logging information"; }; debug: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display debug logging information"; }; level: { readonly type: "string"; readonly category: "logging"; readonly enum: readonly ["debug", "verbose", "information", "warning", "error", "fatal"]; readonly description: "Set logging level"; }; "message-format": { readonly type: "string"; readonly category: "logging"; readonly description: "Format of logging messages"; readonly enum: readonly ["json", "regular"]; }; info: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display information about the installed version of autorest and its extensions"; }; "list-available": { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display available AutoRest versions"; }; reset: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Removes all autorest extensions and downloads the latest version of the autorest-core extension"; }; preview: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Enables using autorest extensions that are not yet released"; }; latest: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Install the latest autorest-core extension"; }; force: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Force the re-installation of the autorest-core extension and frameworks"; }; version: { readonly type: "string"; readonly category: "installation"; readonly description: "Use the specified version of the autorest-core extension"; }; use: { readonly type: "array"; readonly category: "installation"; readonly items: { readonly type: "string"; }; readonly description: "Specify an extension to load and use. Format: --use=[@] (e.g. --use=@autorest/modelerfour@~4.19.0)"; }; "use-extension": { readonly type: "dictionary"; readonly category: "installation"; readonly description: "Specify extension to load and use. Format: {\"\": \"\"}"; readonly items: { readonly type: "string"; }; }; help: { readonly type: "boolean"; readonly category: "core"; readonly description: "Display help (combine with flags like --csharp to get further details about specific functionality)"; }; memory: { readonly type: "string"; readonly category: "core"; readonly description: "Configure max memory allowed for autorest process(s)"; }; "input-file": { readonly type: "array"; readonly category: "core"; readonly description: "OpenAPI file to use as input (use this setting repeatedly to pass multiple files at once)"; readonly items: { readonly type: "string"; }; }; "output-folder": { readonly type: "string"; readonly category: "core"; readonly description: "Target folder for generated artifacts; default: \"/generated\""; }; "github-auth-token": { readonly type: "string"; readonly category: "core"; readonly description: "OAuth token to use when pointing AutoRest at files living in a private GitHub repository"; }; "azure-arm": { readonly type: "boolean"; readonly category: "core"; readonly description: "Generate code in Azure flavor"; }; "header-text": { readonly type: "string"; readonly category: "core"; readonly description: "Text to include as a header comment in generated files (magic strings:MICROSOFTMIT, MICROSOFT_APACHE, MICROSOFT_MIT_NO_VERSION, MICROSOFT_APACHE_NO_VERSION, MICROSOFT_MIT_NOCODEGEN)"; }; "openapi-type": { readonly type: "string"; readonly category: "core"; readonly description: "Open API Type: \"arm\" or \"data-plane\""; }; "output-converted-oai3": { readonly type: "boolean"; readonly category: "core"; readonly description: "If enabled and the input-files are swager 2.0 this will output the resulting OpenAPI3.0 converted files to the output-folder"; }; eol: { readonly type: "string"; readonly category: "core"; readonly enum: readonly ["default", "lf", "crlf"]; readonly description: "Change the end of line character for generated output."; }; title: { readonly type: "string"; readonly category: "core"; readonly description: "Override the service client's name listed in the swagger under title."; }; "override-client-name": { readonly type: "string"; readonly category: "core"; readonly description: "Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files"; }; directive: { readonly type: "array"; readonly category: "core"; readonly items: { readonly type: "object"; readonly properties: { readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly suppress: { readonly type: "array"; readonly deprecated: true; readonly items: { readonly type: "string"; }; }; readonly transform: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "text-transform": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly test: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly debug: { readonly type: "boolean"; readonly description: "Debug this directive. When set to true autorest will log additional information regarding that directive."; }; }; }; }; require: { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to include."; readonly items: { readonly type: "string"; }; }; "try-require": { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to try to include. Will not fail if the configuration file doesn't exist."; readonly items: { readonly type: "string"; readonly description: "Additional configuration files to include."; }; }; "declare-directive": { readonly type: "dictionary"; readonly category: "core"; readonly description: "Declare some reusable directives (https://github.com/Azure/autorest/blob/main/packages/libs/configuration/resources/directives.md#how-it-works)"; readonly items: { readonly type: "string"; }; }; "output-artifact": { readonly type: "array"; readonly category: "core"; readonly description: "Additional artifact type to emit to the output-folder"; readonly items: { readonly type: "string"; }; }; "allow-no-input": { readonly type: "boolean"; }; "exclude-file": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; "base-folder": { readonly type: "string"; }; stats: { readonly type: "boolean"; readonly category: "core"; readonly description: "Output some statistics about current autorest run."; }; profile: { readonly type: "array"; readonly category: "core"; readonly description: "Reserved for future use."; readonly items: { readonly type: "string"; }; }; suppressions: { readonly type: "array"; readonly category: "core"; readonly description: "List of warning/error code to ignore."; readonly items: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; }; readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly where: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "string"; }; }; }; }; "output-file": { readonly type: "string"; }; "deduplicate-inline-models": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Deduplicate inline models"; }; "include-x-ms-examples-original-file": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Include x-ms-original-file property in x-ms-examples"; }; "pass-thru": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; }; export declare const autorestConfigurationProcessor: ConfigurationSchemaProcessor<"extensions" | "logging" | "installation" | "core" | "feature", { /** * Verbosity category */ readonly verbose: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display verbose logging information"; }; readonly debug: { readonly type: "boolean"; readonly category: "logging"; readonly description: "Display debug logging information"; }; readonly level: { readonly type: "string"; readonly category: "logging"; readonly enum: readonly ["debug", "verbose", "information", "warning", "error", "fatal"]; readonly description: "Set logging level"; }; readonly "message-format": { readonly type: "string"; readonly category: "logging"; readonly description: "Format of logging messages"; readonly enum: readonly ["json", "regular"]; }; /** * Manage installation category */ readonly info: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display information about the installed version of autorest and its extensions"; }; readonly "list-available": { readonly type: "boolean"; readonly category: "installation"; readonly description: "Display available AutoRest versions"; }; readonly reset: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Removes all autorest extensions and downloads the latest version of the autorest-core extension"; }; readonly preview: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Enables using autorest extensions that are not yet released"; }; readonly latest: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Install the latest autorest-core extension"; }; readonly force: { readonly type: "boolean"; readonly category: "installation"; readonly description: "Force the re-installation of the autorest-core extension and frameworks"; }; readonly version: { readonly type: "string"; readonly category: "installation"; readonly description: "Use the specified version of the autorest-core extension"; }; readonly use: { readonly type: "array"; readonly category: "installation"; readonly items: { readonly type: "string"; }; readonly description: "Specify an extension to load and use. Format: --use=[@] (e.g. --use=@autorest/modelerfour@~4.19.0)"; }; readonly "use-extension": { readonly type: "dictionary"; readonly category: "installation"; readonly description: "Specify extension to load and use. Format: {\"\": \"\"}"; readonly items: { readonly type: "string"; }; }; /** * Core settings */ readonly help: { readonly type: "boolean"; readonly category: "core"; readonly description: "Display help (combine with flags like --csharp to get further details about specific functionality)"; }; readonly memory: { readonly type: "string"; readonly category: "core"; readonly description: "Configure max memory allowed for autorest process(s)"; }; readonly "input-file": { readonly type: "array"; readonly category: "core"; readonly description: "OpenAPI file to use as input (use this setting repeatedly to pass multiple files at once)"; readonly items: { readonly type: "string"; }; }; readonly "output-folder": { readonly type: "string"; readonly category: "core"; readonly description: "Target folder for generated artifacts; default: \"/generated\""; }; readonly "github-auth-token": { readonly type: "string"; readonly category: "core"; readonly description: "OAuth token to use when pointing AutoRest at files living in a private GitHub repository"; }; readonly "azure-arm": { readonly type: "boolean"; readonly category: "core"; readonly description: "Generate code in Azure flavor"; }; readonly "header-text": { readonly type: "string"; readonly category: "core"; readonly description: "Text to include as a header comment in generated files (magic strings:MICROSOFTMIT, MICROSOFT_APACHE, MICROSOFT_MIT_NO_VERSION, MICROSOFT_APACHE_NO_VERSION, MICROSOFT_MIT_NOCODEGEN)"; }; readonly "openapi-type": { readonly type: "string"; readonly category: "core"; readonly description: "Open API Type: \"arm\" or \"data-plane\""; }; readonly "output-converted-oai3": { readonly type: "boolean"; readonly category: "core"; readonly description: "If enabled and the input-files are swager 2.0 this will output the resulting OpenAPI3.0 converted files to the output-folder"; }; readonly eol: { readonly type: "string"; readonly category: "core"; readonly enum: readonly ["default", "lf", "crlf"]; readonly description: "Change the end of line character for generated output."; }; readonly title: { readonly type: "string"; readonly category: "core"; readonly description: "Override the service client's name listed in the swagger under title."; }; readonly "override-client-name": { readonly type: "string"; readonly category: "core"; readonly description: "Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files"; }; readonly directive: { readonly type: "array"; readonly category: "core"; readonly items: { readonly type: "object"; readonly properties: { readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly suppress: { readonly type: "array"; readonly deprecated: true; readonly items: { readonly type: "string"; }; }; readonly transform: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "text-transform": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly test: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly debug: { readonly type: "boolean"; readonly description: "Debug this directive. When set to true autorest will log additional information regarding that directive."; }; }; }; }; readonly require: { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to include."; readonly items: { readonly type: "string"; }; }; readonly "try-require": { readonly type: "array"; readonly category: "core"; readonly description: "Additional configuration file(s) to try to include. Will not fail if the configuration file doesn't exist."; readonly items: { readonly type: "string"; readonly description: "Additional configuration files to include."; }; }; readonly "declare-directive": { readonly type: "dictionary"; readonly category: "core"; readonly description: "Declare some reusable directives (https://github.com/Azure/autorest/blob/main/packages/libs/configuration/resources/directives.md#how-it-works)"; readonly items: { readonly type: "string"; }; }; readonly "output-artifact": { readonly type: "array"; readonly category: "core"; readonly description: "Additional artifact type to emit to the output-folder"; readonly items: { readonly type: "string"; }; }; readonly "allow-no-input": { readonly type: "boolean"; }; readonly "exclude-file": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly "base-folder": { readonly type: "string"; }; readonly stats: { readonly type: "boolean"; readonly category: "core"; readonly description: "Output some statistics about current autorest run."; }; readonly profile: { readonly type: "array"; readonly category: "core"; readonly description: "Reserved for future use."; readonly items: { readonly type: "string"; }; }; readonly suppressions: { readonly type: "array"; readonly category: "core"; readonly description: "List of warning/error code to ignore."; readonly items: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; }; readonly from: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly where: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly reason: { readonly type: "string"; }; }; }; }; readonly "output-file": { readonly type: "string"; }; /** * Feature flags */ readonly "deduplicate-inline-models": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Deduplicate inline models"; }; readonly "include-x-ms-examples-original-file": { readonly type: "boolean"; readonly category: "feature"; readonly description: "Include x-ms-original-file property in x-ms-examples"; }; /** * Ignore. */ readonly "pass-thru": { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }>; export declare const AUTOREST_INITIAL_CONFIG: AutorestNormalizedConfiguration; //# sourceMappingURL=autorest-configuration-schema.d.ts.map