search

Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
111 stars 172 forks source link

[Breaking Change] OAD support request by Tim Lovell-Smith: non-breaking change alerted on (3/14/2023) #5730

Open konrad-jamrozik opened 1 year ago

konrad-jamrozik commented 1 year ago

As reported on email thread with subject New Response to Swagger Validation Feedback: 3/14/2023 3:33:46 PM

https://github.com/Azure/azure-rest-api-specs/pull/23049/checks?check_run_id=11963838160

Question detail: This refactoring seems like a non-breaking change to swagger to me. But it is flagged as a breaking change, because [I think] it is too sensitive to $ref redirection. https://github.com/Azure/azure-rest-api-specs/pull/23049

❌ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions. New: Microsoft.Cache/preview/2023-03-01-preview/redisenterprise.json#L1302:9 Old: Microsoft.Cache/preview/2023-03-01-preview/redisenterprise.json#L1302:9

❌ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions. New: Microsoft.Cache/preview/2023-03-01-preview/redisenterprise.json#L1927:9 Old: Microsoft.Cache/preview/2023-03-01-preview/redisenterprise.json#L1940:9

konrad-jamrozik commented 1 year ago

The relevant PR got merged but it is not yet clear to me if the OAD was mistaken here. I left a comment asking Tim about it, and also emailed him.

konrad-jamrozik commented 1 year ago

Based on my chat with Tim over email, it is not clear if this was "clearly not a breaking change" or "possibly a breaking change". Hence for now assuming it was possibly a breaking change, and the tool behaved correctly. Closing this issue.

konrad-jamrozik commented 1 year ago

Reopening. Further discussion over email led to @mikekistler saying this looks like a false positive - the tool should not be reporting it.