autorest/docs/troubleshooting.md

2.9 KiB

Troubleshooting

Module Errors

When running into an AutoRest issues actually running the AutoRest program, your first instinct should always to be run autorest --reset. This clears you AutoRest temp folders and extensions, and reacquires them on your next call to AutoRest.

Generation Errors

There are two broad kinds of errors you can run into when generating: one kind is thrown earlier in the AutoRest pipeline and has to do with malformed swaggers (see our OpenAPI docs for more information). The other kind is thrown by the language generators.

The general AutoRest errors are thrown like this, and are commonly due to swagger issues.

FATAL: Error: Enum types of 'object' and format 'undefined' are not supported. Correct your input (HdiNodeTypes).
  Error: Plugin modelerfour reported failure.

If your error does not look like this, refer to the docs in our language generators:

These issues should give you enough information to fix the error. If not, please let us know in either the main repo, or in the language-specific repos. Also let us know if you believe there are erroneous errors being thrown.

Debugging

We use flags to correspond our debugging process, view our debugging flags to find out which ones would work best for you.

If you would like to actually debug through a language generator's code, see our language-specific instructions: