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

$ cd azure-rest-api-specs
$ npm ci
$ npx 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: https://github.com/Azure/avocado/pull/157.

If your PR is blocked due to this error, and your spec has always shipped multiple API versions in your default tag:

1. Add label Approved-Avocado, plus a comment explaining why you need to suppress this.
2. In parallel, contact @qiaozha to discuss long-term plans to address this for your spec.

Future Plans

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