EngSys Desired Goals

EngSys Identified Goals

1. Systematic way to track suppressions.

Example suppression.yaml:

- tool: rest-api-diff
  element: foo/bar/baz
  fromVersion: v1
  toVersion: v2

2. The existing tool often reports "breaking changes" that are not meaningful to spec authors.

3. Make it easy to run tool on a dev machine

4. Make error messages as clear and "self-serve" as possible, so spec authors can fix their errors without contacting us. Current tool tells you things like "parameter order changed from v1 to v2". OK, but what does that mean, should I fix it or suppress it, etc.

5. If swagger generated from TSP, errors might want to link back to the TSP. Spec authors might not know how their TSP is breaking swagger.