Typo in description of incompatible changes
dalv666 opened this issue · comments
oasdiff/BREAKING-CHANGES-EXAMPLES.md
Line 18 in b89acea
Typo. The test checks that the path variable has become an enum and not in the header. For the header, there is a separate test.
Similarly:
Solution:
[changing an existing path param to enum is breaking](https://github.com/Tufin/oasdiff/blob/b89acea39d422cddd1c6879850cbfc603d73aa0a/checker/check_breaking_property_test.go?plain=1#L185)
Hi @dalv666 ,
Could you please share the use case: how are you using the test descriptions?
Thanks,
Reuven
The description of backwards incompatible is not clearly described, so you have to determine what this means from the source code. The description helps you find the test using text search. Otherwise it would be more reliable to search for the code by identifier. Yes, this can be done by link in description, but it does not work in IDE.