SDK Validation

Short Link:	aka.ms/azsdk/sdk-automation-faq

Table of Contents

• How to Download the Generated Artifacts
  • Prerequisites
  • Steps to Download Artifacts
• How to View the Html Report of SDK Validation Checks Result
• How to View the Detailed SDK Generation Errors
• Locating an Automatically Generated SDK Pull Request from Your API Specs
• Common Error Fix Guidance
• Import Resolution Errors
  • Error Pattern: import-not-found
• .NET SDK Generation Error Fix Guidance
  • How to Fix Naming Violations for Management Plane SDK

How to Download the Generated Artifacts

Prerequisites

Ensure the SDK Validation CI check succeeds. If the check fails, the artifacts might not have been generated.

Steps to Download Artifacts

Let's take Python as an example.

1. Navigate to Checks page: click on the Checks tab in the navigation pane of the pull request.

2. View the SDK Validation - Python check result: click on the SDK Validation - Python item in the left CI check list.

3. View Azure DevOps Build Pipeline Run: click on the Pipeline result link.

4. Access Artifacts Page: click on the artifacts link.

5. Locate Generated Artifacts: The generated artifacts for Python are located under the Packages folder.

How to View the Html Report of SDK Validation Checks Result

1. Refer to the former Steps to Download Artifacts to download html report file.

2. The html report is like this screenshot:

How to View the Detailed SDK Generation Errors

1. Open the Azure DevOps Build Pipeline Run: click the Pipeline result link.

2. Examine the Pipeline Run Log: click directly on the error entry directly.

3. Review Detailed Log Information: expand the log group immediately above the error summary group.

Locating an Automatically Generated SDK Pull Request from Your API Specs

For detailed instructions, please refer to Using the SDK Generation Pipelines.

Common Error Fix Guidance

Import Resolution Errors

Error Pattern: import-not-found

Error Message Pattern: error import-not-found: Couldn't resolve import '[.*].tsp'

Root Cause: The folder containing the imported TypeSpec files is not specified in the tspconfig.yaml file's additionalDirectories setting.

Solution Steps:

1. Locate the tspconfig.yaml file in your TypeSpec project root
2. Find the additionalDirectories array in the configuration
3. Add the path to the folder containing the imported .tsp files
4. Ensure the path is relative to the tspconfig.yaml file location Reference: Sample tspconfig.yaml

.NET SDK Generation Error Fix Guidance

How to Fix Naming Violations for Management Plane SDK

If your pipeline run logs already outline the naming violations, simply locate the reported issues and proceed as follows:

1. Review the Pipeline Logs: Identify the naming violations highlighted in the log output.

2. Consult Naming Conventions: Familiarize yourself with the Naming Conventions guidelines to understand the expected naming rules.

3. Apply Polishing Configurations: Use the Polishing Configurations as a reference to adjust your SDK naming as per the conventions.

4. Update and Validate: Modify the specs to correct the naming issues and run the CI checks again to confirm that all violations have been resolved.