Azure / openapi-diff

Command line tool to detect breaking changes between two openapi specifications

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Rule] Ref model change for property, array item or map items should be a breaking change

tadelesh opened this issue · comments

For e.g., value for RestorableMongodbResourcesListResult changed from DatabaseRestoreResource to RestorableMongodbResourcesGetResult should be a breaking change.
Exceptions: x-ms-client-name set with the same name of previous model.

Actually we have a rule ReferenceRedirection , but it's considered as non breaking change, see

/// Just changing the name of a parameter schema in the definitions section does not change the wire format for
, @mikekistler can you help confirm it as well

@jianyexi The doc you point to says:

Cause: This is considered a breaking change.

And that is what I would expect. What makes you say that it is considered a non-breaking change?

I mean the comment in the test and this rule actually doesn't work now, as the tool compares the resolved schema instead of the reference itself

That sounds like a bug to me then, because if the $ref changes then the generated SDKs will produce different code that can break some users.