Skip to content
Command line tool to detect breaking changes between two openapi specifications
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Minor updates Jul 10, 2017
openapi-diff Adding an enum to a paramter causing Null Exception (#143) Apr 19, 2019
src Fix AutoRest path. Apr 22, 2019
.gitattributes Adding LF line adding to .js files Jul 10, 2017
.gitignore
CHANGELOG.md Fix AutoRest path. Apr 22, 2019
LICENSE
README.md changed readme (#147) May 15, 2019
azure-pipelines.yml Remove Gulp, switch to TypeScript, Unit Tests. (#131) Mar 25, 2019
package-lock.json Fix autorest path. (#144) Apr 22, 2019
package.json changed readme (#147) May 15, 2019
tsconfig.json Remove Gulp, switch to TypeScript, Unit Tests. (#131) Mar 25, 2019

README.md

Build Status

How to install

npm install -g @azure/oad

git Usage

vishrut@visshamac openapi-diff $ oad compare --help
Commands:
  compare <old-spec> <new-spec>  Compares old and new open api specification for
                                 breaking changes.

Options:
  --version          Show version number                               [boolean]
  -l, --logLevel     Set the logging level for console.
  [choices: "off", "json", "error", "warn", "info", "verbose", "debug", "silly"]
                                                               [default: "warn"]
  -f, --logFilepath  Set the log file path. It must be an absolute filepath. By
                     default the logs will stored in a timestamp based log file
                     at "/Users/vishrut/oad_output".
  -j, --inJson       A boolean flag indicating whether output format of the
                     messages is json.                 [boolean] [default: true]
  -h, --help         Show help                                         [boolean]
  -o, --oldTagName   The tag name for the old specification file.  If include it 
                     indicates that the old spec file is a readme file
  -n, --newTagName   The tag name for the new specification file.  If include it 
                     indicates that the new spec file is a readme file

Build dependencies

2.0.2

Build scripts

How to build

The first step would be to run npm install so we have all the required modules installed.

How to build the whole repo

gulp;

How to test

To run all tests under the repo

gulp test

How to bundle node package & install

gulp pack
npm install -g oad-0.1.0.tgz

Contributing

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

You can’t perform that action at this time.