Skip to content

vishrutshah/openapi-diff

 
 

Repository files navigation

How to install

npm install -g [email protected]

Command 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]

Build dependencies

You want the .NET Core SDK Binaries for your platform

dotnet --version
1.0.0-rc4-004769

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 [email protected] with any additional questions or comments.

About

Tools to detect breaking changes between openapi versions

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 80.5%
  • JavaScript 19.5%