Giters

OpenAPITools / openapi-diff

Utility for comparing two OpenAPI specifications.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

No backward compatible changes in Schema are marked as Compatible

awaqas opened this issue · comments

commented

Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,

Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'

  1. Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
  2. Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE

After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.

Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.