README.md

⚠️ Deprecation Notice

AutoRest and its ecosystem(including oad) is deprecated and was retired on July 1, 2026.

AutoRest is no longer under active development. No new features, language generators, or plugins will be added.

✅ Recommended replacement: TypeSpec

The recommended successor to AutoRest is TypeSpec — a modern, actively developed API description language and code generation platform.

About openapi-diff

This repository contains source code of openapi-diff aka oad aka "Breaking change detector tool" npm package. This package is invoked internally by the azure-rest-api-specs and azure-rest-api-specs-pr repos Swagger Breaking Change and Breaking Change(Cross-Version) GitHub checks, validating PRs submitted to them.

For description of the overall process of which oad is part of, see https://aka.ms/azsdk/specreview.

npm package

• @azure/oad
• package.json

Caution

Do not use the package oad . It is deprecated and obsolete.

How to run locally

See relevant section in CONTRIBUTING.md