# openapi-diff

**Repository Path**: mirrors_Azure/openapi-diff

## Basic Information

- **Project Name**: openapi-diff
- **Description**: Command line tool to detect breaking changes between two openapi specifications
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# About openapi-diff

[![Build Status][build status]][build pipeline]

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.

[build status]: https://dev.azure.com/azure-sdk/public/_apis/build/status/public.openapi-diff?branchName=main
[build pipeline]: https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=135&branchName=main
[azure-rest-api-specs]: https://github.com/Azure/azure-rest-api-specs
[azure-rest-api-specs-pr]: https://github.com/Azure/azure-rest-api-specs-pr

## npm package

- [@azure/oad] ![npm package version shield](https://img.shields.io/npm/v/@azure/oad)
- [package.json]

> [!CAUTION]  
> Do not use the package [oad] ![npm package version shield](https://img.shields.io/npm/v/oad). It is deprecated and obsolete.

[@azure/oad]: https://www.npmjs.com/package/@azure/oad
[package.json]: /package.json
[oad]: https://www.npmjs.com/package/oad

## How to run locally

See relevant section in [CONTRIBUTING.md](./CONTRIBUTING.md)