Skip to content

Frequently Asked Questions

Renaming the generated Swagger file

Section titled “Renaming the generated Swagger file”

Rename the generated Swagger file by modifying the output-file option in the tspconfig.yaml:

options:
  "@azure-tools/typespec-autorest":
    output-file: "your-meaningful-name.json"

File Layout for ARM Services

Section titled “File Layout for ARM Services”

For ARM services, use the following file structure:

  • main.tsp: Entry point for the TypeSpec specification containing service information
  • {resource-name}.tsp: Resource-specific operations for each ARM resource type
  • routes.tsp: All other operations that don’t belong to specific resources
  • models.tsp: All the model definitions used across operations
  • (optional) client.tsp: Client-specific customizations and configurations
  • (optional) back-compatible.tsp: Backward compatibility definitions and legacy support

This structure helps maintain a clear separation of concerns between the API description and the client SDK and makes the TypeSpec specification easier to navigate and maintain.