Link to source Swaggers

[AlitzelMendez]

Right now, even if the tool tells us the path, it is hard to do the actual review (to know the context of where the rule is being triggered).

• For small swagger files, it is not as bad. We just compare LHS vs. RHS, look for the path, and I can see the diff. It's okay.
• For big swagger files, it gets more complicated because the LHS comparison against RHS is not a perfect match. At least on compute, they get misplaced so badly that it is impossible to compare. So, we need to look for the path in LHS, then in RHS, and then copy those path sections to another location to be able to compare.

[tjprescott]

Similar to #4. Are you saying you would like if the diff payload contained the original path or something different?

[AlitzelMendez]

kind of, I would like to contain the path such that if I click into it takes me to the line of the error, for example this way of showing the diff: https://github.com/Azure/azure-rest-api-specs/pull/32748/checks?check_run_id=38581826895 it contains a link to the line diff

or the breaking change: https://github.com/Azure/azure-rest-api-specs/pull/32748/checks?check_run_id=38581825693

where there is a link to the old and the new swagger where this is happening

[tjprescott]

As discussed at yesterday's meeting, this would be difficult. The diffing algorithm is an object tree diff, not a line-by-line text diff, so you don't get line numbers "for free". I could potentially use the paths to "calculate" the line number, but this is likely to be brittle and heavily assumption based. Imagine trying to guess as you navigate the object structure how many brackets are necessary between jumps.

Also, it seems for this to truly be useful, you would want links to the Swagger. Currently the paths in the diff are simply paths to the transformation files.