TypeSpec Conversion

UNDER CONSTRUCTION

TypeSpec Conversion

Short link: aka.ms/typespec/conversion

Overview

1. Identify the OpenAPI spec version to convert

   • Must be newest version for which SDKs have been generated, regardless of whether it was a stable or preview version

2. Choose a new preview version for your converted OpenAPI (e.g. preview/2024-07-01-preview)

3. Create a folder for your TypeSpec sources, per the TypeSpec Structure Guidelines.

4. In this folder, run the conversion tool:

$ npx @azure-tools/typespec-client-generator-cli convert --swagger-readme ../data-plane/readme.md

OR

$ npx @azure-tools/typespec-client-generator-cli convert --swagger-readme ../resource-manager/readme.md --arm

5. Update the version in the generated TypeSpec, to the version from step 2.

6. Compile the generated TypeSpec:

$ npx tsp compile .

7. Add all new files to a branch.

8. Iterate on your TypeSpec and generated swagger. Create a draft PR, to run checks that will guide you to get your PR ready to merge.

Links

• https://azure.github.io/typespec-azure/docs/next/howtos/migrate-swagger/get-started
• https://azure.github.io/typespec-azure/docs/howtos/migrate-swagger/migrate-arm-tips