Swagger Avocado

Table of Contents

• Overview
• Fixing Errors
• Running Locally
• Known Issues
  • MULTIPLE_API_VERSION
• Future Plans

Overview

Check "Swagger Avocado" is a thin wrapper around package @azure/avocado, which is hosted in its own repo and published to npmjs.

Repo: https://github.com/Azure/avocado

Package: https://www.npmjs.com/package/@azure/avocado

Fixing Errors

https://github.com/Azure/avocado?tab=readme-ov-file#how-to-solve-errors

Running Locally

Complete the Node.js and pnpm setup in Contributing first, then change to the repository root and run:

$ cd azure-rest-api-specs
$ pnpm ci
$ pnpm avocado --excludePaths common-types -d specification/contosowidgetmanager

Known Issues

Workaround is for PR reviewer to apply label Approved-Avocado until tool issues are fixed.

1. Allow specs with readme.md in sub-folders under resource-manager
2. [MISSING_APIS_IN_DEFAULT_TAG] False positive on deprecated APIs

MULTIPLE_API_VERSION

Rule MULTIPLE_API_VERSION was changed from a warning to an error on 7/1/2025. As this issue is a blocker to TypeSpec conversion which is an Azure wide effort to drive the API first design pattern among all Azure services.

If your PR is blocked due to this error, please check out this Uniform Versioning Violation Guide wiki on how to resolve this.

Please check with azversioning@service.microsoft.com to see if your service can have one-time suppression if you are not sure.

Future Plans

• Move code for check and package to specs repo (https://github.com/Azure/azure-rest-api-specs/issues/32398)