Azure / openapi-diff

Command line tool to detect breaking changes between two openapi specifications
MIT License
266 stars 37 forks source link

About openapi-diff

Build Status

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

[!CAUTION]
Do not use the package oad npm package version shield. It is deprecated and obsolete.

How to run locally

See relevant section in CONTRIBUTING.md