Skip to content

Instantly share code, notes, and snippets.

@weidongxu-microsoft
Last active January 16, 2026 06:25
Show Gist options
  • Select an option

  • Save weidongxu-microsoft/e7f19761e4b93c05b0c5880d4bb3df61 to your computer and use it in GitHub Desktop.

Select an option

Save weidongxu-microsoft/e7f19761e4b93c05b0c5880d4bb3df61 to your computer and use it in GitHub Desktop.
Examples on checking API change

Client method change

Case 1

image

Verify whether the change is from service.

Here, before https://github.com/Azure/azure-rest-api-specs/blob/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json#L6341 after https://github.com/Azure/azure-rest-api-specs/blob/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2025-10-01-preview/mfe.json#L6687

In this case, it is add by service, so it is OK.

Similar case:

image Request body is changed from "required" to "optional" by service.

Case 2

image

Typically, response of a list is a PagedIterable. Therefore, we take this as a "fix" on service, so it is OK.

Case 3

Screenshot 2026-01-15 154045

Same as Case 1, need to check service.

In this case, it appears to be incorrect in conversion https://github.com/Azure/azure-rest-api-specs/blob/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2025-10-01-preview/mfe.json#L1571

Model change

Case 1

image

Should be fixed by the agent/tool.

Similar case:

image image

Case 2

image

Service actually changed the naming. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2025-10-01-preview/workspaceRP.json#L6684

But we can still have the agent/tool fix the break.

Case 3

image

Changed by service. Accept it. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2025-10-01-preview/workspaceRP.json#L7472

Similar case: image

Fluent resource model change

Case 1

image

Should be OK. Usually this is caused by the order change of the Stages (due to property order change of the model), which will not break user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment