Azure / Azure/azure-sdk-tools

[Breaking Change] Swagger SDK Breaking Change PR check misses breaks in .NET and Python SDKs

Open
#5,957 2 comments 0 reactions 2 assignees Assigned to @raych1 View on GitHub
Breaking Changes bug Central-EngSys Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

The Swagger SDK Breaking Change PR check in [PR 22789](https://github.com/Azure/azure-rest-api-specs/pull/22789/checks?check_run_id=12642697672) reports breaks in the Go and JavaScript SDKs but fails to report breaks in .NET or Python (and maybe Java too).

The PR changes the schema of the evaluationDetails property of PolicyEvaluationResult from

`"$ref": "../../stable/2019-10-01/policyStates.json#/definitions/PolicyEvaluationDetails",`

to

`"$ref": "#/definitions/CheckRestrictionEvaluationDetails",`

The structure of the new schema is compatible with the old one -- just adds one new property -- so is not breaking at the REST API level. But since the SDKs create classes for the schemas, a change in the schema name will change the class name and that is breaking.

I believe both .NET and Python will be impacted because both have models for PolicyEvaluationResult with an evaluationDetails field defined as the type of the old schema name.

.NET v1.1.0 (stable)
https://learn.microsoft.com/en-us/dotnet/api/azure.resourcemanager.policyinsights.models.policyevaluationresult?view=azure-dotnet

Python v1.0.0 (stable)
https://learn.microsoft.com/en-us/python/api/azure-mgmt-policyinsights/azure.mgmt.policyinsights.models.policyevaluationresult?view=azure-python

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.