search

OpenAPITools / openapi-diff

Utility for comparing two OpenAPI specifications.
Apache License 2.0
832 stars 154 forks source link

Wrong changelog generated when having objects with same field name #268

Open gbalabanov opened 3 years ago

gbalabanov commented 3 years ago

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

joschi commented 3 years ago

@gbalabanov Could you please provide a test case (minimal OpenAPI spec) to demonstrate the issue?

gbalabanov commented 3 years ago

Please find attached

joschi commented 3 years ago

@gbalabanov I think you forgot to attach the specs. 😉

gbalabanov commented 3 years ago

Yes, json and md files are not supported as attachments. Changed all of the to txt. test2.txt diff.txt test1.txt